fts3_hash.h.svn-base
上传用户:sunhongbo
上传日期:2022-01-25
资源大小:3010k
文件大小:4k
源码类别:

数据库系统

开发平台:

C/C++

  1. /*
  2. ** 2001 September 22
  3. **
  4. ** The author disclaims copyright to this source code.  In place of
  5. ** a legal notice, here is a blessing:
  6. **
  7. **    May you do good and not evil.
  8. **    May you find forgiveness for yourself and forgive others.
  9. **    May you share freely, never taking more than you give.
  10. **
  11. *************************************************************************
  12. ** This is the header file for the generic hash-table implemenation
  13. ** used in SQLite.  We've modified it slightly to serve as a standalone
  14. ** hash table implementation for the full-text indexing module.
  15. **
  16. */
  17. #ifndef _FTS3_HASH_H_
  18. #define _FTS3_HASH_H_
  19. /* Forward declarations of structures. */
  20. typedef struct fts3Hash fts3Hash;
  21. typedef struct fts3HashElem fts3HashElem;
  22. /* A complete hash table is an instance of the following structure.
  23. ** The internals of this structure are intended to be opaque -- client
  24. ** code should not attempt to access or modify the fields of this structure
  25. ** directly.  Change this structure only by using the routines below.
  26. ** However, many of the "procedures" and "functions" for modifying and
  27. ** accessing this structure are really macros, so we can't really make
  28. ** this structure opaque.
  29. */
  30. struct fts3Hash {
  31.   char keyClass;          /* HASH_INT, _POINTER, _STRING, _BINARY */
  32.   char copyKey;           /* True if copy of key made on insert */
  33.   int count;              /* Number of entries in this table */
  34.   fts3HashElem *first;    /* The first element of the array */
  35.   int htsize;             /* Number of buckets in the hash table */
  36.   struct _fts3ht {        /* the hash table */
  37.     int count;               /* Number of entries with this hash */
  38.     fts3HashElem *chain;     /* Pointer to first entry with this hash */
  39.   } *ht;
  40. };
  41. /* Each element in the hash table is an instance of the following 
  42. ** structure.  All elements are stored on a single doubly-linked list.
  43. **
  44. ** Again, this structure is intended to be opaque, but it can't really
  45. ** be opaque because it is used by macros.
  46. */
  47. struct fts3HashElem {
  48.   fts3HashElem *next, *prev; /* Next and previous elements in the table */
  49.   void *data;                /* Data associated with this element */
  50.   void *pKey; int nKey;      /* Key associated with this element */
  51. };
  52. /*
  53. ** There are 2 different modes of operation for a hash table:
  54. **
  55. **   FTS3_HASH_STRING        pKey points to a string that is nKey bytes long
  56. **                           (including the null-terminator, if any).  Case
  57. **                           is respected in comparisons.
  58. **
  59. **   FTS3_HASH_BINARY        pKey points to binary data nKey bytes long. 
  60. **                           memcmp() is used to compare keys.
  61. **
  62. ** A copy of the key is made if the copyKey parameter to fts3HashInit is 1.  
  63. */
  64. #define FTS3_HASH_STRING    1
  65. #define FTS3_HASH_BINARY    2
  66. /*
  67. ** Access routines.  To delete, insert a NULL pointer.
  68. */
  69. void sqlite3Fts3HashInit(fts3Hash*, int keytype, int copyKey);
  70. void *sqlite3Fts3HashInsert(fts3Hash*, const void *pKey, int nKey, void *pData);
  71. void *sqlite3Fts3HashFind(const fts3Hash*, const void *pKey, int nKey);
  72. void sqlite3Fts3HashClear(fts3Hash*);
  73. /*
  74. ** Shorthand for the functions above
  75. */
  76. #define fts3HashInit   sqlite3Fts3HashInit
  77. #define fts3HashInsert sqlite3Fts3HashInsert
  78. #define fts3HashFind   sqlite3Fts3HashFind
  79. #define fts3HashClear  sqlite3Fts3HashClear
  80. /*
  81. ** Macros for looping over all elements of a hash table.  The idiom is
  82. ** like this:
  83. **
  84. **   fts3Hash h;
  85. **   fts3HashElem *p;
  86. **   ...
  87. **   for(p=fts3HashFirst(&h); p; p=fts3HashNext(p)){
  88. **     SomeStructure *pData = fts3HashData(p);
  89. **     // do something with pData
  90. **   }
  91. */
  92. #define fts3HashFirst(H)  ((H)->first)
  93. #define fts3HashNext(E)   ((E)->next)
  94. #define fts3HashData(E)   ((E)->data)
  95. #define fts3HashKey(E)    ((E)->pKey)
  96. #define fts3HashKeysize(E) ((E)->nKey)
  97. /*
  98. ** Number of entries in a hash table
  99. */
  100. #define fts3HashCount(H)  ((H)->count)
  101. #endif /* _FTS3_HASH_H_ */