PostgreSQL Source Code  git master
Data Structures | Macros | Typedefs | Functions | Variables
dict_snowball.c File Reference
#include "postgres.h"
#include "commands/defrem.h"
#include "tsearch/ts_locale.h"
#include "tsearch/ts_utils.h"
#include "snowball/libstemmer/header.h"
#include "snowball/libstemmer/stem_ISO_8859_1_basque.h"
#include "snowball/libstemmer/stem_ISO_8859_1_catalan.h"
#include "snowball/libstemmer/stem_ISO_8859_1_danish.h"
#include "snowball/libstemmer/stem_ISO_8859_1_dutch.h"
#include "snowball/libstemmer/stem_ISO_8859_1_english.h"
#include "snowball/libstemmer/stem_ISO_8859_1_finnish.h"
#include "snowball/libstemmer/stem_ISO_8859_1_french.h"
#include "snowball/libstemmer/stem_ISO_8859_1_german.h"
#include "snowball/libstemmer/stem_ISO_8859_1_indonesian.h"
#include "snowball/libstemmer/stem_ISO_8859_1_irish.h"
#include "snowball/libstemmer/stem_ISO_8859_1_italian.h"
#include "snowball/libstemmer/stem_ISO_8859_1_norwegian.h"
#include "snowball/libstemmer/stem_ISO_8859_1_porter.h"
#include "snowball/libstemmer/stem_ISO_8859_1_portuguese.h"
#include "snowball/libstemmer/stem_ISO_8859_1_spanish.h"
#include "snowball/libstemmer/stem_ISO_8859_1_swedish.h"
#include "snowball/libstemmer/stem_ISO_8859_2_hungarian.h"
#include "snowball/libstemmer/stem_ISO_8859_2_romanian.h"
#include "snowball/libstemmer/stem_KOI8_R_russian.h"
#include "snowball/libstemmer/stem_UTF_8_arabic.h"
#include "snowball/libstemmer/stem_UTF_8_armenian.h"
#include "snowball/libstemmer/stem_UTF_8_basque.h"
#include "snowball/libstemmer/stem_UTF_8_catalan.h"
#include "snowball/libstemmer/stem_UTF_8_danish.h"
#include "snowball/libstemmer/stem_UTF_8_dutch.h"
#include "snowball/libstemmer/stem_UTF_8_english.h"
#include "snowball/libstemmer/stem_UTF_8_finnish.h"
#include "snowball/libstemmer/stem_UTF_8_french.h"
#include "snowball/libstemmer/stem_UTF_8_german.h"
#include "snowball/libstemmer/stem_UTF_8_greek.h"
#include "snowball/libstemmer/stem_UTF_8_hindi.h"
#include "snowball/libstemmer/stem_UTF_8_hungarian.h"
#include "snowball/libstemmer/stem_UTF_8_indonesian.h"
#include "snowball/libstemmer/stem_UTF_8_irish.h"
#include "snowball/libstemmer/stem_UTF_8_italian.h"
#include "snowball/libstemmer/stem_UTF_8_lithuanian.h"
#include "snowball/libstemmer/stem_UTF_8_nepali.h"
#include "snowball/libstemmer/stem_UTF_8_norwegian.h"
#include "snowball/libstemmer/stem_UTF_8_porter.h"
#include "snowball/libstemmer/stem_UTF_8_portuguese.h"
#include "snowball/libstemmer/stem_UTF_8_romanian.h"
#include "snowball/libstemmer/stem_UTF_8_russian.h"
#include "snowball/libstemmer/stem_UTF_8_serbian.h"
#include "snowball/libstemmer/stem_UTF_8_spanish.h"
#include "snowball/libstemmer/stem_UTF_8_swedish.h"
#include "snowball/libstemmer/stem_UTF_8_tamil.h"
#include "snowball/libstemmer/stem_UTF_8_turkish.h"
#include "snowball/libstemmer/stem_UTF_8_yiddish.h"
Include dependency graph for dict_snowball.c:

Go to the source code of this file.

Data Structures

struct  stemmer_module
 
struct  DictSnowball
 

Macros

#define STEMMER_MODULE(name, enc, senc)    {#name, enc, name##_##senc##_create_env, name##_##senc##_close_env, name##_##senc##_stem}
 

Typedefs

typedef struct stemmer_module stemmer_module
 
typedef struct DictSnowball DictSnowball
 

Functions

 PG_FUNCTION_INFO_V1 (dsnowball_init)
 
 PG_FUNCTION_INFO_V1 (dsnowball_lexize)
 
static void locate_stem_module (DictSnowball *d, const char *lang)
 
Datum dsnowball_init (PG_FUNCTION_ARGS)
 
Datum dsnowball_lexize (PG_FUNCTION_ARGS)
 

Variables

 PG_MODULE_MAGIC
 
static const stemmer_module stemmer_modules []
 

Macro Definition Documentation

◆ STEMMER_MODULE

#define STEMMER_MODULE (   name,
  enc,
  senc 
)     {#name, enc, name##_##senc##_create_env, name##_##senc##_close_env, name##_##senc##_stem}

Definition at line 95 of file dict_snowball.c.

Typedef Documentation

◆ DictSnowball

typedef struct DictSnowball DictSnowball

◆ stemmer_module

typedef struct stemmer_module stemmer_module

Function Documentation

◆ dsnowball_init()

Datum dsnowball_init ( PG_FUNCTION_ARGS  )

Definition at line 220 of file dict_snowball.c.

221 {
222  List *dictoptions = (List *) PG_GETARG_POINTER(0);
223  DictSnowball *d;
224  bool stoploaded = false;
225  ListCell *l;
226 
227  d = (DictSnowball *) palloc0(sizeof(DictSnowball));
228 
229  foreach(l, dictoptions)
230  {
231  DefElem *defel = (DefElem *) lfirst(l);
232 
233  if (strcmp(defel->defname, "stopwords") == 0)
234  {
235  if (stoploaded)
236  ereport(ERROR,
237  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
238  errmsg("multiple StopWords parameters")));
239  readstoplist(defGetString(defel), &d->stoplist, lowerstr);
240  stoploaded = true;
241  }
242  else if (strcmp(defel->defname, "language") == 0)
243  {
244  if (d->stem)
245  ereport(ERROR,
246  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
247  errmsg("multiple Language parameters")));
248  locate_stem_module(d, defGetString(defel));
249  }
250  else
251  {
252  ereport(ERROR,
253  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
254  errmsg("unrecognized Snowball parameter: \"%s\"",
255  defel->defname)));
256  }
257  }
258 
259  if (!d->stem)
260  ereport(ERROR,
261  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
262  errmsg("missing Language parameter")));
263 
264  d->dictCtx = CurrentMemoryContext;
265 
266  PG_RETURN_POINTER(d);
267 }
defGetString
char * defGetString(DefElem *def)
Definition: define.c:49
locate_stem_module
static void locate_stem_module(DictSnowball *d, const char *lang)
Definition: dict_snowball.c:179
errcode
int errcode(int sqlerrcode)
Definition: elog.c:858
errmsg
int errmsg(const char *fmt,...)
Definition: elog.c:1069
ERROR
#define ERROR
Definition: elog.h:39
ereport
#define ereport(elevel,...)
Definition: elog.h:149
PG_GETARG_POINTER
#define PG_GETARG_POINTER(n)
Definition: fmgr.h:276
PG_RETURN_POINTER
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:361
palloc0
void * palloc0(Size size)
Definition: mcxt.c:1257
CurrentMemoryContext
MemoryContext CurrentMemoryContext
Definition: mcxt.c:135
lfirst
#define lfirst(lc)
Definition: pg_list.h:172
DefElem::defname
char * defname
Definition: parsenodes.h:802
DictSnowball::dictCtx
MemoryContext dictCtx
Definition: dict_snowball.c:174
DictSnowball::stoplist
StopList stoplist
Definition: dict_snowball.c:165
DictSnowball::stem
int(* stem)(struct SN_env *z)
Definition: dict_snowball.c:167
List
Definition: pg_list.h:54
lowerstr
char * lowerstr(const char *str)
Definition: ts_locale.c:255
readstoplist
void readstoplist(const char *fname, StopList *s, char *(*wordop)(const char *))
Definition: ts_utils.c:68

References CurrentMemoryContext, defGetString(), DefElem::defname, DictSnowball::dictCtx, ereport, errcode(), errmsg(), ERROR, SN_env::l, lfirst, locate_stem_module(), lowerstr(), palloc0(), PG_GETARG_POINTER, PG_RETURN_POINTER, readstoplist(), DictSnowball::stem, and DictSnowball::stoplist.

◆ dsnowball_lexize()

Datum dsnowball_lexize ( PG_FUNCTION_ARGS  )

Definition at line 270 of file dict_snowball.c.

271 {
272  DictSnowball *d = (DictSnowball *) PG_GETARG_POINTER(0);
273  char *in = (char *) PG_GETARG_POINTER(1);
274  int32 len = PG_GETARG_INT32(2);
275  char *txt = lowerstr_with_len(in, len);
276  TSLexeme *res = palloc0(sizeof(TSLexeme) * 2);
277 
278  /*
279  * Do not pass strings exceeding 1000 bytes to the stemmer, as they're
280  * surely not words in any human language. This restriction avoids
281  * wasting cycles on stuff like base64-encoded data, and it protects us
282  * against possible inefficiency or misbehavior in the stemmer. (For
283  * example, the Turkish stemmer has an indefinite recursion, so it can
284  * crash on long-enough strings.) However, Snowball dictionaries are
285  * defined to recognize all strings, so we can't reject the string as an
286  * unknown word.
287  */
288  if (len > 1000)
289  {
290  /* return the lexeme lowercased, but otherwise unmodified */
291  res->lexeme = txt;
292  }
293  else if (*txt == '\0' || searchstoplist(&(d->stoplist), txt))
294  {
295  /* empty or stopword, so report as stopword */
296  pfree(txt);
297  }
298  else
299  {
300  MemoryContext saveCtx;
301 
302  /*
303  * recode to utf8 if stemmer is utf8 and doesn't match server encoding
304  */
305  if (d->needrecode)
306  {
307  char *recoded;
308 
309  recoded = pg_server_to_any(txt, strlen(txt), PG_UTF8);
310  if (recoded != txt)
311  {
312  pfree(txt);
313  txt = recoded;
314  }
315  }
316 
317  /* see comment about d->dictCtx */
318  saveCtx = MemoryContextSwitchTo(d->dictCtx);
319  SN_set_current(d->z, strlen(txt), (symbol *) txt);
320  d->stem(d->z);
321  MemoryContextSwitchTo(saveCtx);
322 
323  if (d->z->p && d->z->l)
324  {
325  txt = repalloc(txt, d->z->l + 1);
326  memcpy(txt, d->z->p, d->z->l);
327  txt[d->z->l] = '\0';
328  }
329 
330  /* back recode if needed */
331  if (d->needrecode)
332  {
333  char *recoded;
334 
335  recoded = pg_any_to_server(txt, strlen(txt), PG_UTF8);
336  if (recoded != txt)
337  {
338  pfree(txt);
339  txt = recoded;
340  }
341  }
342 
343  res->lexeme = txt;
344  }
345 
346  PG_RETURN_POINTER(res);
347 }
SN_set_current
int SN_set_current(struct SN_env *z, int size, const symbol *s)
Definition: api.c:51
symbol
unsigned char symbol
Definition: api.h:2
int32
signed int int32
Definition: c.h:483
PG_GETARG_INT32
#define PG_GETARG_INT32(n)
Definition: fmgr.h:269
pg_any_to_server
char * pg_any_to_server(const char *s, int len, int encoding)
Definition: mbutils.c:677
pg_server_to_any
char * pg_server_to_any(const char *s, int len, int encoding)
Definition: mbutils.c:750
pfree
void pfree(void *pointer)
Definition: mcxt.c:1456
repalloc
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1476
MemoryContextSwitchTo
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:138
len
const void size_t len
Definition: pg_crc32c_sse42.c:24
PG_UTF8
@ PG_UTF8
Definition: pg_wchar.h:235
DictSnowball::z
struct SN_env * z
Definition: dict_snowball.c:164
SN_env::p
symbol * p
Definition: api.h:15
SN_env::l
int l
Definition: api.h:16
lowerstr_with_len
char * lowerstr_with_len(const char *str, int len)
Definition: ts_locale.c:268
searchstoplist
bool searchstoplist(StopList *s, char *key)
Definition: ts_utils.c:140

References DictSnowball::dictCtx, SN_env::l, len, lowerstr_with_len(), MemoryContextSwitchTo(), DictSnowball::needrecode, SN_env::p, palloc0(), pfree(), pg_any_to_server(), PG_GETARG_INT32, PG_GETARG_POINTER, PG_RETURN_POINTER, pg_server_to_any(), PG_UTF8, repalloc(), res, searchstoplist(), SN_set_current(), DictSnowball::stem, DictSnowball::stoplist, and DictSnowball::z.

◆ locate_stem_module()

static void locate_stem_module ( DictSnowball *  d,
const char *  lang 
)
static

Definition at line 179 of file dict_snowball.c.

180 {
181  const stemmer_module *m;
182 
183  /*
184  * First, try to find exact match of stemmer module. Stemmer with
185  * PG_SQL_ASCII encoding is treated as working with any server encoding
186  */
187  for (m = stemmer_modules; m->name; m++)
188  {
189  if ((m->enc == PG_SQL_ASCII || m->enc == GetDatabaseEncoding()) &&
190  pg_strcasecmp(m->name, lang) == 0)
191  {
192  d->stem = m->stem;
193  d->z = m->create();
194  d->needrecode = false;
195  return;
196  }
197  }
198 
199  /*
200  * Second, try to find stemmer for needed language for UTF8 encoding.
201  */
202  for (m = stemmer_modules; m->name; m++)
203  {
204  if (m->enc == PG_UTF8 && pg_strcasecmp(m->name, lang) == 0)
205  {
206  d->stem = m->stem;
207  d->z = m->create();
208  d->needrecode = true;
209  return;
210  }
211  }
212 
213  ereport(ERROR,
214  (errcode(ERRCODE_UNDEFINED_OBJECT),
215  errmsg("no Snowball stemmer available for language \"%s\" and encoding \"%s\"",
216  lang, GetDatabaseEncodingName())));
217 }
stemmer_modules
static const stemmer_module stemmer_modules[]
Definition: dict_snowball.c:98
GetDatabaseEncoding
int GetDatabaseEncoding(void)
Definition: mbutils.c:1268
GetDatabaseEncodingName
const char * GetDatabaseEncodingName(void)
Definition: mbutils.c:1274
PG_SQL_ASCII
@ PG_SQL_ASCII
Definition: pg_wchar.h:229
pg_strcasecmp
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
stemmer_module
Definition: dict_snowball.c:86
stemmer_module::name
const char * name
Definition: dict_snowball.c:87
stemmer_module::enc
pg_enc enc
Definition: dict_snowball.c:88
stemmer_module::stem
int(* stem)(struct SN_env *)
Definition: dict_snowball.c:91
stemmer_module::create
struct SN_env *(* create)(void)
Definition: dict_snowball.c:89

References stemmer_module::create, stemmer_module::enc, ereport, errcode(), errmsg(), ERROR, GetDatabaseEncoding(), GetDatabaseEncodingName(), stemmer_module::name, DictSnowball::needrecode, PG_SQL_ASCII, pg_strcasecmp(), PG_UTF8, stemmer_module::stem, DictSnowball::stem, stemmer_modules, and DictSnowball::z.

Referenced by dsnowball_init().

◆ PG_FUNCTION_INFO_V1() [1/2]

PG_FUNCTION_INFO_V1 ( dsnowball_init  )

◆ PG_FUNCTION_INFO_V1() [2/2]

PG_FUNCTION_INFO_V1 ( dsnowball_lexize  )

Variable Documentation

◆ PG_MODULE_MAGIC

PG_MODULE_MAGIC

Definition at line 78 of file dict_snowball.c.

◆ stemmer_modules

const stemmer_module stemmer_modules[]
static

Definition at line 98 of file dict_snowball.c.

Referenced by locate_stem_module().