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-2009, 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                                 skip:1,
  42                                 unused:3,
  43                                 type:8,
  44                                 len:16;
  45         char       *word;
  46         QueryOperand *item;
  47 } HeadlineWordEntry;
  48
  49 typedef struct
  50 {
  51         HeadlineWordEntry *words;
  52         int4            lenwords;
  53         int4            curwords;
  54         char       *startsel;
  55         char       *stopsel;
  56         char       *fragdelim;
  57         int2            startsellen;
  58         int2            stopsellen;
  59         int2            fragdelimlen;
  60 } HeadlineParsedText;
  61
  62 /*
  63  * Common useful things for tsearch subsystem
  64  */
  65 extern char *get_tsearch_config_filename(const char *basename,
  66                                                         const char *extension);
  67
  68 /*
  69  * Often useful stopword list management
  70  */
  71 typedef struct
  72 {
  73         int                     len;
  74         char      **stop;
  75 } StopList;
  76
  77 extern void readstoplist(const char *fname, StopList *s,
  78                          char *(*wordop) (const char *));
  79 extern bool searchstoplist(StopList *s, char *key);
  80
  81 /*
  82  * Interface with dictionaries
  83  */
  84
  85 /* return struct for any lexize function */
  86 typedef struct
  87 {
  88         /*
  89          * number of variant of split word , for example Word 'fotballklubber'
  90          * (norwegian) has two varian to split: ( fotball, klubb ) and ( fot,
  91          * ball, klubb ). So, dictionary should return: nvariant lexeme 1 fotball
  92          * 1      klubb 2          fot 2          ball 2          klubb
  93          */
  94         uint16          nvariant;
  95
  96         uint16          flags;
  97
  98         /* C-string */
  99         char       *lexeme;
 100 } TSLexeme;
 101
 102 #define TSL_ADDPOS              0x01
 103 #define TSL_PREFIX              0x02
 104
 105 /*
 106  * Struct for supporting complex dictionaries like thesaurus.
 107  * 4th argument for dictlexize method is a pointer to this
 108  */
 109 typedef struct
 110 {
 111         bool            isend;                  /* in: marks for lexize_info about text end is
 112                                                                  * reached */
 113         bool            getnext;                /* out: dict wants next lexeme */
 114         void       *private;            /* internal dict state between calls with
 115                                                                  * getnext == true */
 116 } DictSubState;
 117
 118 #endif   /* _PG_TS_PUBLIC_H_ */