git.sur5r.net Git - cc65/blob - src/common/strpool.h

   1 /*****************************************************************************/
   2 /*                                                                           */
   3 /*                                 strpool.h                                 */
   4 /*                                                                           */
   5 /*                               A string pool                               */
   6 /*                                                                           */
   7 /*                                                                           */
   8 /*                                                                           */
   9 /* (C) 2003      Ullrich von Bassewitz                                       */
  10 /*               Römerstrasse 52                                             */
  11 /*               D-70794 Filderstadt                                         */
  12 /* EMail:        uz@cc65.org                                                 */
  13 /*                                                                           */
  14 /*                                                                           */
  15 /* This software is provided 'as-is', without any expressed or implied       */
  16 /* warranty.  In no event will the authors be held liable for any damages    */
  17 /* arising from the use of this software.                                    */
  18 /*                                                                           */
  19 /* Permission is granted to anyone to use this software for any purpose,     */
  20 /* including commercial applications, and to alter it and redistribute it    */
  21 /* freely, subject to the following restrictions:                            */
  22 /*                                                                           */
  23 /* 1. The origin of this software must not be misrepresented; you must not   */
  24 /*    claim that you wrote the original software. If you use this software   */
  25 /*    in a product, an acknowledgment in the product documentation would be  */
  26 /*    appreciated but is not required.                                       */
  27 /* 2. Altered source versions must be plainly marked as such, and must not   */
  28 /*    be misrepresented as being the original software.                      */
  29 /* 3. This notice may not be removed or altered from any source              */
  30 /*    distribution.                                                          */
  31 /*                                                                           */
  32 /*****************************************************************************/
  33
  34
  35
  36 /* A string pool is used to store identifiers and other strings. Each string
  37  * stored in the pool has a unique id, which may be used to access the string
  38  * in the pool. Identical strings are only stored once in the pool and have
  39  * identical ids. This means that instead of comparing strings, just the
  40  * string pool ids must be compared.
  41  */
  42
  43
  44
  45 #ifndef STRPOOL_H
  46 #define STRPOOL_H
  47
  48
  49
  50 /* common */
  51 #include "coll.h"
  52 #include "inline.h"
  53 #include "strbuf.h"
  54
  55
  56
  57 /*****************************************************************************/
  58 /*                                     Data                                  */
  59 /*****************************************************************************/
  60
  61
  62
  63 /* Opaque string pool entry */
  64 typedef struct StringPoolEntry StringPoolEntry;
  65
  66 /* A string pool */
  67 typedef struct StringPool StringPool;
  68 struct StringPool {
  69     Collection        Entries;    /* Entries sorted by number */
  70     unsigned          TotalSize;  /* Total size of all string data */
  71     StringPoolEntry*  Tab[4177];  /* Entry hash table */
  72 };
  73
  74 /* A string pool initializer. We do only initialize the first field, all
  75  * others will get zeroed out by the compiler.
  76  */
  77 #define STATIC_STRINGPOOL_INITIALIZER {         \
  78     STATIC_COLLECTION_INITIALIZER,              \
  79     0,                                          \
  80     { 0 }                                       \
  81 }
  82
  83
  84
  85 /*****************************************************************************/
  86 /*                                     Code                                  */
  87 /*****************************************************************************/
  88
  89
  90
  91 StringPool* InitStringPool (StringPool* P);
  92 /* Initialize a string pool */
  93
  94 void DoneStringPool (StringPool* P);
  95 /* Free the data of a string pool (but not the data itself) */
  96
  97 StringPool* NewStringPool (void);
  98 /* Allocate, initialize and return a new string pool */
  99
 100 void FreeStringPool (StringPool* P);
 101 /* Free a string pool */
 102
 103 const char* SP_Get (const StringPool* P, unsigned Index);
 104 /* Return a string from the pool. Index must exist, otherwise FAIL is called. */
 105
 106 unsigned SP_Add (StringPool* P, const char* S);
 107 /* Add a string to the buffer and return the index. If the string does already
 108  * exist in the pool, SP_Add will just return the index of the existing string.
 109  */
 110
 111 #if defined(HAVE_INLINE)
 112 INLINE unsigned SP_GetCount (const StringPool* P)
 113 /* Return the number of strings in the pool */
 114 {
 115     return CollCount (&P->Entries);
 116 }
 117 #else
 118 #  define SP_GetCount(P)        CollCount (&(P)->Entries)
 119 #endif
 120
 121
 122
 123 /* End of strpool.h */
 124
 125 #endif
 126
 127
 128