Add GNU LGPL headers to all .c .C and .h files
[oweals/cde.git] / cde / programs / dtinfo / DtMmdb / index / hash.h
1 /*
2  * CDE - Common Desktop Environment
3  *
4  * Copyright (c) 1993-2012, The Open Group. All rights reserved.
5  *
6  * These libraries and programs are free software; you can
7  * redistribute them and/or modify them under the terms of the GNU
8  * Lesser General Public License as published by the Free Software
9  * Foundation; either version 2 of the License, or (at your option)
10  * any later version.
11  *
12  * These libraries and programs are distributed in the hope that
13  * they will be useful, but WITHOUT ANY WARRANTY; without even the
14  * implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
15  * PURPOSE. See the GNU Lesser General Public License for more
16  * details.
17  *
18  * You should have received a copy of the GNU Lesser General Public
19  * License along with these librararies and programs; if not, write
20  * to the Free Software Foundation, Inc., 51 Franklin Street, Fifth
21  * Floor, Boston, MA 02110-1301 USA
22  */
23 /*
24  * $XConsortium: hash.h /main/4 1996/06/11 17:21:59 cde-hal $
25  *
26  * Copyright (c) 1993 HAL Computer Systems International, Ltd.
27  * All rights reserved.  Unpublished -- rights reserved under
28  * the Copyright Laws of the United States.  USE OF A COPYRIGHT
29  * NOTICE IS PRECAUTIONARY ONLY AND DOES NOT IMPLY PUBLICATION
30  * OR DISCLOSURE.
31  * 
32  * THIS SOFTWARE CONTAINS CONFIDENTIAL INFORMATION AND TRADE
33  * SECRETS OF HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.  USE,
34  * DISCLOSURE, OR REPRODUCTION IS PROHIBITED WITHOUT THE
35  * PRIOR EXPRESS WRITTEN PERMISSION OF HAL COMPUTER SYSTEMS
36  * INTERNATIONAL, LTD.
37  * 
38  *                         RESTRICTED RIGHTS LEGEND
39  * Use, duplication, or disclosure by the Government is subject
40  * to the restrictions as set forth in subparagraph (c)(l)(ii)
41  * of the Rights in Technical Data and Computer Software clause
42  * at DFARS 252.227-7013.
43  *
44  *          HAL COMPUTER SYSTEMS INTERNATIONAL, LTD.
45  *                  1315 Dell Avenue
46  *                  Campbell, CA  95008
47  * 
48  */
49
50
51 #ifndef _hash_h
52 #define _hash_h 1
53
54 //#include <assert.h>
55 #include "utility/buffer.h"
56 #include "utility/key.h"
57
58 class hash 
59 {   
60
61 public:
62    hash();
63    virtual ~hash() ;
64  
65    virtual void init_data_member(unsigned int v_key_set_sz = 0, 
66                                 unsigned int v_hash_func_sz = 0, 
67                                 unsigned int v_hash_tbl_sz = 0);
68
69 // status inquiry functions
70    virtual int keysetsize()    const { return v_key_set_sz; };
71    virtual int hashtablesize() const { return v_hash_tbl_sz; };
72    virtual int hashfuncsize()  const { return v_hash_func_sz; };
73
74 // return the hash value for a key
75    virtual int hashTo(const key_type&) = 0;
76
77 // load a set of key-oid pairs 
78    virtual Boolean load() { return false; };
79
80 // compacted disk representation In and Out functions
81    virtual int cdr_sizeof();
82    virtual io_status cdrOut(buffer&);
83    virtual io_status cdrIn(buffer&);
84
85 protected:
86    unsigned int v_key_set_sz;
87    unsigned int v_hash_func_sz;
88    unsigned int v_hash_tbl_sz;
89 };
90
91 #endif