[sql] Import SQLite 3.17.0.

third_party/sqlite/src/ext/fts5/fts5_tcl.c

 /*
 ** 2014 Dec 01
 **
 ** The author disclaims copyright to this source code.  In place of
 ** a legal notice, here is a blessing:
 **
 **    May you do good and not evil.
 **    May you find forgiveness for yourself and forgive others.
 **    May you share freely, never taking more than you give.
 **
 ******************************************************************************
 **
 */
 
 
 #ifdef SQLITE_TEST
-#include <tcl.h>
+#if defined(INCLUDE_SQLITE_TCL_H)
+#  include "sqlite_tcl.h"
+#else
+#  include "tcl.h"
+#  ifndef SQLITE_TCLAPI
+#    define SQLITE_TCLAPI
+#  endif
+#endif
 
 #ifdef SQLITE_ENABLE_FTS5
 
 #include "fts5.h"
 #include <string.h>
 #include <assert.h>
 
 extern int sqlite3_fts5_may_be_corrupt;
-extern int sqlite3Fts5TestRegisterMatchinfo(sqlite3 *);
+extern int sqlite3Fts5TestRegisterMatchinfo(sqlite3*);
+extern int sqlite3Fts5TestRegisterTok(sqlite3*, fts5_api*);
 
 /*************************************************************************
 ** This is a copy of the first part of the SqliteDb structure in 
 ** tclsqlite.c.  We need it here so that the get_sqlite_pointer routine
 ** can extract the sqlite3* pointer from an existing Tcl SQLite
 ** connection.
 */
 
 extern const char *sqlite3ErrName(int);
 
@@ skipping 33 matching lines @@
 
   for(i=0; i<sizeof(aErr)/sizeof(aErr[0]); i++){
     if( 0==sqlite3_stricmp(zRes, aErr[i].zError) ){
       return aErr[i].rc;
     }
   }
 
   return SQLITE_ERROR;
 }
 
-static int f5tDbAndApi(
+static int SQLITE_TCLAPI f5tDbAndApi(
   Tcl_Interp *interp, 
   Tcl_Obj *pObj, 
   sqlite3 **ppDb, 
   fts5_api **ppApi
 ){
   sqlite3 *db = 0;
   int rc = f5tDbPointer(interp, pObj, &db);
   if( rc!=TCL_OK ){
     return TCL_ERROR;
   }else{
@@ skipping 65 matching lines @@
 
   rc = Tcl_EvalObjEx(p->interp, pEval, 0);
   Tcl_DecrRefCount(pEval);
   if( rc==TCL_OK ){
     rc = f5tResultToErrorCode(Tcl_GetStringResult(p->interp));
   }
 
   return rc;
 }
 
-static int xF5tApi(void*, Tcl_Interp*, int, Tcl_Obj *CONST []);
+static int SQLITE_TCLAPI xF5tApi(void*, Tcl_Interp*, int, Tcl_Obj *CONST []);
 
 static int xQueryPhraseCb(
   const Fts5ExtensionApi *pApi, 
   Fts5Context *pFts, 
   void *pCtx
 ){
   F5tFunction *p = (F5tFunction*)pCtx;
   static sqlite3_int64 iCmd = 0;
   Tcl_Obj *pEval;
   int rc;
@@ skipping 24 matching lines @@
   F5tAuxData *pData = (F5tAuxData*)p;
   Tcl_DecrRefCount(pData->pObj);
   sqlite3_free(pData);
 }
 
 /*
 **      api sub-command...
 **
 ** Description...
 */
-static int xF5tApi(
+static int SQLITE_TCLAPI xF5tApi(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   struct Sub {
     const char *zName;
     int nArg;
     const char *zMsg;
   } aSub[] = {
     { "xColumnCount",      0, "" },                   /*  0 */
     { "xRowCount",         0, "" },                   /*  1 */
     { "xColumnTotalSize",  1, "COL" },                /*  2 */
     { "xTokenize",         2, "TEXT SCRIPT" },        /*  3 */
     { "xPhraseCount",      0, "" },                   /*  4 */
     { "xPhraseSize",       1, "PHRASE" },             /*  5 */
     { "xInstCount",        0, "" },                   /*  6 */
     { "xInst",             1, "IDX" },                /*  7 */
     { "xRowid",            0, "" },                   /*  8 */
     { "xColumnText",       1, "COL" },                /*  9 */
     { "xColumnSize",       1, "COL" },                /* 10 */
     { "xQueryPhrase",      2, "PHRASE SCRIPT" },      /* 11 */
     { "xSetAuxdata",       1, "VALUE" },              /* 12 */
     { "xGetAuxdata",       1, "CLEAR" },              /* 13 */
     { "xSetAuxdataInt",    1, "INTEGER" },            /* 14 */
     { "xGetAuxdataInt",    1, "CLEAR" },              /* 15 */
+    { "xPhraseForeach",    4, "IPHRASE COLVAR OFFVAR SCRIPT" }, /* 16 */
+    { "xPhraseColumnForeach", 3, "IPHRASE COLVAR SCRIPT" }, /* 17 */
     { 0, 0, 0}
   };
 
   int rc;
   int iSub = 0;
   F5tApi *p = (F5tApi*)clientData;
 
   if( objc<2 ){
     Tcl_WrongNumArgs(interp, 1, objv, "SUB-COMMAND");
     return TCL_ERROR;
@@ skipping 176 matching lines @@
     }
     CASE(15, "xGetAuxdataInt") {
       int iVal;
       int bClear;
       if( Tcl_GetBooleanFromObj(interp, objv[2], &bClear) ) return TCL_ERROR;
       iVal = ((char*)p->pApi->xGetAuxdata(p->pFts, bClear) - (char*)0);
       Tcl_SetObjResult(interp, Tcl_NewIntObj(iVal));
       break;
     }
 
+    CASE(16, "xPhraseForeach") {
+      int iPhrase;
+      int iCol;
+      int iOff;
+      const char *zColvar;
+      const char *zOffvar;
+      Tcl_Obj *pScript = objv[5];
+      Fts5PhraseIter iter;
+
+      if( Tcl_GetIntFromObj(interp, objv[2], &iPhrase) ) return TCL_ERROR;
+      zColvar = Tcl_GetString(objv[3]);
+      zOffvar = Tcl_GetString(objv[4]);
+
+      rc = p->pApi->xPhraseFirst(p->pFts, iPhrase, &iter, &iCol, &iOff);
+      if( rc!=SQLITE_OK ){
+        Tcl_AppendResult(interp, sqlite3ErrName(rc), 0);
+        return TCL_ERROR;
+      }
+      for( ;iCol>=0; p->pApi->xPhraseNext(p->pFts, &iter, &iCol, &iOff) ){
+        Tcl_SetVar2Ex(interp, zColvar, 0, Tcl_NewIntObj(iCol), 0);
+        Tcl_SetVar2Ex(interp, zOffvar, 0, Tcl_NewIntObj(iOff), 0);
+        rc = Tcl_EvalObjEx(interp, pScript, 0);
+        if( rc==TCL_CONTINUE ) rc = TCL_OK;
+        if( rc!=TCL_OK ){
+          if( rc==TCL_BREAK ) rc = TCL_OK;
+          break;
+        }
+      }
+
+      break;
+    }
+
+    CASE(17, "xPhraseColumnForeach") {
+      int iPhrase;
+      int iCol;
+      const char *zColvar;
+      Tcl_Obj *pScript = objv[4];
+      Fts5PhraseIter iter;
+
+      if( Tcl_GetIntFromObj(interp, objv[2], &iPhrase) ) return TCL_ERROR;
+      zColvar = Tcl_GetString(objv[3]);
+
+      rc = p->pApi->xPhraseFirstColumn(p->pFts, iPhrase, &iter, &iCol);
+      if( rc!=SQLITE_OK ){
+        Tcl_AppendResult(interp, sqlite3ErrName(rc), 0);
+        return TCL_ERROR;
+      }
+      for( ; iCol>=0; p->pApi->xPhraseNextColumn(p->pFts, &iter, &iCol)){
+        Tcl_SetVar2Ex(interp, zColvar, 0, Tcl_NewIntObj(iCol), 0);
+        rc = Tcl_EvalObjEx(interp, pScript, 0);
+        if( rc==TCL_CONTINUE ) rc = TCL_OK;
+        if( rc!=TCL_OK ){
+          if( rc==TCL_BREAK ) rc = TCL_OK;
+          break;
+        }
+      }
+
+      break;
+    }
+
     default: 
       assert( 0 );
       break;
   }
 #undef CASE
 
   if( rc!=SQLITE_OK ){
     Tcl_SetResult(interp, (char*)sqlite3ErrName(rc), TCL_VOLATILE);
     return TCL_ERROR;
   }
@@ skipping 88 matching lines @@
   F5tFunction *p = (F5tFunction*)pCtx;
   Tcl_DecrRefCount(p->pScript);
   ckfree((char *)p);
 }
 
 /*
 **      sqlite3_fts5_create_function DB NAME SCRIPT
 **
 ** Description...
 */
-static int f5tCreateFunction(
+static int SQLITE_TCLAPI f5tCreateFunction(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   char *zName;
   Tcl_Obj *pScript;
   sqlite3 *db = 0;
   fts5_api *pApi = 0;
   F5tFunction *pCtx = 0;
@@ skipping 49 matching lines @@
   }
   return SQLITE_OK;
 }
 
 
 /*
 **      sqlite3_fts5_tokenize DB TOKENIZER TEXT
 **
 ** Description...
 */
-static int f5tTokenize(
+static int SQLITE_TCLAPI f5tTokenize(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   char *zText;
   int nText;
   sqlite3 *db = 0;
   fts5_api *pApi = 0;
   Fts5Tokenizer *pTok = 0;
@@ skipping 185 matching lines @@
   Tcl_DecrRefCount(pEval);
 
   pInst->pContext->pCtx = pOldCtx;
   pInst->pContext->xToken = xOldToken;
   return rc;
 }
 
 /*
 ** sqlite3_fts5_token ?-colocated? TEXT START END
 */
-static int f5tTokenizerReturn(
+static int SQLITE_TCLAPI f5tTokenizerReturn(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   F5tTokenizerContext *p = (F5tTokenizerContext*)clientData;
   int iStart;
   int iEnd;
   int nToken;
   int tflags = 0;
@@ skipping 50 matching lines @@
 **
 ** The value returned by (SCRIPT + args) is itself a tcl script. This 
 ** script - call it SCRIPT2 - is executed to tokenize text using the
 ** tokenizer instance "returned" by SCRIPT. Specifically, to tokenize
 ** text SCRIPT2 is invoked with a single argument appended to it - the
 ** text to tokenize.
 **
 ** SCRIPT2 should invoke the [sqlite3_fts5_token] command once for each
 ** token within the tokenized text.
 */
-static int f5tCreateTokenizer(
+static int SQLITE_TCLAPI f5tCreateTokenizer(
   ClientData clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   F5tTokenizerContext *pContext = (F5tTokenizerContext*)clientData;
   sqlite3 *db;
   fts5_api *pApi;
   char *zName;
   Tcl_Obj *pScript;
@@ skipping 22 matching lines @@
   Tcl_IncrRefCount(pScript);
   rc = pApi->xCreateTokenizer(pApi, zName, (void*)pMod, &t, f5tDelTokenizer);
   if( rc!=SQLITE_OK ){
     Tcl_AppendResult(interp, "error in fts5_api.xCreateTokenizer()", 0);
     return TCL_ERROR;
   }
 
   return TCL_OK;
 }
 
-static void xF5tFree(ClientData clientData){
+static void SQLITE_TCLAPI xF5tFree(ClientData clientData){
   ckfree(clientData);
 }
 
 /*
 **      sqlite3_fts5_may_be_corrupt BOOLEAN
 **
 ** Set or clear the global "may-be-corrupt" flag. Return the old value.
 */
-static int f5tMayBeCorrupt(
+static int SQLITE_TCLAPI f5tMayBeCorrupt(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   int bOld = sqlite3_fts5_may_be_corrupt;
 
   if( objc!=2 && objc!=1 ){
     Tcl_WrongNumArgs(interp, 1, objv, "?BOOLEAN?");
     return TCL_ERROR;
@@ skipping 11 matching lines @@
 
 static unsigned int f5t_fts5HashKey(int nSlot, const char *p, int n){
   int i;
   unsigned int h = 13;
   for(i=n-1; i>=0; i--){
     h = (h << 3) ^ h ^ p[i];
   }
   return (h % nSlot);
 }
 
-static int f5tTokenHash(
+static int SQLITE_TCLAPI f5tTokenHash(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   char *z;
   int n;
   unsigned int iVal;
   int nSlot;
 
   if( objc!=3 ){
     Tcl_WrongNumArgs(interp, 1, objv, "NSLOT TOKEN");
     return TCL_ERROR;
   }
   if( Tcl_GetIntFromObj(interp, objv[1], &nSlot) ){
     return TCL_ERROR;
   }
   z = Tcl_GetStringFromObj(objv[2], &n);
 
   iVal = f5t_fts5HashKey(nSlot, z, n);
   Tcl_SetObjResult(interp, Tcl_NewIntObj(iVal));
   return TCL_OK;
 }
 
-static int f5tRegisterMatchinfo(
+static int SQLITE_TCLAPI f5tRegisterMatchinfo(
   void * clientData,
   Tcl_Interp *interp,
   int objc,
   Tcl_Obj *CONST objv[]
 ){
   int rc;
   sqlite3 *db = 0;
 
   if( objc!=2 ){
     Tcl_WrongNumArgs(interp, 1, objv, "DB");
     return TCL_ERROR;
   }
   if( f5tDbPointer(interp, objv[1], &db) ){
     return TCL_ERROR;
   }
 
   rc = sqlite3Fts5TestRegisterMatchinfo(db);
   if( rc!=SQLITE_OK ){
     Tcl_SetResult(interp, (char*)sqlite3ErrName(rc), TCL_VOLATILE);
     return TCL_ERROR;
   }
   return TCL_OK;
 }
 
+static int SQLITE_TCLAPI f5tRegisterTok(
+  void * clientData,
+  Tcl_Interp *interp,
+  int objc,
+  Tcl_Obj *CONST objv[]
+){
+  int rc;
+  sqlite3 *db = 0;
+  fts5_api *pApi = 0;
+
+  if( objc!=2 ){
+    Tcl_WrongNumArgs(interp, 1, objv, "DB");
+    return TCL_ERROR;
+  }
+  if( f5tDbAndApi(interp, objv[1], &db, &pApi) ){
+    return TCL_ERROR;
+  }
+
+  rc = sqlite3Fts5TestRegisterTok(db, pApi);
+  if( rc!=SQLITE_OK ){
+    Tcl_SetResult(interp, (char*)sqlite3ErrName(rc), TCL_VOLATILE);
+    return TCL_ERROR;
+  }
+  return TCL_OK;
+}
+
 /*
 ** Entry point.
 */
 int Fts5tcl_Init(Tcl_Interp *interp){
   static struct Cmd {
     char *zName;
     Tcl_ObjCmdProc *xProc;
     int bTokenizeCtx;
   } aCmd[] = {
     { "sqlite3_fts5_create_tokenizer",   f5tCreateTokenizer, 1 },
     { "sqlite3_fts5_token",              f5tTokenizerReturn, 1 },
     { "sqlite3_fts5_tokenize",           f5tTokenize, 0 },
     { "sqlite3_fts5_create_function",    f5tCreateFunction, 0 },
     { "sqlite3_fts5_may_be_corrupt",     f5tMayBeCorrupt, 0 },
     { "sqlite3_fts5_token_hash",         f5tTokenHash, 0 },
-    { "sqlite3_fts5_register_matchinfo", f5tRegisterMatchinfo, 0 }
+    { "sqlite3_fts5_register_matchinfo", f5tRegisterMatchinfo, 0 },
+    { "sqlite3_fts5_register_fts5tokenize", f5tRegisterTok, 0 }
   };
   int i;
   F5tTokenizerContext *pContext;
 
   pContext = (F5tTokenizerContext*)ckalloc(sizeof(F5tTokenizerContext));
   memset(pContext, 0, sizeof(*pContext));
 
   for(i=0; i<sizeof(aCmd)/sizeof(aCmd[0]); i++){
     struct Cmd *p = &aCmd[i];
     void *pCtx = 0;
     if( p->bTokenizeCtx ) pCtx = (void*)pContext;
     Tcl_CreateObjCommand(interp, p->zName, p->xProc, pCtx, (i ? 0 : xF5tFree));
   }
 
   return TCL_OK;
 }
 #else  /* SQLITE_ENABLE_FTS5 */
 int Fts5tcl_Init(Tcl_Interp *interp){
   return TCL_OK;
 }
 #endif /* SQLITE_ENABLE_FTS5 */
 #endif /* SQLITE_TEST */