Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
Comment: | Add the "helptext" virtual table. This is a stepping-stone to adding help-text search. |
---|---|
Downloads: | Tarball | ZIP archive | SQL archive |
Timelines: | family | ancestors | descendants | both | trunk |
Files: | files | file ages | folders |
SHA3-256: |
b2dacfcd735d4b1c4b4e1f1c1efe8b50 |
User & Date: | drh 2020-06-20 00:15:01 |
References
2023-02-18
| ||
15:14 | • Wiki page "To Do List" ... (artifact: 38abf0c395 user: drh) | |
Context
2020-06-20
| ||
03:45 | Work around an erroneous warning in clang-8. No logic changes. The exact same machine code is generated. ... (check-in: 6daa19d961 user: drh tags: trunk) | |
00:15 | Add the "helptext" virtual table. This is a stepping-stone to adding help-text search. ... (check-in: b2dacfcd73 user: drh tags: trunk) | |
2020-06-19
| ||
20:41 | Remove a stale dependency from the MSC makefile. ... (check-in: 162ac96d7b user: drh tags: trunk) | |
Changes
Changes to src/dispatch.c.
︙ | ︙ | |||
802 803 804 805 806 807 808 | ** This routine provides access to the aSetting2[] array which is created ** by the mkindex utility program and included with <page_index.h>. */ const Setting *setting_info(int *pnCount){ if( pnCount ) *pnCount = (int)(sizeof(aSetting)/sizeof(aSetting[0])) - 1; return aSetting; } | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 | ** This routine provides access to the aSetting2[] array which is created ** by the mkindex utility program and included with <page_index.h>. */ const Setting *setting_info(int *pnCount){ if( pnCount ) *pnCount = (int)(sizeof(aSetting)/sizeof(aSetting[0])) - 1; return aSetting; } /***************************************************************************** ** A virtual table for accessing the information in aCommand[], and ** especially the help-text */ /* helptextVtab_vtab is a subclass of sqlite3_vtab which is ** underlying representation of the virtual table */ typedef struct helptextVtab_vtab helptextVtab_vtab; struct helptextVtab_vtab { sqlite3_vtab base; /* Base class - must be first */ /* Add new fields here, as necessary */ }; /* helptextVtab_cursor is a subclass of sqlite3_vtab_cursor which will ** serve as the underlying representation of a cursor that scans ** over rows of the result */ typedef struct helptextVtab_cursor helptextVtab_cursor; struct helptextVtab_cursor { sqlite3_vtab_cursor base; /* Base class - must be first */ /* Insert new fields here. For this helptextVtab we only keep track ** of the rowid */ sqlite3_int64 iRowid; /* The rowid */ }; /* ** The helptextVtabConnect() method is invoked to create a new ** helptext virtual table. ** ** Think of this routine as the constructor for helptextVtab_vtab objects. ** ** All this routine needs to do is: ** ** (1) Allocate the helptextVtab_vtab object and initialize all fields. ** ** (2) Tell SQLite (via the sqlite3_declare_vtab() interface) what the ** result set of queries against the virtual table will look like. */ static int helptextVtabConnect( sqlite3 *db, void *pAux, int argc, const char *const*argv, sqlite3_vtab **ppVtab, char **pzErr ){ helptextVtab_vtab *pNew; int rc; rc = sqlite3_declare_vtab(db, "CREATE TABLE x(name,type,flags,helptext)" ); if( rc==SQLITE_OK ){ pNew = sqlite3_malloc( sizeof(*pNew) ); *ppVtab = (sqlite3_vtab*)pNew; if( pNew==0 ) return SQLITE_NOMEM; memset(pNew, 0, sizeof(*pNew)); } return rc; } /* ** This method is the destructor for helptextVtab_vtab objects. */ static int helptextVtabDisconnect(sqlite3_vtab *pVtab){ helptextVtab_vtab *p = (helptextVtab_vtab*)pVtab; sqlite3_free(p); return SQLITE_OK; } /* ** Constructor for a new helptextVtab_cursor object. */ static int helptextVtabOpen(sqlite3_vtab *p, sqlite3_vtab_cursor **ppCursor){ helptextVtab_cursor *pCur; pCur = sqlite3_malloc( sizeof(*pCur) ); if( pCur==0 ) return SQLITE_NOMEM; memset(pCur, 0, sizeof(*pCur)); *ppCursor = &pCur->base; return SQLITE_OK; } /* ** Destructor for a helptextVtab_cursor. */ static int helptextVtabClose(sqlite3_vtab_cursor *cur){ helptextVtab_cursor *pCur = (helptextVtab_cursor*)cur; sqlite3_free(pCur); return SQLITE_OK; } /* ** Advance a helptextVtab_cursor to its next row of output. */ static int helptextVtabNext(sqlite3_vtab_cursor *cur){ helptextVtab_cursor *pCur = (helptextVtab_cursor*)cur; pCur->iRowid++; return SQLITE_OK; } /* ** Return values of columns for the row at which the helptextVtab_cursor ** is currently pointing. */ static int helptextVtabColumn( sqlite3_vtab_cursor *cur, /* The cursor */ sqlite3_context *ctx, /* First argument to sqlite3_result_...() */ int i /* Which column to return */ ){ helptextVtab_cursor *pCur = (helptextVtab_cursor*)cur; const CmdOrPage *pPage = aCommand + pCur->iRowid; switch( i ){ case 0: /* name */ sqlite3_result_text(ctx, pPage->zName, -1, SQLITE_STATIC); break; case 1: { /* type */ const char *zType = 0; if( pPage->eCmdFlags & CMDFLAG_COMMAND ){ zType = "command"; }else if( pPage->eCmdFlags & CMDFLAG_WEBPAGE ){ zType = "webpage"; }else if( pPage->eCmdFlags & CMDFLAG_SETTING ){ zType = "setting"; } sqlite3_result_text(ctx, zType, -1, SQLITE_STATIC); break; } case 2: /* flags */ sqlite3_result_int(ctx, pPage->eCmdFlags); break; case 3: /* helptext */ sqlite3_result_text(ctx, pPage->zHelp, -1, SQLITE_STATIC); break; } return SQLITE_OK; } /* ** Return the rowid for the current row. In this implementation, the ** rowid is the same as the output value. */ static int helptextVtabRowid(sqlite3_vtab_cursor *cur, sqlite_int64 *pRowid){ helptextVtab_cursor *pCur = (helptextVtab_cursor*)cur; *pRowid = pCur->iRowid; return SQLITE_OK; } /* ** Return TRUE if the cursor has been moved off of the last ** row of output. */ static int helptextVtabEof(sqlite3_vtab_cursor *cur){ helptextVtab_cursor *pCur = (helptextVtab_cursor*)cur; return pCur->iRowid>=MX_COMMAND; } /* ** This method is called to "rewind" the helptextVtab_cursor object back ** to the first row of output. This method is always called at least ** once prior to any call to helptextVtabColumn() or helptextVtabRowid() or ** helptextVtabEof(). */ static int helptextVtabFilter( sqlite3_vtab_cursor *pVtabCursor, int idxNum, const char *idxStr, int argc, sqlite3_value **argv ){ helptextVtab_cursor *pCur = (helptextVtab_cursor *)pVtabCursor; pCur->iRowid = 1; return SQLITE_OK; } /* ** SQLite will invoke this method one or more times while planning a query ** that uses the virtual table. This routine needs to create ** a query plan for each invocation and compute an estimated cost for that ** plan. */ static int helptextVtabBestIndex( sqlite3_vtab *tab, sqlite3_index_info *pIdxInfo ){ pIdxInfo->estimatedCost = (double)MX_COMMAND; pIdxInfo->estimatedRows = MX_COMMAND; return SQLITE_OK; } /* ** This following structure defines all the methods for the ** virtual table. */ static sqlite3_module helptextVtabModule = { /* iVersion */ 0, /* xCreate */ 0, /* Helptext is eponymous and read-only */ /* xConnect */ helptextVtabConnect, /* xBestIndex */ helptextVtabBestIndex, /* xDisconnect */ helptextVtabDisconnect, /* xDestroy */ 0, /* xOpen */ helptextVtabOpen, /* xClose */ helptextVtabClose, /* xFilter */ helptextVtabFilter, /* xNext */ helptextVtabNext, /* xEof */ helptextVtabEof, /* xColumn */ helptextVtabColumn, /* xRowid */ helptextVtabRowid, /* xUpdate */ 0, /* xBegin */ 0, /* xSync */ 0, /* xCommit */ 0, /* xRollback */ 0, /* xFindMethod */ 0, /* xRename */ 0, /* xSavepoint */ 0, /* xRelease */ 0, /* xRollbackTo */ 0, /* xShadowName */ 0 }; /* ** Register the helptext virtual table */ int helptext_vtab_register(sqlite3 *db){ int rc = sqlite3_create_module(db, "helptext", &helptextVtabModule, 0); return rc; } /* End of the helptext virtual table ******************************************************************************/ |
Changes to src/sqlcmd.c.
︙ | ︙ | |||
169 170 171 172 173 174 175 176 177 178 179 180 181 182 | int mTrace = SQLITE_TRACE_CLOSE; add_content_sql_commands(db); db_add_aux_functions(db); re_add_sql_func(db); search_sql_setup(db); foci_register(db); deltafunc_init(db); g.repositoryOpen = 1; g.db = db; sqlite3_db_config(db, SQLITE_DBCONFIG_MAINDBNAME, "repository"); db_maybe_set_encryption_key(db, g.zRepositoryName); if( g.zLocalDbName ){ char *zSql = sqlite3_mprintf("ATTACH %Q AS 'localdb' KEY ''", g.zLocalDbName); | > | 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 | int mTrace = SQLITE_TRACE_CLOSE; add_content_sql_commands(db); db_add_aux_functions(db); re_add_sql_func(db); search_sql_setup(db); foci_register(db); deltafunc_init(db); helptext_vtab_register(db); g.repositoryOpen = 1; g.db = db; sqlite3_db_config(db, SQLITE_DBCONFIG_MAINDBNAME, "repository"); db_maybe_set_encryption_key(db, g.zRepositoryName); if( g.zLocalDbName ){ char *zSql = sqlite3_mprintf("ATTACH %Q AS 'localdb' KEY ''", g.zLocalDbName); |
︙ | ︙ |