src/include/tsearch/ts_cache.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * ts_cache.h
   4  *        Tsearch related object caches.
   5  *
   6  * Portions Copyright (c) 1996-2009, PostgreSQL Global Development Group
   7  * Portions Copyright (c) 1994, Regents of the University of California
   8  *
   9  * $PostgreSQL$
  10  *
  11  *-------------------------------------------------------------------------
  12  */
  13 #ifndef TS_CACHE_H
  14 #define TS_CACHE_H
  15
  16 #include "fmgr.h"
  17 #include "utils/guc.h"
  18
  19
  20 /*
  21  * All TS*CacheEntry structs must share this common header
  22  * (see InvalidateTSCacheCallBack)
  23  */
  24 typedef struct TSAnyCacheEntry
  25 {
  26         Oid                     objId;
  27         bool            isvalid;
  28 } TSAnyCacheEntry;
  29
  30
  31 typedef struct TSParserCacheEntry
  32 {
  33         /* prsId is the hash lookup key and MUST BE FIRST */
  34         Oid                     prsId;                  /* OID of the parser */
  35         bool            isvalid;
  36
  37         Oid                     startOid;
  38         Oid                     tokenOid;
  39         Oid                     endOid;
  40         Oid                     headlineOid;
  41         Oid                     lextypeOid;
  42
  43         /*
  44          * Pre-set-up fmgr call of most needed parser's methods
  45          */
  46         FmgrInfo        prsstart;
  47         FmgrInfo        prstoken;
  48         FmgrInfo        prsend;
  49         FmgrInfo        prsheadline;
  50 } TSParserCacheEntry;
  51
  52 typedef struct TSDictionaryCacheEntry
  53 {
  54         /* dictId is the hash lookup key and MUST BE FIRST */
  55         Oid                     dictId;
  56         bool            isvalid;
  57
  58         /* most frequent fmgr call */
  59         Oid                     lexizeOid;
  60         FmgrInfo        lexize;
  61
  62         MemoryContext dictCtx;          /* memory context to store private data */
  63         void       *dictData;
  64 } TSDictionaryCacheEntry;
  65
  66 typedef struct
  67 {
  68         int                     len;
  69         Oid                *dictIds;
  70 } ListDictionary;
  71
  72 typedef struct
  73 {
  74         /* cfgId is the hash lookup key and MUST BE FIRST */
  75         Oid                     cfgId;
  76         bool            isvalid;
  77
  78         Oid                     prsId;
  79
  80         int                     lenmap;
  81         ListDictionary *map;
  82 } TSConfigCacheEntry;
  83
  84
  85 /*
  86  * GUC variable for current configuration
  87  */
  88 extern char *TSCurrentConfig;
  89
  90
  91 extern TSParserCacheEntry *lookup_ts_parser_cache(Oid prsId);
  92 extern TSDictionaryCacheEntry *lookup_ts_dictionary_cache(Oid dictId);
  93 extern TSConfigCacheEntry *lookup_ts_config_cache(Oid cfgId);
  94
  95 extern Oid      getTSCurrentConfig(bool emitError);
  96 extern const char *assignTSCurrentConfig(const char *newval, bool doit, GucSource source);
  97
  98 #endif   /* TS_CACHE_H */