spell.h

Go to the documentation of this file.

/*-------------------------------------------------------------------------
 *
 * spell.h
 *
 * Declarations for ISpell dictionary
 *
 * Portions Copyright (c) 1996-2013, PostgreSQL Global Development Group
 *
 * src/include/tsearch/dicts/spell.h
 *
 *-------------------------------------------------------------------------
 */

#ifndef __SPELL_H__
#define __SPELL_H__

#include "regex/regex.h"
#include "tsearch/dicts/regis.h"
#include "tsearch/ts_public.h"

/*
 * Max length of a flag name. Names longer than this will be truncated
 * to the maximum.
 */
#define MAXFLAGLEN 16

struct SPNode;

typedef struct
{
    uint32      val:8,
                isword:1,
                compoundflag:4,
                affix:19;
    struct SPNode *node;
} SPNodeData;

/*
 * Names of FF_ are correlated with Hunspell options in affix file
 * http://hunspell.sourceforge.net/
 */
#define FF_COMPOUNDONLY     0x01
#define FF_COMPOUNDBEGIN    0x02
#define FF_COMPOUNDMIDDLE   0x04
#define FF_COMPOUNDLAST     0x08
#define FF_COMPOUNDFLAG     ( FF_COMPOUNDBEGIN | FF_COMPOUNDMIDDLE | FF_COMPOUNDLAST )
#define FF_DICTFLAGMASK     0x0f

typedef struct SPNode
{
    uint32      length;
    SPNodeData  data[1];
} SPNode;

#define SPNHDRSZ    (offsetof(SPNode,data))


typedef struct spell_struct
{
    union
    {
        /*
         * flag is filled in by NIImportDictionary. After NISortDictionary, d
         * is valid and flag is invalid.
         */
        char        flag[MAXFLAGLEN];
        struct
        {
            int         affix;
            int         len;
        }           d;
    }           p;
    char        word[1];        /* variable length, null-terminated */
} SPELL;

#define SPELLHDRSZ  (offsetof(SPELL, word))

typedef struct aff_struct
{
    uint32      flag:8,
                type:1,
                flagflags:7,
                issimple:1,
                isregis:1,
                replen:14;
    char       *find;
    char       *repl;
    union
    {
        regex_t     regex;
        Regis       regis;
    }           reg;
} AFFIX;

/*
 * affixes use dictionary flags too
 */
#define FF_COMPOUNDPERMITFLAG   0x10
#define FF_COMPOUNDFORBIDFLAG   0x20
#define FF_CROSSPRODUCT         0x40

/*
 * Don't change the order of these. Initialization sorts by these,
 * and expects prefixes to come first after sorting.
 */
#define FF_SUFFIX               1
#define FF_PREFIX               0

struct AffixNode;

typedef struct
{
    uint32      val:8,
                naff:24;
    AFFIX     **aff;
    struct AffixNode *node;
} AffixNodeData;

typedef struct AffixNode
{
    uint32      isvoid:1,
                length:31;
    AffixNodeData data[1];
} AffixNode;

#define ANHRDSZ        (offsetof(AffixNode, data))

typedef struct
{
    char       *affix;
    int         len;
    bool        issuffix;
} CMPDAffix;

typedef struct
{
    int         maffixes;
    int         naffixes;
    AFFIX      *Affix;

    AffixNode  *Suffix;
    AffixNode  *Prefix;

    SPNode     *Dictionary;
    char      **AffixData;
    int         lenAffixData;
    int         nAffixData;

    CMPDAffix  *CompoundAffix;

    unsigned char flagval[256];
    bool        usecompound;

    /*
     * Remaining fields are only used during dictionary construction; they are
     * set up by NIStartBuild and cleared by NIFinishBuild.
     */
    MemoryContext buildCxt;     /* temp context for construction */

    /* Temporary array of all words in the dict file */
    SPELL     **Spell;
    int         nspell;         /* number of valid entries in Spell array */
    int         mspell;         /* allocated length of Spell array */

    /* These are used to allocate "compact" data without palloc overhead */
    char       *firstfree;      /* first free address (always maxaligned) */
    size_t      avail;          /* free space remaining at firstfree */
} IspellDict;

extern TSLexeme *NINormalizeWord(IspellDict *Conf, char *word);

extern void NIStartBuild(IspellDict *Conf);
extern void NIImportAffixes(IspellDict *Conf, const char *filename);
extern void NIImportDictionary(IspellDict *Conf, const char *filename);
extern void NISortDictionary(IspellDict *Conf);
extern void NISortAffixes(IspellDict *Conf);
extern void NIFinishBuild(IspellDict *Conf);

#endif