xref: /sqlite-3.40.0/src/treeview.c (revision 79d5bc80)
1 /*
2 ** 2015-06-08
3 **
4 ** The author disclaims copyright to this source code.  In place of
5 ** a legal notice, here is a blessing:
6 **
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.
10 **
11 *************************************************************************
12 **
13 ** This file contains C code to implement the TreeView debugging routines.
14 ** These routines print a parse tree to standard output for debugging and
15 ** analysis.
16 **
17 ** The interfaces in this file is only available when compiling
18 ** with SQLITE_DEBUG.
19 */
20 #include "sqliteInt.h"
21 #ifdef SQLITE_DEBUG
22 
23 /*
24 ** Add a new subitem to the tree.  The moreToFollow flag indicates that this
25 ** is not the last item in the tree.
26 */
27 static TreeView *sqlite3TreeViewPush(TreeView *p, u8 moreToFollow){
28   if( p==0 ){
29     p = sqlite3_malloc64( sizeof(*p) );
30     if( p==0 ) return 0;
31     memset(p, 0, sizeof(*p));
32   }else{
33     p->iLevel++;
34   }
35   assert( moreToFollow==0 || moreToFollow==1 );
36   if( p->iLevel<sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow;
37   return p;
38 }
39 
40 /*
41 ** Finished with one layer of the tree
42 */
43 static void sqlite3TreeViewPop(TreeView *p){
44   if( p==0 ) return;
45   p->iLevel--;
46   if( p->iLevel<0 ) sqlite3_free(p);
47 }
48 
49 /*
50 ** Generate a single line of output for the tree, with a prefix that contains
51 ** all the appropriate tree lines
52 */
53 static void sqlite3TreeViewLine(TreeView *p, const char *zFormat, ...){
54   va_list ap;
55   int i;
56   StrAccum acc;
57   char zBuf[500];
58   sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
59   if( p ){
60     for(i=0; i<p->iLevel && i<sizeof(p->bLine)-1; i++){
61       sqlite3_str_append(&acc, p->bLine[i] ? "|   " : "    ", 4);
62     }
63     sqlite3_str_append(&acc, p->bLine[i] ? "|-- " : "'-- ", 4);
64   }
65   if( zFormat!=0 ){
66     va_start(ap, zFormat);
67     sqlite3_str_vappendf(&acc, zFormat, ap);
68     va_end(ap);
69     assert( acc.nChar>0 || acc.accError );
70     sqlite3_str_append(&acc, "\n", 1);
71   }
72   sqlite3StrAccumFinish(&acc);
73   fprintf(stdout,"%s", zBuf);
74   fflush(stdout);
75 }
76 
77 /*
78 ** Shorthand for starting a new tree item that consists of a single label
79 */
80 static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){
81   p = sqlite3TreeViewPush(p, moreFollows);
82   sqlite3TreeViewLine(p, "%s", zLabel);
83 }
84 
85 /*
86 ** Generate a human-readable description of a WITH clause.
87 */
88 void sqlite3TreeViewWith(TreeView *pView, const With *pWith, u8 moreToFollow){
89   int i;
90   if( pWith==0 ) return;
91   if( pWith->nCte==0 ) return;
92   if( pWith->pOuter ){
93     sqlite3TreeViewLine(pView, "WITH (0x%p, pOuter=0x%p)",pWith,pWith->pOuter);
94   }else{
95     sqlite3TreeViewLine(pView, "WITH (0x%p)", pWith);
96   }
97   if( pWith->nCte>0 ){
98     pView = sqlite3TreeViewPush(pView, 1);
99     for(i=0; i<pWith->nCte; i++){
100       StrAccum x;
101       char zLine[1000];
102       const struct Cte *pCte = &pWith->a[i];
103       sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
104       sqlite3_str_appendf(&x, "%s", pCte->zName);
105       if( pCte->pCols && pCte->pCols->nExpr>0 ){
106         char cSep = '(';
107         int j;
108         for(j=0; j<pCte->pCols->nExpr; j++){
109           sqlite3_str_appendf(&x, "%c%s", cSep, pCte->pCols->a[j].zEName);
110           cSep = ',';
111         }
112         sqlite3_str_appendf(&x, ")");
113       }
114       sqlite3_str_appendf(&x, " AS");
115       sqlite3StrAccumFinish(&x);
116       sqlite3TreeViewItem(pView, zLine, i<pWith->nCte-1);
117       sqlite3TreeViewSelect(pView, pCte->pSelect, 0);
118       sqlite3TreeViewPop(pView);
119     }
120     sqlite3TreeViewPop(pView);
121   }
122 }
123 
124 /*
125 ** Generate a human-readable description of a SrcList object.
126 */
127 void sqlite3TreeViewSrcList(TreeView *pView, const SrcList *pSrc){
128   int i;
129   for(i=0; i<pSrc->nSrc; i++){
130     const struct SrcList_item *pItem = &pSrc->a[i];
131     StrAccum x;
132     char zLine[100];
133     sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
134     sqlite3_str_appendf(&x, "{%d:*}", pItem->iCursor);
135     if( pItem->zDatabase ){
136       sqlite3_str_appendf(&x, " %s.%s", pItem->zDatabase, pItem->zName);
137     }else if( pItem->zName ){
138       sqlite3_str_appendf(&x, " %s", pItem->zName);
139     }
140     if( pItem->pTab ){
141       sqlite3_str_appendf(&x, " tab=%Q nCol=%d ptr=%p",
142            pItem->pTab->zName, pItem->pTab->nCol, pItem->pTab);
143     }
144     if( pItem->zAlias ){
145       sqlite3_str_appendf(&x, " (AS %s)", pItem->zAlias);
146     }
147     if( pItem->fg.jointype & JT_LEFT ){
148       sqlite3_str_appendf(&x, " LEFT-JOIN");
149     }
150     sqlite3StrAccumFinish(&x);
151     sqlite3TreeViewItem(pView, zLine, i<pSrc->nSrc-1);
152     if( pItem->pSelect ){
153       sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
154     }
155     if( pItem->fg.isTabFunc ){
156       sqlite3TreeViewExprList(pView, pItem->u1.pFuncArg, 0, "func-args:");
157     }
158     sqlite3TreeViewPop(pView);
159   }
160 }
161 
162 /*
163 ** Generate a human-readable description of a Select object.
164 */
165 void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
166   int n = 0;
167   int cnt = 0;
168   if( p==0 ){
169     sqlite3TreeViewLine(pView, "nil-SELECT");
170     return;
171   }
172   pView = sqlite3TreeViewPush(pView, moreToFollow);
173   if( p->pWith ){
174     sqlite3TreeViewWith(pView, p->pWith, 1);
175     cnt = 1;
176     sqlite3TreeViewPush(pView, 1);
177   }
178   do{
179     if( p->selFlags & SF_WhereBegin ){
180       sqlite3TreeViewLine(pView, "sqlite3WhereBegin()");
181     }else{
182       sqlite3TreeViewLine(pView,
183         "SELECT%s%s (%u/%p) selFlags=0x%x nSelectRow=%d",
184         ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
185         ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""),
186         p->selId, p, p->selFlags,
187         (int)p->nSelectRow
188       );
189     }
190     if( cnt++ ) sqlite3TreeViewPop(pView);
191     if( p->pPrior ){
192       n = 1000;
193     }else{
194       n = 0;
195       if( p->pSrc && p->pSrc->nSrc ) n++;
196       if( p->pWhere ) n++;
197       if( p->pGroupBy ) n++;
198       if( p->pHaving ) n++;
199       if( p->pOrderBy ) n++;
200       if( p->pLimit ) n++;
201 #ifndef SQLITE_OMIT_WINDOWFUNC
202       if( p->pWin ) n++;
203       if( p->pWinDefn ) n++;
204 #endif
205     }
206     if( p->pEList ){
207       sqlite3TreeViewExprList(pView, p->pEList, n>0, "result-set");
208     }
209     n--;
210 #ifndef SQLITE_OMIT_WINDOWFUNC
211     if( p->pWin ){
212       Window *pX;
213       pView = sqlite3TreeViewPush(pView, (n--)>0);
214       sqlite3TreeViewLine(pView, "window-functions");
215       for(pX=p->pWin; pX; pX=pX->pNextWin){
216         sqlite3TreeViewWinFunc(pView, pX, pX->pNextWin!=0);
217       }
218       sqlite3TreeViewPop(pView);
219     }
220 #endif
221     if( p->pSrc && p->pSrc->nSrc ){
222       pView = sqlite3TreeViewPush(pView, (n--)>0);
223       sqlite3TreeViewLine(pView, "FROM");
224       sqlite3TreeViewSrcList(pView, p->pSrc);
225       sqlite3TreeViewPop(pView);
226     }
227     if( p->pWhere ){
228       sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
229       sqlite3TreeViewExpr(pView, p->pWhere, 0);
230       sqlite3TreeViewPop(pView);
231     }
232     if( p->pGroupBy ){
233       sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
234     }
235     if( p->pHaving ){
236       sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
237       sqlite3TreeViewExpr(pView, p->pHaving, 0);
238       sqlite3TreeViewPop(pView);
239     }
240 #ifndef SQLITE_OMIT_WINDOWFUNC
241     if( p->pWinDefn ){
242       Window *pX;
243       sqlite3TreeViewItem(pView, "WINDOW", (n--)>0);
244       for(pX=p->pWinDefn; pX; pX=pX->pNextWin){
245         sqlite3TreeViewWindow(pView, pX, pX->pNextWin!=0);
246       }
247       sqlite3TreeViewPop(pView);
248     }
249 #endif
250     if( p->pOrderBy ){
251       sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
252     }
253     if( p->pLimit ){
254       sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
255       sqlite3TreeViewExpr(pView, p->pLimit->pLeft, p->pLimit->pRight!=0);
256       if( p->pLimit->pRight ){
257         sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
258         sqlite3TreeViewExpr(pView, p->pLimit->pRight, 0);
259         sqlite3TreeViewPop(pView);
260       }
261       sqlite3TreeViewPop(pView);
262     }
263     if( p->pPrior ){
264       const char *zOp = "UNION";
265       switch( p->op ){
266         case TK_ALL:         zOp = "UNION ALL";  break;
267         case TK_INTERSECT:   zOp = "INTERSECT";  break;
268         case TK_EXCEPT:      zOp = "EXCEPT";     break;
269       }
270       sqlite3TreeViewItem(pView, zOp, 1);
271     }
272     p = p->pPrior;
273   }while( p!=0 );
274   sqlite3TreeViewPop(pView);
275 }
276 
277 #ifndef SQLITE_OMIT_WINDOWFUNC
278 /*
279 ** Generate a description of starting or stopping bounds
280 */
281 void sqlite3TreeViewBound(
282   TreeView *pView,        /* View context */
283   u8 eBound,              /* UNBOUNDED, CURRENT, PRECEDING, FOLLOWING */
284   Expr *pExpr,            /* Value for PRECEDING or FOLLOWING */
285   u8 moreToFollow         /* True if more to follow */
286 ){
287   switch( eBound ){
288     case TK_UNBOUNDED: {
289       sqlite3TreeViewItem(pView, "UNBOUNDED", moreToFollow);
290       sqlite3TreeViewPop(pView);
291       break;
292     }
293     case TK_CURRENT: {
294       sqlite3TreeViewItem(pView, "CURRENT", moreToFollow);
295       sqlite3TreeViewPop(pView);
296       break;
297     }
298     case TK_PRECEDING: {
299       sqlite3TreeViewItem(pView, "PRECEDING", moreToFollow);
300       sqlite3TreeViewExpr(pView, pExpr, 0);
301       sqlite3TreeViewPop(pView);
302       break;
303     }
304     case TK_FOLLOWING: {
305       sqlite3TreeViewItem(pView, "FOLLOWING", moreToFollow);
306       sqlite3TreeViewExpr(pView, pExpr, 0);
307       sqlite3TreeViewPop(pView);
308       break;
309     }
310   }
311 }
312 #endif /* SQLITE_OMIT_WINDOWFUNC */
313 
314 #ifndef SQLITE_OMIT_WINDOWFUNC
315 /*
316 ** Generate a human-readable explanation for a Window object
317 */
318 void sqlite3TreeViewWindow(TreeView *pView, const Window *pWin, u8 more){
319   int nElement = 0;
320   if( pWin->pFilter ){
321     sqlite3TreeViewItem(pView, "FILTER", 1);
322     sqlite3TreeViewExpr(pView, pWin->pFilter, 0);
323     sqlite3TreeViewPop(pView);
324   }
325   pView = sqlite3TreeViewPush(pView, more);
326   if( pWin->zName ){
327     sqlite3TreeViewLine(pView, "OVER %s (%p)", pWin->zName, pWin);
328   }else{
329     sqlite3TreeViewLine(pView, "OVER (%p)", pWin);
330   }
331   if( pWin->zBase )    nElement++;
332   if( pWin->pOrderBy ) nElement++;
333   if( pWin->eFrmType ) nElement++;
334   if( pWin->eExclude ) nElement++;
335   if( pWin->zBase ){
336     sqlite3TreeViewPush(pView, (--nElement)>0);
337     sqlite3TreeViewLine(pView, "window: %s", pWin->zBase);
338     sqlite3TreeViewPop(pView);
339   }
340   if( pWin->pPartition ){
341     sqlite3TreeViewExprList(pView, pWin->pPartition, nElement>0,"PARTITION-BY");
342   }
343   if( pWin->pOrderBy ){
344     sqlite3TreeViewExprList(pView, pWin->pOrderBy, (--nElement)>0, "ORDER-BY");
345   }
346   if( pWin->eFrmType ){
347     char zBuf[30];
348     const char *zFrmType = "ROWS";
349     if( pWin->eFrmType==TK_RANGE ) zFrmType = "RANGE";
350     if( pWin->eFrmType==TK_GROUPS ) zFrmType = "GROUPS";
351     sqlite3_snprintf(sizeof(zBuf),zBuf,"%s%s",zFrmType,
352         pWin->bImplicitFrame ? " (implied)" : "");
353     sqlite3TreeViewItem(pView, zBuf, (--nElement)>0);
354     sqlite3TreeViewBound(pView, pWin->eStart, pWin->pStart, 1);
355     sqlite3TreeViewBound(pView, pWin->eEnd, pWin->pEnd, 0);
356     sqlite3TreeViewPop(pView);
357   }
358   if( pWin->eExclude ){
359     char zBuf[30];
360     const char *zExclude;
361     switch( pWin->eExclude ){
362       case TK_NO:      zExclude = "NO OTHERS";   break;
363       case TK_CURRENT: zExclude = "CURRENT ROW"; break;
364       case TK_GROUP:   zExclude = "GROUP";       break;
365       case TK_TIES:    zExclude = "TIES";        break;
366       default:
367         sqlite3_snprintf(sizeof(zBuf),zBuf,"invalid(%d)", pWin->eExclude);
368         zExclude = zBuf;
369         break;
370     }
371     sqlite3TreeViewPush(pView, 0);
372     sqlite3TreeViewLine(pView, "EXCLUDE %s", zExclude);
373     sqlite3TreeViewPop(pView);
374   }
375   sqlite3TreeViewPop(pView);
376 }
377 #endif /* SQLITE_OMIT_WINDOWFUNC */
378 
379 #ifndef SQLITE_OMIT_WINDOWFUNC
380 /*
381 ** Generate a human-readable explanation for a Window Function object
382 */
383 void sqlite3TreeViewWinFunc(TreeView *pView, const Window *pWin, u8 more){
384   pView = sqlite3TreeViewPush(pView, more);
385   sqlite3TreeViewLine(pView, "WINFUNC %s(%d)",
386                        pWin->pFunc->zName, pWin->pFunc->nArg);
387   sqlite3TreeViewWindow(pView, pWin, 0);
388   sqlite3TreeViewPop(pView);
389 }
390 #endif /* SQLITE_OMIT_WINDOWFUNC */
391 
392 /*
393 ** Generate a human-readable explanation of an expression tree.
394 */
395 void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){
396   const char *zBinOp = 0;   /* Binary operator */
397   const char *zUniOp = 0;   /* Unary operator */
398   char zFlgs[60];
399   pView = sqlite3TreeViewPush(pView, moreToFollow);
400   if( pExpr==0 ){
401     sqlite3TreeViewLine(pView, "nil");
402     sqlite3TreeViewPop(pView);
403     return;
404   }
405   if( pExpr->flags || pExpr->affExpr ){
406     if( ExprHasProperty(pExpr, EP_FromJoin) ){
407       sqlite3_snprintf(sizeof(zFlgs),zFlgs,"  fg.af=%x.%c iRJT=%d",
408                        pExpr->flags, pExpr->affExpr ? pExpr->affExpr : 'n',
409                        pExpr->iRightJoinTable);
410     }else{
411       sqlite3_snprintf(sizeof(zFlgs),zFlgs,"  fg.af=%x.%c",
412                        pExpr->flags, pExpr->affExpr ? pExpr->affExpr : 'n');
413     }
414   }else{
415     zFlgs[0] = 0;
416   }
417   switch( pExpr->op ){
418     case TK_AGG_COLUMN: {
419       sqlite3TreeViewLine(pView, "AGG{%d:%d}%s",
420             pExpr->iTable, pExpr->iColumn, zFlgs);
421       break;
422     }
423     case TK_COLUMN: {
424       if( pExpr->iTable<0 ){
425         /* This only happens when coding check constraints */
426         char zOp2[16];
427         if( pExpr->op2 ){
428           sqlite3_snprintf(sizeof(zOp2),zOp2," op2=0x%02x",pExpr->op2);
429         }else{
430           zOp2[0] = 0;
431         }
432         sqlite3TreeViewLine(pView, "COLUMN(%d)%s%s",
433                                     pExpr->iColumn, zFlgs, zOp2);
434       }else{
435         sqlite3TreeViewLine(pView, "{%d:%d} pTab=%p%s",
436                         pExpr->iTable, pExpr->iColumn,
437                         pExpr->y.pTab, zFlgs);
438       }
439       if( ExprHasProperty(pExpr, EP_FixedCol) ){
440         sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
441       }
442       break;
443     }
444     case TK_INTEGER: {
445       if( pExpr->flags & EP_IntValue ){
446         sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue);
447       }else{
448         sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken);
449       }
450       break;
451     }
452 #ifndef SQLITE_OMIT_FLOATING_POINT
453     case TK_FLOAT: {
454       sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
455       break;
456     }
457 #endif
458     case TK_STRING: {
459       sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken);
460       break;
461     }
462     case TK_NULL: {
463       sqlite3TreeViewLine(pView,"NULL");
464       break;
465     }
466     case TK_TRUEFALSE: {
467       sqlite3TreeViewLine(pView,
468          sqlite3ExprTruthValue(pExpr) ? "TRUE" : "FALSE");
469       break;
470     }
471 #ifndef SQLITE_OMIT_BLOB_LITERAL
472     case TK_BLOB: {
473       sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
474       break;
475     }
476 #endif
477     case TK_VARIABLE: {
478       sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)",
479                           pExpr->u.zToken, pExpr->iColumn);
480       break;
481     }
482     case TK_REGISTER: {
483       sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable);
484       break;
485     }
486     case TK_ID: {
487       sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken);
488       break;
489     }
490 #ifndef SQLITE_OMIT_CAST
491     case TK_CAST: {
492       /* Expressions of the form:   CAST(pLeft AS token) */
493       sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken);
494       sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
495       break;
496     }
497 #endif /* SQLITE_OMIT_CAST */
498     case TK_LT:      zBinOp = "LT";     break;
499     case TK_LE:      zBinOp = "LE";     break;
500     case TK_GT:      zBinOp = "GT";     break;
501     case TK_GE:      zBinOp = "GE";     break;
502     case TK_NE:      zBinOp = "NE";     break;
503     case TK_EQ:      zBinOp = "EQ";     break;
504     case TK_IS:      zBinOp = "IS";     break;
505     case TK_ISNOT:   zBinOp = "ISNOT";  break;
506     case TK_AND:     zBinOp = "AND";    break;
507     case TK_OR:      zBinOp = "OR";     break;
508     case TK_PLUS:    zBinOp = "ADD";    break;
509     case TK_STAR:    zBinOp = "MUL";    break;
510     case TK_MINUS:   zBinOp = "SUB";    break;
511     case TK_REM:     zBinOp = "REM";    break;
512     case TK_BITAND:  zBinOp = "BITAND"; break;
513     case TK_BITOR:   zBinOp = "BITOR";  break;
514     case TK_SLASH:   zBinOp = "DIV";    break;
515     case TK_LSHIFT:  zBinOp = "LSHIFT"; break;
516     case TK_RSHIFT:  zBinOp = "RSHIFT"; break;
517     case TK_CONCAT:  zBinOp = "CONCAT"; break;
518     case TK_DOT:     zBinOp = "DOT";    break;
519 
520     case TK_UMINUS:  zUniOp = "UMINUS"; break;
521     case TK_UPLUS:   zUniOp = "UPLUS";  break;
522     case TK_BITNOT:  zUniOp = "BITNOT"; break;
523     case TK_NOT:     zUniOp = "NOT";    break;
524     case TK_ISNULL:  zUniOp = "ISNULL"; break;
525     case TK_NOTNULL: zUniOp = "NOTNULL"; break;
526 
527     case TK_TRUTH: {
528       int x;
529       const char *azOp[] = {
530          "IS-FALSE", "IS-TRUE", "IS-NOT-FALSE", "IS-NOT-TRUE"
531       };
532       assert( pExpr->op2==TK_IS || pExpr->op2==TK_ISNOT );
533       assert( pExpr->pRight );
534       assert( sqlite3ExprSkipCollate(pExpr->pRight)->op==TK_TRUEFALSE );
535       x = (pExpr->op2==TK_ISNOT)*2 + sqlite3ExprTruthValue(pExpr->pRight);
536       zUniOp = azOp[x];
537       break;
538     }
539 
540     case TK_SPAN: {
541       sqlite3TreeViewLine(pView, "SPAN %Q", pExpr->u.zToken);
542       sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
543       break;
544     }
545 
546     case TK_COLLATE: {
547       /* COLLATE operators without the EP_Collate flag are intended to
548       ** emulate collation associated with a table column.  These show
549       ** up in the treeview output as "SOFT-COLLATE".  Explicit COLLATE
550       ** operators that appear in the original SQL always have the
551       ** EP_Collate bit set and appear in treeview output as just "COLLATE" */
552       sqlite3TreeViewLine(pView, "%sCOLLATE %Q%s",
553         !ExprHasProperty(pExpr, EP_Collate) ? "SOFT-" : "",
554         pExpr->u.zToken, zFlgs);
555       sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
556       break;
557     }
558 
559     case TK_AGG_FUNCTION:
560     case TK_FUNCTION: {
561       ExprList *pFarg;       /* List of function arguments */
562       Window *pWin;
563       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
564         pFarg = 0;
565         pWin = 0;
566       }else{
567         pFarg = pExpr->x.pList;
568 #ifndef SQLITE_OMIT_WINDOWFUNC
569         pWin = pExpr->y.pWin;
570 #else
571         pWin = 0;
572 #endif
573       }
574       if( pExpr->op==TK_AGG_FUNCTION ){
575         sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q%s",
576                              pExpr->op2, pExpr->u.zToken, zFlgs);
577       }else if( pExpr->op2!=0 ){
578         const char *zOp2;
579         char zBuf[8];
580         sqlite3_snprintf(sizeof(zBuf),zBuf,"0x%02x",pExpr->op2);
581         zOp2 = zBuf;
582         if( pExpr->op2==NC_IsCheck ) zOp2 = "NC_IsCheck";
583         if( pExpr->op2==NC_IdxExpr ) zOp2 = "NC_IdxExpr";
584         if( pExpr->op2==NC_PartIdx ) zOp2 = "NC_PartIdx";
585         if( pExpr->op2==NC_GenCol ) zOp2 = "NC_GenCol";
586         sqlite3TreeViewLine(pView, "FUNCTION %Q%s op2=%s",
587                             pExpr->u.zToken, zFlgs, zOp2);
588       }else{
589         sqlite3TreeViewLine(pView, "FUNCTION %Q%s", pExpr->u.zToken, zFlgs);
590       }
591       if( pFarg ){
592         sqlite3TreeViewExprList(pView, pFarg, pWin!=0, 0);
593       }
594 #ifndef SQLITE_OMIT_WINDOWFUNC
595       if( pWin ){
596         sqlite3TreeViewWindow(pView, pWin, 0);
597       }
598 #endif
599       break;
600     }
601 #ifndef SQLITE_OMIT_SUBQUERY
602     case TK_EXISTS: {
603       sqlite3TreeViewLine(pView, "EXISTS-expr flags=0x%x", pExpr->flags);
604       sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
605       break;
606     }
607     case TK_SELECT: {
608       sqlite3TreeViewLine(pView, "SELECT-expr flags=0x%x", pExpr->flags);
609       sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
610       break;
611     }
612     case TK_IN: {
613       sqlite3TreeViewLine(pView, "IN flags=0x%x", pExpr->flags);
614       sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
615       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
616         sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
617       }else{
618         sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
619       }
620       break;
621     }
622 #endif /* SQLITE_OMIT_SUBQUERY */
623 
624     /*
625     **    x BETWEEN y AND z
626     **
627     ** This is equivalent to
628     **
629     **    x>=y AND x<=z
630     **
631     ** X is stored in pExpr->pLeft.
632     ** Y is stored in pExpr->pList->a[0].pExpr.
633     ** Z is stored in pExpr->pList->a[1].pExpr.
634     */
635     case TK_BETWEEN: {
636       Expr *pX = pExpr->pLeft;
637       Expr *pY = pExpr->x.pList->a[0].pExpr;
638       Expr *pZ = pExpr->x.pList->a[1].pExpr;
639       sqlite3TreeViewLine(pView, "BETWEEN");
640       sqlite3TreeViewExpr(pView, pX, 1);
641       sqlite3TreeViewExpr(pView, pY, 1);
642       sqlite3TreeViewExpr(pView, pZ, 0);
643       break;
644     }
645     case TK_TRIGGER: {
646       /* If the opcode is TK_TRIGGER, then the expression is a reference
647       ** to a column in the new.* or old.* pseudo-tables available to
648       ** trigger programs. In this case Expr.iTable is set to 1 for the
649       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
650       ** is set to the column of the pseudo-table to read, or to -1 to
651       ** read the rowid field.
652       */
653       sqlite3TreeViewLine(pView, "%s(%d)",
654           pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
655       break;
656     }
657     case TK_CASE: {
658       sqlite3TreeViewLine(pView, "CASE");
659       sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
660       sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
661       break;
662     }
663 #ifndef SQLITE_OMIT_TRIGGER
664     case TK_RAISE: {
665       const char *zType = "unk";
666       switch( pExpr->affExpr ){
667         case OE_Rollback:   zType = "rollback";  break;
668         case OE_Abort:      zType = "abort";     break;
669         case OE_Fail:       zType = "fail";      break;
670         case OE_Ignore:     zType = "ignore";    break;
671       }
672       sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken);
673       break;
674     }
675 #endif
676     case TK_MATCH: {
677       sqlite3TreeViewLine(pView, "MATCH {%d:%d}%s",
678                           pExpr->iTable, pExpr->iColumn, zFlgs);
679       sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
680       break;
681     }
682     case TK_VECTOR: {
683       char *z = sqlite3_mprintf("VECTOR%s",zFlgs);
684       sqlite3TreeViewBareExprList(pView, pExpr->x.pList, z);
685       sqlite3_free(z);
686       break;
687     }
688     case TK_SELECT_COLUMN: {
689       sqlite3TreeViewLine(pView, "SELECT-COLUMN %d", pExpr->iColumn);
690       sqlite3TreeViewSelect(pView, pExpr->pLeft->x.pSelect, 0);
691       break;
692     }
693     case TK_IF_NULL_ROW: {
694       sqlite3TreeViewLine(pView, "IF-NULL-ROW %d", pExpr->iTable);
695       sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
696       break;
697     }
698     default: {
699       sqlite3TreeViewLine(pView, "op=%d", pExpr->op);
700       break;
701     }
702   }
703   if( zBinOp ){
704     sqlite3TreeViewLine(pView, "%s%s", zBinOp, zFlgs);
705     sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
706     sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
707   }else if( zUniOp ){
708     sqlite3TreeViewLine(pView, "%s%s", zUniOp, zFlgs);
709    sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
710   }
711   sqlite3TreeViewPop(pView);
712 }
713 
714 
715 /*
716 ** Generate a human-readable explanation of an expression list.
717 */
718 void sqlite3TreeViewBareExprList(
719   TreeView *pView,
720   const ExprList *pList,
721   const char *zLabel
722 ){
723   if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
724   if( pList==0 ){
725     sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
726   }else{
727     int i;
728     sqlite3TreeViewLine(pView, "%s", zLabel);
729     for(i=0; i<pList->nExpr; i++){
730       int j = pList->a[i].u.x.iOrderByCol;
731       char *zName = pList->a[i].zEName;
732       int moreToFollow = i<pList->nExpr - 1;
733       if( pList->a[i].eEName!=ENAME_NAME ) zName = 0;
734       if( j || zName ){
735         sqlite3TreeViewPush(pView, moreToFollow);
736         moreToFollow = 0;
737         sqlite3TreeViewLine(pView, 0);
738         if( zName ){
739           fprintf(stdout, "AS %s ", zName);
740         }
741         if( j ){
742           fprintf(stdout, "iOrderByCol=%d", j);
743         }
744         fprintf(stdout, "\n");
745         fflush(stdout);
746       }
747       sqlite3TreeViewExpr(pView, pList->a[i].pExpr, moreToFollow);
748       if( j || zName ){
749         sqlite3TreeViewPop(pView);
750       }
751     }
752   }
753 }
754 void sqlite3TreeViewExprList(
755   TreeView *pView,
756   const ExprList *pList,
757   u8 moreToFollow,
758   const char *zLabel
759 ){
760   pView = sqlite3TreeViewPush(pView, moreToFollow);
761   sqlite3TreeViewBareExprList(pView, pList, zLabel);
762   sqlite3TreeViewPop(pView);
763 }
764 
765 #endif /* SQLITE_DEBUG */
766