home *** CD-ROM | disk | FTP | other *** search
/ PC Press 1997 July / Sezamfile97_1.iso / msdos / c / cbase11.a03 / CBASE11.ZIP / LSEQ / LSEQ.H < prev    next >
C/C++ Source or Header  |  1993-01-01  |  5KB  |  159 lines
  1. /*
  2.  *    Copyright (c) 1989-1992 Citadel Software, Inc.
  3.  *    All Rights Reserved
  4.  */
  5.  
  6. /*man---------------------------------------------------------------------------
  7. NAME
  8.      lseq - linked sequential file management library
  9.  
  10. SYNOPSIS
  11.      #include <lseq.h>
  12.  
  13. DESCRIPTION
  14.      The lseq library consists of a set of routines for the creation
  15.      and manipulation of doubly-linked sequential files.
  16.  
  17.      lseq uses the blkio library for file access and buffering.
  18.      Therefore bexit should be used in place of exit when using lseq.
  19.  
  20. SEE ALSO
  21.      lsclose, lscreate, lscursor, lsdelcur, lsfirst, lsgetcur,
  22.      lsgetlck, lsgetr, lsgetrf, lsinsert, lslast, lslock, lsnext,
  23.      lsopen, lsprev, lsputr, lsputrf, lsreccnt, lsrecsize, lssearch,
  24.      lssetbuf, lssetcur, lssetvbuf, lssync.
  25.  
  26. ------------------------------------------------------------------------------*/
  27. #ifndef H_LSEQ        /* prevent multiple includes */
  28. #define H_LSEQ
  29.  
  30. /* #ident    "@(#)lseq.h    1.7 - 93/01/01" */
  31.  
  32. #include <port.h>
  33.  
  34. /* standard headers */
  35. #ifdef AC_STDDEF
  36. #include <stddef.h>
  37. #endif
  38.  
  39. /* library headers */
  40. #include <blkio.h>
  41.  
  42. /* constants */
  43. #define LSOPEN_MAX    BOPEN_MAX    /* max # lseqs open at once */
  44. #define LSBUFCNT    ((size_t)10)    /* default # of records to buffer */
  45.  
  46. /* macro to calculate buffer size needed by an lseq */
  47. #define LSBUFSIZ(RECSIZE, BUFCNT) ((size_t)(                \
  48.     sizeof(lshdr_t) +                        \
  49.     (BUFCNT) * (offsetof(lsrec_t, recbuf) + (RECSIZE)        \
  50. ))
  51.  
  52. /* type definitions */
  53. typedef bpos_t    lspos_t;    /* lseq position */
  54. #ifdef AC_PROTO
  55. typedef int (*lscmp_t)(const void *p1, const void *p2, size_t n);
  56. #else
  57. typedef int (*lscmp_t)();
  58. #endif
  59.  
  60. typedef struct {        /* lseq record */
  61.     lspos_t    next;        /* next record in list */
  62.     lspos_t    prev;        /* previous record in list */
  63.     void *    recbuf;        /* record contents */
  64. } lsrec_t;
  65.  
  66. typedef struct {        /* lseq file header */
  67.     bpos_t    flh;        /* position of free list head */
  68.     size_t    recsize;    /* record size */
  69.     int    flags;        /* flags */
  70.     lspos_t    first;        /* position of first record */
  71.     lspos_t    last;        /* position of last record */
  72.     unsigned long reccnt;    /* number records currently in lseq */
  73. } lshdr_t;
  74.  
  75. typedef struct {        /* lseq control structure */
  76.     lshdr_t    lshdr;        /* file header */
  77.     BLKFILE *bp;        /* block file */
  78.     int    flags;        /* status flags */
  79.     lspos_t    clspos;        /* current lseq position */
  80.     lsrec_t *clsrp;        /* current record */
  81. } lseq_t;
  82.  
  83. /* function declarations */
  84. #ifdef AC_PROTO
  85. int        lsclose(lseq_t *lsp);
  86. int        lscreate(const char *filename, size_t recsize);
  87. int        lsdelcur(lseq_t *lsp);
  88. int        lsfirst(lseq_t *lsp);
  89. int        lsgetcur(lseq_t *lsp, lspos_t *lsposp);
  90. int        lsgetlck(lseq_t *lsp);
  91. int        lsgetr(lseq_t *lsp, void *buf);
  92. int        lsgetrf(lseq_t *lsp, size_t offset, void *buf, size_t bufsize);
  93. int        lsinsert(lseq_t *lsp, const void *buf);
  94. int        lslast(lseq_t *lsp);
  95. int        lslock(lseq_t *lsp, int ltype);
  96. int        lsnext(lseq_t *lsp);
  97. lseq_t *    lsopen(const char *filename, const char *type);
  98. int        lsprev(lseq_t *lsp);
  99. int        lsputr(lseq_t *lsp, const void *buf);
  100. int        lsputrf(lseq_t *lsp, size_t offset, const void *buf,
  101.             size_t bufsize);
  102. int        lssearch(lseq_t *lsp, size_t offset, const void *buf,
  103.             size_t bufsize, lscmp_t cmp);
  104. int        lssetbuf(lseq_t *lsp, void *buf);
  105. int        lssetcur(lseq_t *lsp, const lspos_t *lsposp);
  106. int        lssetvbuf(lseq_t *lsp, void *buf, size_t bufcnt);
  107. int        lssync(lseq_t *lsp);
  108. #else
  109. int        lsclose();
  110. int        lscreate();
  111. int        lsdelcur();
  112. int        lsfirst();
  113. int        lsgetcur();
  114. int        lsgetlck();
  115. int        lsgetr();
  116. int        lsgetrf();
  117. int        lsinsert();
  118. int        lslast();
  119. int        lslock();
  120. int        lsnext();
  121. lseq_t *    lsopen();
  122. int        lsprev();
  123. int        lsputr();
  124. int        lsputrf();
  125. int        lssearch();
  126. int        lssetbuf();
  127. int        lssetcur();
  128. int        lssetvbuf();
  129. int        lssync();
  130. #endif    /* #ifdef AC_PROTO */
  131.  
  132. /* macros */
  133. #define    lscursor(LSP)    ((void *)(                    \
  134.     (LSP)->clspos == NIL ? NULL : ((char *)NULL + 1)        \
  135. ))
  136. #define    lsreccnt(LSP)    ((LSP)->lshdr.reccnt)
  137. #define    lsrecsize(LSP)    ((LSP)->lshdr.recsize)
  138.  
  139. /* lock types */
  140. #define LS_UNLCK    (0)    /* unlock */
  141. #define LS_RDLCK    (1)    /* read lock */
  142. #define LS_WRLCK    (2)    /* write lock */
  143. #define LS_RDLKW    (3)    /* read lock, wait */
  144. #define LS_WRLKW    (4)    /* write lock, wait */
  145.  
  146. /* lseq error codes */
  147. #define LSEOS        (-20)    /* start of lseq error code domain */
  148. #define LSEMFILE    (LSEOS - 1)    /* too many open lseqs */
  149. #define LSECORRUPT    (LSEOS - 2)    /* lseq is corrupt */
  150. #define LSENOPEN    (LSEOS - 3)    /* lseq not open */
  151. #define LSENBUF        (LSEOS - 4)    /* buffering is off */
  152. #define LSELOCK        (LSEOS - 5)    /* incorrect lock type */
  153. #define LSENREC        (LSEOS - 6)    /* no record */
  154. #define LSEBOUND    (LSEOS - 7)    /* record boundary error */
  155. #define LSEEOF        (LSEOS - 8)    /* past end of file */
  156. #define LSEFATAL    (LSEOS - 9)    /* internal lseq error */
  157.  
  158. #endif        /* #ifndef H_LSEQ */
  159.