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-2008 Ullrich von Bassewitz                                       */
  10 /*               Roemerstrasse 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 "attrib.h"
  52 #include "coll.h"
  53 #include "inline.h"
  54 #include "strbuf.h"
  55
  56
  57
  58 /*****************************************************************************/
  59 /*                                     Data                                  */
  60 /*****************************************************************************/
  61
  62
  63
  64 /* Opaque string pool entry */
  65 typedef struct StringPoolEntry StringPoolEntry;
  66
  67 /* A string pool */
  68 typedef struct StringPool StringPool;
  69 struct StringPool {
  70     Collection        Entries;    /* Entries sorted by number */
  71     unsigned          TotalSize;  /* Total size of all string data */
  72     StringPoolEntry*  Tab[4177];  /* Entry hash table */
  73 };
  74
  75 /* A string pool initializer. We do only initialize the first field, all
  76  * others will get zeroed out by the compiler.
  77  */
  78 #define STATIC_STRINGPOOL_INITIALIZER {         \
  79     STATIC_COLLECTION_INITIALIZER,              \
  80     0,                                          \
  81     { 0 }                                       \
  82 }
  83
  84
  85
  86 /*****************************************************************************/
  87 /*                                     Code                                  */
  88 /*****************************************************************************/
  89
  90
  91
  92 StringPool* InitStringPool (StringPool* P);
  93 /* Initialize a string pool */
  94
  95 void DoneStringPool (StringPool* P);
  96 /* Free the data of a string pool (but not the data itself) */
  97
  98 StringPool* NewStringPool (void);
  99 /* Allocate, initialize and return a new string pool */
 100
 101 void FreeStringPool (StringPool* P);
 102 /* Free a string pool */
 103
 104 const StrBuf* SP_Get (const StringPool* P, unsigned Index);
 105 /* Return a string from the pool. Index must exist, otherwise FAIL is called. */
 106
 107 unsigned SP_Add (StringPool* P, const StrBuf* S);
 108 /* Add a string buffer to the buffer and return the index. If the string does
 109  * already exist in the pool, SP_AddBuf will just return the index of the
 110  * existing string.
 111  */
 112
 113 unsigned SP_AddStr (StringPool* P, const char* S);
 114 /* Add a string to the buffer and return the index. If the string does already
 115  * exist in the pool, SP_Add will just return the index of the existing string.
 116  */
 117
 118 #if defined(HAVE_INLINE)
 119 INLINE unsigned SP_GetCount (const StringPool* P)
 120 /* Return the number of strings in the pool */
 121 {
 122     return CollCount (&P->Entries);
 123 }
 124 #else
 125 #  define SP_GetCount(P)        CollCount (&(P)->Entries)
 126 #endif
 127
 128
 129
 130 /* End of strpool.h */
 131
 132 #endif
 133
 134
 135