src/include/tsearch/ts_public.h

   1 /*-------------------------------------------------------------------------
   2  *
   3  * ts_public.h
   4  *        Public interface to various tsearch modules, such as
   5  *        parsers and dictionaries.
   6  *
   7  * Copyright (c) 1998-2008, PostgreSQL Global Development Group
   8  *
   9  * $PostgreSQL$
  10  *
  11  *-------------------------------------------------------------------------
  12  */
  13 #ifndef _PG_TS_PUBLIC_H_
  14 #define _PG_TS_PUBLIC_H_
  15
  16 #include "tsearch/ts_type.h"
  17
  18 /*
  19  * Parser's framework
  20  */
  21
  22 /*
  23  * returning type for prslextype method of parser
  24  */
  25 typedef struct
  26 {
  27         int                     lexid;
  28         char       *alias;
  29         char       *descr;
  30 } LexDescr;
  31
  32 /*
  33  * Interface to headline generator
  34  */
  35 typedef struct
  36 {
  37         uint32          selected:1,
  38                                 in:1,
  39                                 replace:1,
  40                                 repeated:1,
  41                                 unused:4,
  42                                 type:8,
  43                                 len:16;
  44         char       *word;
  45         QueryOperand *item;
  46 } HeadlineWordEntry;
  47
  48 typedef struct
  49 {
  50         HeadlineWordEntry *words;
  51         int4            lenwords;
  52         int4            curwords;
  53         char       *startsel;
  54         char       *stopsel;
  55         int2            startsellen;
  56         int2            stopsellen;
  57 } HeadlineParsedText;
  58
  59 /*
  60  * Common useful things for tsearch subsystem
  61  */
  62 extern char *get_tsearch_config_filename(const char *basename,
  63                                                         const char *extension);
  64
  65 /*
  66  * Often useful stopword list management
  67  */
  68 typedef struct
  69 {
  70         int                     len;
  71         char      **stop;
  72 } StopList;
  73
  74 extern void readstoplist(const char *fname, StopList *s,
  75                          char *(*wordop) (const char *));
  76 extern bool searchstoplist(StopList *s, char *key);
  77
  78 /*
  79  * Interface with dictionaries
  80  */
  81
  82 /* return struct for any lexize function */
  83 typedef struct
  84 {
  85         /*
  86          * number of variant of split word , for example Word 'fotballklubber'
  87          * (norwegian) has two varian to split: ( fotball, klubb ) and ( fot,
  88          * ball, klubb ). So, dictionary should return: nvariant lexeme 1 fotball
  89          * 1      klubb 2          fot 2          ball 2          klubb
  90          */
  91         uint16          nvariant;
  92
  93         uint16          flags;
  94
  95         /* C-string */
  96         char       *lexeme;
  97 } TSLexeme;
  98
  99 #define TSL_ADDPOS              0x01
 100 #define TSL_PREFIX              0x02
 101
 102 /*
 103  * Struct for supporting complex dictionaries like thesaurus.
 104  * 4th argument for dictlexize method is a pointer to this
 105  */
 106 typedef struct
 107 {
 108         bool            isend;                  /* in: marks for lexize_info about text end is
 109                                                                  * reached */
 110         bool            getnext;                /* out: dict wants next lexeme */
 111         void       *private;            /* internal dict state between calls with
 112                                                                  * getnext == true */
 113 } DictSubState;
 114
 115 #endif   /* _PG_TS_PUBLIC_H_ */