include/ndbm.h

   1 /*-
   2  * Copyright (c) 1990, 1993
   3  *      The Regents of the University of California.  All rights reserved.
   4  *
   5  * This code is derived from software contributed to Berkeley by
   6  * Margo Seltzer.
   7  *
   8  * Redistribution and use in source and binary forms, with or without
   9  * modification, are permitted provided that the following conditions
  10  * are met:
  11  * 1. Redistributions of source code must retain the above copyright
  12  *    notice, this list of conditions and the following disclaimer.
  13  * 2. Redistributions in binary form must reproduce the above copyright
  14  *    notice, this list of conditions and the following disclaimer in the
  15  *    documentation and/or other materials provided with the distribution.
  16  * 3. Neither the name of the University nor the names of its contributors
  17  *    may be used to endorse or promote products derived from this software
  18  *    without specific prior written permission.
  19  *
  20  * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  21  * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22  * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23  * ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  24  * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25  * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26  * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27  * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29  * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30  * SUCH DAMAGE.
  31  *
  32  *      @(#)ndbm.h      8.1 (Berkeley) 6/2/93
  33  * $FreeBSD: head/include/ndbm.h 203964 2010-02-16 19:39:50Z imp $
  34  */
  35
  36 #ifndef _NDBM_H_
  37 #define _NDBM_H_
  38
  39 #include <db.h>
  40
  41 /* Map dbm interface onto db(3). */
  42 #define DBM_RDONLY      O_RDONLY
  43
  44 /* Flags to dbm_store(). */
  45 #define DBM_INSERT      0
  46 #define DBM_REPLACE     1
  47
  48 /*
  49  * The db(3) support for ndbm always appends this suffix to the
  50  * file name to avoid overwriting the user's original database.
  51  *
  52  * XXX dsize should be size_t; see 1003.1-2008
  53  */
  54 #define DBM_SUFFIX      ".db"
  55
  56 typedef struct {
  57         void *dptr;
  58         int dsize;
  59 } datum;
  60
  61 typedef DB DBM;
  62 #define dbm_pagfno(a)   DBM_PAGFNO_NOT_AVAILABLE
  63
  64 __BEGIN_DECLS
  65 int      dbm_clearerr(DBM *);
  66 void     dbm_close(DBM *);
  67 int      dbm_delete(DBM *, datum);
  68 int      dbm_error(DBM *);
  69 datum    dbm_fetch(DBM *, datum);
  70 datum    dbm_firstkey(DBM *);
  71 #if __BSD_VISIBLE
  72 long     dbm_forder(DBM *, datum);
  73 #endif
  74 datum    dbm_nextkey(DBM *);
  75 DBM     *dbm_open(const char *, int, mode_t);
  76 int      dbm_store(DBM *, datum, datum, int);
  77 #if __BSD_VISIBLE
  78 int      dbm_dirfno(DBM *);
  79 #endif
  80 __END_DECLS
  81
  82 #endif /* !_NDBM_H_ */