xref: /sqlite-3.40.0/src/walker.c (revision be217793)
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 ** $Id: walker.c,v 1.2 2009/02/19 14:39:25 danielk1977 Exp $
16 */
17 #include "sqliteInt.h"
18 #include <stdlib.h>
19 #include <string.h>
20 
21 
22 /*
23 ** Walk an expression tree.  Invoke the callback once for each node
24 ** of the expression, while decending.  (In other words, the callback
25 ** is invoked before visiting children.)
26 **
27 ** The return value from the callback should be one of the WRC_*
28 ** constants to specify how to proceed with the walk.
29 **
30 **    WRC_Continue      Continue descending down the tree.
31 **
32 **    WRC_Prune         Do not descend into child nodes.  But allow
33 **                      the walk to continue with sibling nodes.
34 **
35 **    WRC_Abort         Do no more callbacks.  Unwind the stack and
36 **                      return the top-level walk call.
37 **
38 ** The return value from this routine is WRC_Abort to abandon the tree walk
39 ** and WRC_Continue to continue.
40 */
41 int sqlite3WalkExpr(Walker *pWalker, Expr *pExpr){
42   int rc;
43   if( pExpr==0 ) return WRC_Continue;
44   rc = pWalker->xExprCallback(pWalker, pExpr);
45   if( rc==WRC_Continue ){
46     if( sqlite3WalkExpr(pWalker, pExpr->pLeft) ) return WRC_Abort;
47     if( sqlite3WalkExpr(pWalker, pExpr->pRight) ) return WRC_Abort;
48     if( ExprHasProperty(pExpr, EP_xIsSelect) ){
49       if( sqlite3WalkSelect(pWalker, pExpr->x.pSelect) ) return WRC_Abort;
50     }else{
51       if( sqlite3WalkExprList(pWalker, pExpr->x.pList) ) return WRC_Abort;
52     }
53   }
54   return rc & WRC_Abort;
55 }
56 
57 /*
58 ** Call sqlite3WalkExpr() for every expression in list p or until
59 ** an abort request is seen.
60 */
61 int sqlite3WalkExprList(Walker *pWalker, ExprList *p){
62   int i, rc = WRC_Continue;
63   struct ExprList_item *pItem;
64   if( p ){
65     for(i=p->nExpr, pItem=p->a; i>0; i--, pItem++){
66       if( sqlite3WalkExpr(pWalker, pItem->pExpr) ) return WRC_Abort;
67     }
68   }
69   return rc & WRC_Continue;
70 }
71 
72 /*
73 ** Walk all expressions associated with SELECT statement p.  Do
74 ** not invoke the SELECT callback on p, but do (of course) invoke
75 ** any expr callbacks and SELECT callbacks that come from subqueries.
76 ** Return WRC_Abort or WRC_Continue.
77 */
78 int sqlite3WalkSelectExpr(Walker *pWalker, Select *p){
79   if( sqlite3WalkExprList(pWalker, p->pEList) ) return WRC_Abort;
80   if( sqlite3WalkExpr(pWalker, p->pWhere) ) return WRC_Abort;
81   if( sqlite3WalkExprList(pWalker, p->pGroupBy) ) return WRC_Abort;
82   if( sqlite3WalkExpr(pWalker, p->pHaving) ) return WRC_Abort;
83   if( sqlite3WalkExprList(pWalker, p->pOrderBy) ) return WRC_Abort;
84   if( sqlite3WalkExpr(pWalker, p->pLimit) ) return WRC_Abort;
85   if( sqlite3WalkExpr(pWalker, p->pOffset) ) return WRC_Abort;
86   return WRC_Continue;
87 }
88 
89 /*
90 ** Walk the parse trees associated with all subqueries in the
91 ** FROM clause of SELECT statement p.  Do not invoke the select
92 ** callback on p, but do invoke it on each FROM clause subquery
93 ** and on any subqueries further down in the tree.  Return
94 ** WRC_Abort or WRC_Continue;
95 */
96 int sqlite3WalkSelectFrom(Walker *pWalker, Select *p){
97   SrcList *pSrc;
98   int i;
99   struct SrcList_item *pItem;
100 
101   pSrc = p->pSrc;
102   if( pSrc ){
103     for(i=pSrc->nSrc, pItem=pSrc->a; i>0; i--, pItem++){
104       if( sqlite3WalkSelect(pWalker, pItem->pSelect) ){
105         return WRC_Abort;
106       }
107     }
108   }
109   return WRC_Continue;
110 }
111 
112 /*
113 ** Call sqlite3WalkExpr() for every expression in Select statement p.
114 ** Invoke sqlite3WalkSelect() for subqueries in the FROM clause and
115 ** on the compound select chain, p->pPrior.
116 **
117 ** Return WRC_Continue under normal conditions.  Return WRC_Abort if
118 ** there is an abort request.
119 **
120 ** If the Walker does not have an xSelectCallback() then this routine
121 ** is a no-op returning WRC_Continue.
122 */
123 int sqlite3WalkSelect(Walker *pWalker, Select *p){
124   int rc;
125   if( p==0 || pWalker->xSelectCallback==0 ) return WRC_Continue;
126   rc = WRC_Continue;
127   while( p  ){
128     rc = pWalker->xSelectCallback(pWalker, p);
129     if( rc ) break;
130     if( sqlite3WalkSelectExpr(pWalker, p) ) return WRC_Abort;
131     if( sqlite3WalkSelectFrom(pWalker, p) ) return WRC_Abort;
132     p = p->pPrior;
133   }
134   return rc & WRC_Abort;
135 }
136