include/ndbm.h

   1 /*
   2  * Copyright (c) 2000 Apple Computer, Inc. All rights reserved.
   3  *
   4  * @APPLE_LICENSE_HEADER_START@
   5  *
   6  * This file contains Original Code and/or Modifications of Original Code
   7  * as defined in and that are subject to the Apple Public Source License
   8  * Version 2.0 (the 'License'). You may not use this file except in
   9  * compliance with the License. Please obtain a copy of the License at
  10  * http://www.opensource.apple.com/apsl/ and read it before using this
  11  * file.
  12  *
  13  * The Original Code and all software distributed under the License are
  14  * distributed on an 'AS IS' basis, WITHOUT WARRANTY OF ANY KIND, EITHER
  15  * EXPRESS OR IMPLIED, AND APPLE HEREBY DISCLAIMS ALL SUCH WARRANTIES,
  16  * INCLUDING WITHOUT LIMITATION, ANY WARRANTIES OF MERCHANTABILITY,
  17  * FITNESS FOR A PARTICULAR PURPOSE, QUIET ENJOYMENT OR NON-INFRINGEMENT.
  18  * Please see the License for the specific language governing rights and
  19  * limitations under the License.
  20  *
  21  * @APPLE_LICENSE_HEADER_END@
  22  */
  23 /*-
  24  * Copyright (c) 1990, 1993
  25  *      The Regents of the University of California.  All rights reserved.
  26  *
  27  * This code is derived from software contributed to Berkeley by
  28  * Margo Seltzer.
  29  *
  30  * Redistribution and use in source and binary forms, with or without
  31  * modification, are permitted provided that the following conditions
  32  * are met:
  33  * 1. Redistributions of source code must retain the above copyright
  34  *    notice, this list of conditions and the following disclaimer.
  35  * 2. Redistributions in binary form must reproduce the above copyright
  36  *    notice, this list of conditions and the following disclaimer in the
  37  *    documentation and/or other materials provided with the distribution.
  38  * 3. All advertising materials mentioning features or use of this software
  39  *    must display the following acknowledgement:
  40  *      This product includes software developed by the University of
  41  *      California, Berkeley and its contributors.
  42  * 4. Neither the name of the University nor the names of its contributors
  43  *    may be used to endorse or promote products derived from this software
  44  *    without specific prior written permission.
  45  *
  46  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  47  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  48  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  49  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  50  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  51  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  52  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  53  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  54  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  55  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  56  * SUCH DAMAGE.
  57  *
  58  *      @(#)ndbm.h      8.1 (Berkeley) 6/2/93
  59  */
  60
  61 #ifndef _NDBM_H_
  62 #define _NDBM_H_
  63
  64 #include <_types.h>
  65 #include <sys/_types/_mode_t.h>
  66 #include <sys/_types/_size_t.h>
  67
  68 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
  69 /* Map dbm interface onto db(3). */
  70 #include <fcntl.h>
  71 #define DBM_RDONLY      O_RDONLY
  72 #endif
  73
  74 /* Flags to dbm_store(). */
  75 #define DBM_INSERT      0
  76 #define DBM_REPLACE     1
  77
  78 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
  79 /*
  80  * The db(3) support for ndbm(3) always appends this suffix to the
  81  * file name to avoid overwriting the user's original database.
  82  */
  83 #define DBM_SUFFIX      ".db"
  84 #endif
  85
  86 typedef struct {
  87         void *dptr;
  88         size_t dsize;
  89 } datum;
  90
  91 #ifndef _DBM
  92 #define _DBM
  93 typedef struct {
  94     char __opaque[sizeof(int) + 8 * sizeof(void *)];
  95 } DBM;
  96 #endif /* _DBM */
  97
  98 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
  99 #define dbm_pagfno(a)   DBM_PAGFNO_NOT_AVAILABLE
 100 #endif
 101
 102 __BEGIN_DECLS
 103 int      dbm_clearerr( DBM *);
 104 void     dbm_close(DBM *);
 105 int      dbm_delete(DBM *, datum);
 106 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
 107 int      dbm_dirfno(DBM *);
 108 #endif
 109 int      dbm_error( DBM *);
 110 datum    dbm_fetch(DBM *, datum);
 111 datum    dbm_firstkey(DBM *);
 112 #if !defined(_ANSI_SOURCE) && (!defined(_POSIX_C_SOURCE) || defined(_DARWIN_C_SOURCE))
 113 long     dbm_forder(DBM *, datum);
 114 #endif
 115 datum    dbm_nextkey(DBM *);
 116 DBM     *dbm_open(const char *, int, mode_t);
 117 int      dbm_store(DBM *, datum, datum, int);
 118 __END_DECLS
 119
 120 #endif /* !_NDBM_H_ */