342533d40dbbfb0f0d9c1343caca84d013026d24
[openssl.git] / crypto / txt_db / txt_db.h
1 /* crypto/txt_db/txt_db.h */
2 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
3  * All rights reserved.
4  *
5  * This package is an SSL implementation written
6  * by Eric Young (eay@cryptsoft.com).
7  * The implementation was written so as to conform with Netscapes SSL.
8  * 
9  * This library is free for commercial and non-commercial use as long as
10  * the following conditions are aheared to.  The following conditions
11  * apply to all code found in this distribution, be it the RC4, RSA,
12  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
13  * included with this distribution is covered by the same copyright terms
14  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
15  * 
16  * Copyright remains Eric Young's, and as such any Copyright notices in
17  * the code are not to be removed.
18  * If this package is used in a product, Eric Young should be given attribution
19  * as the author of the parts of the library used.
20  * This can be in the form of a textual message at program startup or
21  * in documentation (online or textual) provided with the package.
22  * 
23  * Redistribution and use in source and binary forms, with or without
24  * modification, are permitted provided that the following conditions
25  * are met:
26  * 1. Redistributions of source code must retain the copyright
27  *    notice, this list of conditions and the following disclaimer.
28  * 2. Redistributions in binary form must reproduce the above copyright
29  *    notice, this list of conditions and the following disclaimer in the
30  *    documentation and/or other materials provided with the distribution.
31  * 3. All advertising materials mentioning features or use of this software
32  *    must display the following acknowledgement:
33  *    "This product includes cryptographic software written by
34  *     Eric Young (eay@cryptsoft.com)"
35  *    The word 'cryptographic' can be left out if the rouines from the library
36  *    being used are not cryptographic related :-).
37  * 4. If you include any Windows specific code (or a derivative thereof) from 
38  *    the apps directory (application code) you must include an acknowledgement:
39  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
40  * 
41  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
42  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
43  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
44  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
45  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
46  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
47  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
48  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
49  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
50  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
51  * SUCH DAMAGE.
52  * 
53  * The licence and distribution terms for any publically available version or
54  * derivative of this code cannot be changed.  i.e. this code cannot simply be
55  * copied and put under another distribution licence
56  * [including the GNU Public Licence.]
57  */
58
59 #ifndef HEADER_TXT_DB_H
60 #define HEADER_TXT_DB_H
61
62 #ifndef NO_BIO
63 #include <openssl/bio.h>
64 #endif
65 #include <openssl/stack.h>
66 #include <openssl/lhash.h>
67
68 #define DB_ERROR_OK                     0
69 #define DB_ERROR_MALLOC                 1
70 #define DB_ERROR_INDEX_CLASH            2
71 #define DB_ERROR_INDEX_OUT_OF_RANGE     3
72 #define DB_ERROR_NO_INDEX               4
73 #define DB_ERROR_INSERT_INDEX_CLASH     5
74
75 #ifdef  __cplusplus
76 extern "C" {
77 #endif
78
79 typedef struct txt_db_st
80         {
81         int num_fields;
82         STACK /* char ** */ *data;
83         LHASH **index;
84         int (**qual)();
85         long error;
86         long arg1;
87         long arg2;
88         char **arg_row;
89         } TXT_DB;
90
91 #ifndef NO_BIO
92 TXT_DB *TXT_DB_read(BIO *in, int num);
93 long TXT_DB_write(BIO *out, TXT_DB *db);
94 #else
95 TXT_DB *TXT_DB_read(char *in, int num);
96 long TXT_DB_write(char *out, TXT_DB *db);
97 #endif
98 int TXT_DB_create_index(TXT_DB *db,int field,int (*qual)(),
99          unsigned long (*hash)(),int (*cmp)());
100 void TXT_DB_free(TXT_DB *db);
101 char **TXT_DB_get_by_index(TXT_DB *db, int idx, char **value);
102 int TXT_DB_insert(TXT_DB *db,char **value);
103
104 #ifdef  __cplusplus
105 }
106 #endif
107
108 #endif