PostgreSQL Source Code  git master
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_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_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 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 92 of file dict_snowball.c.

Typedef Documentation

◆ DictSnowball

typedef struct DictSnowball DictSnowball

◆ stemmer_module

Function Documentation

◆ dsnowball_init()

Datum dsnowball_init ( PG_FUNCTION_ARGS  )

Definition at line 214 of file dict_snowball.c.

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.

215 {
216  List *dictoptions = (List *) PG_GETARG_POINTER(0);
217  DictSnowball *d;
218  bool stoploaded = false;
219  ListCell *l;
220 
221  d = (DictSnowball *) palloc0(sizeof(DictSnowball));
222 
223  foreach(l, dictoptions)
224  {
225  DefElem *defel = (DefElem *) lfirst(l);
226 
227  if (strcmp(defel->defname, "stopwords") == 0)
228  {
229  if (stoploaded)
230  ereport(ERROR,
231  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
232  errmsg("multiple StopWords parameters")));
234  stoploaded = true;
235  }
236  else if (strcmp(defel->defname, "language") == 0)
237  {
238  if (d->stem)
239  ereport(ERROR,
240  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
241  errmsg("multiple Language parameters")));
242  locate_stem_module(d, defGetString(defel));
243  }
244  else
245  {
246  ereport(ERROR,
247  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
248  errmsg("unrecognized Snowball parameter: \"%s\"",
249  defel->defname)));
250  }
251  }
252 
253  if (!d->stem)
254  ereport(ERROR,
255  (errcode(ERRCODE_INVALID_PARAMETER_VALUE),
256  errmsg("missing Language parameter")));
257 
259 
261 }
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:360
StopList stoplist
int errcode(int sqlerrcode)
Definition: elog.c:610
#define PG_GETARG_POINTER(n)
Definition: fmgr.h:276
char * lowerstr(const char *str)
Definition: ts_locale.c:239
int(* stem)(struct SN_env *z)
#define ERROR
Definition: elog.h:43
char * defGetString(DefElem *def)
Definition: define.c:49
MemoryContext CurrentMemoryContext
Definition: mcxt.c:38
void readstoplist(const char *fname, StopList *s, char *(*wordop)(const char *))
Definition: ts_utils.c:68
void * palloc0(Size size)
Definition: mcxt.c:980
#define ereport(elevel,...)
Definition: elog.h:144
static void locate_stem_module(DictSnowball *d, const char *lang)
#define lfirst(lc)
Definition: pg_list.h:190
int errmsg(const char *fmt,...)
Definition: elog.c:824
MemoryContext dictCtx
char * defname
Definition: parsenodes.h:732
Definition: pg_list.h:50

◆ dsnowball_lexize()

Datum dsnowball_lexize ( PG_FUNCTION_ARGS  )

Definition at line 264 of file dict_snowball.c.

References DictSnowball::dictCtx, SN_env::l, TSLexeme::lexeme, 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(), searchstoplist(), SN_set_current(), DictSnowball::stem, DictSnowball::stoplist, and DictSnowball::z.

265 {
267  char *in = (char *) PG_GETARG_POINTER(1);
268  int32 len = PG_GETARG_INT32(2);
269  char *txt = lowerstr_with_len(in, len);
270  TSLexeme *res = palloc0(sizeof(TSLexeme) * 2);
271 
272  if (*txt == '\0' || searchstoplist(&(d->stoplist), txt))
273  {
274  pfree(txt);
275  }
276  else
277  {
278  MemoryContext saveCtx;
279 
280  /*
281  * recode to utf8 if stemmer is utf8 and doesn't match server encoding
282  */
283  if (d->needrecode)
284  {
285  char *recoded;
286 
287  recoded = pg_server_to_any(txt, strlen(txt), PG_UTF8);
288  if (recoded != txt)
289  {
290  pfree(txt);
291  txt = recoded;
292  }
293  }
294 
295  /* see comment about d->dictCtx */
296  saveCtx = MemoryContextSwitchTo(d->dictCtx);
297  SN_set_current(d->z, strlen(txt), (symbol *) txt);
298  d->stem(d->z);
299  MemoryContextSwitchTo(saveCtx);
300 
301  if (d->z->p && d->z->l)
302  {
303  txt = repalloc(txt, d->z->l + 1);
304  memcpy(txt, d->z->p, d->z->l);
305  txt[d->z->l] = '\0';
306  }
307 
308  /* back recode if needed */
309  if (d->needrecode)
310  {
311  char *recoded;
312 
313  recoded = pg_any_to_server(txt, strlen(txt), PG_UTF8);
314  if (recoded != txt)
315  {
316  pfree(txt);
317  txt = recoded;
318  }
319  }
320 
321  res->lexeme = txt;
322  }
323 
324  PG_RETURN_POINTER(res);
325 }
#define PG_RETURN_POINTER(x)
Definition: fmgr.h:360
#define PG_GETARG_INT32(n)
Definition: fmgr.h:269
StopList stoplist
symbol * p
Definition: api.h:15
int SN_set_current(struct SN_env *z, int size, const symbol *s)
Definition: api.c:58
char * lowerstr_with_len(const char *str, int len)
Definition: ts_locale.c:252
static MemoryContext MemoryContextSwitchTo(MemoryContext context)
Definition: palloc.h:109
#define PG_GETARG_POINTER(n)
Definition: fmgr.h:276
int(* stem)(struct SN_env *z)
char * pg_server_to_any(const char *s, int len, int encoding)
Definition: mbutils.c:692
signed int int32
Definition: c.h:362
void pfree(void *pointer)
Definition: mcxt.c:1056
char * lexeme
Definition: ts_public.h:111
void * palloc0(Size size)
Definition: mcxt.c:980
void * repalloc(void *pointer, Size size)
Definition: mcxt.c:1069
struct SN_env * z
bool searchstoplist(StopList *s, char *key)
Definition: ts_utils.c:141
MemoryContext dictCtx
int l
Definition: api.h:16
char * pg_any_to_server(const char *s, int len, int encoding)
Definition: mbutils.c:619
unsigned char symbol
Definition: api.h:2

◆ locate_stem_module()

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

Definition at line 173 of file dict_snowball.c.

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, and DictSnowball::z.

Referenced by dsnowball_init().

174 {
175  const stemmer_module *m;
176 
177  /*
178  * First, try to find exact match of stemmer module. Stemmer with
179  * PG_SQL_ASCII encoding is treated as working with any server encoding
180  */
181  for (m = stemmer_modules; m->name; m++)
182  {
183  if ((m->enc == PG_SQL_ASCII || m->enc == GetDatabaseEncoding()) &&
184  pg_strcasecmp(m->name, lang) == 0)
185  {
186  d->stem = m->stem;
187  d->z = m->create();
188  d->needrecode = false;
189  return;
190  }
191  }
192 
193  /*
194  * Second, try to find stemmer for needed language for UTF8 encoding.
195  */
196  for (m = stemmer_modules; m->name; m++)
197  {
198  if (m->enc == PG_UTF8 && pg_strcasecmp(m->name, lang) == 0)
199  {
200  d->stem = m->stem;
201  d->z = m->create();
202  d->needrecode = true;
203  return;
204  }
205  }
206 
207  ereport(ERROR,
208  (errcode(ERRCODE_UNDEFINED_OBJECT),
209  errmsg("no Snowball stemmer available for language \"%s\" and encoding \"%s\"",
210  lang, GetDatabaseEncodingName())));
211 }
int errcode(int sqlerrcode)
Definition: elog.c:610
int(* stem)(struct SN_env *z)
int pg_strcasecmp(const char *s1, const char *s2)
Definition: pgstrcasecmp.c:36
#define ERROR
Definition: elog.h:43
struct SN_env *(* create)(void)
Definition: dict_snowball.c:86
int GetDatabaseEncoding(void)
Definition: mbutils.c:1151
#define ereport(elevel,...)
Definition: elog.h:144
const char * GetDatabaseEncodingName(void)
Definition: mbutils.c:1157
static const stemmer_module stemmer_modules[]
Definition: dict_snowball.c:95
int(* stem)(struct SN_env *)
Definition: dict_snowball.c:88
struct SN_env * z
int errmsg(const char *fmt,...)
Definition: elog.c:824
const char * name
Definition: dict_snowball.c:84

◆ 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 75 of file dict_snowball.c.

◆ stemmer_modules

const stemmer_module stemmer_modules[]
static

Definition at line 95 of file dict_snowball.c.