Many hyperlinks are disabled.
Use anonymous login
to enable hyperlinks.
Overview
| Comment: | Revise the COMMAND: and WEBSITE: parsing to add the ability to specify flag options after the command or website name. |
|---|---|
| Timelines: | family | ancestors | descendants | both | trunk |
| Files: | files | file ages | folders |
| SHA1: |
555ddfecfa9aae065c2b87eee573049a |
| User & Date: | drh 2016-09-13 19:59:52.402 |
Context
|
2016-09-13
| ||
| 22:12 | Update custom MinGW makefile. check-in: b218dbb9f3 user: mistachkin tags: trunk | |
| 19:59 | Revise the COMMAND: and WEBSITE: parsing to add the ability to specify flag options after the command or website name. check-in: 555ddfecfa user: drh tags: trunk | |
| 18:03 | Fix up some comments on the command and webpage name lookup logic. No changes to code. check-in: 49703de740 user: drh tags: trunk | |
Changes
Changes to src/content.c.
| ︙ | ︙ | |||
852 853 854 855 856 857 858 | if( strncmp(z, "-----BEGIN PGP SIGNED MESSAGE-----", 34)==0 ) return 1; if( z[0]<'A' || z[0]>'Z' || z[1]!=' ' || z[0]=='I' ) return 0; if( z[n-1]!='\n' ) return 0; return 1; } /* | | | 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 | if( strncmp(z, "-----BEGIN PGP SIGNED MESSAGE-----", 34)==0 ) return 1; if( z[0]<'A' || z[0]>'Z' || z[1]!=' ' || z[0]=='I' ) return 0; if( z[n-1]!='\n' ) return 0; return 1; } /* ** COMMAND: test-integrity ** ** Verify that all content can be extracted from the BLOB table correctly. ** If the BLOB table is correct, then the repository can always be ** successfully reconstructed using "fossil rebuild". ** ** Options: ** |
| ︙ | ︙ |
Changes to src/dispatch.c.
| ︙ | ︙ | |||
33 34 35 36 37 38 39 |
struct CmdOrPage {
const char *zName; /* Name. Webpages start with "/". Commands do not */
void (*xFunc)(void); /* Function that implements the command or webpage */
const char *zHelp; /* Raw help text */
unsigned eCmdFlags; /* Flags */
};
| > > | > | | | | | > > > > > > > | | | 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 |
struct CmdOrPage {
const char *zName; /* Name. Webpages start with "/". Commands do not */
void (*xFunc)(void); /* Function that implements the command or webpage */
const char *zHelp; /* Raw help text */
unsigned eCmdFlags; /* Flags */
};
/***************************************************************************
** These macros must match similar macros in mkindex.c
** Allowed values for CmdOrPage.eCmdFlags.
*/
#define CMDFLAG_1ST_TIER 0x0001 /* Most important commands */
#define CMDFLAG_2ND_TIER 0x0002 /* Obscure and seldom used commands */
#define CMDFLAG_TEST 0x0004 /* Commands for testing only */
#define CMDFLAG_WEBPAGE 0x0008 /* Web pages */
#define CMDFLAG_COMMAND 0x0010 /* A command */
/**************************************************************************/
/* Only the bits above that are part of CMDFLAG_TH_MASK are passed into
** the TH1 hook procedures. */
#define CMDFLAG_TH_MASK 0x000f /* Legacy flags only */
/* Values for the 2nd parameter to dispatch_name_search() */
#define CMDFLAG_ANY 0x0018 /* Match anything */
#define CMDFLAG_PREFIX 0x0020 /* Prefix match is ok */
#endif /* INTERFACE */
/*
** The page_index.h file contains the definition for aCommand[] - an array
** of CmdOrPage objects that defines all available commands and webpages
** known to Fossil.
|
| ︙ | ︙ |
Changes to src/main.c.
| ︙ | ︙ | |||
729 730 731 732 733 734 735 |
** TH_RETURN: The xFunc() will be executed, the TH1 notification will be
** skipped.
**
** TH_CONTINUE: The xFunc() will be skipped, the TH1 notification will be
** executed.
*/
if( !g.isHTTP && !g.fNoThHook ){
| | | | 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 |
** TH_RETURN: The xFunc() will be executed, the TH1 notification will be
** skipped.
**
** TH_CONTINUE: The xFunc() will be skipped, the TH1 notification will be
** executed.
*/
if( !g.isHTTP && !g.fNoThHook ){
rc = Th_CommandHook(pCmd->zName, pCmd->eCmdFlags & CMDFLAG_TH_MASK);
}else{
rc = TH_OK;
}
if( rc==TH_OK || rc==TH_RETURN || rc==TH_CONTINUE ){
if( rc==TH_OK || rc==TH_RETURN ){
#endif
pCmd->xFunc();
#ifdef FOSSIL_ENABLE_TH1_HOOKS
}
if( !g.isHTTP && !g.fNoThHook && (rc==TH_OK || rc==TH_CONTINUE) ){
Th_CommandNotify(pCmd->zName, pCmd->eCmdFlags & CMDFLAG_TH_MASK);
}
}
#endif
fossil_exit(0);
/*NOT_REACHED*/
return 0;
}
|
| ︙ | ︙ | |||
1544 1545 1546 1547 1548 1549 1550 |
** skipped.
**
** TH_CONTINUE: The xFunc() will be skipped, the TH1 notification will be
** executed.
*/
int rc;
if( !g.fNoThHook ){
| | | | 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 |
** skipped.
**
** TH_CONTINUE: The xFunc() will be skipped, the TH1 notification will be
** executed.
*/
int rc;
if( !g.fNoThHook ){
rc = Th_WebpageHook(pCmd->zName+1, pCmd->eCmdFlags & CMDFLAG_TH_MASK);
}else{
rc = TH_OK;
}
if( rc==TH_OK || rc==TH_RETURN || rc==TH_CONTINUE ){
if( rc==TH_OK || rc==TH_RETURN ){
#endif
pCmd->xFunc();
#ifdef FOSSIL_ENABLE_TH1_HOOKS
}
if( !g.fNoThHook && (rc==TH_OK || rc==TH_CONTINUE) ){
Th_WebpageNotify(pCmd->zName+1, pCmd->eCmdFlags & CMDFLAG_TH_MASK);
}
}
#endif
}
/* Return the result.
*/
|
| ︙ | ︙ |
Changes to src/mkindex.c.
| ︙ | ︙ | |||
20 21 22 23 24 25 26 27 | ** routine collects information about these entry points and then ** generates (on standard output) C code used by Fossil to dispatch ** to those entry points. ** ** The source code is scanned for comment lines of the form: ** ** WEBPAGE: /abc/xyz ** | > | | > | > > > > > > > > | > > > < > | < < | | < < < | > | | < > > > > > > > > > > > | | 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 |
** routine collects information about these entry points and then
** generates (on standard output) C code used by Fossil to dispatch
** to those entry points.
**
** The source code is scanned for comment lines of the form:
**
** WEBPAGE: /abc/xyz
** COMMAND: cmdname
**
** These comment should be followed by a function definition of the
** form:
**
** void function_name(void){
**
** This routine creates C source code for a constant table that maps
** command and webpage name into pointers to the function.
**
** Command names can divided into three classes: 1st-tier, 2nd-tier,
** and test. 1st-tier commands are the most frequently used and the
** ones that show up with "fossil help". 2nd-tier are seldom-used and/or
** legacy command. Test commands are unsupported commands used for testing
** and analysis only.
**
** Commands are 1st-tier by default. If the command name begins with
** "test-" or if the command name as a "test" argument, then it becomes
** a test command. If the command name has a "2nd-tier" argument or ends
** with a "*" character, it is second tier. Examples:
**
** COMMAND: abcde*
** COMMAND: fghij 2nd-tier
** COMMAND: test-xyzzy
** COMMAND: xyzzy test
**
** New arguments may be added in future releases that set additional
** bits in the eCmdFlags field.
**
** Additional lines of comment after the COMMAND: or WEBPAGE: become
** the built-in help text for that command or webpage.
**
** Multiple COMMAND: entries can be attached to the same command, thus
** creating multiple aliases for that command. Similarly, multiple
** WEBPAGE: entries can be attached to the same webpage function, to give
** that page aliases.
*/
#include <stdio.h>
#include <stdlib.h>
#include <assert.h>
#include <string.h>
/***************************************************************************
** These macros must match similar macros in dispatch.c.
**
** Allowed values for CmdOrPage.eCmdFlags. */
#define CMDFLAG_1ST_TIER 0x0001 /* Most important commands */
#define CMDFLAG_2ND_TIER 0x0002 /* Obscure and seldom used commands */
#define CMDFLAG_TEST 0x0004 /* Commands for testing only */
#define CMDFLAG_WEBPAGE 0x0008 /* Web pages */
#define CMDFLAG_COMMAND 0x0010 /* A command */
/**************************************************************************/
/*
** Each entry looks like this:
*/
typedef struct Entry {
int eType; /* CMDFLAG_* values */
char *zIf; /* Enclose in #if */
char *zFunc; /* Name of implementation */
char *zPath; /* Webpage or command name */
char *zHelp; /* Help text */
int iHelp; /* Index of Help text */
} Entry;
|
| ︙ | ︙ | |||
104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 |
/*
** Current filename and line number
*/
char *zFile;
int nLine;
/*
** Duplicate N characters of a string.
*/
char *string_dup(const char *zSrc, int n){
char *z;
if( n<0 ) n = strlen(zSrc);
z = malloc( n+1 );
if( z==0 ){ fprintf(stderr,"Out of memory!\n"); exit(1); }
strncpy(z, zSrc, n);
z[n] = 0;
return z;
}
/*
** Scan a line looking for comments containing zLabel. Make
** new entries if found.
*/
void scan_for_label(const char *zLabel, char *zLine, int eType){
int i, j;
int len = strlen(zLabel);
if( nUsed>=N_ENTRY ) return;
| > > > > > > > > > > > > > > > > > > > > > > > | | | > > > > | > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > > | | | | | | | | | < < | < < | 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 |
/*
** Current filename and line number
*/
char *zFile;
int nLine;
/*
** Number of errors
*/
int nErr = 0;
/*
** Duplicate N characters of a string.
*/
char *string_dup(const char *zSrc, int n){
char *z;
if( n<0 ) n = strlen(zSrc);
z = malloc( n+1 );
if( z==0 ){ fprintf(stderr,"Out of memory!\n"); exit(1); }
strncpy(z, zSrc, n);
z[n] = 0;
return z;
}
/*
** Safe isspace macro. Works with signed characters.
*/
int fossil_isspace(char c){
return c==' ' || (c<='\r' && c>='\t');
}
/*
** Safe isident macro. Works with signed characters.
*/
int fossil_isident(char c){
if( c>='a' && c<='z' ) return 1;
if( c>='A' && c<='Z' ) return 1;
if( c>='0' && c<='9' ) return 1;
if( c=='_' ) return 1;
return 0;
}
/*
** Scan a line looking for comments containing zLabel. Make
** new entries if found.
*/
void scan_for_label(const char *zLabel, char *zLine, int eType){
int i, j;
int len = strlen(zLabel);
if( nUsed>=N_ENTRY ) return;
for(i=0; fossil_isspace(zLine[i]) || zLine[i]=='*'; i++){}
if( zLine[i]!=zLabel[0] ) return;
if( strncmp(&zLine[i],zLabel, len)==0 ){
i += len;
}else{
return;
}
while( fossil_isspace(zLine[i]) ){ i++; }
if( zLine[i]=='/' ) i++;
for(j=0; zLine[i+j] && !fossil_isspace(zLine[i+j]); j++){}
aEntry[nUsed].eType = eType;
if( eType & CMDFLAG_WEBPAGE ){
aEntry[nUsed].zPath = string_dup(&zLine[i-1], j+1);
aEntry[nUsed].zPath[0] = '/';
}else{
aEntry[nUsed].zPath = string_dup(&zLine[i], j);
}
aEntry[nUsed].zFunc = 0;
if( (eType & CMDFLAG_COMMAND)!=0 ){
if( strncmp(&zLine[i], "test-", 5)==0 ){
/* Commands that start with "test-" are test-commands */
aEntry[nUsed].eType |= CMDFLAG_TEST;
}else if( zLine[i+j-1]=='*' ){
/* If the command name ends in '*', remove the '*' from the name
** but move the command into the second tier */
aEntry[nUsed].zPath[j-1] = 0;
aEntry[nUsed].eType |= CMDFLAG_2ND_TIER;
}else{
/* Otherwise, this is a first-tier command */
aEntry[nUsed].eType |= CMDFLAG_1ST_TIER;
}
}
/* Processing additional flags that might following the command name */
while( zLine[i+j]!=0 ){
i += j;
while( fossil_isspace(zLine[i]) ){ i++; }
if( zLine[i]==0 ) break;
for(j=0; zLine[i+j] && !fossil_isspace(zLine[i+j]); j++){}
if( j==8 && strncmp(&zLine[i], "1st-tier", j)==0 ){
aEntry[nUsed].eType &= ~(CMDFLAG_2ND_TIER|CMDFLAG_TEST);
aEntry[nUsed].eType |= CMDFLAG_1ST_TIER;
}else if( j==8 && strncmp(&zLine[i], "2nd-tier", j)==0 ){
aEntry[nUsed].eType &= ~(CMDFLAG_1ST_TIER|CMDFLAG_TEST);
aEntry[nUsed].eType |= CMDFLAG_2ND_TIER;
}else if( j==4 && strncmp(&zLine[i], "test", j)==0 ){
aEntry[nUsed].eType &= ~(CMDFLAG_1ST_TIER|CMDFLAG_2ND_TIER);
aEntry[nUsed].eType |= CMDFLAG_TEST;
}else{
fprintf(stderr, "%s:%d: unknown option: '%.*s'\n",
zFile, nLine, j, &zLine[i]);
nErr++;
}
}
nUsed++;
}
/*
** Check to see if the current line is an #if and if it is, add it to
** the zIf[] string. If the current line is an #endif or #else or #elif
** then cancel the current zIf[] string.
*/
void scan_for_if(const char *zLine){
int i;
int len;
if( zLine[0]!='#' ) return;
for(i=1; fossil_isspace(zLine[i]); i++){}
if( zLine[i]==0 ) return;
len = strlen(&zLine[i]);
if( strncmp(&zLine[i],"if",2)==0 ){
zIf[0] = '#';
memcpy(&zIf[1], &zLine[i], len+1);
}else if( zLine[i]=='e' ){
zIf[0] = 0;
}
}
/*
** Scan a line for a function that implements a web page or command.
*/
void scan_for_func(char *zLine){
int i,j,k;
char *z;
if( nUsed<=nFixed ) return;
if( strncmp(zLine, "**", 2)==0
&& fossil_isspace(zLine[2])
&& strlen(zLine)<sizeof(zHelp)-nHelp-1
&& nUsed>nFixed
&& strncmp(zLine,"** COMMAND:",11)!=0
&& strncmp(zLine,"** WEBPAGE:",11)!=0
){
if( zLine[2]=='\n' ){
zHelp[nHelp++] = '\n';
}else{
if( strncmp(&zLine[3], "Usage: ", 6)==0 ) nHelp = 0;
strcpy(&zHelp[nHelp], &zLine[3]);
nHelp += strlen(&zHelp[nHelp]);
}
return;
}
for(i=0; fossil_isspace(zLine[i]); i++){}
if( zLine[i]==0 ) return;
if( strncmp(&zLine[i],"void",4)!=0 ){
if( zLine[i]!='*' ) goto page_skip;
return;
}
i += 4;
if( !fossil_isspace(zLine[i]) ) goto page_skip;
while( fossil_isspace(zLine[i]) ){ i++; }
for(j=0; fossil_isident(zLine[i+j]); j++){}
if( j==0 ) goto page_skip;
for(k=nHelp-1; k>=0 && fossil_isspace(zHelp[k]); k--){}
nHelp = k+1;
zHelp[nHelp] = 0;
for(k=0; k<nHelp && fossil_isspace(zHelp[k]); k++){}
if( k<nHelp ){
z = string_dup(&zHelp[k], nHelp-k);
}else{
z = "";
}
for(k=nFixed; k<nUsed; k++){
aEntry[k].zIf = zIf[0] ? string_dup(zIf, -1) : 0;
aEntry[k].zFunc = string_dup(&zLine[i], j);
aEntry[k].zHelp = z;
z = 0;
aEntry[k].iHelp = nFixed;
}
i+=j;
while( fossil_isspace(zLine[i]) ){ i++; }
if( zLine[i]!='(' ) goto page_skip;
nFixed = nUsed;
nHelp = 0;
return;
page_skip:
for(i=nFixed; i<nUsed; i++){
fprintf(stderr,"%s:%d: skipping page \"%s\"\n",
zFile, nLine, aEntry[i].zPath);
}
nUsed = nFixed;
}
/*
** Compare two entries
*/
int e_compare(const void *a, const void *b){
const Entry *pA = (const Entry*)a;
const Entry *pB = (const Entry*)b;
return strcmp(pA->zPath, pB->zPath);
}
/*
** Build the binary search table.
*/
void build_table(void){
int i;
|
| ︙ | ︙ | |||
290 291 292 293 294 295 296 |
}
/* Generate the aCommand[] table */
printf("static const CmdOrPage aCommand[] = {\n");
for(i=0; i<nFixed; i++){
const char *z = aEntry[i].zPath;
int n = strlen(z);
| < < < < < < < < < | | | | | | 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 |
}
/* Generate the aCommand[] table */
printf("static const CmdOrPage aCommand[] = {\n");
for(i=0; i<nFixed; i++){
const char *z = aEntry[i].zPath;
int n = strlen(z);
if( aEntry[i].zIf ){
printf("%s", aEntry[i].zIf);
}else if( (aEntry[i].eType & CMDFLAG_WEBPAGE)!=0 ){
nWeb++;
}
printf(" { \"%.*s\",%*s%s,%*szHelp%03d, 0x%02x },\n",
n, z,
25-n, "",
aEntry[i].zFunc,
(int)(30-strlen(aEntry[i].zFunc)), "",
aEntry[i].iHelp,
aEntry[i].eType
);
if( aEntry[i].zIf ) printf("#endif\n");
}
printf("};\n");
printf("#define FOSSIL_FIRST_CMD %d\n", nWeb);
}
|
| ︙ | ︙ | |||
332 333 334 335 336 337 338 |
fprintf(stderr,"%s: cannot open\n", zFile);
return;
}
nLine = 0;
while( fgets(zLine, sizeof(zLine), in) ){
nLine++;
scan_for_if(zLine);
| | | | | 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 |
fprintf(stderr,"%s: cannot open\n", zFile);
return;
}
nLine = 0;
while( fgets(zLine, sizeof(zLine), in) ){
nLine++;
scan_for_if(zLine);
scan_for_label("WEBPAGE:",zLine,CMDFLAG_WEBPAGE);
scan_for_label("COMMAND:",zLine,CMDFLAG_COMMAND);
scan_for_func(zLine);
}
fclose(in);
nUsed = nFixed;
}
int main(int argc, char **argv){
int i;
for(i=1; i<argc; i++){
zFile = argv[i];
process_file();
}
build_table();
return nErr;
}
|