LTKCPP-- LLRP Toolkit C Plus Plus Library
txt_db.h
00001 /* crypto/txt_db/txt_db.h */
00002 /* Copyright (C) 1995-1998 Eric Young (eay@cryptsoft.com)
00003  * All rights reserved.
00004  *
00005  * This package is an SSL implementation written
00006  * by Eric Young (eay@cryptsoft.com).
00007  * The implementation was written so as to conform with Netscapes SSL.
00008  *
00009  * This library is free for commercial and non-commercial use as long as
00010  * the following conditions are aheared to.  The following conditions
00011  * apply to all code found in this distribution, be it the RC4, RSA,
00012  * lhash, DES, etc., code; not just the SSL code.  The SSL documentation
00013  * included with this distribution is covered by the same copyright terms
00014  * except that the holder is Tim Hudson (tjh@cryptsoft.com).
00015  *
00016  * Copyright remains Eric Young's, and as such any Copyright notices in
00017  * the code are not to be removed.
00018  * If this package is used in a product, Eric Young should be given attribution
00019  * as the author of the parts of the library used.
00020  * This can be in the form of a textual message at program startup or
00021  * in documentation (online or textual) provided with the package.
00022  *
00023  * Redistribution and use in source and binary forms, with or without
00024  * modification, are permitted provided that the following conditions
00025  * are met:
00026  * 1. Redistributions of source code must retain the copyright
00027  *    notice, this list of conditions and the following disclaimer.
00028  * 2. Redistributions in binary form must reproduce the above copyright
00029  *    notice, this list of conditions and the following disclaimer in the
00030  *    documentation and/or other materials provided with the distribution.
00031  * 3. All advertising materials mentioning features or use of this software
00032  *    must display the following acknowledgement:
00033  *    "This product includes cryptographic software written by
00034  *     Eric Young (eay@cryptsoft.com)"
00035  *    The word 'cryptographic' can be left out if the rouines from the library
00036  *    being used are not cryptographic related :-).
00037  * 4. If you include any Windows specific code (or a derivative thereof) from
00038  *    the apps directory (application code) you must include an acknowledgement:
00039  *    "This product includes software written by Tim Hudson (tjh@cryptsoft.com)"
00040  *
00041  * THIS SOFTWARE IS PROVIDED BY ERIC YOUNG ``AS IS'' AND
00042  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
00043  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
00044  * ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
00045  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
00046  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
00047  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
00048  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
00049  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
00050  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00051  * SUCH DAMAGE.
00052  *
00053  * The licence and distribution terms for any publically available version or
00054  * derivative of this code cannot be changed.  i.e. this code cannot simply be
00055  * copied and put under another distribution licence
00056  * [including the GNU Public Licence.]
00057  */
00058 
00059 #ifndef HEADER_TXT_DB_H
00060 # define HEADER_TXT_DB_H
00061 
00062 # include <openssl/opensslconf.h>
00063 # ifndef OPENSSL_NO_BIO
00064 #  include <openssl/bio.h>
00065 # endif
00066 # include <openssl/stack.h>
00067 # include <openssl/lhash.h>
00068 
00069 # define DB_ERROR_OK                     0
00070 # define DB_ERROR_MALLOC                 1
00071 # define DB_ERROR_INDEX_CLASH            2
00072 # define DB_ERROR_INDEX_OUT_OF_RANGE     3
00073 # define DB_ERROR_NO_INDEX               4
00074 # define DB_ERROR_INSERT_INDEX_CLASH     5
00075 
00076 #ifdef  __cplusplus
00077 extern "C" {
00078 #endif
00079 
00080 typedef OPENSSL_STRING *OPENSSL_PSTRING;
00081 DECLARE_SPECIAL_STACK_OF(OPENSSL_PSTRING, OPENSSL_STRING)
00082 
00083 typedef struct txt_db_st {
00084     int num_fields;
00085     STACK_OF(OPENSSL_PSTRING) *data;
00086     LHASH_OF(OPENSSL_STRING) **index;
00087     int (**qual) (OPENSSL_STRING *);
00088     long error;
00089     long arg1;
00090     long arg2;
00091     OPENSSL_STRING *arg_row;
00092 } TXT_DB;
00093 
00094 # ifndef OPENSSL_NO_BIO
00095 TXT_DB *TXT_DB_read(BIO *in, int num);
00096 long TXT_DB_write(BIO *out, TXT_DB *db);
00097 # else
00098 TXT_DB *TXT_DB_read(char *in, int num);
00099 long TXT_DB_write(char *out, TXT_DB *db);
00100 # endif
00101 int TXT_DB_create_index(TXT_DB *db, int field, int (*qual) (OPENSSL_STRING *),
00102                         LHASH_HASH_FN_TYPE hash, LHASH_COMP_FN_TYPE cmp);
00103 void TXT_DB_free(TXT_DB *db);
00104 OPENSSL_STRING *TXT_DB_get_by_index(TXT_DB *db, int idx,
00105                                     OPENSSL_STRING *value);
00106 int TXT_DB_insert(TXT_DB *db, OPENSSL_STRING *value);
00107 
00108 #ifdef  __cplusplus
00109 }
00110 #endif
00111 
00112 #endif