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