4 ** The author disclaims copyright to this source code. In place of
5 ** a legal notice, here is a blessing:
7 ** May you do good and not evil.
8 ** May you find forgiveness for yourself and forgive others.
9 ** May you share freely, never taking more than you give.
11 *************************************************************************
12 ** Implementation of the full-text-search tokenizer that implements
17 ** The code in this file is only compiled if:
19 ** * The FTS3 module is being built as an extension
20 ** (in which case SQLITE_CORE is not defined), or
22 ** * The FTS3 module is being built into the core of
23 ** SQLite (in which case SQLITE_ENABLE_FTS3 is defined).
26 #if !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3)
33 #include "fts3_tokenizer.h"
36 ** Class derived from sqlite3_tokenizer
38 typedef struct porter_tokenizer
{
39 sqlite3_tokenizer base
; /* Base class */
43 ** Class derived from sqlite3_tokenizer_cursor
45 typedef struct porter_tokenizer_cursor
{
46 sqlite3_tokenizer_cursor base
;
47 const char *zInput
; /* input we are tokenizing */
48 int nInput
; /* size of the input */
49 int iOffset
; /* current position in zInput */
50 int iToken
; /* index of next token to be returned */
51 char *zToken
; /* storage for current token */
52 int nAllocated
; /* space allocated to zToken buffer */
53 } porter_tokenizer_cursor
;
57 ** Create a new tokenizer instance.
59 static int porterCreate(
60 int argc
, const char * const *argv
,
61 sqlite3_tokenizer
**ppTokenizer
65 UNUSED_PARAMETER(argc
);
66 UNUSED_PARAMETER(argv
);
68 t
= (porter_tokenizer
*) sqlite3_malloc(sizeof(*t
));
69 if( t
==NULL
) return SQLITE_NOMEM
;
70 memset(t
, 0, sizeof(*t
));
71 *ppTokenizer
= &t
->base
;
76 ** Destroy a tokenizer
78 static int porterDestroy(sqlite3_tokenizer
*pTokenizer
){
79 sqlite3_free(pTokenizer
);
84 ** Prepare to begin tokenizing a particular string. The input
85 ** string to be tokenized is zInput[0..nInput-1]. A cursor
86 ** used to incrementally tokenize this string is returned in
89 static int porterOpen(
90 sqlite3_tokenizer
*pTokenizer
, /* The tokenizer */
91 const char *zInput
, int nInput
, /* String to be tokenized */
92 sqlite3_tokenizer_cursor
**ppCursor
/* OUT: Tokenization cursor */
94 porter_tokenizer_cursor
*c
;
96 UNUSED_PARAMETER(pTokenizer
);
98 c
= (porter_tokenizer_cursor
*) sqlite3_malloc(sizeof(*c
));
99 if( c
==NULL
) return SQLITE_NOMEM
;
104 }else if( nInput
<0 ){
105 c
->nInput
= (int)strlen(zInput
);
109 c
->iOffset
= 0; /* start tokenizing at the beginning */
111 c
->zToken
= NULL
; /* no space allocated, yet. */
114 *ppCursor
= &c
->base
;
119 ** Close a tokenization cursor previously opened by a call to
120 ** porterOpen() above.
122 static int porterClose(sqlite3_tokenizer_cursor
*pCursor
){
123 porter_tokenizer_cursor
*c
= (porter_tokenizer_cursor
*) pCursor
;
124 sqlite3_free(c
->zToken
);
129 ** Vowel or consonant
131 static const char cType
[] = {
132 0, 1, 1, 1, 0, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0, 1, 1, 1, 1, 1, 0,
137 ** isConsonant() and isVowel() determine if their first character in
138 ** the string they point to is a consonant or a vowel, according
141 ** A consonate is any letter other than 'a', 'e', 'i', 'o', or 'u'.
142 ** 'Y' is a consonant unless it follows another consonant,
143 ** in which case it is a vowel.
145 ** In these routine, the letters are in reverse order. So the 'y' rule
146 ** is that 'y' is a consonant unless it is followed by another
149 static int isVowel(const char*);
150 static int isConsonant(const char *z
){
154 assert( x
>='a' && x
<='z' );
157 return z
[1]==0 || isVowel(z
+ 1);
159 static int isVowel(const char *z
){
163 assert( x
>='a' && x
<='z' );
165 if( j
<2 ) return 1-j
;
166 return isConsonant(z
+ 1);
170 ** Let any sequence of one or more vowels be represented by V and let
171 ** C be sequence of one or more consonants. Then every word can be
176 ** In prose: A word is an optional consonant followed by zero or
177 ** vowel-consonant pairs followed by an optional vowel. "m" is the
178 ** number of vowel consonant pairs. This routine computes the value
179 ** of m for the first i bytes of a word.
181 ** Return true if the m-value for z is 1 or more. In other words,
182 ** return true if z contains at least one vowel that is followed
185 ** In this routine z[] is in reverse order. So we are really looking
186 ** for an instance of of a consonant followed by a vowel.
188 static int m_gt_0(const char *z
){
189 while( isVowel(z
) ){ z
++; }
190 if( *z
==0 ) return 0;
191 while( isConsonant(z
) ){ z
++; }
195 /* Like mgt0 above except we are looking for a value of m which is
198 static int m_eq_1(const char *z
){
199 while( isVowel(z
) ){ z
++; }
200 if( *z
==0 ) return 0;
201 while( isConsonant(z
) ){ z
++; }
202 if( *z
==0 ) return 0;
203 while( isVowel(z
) ){ z
++; }
204 if( *z
==0 ) return 1;
205 while( isConsonant(z
) ){ z
++; }
209 /* Like mgt0 above except we are looking for a value of m>1 instead
212 static int m_gt_1(const char *z
){
213 while( isVowel(z
) ){ z
++; }
214 if( *z
==0 ) return 0;
215 while( isConsonant(z
) ){ z
++; }
216 if( *z
==0 ) return 0;
217 while( isVowel(z
) ){ z
++; }
218 if( *z
==0 ) return 0;
219 while( isConsonant(z
) ){ z
++; }
224 ** Return TRUE if there is a vowel anywhere within z[0..n-1]
226 static int hasVowel(const char *z
){
227 while( isConsonant(z
) ){ z
++; }
232 ** Return TRUE if the word ends in a double consonant.
234 ** The text is reversed here. So we are really looking at
235 ** the first two characters of z[].
237 static int doubleConsonant(const char *z
){
238 return isConsonant(z
) && z
[0]==z
[1];
242 ** Return TRUE if the word ends with three letters which
243 ** are consonant-vowel-consonent and where the final consonant
244 ** is not 'w', 'x', or 'y'.
246 ** The word is reversed here. So we are really checking the
247 ** first three letters and the first one cannot be in [wxy].
249 static int star_oh(const char *z
){
252 z
[0]!='w' && z
[0]!='x' && z
[0]!='y' &&
258 ** If the word ends with zFrom and xCond() is true for the stem
259 ** of the word that preceeds the zFrom ending, then change the
262 ** The input word *pz and zFrom are both in reverse order. zTo
263 ** is in normal order.
265 ** Return TRUE if zFrom matches. Return FALSE if zFrom does not
266 ** match. Not that TRUE is returned even if xCond() fails and
267 ** no substitution occurs.
270 char **pz
, /* The word being stemmed (Reversed) */
271 const char *zFrom
, /* If the ending matches this... (Reversed) */
272 const char *zTo
, /* ... change the ending to this (not reversed) */
273 int (*xCond
)(const char*) /* Condition that must be true */
276 while( *zFrom
&& *zFrom
==*z
){ z
++; zFrom
++; }
277 if( *zFrom
!=0 ) return 0;
278 if( xCond
&& !xCond(z
) ) return 1;
287 ** This is the fallback stemmer used when the porter stemmer is
288 ** inappropriate. The input word is copied into the output with
289 ** US-ASCII case folding. If the input word is too long (more
290 ** than 20 bytes if it contains no digits or more than 6 bytes if
291 ** it contains digits) then word is truncated to 20 or 6 bytes
292 ** by taking 10 or 3 bytes from the beginning and end.
294 static void copy_stemmer(const char *zIn
, int nIn
, char *zOut
, int *pnOut
){
297 for(i
=0; i
<nIn
; i
++){
299 if( c
>='A' && c
<='Z' ){
300 zOut
[i
] = c
- 'A' + 'a';
302 if( c
>='0' && c
<='9' ) hasDigit
= 1;
306 mx
= hasDigit
? 3 : 10;
308 for(j
=mx
, i
=nIn
-mx
; i
<nIn
; i
++, j
++){
319 ** Stem the input word zIn[0..nIn-1]. Store the output in zOut.
320 ** zOut is at least big enough to hold nIn bytes. Write the actual
321 ** size of the output word (exclusive of the '\0' terminator) into *pnOut.
323 ** Any upper-case characters in the US-ASCII character set ([A-Z])
324 ** are converted to lower case. Upper-case UTF characters are
327 ** Words that are longer than about 20 bytes are stemmed by retaining
328 ** a few bytes from the beginning and the end of the word. If the
329 ** word contains digits, 3 bytes are taken from the beginning and
330 ** 3 bytes from the end. For long words without digits, 10 bytes
331 ** are taken from each end. US-ASCII case folding still applies.
333 ** If the input word contains not digits but does characters not
334 ** in [a-zA-Z] then no stemming is attempted and this routine just
335 ** copies the input into the input into the output with US-ASCII
338 ** Stemming never increases the length of the word. So there is
339 ** no chance of overflowing the zOut buffer.
341 static void porter_stemmer(const char *zIn
, int nIn
, char *zOut
, int *pnOut
){
345 if( nIn
<3 || nIn
>=(int)sizeof(zReverse
)-7 ){
346 /* The word is too big or too small for the porter stemmer.
347 ** Fallback to the copy stemmer */
348 copy_stemmer(zIn
, nIn
, zOut
, pnOut
);
351 for(i
=0, j
=sizeof(zReverse
)-6; i
<nIn
; i
++, j
--){
353 if( c
>='A' && c
<='Z' ){
354 zReverse
[j
] = c
+ 'a' - 'A';
355 }else if( c
>='a' && c
<='z' ){
358 /* The use of a character not in [a-zA-Z] means that we fallback
359 ** to the copy stemmer */
360 copy_stemmer(zIn
, nIn
, zOut
, pnOut
);
364 memset(&zReverse
[sizeof(zReverse
)-5], 0, 5);
371 !stem(&z
, "sess", "ss", 0) &&
372 !stem(&z
, "sei", "i", 0) &&
373 !stem(&z
, "ss", "ss", 0)
381 if( stem(&z
, "dee", "ee", m_gt_0
) ){
382 /* Do nothing. The work was all in the test */
384 (stem(&z
, "gni", "", hasVowel
) || stem(&z
, "de", "", hasVowel
))
387 if( stem(&z
, "ta", "ate", 0) ||
388 stem(&z
, "lb", "ble", 0) ||
389 stem(&z
, "zi", "ize", 0) ){
390 /* Do nothing. The work was all in the test */
391 }else if( doubleConsonant(z
) && (*z
!='l' && *z
!='s' && *z
!='z') ){
393 }else if( m_eq_1(z
) && star_oh(z
) ){
399 if( z
[0]=='y' && hasVowel(z
+1) ){
406 if( !stem(&z
, "lanoita", "ate", m_gt_0
) ){
407 stem(&z
, "lanoit", "tion", m_gt_0
);
411 if( !stem(&z
, "icne", "ence", m_gt_0
) ){
412 stem(&z
, "icna", "ance", m_gt_0
);
416 stem(&z
, "rezi", "ize", m_gt_0
);
419 stem(&z
, "igol", "log", m_gt_0
);
422 if( !stem(&z
, "ilb", "ble", m_gt_0
)
423 && !stem(&z
, "illa", "al", m_gt_0
)
424 && !stem(&z
, "iltne", "ent", m_gt_0
)
425 && !stem(&z
, "ile", "e", m_gt_0
)
427 stem(&z
, "ilsuo", "ous", m_gt_0
);
431 if( !stem(&z
, "noitazi", "ize", m_gt_0
)
432 && !stem(&z
, "noita", "ate", m_gt_0
)
434 stem(&z
, "rota", "ate", m_gt_0
);
438 if( !stem(&z
, "msila", "al", m_gt_0
)
439 && !stem(&z
, "ssenevi", "ive", m_gt_0
)
440 && !stem(&z
, "ssenluf", "ful", m_gt_0
)
442 stem(&z
, "ssensuo", "ous", m_gt_0
);
446 if( !stem(&z
, "itila", "al", m_gt_0
)
447 && !stem(&z
, "itivi", "ive", m_gt_0
)
449 stem(&z
, "itilib", "ble", m_gt_0
);
457 if( !stem(&z
, "etaci", "ic", m_gt_0
)
458 && !stem(&z
, "evita", "", m_gt_0
)
460 stem(&z
, "ezila", "al", m_gt_0
);
464 stem(&z
, "itici", "ic", m_gt_0
);
467 if( !stem(&z
, "laci", "ic", m_gt_0
) ){
468 stem(&z
, "luf", "", m_gt_0
);
472 stem(&z
, "ssen", "", m_gt_0
);
479 if( z
[0]=='l' && m_gt_1(z
+2) ){
484 if( z
[0]=='e' && z
[2]=='n' && (z
[3]=='a' || z
[3]=='e') && m_gt_1(z
+4) ){
489 if( z
[0]=='r' && m_gt_1(z
+2) ){
494 if( z
[0]=='c' && m_gt_1(z
+2) ){
499 if( z
[0]=='e' && z
[2]=='b' && (z
[3]=='a' || z
[3]=='i') && m_gt_1(z
+4) ){
509 }else if( z
[2]=='e' ){
510 if( !stem(&z
, "tneme", "", m_gt_1
)
511 && !stem(&z
, "tnem", "", m_gt_1
)
513 stem(&z
, "tne", "", m_gt_1
);
523 }else if( z
[3]=='s' || z
[3]=='t' ){
524 stem(&z
, "noi", "", m_gt_1
);
528 if( z
[0]=='m' && z
[2]=='i' && m_gt_1(z
+3) ){
533 if( !stem(&z
, "eta", "", m_gt_1
) ){
534 stem(&z
, "iti", "", m_gt_1
);
538 if( z
[0]=='s' && z
[2]=='o' && m_gt_1(z
+3) ){
544 if( z
[0]=='e' && z
[2]=='i' && m_gt_1(z
+3) ){
554 }else if( m_eq_1(z
+1) && !star_oh(z
+1) ){
560 if( m_gt_1(z
) && z
[0]=='l' && z
[1]=='l' ){
564 /* z[] is now the stemmed word in reverse order. Flip it back
565 ** around into forward order and return.
567 *pnOut
= i
= (int)strlen(z
);
575 ** Characters that can be part of a token. We assume any character
576 ** whose value is greater than 0x80 (any UTF character) can be
577 ** part of a token. In other words, delimiters all must have
578 ** values of 0x7f or lower.
580 static const char porterIdChar
[] = {
581 /* x0 x1 x2 x3 x4 x5 x6 x7 x8 x9 xA xB xC xD xE xF */
582 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, 0, /* 3x */
583 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 4x */
584 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 1, /* 5x */
585 0, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, /* 6x */
586 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 1, 0, 0, 0, 0, 0, /* 7x */
588 #define isDelim(C) (((ch=C)&0x80)==0 && (ch<0x30 || !porterIdChar[ch-0x30]))
591 ** Extract the next token from a tokenization cursor. The cursor must
592 ** have been opened by a prior call to porterOpen().
594 static int porterNext(
595 sqlite3_tokenizer_cursor
*pCursor
, /* Cursor returned by porterOpen */
596 const char **pzToken
, /* OUT: *pzToken is the token text */
597 int *pnBytes
, /* OUT: Number of bytes in token */
598 int *piStartOffset
, /* OUT: Starting offset of token */
599 int *piEndOffset
, /* OUT: Ending offset of token */
600 int *piPosition
/* OUT: Position integer of token */
602 porter_tokenizer_cursor
*c
= (porter_tokenizer_cursor
*) pCursor
;
603 const char *z
= c
->zInput
;
605 while( c
->iOffset
<c
->nInput
){
606 int iStartOffset
, ch
;
608 /* Scan past delimiter characters */
609 while( c
->iOffset
<c
->nInput
&& isDelim(z
[c
->iOffset
]) ){
613 /* Count non-delimiter characters. */
614 iStartOffset
= c
->iOffset
;
615 while( c
->iOffset
<c
->nInput
&& !isDelim(z
[c
->iOffset
]) ){
619 if( c
->iOffset
>iStartOffset
){
620 int n
= c
->iOffset
-iStartOffset
;
621 if( n
>c
->nAllocated
){
623 c
->nAllocated
= n
+20;
624 pNew
= sqlite3_realloc(c
->zToken
, c
->nAllocated
);
625 if( !pNew
) return SQLITE_NOMEM
;
628 porter_stemmer(&z
[iStartOffset
], n
, c
->zToken
, pnBytes
);
629 *pzToken
= c
->zToken
;
630 *piStartOffset
= iStartOffset
;
631 *piEndOffset
= c
->iOffset
;
632 *piPosition
= c
->iToken
++;
640 ** The set of routines that implement the porter-stemmer tokenizer
642 static const sqlite3_tokenizer_module porterTokenizerModule
= {
653 ** Allocate a new porter tokenizer. Return a pointer to the new
654 ** tokenizer in *ppModule
656 void sqlite3Fts3PorterTokenizerModule(
657 sqlite3_tokenizer_module
const**ppModule
659 *ppModule
= &porterTokenizerModule
;
662 #endif /* !defined(SQLITE_CORE) || defined(SQLITE_ENABLE_FTS3) */