include/openssl/txt_db.h

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