xref: /sqlite-3.40.0/src/walker.c (revision 4f9adee2)
1 /*
2 ** 2008 August 16
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 ** This file contains routines used for walking the parser tree for
13 ** an SQL statement.
14 */
15 #include "sqliteInt.h"
16 #include <stdlib.h>
17 #include <string.h>
18 
19 
20 #if !defined(SQLITE_OMIT_WINDOWFUNC)
21 /*
22 ** Walk all expressions linked into the list of Window objects passed
23 ** as the second argument.
24 */
25 static int walkWindowList(Walker *pWalker, Window *pList){
26   Window *pWin;
27   for(pWin=pList; pWin; pWin=pWin->pNextWin){
28     if( sqlite3WalkExprList(pWalker, pWin->pOrderBy) ) return WRC_Abort;
29     if( sqlite3WalkExprList(pWalker, pWin->pPartition) ) return WRC_Abort;
30     if( sqlite3WalkExpr(pWalker, pWin->pFilter) ) return WRC_Abort;
31   }
32   return WRC_Continue;
33 }
34 #endif
35 
36 /*
37 ** Walk an expression tree.  Invoke the callback once for each node
38 ** of the expression, while descending.  (In other words, the callback
39 ** is invoked before visiting children.)
40 **
41 ** The return value from the callback should be one of the WRC_*
42 ** constants to specify how to proceed with the walk.
43 **
44 **    WRC_Continue      Continue descending down the tree.
45 **
46 **    WRC_Prune         Do not descend into child nodes, but allow
47 **                      the walk to continue with sibling nodes.
48 **
49 **    WRC_Abort         Do no more callbacks.  Unwind the stack and
50 **                      return from the top-level walk call.
51 **
52 ** The return value from this routine is WRC_Abort to abandon the tree walk
53 ** and WRC_Continue to continue.
54 */
55 static SQLITE_NOINLINE int walkExpr(Walker *pWalker, Expr *pExpr){
56   int rc;
57   testcase( ExprHasProperty(pExpr, EP_TokenOnly) );
58   testcase( ExprHasProperty(pExpr, EP_Reduced) );
59   while(1){
60     rc = pWalker->xExprCallback(pWalker, pExpr);
61     if( rc ) return rc & WRC_Abort;
62     if( !ExprHasProperty(pExpr,(EP_TokenOnly|EP_Leaf)) ){
63       if( pExpr->pLeft && walkExpr(pWalker, pExpr->pLeft) ) return WRC_Abort;
64        assert( pExpr->x.pList==0 || pExpr->pRight==0 );
65       if( pExpr->pRight ){
66         assert( !ExprHasProperty(pExpr, EP_WinFunc) );
67         pExpr = pExpr->pRight;
68         continue;
69       }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
70         assert( !ExprHasProperty(pExpr, EP_WinFunc) );
71         if( sqlite3WalkSelect(pWalker, pExpr->x.pSelect) ) return WRC_Abort;
72       }else{
73         if( pExpr->x.pList ){
74           if( sqlite3WalkExprList(pWalker, pExpr->x.pList) ) return WRC_Abort;
75         }
76 #ifndef SQLITE_OMIT_WINDOWFUNC
77         if( ExprHasProperty(pExpr, EP_WinFunc) ){
78           if( walkWindowList(pWalker, pExpr->y.pWin) ) return WRC_Abort;
79         }
80 #endif
81       }
82     }
83     break;
84   }
85   return WRC_Continue;
86 }
87 int sqlite3WalkExpr(Walker *pWalker, Expr *pExpr){
88   return pExpr ? walkExpr(pWalker,pExpr) : WRC_Continue;
89 }
90 
91 /*
92 ** Call sqlite3WalkExpr() for every expression in list p or until
93 ** an abort request is seen.
94 */
95 int sqlite3WalkExprList(Walker *pWalker, ExprList *p){
96   int i;
97   struct ExprList_item *pItem;
98   if( p ){
99     for(i=p->nExpr, pItem=p->a; i>0; i--, pItem++){
100       if( sqlite3WalkExpr(pWalker, pItem->pExpr) ) return WRC_Abort;
101     }
102   }
103   return WRC_Continue;
104 }
105 
106 /*
107 ** Walk all expressions associated with SELECT statement p.  Do
108 ** not invoke the SELECT callback on p, but do (of course) invoke
109 ** any expr callbacks and SELECT callbacks that come from subqueries.
110 ** Return WRC_Abort or WRC_Continue.
111 */
112 int sqlite3WalkSelectExpr(Walker *pWalker, Select *p){
113   if( sqlite3WalkExprList(pWalker, p->pEList) ) return WRC_Abort;
114   if( sqlite3WalkExpr(pWalker, p->pWhere) ) return WRC_Abort;
115   if( sqlite3WalkExprList(pWalker, p->pGroupBy) ) return WRC_Abort;
116   if( sqlite3WalkExpr(pWalker, p->pHaving) ) return WRC_Abort;
117   if( sqlite3WalkExprList(pWalker, p->pOrderBy) ) return WRC_Abort;
118   if( sqlite3WalkExpr(pWalker, p->pLimit) ) return WRC_Abort;
119 #if !defined(SQLITE_OMIT_WINDOWFUNC) && !defined(SQLITE_OMIT_ALTERTABLE)
120   {
121     Parse *pParse = pWalker->pParse;
122     if( pParse && IN_RENAME_OBJECT ){
123       int rc = walkWindowList(pWalker, p->pWinDefn);
124       assert( rc==WRC_Continue );
125       return rc;
126     }
127   }
128 #endif
129   return WRC_Continue;
130 }
131 
132 /*
133 ** Walk the parse trees associated with all subqueries in the
134 ** FROM clause of SELECT statement p.  Do not invoke the select
135 ** callback on p, but do invoke it on each FROM clause subquery
136 ** and on any subqueries further down in the tree.  Return
137 ** WRC_Abort or WRC_Continue;
138 */
139 int sqlite3WalkSelectFrom(Walker *pWalker, Select *p){
140   SrcList *pSrc;
141   int i;
142   struct SrcList_item *pItem;
143 
144   pSrc = p->pSrc;
145   assert( pSrc!=0 );
146   for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
147     if( pItem->pSelect && sqlite3WalkSelect(pWalker, pItem->pSelect) ){
148       return WRC_Abort;
149     }
150     if( pItem->fg.isTabFunc
151      && sqlite3WalkExprList(pWalker, pItem->u1.pFuncArg)
152     ){
153       return WRC_Abort;
154     }
155   }
156   return WRC_Continue;
157 }
158 
159 /*
160 ** Call sqlite3WalkExpr() for every expression in Select statement p.
161 ** Invoke sqlite3WalkSelect() for subqueries in the FROM clause and
162 ** on the compound select chain, p->pPrior.
163 **
164 ** If it is not NULL, the xSelectCallback() callback is invoked before
165 ** the walk of the expressions and FROM clause. The xSelectCallback2()
166 ** method is invoked following the walk of the expressions and FROM clause,
167 ** but only if both xSelectCallback and xSelectCallback2 are both non-NULL
168 ** and if the expressions and FROM clause both return WRC_Continue;
169 **
170 ** Return WRC_Continue under normal conditions.  Return WRC_Abort if
171 ** there is an abort request.
172 **
173 ** If the Walker does not have an xSelectCallback() then this routine
174 ** is a no-op returning WRC_Continue.
175 */
176 int sqlite3WalkSelect(Walker *pWalker, Select *p){
177   int rc;
178   if( p==0 ) return WRC_Continue;
179   if( pWalker->xSelectCallback==0 ) return WRC_Continue;
180   do{
181     rc = pWalker->xSelectCallback(pWalker, p);
182     if( rc ) return rc & WRC_Abort;
183     if( sqlite3WalkSelectExpr(pWalker, p)
184      || sqlite3WalkSelectFrom(pWalker, p)
185     ){
186       return WRC_Abort;
187     }
188     if( pWalker->xSelectCallback2 ){
189       pWalker->xSelectCallback2(pWalker, p);
190     }
191     p = p->pPrior;
192   }while( p!=0 );
193   return WRC_Continue;
194 }
195