blob: 9f630b1561d97ed6b487c35ff20ba785c46dcafc [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*/
drh2a7dcbf2022-04-06 15:41:53 +000027static void sqlite3TreeViewPush(TreeView **pp, u8 moreToFollow){
28 TreeView *p = *pp;
drh38b41492015-06-08 15:08:15 +000029 if( p==0 ){
drh2a7dcbf2022-04-06 15:41:53 +000030 *pp = p = sqlite3_malloc64( sizeof(*p) );
31 if( p==0 ) return;
drh38b41492015-06-08 15:08:15 +000032 memset(p, 0, sizeof(*p));
33 }else{
34 p->iLevel++;
35 }
36 assert( moreToFollow==0 || moreToFollow==1 );
drhe684ac62022-03-08 13:59:46 +000037 if( p->iLevel<(int)sizeof(p->bLine) ) p->bLine[p->iLevel] = moreToFollow;
drh38b41492015-06-08 15:08:15 +000038}
39
40/*
41** Finished with one layer of the tree
42*/
drh2a7dcbf2022-04-06 15:41:53 +000043static void sqlite3TreeViewPop(TreeView **pp){
44 TreeView *p = *pp;
drh38b41492015-06-08 15:08:15 +000045 if( p==0 ) return;
46 p->iLevel--;
drh2a7dcbf2022-04-06 15:41:53 +000047 if( p->iLevel<0 ){
48 sqlite3_free(p);
49 *pp = 0;
50 }
drh38b41492015-06-08 15:08:15 +000051}
52
53/*
54** Generate a single line of output for the tree, with a prefix that contains
55** all the appropriate tree lines
56*/
drh2a7dcbf2022-04-06 15:41:53 +000057void sqlite3TreeViewLine(TreeView *p, const char *zFormat, ...){
drh38b41492015-06-08 15:08:15 +000058 va_list ap;
59 int i;
60 StrAccum acc;
drh0751fc32022-06-22 14:43:52 +000061 char zBuf[1000];
drh38b41492015-06-08 15:08:15 +000062 sqlite3StrAccumInit(&acc, 0, zBuf, sizeof(zBuf), 0);
63 if( p ){
drhe684ac62022-03-08 13:59:46 +000064 for(i=0; i<p->iLevel && i<(int)sizeof(p->bLine)-1; i++){
drh0cdbe1a2018-05-09 13:46:26 +000065 sqlite3_str_append(&acc, p->bLine[i] ? "| " : " ", 4);
drh38b41492015-06-08 15:08:15 +000066 }
drh0cdbe1a2018-05-09 13:46:26 +000067 sqlite3_str_append(&acc, p->bLine[i] ? "|-- " : "'-- ", 4);
drh38b41492015-06-08 15:08:15 +000068 }
drhfbe07532018-04-23 20:04:38 +000069 if( zFormat!=0 ){
70 va_start(ap, zFormat);
drh0cdbe1a2018-05-09 13:46:26 +000071 sqlite3_str_vappendf(&acc, zFormat, ap);
drhfbe07532018-04-23 20:04:38 +000072 va_end(ap);
drh10c0e712019-04-25 18:15:38 +000073 assert( acc.nChar>0 || acc.accError );
drh0cdbe1a2018-05-09 13:46:26 +000074 sqlite3_str_append(&acc, "\n", 1);
drhfbe07532018-04-23 20:04:38 +000075 }
drh38b41492015-06-08 15:08:15 +000076 sqlite3StrAccumFinish(&acc);
77 fprintf(stdout,"%s", zBuf);
78 fflush(stdout);
79}
80
81/*
82** Shorthand for starting a new tree item that consists of a single label
83*/
84static void sqlite3TreeViewItem(TreeView *p, const char *zLabel,u8 moreFollows){
drh2a7dcbf2022-04-06 15:41:53 +000085 sqlite3TreeViewPush(&p, moreFollows);
drh38b41492015-06-08 15:08:15 +000086 sqlite3TreeViewLine(p, "%s", zLabel);
87}
88
drh2476a6f2015-11-07 15:19:59 +000089/*
drha087eb82022-04-28 18:17:51 +000090** Show a list of Column objects in tree format.
91*/
92void sqlite3TreeViewColumnList(
93 TreeView *pView,
94 const Column *aCol,
95 int nCol,
96 u8 moreToFollow
97){
98 int i;
99 sqlite3TreeViewPush(&pView, moreToFollow);
100 sqlite3TreeViewLine(pView, "COLUMNS");
101 for(i=0; i<nCol; i++){
102 u16 flg = aCol[i].colFlags;
mistachkin07fae322022-07-06 23:50:01 +0000103 int colMoreToFollow = i<(nCol - 1);
104 sqlite3TreeViewPush(&pView, colMoreToFollow);
drha087eb82022-04-28 18:17:51 +0000105 sqlite3TreeViewLine(pView, 0);
106 printf(" %s", aCol[i].zCnName);
107 switch( aCol[i].eCType ){
108 case COLTYPE_ANY: printf(" ANY"); break;
109 case COLTYPE_BLOB: printf(" BLOB"); break;
110 case COLTYPE_INT: printf(" INT"); break;
111 case COLTYPE_INTEGER: printf(" INTEGER"); break;
112 case COLTYPE_REAL: printf(" REAL"); break;
113 case COLTYPE_TEXT: printf(" TEXT"); break;
114 case COLTYPE_CUSTOM: {
115 if( flg & COLFLAG_HASTYPE ){
116 const char *z = aCol[i].zCnName;
117 z += strlen(z)+1;
118 printf(" X-%s", z);
119 break;
120 }
121 }
122 }
123 if( flg & COLFLAG_PRIMKEY ) printf(" PRIMARY KEY");
124 if( flg & COLFLAG_HIDDEN ) printf(" HIDDEN");
drh0c0d0522022-04-29 17:13:52 +0000125#ifdef COLFLAG_NOEXPAND
drha087eb82022-04-28 18:17:51 +0000126 if( flg & COLFLAG_NOEXPAND ) printf(" NO-EXPAND");
drh0c0d0522022-04-29 17:13:52 +0000127#endif
drha087eb82022-04-28 18:17:51 +0000128 if( flg ) printf(" flags=%04x", flg);
129 printf("\n");
130 fflush(stdout);
131 sqlite3TreeViewPop(&pView);
132 }
133 sqlite3TreeViewPop(&pView);
134}
135
136/*
drh2476a6f2015-11-07 15:19:59 +0000137** Generate a human-readable description of a WITH clause.
138*/
139void sqlite3TreeViewWith(TreeView *pView, const With *pWith, u8 moreToFollow){
140 int i;
141 if( pWith==0 ) return;
142 if( pWith->nCte==0 ) return;
143 if( pWith->pOuter ){
144 sqlite3TreeViewLine(pView, "WITH (0x%p, pOuter=0x%p)",pWith,pWith->pOuter);
145 }else{
146 sqlite3TreeViewLine(pView, "WITH (0x%p)", pWith);
147 }
148 if( pWith->nCte>0 ){
drh2a7dcbf2022-04-06 15:41:53 +0000149 sqlite3TreeViewPush(&pView, moreToFollow);
drh2476a6f2015-11-07 15:19:59 +0000150 for(i=0; i<pWith->nCte; i++){
151 StrAccum x;
152 char zLine[1000];
153 const struct Cte *pCte = &pWith->a[i];
154 sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
drh0cdbe1a2018-05-09 13:46:26 +0000155 sqlite3_str_appendf(&x, "%s", pCte->zName);
drh2476a6f2015-11-07 15:19:59 +0000156 if( pCte->pCols && pCte->pCols->nExpr>0 ){
157 char cSep = '(';
158 int j;
159 for(j=0; j<pCte->pCols->nExpr; j++){
drh41cee662019-12-12 20:22:34 +0000160 sqlite3_str_appendf(&x, "%c%s", cSep, pCte->pCols->a[j].zEName);
drh2476a6f2015-11-07 15:19:59 +0000161 cSep = ',';
162 }
drh0cdbe1a2018-05-09 13:46:26 +0000163 sqlite3_str_appendf(&x, ")");
drh2476a6f2015-11-07 15:19:59 +0000164 }
drh67f70be2022-04-22 16:15:48 +0000165 if( pCte->eM10d!=M10d_Any ){
166 sqlite3_str_appendf(&x, " %sMATERIALIZED",
167 pCte->eM10d==M10d_No ? "NOT " : "");
168 }
drha79e2a22021-02-21 23:44:14 +0000169 if( pCte->pUse ){
170 sqlite3_str_appendf(&x, " (pUse=0x%p, nUse=%d)", pCte->pUse,
171 pCte->pUse->nUse);
172 }
drh2476a6f2015-11-07 15:19:59 +0000173 sqlite3StrAccumFinish(&x);
174 sqlite3TreeViewItem(pView, zLine, i<pWith->nCte-1);
175 sqlite3TreeViewSelect(pView, pCte->pSelect, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000176 sqlite3TreeViewPop(&pView);
drh2476a6f2015-11-07 15:19:59 +0000177 }
drh2a7dcbf2022-04-06 15:41:53 +0000178 sqlite3TreeViewPop(&pView);
drh2476a6f2015-11-07 15:19:59 +0000179 }
180}
181
drh145d0a32018-11-08 22:53:06 +0000182/*
183** Generate a human-readable description of a SrcList object.
184*/
185void sqlite3TreeViewSrcList(TreeView *pView, const SrcList *pSrc){
186 int i;
drhb60d1fb2022-04-13 18:32:04 +0000187 if( pSrc==0 ) return;
drh145d0a32018-11-08 22:53:06 +0000188 for(i=0; i<pSrc->nSrc; i++){
drh76012942021-02-21 21:04:54 +0000189 const SrcItem *pItem = &pSrc->a[i];
drh145d0a32018-11-08 22:53:06 +0000190 StrAccum x;
drh08e1a6a2022-04-29 17:03:25 +0000191 int n = 0;
drh0751fc32022-06-22 14:43:52 +0000192 char zLine[1000];
drh145d0a32018-11-08 22:53:06 +0000193 sqlite3StrAccumInit(&x, 0, zLine, sizeof(zLine), 0);
drhff374912021-04-12 12:58:55 +0000194 x.printfFlags |= SQLITE_PRINTF_INTERNAL;
drh6610e6a2021-03-19 19:44:56 +0000195 sqlite3_str_appendf(&x, "{%d:*} %!S", pItem->iCursor, pItem);
drh145d0a32018-11-08 22:53:06 +0000196 if( pItem->pTab ){
drhf7f6dbf2020-03-21 22:03:32 +0000197 sqlite3_str_appendf(&x, " tab=%Q nCol=%d ptr=%p used=%llx",
198 pItem->pTab->zName, pItem->pTab->nCol, pItem->pTab, pItem->colUsed);
drh145d0a32018-11-08 22:53:06 +0000199 }
drha76ac882022-04-08 19:20:12 +0000200 if( (pItem->fg.jointype & (JT_LEFT|JT_RIGHT))==(JT_LEFT|JT_RIGHT) ){
201 sqlite3_str_appendf(&x, " FULL-OUTER-JOIN");
202 }else if( pItem->fg.jointype & JT_LEFT ){
drh145d0a32018-11-08 22:53:06 +0000203 sqlite3_str_appendf(&x, " LEFT-JOIN");
drha76ac882022-04-08 19:20:12 +0000204 }else if( pItem->fg.jointype & JT_RIGHT ){
205 sqlite3_str_appendf(&x, " RIGHT-JOIN");
drh9b9f2352021-06-23 11:39:00 +0000206 }else if( pItem->fg.jointype & JT_CROSS ){
207 sqlite3_str_appendf(&x, " CROSS-JOIN");
drh145d0a32018-11-08 22:53:06 +0000208 }
drh8a28ce72022-04-11 00:54:30 +0000209 if( pItem->fg.jointype & JT_LTORJ ){
210 sqlite3_str_appendf(&x, " LTORJ");
211 }
drhb7e51992020-01-08 14:39:57 +0000212 if( pItem->fg.fromDDL ){
213 sqlite3_str_appendf(&x, " DDL");
214 }
drha79e2a22021-02-21 23:44:14 +0000215 if( pItem->fg.isCte ){
216 sqlite3_str_appendf(&x, " CteUse=0x%p", pItem->u2.pCteUse);
217 }
drh5c118e32022-06-08 15:30:39 +0000218 if( pItem->fg.isOn || (pItem->fg.isUsing==0 && pItem->u3.pOn!=0) ){
219 sqlite3_str_appendf(&x, " ON");
220 }
drh8cc8d362023-01-28 21:01:33 +0000221 if( pItem->fg.isTabFunc ) sqlite3_str_appendf(&x, " isTabFunc");
222 if( pItem->fg.isCorrelated ) sqlite3_str_appendf(&x, " isCorrelated");
223 if( pItem->fg.isMaterialized ) sqlite3_str_appendf(&x, " isMaterialized");
224 if( pItem->fg.viaCoroutine ) sqlite3_str_appendf(&x, " viaCoroutine");
225 if( pItem->fg.notCte ) sqlite3_str_appendf(&x, " notCte");
226 if( pItem->fg.isNestedFrom ) sqlite3_str_appendf(&x, " isNestedFrom");
227
drh145d0a32018-11-08 22:53:06 +0000228 sqlite3StrAccumFinish(&x);
drha087eb82022-04-28 18:17:51 +0000229 sqlite3TreeViewItem(pView, zLine, i<pSrc->nSrc-1);
drh08e1a6a2022-04-29 17:03:25 +0000230 n = 0;
drh08e1a6a2022-04-29 17:03:25 +0000231 if( pItem->pSelect ) n++;
232 if( pItem->fg.isTabFunc ) n++;
233 if( pItem->fg.isUsing ) n++;
234 if( pItem->fg.isUsing ){
235 sqlite3TreeViewIdList(pView, pItem->u3.pUsing, (--n)>0, "USING");
236 }
drh145d0a32018-11-08 22:53:06 +0000237 if( pItem->pSelect ){
drh8e8e9de2022-04-29 17:45:39 +0000238 if( pItem->pTab ){
239 Table *pTab = pItem->pTab;
240 sqlite3TreeViewColumnList(pView, pTab->aCol, pTab->nCol, 1);
241 }
mistachkin07fae322022-07-06 23:50:01 +0000242 assert( (int)pItem->fg.isNestedFrom == IsNestedFrom(pItem->pSelect) );
drh08e1a6a2022-04-29 17:03:25 +0000243 sqlite3TreeViewSelect(pView, pItem->pSelect, (--n)>0);
drh145d0a32018-11-08 22:53:06 +0000244 }
245 if( pItem->fg.isTabFunc ){
246 sqlite3TreeViewExprList(pView, pItem->u1.pFuncArg, 0, "func-args:");
247 }
drh2a7dcbf2022-04-06 15:41:53 +0000248 sqlite3TreeViewPop(&pView);
drh145d0a32018-11-08 22:53:06 +0000249 }
250}
drh38b41492015-06-08 15:08:15 +0000251
252/*
drh2e5c5052016-08-27 20:21:51 +0000253** Generate a human-readable description of a Select object.
drh38b41492015-06-08 15:08:15 +0000254*/
255void sqlite3TreeViewSelect(TreeView *pView, const Select *p, u8 moreToFollow){
256 int n = 0;
drh1c4505d2015-08-26 11:34:31 +0000257 int cnt = 0;
drh510b7ff2017-03-13 17:37:13 +0000258 if( p==0 ){
259 sqlite3TreeViewLine(pView, "nil-SELECT");
260 return;
261 }
drh2a7dcbf2022-04-06 15:41:53 +0000262 sqlite3TreeViewPush(&pView, moreToFollow);
drh2476a6f2015-11-07 15:19:59 +0000263 if( p->pWith ){
264 sqlite3TreeViewWith(pView, p->pWith, 1);
265 cnt = 1;
drh2a7dcbf2022-04-06 15:41:53 +0000266 sqlite3TreeViewPush(&pView, 1);
drh2476a6f2015-11-07 15:19:59 +0000267 }
drh1c4505d2015-08-26 11:34:31 +0000268 do{
drh55b4c822019-08-03 16:17:46 +0000269 if( p->selFlags & SF_WhereBegin ){
270 sqlite3TreeViewLine(pView, "sqlite3WhereBegin()");
271 }else{
272 sqlite3TreeViewLine(pView,
273 "SELECT%s%s (%u/%p) selFlags=0x%x nSelectRow=%d",
274 ((p->selFlags & SF_Distinct) ? " DISTINCT" : ""),
275 ((p->selFlags & SF_Aggregate) ? " agg_flag" : ""),
276 p->selId, p, p->selFlags,
277 (int)p->nSelectRow
278 );
279 }
drh2a7dcbf2022-04-06 15:41:53 +0000280 if( cnt++ ) sqlite3TreeViewPop(&pView);
drh1c4505d2015-08-26 11:34:31 +0000281 if( p->pPrior ){
282 n = 1000;
283 }else{
284 n = 0;
285 if( p->pSrc && p->pSrc->nSrc ) n++;
286 if( p->pWhere ) n++;
287 if( p->pGroupBy ) n++;
288 if( p->pHaving ) n++;
289 if( p->pOrderBy ) n++;
290 if( p->pLimit ) n++;
drha1fd4b52018-07-10 06:32:53 +0000291#ifndef SQLITE_OMIT_WINDOWFUNC
292 if( p->pWin ) n++;
293 if( p->pWinDefn ) n++;
294#endif
drh1c4505d2015-08-26 11:34:31 +0000295 }
drh55b4c822019-08-03 16:17:46 +0000296 if( p->pEList ){
297 sqlite3TreeViewExprList(pView, p->pEList, n>0, "result-set");
298 }
299 n--;
drha1fd4b52018-07-10 06:32:53 +0000300#ifndef SQLITE_OMIT_WINDOWFUNC
301 if( p->pWin ){
302 Window *pX;
drh2a7dcbf2022-04-06 15:41:53 +0000303 sqlite3TreeViewPush(&pView, (n--)>0);
drha1fd4b52018-07-10 06:32:53 +0000304 sqlite3TreeViewLine(pView, "window-functions");
305 for(pX=p->pWin; pX; pX=pX->pNextWin){
306 sqlite3TreeViewWinFunc(pView, pX, pX->pNextWin!=0);
307 }
drh2a7dcbf2022-04-06 15:41:53 +0000308 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000309 }
310#endif
drh1c4505d2015-08-26 11:34:31 +0000311 if( p->pSrc && p->pSrc->nSrc ){
drh2a7dcbf2022-04-06 15:41:53 +0000312 sqlite3TreeViewPush(&pView, (n--)>0);
drh1c4505d2015-08-26 11:34:31 +0000313 sqlite3TreeViewLine(pView, "FROM");
drh145d0a32018-11-08 22:53:06 +0000314 sqlite3TreeViewSrcList(pView, p->pSrc);
drh2a7dcbf2022-04-06 15:41:53 +0000315 sqlite3TreeViewPop(&pView);
drh38b41492015-06-08 15:08:15 +0000316 }
drh1c4505d2015-08-26 11:34:31 +0000317 if( p->pWhere ){
318 sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
319 sqlite3TreeViewExpr(pView, p->pWhere, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000320 sqlite3TreeViewPop(&pView);
drh38b41492015-06-08 15:08:15 +0000321 }
drh1c4505d2015-08-26 11:34:31 +0000322 if( p->pGroupBy ){
323 sqlite3TreeViewExprList(pView, p->pGroupBy, (n--)>0, "GROUPBY");
324 }
325 if( p->pHaving ){
326 sqlite3TreeViewItem(pView, "HAVING", (n--)>0);
327 sqlite3TreeViewExpr(pView, p->pHaving, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000328 sqlite3TreeViewPop(&pView);
drh1c4505d2015-08-26 11:34:31 +0000329 }
drha1fd4b52018-07-10 06:32:53 +0000330#ifndef SQLITE_OMIT_WINDOWFUNC
331 if( p->pWinDefn ){
332 Window *pX;
333 sqlite3TreeViewItem(pView, "WINDOW", (n--)>0);
334 for(pX=p->pWinDefn; pX; pX=pX->pNextWin){
335 sqlite3TreeViewWindow(pView, pX, pX->pNextWin!=0);
336 }
drh2a7dcbf2022-04-06 15:41:53 +0000337 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000338 }
339#endif
drh1c4505d2015-08-26 11:34:31 +0000340 if( p->pOrderBy ){
341 sqlite3TreeViewExprList(pView, p->pOrderBy, (n--)>0, "ORDERBY");
342 }
343 if( p->pLimit ){
344 sqlite3TreeViewItem(pView, "LIMIT", (n--)>0);
drh8c0833f2017-11-14 23:48:23 +0000345 sqlite3TreeViewExpr(pView, p->pLimit->pLeft, p->pLimit->pRight!=0);
346 if( p->pLimit->pRight ){
347 sqlite3TreeViewItem(pView, "OFFSET", (n--)>0);
348 sqlite3TreeViewExpr(pView, p->pLimit->pRight, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000349 sqlite3TreeViewPop(&pView);
drh8c0833f2017-11-14 23:48:23 +0000350 }
drh2a7dcbf2022-04-06 15:41:53 +0000351 sqlite3TreeViewPop(&pView);
drh1c4505d2015-08-26 11:34:31 +0000352 }
353 if( p->pPrior ){
354 const char *zOp = "UNION";
355 switch( p->op ){
356 case TK_ALL: zOp = "UNION ALL"; break;
357 case TK_INTERSECT: zOp = "INTERSECT"; break;
358 case TK_EXCEPT: zOp = "EXCEPT"; break;
359 }
360 sqlite3TreeViewItem(pView, zOp, 1);
361 }
362 p = p->pPrior;
363 }while( p!=0 );
drh2a7dcbf2022-04-06 15:41:53 +0000364 sqlite3TreeViewPop(&pView);
drh38b41492015-06-08 15:08:15 +0000365}
366
drha1fd4b52018-07-10 06:32:53 +0000367#ifndef SQLITE_OMIT_WINDOWFUNC
368/*
369** Generate a description of starting or stopping bounds
370*/
371void sqlite3TreeViewBound(
372 TreeView *pView, /* View context */
373 u8 eBound, /* UNBOUNDED, CURRENT, PRECEDING, FOLLOWING */
374 Expr *pExpr, /* Value for PRECEDING or FOLLOWING */
375 u8 moreToFollow /* True if more to follow */
376){
377 switch( eBound ){
378 case TK_UNBOUNDED: {
379 sqlite3TreeViewItem(pView, "UNBOUNDED", moreToFollow);
drh2a7dcbf2022-04-06 15:41:53 +0000380 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000381 break;
382 }
383 case TK_CURRENT: {
384 sqlite3TreeViewItem(pView, "CURRENT", moreToFollow);
drh2a7dcbf2022-04-06 15:41:53 +0000385 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000386 break;
387 }
388 case TK_PRECEDING: {
389 sqlite3TreeViewItem(pView, "PRECEDING", moreToFollow);
390 sqlite3TreeViewExpr(pView, pExpr, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000391 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000392 break;
393 }
394 case TK_FOLLOWING: {
395 sqlite3TreeViewItem(pView, "FOLLOWING", moreToFollow);
396 sqlite3TreeViewExpr(pView, pExpr, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000397 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000398 break;
399 }
400 }
401}
402#endif /* SQLITE_OMIT_WINDOWFUNC */
403
404#ifndef SQLITE_OMIT_WINDOWFUNC
405/*
406** Generate a human-readable explanation for a Window object
407*/
408void sqlite3TreeViewWindow(TreeView *pView, const Window *pWin, u8 more){
drhfc15f4c2019-03-28 13:03:41 +0000409 int nElement = 0;
drhbae50d62022-04-30 19:55:28 +0000410 if( pWin==0 ) return;
drh0dc0e9c2019-03-28 13:35:28 +0000411 if( pWin->pFilter ){
412 sqlite3TreeViewItem(pView, "FILTER", 1);
413 sqlite3TreeViewExpr(pView, pWin->pFilter, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000414 sqlite3TreeViewPop(&pView);
drh0dc0e9c2019-03-28 13:35:28 +0000415 }
drh2a7dcbf2022-04-06 15:41:53 +0000416 sqlite3TreeViewPush(&pView, more);
drha1fd4b52018-07-10 06:32:53 +0000417 if( pWin->zName ){
drh6f1644c2019-03-28 13:53:12 +0000418 sqlite3TreeViewLine(pView, "OVER %s (%p)", pWin->zName, pWin);
drha1fd4b52018-07-10 06:32:53 +0000419 }else{
drh6f1644c2019-03-28 13:53:12 +0000420 sqlite3TreeViewLine(pView, "OVER (%p)", pWin);
drha1fd4b52018-07-10 06:32:53 +0000421 }
drhfc15f4c2019-03-28 13:03:41 +0000422 if( pWin->zBase ) nElement++;
423 if( pWin->pOrderBy ) nElement++;
424 if( pWin->eFrmType ) nElement++;
425 if( pWin->eExclude ) nElement++;
drhfc15f4c2019-03-28 13:03:41 +0000426 if( pWin->zBase ){
drh2a7dcbf2022-04-06 15:41:53 +0000427 sqlite3TreeViewPush(&pView, (--nElement)>0);
drhfc15f4c2019-03-28 13:03:41 +0000428 sqlite3TreeViewLine(pView, "window: %s", pWin->zBase);
drh2a7dcbf2022-04-06 15:41:53 +0000429 sqlite3TreeViewPop(&pView);
drhfc15f4c2019-03-28 13:03:41 +0000430 }
drha1fd4b52018-07-10 06:32:53 +0000431 if( pWin->pPartition ){
drhfc15f4c2019-03-28 13:03:41 +0000432 sqlite3TreeViewExprList(pView, pWin->pPartition, nElement>0,"PARTITION-BY");
drha1fd4b52018-07-10 06:32:53 +0000433 }
434 if( pWin->pOrderBy ){
drhfc15f4c2019-03-28 13:03:41 +0000435 sqlite3TreeViewExprList(pView, pWin->pOrderBy, (--nElement)>0, "ORDER-BY");
drha1fd4b52018-07-10 06:32:53 +0000436 }
drhfc15f4c2019-03-28 13:03:41 +0000437 if( pWin->eFrmType ){
drh0dc0e9c2019-03-28 13:35:28 +0000438 char zBuf[30];
drhfc15f4c2019-03-28 13:03:41 +0000439 const char *zFrmType = "ROWS";
440 if( pWin->eFrmType==TK_RANGE ) zFrmType = "RANGE";
441 if( pWin->eFrmType==TK_GROUPS ) zFrmType = "GROUPS";
drh0dc0e9c2019-03-28 13:35:28 +0000442 sqlite3_snprintf(sizeof(zBuf),zBuf,"%s%s",zFrmType,
443 pWin->bImplicitFrame ? " (implied)" : "");
444 sqlite3TreeViewItem(pView, zBuf, (--nElement)>0);
drha1fd4b52018-07-10 06:32:53 +0000445 sqlite3TreeViewBound(pView, pWin->eStart, pWin->pStart, 1);
446 sqlite3TreeViewBound(pView, pWin->eEnd, pWin->pEnd, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000447 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000448 }
drhfc15f4c2019-03-28 13:03:41 +0000449 if( pWin->eExclude ){
450 char zBuf[30];
451 const char *zExclude;
452 switch( pWin->eExclude ){
453 case TK_NO: zExclude = "NO OTHERS"; break;
454 case TK_CURRENT: zExclude = "CURRENT ROW"; break;
455 case TK_GROUP: zExclude = "GROUP"; break;
456 case TK_TIES: zExclude = "TIES"; break;
457 default:
458 sqlite3_snprintf(sizeof(zBuf),zBuf,"invalid(%d)", pWin->eExclude);
459 zExclude = zBuf;
460 break;
461 }
drh2a7dcbf2022-04-06 15:41:53 +0000462 sqlite3TreeViewPush(&pView, 0);
drhfc15f4c2019-03-28 13:03:41 +0000463 sqlite3TreeViewLine(pView, "EXCLUDE %s", zExclude);
drh2a7dcbf2022-04-06 15:41:53 +0000464 sqlite3TreeViewPop(&pView);
drhfc15f4c2019-03-28 13:03:41 +0000465 }
drh2a7dcbf2022-04-06 15:41:53 +0000466 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000467}
468#endif /* SQLITE_OMIT_WINDOWFUNC */
469
470#ifndef SQLITE_OMIT_WINDOWFUNC
471/*
472** Generate a human-readable explanation for a Window Function object
473*/
474void sqlite3TreeViewWinFunc(TreeView *pView, const Window *pWin, u8 more){
drh7a880992022-05-02 15:23:59 +0000475 if( pWin==0 ) return;
drh2a7dcbf2022-04-06 15:41:53 +0000476 sqlite3TreeViewPush(&pView, more);
drha1fd4b52018-07-10 06:32:53 +0000477 sqlite3TreeViewLine(pView, "WINFUNC %s(%d)",
drh105dcaa2022-03-10 16:01:14 +0000478 pWin->pWFunc->zName, pWin->pWFunc->nArg);
drha1fd4b52018-07-10 06:32:53 +0000479 sqlite3TreeViewWindow(pView, pWin, 0);
drh2a7dcbf2022-04-06 15:41:53 +0000480 sqlite3TreeViewPop(&pView);
drha1fd4b52018-07-10 06:32:53 +0000481}
482#endif /* SQLITE_OMIT_WINDOWFUNC */
483
drh38b41492015-06-08 15:08:15 +0000484/*
485** Generate a human-readable explanation of an expression tree.
486*/
487void sqlite3TreeViewExpr(TreeView *pView, const Expr *pExpr, u8 moreToFollow){
488 const char *zBinOp = 0; /* Binary operator */
489 const char *zUniOp = 0; /* Unary operator */
drhe7375bf2020-03-10 19:24:38 +0000490 char zFlgs[200];
drh2a7dcbf2022-04-06 15:41:53 +0000491 sqlite3TreeViewPush(&pView, moreToFollow);
drh38b41492015-06-08 15:08:15 +0000492 if( pExpr==0 ){
493 sqlite3TreeViewLine(pView, "nil");
drh2a7dcbf2022-04-06 15:41:53 +0000494 sqlite3TreeViewPop(&pView);
drh38b41492015-06-08 15:08:15 +0000495 return;
496 }
drh217e77d2022-11-26 20:48:56 +0000497 if( pExpr->flags || pExpr->affExpr || pExpr->vvaFlags || pExpr->pAggInfo ){
drhb7e51992020-01-08 14:39:57 +0000498 StrAccum x;
499 sqlite3StrAccumInit(&x, 0, zFlgs, sizeof(zFlgs), 0);
500 sqlite3_str_appendf(&x, " fg.af=%x.%c",
501 pExpr->flags, pExpr->affExpr ? pExpr->affExpr : 'n');
drh67a99db2022-05-13 14:52:04 +0000502 if( ExprHasProperty(pExpr, EP_OuterON) ){
drha6e8ee12022-05-13 16:38:40 +0000503 sqlite3_str_appendf(&x, " outer.iJoin=%d", pExpr->w.iJoin);
drhd97cda42017-04-14 14:02:14 +0000504 }
drh67a99db2022-05-13 14:52:04 +0000505 if( ExprHasProperty(pExpr, EP_InnerON) ){
drha6e8ee12022-05-13 16:38:40 +0000506 sqlite3_str_appendf(&x, " inner.iJoin=%d", pExpr->w.iJoin);
drh67a99db2022-05-13 14:52:04 +0000507 }
drhb7e51992020-01-08 14:39:57 +0000508 if( ExprHasProperty(pExpr, EP_FromDDL) ){
509 sqlite3_str_appendf(&x, " DDL");
510 }
drhe7375bf2020-03-10 19:24:38 +0000511 if( ExprHasVVAProperty(pExpr, EP_Immutable) ){
512 sqlite3_str_appendf(&x, " IMMUTABLE");
513 }
drh217e77d2022-11-26 20:48:56 +0000514 if( pExpr->pAggInfo!=0 ){
515 sqlite3_str_appendf(&x, " agg-column[%d]", pExpr->iAgg);
516 }
drhb7e51992020-01-08 14:39:57 +0000517 sqlite3StrAccumFinish(&x);
drhb3d903e2015-06-18 14:09:13 +0000518 }else{
519 zFlgs[0] = 0;
520 }
drh38b41492015-06-08 15:08:15 +0000521 switch( pExpr->op ){
522 case TK_AGG_COLUMN: {
drhb3d903e2015-06-18 14:09:13 +0000523 sqlite3TreeViewLine(pView, "AGG{%d:%d}%s",
524 pExpr->iTable, pExpr->iColumn, zFlgs);
drh38b41492015-06-08 15:08:15 +0000525 break;
526 }
527 case TK_COLUMN: {
528 if( pExpr->iTable<0 ){
529 /* This only happens when coding check constraints */
drhd4933532019-10-31 12:30:38 +0000530 char zOp2[16];
531 if( pExpr->op2 ){
532 sqlite3_snprintf(sizeof(zOp2),zOp2," op2=0x%02x",pExpr->op2);
533 }else{
534 zOp2[0] = 0;
535 }
536 sqlite3TreeViewLine(pView, "COLUMN(%d)%s%s",
537 pExpr->iColumn, zFlgs, zOp2);
drh38b41492015-06-08 15:08:15 +0000538 }else{
drh477572b2021-10-07 20:46:29 +0000539 assert( ExprUseYTab(pExpr) );
drha513e592019-12-20 20:08:56 +0000540 sqlite3TreeViewLine(pView, "{%d:%d} pTab=%p%s",
541 pExpr->iTable, pExpr->iColumn,
542 pExpr->y.pTab, zFlgs);
drh38b41492015-06-08 15:08:15 +0000543 }
drhefad2e22018-07-27 16:57:11 +0000544 if( ExprHasProperty(pExpr, EP_FixedCol) ){
545 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
546 }
drh38b41492015-06-08 15:08:15 +0000547 break;
548 }
549 case TK_INTEGER: {
550 if( pExpr->flags & EP_IntValue ){
551 sqlite3TreeViewLine(pView, "%d", pExpr->u.iValue);
552 }else{
553 sqlite3TreeViewLine(pView, "%s", pExpr->u.zToken);
554 }
555 break;
556 }
557#ifndef SQLITE_OMIT_FLOATING_POINT
558 case TK_FLOAT: {
drhf9751072021-10-07 13:40:29 +0000559 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000560 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
561 break;
562 }
563#endif
564 case TK_STRING: {
drhf9751072021-10-07 13:40:29 +0000565 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000566 sqlite3TreeViewLine(pView,"%Q", pExpr->u.zToken);
567 break;
568 }
569 case TK_NULL: {
570 sqlite3TreeViewLine(pView,"NULL");
571 break;
572 }
drh34328212018-02-26 19:03:25 +0000573 case TK_TRUEFALSE: {
drh348e0022021-07-22 16:07:01 +0000574 sqlite3TreeViewLine(pView,"%s%s",
575 sqlite3ExprTruthValue(pExpr) ? "TRUE" : "FALSE", zFlgs);
drh34328212018-02-26 19:03:25 +0000576 break;
577 }
drh38b41492015-06-08 15:08:15 +0000578#ifndef SQLITE_OMIT_BLOB_LITERAL
579 case TK_BLOB: {
drhf9751072021-10-07 13:40:29 +0000580 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000581 sqlite3TreeViewLine(pView,"%s", pExpr->u.zToken);
582 break;
583 }
584#endif
585 case TK_VARIABLE: {
drhf9751072021-10-07 13:40:29 +0000586 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000587 sqlite3TreeViewLine(pView,"VARIABLE(%s,%d)",
588 pExpr->u.zToken, pExpr->iColumn);
589 break;
590 }
591 case TK_REGISTER: {
592 sqlite3TreeViewLine(pView,"REGISTER(%d)", pExpr->iTable);
593 break;
594 }
drh38b41492015-06-08 15:08:15 +0000595 case TK_ID: {
drhf9751072021-10-07 13:40:29 +0000596 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000597 sqlite3TreeViewLine(pView,"ID \"%w\"", pExpr->u.zToken);
598 break;
599 }
600#ifndef SQLITE_OMIT_CAST
601 case TK_CAST: {
602 /* Expressions of the form: CAST(pLeft AS token) */
drhf9751072021-10-07 13:40:29 +0000603 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000604 sqlite3TreeViewLine(pView,"CAST %Q", pExpr->u.zToken);
605 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
606 break;
607 }
608#endif /* SQLITE_OMIT_CAST */
609 case TK_LT: zBinOp = "LT"; break;
610 case TK_LE: zBinOp = "LE"; break;
611 case TK_GT: zBinOp = "GT"; break;
612 case TK_GE: zBinOp = "GE"; break;
613 case TK_NE: zBinOp = "NE"; break;
614 case TK_EQ: zBinOp = "EQ"; break;
615 case TK_IS: zBinOp = "IS"; break;
616 case TK_ISNOT: zBinOp = "ISNOT"; break;
617 case TK_AND: zBinOp = "AND"; break;
618 case TK_OR: zBinOp = "OR"; break;
619 case TK_PLUS: zBinOp = "ADD"; break;
620 case TK_STAR: zBinOp = "MUL"; break;
621 case TK_MINUS: zBinOp = "SUB"; break;
622 case TK_REM: zBinOp = "REM"; break;
623 case TK_BITAND: zBinOp = "BITAND"; break;
624 case TK_BITOR: zBinOp = "BITOR"; break;
625 case TK_SLASH: zBinOp = "DIV"; break;
626 case TK_LSHIFT: zBinOp = "LSHIFT"; break;
627 case TK_RSHIFT: zBinOp = "RSHIFT"; break;
628 case TK_CONCAT: zBinOp = "CONCAT"; break;
629 case TK_DOT: zBinOp = "DOT"; break;
drhe7375bf2020-03-10 19:24:38 +0000630 case TK_LIMIT: zBinOp = "LIMIT"; break;
drh38b41492015-06-08 15:08:15 +0000631
632 case TK_UMINUS: zUniOp = "UMINUS"; break;
633 case TK_UPLUS: zUniOp = "UPLUS"; break;
634 case TK_BITNOT: zUniOp = "BITNOT"; break;
635 case TK_NOT: zUniOp = "NOT"; break;
636 case TK_ISNULL: zUniOp = "ISNULL"; break;
637 case TK_NOTNULL: zUniOp = "NOTNULL"; break;
638
drh34328212018-02-26 19:03:25 +0000639 case TK_TRUTH: {
drh43c4ac82018-02-26 21:26:27 +0000640 int x;
641 const char *azOp[] = {
642 "IS-FALSE", "IS-TRUE", "IS-NOT-FALSE", "IS-NOT-TRUE"
643 };
drh34328212018-02-26 19:03:25 +0000644 assert( pExpr->op2==TK_IS || pExpr->op2==TK_ISNOT );
645 assert( pExpr->pRight );
dan6ece3532019-06-12 13:49:32 +0000646 assert( sqlite3ExprSkipCollate(pExpr->pRight)->op==TK_TRUEFALSE );
drh96acafb2018-02-27 14:49:25 +0000647 x = (pExpr->op2==TK_ISNOT)*2 + sqlite3ExprTruthValue(pExpr->pRight);
drh43c4ac82018-02-26 21:26:27 +0000648 zUniOp = azOp[x];
drh34328212018-02-26 19:03:25 +0000649 break;
650 }
651
drh94fa9c42016-02-27 21:16:04 +0000652 case TK_SPAN: {
drhf9751072021-10-07 13:40:29 +0000653 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh94fa9c42016-02-27 21:16:04 +0000654 sqlite3TreeViewLine(pView, "SPAN %Q", pExpr->u.zToken);
655 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
656 break;
657 }
658
drh38b41492015-06-08 15:08:15 +0000659 case TK_COLLATE: {
drhc204d812019-09-10 17:51:27 +0000660 /* COLLATE operators without the EP_Collate flag are intended to
drh018dbb12019-09-28 16:14:55 +0000661 ** emulate collation associated with a table column. These show
662 ** up in the treeview output as "SOFT-COLLATE". Explicit COLLATE
663 ** operators that appear in the original SQL always have the
664 ** EP_Collate bit set and appear in treeview output as just "COLLATE" */
drhf9751072021-10-07 13:40:29 +0000665 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drhc204d812019-09-10 17:51:27 +0000666 sqlite3TreeViewLine(pView, "%sCOLLATE %Q%s",
667 !ExprHasProperty(pExpr, EP_Collate) ? "SOFT-" : "",
668 pExpr->u.zToken, zFlgs);
drh38b41492015-06-08 15:08:15 +0000669 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
670 break;
671 }
672
673 case TK_AGG_FUNCTION:
674 case TK_FUNCTION: {
675 ExprList *pFarg; /* List of function arguments */
drha1fd4b52018-07-10 06:32:53 +0000676 Window *pWin;
drh38b41492015-06-08 15:08:15 +0000677 if( ExprHasProperty(pExpr, EP_TokenOnly) ){
678 pFarg = 0;
drha1fd4b52018-07-10 06:32:53 +0000679 pWin = 0;
drh38b41492015-06-08 15:08:15 +0000680 }else{
drha4eeccd2021-10-07 17:43:30 +0000681 assert( ExprUseXList(pExpr) );
drh38b41492015-06-08 15:08:15 +0000682 pFarg = pExpr->x.pList;
drha1fd4b52018-07-10 06:32:53 +0000683#ifndef SQLITE_OMIT_WINDOWFUNC
drh014fff22020-01-08 22:22:36 +0000684 pWin = ExprHasProperty(pExpr, EP_WinFunc) ? pExpr->y.pWin : 0;
drha1fd4b52018-07-10 06:32:53 +0000685#else
686 pWin = 0;
687#endif
drh38b41492015-06-08 15:08:15 +0000688 }
drhf9751072021-10-07 13:40:29 +0000689 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000690 if( pExpr->op==TK_AGG_FUNCTION ){
drhe26d4282020-06-09 11:59:15 +0000691 sqlite3TreeViewLine(pView, "AGG_FUNCTION%d %Q%s agg=%d[%d]/%p",
drhca74fbf2020-05-24 02:05:04 +0000692 pExpr->op2, pExpr->u.zToken, zFlgs,
drhe26d4282020-06-09 11:59:15 +0000693 pExpr->pAggInfo ? pExpr->pAggInfo->selId : 0,
drhca74fbf2020-05-24 02:05:04 +0000694 pExpr->iAgg, pExpr->pAggInfo);
drhd4933532019-10-31 12:30:38 +0000695 }else if( pExpr->op2!=0 ){
696 const char *zOp2;
697 char zBuf[8];
698 sqlite3_snprintf(sizeof(zBuf),zBuf,"0x%02x",pExpr->op2);
699 zOp2 = zBuf;
700 if( pExpr->op2==NC_IsCheck ) zOp2 = "NC_IsCheck";
701 if( pExpr->op2==NC_IdxExpr ) zOp2 = "NC_IdxExpr";
702 if( pExpr->op2==NC_PartIdx ) zOp2 = "NC_PartIdx";
703 if( pExpr->op2==NC_GenCol ) zOp2 = "NC_GenCol";
704 sqlite3TreeViewLine(pView, "FUNCTION %Q%s op2=%s",
705 pExpr->u.zToken, zFlgs, zOp2);
drh38b41492015-06-08 15:08:15 +0000706 }else{
drh42d2fce2019-08-15 20:04:09 +0000707 sqlite3TreeViewLine(pView, "FUNCTION %Q%s", pExpr->u.zToken, zFlgs);
drh38b41492015-06-08 15:08:15 +0000708 }
709 if( pFarg ){
drha1fd4b52018-07-10 06:32:53 +0000710 sqlite3TreeViewExprList(pView, pFarg, pWin!=0, 0);
drh38b41492015-06-08 15:08:15 +0000711 }
mistachkin14897852018-07-23 18:53:49 +0000712#ifndef SQLITE_OMIT_WINDOWFUNC
drha1fd4b52018-07-10 06:32:53 +0000713 if( pWin ){
714 sqlite3TreeViewWindow(pView, pWin, 0);
715 }
716#endif
drh38b41492015-06-08 15:08:15 +0000717 break;
718 }
719#ifndef SQLITE_OMIT_SUBQUERY
720 case TK_EXISTS: {
drha4eeccd2021-10-07 17:43:30 +0000721 assert( ExprUseXSelect(pExpr) );
drh9f6e14c2017-07-10 13:24:58 +0000722 sqlite3TreeViewLine(pView, "EXISTS-expr flags=0x%x", pExpr->flags);
drh38b41492015-06-08 15:08:15 +0000723 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
724 break;
725 }
726 case TK_SELECT: {
drha4eeccd2021-10-07 17:43:30 +0000727 assert( ExprUseXSelect(pExpr) );
drha0365c42020-06-05 04:01:50 +0000728 sqlite3TreeViewLine(pView, "subquery-expr flags=0x%x", pExpr->flags);
drh38b41492015-06-08 15:08:15 +0000729 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
730 break;
731 }
732 case TK_IN: {
drhc64f0e72022-04-30 00:05:37 +0000733 sqlite3_str *pStr = sqlite3_str_new(0);
734 char *z;
735 sqlite3_str_appendf(pStr, "IN flags=0x%x", pExpr->flags);
736 if( pExpr->iTable ) sqlite3_str_appendf(pStr, " iTable=%d",pExpr->iTable);
737 if( ExprHasProperty(pExpr, EP_Subrtn) ){
738 sqlite3_str_appendf(pStr, " subrtn(%d,%d)",
739 pExpr->y.sub.regReturn, pExpr->y.sub.iAddr);
740 }
741 z = sqlite3_str_finish(pStr);
742 sqlite3TreeViewLine(pView, z);
743 sqlite3_free(z);
drh38b41492015-06-08 15:08:15 +0000744 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
drha4eeccd2021-10-07 17:43:30 +0000745 if( ExprUseXSelect(pExpr) ){
drh38b41492015-06-08 15:08:15 +0000746 sqlite3TreeViewSelect(pView, pExpr->x.pSelect, 0);
747 }else{
748 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
749 }
750 break;
751 }
752#endif /* SQLITE_OMIT_SUBQUERY */
753
754 /*
755 ** x BETWEEN y AND z
756 **
757 ** This is equivalent to
758 **
759 ** x>=y AND x<=z
760 **
761 ** X is stored in pExpr->pLeft.
762 ** Y is stored in pExpr->pList->a[0].pExpr.
763 ** Z is stored in pExpr->pList->a[1].pExpr.
764 */
765 case TK_BETWEEN: {
drha4eeccd2021-10-07 17:43:30 +0000766 const Expr *pX, *pY, *pZ;
767 pX = pExpr->pLeft;
768 assert( ExprUseXList(pExpr) );
769 assert( pExpr->x.pList->nExpr==2 );
770 pY = pExpr->x.pList->a[0].pExpr;
771 pZ = pExpr->x.pList->a[1].pExpr;
drh38b41492015-06-08 15:08:15 +0000772 sqlite3TreeViewLine(pView, "BETWEEN");
773 sqlite3TreeViewExpr(pView, pX, 1);
774 sqlite3TreeViewExpr(pView, pY, 1);
775 sqlite3TreeViewExpr(pView, pZ, 0);
776 break;
777 }
778 case TK_TRIGGER: {
779 /* If the opcode is TK_TRIGGER, then the expression is a reference
780 ** to a column in the new.* or old.* pseudo-tables available to
781 ** trigger programs. In this case Expr.iTable is set to 1 for the
782 ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
783 ** is set to the column of the pseudo-table to read, or to -1 to
784 ** read the rowid field.
785 */
786 sqlite3TreeViewLine(pView, "%s(%d)",
787 pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
788 break;
789 }
790 case TK_CASE: {
791 sqlite3TreeViewLine(pView, "CASE");
792 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
drha4eeccd2021-10-07 17:43:30 +0000793 assert( ExprUseXList(pExpr) );
drh38b41492015-06-08 15:08:15 +0000794 sqlite3TreeViewExprList(pView, pExpr->x.pList, 0, 0);
795 break;
796 }
797#ifndef SQLITE_OMIT_TRIGGER
798 case TK_RAISE: {
799 const char *zType = "unk";
drh11949042019-08-05 18:01:42 +0000800 switch( pExpr->affExpr ){
drh38b41492015-06-08 15:08:15 +0000801 case OE_Rollback: zType = "rollback"; break;
802 case OE_Abort: zType = "abort"; break;
803 case OE_Fail: zType = "fail"; break;
804 case OE_Ignore: zType = "ignore"; break;
805 }
drhf9751072021-10-07 13:40:29 +0000806 assert( !ExprHasProperty(pExpr, EP_IntValue) );
drh38b41492015-06-08 15:08:15 +0000807 sqlite3TreeViewLine(pView, "RAISE %s(%Q)", zType, pExpr->u.zToken);
808 break;
809 }
810#endif
drhc84a4022016-05-27 12:30:20 +0000811 case TK_MATCH: {
812 sqlite3TreeViewLine(pView, "MATCH {%d:%d}%s",
813 pExpr->iTable, pExpr->iColumn, zFlgs);
814 sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
815 break;
816 }
drhdb97e562016-08-18 17:55:57 +0000817 case TK_VECTOR: {
drh269d3222019-10-23 18:09:39 +0000818 char *z = sqlite3_mprintf("VECTOR%s",zFlgs);
drha4eeccd2021-10-07 17:43:30 +0000819 assert( ExprUseXList(pExpr) );
drh269d3222019-10-23 18:09:39 +0000820 sqlite3TreeViewBareExprList(pView, pExpr->x.pList, z);
821 sqlite3_free(z);
drhdb97e562016-08-18 17:55:57 +0000822 break;
823 }
drh48cb3a72016-08-18 18:09:10 +0000824 case TK_SELECT_COLUMN: {
drhe46292a2021-07-05 02:40:29 +0000825 sqlite3TreeViewLine(pView, "SELECT-COLUMN %d of [0..%d]%s",
826 pExpr->iColumn, pExpr->iTable-1,
827 pExpr->pRight==pExpr->pLeft ? " (SELECT-owner)" : "");
drha4eeccd2021-10-07 17:43:30 +0000828 assert( ExprUseXSelect(pExpr->pLeft) );
drh48cb3a72016-08-18 18:09:10 +0000829 sqlite3TreeViewSelect(pView, pExpr->pLeft->x.pSelect, 0);
830 break;
831 }
drh31d6fd52017-04-14 19:03:10 +0000832 case TK_IF_NULL_ROW: {
833 sqlite3TreeViewLine(pView, "IF-NULL-ROW %d", pExpr->iTable);
834 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
835 break;
836 }
drhbf7f3a02021-05-24 11:35:16 +0000837 case TK_ERROR: {
838 Expr tmp;
839 sqlite3TreeViewLine(pView, "ERROR");
840 tmp = *pExpr;
841 tmp.op = pExpr->op2;
842 sqlite3TreeViewExpr(pView, &tmp, 0);
843 break;
844 }
drh4a4e02b2021-07-04 22:33:08 +0000845 case TK_ROW: {
846 if( pExpr->iColumn<=0 ){
847 sqlite3TreeViewLine(pView, "First FROM table rowid");
848 }else{
849 sqlite3TreeViewLine(pView, "First FROM table column %d",
850 pExpr->iColumn-1);
851 }
852 break;
853 }
drh38b41492015-06-08 15:08:15 +0000854 default: {
855 sqlite3TreeViewLine(pView, "op=%d", pExpr->op);
856 break;
857 }
858 }
859 if( zBinOp ){
drhb3d903e2015-06-18 14:09:13 +0000860 sqlite3TreeViewLine(pView, "%s%s", zBinOp, zFlgs);
drh38b41492015-06-08 15:08:15 +0000861 sqlite3TreeViewExpr(pView, pExpr->pLeft, 1);
862 sqlite3TreeViewExpr(pView, pExpr->pRight, 0);
863 }else if( zUniOp ){
drhb3d903e2015-06-18 14:09:13 +0000864 sqlite3TreeViewLine(pView, "%s%s", zUniOp, zFlgs);
drh11949042019-08-05 18:01:42 +0000865 sqlite3TreeViewExpr(pView, pExpr->pLeft, 0);
drh38b41492015-06-08 15:08:15 +0000866 }
drh2a7dcbf2022-04-06 15:41:53 +0000867 sqlite3TreeViewPop(&pView);
drh38b41492015-06-08 15:08:15 +0000868}
869
drhdb97e562016-08-18 17:55:57 +0000870
drh38b41492015-06-08 15:08:15 +0000871/*
872** Generate a human-readable explanation of an expression list.
873*/
drhdb97e562016-08-18 17:55:57 +0000874void sqlite3TreeViewBareExprList(
drh38b41492015-06-08 15:08:15 +0000875 TreeView *pView,
876 const ExprList *pList,
drh38b41492015-06-08 15:08:15 +0000877 const char *zLabel
878){
drh38b41492015-06-08 15:08:15 +0000879 if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
880 if( pList==0 ){
881 sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
882 }else{
drhdb97e562016-08-18 17:55:57 +0000883 int i;
drh38b41492015-06-08 15:08:15 +0000884 sqlite3TreeViewLine(pView, "%s", zLabel);
885 for(i=0; i<pList->nExpr; i++){
drh5579d592015-08-26 14:01:41 +0000886 int j = pList->a[i].u.x.iOrderByCol;
drh41cee662019-12-12 20:22:34 +0000887 char *zName = pList->a[i].zEName;
drhfbe07532018-04-23 20:04:38 +0000888 int moreToFollow = i<pList->nExpr - 1;
drh5a699a02017-12-22 19:53:02 +0000889 if( j || zName ){
drh2a7dcbf2022-04-06 15:41:53 +0000890 sqlite3TreeViewPush(&pView, moreToFollow);
drhfbe07532018-04-23 20:04:38 +0000891 moreToFollow = 0;
892 sqlite3TreeViewLine(pView, 0);
893 if( zName ){
drhd88fd532022-05-02 20:49:30 +0000894 switch( pList->a[i].fg.eEName ){
drhd4e9caf2022-04-20 12:14:20 +0000895 default:
896 fprintf(stdout, "AS %s ", zName);
897 break;
898 case ENAME_TAB:
899 fprintf(stdout, "TABLE-ALIAS-NAME(\"%s\") ", zName);
drhd88fd532022-05-02 20:49:30 +0000900 if( pList->a[i].fg.bUsed ) fprintf(stdout, "(used) ");
901 if( pList->a[i].fg.bUsingTerm ) fprintf(stdout, "(USING-term) ");
902 if( pList->a[i].fg.bNoExpand ) fprintf(stdout, "(NoExpand) ");
drhd4e9caf2022-04-20 12:14:20 +0000903 break;
904 case ENAME_SPAN:
905 fprintf(stdout, "SPAN(\"%s\") ", zName);
906 break;
907 }
drhfbe07532018-04-23 20:04:38 +0000908 }
909 if( j ){
910 fprintf(stdout, "iOrderByCol=%d", j);
911 }
912 fprintf(stdout, "\n");
913 fflush(stdout);
drh5a699a02017-12-22 19:53:02 +0000914 }
drhfbe07532018-04-23 20:04:38 +0000915 sqlite3TreeViewExpr(pView, pList->a[i].pExpr, moreToFollow);
drh5a699a02017-12-22 19:53:02 +0000916 if( j || zName ){
drh2a7dcbf2022-04-06 15:41:53 +0000917 sqlite3TreeViewPop(&pView);
drh5a699a02017-12-22 19:53:02 +0000918 }
drh38b41492015-06-08 15:08:15 +0000919 }
920 }
drhdb97e562016-08-18 17:55:57 +0000921}
922void sqlite3TreeViewExprList(
923 TreeView *pView,
924 const ExprList *pList,
925 u8 moreToFollow,
926 const char *zLabel
927){
drh2a7dcbf2022-04-06 15:41:53 +0000928 sqlite3TreeViewPush(&pView, moreToFollow);
drhdb97e562016-08-18 17:55:57 +0000929 sqlite3TreeViewBareExprList(pView, pList, zLabel);
drh2a7dcbf2022-04-06 15:41:53 +0000930 sqlite3TreeViewPop(&pView);
drh38b41492015-06-08 15:08:15 +0000931}
932
drh7d2c1d22022-04-06 00:29:21 +0000933/*
934** Generate a human-readable explanation of an id-list.
935*/
936void sqlite3TreeViewBareIdList(
937 TreeView *pView,
938 const IdList *pList,
939 const char *zLabel
940){
941 if( zLabel==0 || zLabel[0]==0 ) zLabel = "LIST";
942 if( pList==0 ){
943 sqlite3TreeViewLine(pView, "%s (empty)", zLabel);
944 }else{
945 int i;
946 sqlite3TreeViewLine(pView, "%s", zLabel);
947 for(i=0; i<pList->nId; i++){
948 char *zName = pList->a[i].zName;
949 int moreToFollow = i<pList->nId - 1;
950 if( zName==0 ) zName = "(null)";
drh2a7dcbf2022-04-06 15:41:53 +0000951 sqlite3TreeViewPush(&pView, moreToFollow);
drh7d2c1d22022-04-06 00:29:21 +0000952 sqlite3TreeViewLine(pView, 0);
drha99e3252022-04-15 15:47:14 +0000953 if( pList->eU4==EU4_NONE ){
954 fprintf(stdout, "%s\n", zName);
955 }else if( pList->eU4==EU4_IDX ){
956 fprintf(stdout, "%s (%d)\n", zName, pList->a[i].u4.idx);
957 }else{
958 assert( pList->eU4==EU4_EXPR );
959 if( pList->a[i].u4.pExpr==0 ){
960 fprintf(stdout, "%s (pExpr=NULL)\n", zName);
961 }else{
962 fprintf(stdout, "%s\n", zName);
963 sqlite3TreeViewPush(&pView, i<pList->nId-1);
964 sqlite3TreeViewExpr(pView, pList->a[i].u4.pExpr, 0);
965 sqlite3TreeViewPop(&pView);
966 }
967 }
drh2a7dcbf2022-04-06 15:41:53 +0000968 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +0000969 }
970 }
971}
972void sqlite3TreeViewIdList(
973 TreeView *pView,
974 const IdList *pList,
975 u8 moreToFollow,
976 const char *zLabel
977){
drh2a7dcbf2022-04-06 15:41:53 +0000978 sqlite3TreeViewPush(&pView, moreToFollow);
drh7d2c1d22022-04-06 00:29:21 +0000979 sqlite3TreeViewBareIdList(pView, pList, zLabel);
drh2a7dcbf2022-04-06 15:41:53 +0000980 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +0000981}
982
983/*
984** Generate a human-readable explanation of a list of Upsert objects
985*/
986void sqlite3TreeViewUpsert(
987 TreeView *pView,
988 const Upsert *pUpsert,
989 u8 moreToFollow
990){
991 if( pUpsert==0 ) return;
drh2a7dcbf2022-04-06 15:41:53 +0000992 sqlite3TreeViewPush(&pView, moreToFollow);
drh7d2c1d22022-04-06 00:29:21 +0000993 while( pUpsert ){
994 int n;
drh2a7dcbf2022-04-06 15:41:53 +0000995 sqlite3TreeViewPush(&pView, pUpsert->pNextUpsert!=0 || moreToFollow);
drh7d2c1d22022-04-06 00:29:21 +0000996 sqlite3TreeViewLine(pView, "ON CONFLICT DO %s",
997 pUpsert->isDoUpdate ? "UPDATE" : "NOTHING");
998 n = (pUpsert->pUpsertSet!=0) + (pUpsert->pUpsertWhere!=0);
999 sqlite3TreeViewExprList(pView, pUpsert->pUpsertTarget, (n--)>0, "TARGET");
1000 sqlite3TreeViewExprList(pView, pUpsert->pUpsertSet, (n--)>0, "SET");
1001 if( pUpsert->pUpsertWhere ){
1002 sqlite3TreeViewItem(pView, "WHERE", (n--)>0);
1003 sqlite3TreeViewExpr(pView, pUpsert->pUpsertWhere, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001004 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001005 }
drh2a7dcbf2022-04-06 15:41:53 +00001006 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001007 pUpsert = pUpsert->pNextUpsert;
1008 }
drh2a7dcbf2022-04-06 15:41:53 +00001009 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001010}
1011
drhf1ab6422022-07-11 18:26:14 +00001012#if TREETRACE_ENABLED
drh7d2c1d22022-04-06 00:29:21 +00001013/*
1014** Generate a human-readable diagram of the data structure that go
drhf8ef2db2022-04-06 10:37:44 +00001015** into generating an DELETE statement.
1016*/
1017void sqlite3TreeViewDelete(
drhf8ef2db2022-04-06 10:37:44 +00001018 const With *pWith,
1019 const SrcList *pTabList,
1020 const Expr *pWhere,
1021 const ExprList *pOrderBy,
drh2a7dcbf2022-04-06 15:41:53 +00001022 const Expr *pLimit,
1023 const Trigger *pTrigger
drhf8ef2db2022-04-06 10:37:44 +00001024){
1025 int n = 0;
drh2a7dcbf2022-04-06 15:41:53 +00001026 TreeView *pView = 0;
1027 sqlite3TreeViewPush(&pView, 0);
drhf8ef2db2022-04-06 10:37:44 +00001028 sqlite3TreeViewLine(pView, "DELETE");
drhf8ef2db2022-04-06 10:37:44 +00001029 if( pWith ) n++;
1030 if( pTabList ) n++;
1031 if( pWhere ) n++;
1032 if( pOrderBy ) n++;
1033 if( pLimit ) n++;
drh2a7dcbf2022-04-06 15:41:53 +00001034 if( pTrigger ) n++;
drhf8ef2db2022-04-06 10:37:44 +00001035 if( pWith ){
drh2a7dcbf2022-04-06 15:41:53 +00001036 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001037 sqlite3TreeViewWith(pView, pWith, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001038 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001039 }
1040 if( pTabList ){
drh2a7dcbf2022-04-06 15:41:53 +00001041 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001042 sqlite3TreeViewLine(pView, "FROM");
1043 sqlite3TreeViewSrcList(pView, pTabList);
drh2a7dcbf2022-04-06 15:41:53 +00001044 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001045 }
1046 if( pWhere ){
drh2a7dcbf2022-04-06 15:41:53 +00001047 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001048 sqlite3TreeViewLine(pView, "WHERE");
1049 sqlite3TreeViewExpr(pView, pWhere, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001050 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001051 }
1052 if( pOrderBy ){
1053 sqlite3TreeViewExprList(pView, pOrderBy, (--n)>0, "ORDER-BY");
1054 }
1055 if( pLimit ){
drh2a7dcbf2022-04-06 15:41:53 +00001056 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001057 sqlite3TreeViewLine(pView, "LIMIT");
1058 sqlite3TreeViewExpr(pView, pLimit, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001059 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001060 }
drh2a7dcbf2022-04-06 15:41:53 +00001061 if( pTrigger ){
1062 sqlite3TreeViewTrigger(pView, pTrigger, (--n)>0, 1);
1063 }
1064 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001065}
drhf1ab6422022-07-11 18:26:14 +00001066#endif /* TREETRACE_ENABLED */
drhf8ef2db2022-04-06 10:37:44 +00001067
drhf1ab6422022-07-11 18:26:14 +00001068#if TREETRACE_ENABLED
drhf8ef2db2022-04-06 10:37:44 +00001069/*
1070** Generate a human-readable diagram of the data structure that go
drh7d2c1d22022-04-06 00:29:21 +00001071** into generating an INSERT statement.
1072*/
1073void sqlite3TreeViewInsert(
drh7d2c1d22022-04-06 00:29:21 +00001074 const With *pWith,
1075 const SrcList *pTabList,
1076 const IdList *pColumnList,
1077 const Select *pSelect,
drhc2d0df92022-04-06 18:30:17 +00001078 const ExprList *pExprList,
drh7d2c1d22022-04-06 00:29:21 +00001079 int onError,
drh2a7dcbf2022-04-06 15:41:53 +00001080 const Upsert *pUpsert,
1081 const Trigger *pTrigger
drh7d2c1d22022-04-06 00:29:21 +00001082){
drh2a7dcbf2022-04-06 15:41:53 +00001083 TreeView *pView = 0;
drh7d2c1d22022-04-06 00:29:21 +00001084 int n = 0;
1085 const char *zLabel = "INSERT";
1086 switch( onError ){
1087 case OE_Replace: zLabel = "REPLACE"; break;
1088 case OE_Ignore: zLabel = "INSERT OR IGNORE"; break;
1089 case OE_Rollback: zLabel = "INSERT OR ROLLBACK"; break;
1090 case OE_Abort: zLabel = "INSERT OR ABORT"; break;
1091 case OE_Fail: zLabel = "INSERT OR FAIL"; break;
1092 }
drh2a7dcbf2022-04-06 15:41:53 +00001093 sqlite3TreeViewPush(&pView, 0);
drh7d2c1d22022-04-06 00:29:21 +00001094 sqlite3TreeViewLine(pView, zLabel);
drh7d2c1d22022-04-06 00:29:21 +00001095 if( pWith ) n++;
1096 if( pTabList ) n++;
1097 if( pColumnList ) n++;
1098 if( pSelect ) n++;
drhc2d0df92022-04-06 18:30:17 +00001099 if( pExprList ) n++;
drh7d2c1d22022-04-06 00:29:21 +00001100 if( pUpsert ) n++;
drh2a7dcbf2022-04-06 15:41:53 +00001101 if( pTrigger ) n++;
drh7d2c1d22022-04-06 00:29:21 +00001102 if( pWith ){
drh2a7dcbf2022-04-06 15:41:53 +00001103 sqlite3TreeViewPush(&pView, (--n)>0);
drh7d2c1d22022-04-06 00:29:21 +00001104 sqlite3TreeViewWith(pView, pWith, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001105 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001106 }
1107 if( pTabList ){
drh2a7dcbf2022-04-06 15:41:53 +00001108 sqlite3TreeViewPush(&pView, (--n)>0);
drh7d2c1d22022-04-06 00:29:21 +00001109 sqlite3TreeViewLine(pView, "INTO");
1110 sqlite3TreeViewSrcList(pView, pTabList);
drh2a7dcbf2022-04-06 15:41:53 +00001111 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001112 }
1113 if( pColumnList ){
1114 sqlite3TreeViewIdList(pView, pColumnList, (--n)>0, "COLUMNS");
1115 }
1116 if( pSelect ){
drh2a7dcbf2022-04-06 15:41:53 +00001117 sqlite3TreeViewPush(&pView, (--n)>0);
drh7d2c1d22022-04-06 00:29:21 +00001118 sqlite3TreeViewLine(pView, "DATA-SOURCE");
1119 sqlite3TreeViewSelect(pView, pSelect, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001120 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001121 }
drhc2d0df92022-04-06 18:30:17 +00001122 if( pExprList ){
1123 sqlite3TreeViewExprList(pView, pExprList, (--n)>0, "VALUES");
1124 }
drh7d2c1d22022-04-06 00:29:21 +00001125 if( pUpsert ){
drh2a7dcbf2022-04-06 15:41:53 +00001126 sqlite3TreeViewPush(&pView, (--n)>0);
drh7d2c1d22022-04-06 00:29:21 +00001127 sqlite3TreeViewLine(pView, "UPSERT");
1128 sqlite3TreeViewUpsert(pView, pUpsert, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001129 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001130 }
drh2a7dcbf2022-04-06 15:41:53 +00001131 if( pTrigger ){
1132 sqlite3TreeViewTrigger(pView, pTrigger, (--n)>0, 1);
1133 }
1134 sqlite3TreeViewPop(&pView);
drh7d2c1d22022-04-06 00:29:21 +00001135}
drhf1ab6422022-07-11 18:26:14 +00001136#endif /* TREETRACE_ENABLED */
drh7d2c1d22022-04-06 00:29:21 +00001137
drhf1ab6422022-07-11 18:26:14 +00001138#if TREETRACE_ENABLED
drhf8ef2db2022-04-06 10:37:44 +00001139/*
1140** Generate a human-readable diagram of the data structure that go
1141** into generating an UPDATE statement.
1142*/
1143void sqlite3TreeViewUpdate(
drhf8ef2db2022-04-06 10:37:44 +00001144 const With *pWith,
1145 const SrcList *pTabList,
1146 const ExprList *pChanges,
1147 const Expr *pWhere,
1148 int onError,
1149 const ExprList *pOrderBy,
1150 const Expr *pLimit,
drh2a7dcbf2022-04-06 15:41:53 +00001151 const Upsert *pUpsert,
1152 const Trigger *pTrigger
drhf8ef2db2022-04-06 10:37:44 +00001153){
1154 int n = 0;
drh2a7dcbf2022-04-06 15:41:53 +00001155 TreeView *pView = 0;
drhf8ef2db2022-04-06 10:37:44 +00001156 const char *zLabel = "UPDATE";
1157 switch( onError ){
1158 case OE_Replace: zLabel = "UPDATE OR REPLACE"; break;
1159 case OE_Ignore: zLabel = "UPDATE OR IGNORE"; break;
1160 case OE_Rollback: zLabel = "UPDATE OR ROLLBACK"; break;
1161 case OE_Abort: zLabel = "UPDATE OR ABORT"; break;
1162 case OE_Fail: zLabel = "UPDATE OR FAIL"; break;
1163 }
drh2a7dcbf2022-04-06 15:41:53 +00001164 sqlite3TreeViewPush(&pView, 0);
drhf8ef2db2022-04-06 10:37:44 +00001165 sqlite3TreeViewLine(pView, zLabel);
drhf8ef2db2022-04-06 10:37:44 +00001166 if( pWith ) n++;
1167 if( pTabList ) n++;
1168 if( pChanges ) n++;
1169 if( pWhere ) n++;
1170 if( pOrderBy ) n++;
1171 if( pLimit ) n++;
1172 if( pUpsert ) n++;
drh2a7dcbf2022-04-06 15:41:53 +00001173 if( pTrigger ) n++;
drhf8ef2db2022-04-06 10:37:44 +00001174 if( pWith ){
drh2a7dcbf2022-04-06 15:41:53 +00001175 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001176 sqlite3TreeViewWith(pView, pWith, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001177 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001178 }
1179 if( pTabList ){
drh2a7dcbf2022-04-06 15:41:53 +00001180 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001181 sqlite3TreeViewLine(pView, "FROM");
1182 sqlite3TreeViewSrcList(pView, pTabList);
drh2a7dcbf2022-04-06 15:41:53 +00001183 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001184 }
1185 if( pChanges ){
1186 sqlite3TreeViewExprList(pView, pChanges, (--n)>0, "SET");
1187 }
1188 if( pWhere ){
drh2a7dcbf2022-04-06 15:41:53 +00001189 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001190 sqlite3TreeViewLine(pView, "WHERE");
1191 sqlite3TreeViewExpr(pView, pWhere, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001192 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001193 }
1194 if( pOrderBy ){
1195 sqlite3TreeViewExprList(pView, pOrderBy, (--n)>0, "ORDER-BY");
1196 }
1197 if( pLimit ){
drh2a7dcbf2022-04-06 15:41:53 +00001198 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001199 sqlite3TreeViewLine(pView, "LIMIT");
1200 sqlite3TreeViewExpr(pView, pLimit, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001201 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001202 }
1203 if( pUpsert ){
drh2a7dcbf2022-04-06 15:41:53 +00001204 sqlite3TreeViewPush(&pView, (--n)>0);
drhf8ef2db2022-04-06 10:37:44 +00001205 sqlite3TreeViewLine(pView, "UPSERT");
1206 sqlite3TreeViewUpsert(pView, pUpsert, 0);
drh2a7dcbf2022-04-06 15:41:53 +00001207 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001208 }
drh2a7dcbf2022-04-06 15:41:53 +00001209 if( pTrigger ){
1210 sqlite3TreeViewTrigger(pView, pTrigger, (--n)>0, 1);
1211 }
1212 sqlite3TreeViewPop(&pView);
drhf8ef2db2022-04-06 10:37:44 +00001213}
drhf1ab6422022-07-11 18:26:14 +00001214#endif /* TREETRACE_ENABLED */
drhf8ef2db2022-04-06 10:37:44 +00001215
drh2a7dcbf2022-04-06 15:41:53 +00001216#ifndef SQLITE_OMIT_TRIGGER
1217/*
1218** Show a human-readable graph of a TriggerStep
1219*/
1220void sqlite3TreeViewTriggerStep(
1221 TreeView *pView,
1222 const TriggerStep *pStep,
1223 u8 moreToFollow,
1224 u8 showFullList
1225){
1226 int cnt = 0;
1227 if( pStep==0 ) return;
1228 sqlite3TreeViewPush(&pView,
1229 moreToFollow || (showFullList && pStep->pNext!=0));
1230 do{
1231 if( cnt++ && pStep->pNext==0 ){
1232 sqlite3TreeViewPop(&pView);
1233 sqlite3TreeViewPush(&pView, 0);
1234 }
1235 sqlite3TreeViewLine(pView, "%s", pStep->zSpan ? pStep->zSpan : "RETURNING");
1236 }while( showFullList && (pStep = pStep->pNext)!=0 );
1237 sqlite3TreeViewPop(&pView);
1238}
1239
1240/*
1241** Show a human-readable graph of a Trigger
1242*/
1243void sqlite3TreeViewTrigger(
1244 TreeView *pView,
1245 const Trigger *pTrigger,
1246 u8 moreToFollow,
1247 u8 showFullList
1248){
1249 int cnt = 0;
1250 if( pTrigger==0 ) return;
1251 sqlite3TreeViewPush(&pView,
1252 moreToFollow || (showFullList && pTrigger->pNext!=0));
1253 do{
1254 if( cnt++ && pTrigger->pNext==0 ){
1255 sqlite3TreeViewPop(&pView);
1256 sqlite3TreeViewPush(&pView, 0);
1257 }
1258 sqlite3TreeViewLine(pView, "TRIGGER %s", pTrigger->zName);
1259 sqlite3TreeViewPush(&pView, 0);
1260 sqlite3TreeViewTriggerStep(pView, pTrigger->step_list, 0, 1);
1261 sqlite3TreeViewPop(&pView);
1262 }while( showFullList && (pTrigger = pTrigger->pNext)!=0 );
1263 sqlite3TreeViewPop(&pView);
1264}
1265#endif /* SQLITE_OMIT_TRIGGER */
1266
1267
drh8f1eb6f2022-04-06 12:25:04 +00001268/*
1269** These simplified versions of the tree-view routines omit unnecessary
1270** parameters. These variants are intended to be used from a symbolic
1271** debugger, such as "gdb", during interactive debugging sessions.
1272**
1273** This routines are given external linkage so that they will always be
1274** accessible to the debugging, and to avoid warnings about unused
1275** functions. But these routines only exist in debugging builds, so they
1276** do not contaminate the interface.
1277*/
1278void sqlite3ShowExpr(const Expr *p){ sqlite3TreeViewExpr(0,p,0); }
1279void sqlite3ShowExprList(const ExprList *p){ sqlite3TreeViewExprList(0,p,0,0);}
1280void sqlite3ShowIdList(const IdList *p){ sqlite3TreeViewIdList(0,p,0,0); }
1281void sqlite3ShowSrcList(const SrcList *p){ sqlite3TreeViewSrcList(0,p); }
1282void sqlite3ShowSelect(const Select *p){ sqlite3TreeViewSelect(0,p,0); }
1283void sqlite3ShowWith(const With *p){ sqlite3TreeViewWith(0,p,0); }
1284void sqlite3ShowUpsert(const Upsert *p){ sqlite3TreeViewUpsert(0,p,0); }
drh2a7dcbf2022-04-06 15:41:53 +00001285#ifndef SQLITE_OMIT_TRIGGER
1286void sqlite3ShowTriggerStep(const TriggerStep *p){
1287 sqlite3TreeViewTriggerStep(0,p,0,0);
1288}
1289void sqlite3ShowTriggerStepList(const TriggerStep *p){
1290 sqlite3TreeViewTriggerStep(0,p,0,1);
1291}
1292void sqlite3ShowTrigger(const Trigger *p){ sqlite3TreeViewTrigger(0,p,0,0); }
1293void sqlite3ShowTriggerList(const Trigger *p){ sqlite3TreeViewTrigger(0,p,0,1);}
1294#endif
drh8f1eb6f2022-04-06 12:25:04 +00001295#ifndef SQLITE_OMIT_WINDOWFUNC
1296void sqlite3ShowWindow(const Window *p){ sqlite3TreeViewWindow(0,p,0); }
1297void sqlite3ShowWinFunc(const Window *p){ sqlite3TreeViewWinFunc(0,p,0); }
1298#endif
1299
drh38b41492015-06-08 15:08:15 +00001300#endif /* SQLITE_DEBUG */