The ".selecttrace 0x2000" command causes just the top-level parse tree to
[sqlite.git] / src / treeview.c
blobd3b7ea936f1c6efb0b1bc53adeabd141d9ae9e1d
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.
11 *************************************************************************
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.
17 ** The interfaces in this file is only available when compiling
18 ** with SQLITE_DEBUG.
20 #include "sqliteInt.h"
21 #ifdef SQLITE_DEBUG
24 ** Add a new subitem to the tree. The moreToFollow flag indicates that this
25 ** is not the last item in the tree.
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++;
35 assert( moreToFollow==0 || moreToFollow==1 );
36 if( p->iLevel<sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow;
37 return p;
41 ** Finished with one layer of the tree
43 static void sqlite3TreeViewPop(TreeView *p){
44 if( p==0 ) return;
45 p->iLevel--;
46 if( p->iLevel<0 ) sqlite3_free(p);
50 ** Generate a single line of output for the tree, with a prefix that contains
51 ** all the appropriate tree lines
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 sqlite3StrAccumAppend(&acc, p->bLine[i] ? "| " : " ", 4);
63 sqlite3StrAccumAppend(&acc, p->bLine[i] ? "|-- " : "'-- ", 4);
65 va_start(ap, zFormat);
66 sqlite3VXPrintf(&acc, zFormat, ap);
67 va_end(ap);
68 assert( acc.nChar>0 );
69 if( zBuf[acc.nChar-1]!='\n' ) sqlite3StrAccumAppend(&acc, "\n", 1);
70 sqlite3StrAccumFinish(&acc);
71 fprintf(stdout,"%s", zBuf);
72 fflush(stdout);
76 ** Shorthand for starting a new tree item that consists of a single label
78 static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){
79 p = sqlite3TreeViewPush(p, moreFollows);
80 sqlite3TreeViewLine(p, "%s", zLabel);
84 ** Generate a human-readable description of a WITH clause.
86 void sqlite3TreeViewWith(TreeView *pView, const With *pWith, u8 moreToFollow){
87 int i;
88 if( pWith==0 ) return;
89 if( pWith->nCte==0 ) return;
90 if( pWith->pOuter ){
91 sqlite3TreeViewLine(pView, "WITH (0x%p, pOuter=0x%p)",pWith,pWith->pOuter);
92 }else{
93 sqlite3TreeViewLine(pView, "WITH (0x%p)", pWith);
95 if( pWith->nCte>0 ){
96 pView = sqlite3TreeViewPush(pView, 1);
97 for(i=0; i<pWith->nCte; i++){
98 StrAccum x;
99 char zLine[1000];
100 const struct Cte *pCte = &pWith->a[i];
101 sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
102 sqlite3XPrintf(&x, "%s", pCte->zName);
103 if( pCte->pCols && pCte->pCols->nExpr>0 ){
104 char cSep = '(';
105 int j;
106 for(j=0; j<pCte->pCols->nExpr; j++){
107 sqlite3XPrintf(&x, "%c%s", cSep, pCte->pCols->a[j].zName);
108 cSep = ',';
110 sqlite3XPrintf(&x, ")");
112 sqlite3XPrintf(&x, " AS");
113 sqlite3StrAccumFinish(&x);
114 sqlite3TreeViewItem(pView, zLine, i<pWith->nCte-1);
115 sqlite3TreeViewSelect(pView, pCte->pSelect, 0);
116 sqlite3TreeViewPop(pView);
118 sqlite3TreeViewPop(pView);
124 ** Generate a human-readable description of a Select object.
126 void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
127 int n = 0;
128 int cnt = 0;
129 if( p==0 ){
130 sqlite3TreeViewLine(pView, "nil-SELECT");
131 return;
133 pView = sqlite3TreeViewPush(pView, moreToFollow);
134 if( p->pWith ){
135 sqlite3TreeViewWith(pView, p->pWith, 1);
136 cnt = 1;
137 sqlite3TreeViewPush(pView, 1);
140 #if SELECTTRACE_ENABLED
141 sqlite3TreeViewLine(pView,
142 "SELECT%s%s (%s/%d/%p) selFlags=0x%x nSelectRow=%d",
143 ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
144 ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""),
145 p->zSelName, p->iSelectId, p, p->selFlags,
146 (int)p->nSelectRow
148 #else
149 sqlite3TreeViewLine(pView, "SELECT%s%s (0x%p) selFlags=0x%x nSelectRow=%d",
150 ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
151 ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""), p, p->selFlags,
152 (int)p->nSelectRow
154 #endif
155 if( cnt++ ) sqlite3TreeViewPop(pView);
156 if( p->pPrior ){
157 n = 1000;
158 }else{
159 n = 0;
160 if( p->pSrc && p->pSrc->nSrc ) n++;
161 if( p->pWhere ) n++;
162 if( p->pGroupBy ) n++;
163 if( p->pHaving ) n++;
164 if( p->pOrderBy ) n++;
165 if( p->pLimit ) n++;
167 sqlite3TreeViewExprList(pView, p->pEList, (n--)>0, "result-set");
168 if( p->pSrc && p->pSrc->nSrc ){
169 int i;
170 pView = sqlite3TreeViewPush(pView, (n--)>0);
171 sqlite3TreeViewLine(pView, "FROM");
172 for(i=0; i<p->pSrc->nSrc; i++){
173 struct SrcList_item *pItem = &p->pSrc->a[i];
174 StrAccum x;
175 char zLine[100];
176 sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
177 sqlite3XPrintf(&x, "{%d,*}", pItem->iCursor);
178 if( pItem->zDatabase ){
179 sqlite3XPrintf(&x, " %s.%s", pItem->zDatabase, pItem->zName);
180 }else if( pItem->zName ){
181 sqlite3XPrintf(&x, " %s", pItem->zName);
183 if( pItem->pTab ){
184 sqlite3XPrintf(&x, " tabname=%Q", pItem->pTab->zName);
186 if( pItem->zAlias ){
187 sqlite3XPrintf(&x, " (AS %s)", pItem->zAlias);
189 if( pItem->fg.jointype & JT_LEFT ){
190 sqlite3XPrintf(&x, " LEFT-JOIN");
192 sqlite3StrAccumFinish(&x);
193 sqlite3TreeViewItem(pView, zLine, i<p->pSrc->nSrc-1);
194 if( pItem->pSelect ){
195 sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
197 if( pItem->fg.isTabFunc ){
198 sqlite3TreeViewExprList(pView, pItem->u1.pFuncArg, 0, "func-args:");
200 sqlite3TreeViewPop(pView);
202 sqlite3TreeViewPop(pView);
204 if( p->pWhere ){
205 sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
206 sqlite3TreeViewExpr(pView, p->pWhere, 0);
207 sqlite3TreeViewPop(pView);
209 if( p->pGroupBy ){
210 sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
212 if( p->pHaving ){
213 sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
214 sqlite3TreeViewExpr(pView, p->pHaving, 0);
215 sqlite3TreeViewPop(pView);
217 if( p->pOrderBy ){
218 sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
220 if( p->pLimit ){
221 sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
222 sqlite3TreeViewExpr(pView, p->pLimit->pLeft, p->pLimit->pRight!=0);
223 if( p->pLimit->pRight ){
224 sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
225 sqlite3TreeViewExpr(pView, p->pLimit->pRight, 0);
226 sqlite3TreeViewPop(pView);
228 sqlite3TreeViewPop(pView);
230 if( p->pPrior ){
231 const char *zOp = "UNION";
232 switch( p->op ){
233 case TK_ALL: zOp = "UNION ALL"; break;
234 case TK_INTERSECT: zOp = "INTERSECT"; break;
235 case TK_EXCEPT: zOp = "EXCEPT"; break;
237 sqlite3TreeViewItem(pView, zOp, 1);
239 p = p->pPrior;
240 }while( p!=0 );
241 sqlite3TreeViewPop(pView);
245 ** Generate a human-readable explanation of an expression tree.
247 void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){
248 const char *zBinOp = 0; /* Binary operator */
249 const char *zUniOp = 0; /* Unary operator */
250 char zFlgs[60];
251 pView = sqlite3TreeViewPush(pView, moreToFollow);
252 if( pExpr==0 ){
253 sqlite3TreeViewLine(pView, "nil");
254 sqlite3TreeViewPop(pView);
255 return;
257 if( pExpr->flags ){
258 if( ExprHasProperty(pExpr, EP_FromJoin) ){
259 sqlite3_snprintf(sizeof(zFlgs),zFlgs," flags=0x%x iRJT=%d",
260 pExpr->flags, pExpr->iRightJoinTable);
261 }else{
262 sqlite3_snprintf(sizeof(zFlgs),zFlgs," flags=0x%x",pExpr->flags);
264 }else{
265 zFlgs[0] = 0;
267 switch( pExpr->op ){
268 case TK_AGG_COLUMN: {
269 sqlite3TreeViewLine(pView, "AGG{%d:%d}%s",
270 pExpr->iTable, pExpr->iColumn, zFlgs);
271 break;
273 case TK_COLUMN: {
274 if( pExpr->iTable<0 ){
275 /* This only happens when coding check constraints */
276 sqlite3TreeViewLine(pView, "COLUMN(%d)%s", pExpr->iColumn, zFlgs);
277 }else{
278 sqlite3TreeViewLine(pView, "{%d:%d}%s",
279 pExpr->iTable, pExpr->iColumn, zFlgs);
281 break;
283 case TK_INTEGER: {
284 if( pExpr->flags & EP_IntValue ){
285 sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue);
286 }else{
287 sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken);
289 break;
291 #ifndef SQLITE_OMIT_FLOATING_POINT
292 case TK_FLOAT: {
293 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
294 break;
296 #endif
297 case TK_STRING: {
298 sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken);
299 break;
301 case TK_NULL: {
302 sqlite3TreeViewLine(pView,"NULL");
303 break;
305 case TK_TRUEFALSE: {
306 sqlite3TreeViewLine(pView,
307 sqlite3ExprTruthValue(pExpr) ? "TRUE" : "FALSE");
308 break;
310 #ifndef SQLITE_OMIT_BLOB_LITERAL
311 case TK_BLOB: {
312 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
313 break;
315 #endif
316 case TK_VARIABLE: {
317 sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)",
318 pExpr->u.zToken, pExpr->iColumn);
319 break;
321 case TK_REGISTER: {
322 sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable);
323 break;
325 case TK_ID: {
326 sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken);
327 break;
329 #ifndef SQLITE_OMIT_CAST
330 case TK_CAST: {
331 /* Expressions of the form: CAST(pLeft AS token) */
332 sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken);
333 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
334 break;
336 #endif /* SQLITE_OMIT_CAST */
337 case TK_LT: zBinOp = "LT"; break;
338 case TK_LE: zBinOp = "LE"; break;
339 case TK_GT: zBinOp = "GT"; break;
340 case TK_GE: zBinOp = "GE"; break;
341 case TK_NE: zBinOp = "NE"; break;
342 case TK_EQ: zBinOp = "EQ"; break;
343 case TK_IS: zBinOp = "IS"; break;
344 case TK_ISNOT: zBinOp = "ISNOT"; break;
345 case TK_AND: zBinOp = "AND"; break;
346 case TK_OR: zBinOp = "OR"; break;
347 case TK_PLUS: zBinOp = "ADD"; break;
348 case TK_STAR: zBinOp = "MUL"; break;
349 case TK_MINUS: zBinOp = "SUB"; break;
350 case TK_REM: zBinOp = "REM"; break;
351 case TK_BITAND: zBinOp = "BITAND"; break;
352 case TK_BITOR: zBinOp = "BITOR"; break;
353 case TK_SLASH: zBinOp = "DIV"; break;
354 case TK_LSHIFT: zBinOp = "LSHIFT"; break;
355 case TK_RSHIFT: zBinOp = "RSHIFT"; break;
356 case TK_CONCAT: zBinOp = "CONCAT"; break;
357 case TK_DOT: zBinOp = "DOT"; break;
359 case TK_UMINUS: zUniOp = "UMINUS"; break;
360 case TK_UPLUS: zUniOp = "UPLUS"; break;
361 case TK_BITNOT: zUniOp = "BITNOT"; break;
362 case TK_NOT: zUniOp = "NOT"; break;
363 case TK_ISNULL: zUniOp = "ISNULL"; break;
364 case TK_NOTNULL: zUniOp = "NOTNULL"; break;
366 case TK_TRUTH: {
367 int x;
368 const char *azOp[] = {
369 "IS-FALSE", "IS-TRUE", "IS-NOT-FALSE", "IS-NOT-TRUE"
371 assert( pExpr->op2==TK_IS || pExpr->op2==TK_ISNOT );
372 assert( pExpr->pRight );
373 assert( pExpr->pRight->op==TK_TRUEFALSE );
374 x = (pExpr->op2==TK_ISNOT)*2 + sqlite3ExprTruthValue(pExpr->pRight);
375 zUniOp = azOp[x];
376 break;
379 case TK_SPAN: {
380 sqlite3TreeViewLine(pView, "SPAN %Q", pExpr->u.zToken);
381 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
382 break;
385 case TK_COLLATE: {
386 sqlite3TreeViewLine(pView, "COLLATE %Q", pExpr->u.zToken);
387 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
388 break;
391 case TK_AGG_FUNCTION:
392 case TK_FUNCTION: {
393 ExprList *pFarg; /* List of function arguments */
394 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
395 pFarg = 0;
396 }else{
397 pFarg = pExpr->x.pList;
399 if( pExpr->op==TK_AGG_FUNCTION ){
400 sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q",
401 pExpr->op2, pExpr->u.zToken);
402 }else{
403 sqlite3TreeViewLine(pView, "FUNCTION %Q", pExpr->u.zToken);
405 if( pFarg ){
406 sqlite3TreeViewExprList(pView, pFarg, 0, 0);
408 break;
410 #ifndef SQLITE_OMIT_SUBQUERY
411 case TK_EXISTS: {
412 sqlite3TreeViewLine(pView, "EXISTS-expr flags=0x%x", pExpr->flags);
413 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
414 break;
416 case TK_SELECT: {
417 sqlite3TreeViewLine(pView, "SELECT-expr flags=0x%x", pExpr->flags);
418 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
419 break;
421 case TK_IN: {
422 sqlite3TreeViewLine(pView, "IN flags=0x%x", pExpr->flags);
423 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
424 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
425 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
426 }else{
427 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
429 break;
431 #endif /* SQLITE_OMIT_SUBQUERY */
434 ** x BETWEEN y AND z
436 ** This is equivalent to
438 ** x>=y AND x<=z
440 ** X is stored in pExpr->pLeft.
441 ** Y is stored in pExpr->pList->a[0].pExpr.
442 ** Z is stored in pExpr->pList->a[1].pExpr.
444 case TK_BETWEEN: {
445 Expr *pX = pExpr->pLeft;
446 Expr *pY = pExpr->x.pList->a[0].pExpr;
447 Expr *pZ = pExpr->x.pList->a[1].pExpr;
448 sqlite3TreeViewLine(pView, "BETWEEN");
449 sqlite3TreeViewExpr(pView, pX, 1);
450 sqlite3TreeViewExpr(pView, pY, 1);
451 sqlite3TreeViewExpr(pView, pZ, 0);
452 break;
454 case TK_TRIGGER: {
455 /* If the opcode is TK_TRIGGER, then the expression is a reference
456 ** to a column in the new.* or old.* pseudo-tables available to
457 ** trigger programs. In this case Expr.iTable is set to 1 for the
458 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
459 ** is set to the column of the pseudo-table to read, or to -1 to
460 ** read the rowid field.
462 sqlite3TreeViewLine(pView, "%s(%d)",
463 pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
464 break;
466 case TK_CASE: {
467 sqlite3TreeViewLine(pView, "CASE");
468 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
469 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
470 break;
472 #ifndef SQLITE_OMIT_TRIGGER
473 case TK_RAISE: {
474 const char *zType = "unk";
475 switch( pExpr->affinity ){
476 case OE_Rollback: zType = "rollback"; break;
477 case OE_Abort: zType = "abort"; break;
478 case OE_Fail: zType = "fail"; break;
479 case OE_Ignore: zType = "ignore"; break;
481 sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken);
482 break;
484 #endif
485 case TK_MATCH: {
486 sqlite3TreeViewLine(pView, "MATCH {%d:%d}%s",
487 pExpr->iTable, pExpr->iColumn, zFlgs);
488 sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
489 break;
491 case TK_VECTOR: {
492 sqlite3TreeViewBareExprList(pView, pExpr->x.pList, "VECTOR");
493 break;
495 case TK_SELECT_COLUMN: {
496 sqlite3TreeViewLine(pView, "SELECT-COLUMN %d", pExpr->iColumn);
497 sqlite3TreeViewSelect(pView, pExpr->pLeft->x.pSelect, 0);
498 break;
500 case TK_IF_NULL_ROW: {
501 sqlite3TreeViewLine(pView, "IF-NULL-ROW %d", pExpr->iTable);
502 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
503 break;
505 default: {
506 sqlite3TreeViewLine(pView, "op=%d", pExpr->op);
507 break;
510 if( zBinOp ){
511 sqlite3TreeViewLine(pView, "%s%s", zBinOp, zFlgs);
512 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
513 sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
514 }else if( zUniOp ){
515 sqlite3TreeViewLine(pView, "%s%s", zUniOp, zFlgs);
516 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
518 sqlite3TreeViewPop(pView);
523 ** Generate a human-readable explanation of an expression list.
525 void sqlite3TreeViewBareExprList(
526 TreeView *pView,
527 const ExprList *pList,
528 const char *zLabel
530 if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
531 if( pList==0 ){
532 sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
533 }else{
534 int i;
535 sqlite3TreeViewLine(pView, "%s", zLabel);
536 for(i=0; i<pList->nExpr; i++){
537 int j = pList->a[i].u.x.iOrderByCol;
538 char *zName = pList->a[i].zName;
539 if( j || zName ){
540 sqlite3TreeViewPush(pView, 0);
542 if( zName ){
543 sqlite3TreeViewLine(pView, "AS %s", zName);
545 if( j ){
546 sqlite3TreeViewLine(pView, "iOrderByCol=%d", j);
548 sqlite3TreeViewExpr(pView, pList->a[i].pExpr, i<pList->nExpr-1);
549 if( j || zName ){
550 sqlite3TreeViewPop(pView);
555 void sqlite3TreeViewExprList(
556 TreeView *pView,
557 const ExprList *pList,
558 u8 moreToFollow,
559 const char *zLabel
561 pView = sqlite3TreeViewPush(pView, moreToFollow);
562 sqlite3TreeViewBareExprList(pView, pList, zLabel);
563 sqlite3TreeViewPop(pView);
566 #endif /* SQLITE_DEBUG */