Generic interface.
[u/mdw/catacomb] / ghash.h
1 /* -*-c-*-
2 *
3 * $Id: ghash.h,v 1.1 1999/12/10 23:16:01 mdw Exp $
4 *
5 * Generic hash function interface
6 *
7 * (c) 1999 Straylight/Edgeware
8 */
9
10 /*----- Licensing notice --------------------------------------------------*
11 *
12 * This file is part of Catacomb.
13 *
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
18 *
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
23 *
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
27 * MA 02111-1307, USA.
28 */
29
30 /*----- Revision history --------------------------------------------------*
31 *
32 * $Log: ghash.h,v $
33 * Revision 1.1 1999/12/10 23:16:01 mdw
34 * Generic interface.
35 *
36 */
37
38 #ifndef CATACOMB_GHASH_H
39 #define CATACOMB_GHASH_H
40
41 #ifdef __cplusplus
42 extern "C" {
43 #endif
44
45 /*----- Header files ------------------------------------------------------*/
46
47 #include <stddef.h>
48
49 /*----- Generic hash function interface -----------------------------------*/
50
51 typedef struct gchash_base {
52 const char *name; /* Name of the hash function */
53 size_t hashsz; /* Size of output hash */
54 } gchash_base;
55
56 typedef struct ghash {
57 const struct ghash_ops *ops; /* Pointer to hash operations */
58 } ghash;
59
60 typedef struct ghash_ops {
61 const gchash_base *b; /* Pointer to basic information */
62 void (*hash)(ghash */*h*/, const void */*p*/, size_t /*sz*/); /* Hash */
63 void (*done)(ghash */*h*/, void */*buf*/); /* Write result */
64 void (*destroy)(ghash */*h*/); /* Destroy hash block */
65 } ghash_ops;
66
67 typedef struct gchash {
68 gchash_base b; /* Basic bits of information */
69 ghash *(*init)(void); /* Create a new hash instance */
70 } gchash;
71
72 /*----- That's all, folks -------------------------------------------------*/
73
74 #ifdef __cplusplus
75 }
76 #endif
77
78 #endif