blob: b696d764e02d9fe510752e43d004b4bffa998e6f [file] [log] [blame]
drh38b41492015-06-08 15:08:15 +00001/*
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*/
27static 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*/
43static 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*/
53static 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++){
drh0cdbe1a2018-05-09 13:46:26 +000061 sqlite3_str_append(&acc, p->bLine[i] ? "| " : " ", 4);
drh38b41492015-06-08 15:08:15 +000062 }
drh0cdbe1a2018-05-09 13:46:26 +000063 sqlite3_str_append(&acc, p->bLine[i] ? "|-- " : "'-- ", 4);
drh38b41492015-06-08 15:08:15 +000064 }
drhfbe07532018-04-23 20:04:38 +000065 if( zFormat!=0 ){
66 va_start(ap, zFormat);
drh0cdbe1a2018-05-09 13:46:26 +000067 sqlite3_str_vappendf(&acc, zFormat, ap);
drhfbe07532018-04-23 20:04:38 +000068 va_end(ap);
drh10c0e712019-04-25 18:15:38 +000069 assert( acc.nChar>0 || acc.accError );
drh0cdbe1a2018-05-09 13:46:26 +000070 sqlite3_str_append(&acc, "\n", 1);
drhfbe07532018-04-23 20:04:38 +000071 }
drh38b41492015-06-08 15:08:15 +000072 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*/
80static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){
81 p = sqlite3TreeViewPush(p, moreFollows);
82 sqlite3TreeViewLine(p, "%s", zLabel);
83}
84
drh2476a6f2015-11-07 15:19:59 +000085/*
86** Generate a human-readable description of a WITH clause.
87*/
88void 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);
drh0cdbe1a2018-05-09 13:46:26 +0000104 sqlite3_str_appendf(&x, "%s", pCte->zName);
drh2476a6f2015-11-07 15:19:59 +0000105 if( pCte->pCols && pCte->pCols->nExpr>0 ){
106 char cSep = '(';
107 int j;
108 for(j=0; j<pCte->pCols->nExpr; j++){
drh41cee662019-12-12 20:22:34 +0000109 sqlite3_str_appendf(&x, "%c%s", cSep, pCte->pCols->a[j].zEName);
drh2476a6f2015-11-07 15:19:59 +0000110 cSep = ',';
111 }
drh0cdbe1a2018-05-09 13:46:26 +0000112 sqlite3_str_appendf(&x, ")");
drh2476a6f2015-11-07 15:19:59 +0000113 }
drha79e2a22021-02-21 23:44:14 +0000114 if( pCte->pUse ){
115 sqlite3_str_appendf(&x, " (pUse=0x%p, nUse=%d)", pCte->pUse,
116 pCte->pUse->nUse);
117 }
drh2476a6f2015-11-07 15:19:59 +0000118 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
drh145d0a32018-11-08 22:53:06 +0000127/*
128** Generate a human-readable description of a SrcList object.
129*/
130void sqlite3TreeViewSrcList(TreeView *pView, const SrcList *pSrc){
131 int i;
132 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +0000133 const SrcItem *pItem = &pSrc->a[i];
drh145d0a32018-11-08 22:53:06 +0000134 StrAccum x;
135 char zLine[100];
136 sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
drhdbf1c4b2019-11-13 16:50:06 +0000137 sqlite3_str_appendf(&x, "{%d:*}", pItem->iCursor);
drh145d0a32018-11-08 22:53:06 +0000138 if( pItem->zDatabase ){
139 sqlite3_str_appendf(&x, " %s.%s", pItem->zDatabase, pItem->zName);
140 }else if( pItem->zName ){
141 sqlite3_str_appendf(&x, " %s", pItem->zName);
142 }
143 if( pItem->pTab ){
drhf7f6dbf2020-03-21 22:03:32 +0000144 sqlite3_str_appendf(&x, " tab=%Q nCol=%d ptr=%p used=%llx",
145 pItem->pTab->zName, pItem->pTab->nCol, pItem->pTab, pItem->colUsed);
drh145d0a32018-11-08 22:53:06 +0000146 }
147 if( pItem->zAlias ){
148 sqlite3_str_appendf(&x, " (AS %s)", pItem->zAlias);
149 }
150 if( pItem->fg.jointype & JT_LEFT ){
151 sqlite3_str_appendf(&x, " LEFT-JOIN");
152 }
drhb7e51992020-01-08 14:39:57 +0000153 if( pItem->fg.fromDDL ){
154 sqlite3_str_appendf(&x, " DDL");
155 }
drha79e2a22021-02-21 23:44:14 +0000156 if( pItem->fg.isCte ){
157 sqlite3_str_appendf(&x, " CteUse=0x%p", pItem->u2.pCteUse);
158 }
drh145d0a32018-11-08 22:53:06 +0000159 sqlite3StrAccumFinish(&x);
160 sqlite3TreeViewItem(pView, zLine, i<pSrc->nSrc-1);
161 if( pItem->pSelect ){
162 sqlite3TreeViewSelect(pView, pItem->pSelect, 0);
163 }
164 if( pItem->fg.isTabFunc ){
165 sqlite3TreeViewExprList(pView, pItem->u1.pFuncArg, 0, "func-args:");
166 }
167 sqlite3TreeViewPop(pView);
168 }
169}
drh38b41492015-06-08 15:08:15 +0000170
171/*
drh2e5c5052016-08-27 20:21:51 +0000172** Generate a human-readable description of a Select object.
drh38b41492015-06-08 15:08:15 +0000173*/
174void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
175 int n = 0;
drh1c4505d2015-08-26 11:34:31 +0000176 int cnt = 0;
drh510b7ff2017-03-13 17:37:13 +0000177 if( p==0 ){
178 sqlite3TreeViewLine(pView, "nil-SELECT");
179 return;
180 }
drh38b41492015-06-08 15:08:15 +0000181 pView = sqlite3TreeViewPush(pView, moreToFollow);
drh2476a6f2015-11-07 15:19:59 +0000182 if( p->pWith ){
183 sqlite3TreeViewWith(pView, p->pWith, 1);
184 cnt = 1;
185 sqlite3TreeViewPush(pView, 1);
186 }
drh1c4505d2015-08-26 11:34:31 +0000187 do{
drh55b4c822019-08-03 16:17:46 +0000188 if( p->selFlags & SF_WhereBegin ){
189 sqlite3TreeViewLine(pView, "sqlite3WhereBegin()");
190 }else{
191 sqlite3TreeViewLine(pView,
192 "SELECT%s%s (%u/%p) selFlags=0x%x nSelectRow=%d",
193 ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
194 ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""),
195 p->selId, p, p->selFlags,
196 (int)p->nSelectRow
197 );
198 }
drh1c4505d2015-08-26 11:34:31 +0000199 if( cnt++ ) sqlite3TreeViewPop(pView);
200 if( p->pPrior ){
201 n = 1000;
202 }else{
203 n = 0;
204 if( p->pSrc && p->pSrc->nSrc ) n++;
205 if( p->pWhere ) n++;
206 if( p->pGroupBy ) n++;
207 if( p->pHaving ) n++;
208 if( p->pOrderBy ) n++;
209 if( p->pLimit ) n++;
drha1fd4b52018-07-10 06:32:53 +0000210#ifndef SQLITE_OMIT_WINDOWFUNC
211 if( p->pWin ) n++;
212 if( p->pWinDefn ) n++;
213#endif
drh1c4505d2015-08-26 11:34:31 +0000214 }
drh55b4c822019-08-03 16:17:46 +0000215 if( p->pEList ){
216 sqlite3TreeViewExprList(pView, p->pEList, n>0, "result-set");
217 }
218 n--;
drha1fd4b52018-07-10 06:32:53 +0000219#ifndef SQLITE_OMIT_WINDOWFUNC
220 if( p->pWin ){
221 Window *pX;
222 pView = sqlite3TreeViewPush(pView, (n--)>0);
223 sqlite3TreeViewLine(pView, "window-functions");
224 for(pX=p->pWin; pX; pX=pX->pNextWin){
225 sqlite3TreeViewWinFunc(pView, pX, pX->pNextWin!=0);
226 }
227 sqlite3TreeViewPop(pView);
228 }
229#endif
drh1c4505d2015-08-26 11:34:31 +0000230 if( p->pSrc && p->pSrc->nSrc ){
drh1c4505d2015-08-26 11:34:31 +0000231 pView = sqlite3TreeViewPush(pView, (n--)>0);
232 sqlite3TreeViewLine(pView, "FROM");
drh145d0a32018-11-08 22:53:06 +0000233 sqlite3TreeViewSrcList(pView, p->pSrc);
drh38b41492015-06-08 15:08:15 +0000234 sqlite3TreeViewPop(pView);
235 }
drh1c4505d2015-08-26 11:34:31 +0000236 if( p->pWhere ){
237 sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
238 sqlite3TreeViewExpr(pView, p->pWhere, 0);
239 sqlite3TreeViewPop(pView);
drh38b41492015-06-08 15:08:15 +0000240 }
drh1c4505d2015-08-26 11:34:31 +0000241 if( p->pGroupBy ){
242 sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
243 }
244 if( p->pHaving ){
245 sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
246 sqlite3TreeViewExpr(pView, p->pHaving, 0);
247 sqlite3TreeViewPop(pView);
248 }
drha1fd4b52018-07-10 06:32:53 +0000249#ifndef SQLITE_OMIT_WINDOWFUNC
250 if( p->pWinDefn ){
251 Window *pX;
252 sqlite3TreeViewItem(pView, "WINDOW", (n--)>0);
253 for(pX=p->pWinDefn; pX; pX=pX->pNextWin){
254 sqlite3TreeViewWindow(pView, pX, pX->pNextWin!=0);
255 }
256 sqlite3TreeViewPop(pView);
257 }
258#endif
drh1c4505d2015-08-26 11:34:31 +0000259 if( p->pOrderBy ){
260 sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
261 }
262 if( p->pLimit ){
263 sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
drh8c0833f2017-11-14 23:48:23 +0000264 sqlite3TreeViewExpr(pView, p->pLimit->pLeft, p->pLimit->pRight!=0);
265 if( p->pLimit->pRight ){
266 sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
267 sqlite3TreeViewExpr(pView, p->pLimit->pRight, 0);
268 sqlite3TreeViewPop(pView);
269 }
drh1c4505d2015-08-26 11:34:31 +0000270 sqlite3TreeViewPop(pView);
271 }
272 if( p->pPrior ){
273 const char *zOp = "UNION";
274 switch( p->op ){
275 case TK_ALL: zOp = "UNION ALL"; break;
276 case TK_INTERSECT: zOp = "INTERSECT"; break;
277 case TK_EXCEPT: zOp = "EXCEPT"; break;
278 }
279 sqlite3TreeViewItem(pView, zOp, 1);
280 }
281 p = p->pPrior;
282 }while( p!=0 );
drh38b41492015-06-08 15:08:15 +0000283 sqlite3TreeViewPop(pView);
284}
285
drha1fd4b52018-07-10 06:32:53 +0000286#ifndef SQLITE_OMIT_WINDOWFUNC
287/*
288** Generate a description of starting or stopping bounds
289*/
290void sqlite3TreeViewBound(
291 TreeView *pView, /* View context */
292 u8 eBound, /* UNBOUNDED, CURRENT, PRECEDING, FOLLOWING */
293 Expr *pExpr, /* Value for PRECEDING or FOLLOWING */
294 u8 moreToFollow /* True if more to follow */
295){
296 switch( eBound ){
297 case TK_UNBOUNDED: {
298 sqlite3TreeViewItem(pView, "UNBOUNDED", moreToFollow);
299 sqlite3TreeViewPop(pView);
300 break;
301 }
302 case TK_CURRENT: {
303 sqlite3TreeViewItem(pView, "CURRENT", moreToFollow);
304 sqlite3TreeViewPop(pView);
305 break;
306 }
307 case TK_PRECEDING: {
308 sqlite3TreeViewItem(pView, "PRECEDING", moreToFollow);
309 sqlite3TreeViewExpr(pView, pExpr, 0);
310 sqlite3TreeViewPop(pView);
311 break;
312 }
313 case TK_FOLLOWING: {
314 sqlite3TreeViewItem(pView, "FOLLOWING", moreToFollow);
315 sqlite3TreeViewExpr(pView, pExpr, 0);
316 sqlite3TreeViewPop(pView);
317 break;
318 }
319 }
320}
321#endif /* SQLITE_OMIT_WINDOWFUNC */
322
323#ifndef SQLITE_OMIT_WINDOWFUNC
324/*
325** Generate a human-readable explanation for a Window object
326*/
327void sqlite3TreeViewWindow(TreeView *pView, const Window *pWin, u8 more){
drhfc15f4c2019-03-28 13:03:41 +0000328 int nElement = 0;
drh0dc0e9c2019-03-28 13:35:28 +0000329 if( pWin->pFilter ){
330 sqlite3TreeViewItem(pView, "FILTER", 1);
331 sqlite3TreeViewExpr(pView, pWin->pFilter, 0);
332 sqlite3TreeViewPop(pView);
333 }
drha1fd4b52018-07-10 06:32:53 +0000334 pView = sqlite3TreeViewPush(pView, more);
335 if( pWin->zName ){
drh6f1644c2019-03-28 13:53:12 +0000336 sqlite3TreeViewLine(pView, "OVER %s (%p)", pWin->zName, pWin);
drha1fd4b52018-07-10 06:32:53 +0000337 }else{
drh6f1644c2019-03-28 13:53:12 +0000338 sqlite3TreeViewLine(pView, "OVER (%p)", pWin);
drha1fd4b52018-07-10 06:32:53 +0000339 }
drhfc15f4c2019-03-28 13:03:41 +0000340 if( pWin->zBase ) nElement++;
341 if( pWin->pOrderBy ) nElement++;
342 if( pWin->eFrmType ) nElement++;
343 if( pWin->eExclude ) nElement++;
drhfc15f4c2019-03-28 13:03:41 +0000344 if( pWin->zBase ){
345 sqlite3TreeViewPush(pView, (--nElement)>0);
346 sqlite3TreeViewLine(pView, "window: %s", pWin->zBase);
347 sqlite3TreeViewPop(pView);
348 }
drha1fd4b52018-07-10 06:32:53 +0000349 if( pWin->pPartition ){
drhfc15f4c2019-03-28 13:03:41 +0000350 sqlite3TreeViewExprList(pView, pWin->pPartition, nElement>0,"PARTITION-BY");
drha1fd4b52018-07-10 06:32:53 +0000351 }
352 if( pWin->pOrderBy ){
drhfc15f4c2019-03-28 13:03:41 +0000353 sqlite3TreeViewExprList(pView, pWin->pOrderBy, (--nElement)>0, "ORDER-BY");
drha1fd4b52018-07-10 06:32:53 +0000354 }
drhfc15f4c2019-03-28 13:03:41 +0000355 if( pWin->eFrmType ){
drh0dc0e9c2019-03-28 13:35:28 +0000356 char zBuf[30];
drhfc15f4c2019-03-28 13:03:41 +0000357 const char *zFrmType = "ROWS";
358 if( pWin->eFrmType==TK_RANGE ) zFrmType = "RANGE";
359 if( pWin->eFrmType==TK_GROUPS ) zFrmType = "GROUPS";
drh0dc0e9c2019-03-28 13:35:28 +0000360 sqlite3_snprintf(sizeof(zBuf),zBuf,"%s%s",zFrmType,
361 pWin->bImplicitFrame ? " (implied)" : "");
362 sqlite3TreeViewItem(pView, zBuf, (--nElement)>0);
drha1fd4b52018-07-10 06:32:53 +0000363 sqlite3TreeViewBound(pView, pWin->eStart, pWin->pStart, 1);
364 sqlite3TreeViewBound(pView, pWin->eEnd, pWin->pEnd, 0);
365 sqlite3TreeViewPop(pView);
366 }
drhfc15f4c2019-03-28 13:03:41 +0000367 if( pWin->eExclude ){
368 char zBuf[30];
369 const char *zExclude;
370 switch( pWin->eExclude ){
371 case TK_NO: zExclude = "NO OTHERS"; break;
372 case TK_CURRENT: zExclude = "CURRENT ROW"; break;
373 case TK_GROUP: zExclude = "GROUP"; break;
374 case TK_TIES: zExclude = "TIES"; break;
375 default:
376 sqlite3_snprintf(sizeof(zBuf),zBuf,"invalid(%d)", pWin->eExclude);
377 zExclude = zBuf;
378 break;
379 }
380 sqlite3TreeViewPush(pView, 0);
381 sqlite3TreeViewLine(pView, "EXCLUDE %s", zExclude);
382 sqlite3TreeViewPop(pView);
383 }
drha1fd4b52018-07-10 06:32:53 +0000384 sqlite3TreeViewPop(pView);
385}
386#endif /* SQLITE_OMIT_WINDOWFUNC */
387
388#ifndef SQLITE_OMIT_WINDOWFUNC
389/*
390** Generate a human-readable explanation for a Window Function object
391*/
392void sqlite3TreeViewWinFunc(TreeView *pView, const Window *pWin, u8 more){
393 pView = sqlite3TreeViewPush(pView, more);
394 sqlite3TreeViewLine(pView, "WINFUNC %s(%d)",
395 pWin->pFunc->zName, pWin->pFunc->nArg);
396 sqlite3TreeViewWindow(pView, pWin, 0);
397 sqlite3TreeViewPop(pView);
398}
399#endif /* SQLITE_OMIT_WINDOWFUNC */
400
drh38b41492015-06-08 15:08:15 +0000401/*
402** Generate a human-readable explanation of an expression tree.
403*/
404void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){
405 const char *zBinOp = 0; /* Binary operator */
406 const char *zUniOp = 0; /* Unary operator */
drhe7375bf2020-03-10 19:24:38 +0000407 char zFlgs[200];
drh38b41492015-06-08 15:08:15 +0000408 pView = sqlite3TreeViewPush(pView, moreToFollow);
409 if( pExpr==0 ){
410 sqlite3TreeViewLine(pView, "nil");
411 sqlite3TreeViewPop(pView);
412 return;
413 }
drhe7375bf2020-03-10 19:24:38 +0000414 if( pExpr->flags || pExpr->affExpr || pExpr->vvaFlags ){
drhb7e51992020-01-08 14:39:57 +0000415 StrAccum x;
416 sqlite3StrAccumInit(&x, 0, zFlgs, sizeof(zFlgs), 0);
417 sqlite3_str_appendf(&x, " fg.af=%x.%c",
418 pExpr->flags, pExpr->affExpr ? pExpr->affExpr : 'n');
drhd97cda42017-04-14 14:02:14 +0000419 if( ExprHasProperty(pExpr, EP_FromJoin) ){
drhb7e51992020-01-08 14:39:57 +0000420 sqlite3_str_appendf(&x, " iRJT=%d", pExpr->iRightJoinTable);
drhd97cda42017-04-14 14:02:14 +0000421 }
drhb7e51992020-01-08 14:39:57 +0000422 if( ExprHasProperty(pExpr, EP_FromDDL) ){
423 sqlite3_str_appendf(&x, " DDL");
424 }
drhe7375bf2020-03-10 19:24:38 +0000425 if( ExprHasVVAProperty(pExpr, EP_Immutable) ){
426 sqlite3_str_appendf(&x, " IMMUTABLE");
427 }
drhb7e51992020-01-08 14:39:57 +0000428 sqlite3StrAccumFinish(&x);
drhb3d903e2015-06-18 14:09:13 +0000429 }else{
430 zFlgs[0] = 0;
431 }
drh38b41492015-06-08 15:08:15 +0000432 switch( pExpr->op ){
433 case TK_AGG_COLUMN: {
drhb3d903e2015-06-18 14:09:13 +0000434 sqlite3TreeViewLine(pView, "AGG{%d:%d}%s",
435 pExpr->iTable, pExpr->iColumn, zFlgs);
drh38b41492015-06-08 15:08:15 +0000436 break;
437 }
438 case TK_COLUMN: {
439 if( pExpr->iTable<0 ){
440 /* This only happens when coding check constraints */
drhd4933532019-10-31 12:30:38 +0000441 char zOp2[16];
442 if( pExpr->op2 ){
443 sqlite3_snprintf(sizeof(zOp2),zOp2," op2=0x%02x",pExpr->op2);
444 }else{
445 zOp2[0] = 0;
446 }
447 sqlite3TreeViewLine(pView, "COLUMN(%d)%s%s",
448 pExpr->iColumn, zFlgs, zOp2);
drh38b41492015-06-08 15:08:15 +0000449 }else{
drha513e592019-12-20 20:08:56 +0000450 sqlite3TreeViewLine(pView, "{%d:%d} pTab=%p%s",
451 pExpr->iTable, pExpr->iColumn,
452 pExpr->y.pTab, zFlgs);
drh38b41492015-06-08 15:08:15 +0000453 }
drhefad2e22018-07-27 16:57:11 +0000454 if( ExprHasProperty(pExpr, EP_FixedCol) ){
455 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
456 }
drh38b41492015-06-08 15:08:15 +0000457 break;
458 }
459 case TK_INTEGER: {
460 if( pExpr->flags & EP_IntValue ){
461 sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue);
462 }else{
463 sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken);
464 }
465 break;
466 }
467#ifndef SQLITE_OMIT_FLOATING_POINT
468 case TK_FLOAT: {
469 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
470 break;
471 }
472#endif
473 case TK_STRING: {
474 sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken);
475 break;
476 }
477 case TK_NULL: {
478 sqlite3TreeViewLine(pView,"NULL");
479 break;
480 }
drh34328212018-02-26 19:03:25 +0000481 case TK_TRUEFALSE: {
drh43c4ac82018-02-26 21:26:27 +0000482 sqlite3TreeViewLine(pView,
drh96acafb2018-02-27 14:49:25 +0000483 sqlite3ExprTruthValue(pExpr) ? "TRUE" : "FALSE");
drh34328212018-02-26 19:03:25 +0000484 break;
485 }
drh38b41492015-06-08 15:08:15 +0000486#ifndef SQLITE_OMIT_BLOB_LITERAL
487 case TK_BLOB: {
488 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
489 break;
490 }
491#endif
492 case TK_VARIABLE: {
493 sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)",
494 pExpr->u.zToken, pExpr->iColumn);
495 break;
496 }
497 case TK_REGISTER: {
498 sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable);
499 break;
500 }
drh38b41492015-06-08 15:08:15 +0000501 case TK_ID: {
502 sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken);
503 break;
504 }
505#ifndef SQLITE_OMIT_CAST
506 case TK_CAST: {
507 /* Expressions of the form: CAST(pLeft AS token) */
508 sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken);
509 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
510 break;
511 }
512#endif /* SQLITE_OMIT_CAST */
513 case TK_LT: zBinOp = "LT"; break;
514 case TK_LE: zBinOp = "LE"; break;
515 case TK_GT: zBinOp = "GT"; break;
516 case TK_GE: zBinOp = "GE"; break;
517 case TK_NE: zBinOp = "NE"; break;
518 case TK_EQ: zBinOp = "EQ"; break;
519 case TK_IS: zBinOp = "IS"; break;
520 case TK_ISNOT: zBinOp = "ISNOT"; break;
521 case TK_AND: zBinOp = "AND"; break;
522 case TK_OR: zBinOp = "OR"; break;
523 case TK_PLUS: zBinOp = "ADD"; break;
524 case TK_STAR: zBinOp = "MUL"; break;
525 case TK_MINUS: zBinOp = "SUB"; break;
526 case TK_REM: zBinOp = "REM"; break;
527 case TK_BITAND: zBinOp = "BITAND"; break;
528 case TK_BITOR: zBinOp = "BITOR"; break;
529 case TK_SLASH: zBinOp = "DIV"; break;
530 case TK_LSHIFT: zBinOp = "LSHIFT"; break;
531 case TK_RSHIFT: zBinOp = "RSHIFT"; break;
532 case TK_CONCAT: zBinOp = "CONCAT"; break;
533 case TK_DOT: zBinOp = "DOT"; break;
drhe7375bf2020-03-10 19:24:38 +0000534 case TK_LIMIT: zBinOp = "LIMIT"; break;
drh38b41492015-06-08 15:08:15 +0000535
536 case TK_UMINUS: zUniOp = "UMINUS"; break;
537 case TK_UPLUS: zUniOp = "UPLUS"; break;
538 case TK_BITNOT: zUniOp = "BITNOT"; break;
539 case TK_NOT: zUniOp = "NOT"; break;
540 case TK_ISNULL: zUniOp = "ISNULL"; break;
541 case TK_NOTNULL: zUniOp = "NOTNULL"; break;
542
drh34328212018-02-26 19:03:25 +0000543 case TK_TRUTH: {
drh43c4ac82018-02-26 21:26:27 +0000544 int x;
545 const char *azOp[] = {
546 "IS-FALSE", "IS-TRUE", "IS-NOT-FALSE", "IS-NOT-TRUE"
547 };
drh34328212018-02-26 19:03:25 +0000548 assert( pExpr->op2==TK_IS || pExpr->op2==TK_ISNOT );
549 assert( pExpr->pRight );
dan6ece3532019-06-12 13:49:32 +0000550 assert( sqlite3ExprSkipCollate(pExpr->pRight)->op==TK_TRUEFALSE );
drh96acafb2018-02-27 14:49:25 +0000551 x = (pExpr->op2==TK_ISNOT)*2 + sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +0000552 zUniOp = azOp[x];
drh34328212018-02-26 19:03:25 +0000553 break;
554 }
555
drh94fa9c42016-02-27 21:16:04 +0000556 case TK_SPAN: {
557 sqlite3TreeViewLine(pView, "SPAN %Q", pExpr->u.zToken);
558 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
559 break;
560 }
561
drh38b41492015-06-08 15:08:15 +0000562 case TK_COLLATE: {
drhc204d812019-09-10 17:51:27 +0000563 /* COLLATE operators without the EP_Collate flag are intended to
drh018dbb12019-09-28 16:14:55 +0000564 ** emulate collation associated with a table column. These show
565 ** up in the treeview output as "SOFT-COLLATE". Explicit COLLATE
566 ** operators that appear in the original SQL always have the
567 ** EP_Collate bit set and appear in treeview output as just "COLLATE" */
drhc204d812019-09-10 17:51:27 +0000568 sqlite3TreeViewLine(pView, "%sCOLLATE %Q%s",
569 !ExprHasProperty(pExpr, EP_Collate) ? "SOFT-" : "",
570 pExpr->u.zToken, zFlgs);
drh38b41492015-06-08 15:08:15 +0000571 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
572 break;
573 }
574
575 case TK_AGG_FUNCTION:
576 case TK_FUNCTION: {
577 ExprList *pFarg; /* List of function arguments */
drha1fd4b52018-07-10 06:32:53 +0000578 Window *pWin;
drh38b41492015-06-08 15:08:15 +0000579 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
580 pFarg = 0;
drha1fd4b52018-07-10 06:32:53 +0000581 pWin = 0;
drh38b41492015-06-08 15:08:15 +0000582 }else{
583 pFarg = pExpr->x.pList;
drha1fd4b52018-07-10 06:32:53 +0000584#ifndef SQLITE_OMIT_WINDOWFUNC
drh014fff22020-01-08 22:22:36 +0000585 pWin = ExprHasProperty(pExpr, EP_WinFunc) ? pExpr->y.pWin : 0;
drha1fd4b52018-07-10 06:32:53 +0000586#else
587 pWin = 0;
588#endif
drh38b41492015-06-08 15:08:15 +0000589 }
590 if( pExpr->op==TK_AGG_FUNCTION ){
drhe26d4282020-06-09 11:59:15 +0000591 sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q%s agg=%d[%d]/%p",
drhca74fbf2020-05-24 02:05:04 +0000592 pExpr->op2, pExpr->u.zToken, zFlgs,
drhe26d4282020-06-09 11:59:15 +0000593 pExpr->pAggInfo ? pExpr->pAggInfo->selId : 0,
drhca74fbf2020-05-24 02:05:04 +0000594 pExpr->iAgg, pExpr->pAggInfo);
drhd4933532019-10-31 12:30:38 +0000595 }else if( pExpr->op2!=0 ){
596 const char *zOp2;
597 char zBuf[8];
598 sqlite3_snprintf(sizeof(zBuf),zBuf,"0x%02x",pExpr->op2);
599 zOp2 = zBuf;
600 if( pExpr->op2==NC_IsCheck ) zOp2 = "NC_IsCheck";
601 if( pExpr->op2==NC_IdxExpr ) zOp2 = "NC_IdxExpr";
602 if( pExpr->op2==NC_PartIdx ) zOp2 = "NC_PartIdx";
603 if( pExpr->op2==NC_GenCol ) zOp2 = "NC_GenCol";
604 sqlite3TreeViewLine(pView, "FUNCTION %Q%s op2=%s",
605 pExpr->u.zToken, zFlgs, zOp2);
drh38b41492015-06-08 15:08:15 +0000606 }else{
drh42d2fce2019-08-15 20:04:09 +0000607 sqlite3TreeViewLine(pView, "FUNCTION %Q%s", pExpr->u.zToken, zFlgs);
drh38b41492015-06-08 15:08:15 +0000608 }
609 if( pFarg ){
drha1fd4b52018-07-10 06:32:53 +0000610 sqlite3TreeViewExprList(pView, pFarg, pWin!=0, 0);
drh38b41492015-06-08 15:08:15 +0000611 }
mistachkin14897852018-07-23 18:53:49 +0000612#ifndef SQLITE_OMIT_WINDOWFUNC
drha1fd4b52018-07-10 06:32:53 +0000613 if( pWin ){
614 sqlite3TreeViewWindow(pView, pWin, 0);
615 }
616#endif
drh38b41492015-06-08 15:08:15 +0000617 break;
618 }
619#ifndef SQLITE_OMIT_SUBQUERY
620 case TK_EXISTS: {
drh9f6e14c2017-07-10 13:24:58 +0000621 sqlite3TreeViewLine(pView, "EXISTS-expr flags=0x%x", pExpr->flags);
drh38b41492015-06-08 15:08:15 +0000622 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
623 break;
624 }
625 case TK_SELECT: {
drha0365c42020-06-05 04:01:50 +0000626 sqlite3TreeViewLine(pView, "subquery-expr flags=0x%x", pExpr->flags);
drh38b41492015-06-08 15:08:15 +0000627 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
628 break;
629 }
630 case TK_IN: {
drh9f6e14c2017-07-10 13:24:58 +0000631 sqlite3TreeViewLine(pView, "IN flags=0x%x", pExpr->flags);
drh38b41492015-06-08 15:08:15 +0000632 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
633 if( ExprHasProperty(pExpr, EP_xIsSelect) ){
634 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
635 }else{
636 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
637 }
638 break;
639 }
640#endif /* SQLITE_OMIT_SUBQUERY */
641
642 /*
643 ** x BETWEEN y AND z
644 **
645 ** This is equivalent to
646 **
647 ** x>=y AND x<=z
648 **
649 ** X is stored in pExpr->pLeft.
650 ** Y is stored in pExpr->pList->a[0].pExpr.
651 ** Z is stored in pExpr->pList->a[1].pExpr.
652 */
653 case TK_BETWEEN: {
654 Expr *pX = pExpr->pLeft;
655 Expr *pY = pExpr->x.pList->a[0].pExpr;
656 Expr *pZ = pExpr->x.pList->a[1].pExpr;
657 sqlite3TreeViewLine(pView, "BETWEEN");
658 sqlite3TreeViewExpr(pView, pX, 1);
659 sqlite3TreeViewExpr(pView, pY, 1);
660 sqlite3TreeViewExpr(pView, pZ, 0);
661 break;
662 }
663 case TK_TRIGGER: {
664 /* If the opcode is TK_TRIGGER, then the expression is a reference
665 ** to a column in the new.* or old.* pseudo-tables available to
666 ** trigger programs. In this case Expr.iTable is set to 1 for the
667 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
668 ** is set to the column of the pseudo-table to read, or to -1 to
669 ** read the rowid field.
670 */
671 sqlite3TreeViewLine(pView, "%s(%d)",
672 pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
673 break;
674 }
675 case TK_CASE: {
676 sqlite3TreeViewLine(pView, "CASE");
677 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
678 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
679 break;
680 }
681#ifndef SQLITE_OMIT_TRIGGER
682 case TK_RAISE: {
683 const char *zType = "unk";
drh11949042019-08-05 18:01:42 +0000684 switch( pExpr->affExpr ){
drh38b41492015-06-08 15:08:15 +0000685 case OE_Rollback: zType = "rollback"; break;
686 case OE_Abort: zType = "abort"; break;
687 case OE_Fail: zType = "fail"; break;
688 case OE_Ignore: zType = "ignore"; break;
689 }
690 sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken);
691 break;
692 }
693#endif
drhc84a4022016-05-27 12:30:20 +0000694 case TK_MATCH: {
695 sqlite3TreeViewLine(pView, "MATCH {%d:%d}%s",
696 pExpr->iTable, pExpr->iColumn, zFlgs);
697 sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
698 break;
699 }
drhdb97e562016-08-18 17:55:57 +0000700 case TK_VECTOR: {
drh269d3222019-10-23 18:09:39 +0000701 char *z = sqlite3_mprintf("VECTOR%s",zFlgs);
702 sqlite3TreeViewBareExprList(pView, pExpr->x.pList, z);
703 sqlite3_free(z);
drhdb97e562016-08-18 17:55:57 +0000704 break;
705 }
drh48cb3a72016-08-18 18:09:10 +0000706 case TK_SELECT_COLUMN: {
707 sqlite3TreeViewLine(pView, "SELECT-COLUMN %d", pExpr->iColumn);
708 sqlite3TreeViewSelect(pView, pExpr->pLeft->x.pSelect, 0);
709 break;
710 }
drh31d6fd52017-04-14 19:03:10 +0000711 case TK_IF_NULL_ROW: {
712 sqlite3TreeViewLine(pView, "IF-NULL-ROW %d", pExpr->iTable);
713 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
714 break;
715 }
drh38b41492015-06-08 15:08:15 +0000716 default: {
717 sqlite3TreeViewLine(pView, "op=%d", pExpr->op);
718 break;
719 }
720 }
721 if( zBinOp ){
drhb3d903e2015-06-18 14:09:13 +0000722 sqlite3TreeViewLine(pView, "%s%s", zBinOp, zFlgs);
drh38b41492015-06-08 15:08:15 +0000723 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
724 sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
725 }else if( zUniOp ){
drhb3d903e2015-06-18 14:09:13 +0000726 sqlite3TreeViewLine(pView, "%s%s", zUniOp, zFlgs);
drh11949042019-08-05 18:01:42 +0000727 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
drh38b41492015-06-08 15:08:15 +0000728 }
729 sqlite3TreeViewPop(pView);
730}
731
drhdb97e562016-08-18 17:55:57 +0000732
drh38b41492015-06-08 15:08:15 +0000733/*
734** Generate a human-readable explanation of an expression list.
735*/
drhdb97e562016-08-18 17:55:57 +0000736void sqlite3TreeViewBareExprList(
drh38b41492015-06-08 15:08:15 +0000737 TreeView *pView,
738 const ExprList *pList,
drh38b41492015-06-08 15:08:15 +0000739 const char *zLabel
740){
drh38b41492015-06-08 15:08:15 +0000741 if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
742 if( pList==0 ){
743 sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
744 }else{
drhdb97e562016-08-18 17:55:57 +0000745 int i;
drh38b41492015-06-08 15:08:15 +0000746 sqlite3TreeViewLine(pView, "%s", zLabel);
747 for(i=0; i<pList->nExpr; i++){
drh5579d592015-08-26 14:01:41 +0000748 int j = pList->a[i].u.x.iOrderByCol;
drh41cee662019-12-12 20:22:34 +0000749 char *zName = pList->a[i].zEName;
drhfbe07532018-04-23 20:04:38 +0000750 int moreToFollow = i<pList->nExpr - 1;
drhe1f49b82020-01-03 00:28:14 +0000751 if( pList->a[i].eEName!=ENAME_NAME ) zName = 0;
drh5a699a02017-12-22 19:53:02 +0000752 if( j || zName ){
drhfbe07532018-04-23 20:04:38 +0000753 sqlite3TreeViewPush(pView, moreToFollow);
754 moreToFollow = 0;
755 sqlite3TreeViewLine(pView, 0);
756 if( zName ){
757 fprintf(stdout, "AS %s ", zName);
758 }
759 if( j ){
760 fprintf(stdout, "iOrderByCol=%d", j);
761 }
762 fprintf(stdout, "\n");
763 fflush(stdout);
drh5a699a02017-12-22 19:53:02 +0000764 }
drhfbe07532018-04-23 20:04:38 +0000765 sqlite3TreeViewExpr(pView, pList->a[i].pExpr, moreToFollow);
drh5a699a02017-12-22 19:53:02 +0000766 if( j || zName ){
767 sqlite3TreeViewPop(pView);
768 }
drh38b41492015-06-08 15:08:15 +0000769 }
770 }
drhdb97e562016-08-18 17:55:57 +0000771}
772void sqlite3TreeViewExprList(
773 TreeView *pView,
774 const ExprList *pList,
775 u8 moreToFollow,
776 const char *zLabel
777){
778 pView = sqlite3TreeViewPush(pView, moreToFollow);
779 sqlite3TreeViewBareExprList(pView, pList, zLabel);
drh38b41492015-06-08 15:08:15 +0000780 sqlite3TreeViewPop(pView);
781}
782
783#endif /* SQLITE_DEBUG */