home *** CD-ROM | disk | FTP | other *** search
/ Fresh Fish 2 / FFMCD02.bin / useful / include / gdbm.h < prev    next >
C/C++ Source or Header  |  1993-12-13  |  5KB  |  180 lines
  1. /* gdbm.h  -  The include file for dbm users.  */
  2.  
  3. /*  This file is part of GDBM, the GNU data base manager, by Philip A. Nelson.
  4.     Copyright (C) 1990, 1991, 1993  Free Software Foundation, Inc.
  5.  
  6.     GDBM is free software; you can redistribute it and/or modify
  7.     it under the terms of the GNU General Public License as published by
  8.     the Free Software Foundation; either version 2, or (at your option)
  9.     any later version.
  10.  
  11.     GDBM is distributed in the hope that it will be useful,
  12.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  13.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14.     GNU General Public License for more details.
  15.  
  16.     You should have received a copy of the GNU General Public License
  17.     along with GDBM; see the file COPYING.  If not, write to
  18.     the Free Software Foundation, 675 Mass Ave, Cambridge, MA 02139, USA.
  19.  
  20.     You may contact the author by:
  21.        e-mail:  phil@cs.wwu.edu
  22.       us-mail:  Philip A. Nelson
  23.                 Computer Science Department
  24.                 Western Washington University
  25.                 Bellingham, WA 98226
  26.        
  27. *************************************************************************/
  28.  
  29. /* Protection for multiple includes. */
  30. #ifndef _GDBM_H_
  31. #define _GDBM_H_
  32.  
  33. /* Parameters to gdbm_open for READERS, WRITERS, and WRITERS who
  34.    can create the database. */
  35. #define  GDBM_READER  0        /* A reader. */
  36. #define  GDBM_WRITER  1        /* A writer. */
  37. #define  GDBM_WRCREAT 2        /* A writer.  Create the db if needed. */
  38. #define  GDBM_NEWDB   3        /* A writer.  Always create a new db. */
  39. #define  GDBM_FAST    16    /* Write fast! => No fsyncs. */
  40.  
  41. /* Parameters to gdbm_store for simple insertion or replacement in the
  42.    case that the key is already in the database. */
  43. #define  GDBM_INSERT  0        /* Never replace old data with new. */
  44. #define  GDBM_REPLACE 1        /* Always replace old data with new. */
  45.  
  46. /* Parameters to gdbm_setopt, specifing the type of operation to perform. */
  47. #define  GDBM_CACHESIZE 1       /* Set the cache size. */
  48.  
  49. /* The data and key structure.  This structure is defined for compatibility. */
  50. typedef struct {
  51.     char *dptr;
  52.     int   dsize;
  53.       } datum;
  54.  
  55.  
  56. /* The file information header. This is good enough for most applications. */
  57. typedef struct {int dummy[10];} *GDBM_FILE;
  58.  
  59. /* Determine if the C(++) compiler requires complete function prototype  */
  60. #if  __STDC__ || defined(__cplusplus) || defined(c_plusplus)
  61. #define GDBM_Proto(x) x
  62. #else
  63. #define GDBM_Proto(x) ()
  64. #endif /* NeedFunctionPrototypes */
  65.  
  66. /* External variable, the gdbm build release string. */
  67. extern char *gdbm_version;    
  68.  
  69.  
  70. /* GDBM C++ support */
  71. #if defined(__cplusplus) || defined(c_plusplus)
  72. extern "C" {
  73. #endif
  74.  
  75. /* These are the routines! */
  76.  
  77. extern GDBM_FILE gdbm_open GDBM_Proto((
  78.      char *file,
  79.      int  block_size,
  80.      int  flags,
  81.      int  mode,
  82.      void (*fatal_func)()
  83. ));
  84.  
  85. extern void gdbm_close GDBM_Proto((
  86.      GDBM_FILE dbf
  87. ));
  88.  
  89. extern int gdbm_store GDBM_Proto((
  90.      GDBM_FILE dbf,
  91.      datum key,
  92.      datum content,
  93.      int flags
  94. ));
  95.  
  96. extern datum gdbm_fetch GDBM_Proto((
  97.      GDBM_FILE dbf,
  98.      datum key
  99. ));
  100.  
  101. extern int gdbm_delete GDBM_Proto((
  102.      GDBM_FILE dbf,
  103.      datum key
  104. ));
  105.  
  106. extern datum gdbm_firstkey GDBM_Proto((
  107.      GDBM_FILE dbf
  108. ));
  109.  
  110. extern datum gdbm_nextkey GDBM_Proto((
  111.      GDBM_FILE dbf,
  112.      datum key
  113. ));
  114.  
  115. extern int gdbm_reorganize GDBM_Proto((
  116.      GDBM_FILE dbf
  117. ));
  118.  
  119. extern void gdbm_sync GDBM_Proto((
  120.      GDBM_FILE dbf
  121. ));
  122.  
  123. extern int gdbm_exists GDBM_Proto((
  124.      GDBM_FILE dbf,
  125.      datum key
  126. ));
  127.  
  128. extern int gdbm_setopt GDBM_Proto((
  129.      GDBM_FILE dbf,
  130.      int optflag,
  131.      int *optval,
  132.      int optlen
  133. ));
  134.  
  135. #if defined(__cplusplus) || defined(c_plusplus)
  136. }
  137. #endif
  138.  
  139. /* gdbm sends back the following error codes in the variable gdbm_errno. */
  140. typedef enum {    GDBM_NO_ERROR,
  141.         GDBM_MALLOC_ERROR,
  142.         GDBM_BLOCK_SIZE_ERROR,
  143.         GDBM_FILE_OPEN_ERROR,
  144.         GDBM_FILE_WRITE_ERROR,
  145.         GDBM_FILE_SEEK_ERROR,
  146.         GDBM_FILE_READ_ERROR,
  147.         GDBM_BAD_MAGIC_NUMBER,
  148.         GDBM_EMPTY_DATABASE,
  149.         GDBM_CANT_BE_READER,
  150.             GDBM_CANT_BE_WRITER,
  151.         GDBM_READER_CANT_DELETE,
  152.         GDBM_READER_CANT_STORE,
  153.         GDBM_READER_CANT_REORGANIZE,
  154.         GDBM_UNKNOWN_UPDATE,
  155.         GDBM_ITEM_NOT_FOUND,
  156.         GDBM_REORGANIZE_FAILED,
  157.         GDBM_CANNOT_REPLACE,
  158.         GDBM_ILLEGAL_DATA,
  159.         GDBM_OPT_ALREADY_SET,
  160.         GDBM_OPT_ILLEGAL}
  161.     gdbm_error;
  162. extern gdbm_error gdbm_errno;
  163.  
  164. /* extra prototypes */
  165.  
  166. /* GDBM C++ support */
  167. #if defined(__cplusplus) || defined(c_plusplus)
  168. extern "C" {
  169. #endif
  170.  
  171. extern char *gdbm_strerror GDBM_Proto((
  172.      gdbm_error error
  173. ));
  174.  
  175. #if defined(__cplusplus) || defined(c_plusplus)
  176. }
  177. #endif
  178.  
  179. #endif
  180.