xref: /sqlite-3.40.0/src/expr.c (revision 4e9119d9)
1cce7d176Sdrh /*
2b19a2bc6Sdrh ** 2001 September 15
3cce7d176Sdrh **
4b19a2bc6Sdrh ** The author disclaims copyright to this source code.  In place of
5b19a2bc6Sdrh ** a legal notice, here is a blessing:
6cce7d176Sdrh **
7b19a2bc6Sdrh **    May you do good and not evil.
8b19a2bc6Sdrh **    May you find forgiveness for yourself and forgive others.
9b19a2bc6Sdrh **    May you share freely, never taking more than you give.
10cce7d176Sdrh **
11cce7d176Sdrh *************************************************************************
121ccde15dSdrh ** This file contains routines used for analyzing expressions and
13b19a2bc6Sdrh ** for generating VDBE code that evaluates expressions in SQLite.
14cce7d176Sdrh */
15cce7d176Sdrh #include "sqliteInt.h"
16a2e00042Sdrh 
17e014a838Sdanielk1977 /*
18e014a838Sdanielk1977 ** Return the 'affinity' of the expression pExpr if any.
19e014a838Sdanielk1977 **
20e014a838Sdanielk1977 ** If pExpr is a column, a reference to a column via an 'AS' alias,
21e014a838Sdanielk1977 ** or a sub-select with a column as the return value, then the
22e014a838Sdanielk1977 ** affinity of that column is returned. Otherwise, 0x00 is returned,
23e014a838Sdanielk1977 ** indicating no affinity for the expression.
24e014a838Sdanielk1977 **
25e014a838Sdanielk1977 ** i.e. the WHERE clause expresssions in the following statements all
26e014a838Sdanielk1977 ** have an affinity:
27e014a838Sdanielk1977 **
28e014a838Sdanielk1977 ** CREATE TABLE t1(a);
29e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE a;
30e014a838Sdanielk1977 ** SELECT a AS b FROM t1 WHERE b;
31e014a838Sdanielk1977 ** SELECT * FROM t1 WHERE (select a from t1);
32e014a838Sdanielk1977 */
33bf3b721fSdanielk1977 char sqlite3ExprAffinity(Expr *pExpr){
34580c8c18Sdrh   int op;
35580c8c18Sdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
36580c8c18Sdrh   op = pExpr->op;
37487e262fSdrh   if( op==TK_SELECT ){
386ab3a2ecSdanielk1977     assert( pExpr->flags&EP_xIsSelect );
396ab3a2ecSdanielk1977     return sqlite3ExprAffinity(pExpr->x.pSelect->pEList->a[0].pExpr);
40a37cdde0Sdanielk1977   }
41487e262fSdrh #ifndef SQLITE_OMIT_CAST
42487e262fSdrh   if( op==TK_CAST ){
4333e619fcSdrh     assert( !ExprHasProperty(pExpr, EP_IntValue) );
44fdaac671Sdrh     return sqlite3AffinityType(pExpr->u.zToken, 0);
45487e262fSdrh   }
46487e262fSdrh #endif
47259a455fSdanielk1977   if( (op==TK_AGG_COLUMN || op==TK_COLUMN || op==TK_REGISTER)
48259a455fSdanielk1977    && pExpr->pTab!=0
49259a455fSdanielk1977   ){
507d10d5a6Sdrh     /* op==TK_REGISTER && pExpr->pTab!=0 happens when pExpr was originally
517d10d5a6Sdrh     ** a TK_COLUMN but was previously evaluated and cached in a register */
527d10d5a6Sdrh     int j = pExpr->iColumn;
537d10d5a6Sdrh     if( j<0 ) return SQLITE_AFF_INTEGER;
547d10d5a6Sdrh     assert( pExpr->pTab && j<pExpr->pTab->nCol );
557d10d5a6Sdrh     return pExpr->pTab->aCol[j].affinity;
567d10d5a6Sdrh   }
57a37cdde0Sdanielk1977   return pExpr->affinity;
58a37cdde0Sdanielk1977 }
59a37cdde0Sdanielk1977 
6053db1458Sdrh /*
618b4c40d8Sdrh ** Set the collating sequence for expression pExpr to be the collating
62ae80ddeaSdrh ** sequence named by pToken.   Return a pointer to a new Expr node that
63ae80ddeaSdrh ** implements the COLLATE operator.
640a8a406eSdrh **
650a8a406eSdrh ** If a memory allocation error occurs, that fact is recorded in pParse->db
660a8a406eSdrh ** and the pExpr parameter is returned unchanged.
678b4c40d8Sdrh */
680a8a406eSdrh Expr *sqlite3ExprAddCollateToken(Parse *pParse, Expr *pExpr, Token *pCollName){
690a8a406eSdrh   if( pCollName->n>0 ){
70ae80ddeaSdrh     Expr *pNew = sqlite3ExprAlloc(pParse->db, TK_COLLATE, pCollName, 1);
71ae80ddeaSdrh     if( pNew ){
72ae80ddeaSdrh       pNew->pLeft = pExpr;
73a4c3c87eSdrh       pNew->flags |= EP_Collate|EP_Skip;
740a8a406eSdrh       pExpr = pNew;
75ae80ddeaSdrh     }
760a8a406eSdrh   }
770a8a406eSdrh   return pExpr;
780a8a406eSdrh }
790a8a406eSdrh Expr *sqlite3ExprAddCollateString(Parse *pParse, Expr *pExpr, const char *zC){
800a8a406eSdrh   Token s;
81261d8a51Sdrh   assert( zC!=0 );
820a8a406eSdrh   s.z = zC;
830a8a406eSdrh   s.n = sqlite3Strlen30(s.z);
84261d8a51Sdrh   return sqlite3ExprAddCollateToken(pParse, pExpr, &s);
850a8a406eSdrh }
860a8a406eSdrh 
870a8a406eSdrh /*
88a4c3c87eSdrh ** Skip over any TK_COLLATE or TK_AS operators and any unlikely()
89a4c3c87eSdrh ** or likelihood() function at the root of an expression.
900a8a406eSdrh */
910a8a406eSdrh Expr *sqlite3ExprSkipCollate(Expr *pExpr){
92a4c3c87eSdrh   while( pExpr && ExprHasProperty(pExpr, EP_Skip) ){
93a4c3c87eSdrh     if( ExprHasProperty(pExpr, EP_Unlikely) ){
94cca9f3d2Sdrh       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
95cca9f3d2Sdrh       assert( pExpr->x.pList->nExpr>0 );
96a4c3c87eSdrh       assert( pExpr->op==TK_FUNCTION );
97cca9f3d2Sdrh       pExpr = pExpr->x.pList->a[0].pExpr;
98cca9f3d2Sdrh     }else{
99a4c3c87eSdrh       assert( pExpr->op==TK_COLLATE || pExpr->op==TK_AS );
100d91eba96Sdrh       pExpr = pExpr->pLeft;
101cca9f3d2Sdrh     }
102d91eba96Sdrh   }
1030a8a406eSdrh   return pExpr;
1048b4c40d8Sdrh }
1058b4c40d8Sdrh 
1068b4c40d8Sdrh /*
107ae80ddeaSdrh ** Return the collation sequence for the expression pExpr. If
108ae80ddeaSdrh ** there is no defined collating sequence, return NULL.
109ae80ddeaSdrh **
110ae80ddeaSdrh ** The collating sequence might be determined by a COLLATE operator
111ae80ddeaSdrh ** or by the presence of a column with a defined collating sequence.
112ae80ddeaSdrh ** COLLATE operators take first precedence.  Left operands take
113ae80ddeaSdrh ** precedence over right operands.
1140202b29eSdanielk1977 */
1157cedc8d4Sdanielk1977 CollSeq *sqlite3ExprCollSeq(Parse *pParse, Expr *pExpr){
116ae80ddeaSdrh   sqlite3 *db = pParse->db;
1177cedc8d4Sdanielk1977   CollSeq *pColl = 0;
1187d10d5a6Sdrh   Expr *p = pExpr;
119261d8a51Sdrh   while( p ){
120ae80ddeaSdrh     int op = p->op;
121ae80ddeaSdrh     if( op==TK_CAST || op==TK_UPLUS ){
122ae80ddeaSdrh       p = p->pLeft;
123ae80ddeaSdrh       continue;
124ae80ddeaSdrh     }
12536e78309Sdan     if( op==TK_COLLATE || (op==TK_REGISTER && p->op2==TK_COLLATE) ){
1267a66da13Sdrh       pColl = sqlite3GetCollSeq(pParse, ENC(db), 0, p->u.zToken);
127ae80ddeaSdrh       break;
128ae80ddeaSdrh     }
129ae80ddeaSdrh     if( p->pTab!=0
130ae80ddeaSdrh      && (op==TK_AGG_COLUMN || op==TK_COLUMN
131ae80ddeaSdrh           || op==TK_REGISTER || op==TK_TRIGGER)
132ae80ddeaSdrh     ){
1337d10d5a6Sdrh       /* op==TK_REGISTER && p->pTab!=0 happens when pExpr was originally
1347d10d5a6Sdrh       ** a TK_COLUMN but was previously evaluated and cached in a register */
1357d10d5a6Sdrh       int j = p->iColumn;
1367d10d5a6Sdrh       if( j>=0 ){
137ae80ddeaSdrh         const char *zColl = p->pTab->aCol[j].zColl;
138c4a64facSdrh         pColl = sqlite3FindCollSeq(db, ENC(db), zColl, 0);
1390202b29eSdanielk1977       }
1407d10d5a6Sdrh       break;
1417d10d5a6Sdrh     }
142ae80ddeaSdrh     if( p->flags & EP_Collate ){
143261d8a51Sdrh       if( ALWAYS(p->pLeft) && (p->pLeft->flags & EP_Collate)!=0 ){
1447d10d5a6Sdrh         p = p->pLeft;
145ae80ddeaSdrh       }else{
146ae80ddeaSdrh         p = p->pRight;
147ae80ddeaSdrh       }
148ae80ddeaSdrh     }else{
149ae80ddeaSdrh       break;
150ae80ddeaSdrh     }
1510202b29eSdanielk1977   }
1527cedc8d4Sdanielk1977   if( sqlite3CheckCollSeq(pParse, pColl) ){
1537cedc8d4Sdanielk1977     pColl = 0;
1547cedc8d4Sdanielk1977   }
1557cedc8d4Sdanielk1977   return pColl;
1560202b29eSdanielk1977 }
1570202b29eSdanielk1977 
1580202b29eSdanielk1977 /*
159626a879aSdrh ** pExpr is an operand of a comparison operator.  aff2 is the
160626a879aSdrh ** type affinity of the other operand.  This routine returns the
16153db1458Sdrh ** type affinity that should be used for the comparison operator.
16253db1458Sdrh */
163e014a838Sdanielk1977 char sqlite3CompareAffinity(Expr *pExpr, char aff2){
164bf3b721fSdanielk1977   char aff1 = sqlite3ExprAffinity(pExpr);
165e014a838Sdanielk1977   if( aff1 && aff2 ){
1668df447f0Sdrh     /* Both sides of the comparison are columns. If one has numeric
1678df447f0Sdrh     ** affinity, use that. Otherwise use no affinity.
168e014a838Sdanielk1977     */
1698a51256cSdrh     if( sqlite3IsNumericAffinity(aff1) || sqlite3IsNumericAffinity(aff2) ){
170e014a838Sdanielk1977       return SQLITE_AFF_NUMERIC;
171e014a838Sdanielk1977     }else{
172e014a838Sdanielk1977       return SQLITE_AFF_NONE;
173e014a838Sdanielk1977     }
174e014a838Sdanielk1977   }else if( !aff1 && !aff2 ){
1755f6a87b3Sdrh     /* Neither side of the comparison is a column.  Compare the
1765f6a87b3Sdrh     ** results directly.
177e014a838Sdanielk1977     */
1785f6a87b3Sdrh     return SQLITE_AFF_NONE;
179e014a838Sdanielk1977   }else{
180e014a838Sdanielk1977     /* One side is a column, the other is not. Use the columns affinity. */
181fe05af87Sdrh     assert( aff1==0 || aff2==0 );
182e014a838Sdanielk1977     return (aff1 + aff2);
183e014a838Sdanielk1977   }
184e014a838Sdanielk1977 }
185e014a838Sdanielk1977 
18653db1458Sdrh /*
18753db1458Sdrh ** pExpr is a comparison operator.  Return the type affinity that should
18853db1458Sdrh ** be applied to both operands prior to doing the comparison.
18953db1458Sdrh */
190e014a838Sdanielk1977 static char comparisonAffinity(Expr *pExpr){
191e014a838Sdanielk1977   char aff;
192e014a838Sdanielk1977   assert( pExpr->op==TK_EQ || pExpr->op==TK_IN || pExpr->op==TK_LT ||
193e014a838Sdanielk1977           pExpr->op==TK_GT || pExpr->op==TK_GE || pExpr->op==TK_LE ||
1946a2fe093Sdrh           pExpr->op==TK_NE || pExpr->op==TK_IS || pExpr->op==TK_ISNOT );
195e014a838Sdanielk1977   assert( pExpr->pLeft );
196bf3b721fSdanielk1977   aff = sqlite3ExprAffinity(pExpr->pLeft);
197e014a838Sdanielk1977   if( pExpr->pRight ){
198e014a838Sdanielk1977     aff = sqlite3CompareAffinity(pExpr->pRight, aff);
1996ab3a2ecSdanielk1977   }else if( ExprHasProperty(pExpr, EP_xIsSelect) ){
2006ab3a2ecSdanielk1977     aff = sqlite3CompareAffinity(pExpr->x.pSelect->pEList->a[0].pExpr, aff);
2016ab3a2ecSdanielk1977   }else if( !aff ){
202de087bd5Sdrh     aff = SQLITE_AFF_NONE;
203e014a838Sdanielk1977   }
204e014a838Sdanielk1977   return aff;
205e014a838Sdanielk1977 }
206e014a838Sdanielk1977 
207e014a838Sdanielk1977 /*
208e014a838Sdanielk1977 ** pExpr is a comparison expression, eg. '=', '<', IN(...) etc.
209e014a838Sdanielk1977 ** idx_affinity is the affinity of an indexed column. Return true
210e014a838Sdanielk1977 ** if the index with affinity idx_affinity may be used to implement
211e014a838Sdanielk1977 ** the comparison in pExpr.
212e014a838Sdanielk1977 */
213e014a838Sdanielk1977 int sqlite3IndexAffinityOk(Expr *pExpr, char idx_affinity){
214e014a838Sdanielk1977   char aff = comparisonAffinity(pExpr);
2158a51256cSdrh   switch( aff ){
2168a51256cSdrh     case SQLITE_AFF_NONE:
2178a51256cSdrh       return 1;
2188a51256cSdrh     case SQLITE_AFF_TEXT:
2198a51256cSdrh       return idx_affinity==SQLITE_AFF_TEXT;
2208a51256cSdrh     default:
2218a51256cSdrh       return sqlite3IsNumericAffinity(idx_affinity);
2228a51256cSdrh   }
223e014a838Sdanielk1977 }
224e014a838Sdanielk1977 
225a37cdde0Sdanielk1977 /*
22635573356Sdrh ** Return the P5 value that should be used for a binary comparison
227a37cdde0Sdanielk1977 ** opcode (OP_Eq, OP_Ge etc.) used to compare pExpr1 and pExpr2.
228a37cdde0Sdanielk1977 */
22935573356Sdrh static u8 binaryCompareP5(Expr *pExpr1, Expr *pExpr2, int jumpIfNull){
23035573356Sdrh   u8 aff = (char)sqlite3ExprAffinity(pExpr2);
2311bd10f8aSdrh   aff = (u8)sqlite3CompareAffinity(pExpr1, aff) | (u8)jumpIfNull;
23235573356Sdrh   return aff;
233a37cdde0Sdanielk1977 }
234a37cdde0Sdanielk1977 
235a2e00042Sdrh /*
2360202b29eSdanielk1977 ** Return a pointer to the collation sequence that should be used by
2370202b29eSdanielk1977 ** a binary comparison operator comparing pLeft and pRight.
2380202b29eSdanielk1977 **
2390202b29eSdanielk1977 ** If the left hand expression has a collating sequence type, then it is
2400202b29eSdanielk1977 ** used. Otherwise the collation sequence for the right hand expression
2410202b29eSdanielk1977 ** is used, or the default (BINARY) if neither expression has a collating
2420202b29eSdanielk1977 ** type.
243bcbb04e5Sdanielk1977 **
244bcbb04e5Sdanielk1977 ** Argument pRight (but not pLeft) may be a null pointer. In this case,
245bcbb04e5Sdanielk1977 ** it is not considered.
2460202b29eSdanielk1977 */
247bcbb04e5Sdanielk1977 CollSeq *sqlite3BinaryCompareCollSeq(
248bcbb04e5Sdanielk1977   Parse *pParse,
249bcbb04e5Sdanielk1977   Expr *pLeft,
250bcbb04e5Sdanielk1977   Expr *pRight
251bcbb04e5Sdanielk1977 ){
252ec41ddacSdrh   CollSeq *pColl;
253ec41ddacSdrh   assert( pLeft );
254ae80ddeaSdrh   if( pLeft->flags & EP_Collate ){
255ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
256ae80ddeaSdrh   }else if( pRight && (pRight->flags & EP_Collate)!=0 ){
257ae80ddeaSdrh     pColl = sqlite3ExprCollSeq(pParse, pRight);
258ec41ddacSdrh   }else{
259ec41ddacSdrh     pColl = sqlite3ExprCollSeq(pParse, pLeft);
2600202b29eSdanielk1977     if( !pColl ){
2617cedc8d4Sdanielk1977       pColl = sqlite3ExprCollSeq(pParse, pRight);
2620202b29eSdanielk1977     }
263ec41ddacSdrh   }
2640202b29eSdanielk1977   return pColl;
2650202b29eSdanielk1977 }
2660202b29eSdanielk1977 
2670202b29eSdanielk1977 /*
268be5c89acSdrh ** Generate code for a comparison operator.
269be5c89acSdrh */
270be5c89acSdrh static int codeCompare(
271be5c89acSdrh   Parse *pParse,    /* The parsing (and code generating) context */
272be5c89acSdrh   Expr *pLeft,      /* The left operand */
273be5c89acSdrh   Expr *pRight,     /* The right operand */
274be5c89acSdrh   int opcode,       /* The comparison opcode */
27535573356Sdrh   int in1, int in2, /* Register holding operands */
276be5c89acSdrh   int dest,         /* Jump here if true.  */
277be5c89acSdrh   int jumpIfNull    /* If true, jump if either operand is NULL */
278be5c89acSdrh ){
27935573356Sdrh   int p5;
28035573356Sdrh   int addr;
28135573356Sdrh   CollSeq *p4;
28235573356Sdrh 
28335573356Sdrh   p4 = sqlite3BinaryCompareCollSeq(pParse, pLeft, pRight);
28435573356Sdrh   p5 = binaryCompareP5(pLeft, pRight, jumpIfNull);
28535573356Sdrh   addr = sqlite3VdbeAddOp4(pParse->pVdbe, opcode, in2, dest, in1,
28635573356Sdrh                            (void*)p4, P4_COLLSEQ);
2871bd10f8aSdrh   sqlite3VdbeChangeP5(pParse->pVdbe, (u8)p5);
28835573356Sdrh   return addr;
289be5c89acSdrh }
290be5c89acSdrh 
2914b5255acSdanielk1977 #if SQLITE_MAX_EXPR_DEPTH>0
2924b5255acSdanielk1977 /*
2934b5255acSdanielk1977 ** Check that argument nHeight is less than or equal to the maximum
2944b5255acSdanielk1977 ** expression depth allowed. If it is not, leave an error message in
2954b5255acSdanielk1977 ** pParse.
2964b5255acSdanielk1977 */
2977d10d5a6Sdrh int sqlite3ExprCheckHeight(Parse *pParse, int nHeight){
2984b5255acSdanielk1977   int rc = SQLITE_OK;
2994b5255acSdanielk1977   int mxHeight = pParse->db->aLimit[SQLITE_LIMIT_EXPR_DEPTH];
3004b5255acSdanielk1977   if( nHeight>mxHeight ){
3014b5255acSdanielk1977     sqlite3ErrorMsg(pParse,
3024b5255acSdanielk1977        "Expression tree is too large (maximum depth %d)", mxHeight
3034b5255acSdanielk1977     );
3044b5255acSdanielk1977     rc = SQLITE_ERROR;
3054b5255acSdanielk1977   }
3064b5255acSdanielk1977   return rc;
3074b5255acSdanielk1977 }
3084b5255acSdanielk1977 
3094b5255acSdanielk1977 /* The following three functions, heightOfExpr(), heightOfExprList()
3104b5255acSdanielk1977 ** and heightOfSelect(), are used to determine the maximum height
3114b5255acSdanielk1977 ** of any expression tree referenced by the structure passed as the
3124b5255acSdanielk1977 ** first argument.
3134b5255acSdanielk1977 **
3144b5255acSdanielk1977 ** If this maximum height is greater than the current value pointed
3154b5255acSdanielk1977 ** to by pnHeight, the second parameter, then set *pnHeight to that
3164b5255acSdanielk1977 ** value.
3174b5255acSdanielk1977 */
3184b5255acSdanielk1977 static void heightOfExpr(Expr *p, int *pnHeight){
3194b5255acSdanielk1977   if( p ){
3204b5255acSdanielk1977     if( p->nHeight>*pnHeight ){
3214b5255acSdanielk1977       *pnHeight = p->nHeight;
3224b5255acSdanielk1977     }
3234b5255acSdanielk1977   }
3244b5255acSdanielk1977 }
3254b5255acSdanielk1977 static void heightOfExprList(ExprList *p, int *pnHeight){
3264b5255acSdanielk1977   if( p ){
3274b5255acSdanielk1977     int i;
3284b5255acSdanielk1977     for(i=0; i<p->nExpr; i++){
3294b5255acSdanielk1977       heightOfExpr(p->a[i].pExpr, pnHeight);
3304b5255acSdanielk1977     }
3314b5255acSdanielk1977   }
3324b5255acSdanielk1977 }
3334b5255acSdanielk1977 static void heightOfSelect(Select *p, int *pnHeight){
3344b5255acSdanielk1977   if( p ){
3354b5255acSdanielk1977     heightOfExpr(p->pWhere, pnHeight);
3364b5255acSdanielk1977     heightOfExpr(p->pHaving, pnHeight);
3374b5255acSdanielk1977     heightOfExpr(p->pLimit, pnHeight);
3384b5255acSdanielk1977     heightOfExpr(p->pOffset, pnHeight);
3394b5255acSdanielk1977     heightOfExprList(p->pEList, pnHeight);
3404b5255acSdanielk1977     heightOfExprList(p->pGroupBy, pnHeight);
3414b5255acSdanielk1977     heightOfExprList(p->pOrderBy, pnHeight);
3424b5255acSdanielk1977     heightOfSelect(p->pPrior, pnHeight);
3434b5255acSdanielk1977   }
3444b5255acSdanielk1977 }
3454b5255acSdanielk1977 
3464b5255acSdanielk1977 /*
3474b5255acSdanielk1977 ** Set the Expr.nHeight variable in the structure passed as an
3484b5255acSdanielk1977 ** argument. An expression with no children, Expr.pList or
3494b5255acSdanielk1977 ** Expr.pSelect member has a height of 1. Any other expression
3504b5255acSdanielk1977 ** has a height equal to the maximum height of any other
3514b5255acSdanielk1977 ** referenced Expr plus one.
3524b5255acSdanielk1977 */
3534b5255acSdanielk1977 static void exprSetHeight(Expr *p){
3544b5255acSdanielk1977   int nHeight = 0;
3554b5255acSdanielk1977   heightOfExpr(p->pLeft, &nHeight);
3564b5255acSdanielk1977   heightOfExpr(p->pRight, &nHeight);
3576ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_xIsSelect) ){
3586ab3a2ecSdanielk1977     heightOfSelect(p->x.pSelect, &nHeight);
3596ab3a2ecSdanielk1977   }else{
3606ab3a2ecSdanielk1977     heightOfExprList(p->x.pList, &nHeight);
3616ab3a2ecSdanielk1977   }
3624b5255acSdanielk1977   p->nHeight = nHeight + 1;
3634b5255acSdanielk1977 }
3644b5255acSdanielk1977 
3654b5255acSdanielk1977 /*
3664b5255acSdanielk1977 ** Set the Expr.nHeight variable using the exprSetHeight() function. If
3674b5255acSdanielk1977 ** the height is greater than the maximum allowed expression depth,
3684b5255acSdanielk1977 ** leave an error in pParse.
3694b5255acSdanielk1977 */
3704b5255acSdanielk1977 void sqlite3ExprSetHeight(Parse *pParse, Expr *p){
3714b5255acSdanielk1977   exprSetHeight(p);
3727d10d5a6Sdrh   sqlite3ExprCheckHeight(pParse, p->nHeight);
3734b5255acSdanielk1977 }
3744b5255acSdanielk1977 
3754b5255acSdanielk1977 /*
3764b5255acSdanielk1977 ** Return the maximum height of any expression tree referenced
3774b5255acSdanielk1977 ** by the select statement passed as an argument.
3784b5255acSdanielk1977 */
3794b5255acSdanielk1977 int sqlite3SelectExprHeight(Select *p){
3804b5255acSdanielk1977   int nHeight = 0;
3814b5255acSdanielk1977   heightOfSelect(p, &nHeight);
3824b5255acSdanielk1977   return nHeight;
3834b5255acSdanielk1977 }
3844b5255acSdanielk1977 #else
3854b5255acSdanielk1977   #define exprSetHeight(y)
3864b5255acSdanielk1977 #endif /* SQLITE_MAX_EXPR_DEPTH>0 */
3874b5255acSdanielk1977 
388be5c89acSdrh /*
389b7916a78Sdrh ** This routine is the core allocator for Expr nodes.
390b7916a78Sdrh **
391a76b5dfcSdrh ** Construct a new expression node and return a pointer to it.  Memory
392b7916a78Sdrh ** for this node and for the pToken argument is a single allocation
393b7916a78Sdrh ** obtained from sqlite3DbMalloc().  The calling function
394a76b5dfcSdrh ** is responsible for making sure the node eventually gets freed.
395b7916a78Sdrh **
396b7916a78Sdrh ** If dequote is true, then the token (if it exists) is dequoted.
397b7916a78Sdrh ** If dequote is false, no dequoting is performance.  The deQuote
398b7916a78Sdrh ** parameter is ignored if pToken is NULL or if the token does not
399b7916a78Sdrh ** appear to be quoted.  If the quotes were of the form "..." (double-quotes)
400b7916a78Sdrh ** then the EP_DblQuoted flag is set on the expression node.
40133e619fcSdrh **
40233e619fcSdrh ** Special case:  If op==TK_INTEGER and pToken points to a string that
40333e619fcSdrh ** can be translated into a 32-bit integer, then the token is not
40433e619fcSdrh ** stored in u.zToken.  Instead, the integer values is written
40533e619fcSdrh ** into u.iValue and the EP_IntValue flag is set.  No extra storage
40633e619fcSdrh ** is allocated to hold the integer text and the dequote flag is ignored.
407a76b5dfcSdrh */
408b7916a78Sdrh Expr *sqlite3ExprAlloc(
409a1644fd8Sdanielk1977   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
41017435752Sdrh   int op,                 /* Expression opcode */
411b7916a78Sdrh   const Token *pToken,    /* Token argument.  Might be NULL */
412b7916a78Sdrh   int dequote             /* True to dequote */
41317435752Sdrh ){
414a76b5dfcSdrh   Expr *pNew;
41533e619fcSdrh   int nExtra = 0;
416cf697396Sshane   int iValue = 0;
417b7916a78Sdrh 
418b7916a78Sdrh   if( pToken ){
41933e619fcSdrh     if( op!=TK_INTEGER || pToken->z==0
42033e619fcSdrh           || sqlite3GetInt32(pToken->z, &iValue)==0 ){
421b7916a78Sdrh       nExtra = pToken->n+1;
422d50ffc41Sdrh       assert( iValue>=0 );
42333e619fcSdrh     }
424a76b5dfcSdrh   }
425b7916a78Sdrh   pNew = sqlite3DbMallocZero(db, sizeof(Expr)+nExtra);
426b7916a78Sdrh   if( pNew ){
4271bd10f8aSdrh     pNew->op = (u8)op;
428a58fdfb1Sdanielk1977     pNew->iAgg = -1;
429a76b5dfcSdrh     if( pToken ){
43033e619fcSdrh       if( nExtra==0 ){
43133e619fcSdrh         pNew->flags |= EP_IntValue;
43233e619fcSdrh         pNew->u.iValue = iValue;
43333e619fcSdrh       }else{
434d9da78a2Sdrh         int c;
43533e619fcSdrh         pNew->u.zToken = (char*)&pNew[1];
436b07028f7Sdrh         assert( pToken->z!=0 || pToken->n==0 );
437b07028f7Sdrh         if( pToken->n ) memcpy(pNew->u.zToken, pToken->z, pToken->n);
43833e619fcSdrh         pNew->u.zToken[pToken->n] = 0;
439b7916a78Sdrh         if( dequote && nExtra>=3
440d9da78a2Sdrh              && ((c = pToken->z[0])=='\'' || c=='"' || c=='[' || c=='`') ){
44133e619fcSdrh           sqlite3Dequote(pNew->u.zToken);
44224fb627aSdrh           if( c=='"' ) pNew->flags |= EP_DblQuoted;
443a34001c9Sdrh         }
444a34001c9Sdrh       }
44533e619fcSdrh     }
446b7916a78Sdrh #if SQLITE_MAX_EXPR_DEPTH>0
447b7916a78Sdrh     pNew->nHeight = 1;
448b7916a78Sdrh #endif
449a34001c9Sdrh   }
450a76b5dfcSdrh   return pNew;
451a76b5dfcSdrh }
452a76b5dfcSdrh 
453a76b5dfcSdrh /*
454b7916a78Sdrh ** Allocate a new expression node from a zero-terminated token that has
455b7916a78Sdrh ** already been dequoted.
456b7916a78Sdrh */
457b7916a78Sdrh Expr *sqlite3Expr(
458b7916a78Sdrh   sqlite3 *db,            /* Handle for sqlite3DbMallocZero() (may be null) */
459b7916a78Sdrh   int op,                 /* Expression opcode */
460b7916a78Sdrh   const char *zToken      /* Token argument.  Might be NULL */
461b7916a78Sdrh ){
462b7916a78Sdrh   Token x;
463b7916a78Sdrh   x.z = zToken;
464b7916a78Sdrh   x.n = zToken ? sqlite3Strlen30(zToken) : 0;
465b7916a78Sdrh   return sqlite3ExprAlloc(db, op, &x, 0);
466b7916a78Sdrh }
467b7916a78Sdrh 
468b7916a78Sdrh /*
469b7916a78Sdrh ** Attach subtrees pLeft and pRight to the Expr node pRoot.
470b7916a78Sdrh **
471b7916a78Sdrh ** If pRoot==NULL that means that a memory allocation error has occurred.
472b7916a78Sdrh ** In that case, delete the subtrees pLeft and pRight.
473b7916a78Sdrh */
474b7916a78Sdrh void sqlite3ExprAttachSubtrees(
475b7916a78Sdrh   sqlite3 *db,
476b7916a78Sdrh   Expr *pRoot,
477b7916a78Sdrh   Expr *pLeft,
478b7916a78Sdrh   Expr *pRight
479b7916a78Sdrh ){
480b7916a78Sdrh   if( pRoot==0 ){
481b7916a78Sdrh     assert( db->mallocFailed );
482b7916a78Sdrh     sqlite3ExprDelete(db, pLeft);
483b7916a78Sdrh     sqlite3ExprDelete(db, pRight);
484b7916a78Sdrh   }else{
485b7916a78Sdrh     if( pRight ){
486b7916a78Sdrh       pRoot->pRight = pRight;
487ae80ddeaSdrh       pRoot->flags |= EP_Collate & pRight->flags;
488b7916a78Sdrh     }
489b7916a78Sdrh     if( pLeft ){
490b7916a78Sdrh       pRoot->pLeft = pLeft;
491ae80ddeaSdrh       pRoot->flags |= EP_Collate & pLeft->flags;
492b7916a78Sdrh     }
493b7916a78Sdrh     exprSetHeight(pRoot);
494b7916a78Sdrh   }
495b7916a78Sdrh }
496b7916a78Sdrh 
497b7916a78Sdrh /*
498bf664469Sdrh ** Allocate a Expr node which joins as many as two subtrees.
499b7916a78Sdrh **
500bf664469Sdrh ** One or both of the subtrees can be NULL.  Return a pointer to the new
501bf664469Sdrh ** Expr node.  Or, if an OOM error occurs, set pParse->db->mallocFailed,
502bf664469Sdrh ** free the subtrees and return NULL.
503206f3d96Sdrh */
50417435752Sdrh Expr *sqlite3PExpr(
50517435752Sdrh   Parse *pParse,          /* Parsing context */
50617435752Sdrh   int op,                 /* Expression opcode */
50717435752Sdrh   Expr *pLeft,            /* Left operand */
50817435752Sdrh   Expr *pRight,           /* Right operand */
50917435752Sdrh   const Token *pToken     /* Argument token */
51017435752Sdrh ){
5115fb52caaSdrh   Expr *p;
5125fb52caaSdrh   if( op==TK_AND && pLeft && pRight ){
5135fb52caaSdrh     /* Take advantage of short-circuit false optimization for AND */
5145fb52caaSdrh     p = sqlite3ExprAnd(pParse->db, pLeft, pRight);
5155fb52caaSdrh   }else{
5165fb52caaSdrh     p = sqlite3ExprAlloc(pParse->db, op, pToken, 1);
517b7916a78Sdrh     sqlite3ExprAttachSubtrees(pParse->db, p, pLeft, pRight);
5185fb52caaSdrh   }
5192b359bdbSdan   if( p ) {
5202b359bdbSdan     sqlite3ExprCheckHeight(pParse, p->nHeight);
5212b359bdbSdan   }
5224e0cff60Sdrh   return p;
5234e0cff60Sdrh }
5244e0cff60Sdrh 
5254e0cff60Sdrh /*
526991a1985Sdrh ** If the expression is always either TRUE or FALSE (respectively),
527991a1985Sdrh ** then return 1.  If one cannot determine the truth value of the
528991a1985Sdrh ** expression at compile-time return 0.
529991a1985Sdrh **
530991a1985Sdrh ** This is an optimization.  If is OK to return 0 here even if
531991a1985Sdrh ** the expression really is always false or false (a false negative).
532991a1985Sdrh ** But it is a bug to return 1 if the expression might have different
533991a1985Sdrh ** boolean values in different circumstances (a false positive.)
5345fb52caaSdrh **
5355fb52caaSdrh ** Note that if the expression is part of conditional for a
5365fb52caaSdrh ** LEFT JOIN, then we cannot determine at compile-time whether or not
5375fb52caaSdrh ** is it true or false, so always return 0.
5385fb52caaSdrh */
539991a1985Sdrh static int exprAlwaysTrue(Expr *p){
540991a1985Sdrh   int v = 0;
541991a1985Sdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
542991a1985Sdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
543991a1985Sdrh   return v!=0;
544991a1985Sdrh }
5455fb52caaSdrh static int exprAlwaysFalse(Expr *p){
5465fb52caaSdrh   int v = 0;
5475fb52caaSdrh   if( ExprHasProperty(p, EP_FromJoin) ) return 0;
5485fb52caaSdrh   if( !sqlite3ExprIsInteger(p, &v) ) return 0;
5495fb52caaSdrh   return v==0;
5505fb52caaSdrh }
5515fb52caaSdrh 
5525fb52caaSdrh /*
55391bb0eedSdrh ** Join two expressions using an AND operator.  If either expression is
55491bb0eedSdrh ** NULL, then just return the other expression.
5555fb52caaSdrh **
5565fb52caaSdrh ** If one side or the other of the AND is known to be false, then instead
5575fb52caaSdrh ** of returning an AND expression, just return a constant expression with
5585fb52caaSdrh ** a value of false.
55991bb0eedSdrh */
5601e536953Sdanielk1977 Expr *sqlite3ExprAnd(sqlite3 *db, Expr *pLeft, Expr *pRight){
56191bb0eedSdrh   if( pLeft==0 ){
56291bb0eedSdrh     return pRight;
56391bb0eedSdrh   }else if( pRight==0 ){
56491bb0eedSdrh     return pLeft;
5655fb52caaSdrh   }else if( exprAlwaysFalse(pLeft) || exprAlwaysFalse(pRight) ){
5665fb52caaSdrh     sqlite3ExprDelete(db, pLeft);
5675fb52caaSdrh     sqlite3ExprDelete(db, pRight);
5685fb52caaSdrh     return sqlite3ExprAlloc(db, TK_INTEGER, &sqlite3IntTokens[0], 0);
56991bb0eedSdrh   }else{
570b7916a78Sdrh     Expr *pNew = sqlite3ExprAlloc(db, TK_AND, 0, 0);
571b7916a78Sdrh     sqlite3ExprAttachSubtrees(db, pNew, pLeft, pRight);
572b7916a78Sdrh     return pNew;
573a76b5dfcSdrh   }
574a76b5dfcSdrh }
575a76b5dfcSdrh 
576a76b5dfcSdrh /*
577a76b5dfcSdrh ** Construct a new expression node for a function with multiple
578a76b5dfcSdrh ** arguments.
579a76b5dfcSdrh */
58017435752Sdrh Expr *sqlite3ExprFunction(Parse *pParse, ExprList *pList, Token *pToken){
581a76b5dfcSdrh   Expr *pNew;
582633e6d57Sdrh   sqlite3 *db = pParse->db;
5834b202ae2Sdanielk1977   assert( pToken );
584b7916a78Sdrh   pNew = sqlite3ExprAlloc(db, TK_FUNCTION, pToken, 1);
585a76b5dfcSdrh   if( pNew==0 ){
586d9da78a2Sdrh     sqlite3ExprListDelete(db, pList); /* Avoid memory leak when malloc fails */
587a76b5dfcSdrh     return 0;
588a76b5dfcSdrh   }
5896ab3a2ecSdanielk1977   pNew->x.pList = pList;
5906ab3a2ecSdanielk1977   assert( !ExprHasProperty(pNew, EP_xIsSelect) );
5914b5255acSdanielk1977   sqlite3ExprSetHeight(pParse, pNew);
592a76b5dfcSdrh   return pNew;
593a76b5dfcSdrh }
594a76b5dfcSdrh 
595a76b5dfcSdrh /*
596fa6bc000Sdrh ** Assign a variable number to an expression that encodes a wildcard
597fa6bc000Sdrh ** in the original SQL statement.
598fa6bc000Sdrh **
599fa6bc000Sdrh ** Wildcards consisting of a single "?" are assigned the next sequential
600fa6bc000Sdrh ** variable number.
601fa6bc000Sdrh **
602fa6bc000Sdrh ** Wildcards of the form "?nnn" are assigned the number "nnn".  We make
603fa6bc000Sdrh ** sure "nnn" is not too be to avoid a denial of service attack when
604fa6bc000Sdrh ** the SQL statement comes from an external source.
605fa6bc000Sdrh **
60651f49f17Sdrh ** Wildcards of the form ":aaa", "@aaa", or "$aaa" are assigned the same number
607fa6bc000Sdrh ** as the previous instance of the same wildcard.  Or if this is the first
608fa6bc000Sdrh ** instance of the wildcard, the next sequenial variable number is
609fa6bc000Sdrh ** assigned.
610fa6bc000Sdrh */
611fa6bc000Sdrh void sqlite3ExprAssignVarNumber(Parse *pParse, Expr *pExpr){
61217435752Sdrh   sqlite3 *db = pParse->db;
613b7916a78Sdrh   const char *z;
61417435752Sdrh 
615fa6bc000Sdrh   if( pExpr==0 ) return;
616c5cd1249Sdrh   assert( !ExprHasProperty(pExpr, EP_IntValue|EP_Reduced|EP_TokenOnly) );
61733e619fcSdrh   z = pExpr->u.zToken;
618b7916a78Sdrh   assert( z!=0 );
619b7916a78Sdrh   assert( z[0]!=0 );
620b7916a78Sdrh   if( z[1]==0 ){
621fa6bc000Sdrh     /* Wildcard of the form "?".  Assign the next variable number */
622b7916a78Sdrh     assert( z[0]=='?' );
6238677d308Sdrh     pExpr->iColumn = (ynVar)(++pParse->nVar);
624124c0b49Sdrh   }else{
625124c0b49Sdrh     ynVar x = 0;
626124c0b49Sdrh     u32 n = sqlite3Strlen30(z);
627124c0b49Sdrh     if( z[0]=='?' ){
628fa6bc000Sdrh       /* Wildcard of the form "?nnn".  Convert "nnn" to an integer and
629fa6bc000Sdrh       ** use it as the variable number */
630c8d735aeSdan       i64 i;
631124c0b49Sdrh       int bOk = 0==sqlite3Atoi64(&z[1], &i, n-1, SQLITE_UTF8);
632124c0b49Sdrh       pExpr->iColumn = x = (ynVar)i;
633c5499befSdrh       testcase( i==0 );
634c5499befSdrh       testcase( i==1 );
635c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]-1 );
636c5499befSdrh       testcase( i==db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] );
637c8d735aeSdan       if( bOk==0 || i<1 || i>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
638fa6bc000Sdrh         sqlite3ErrorMsg(pParse, "variable number must be between ?1 and ?%d",
639bb4957f8Sdrh             db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER]);
640124c0b49Sdrh         x = 0;
641fa6bc000Sdrh       }
642fa6bc000Sdrh       if( i>pParse->nVar ){
6431df2db7fSshaneh         pParse->nVar = (int)i;
644fa6bc000Sdrh       }
645fa6bc000Sdrh     }else{
64651f49f17Sdrh       /* Wildcards like ":aaa", "$aaa" or "@aaa".  Reuse the same variable
647fa6bc000Sdrh       ** number as the prior appearance of the same name, or if the name
648fa6bc000Sdrh       ** has never appeared before, reuse the same variable number
649fa6bc000Sdrh       */
650124c0b49Sdrh       ynVar i;
651124c0b49Sdrh       for(i=0; i<pParse->nzVar; i++){
652503a686eSdrh         if( pParse->azVar[i] && strcmp(pParse->azVar[i],z)==0 ){
653124c0b49Sdrh           pExpr->iColumn = x = (ynVar)i+1;
654fa6bc000Sdrh           break;
655fa6bc000Sdrh         }
656fa6bc000Sdrh       }
657124c0b49Sdrh       if( x==0 ) x = pExpr->iColumn = (ynVar)(++pParse->nVar);
658fa6bc000Sdrh     }
659124c0b49Sdrh     if( x>0 ){
660124c0b49Sdrh       if( x>pParse->nzVar ){
661124c0b49Sdrh         char **a;
662124c0b49Sdrh         a = sqlite3DbRealloc(db, pParse->azVar, x*sizeof(a[0]));
663124c0b49Sdrh         if( a==0 ) return;  /* Error reported through db->mallocFailed */
664124c0b49Sdrh         pParse->azVar = a;
665124c0b49Sdrh         memset(&a[pParse->nzVar], 0, (x-pParse->nzVar)*sizeof(a[0]));
666124c0b49Sdrh         pParse->nzVar = x;
667124c0b49Sdrh       }
668124c0b49Sdrh       if( z[0]!='?' || pParse->azVar[x-1]==0 ){
669124c0b49Sdrh         sqlite3DbFree(db, pParse->azVar[x-1]);
670124c0b49Sdrh         pParse->azVar[x-1] = sqlite3DbStrNDup(db, z, n);
671fa6bc000Sdrh       }
672fa6bc000Sdrh     }
673fa6bc000Sdrh   }
674bb4957f8Sdrh   if( !pParse->nErr && pParse->nVar>db->aLimit[SQLITE_LIMIT_VARIABLE_NUMBER] ){
675832b2664Sdanielk1977     sqlite3ErrorMsg(pParse, "too many SQL variables");
676832b2664Sdanielk1977   }
677fa6bc000Sdrh }
678fa6bc000Sdrh 
679fa6bc000Sdrh /*
680f6963f99Sdan ** Recursively delete an expression tree.
681a2e00042Sdrh */
682f6963f99Sdan void sqlite3ExprDelete(sqlite3 *db, Expr *p){
683f6963f99Sdan   if( p==0 ) return;
684d50ffc41Sdrh   /* Sanity check: Assert that the IntValue is non-negative if it exists */
685d50ffc41Sdrh   assert( !ExprHasProperty(p, EP_IntValue) || p->u.iValue>=0 );
686c5cd1249Sdrh   if( !ExprHasProperty(p, EP_TokenOnly) ){
687c5cd1249Sdrh     /* The Expr.x union is never used at the same time as Expr.pRight */
688c5cd1249Sdrh     assert( p->x.pList==0 || p->pRight==0 );
689633e6d57Sdrh     sqlite3ExprDelete(db, p->pLeft);
690633e6d57Sdrh     sqlite3ExprDelete(db, p->pRight);
691c5cd1249Sdrh     if( ExprHasProperty(p, EP_MemToken) ) sqlite3DbFree(db, p->u.zToken);
6926ab3a2ecSdanielk1977     if( ExprHasProperty(p, EP_xIsSelect) ){
6936ab3a2ecSdanielk1977       sqlite3SelectDelete(db, p->x.pSelect);
6946ab3a2ecSdanielk1977     }else{
6956ab3a2ecSdanielk1977       sqlite3ExprListDelete(db, p->x.pList);
6966ab3a2ecSdanielk1977     }
6976ab3a2ecSdanielk1977   }
69833e619fcSdrh   if( !ExprHasProperty(p, EP_Static) ){
699633e6d57Sdrh     sqlite3DbFree(db, p);
700a2e00042Sdrh   }
70133e619fcSdrh }
702a2e00042Sdrh 
703d2687b77Sdrh /*
7046ab3a2ecSdanielk1977 ** Return the number of bytes allocated for the expression structure
7056ab3a2ecSdanielk1977 ** passed as the first argument. This is always one of EXPR_FULLSIZE,
7066ab3a2ecSdanielk1977 ** EXPR_REDUCEDSIZE or EXPR_TOKENONLYSIZE.
7076ab3a2ecSdanielk1977 */
7086ab3a2ecSdanielk1977 static int exprStructSize(Expr *p){
7096ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_TokenOnly) ) return EXPR_TOKENONLYSIZE;
7106ab3a2ecSdanielk1977   if( ExprHasProperty(p, EP_Reduced) ) return EXPR_REDUCEDSIZE;
7116ab3a2ecSdanielk1977   return EXPR_FULLSIZE;
7126ab3a2ecSdanielk1977 }
7136ab3a2ecSdanielk1977 
7146ab3a2ecSdanielk1977 /*
71533e619fcSdrh ** The dupedExpr*Size() routines each return the number of bytes required
71633e619fcSdrh ** to store a copy of an expression or expression tree.  They differ in
71733e619fcSdrh ** how much of the tree is measured.
71833e619fcSdrh **
71933e619fcSdrh **     dupedExprStructSize()     Size of only the Expr structure
72033e619fcSdrh **     dupedExprNodeSize()       Size of Expr + space for token
72133e619fcSdrh **     dupedExprSize()           Expr + token + subtree components
72233e619fcSdrh **
72333e619fcSdrh ***************************************************************************
72433e619fcSdrh **
72533e619fcSdrh ** The dupedExprStructSize() function returns two values OR-ed together:
72633e619fcSdrh ** (1) the space required for a copy of the Expr structure only and
72733e619fcSdrh ** (2) the EP_xxx flags that indicate what the structure size should be.
72833e619fcSdrh ** The return values is always one of:
72933e619fcSdrh **
73033e619fcSdrh **      EXPR_FULLSIZE
73133e619fcSdrh **      EXPR_REDUCEDSIZE   | EP_Reduced
73233e619fcSdrh **      EXPR_TOKENONLYSIZE | EP_TokenOnly
73333e619fcSdrh **
73433e619fcSdrh ** The size of the structure can be found by masking the return value
73533e619fcSdrh ** of this routine with 0xfff.  The flags can be found by masking the
73633e619fcSdrh ** return value with EP_Reduced|EP_TokenOnly.
73733e619fcSdrh **
73833e619fcSdrh ** Note that with flags==EXPRDUP_REDUCE, this routines works on full-size
73933e619fcSdrh ** (unreduced) Expr objects as they or originally constructed by the parser.
74033e619fcSdrh ** During expression analysis, extra information is computed and moved into
74133e619fcSdrh ** later parts of teh Expr object and that extra information might get chopped
74233e619fcSdrh ** off if the expression is reduced.  Note also that it does not work to
74333e619fcSdrh ** make a EXPRDUP_REDUCE copy of a reduced expression.  It is only legal
74433e619fcSdrh ** to reduce a pristine expression tree from the parser.  The implementation
74533e619fcSdrh ** of dupedExprStructSize() contain multiple assert() statements that attempt
74633e619fcSdrh ** to enforce this constraint.
7476ab3a2ecSdanielk1977 */
7486ab3a2ecSdanielk1977 static int dupedExprStructSize(Expr *p, int flags){
7496ab3a2ecSdanielk1977   int nSize;
75033e619fcSdrh   assert( flags==EXPRDUP_REDUCE || flags==0 ); /* Only one flag value allowed */
751aecd8021Sdrh   assert( EXPR_FULLSIZE<=0xfff );
752aecd8021Sdrh   assert( (0xfff & (EP_Reduced|EP_TokenOnly))==0 );
7536ab3a2ecSdanielk1977   if( 0==(flags&EXPRDUP_REDUCE) ){
7546ab3a2ecSdanielk1977     nSize = EXPR_FULLSIZE;
7556ab3a2ecSdanielk1977   }else{
756c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_TokenOnly|EP_Reduced) );
75733e619fcSdrh     assert( !ExprHasProperty(p, EP_FromJoin) );
758c5cd1249Sdrh     assert( !ExprHasProperty(p, EP_MemToken) );
759ebb6a65dSdrh     assert( !ExprHasProperty(p, EP_NoReduce) );
760aecd8021Sdrh     if( p->pLeft || p->x.pList ){
76133e619fcSdrh       nSize = EXPR_REDUCEDSIZE | EP_Reduced;
76233e619fcSdrh     }else{
763aecd8021Sdrh       assert( p->pRight==0 );
76433e619fcSdrh       nSize = EXPR_TOKENONLYSIZE | EP_TokenOnly;
76533e619fcSdrh     }
7666ab3a2ecSdanielk1977   }
7676ab3a2ecSdanielk1977   return nSize;
7686ab3a2ecSdanielk1977 }
7696ab3a2ecSdanielk1977 
7706ab3a2ecSdanielk1977 /*
77133e619fcSdrh ** This function returns the space in bytes required to store the copy
77233e619fcSdrh ** of the Expr structure and a copy of the Expr.u.zToken string (if that
77333e619fcSdrh ** string is defined.)
7746ab3a2ecSdanielk1977 */
7756ab3a2ecSdanielk1977 static int dupedExprNodeSize(Expr *p, int flags){
77633e619fcSdrh   int nByte = dupedExprStructSize(p, flags) & 0xfff;
77733e619fcSdrh   if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
77833e619fcSdrh     nByte += sqlite3Strlen30(p->u.zToken)+1;
7796ab3a2ecSdanielk1977   }
780bc73971dSdanielk1977   return ROUND8(nByte);
7816ab3a2ecSdanielk1977 }
7826ab3a2ecSdanielk1977 
7836ab3a2ecSdanielk1977 /*
7846ab3a2ecSdanielk1977 ** Return the number of bytes required to create a duplicate of the
7856ab3a2ecSdanielk1977 ** expression passed as the first argument. The second argument is a
7866ab3a2ecSdanielk1977 ** mask containing EXPRDUP_XXX flags.
7876ab3a2ecSdanielk1977 **
7886ab3a2ecSdanielk1977 ** The value returned includes space to create a copy of the Expr struct
78933e619fcSdrh ** itself and the buffer referred to by Expr.u.zToken, if any.
7906ab3a2ecSdanielk1977 **
7916ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the return value includes
7926ab3a2ecSdanielk1977 ** space to duplicate all Expr nodes in the tree formed by Expr.pLeft
7936ab3a2ecSdanielk1977 ** and Expr.pRight variables (but not for any structures pointed to or
7946ab3a2ecSdanielk1977 ** descended from the Expr.x.pList or Expr.x.pSelect variables).
7956ab3a2ecSdanielk1977 */
7966ab3a2ecSdanielk1977 static int dupedExprSize(Expr *p, int flags){
7976ab3a2ecSdanielk1977   int nByte = 0;
7986ab3a2ecSdanielk1977   if( p ){
7996ab3a2ecSdanielk1977     nByte = dupedExprNodeSize(p, flags);
8006ab3a2ecSdanielk1977     if( flags&EXPRDUP_REDUCE ){
801b7916a78Sdrh       nByte += dupedExprSize(p->pLeft, flags) + dupedExprSize(p->pRight, flags);
8026ab3a2ecSdanielk1977     }
8036ab3a2ecSdanielk1977   }
8046ab3a2ecSdanielk1977   return nByte;
8056ab3a2ecSdanielk1977 }
8066ab3a2ecSdanielk1977 
8076ab3a2ecSdanielk1977 /*
8086ab3a2ecSdanielk1977 ** This function is similar to sqlite3ExprDup(), except that if pzBuffer
8096ab3a2ecSdanielk1977 ** is not NULL then *pzBuffer is assumed to point to a buffer large enough
81033e619fcSdrh ** to store the copy of expression p, the copies of p->u.zToken
8116ab3a2ecSdanielk1977 ** (if applicable), and the copies of the p->pLeft and p->pRight expressions,
8126ab3a2ecSdanielk1977 ** if any. Before returning, *pzBuffer is set to the first byte passed the
8136ab3a2ecSdanielk1977 ** portion of the buffer copied into by this function.
8146ab3a2ecSdanielk1977 */
8156ab3a2ecSdanielk1977 static Expr *exprDup(sqlite3 *db, Expr *p, int flags, u8 **pzBuffer){
8166ab3a2ecSdanielk1977   Expr *pNew = 0;                      /* Value to return */
8176ab3a2ecSdanielk1977   if( p ){
8186ab3a2ecSdanielk1977     const int isReduced = (flags&EXPRDUP_REDUCE);
8196ab3a2ecSdanielk1977     u8 *zAlloc;
82033e619fcSdrh     u32 staticFlag = 0;
8216ab3a2ecSdanielk1977 
8226ab3a2ecSdanielk1977     assert( pzBuffer==0 || isReduced );
8236ab3a2ecSdanielk1977 
8246ab3a2ecSdanielk1977     /* Figure out where to write the new Expr structure. */
8256ab3a2ecSdanielk1977     if( pzBuffer ){
8266ab3a2ecSdanielk1977       zAlloc = *pzBuffer;
82733e619fcSdrh       staticFlag = EP_Static;
8286ab3a2ecSdanielk1977     }else{
8296ab3a2ecSdanielk1977       zAlloc = sqlite3DbMallocRaw(db, dupedExprSize(p, flags));
8306ab3a2ecSdanielk1977     }
8316ab3a2ecSdanielk1977     pNew = (Expr *)zAlloc;
8326ab3a2ecSdanielk1977 
8336ab3a2ecSdanielk1977     if( pNew ){
8346ab3a2ecSdanielk1977       /* Set nNewSize to the size allocated for the structure pointed to
8356ab3a2ecSdanielk1977       ** by pNew. This is either EXPR_FULLSIZE, EXPR_REDUCEDSIZE or
8366ab3a2ecSdanielk1977       ** EXPR_TOKENONLYSIZE. nToken is set to the number of bytes consumed
83733e619fcSdrh       ** by the copy of the p->u.zToken string (if any).
8386ab3a2ecSdanielk1977       */
83933e619fcSdrh       const unsigned nStructSize = dupedExprStructSize(p, flags);
84033e619fcSdrh       const int nNewSize = nStructSize & 0xfff;
84133e619fcSdrh       int nToken;
84233e619fcSdrh       if( !ExprHasProperty(p, EP_IntValue) && p->u.zToken ){
84333e619fcSdrh         nToken = sqlite3Strlen30(p->u.zToken) + 1;
84433e619fcSdrh       }else{
84533e619fcSdrh         nToken = 0;
84633e619fcSdrh       }
8476ab3a2ecSdanielk1977       if( isReduced ){
8486ab3a2ecSdanielk1977         assert( ExprHasProperty(p, EP_Reduced)==0 );
8496ab3a2ecSdanielk1977         memcpy(zAlloc, p, nNewSize);
8506ab3a2ecSdanielk1977       }else{
8516ab3a2ecSdanielk1977         int nSize = exprStructSize(p);
8526ab3a2ecSdanielk1977         memcpy(zAlloc, p, nSize);
8536ab3a2ecSdanielk1977         memset(&zAlloc[nSize], 0, EXPR_FULLSIZE-nSize);
8546ab3a2ecSdanielk1977       }
8556ab3a2ecSdanielk1977 
85633e619fcSdrh       /* Set the EP_Reduced, EP_TokenOnly, and EP_Static flags appropriately. */
857c5cd1249Sdrh       pNew->flags &= ~(EP_Reduced|EP_TokenOnly|EP_Static|EP_MemToken);
85833e619fcSdrh       pNew->flags |= nStructSize & (EP_Reduced|EP_TokenOnly);
85933e619fcSdrh       pNew->flags |= staticFlag;
8606ab3a2ecSdanielk1977 
86133e619fcSdrh       /* Copy the p->u.zToken string, if any. */
8626ab3a2ecSdanielk1977       if( nToken ){
86333e619fcSdrh         char *zToken = pNew->u.zToken = (char*)&zAlloc[nNewSize];
86433e619fcSdrh         memcpy(zToken, p->u.zToken, nToken);
8656ab3a2ecSdanielk1977       }
8666ab3a2ecSdanielk1977 
8676ab3a2ecSdanielk1977       if( 0==((p->flags|pNew->flags) & EP_TokenOnly) ){
8686ab3a2ecSdanielk1977         /* Fill in the pNew->x.pSelect or pNew->x.pList member. */
8696ab3a2ecSdanielk1977         if( ExprHasProperty(p, EP_xIsSelect) ){
8706ab3a2ecSdanielk1977           pNew->x.pSelect = sqlite3SelectDup(db, p->x.pSelect, isReduced);
8716ab3a2ecSdanielk1977         }else{
8726ab3a2ecSdanielk1977           pNew->x.pList = sqlite3ExprListDup(db, p->x.pList, isReduced);
8736ab3a2ecSdanielk1977         }
8746ab3a2ecSdanielk1977       }
8756ab3a2ecSdanielk1977 
8766ab3a2ecSdanielk1977       /* Fill in pNew->pLeft and pNew->pRight. */
877c5cd1249Sdrh       if( ExprHasProperty(pNew, EP_Reduced|EP_TokenOnly) ){
8786ab3a2ecSdanielk1977         zAlloc += dupedExprNodeSize(p, flags);
8796ab3a2ecSdanielk1977         if( ExprHasProperty(pNew, EP_Reduced) ){
8806ab3a2ecSdanielk1977           pNew->pLeft = exprDup(db, p->pLeft, EXPRDUP_REDUCE, &zAlloc);
8816ab3a2ecSdanielk1977           pNew->pRight = exprDup(db, p->pRight, EXPRDUP_REDUCE, &zAlloc);
8826ab3a2ecSdanielk1977         }
8836ab3a2ecSdanielk1977         if( pzBuffer ){
8846ab3a2ecSdanielk1977           *pzBuffer = zAlloc;
8856ab3a2ecSdanielk1977         }
886b7916a78Sdrh       }else{
887c5cd1249Sdrh         if( !ExprHasProperty(p, EP_TokenOnly) ){
8886ab3a2ecSdanielk1977           pNew->pLeft = sqlite3ExprDup(db, p->pLeft, 0);
8896ab3a2ecSdanielk1977           pNew->pRight = sqlite3ExprDup(db, p->pRight, 0);
8906ab3a2ecSdanielk1977         }
8916ab3a2ecSdanielk1977       }
892b7916a78Sdrh 
893b7916a78Sdrh     }
8946ab3a2ecSdanielk1977   }
8956ab3a2ecSdanielk1977   return pNew;
8966ab3a2ecSdanielk1977 }
8976ab3a2ecSdanielk1977 
898*4e9119d9Sdan With *withDup(sqlite3 *db, With *p){
899*4e9119d9Sdan   With *pRet = 0;
900*4e9119d9Sdan   if( p ){
901*4e9119d9Sdan     int nByte = sizeof(*p) + sizeof(p->a[0]) * (p->nCte-1);
902*4e9119d9Sdan     pRet = sqlite3DbMallocZero(db, nByte);
903*4e9119d9Sdan     if( pRet ){
904*4e9119d9Sdan       int i;
905*4e9119d9Sdan       pRet->nCte = p->nCte;
906*4e9119d9Sdan       for(i=0; i<p->nCte; i++){
907*4e9119d9Sdan         pRet->a[i].pSelect = sqlite3SelectDup(db, p->a[i].pSelect, 0);
908*4e9119d9Sdan         pRet->a[i].pCols = sqlite3ExprListDup(db, p->a[i].pCols, 0);
909*4e9119d9Sdan         pRet->a[i].zName = sqlite3DbStrDup(db, p->a[i].zName);
910*4e9119d9Sdan       }
911*4e9119d9Sdan     }
912*4e9119d9Sdan   }
913*4e9119d9Sdan   return pRet;
914*4e9119d9Sdan }
915*4e9119d9Sdan 
9166ab3a2ecSdanielk1977 /*
917ff78bd2fSdrh ** The following group of routines make deep copies of expressions,
918ff78bd2fSdrh ** expression lists, ID lists, and select statements.  The copies can
919ff78bd2fSdrh ** be deleted (by being passed to their respective ...Delete() routines)
920ff78bd2fSdrh ** without effecting the originals.
921ff78bd2fSdrh **
9224adee20fSdanielk1977 ** The expression list, ID, and source lists return by sqlite3ExprListDup(),
9234adee20fSdanielk1977 ** sqlite3IdListDup(), and sqlite3SrcListDup() can not be further expanded
924ad3cab52Sdrh ** by subsequent calls to sqlite*ListAppend() routines.
925ff78bd2fSdrh **
926ad3cab52Sdrh ** Any tables that the SrcList might point to are not duplicated.
9276ab3a2ecSdanielk1977 **
928b7916a78Sdrh ** The flags parameter contains a combination of the EXPRDUP_XXX flags.
9296ab3a2ecSdanielk1977 ** If the EXPRDUP_REDUCE flag is set, then the structure returned is a
9306ab3a2ecSdanielk1977 ** truncated version of the usual Expr structure that will be stored as
9316ab3a2ecSdanielk1977 ** part of the in-memory representation of the database schema.
932ff78bd2fSdrh */
9336ab3a2ecSdanielk1977 Expr *sqlite3ExprDup(sqlite3 *db, Expr *p, int flags){
9346ab3a2ecSdanielk1977   return exprDup(db, p, flags, 0);
935ff78bd2fSdrh }
9366ab3a2ecSdanielk1977 ExprList *sqlite3ExprListDup(sqlite3 *db, ExprList *p, int flags){
937ff78bd2fSdrh   ExprList *pNew;
938145716b3Sdrh   struct ExprList_item *pItem, *pOldItem;
939ff78bd2fSdrh   int i;
940ff78bd2fSdrh   if( p==0 ) return 0;
94117435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
942ff78bd2fSdrh   if( pNew==0 ) return 0;
94331dad9daSdanielk1977   pNew->iECursor = 0;
944d872bb18Sdrh   pNew->nExpr = i = p->nExpr;
945d872bb18Sdrh   if( (flags & EXPRDUP_REDUCE)==0 ) for(i=1; i<p->nExpr; i+=i){}
946d872bb18Sdrh   pNew->a = pItem = sqlite3DbMallocRaw(db,  i*sizeof(p->a[0]) );
947e0048400Sdanielk1977   if( pItem==0 ){
948633e6d57Sdrh     sqlite3DbFree(db, pNew);
949e0048400Sdanielk1977     return 0;
950e0048400Sdanielk1977   }
951145716b3Sdrh   pOldItem = p->a;
952145716b3Sdrh   for(i=0; i<p->nExpr; i++, pItem++, pOldItem++){
9536ab3a2ecSdanielk1977     Expr *pOldExpr = pOldItem->pExpr;
954b5526ea6Sdrh     pItem->pExpr = sqlite3ExprDup(db, pOldExpr, flags);
95517435752Sdrh     pItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
956b7916a78Sdrh     pItem->zSpan = sqlite3DbStrDup(db, pOldItem->zSpan);
957145716b3Sdrh     pItem->sortOrder = pOldItem->sortOrder;
9583e7bc9caSdrh     pItem->done = 0;
9592c036cffSdrh     pItem->bSpanIsTab = pOldItem->bSpanIsTab;
960c2acc4e4Sdrh     pItem->u = pOldItem->u;
961ff78bd2fSdrh   }
962ff78bd2fSdrh   return pNew;
963ff78bd2fSdrh }
96493758c8dSdanielk1977 
96593758c8dSdanielk1977 /*
96693758c8dSdanielk1977 ** If cursors, triggers, views and subqueries are all omitted from
96793758c8dSdanielk1977 ** the build, then none of the following routines, except for
96893758c8dSdanielk1977 ** sqlite3SelectDup(), can be called. sqlite3SelectDup() is sometimes
96993758c8dSdanielk1977 ** called with a NULL argument.
97093758c8dSdanielk1977 */
9716a67fe8eSdanielk1977 #if !defined(SQLITE_OMIT_VIEW) || !defined(SQLITE_OMIT_TRIGGER) \
9726a67fe8eSdanielk1977  || !defined(SQLITE_OMIT_SUBQUERY)
9736ab3a2ecSdanielk1977 SrcList *sqlite3SrcListDup(sqlite3 *db, SrcList *p, int flags){
974ad3cab52Sdrh   SrcList *pNew;
975ad3cab52Sdrh   int i;
976113088ecSdrh   int nByte;
977ad3cab52Sdrh   if( p==0 ) return 0;
978113088ecSdrh   nByte = sizeof(*p) + (p->nSrc>0 ? sizeof(p->a[0]) * (p->nSrc-1) : 0);
97917435752Sdrh   pNew = sqlite3DbMallocRaw(db, nByte );
980ad3cab52Sdrh   if( pNew==0 ) return 0;
9814305d103Sdrh   pNew->nSrc = pNew->nAlloc = p->nSrc;
982ad3cab52Sdrh   for(i=0; i<p->nSrc; i++){
9834efc4754Sdrh     struct SrcList_item *pNewItem = &pNew->a[i];
9844efc4754Sdrh     struct SrcList_item *pOldItem = &p->a[i];
985ed8a3bb1Sdrh     Table *pTab;
98641fb5cd1Sdan     pNewItem->pSchema = pOldItem->pSchema;
98717435752Sdrh     pNewItem->zDatabase = sqlite3DbStrDup(db, pOldItem->zDatabase);
98817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
98917435752Sdrh     pNewItem->zAlias = sqlite3DbStrDup(db, pOldItem->zAlias);
9904efc4754Sdrh     pNewItem->jointype = pOldItem->jointype;
9914efc4754Sdrh     pNewItem->iCursor = pOldItem->iCursor;
9925b6a9ed4Sdrh     pNewItem->addrFillSub = pOldItem->addrFillSub;
9935b6a9ed4Sdrh     pNewItem->regReturn = pOldItem->regReturn;
994da79cf0cSdan     pNewItem->isCorrelated = pOldItem->isCorrelated;
99521172c4cSdrh     pNewItem->viaCoroutine = pOldItem->viaCoroutine;
99685574e31Sdanielk1977     pNewItem->zIndex = sqlite3DbStrDup(db, pOldItem->zIndex);
99785574e31Sdanielk1977     pNewItem->notIndexed = pOldItem->notIndexed;
99885574e31Sdanielk1977     pNewItem->pIndex = pOldItem->pIndex;
999ed8a3bb1Sdrh     pTab = pNewItem->pTab = pOldItem->pTab;
1000ed8a3bb1Sdrh     if( pTab ){
1001ed8a3bb1Sdrh       pTab->nRef++;
1002a1cb183dSdanielk1977     }
10036ab3a2ecSdanielk1977     pNewItem->pSelect = sqlite3SelectDup(db, pOldItem->pSelect, flags);
10046ab3a2ecSdanielk1977     pNewItem->pOn = sqlite3ExprDup(db, pOldItem->pOn, flags);
100517435752Sdrh     pNewItem->pUsing = sqlite3IdListDup(db, pOldItem->pUsing);
10066c18b6e0Sdanielk1977     pNewItem->colUsed = pOldItem->colUsed;
1007ad3cab52Sdrh   }
1008ad3cab52Sdrh   return pNew;
1009ad3cab52Sdrh }
101017435752Sdrh IdList *sqlite3IdListDup(sqlite3 *db, IdList *p){
1011ff78bd2fSdrh   IdList *pNew;
1012ff78bd2fSdrh   int i;
1013ff78bd2fSdrh   if( p==0 ) return 0;
101417435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*pNew) );
1015ff78bd2fSdrh   if( pNew==0 ) return 0;
10166c535158Sdrh   pNew->nId = p->nId;
101717435752Sdrh   pNew->a = sqlite3DbMallocRaw(db, p->nId*sizeof(p->a[0]) );
1018d5d56523Sdanielk1977   if( pNew->a==0 ){
1019633e6d57Sdrh     sqlite3DbFree(db, pNew);
1020d5d56523Sdanielk1977     return 0;
1021d5d56523Sdanielk1977   }
10226c535158Sdrh   /* Note that because the size of the allocation for p->a[] is not
10236c535158Sdrh   ** necessarily a power of two, sqlite3IdListAppend() may not be called
10246c535158Sdrh   ** on the duplicate created by this function. */
1025ff78bd2fSdrh   for(i=0; i<p->nId; i++){
10264efc4754Sdrh     struct IdList_item *pNewItem = &pNew->a[i];
10274efc4754Sdrh     struct IdList_item *pOldItem = &p->a[i];
102817435752Sdrh     pNewItem->zName = sqlite3DbStrDup(db, pOldItem->zName);
10294efc4754Sdrh     pNewItem->idx = pOldItem->idx;
1030ff78bd2fSdrh   }
1031ff78bd2fSdrh   return pNew;
1032ff78bd2fSdrh }
10336ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
103423b1b372Sdrh   Select *pNew, *pPrior;
1035ff78bd2fSdrh   if( p==0 ) return 0;
103617435752Sdrh   pNew = sqlite3DbMallocRaw(db, sizeof(*p) );
1037ff78bd2fSdrh   if( pNew==0 ) return 0;
1038b7916a78Sdrh   pNew->pEList = sqlite3ExprListDup(db, p->pEList, flags);
10396ab3a2ecSdanielk1977   pNew->pSrc = sqlite3SrcListDup(db, p->pSrc, flags);
10406ab3a2ecSdanielk1977   pNew->pWhere = sqlite3ExprDup(db, p->pWhere, flags);
10416ab3a2ecSdanielk1977   pNew->pGroupBy = sqlite3ExprListDup(db, p->pGroupBy, flags);
10426ab3a2ecSdanielk1977   pNew->pHaving = sqlite3ExprDup(db, p->pHaving, flags);
10436ab3a2ecSdanielk1977   pNew->pOrderBy = sqlite3ExprListDup(db, p->pOrderBy, flags);
1044ff78bd2fSdrh   pNew->op = p->op;
104523b1b372Sdrh   pNew->pPrior = pPrior = sqlite3SelectDup(db, p->pPrior, flags);
104623b1b372Sdrh   if( pPrior ) pPrior->pNext = pNew;
104723b1b372Sdrh   pNew->pNext = 0;
10486ab3a2ecSdanielk1977   pNew->pLimit = sqlite3ExprDup(db, p->pLimit, flags);
10496ab3a2ecSdanielk1977   pNew->pOffset = sqlite3ExprDup(db, p->pOffset, flags);
105092b01d53Sdrh   pNew->iLimit = 0;
105192b01d53Sdrh   pNew->iOffset = 0;
10527d10d5a6Sdrh   pNew->selFlags = p->selFlags & ~SF_UsesEphemeral;
10530342b1f5Sdrh   pNew->pRightmost = 0;
1054b9bb7c18Sdrh   pNew->addrOpenEphm[0] = -1;
1055b9bb7c18Sdrh   pNew->addrOpenEphm[1] = -1;
1056b9bb7c18Sdrh   pNew->addrOpenEphm[2] = -1;
1057*4e9119d9Sdan   pNew->pWith = withDup(db, p->pWith);
1058ff78bd2fSdrh   return pNew;
1059ff78bd2fSdrh }
106093758c8dSdanielk1977 #else
10616ab3a2ecSdanielk1977 Select *sqlite3SelectDup(sqlite3 *db, Select *p, int flags){
106293758c8dSdanielk1977   assert( p==0 );
106393758c8dSdanielk1977   return 0;
106493758c8dSdanielk1977 }
106593758c8dSdanielk1977 #endif
1066ff78bd2fSdrh 
1067ff78bd2fSdrh 
1068ff78bd2fSdrh /*
1069a76b5dfcSdrh ** Add a new element to the end of an expression list.  If pList is
1070a76b5dfcSdrh ** initially NULL, then create a new expression list.
1071b7916a78Sdrh **
1072b7916a78Sdrh ** If a memory allocation error occurs, the entire list is freed and
1073b7916a78Sdrh ** NULL is returned.  If non-NULL is returned, then it is guaranteed
1074b7916a78Sdrh ** that the new entry was successfully appended.
1075a76b5dfcSdrh */
107617435752Sdrh ExprList *sqlite3ExprListAppend(
107717435752Sdrh   Parse *pParse,          /* Parsing context */
107817435752Sdrh   ExprList *pList,        /* List to which to append. Might be NULL */
1079b7916a78Sdrh   Expr *pExpr             /* Expression to be appended. Might be NULL */
108017435752Sdrh ){
108117435752Sdrh   sqlite3 *db = pParse->db;
1082a76b5dfcSdrh   if( pList==0 ){
108317435752Sdrh     pList = sqlite3DbMallocZero(db, sizeof(ExprList) );
1084a76b5dfcSdrh     if( pList==0 ){
1085d5d56523Sdanielk1977       goto no_mem;
1086a76b5dfcSdrh     }
1087d872bb18Sdrh     pList->a = sqlite3DbMallocRaw(db, sizeof(pList->a[0]));
1088d872bb18Sdrh     if( pList->a==0 ) goto no_mem;
1089d872bb18Sdrh   }else if( (pList->nExpr & (pList->nExpr-1))==0 ){
1090d5d56523Sdanielk1977     struct ExprList_item *a;
1091d872bb18Sdrh     assert( pList->nExpr>0 );
1092d872bb18Sdrh     a = sqlite3DbRealloc(db, pList->a, pList->nExpr*2*sizeof(pList->a[0]));
1093d5d56523Sdanielk1977     if( a==0 ){
1094d5d56523Sdanielk1977       goto no_mem;
1095a76b5dfcSdrh     }
1096d5d56523Sdanielk1977     pList->a = a;
1097a76b5dfcSdrh   }
10984efc4754Sdrh   assert( pList->a!=0 );
1099b7916a78Sdrh   if( 1 ){
11004efc4754Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr++];
11014efc4754Sdrh     memset(pItem, 0, sizeof(*pItem));
1102e94ddc9eSdanielk1977     pItem->pExpr = pExpr;
1103a76b5dfcSdrh   }
1104a76b5dfcSdrh   return pList;
1105d5d56523Sdanielk1977 
1106d5d56523Sdanielk1977 no_mem:
1107d5d56523Sdanielk1977   /* Avoid leaking memory if malloc has failed. */
1108633e6d57Sdrh   sqlite3ExprDelete(db, pExpr);
1109633e6d57Sdrh   sqlite3ExprListDelete(db, pList);
1110d5d56523Sdanielk1977   return 0;
1111a76b5dfcSdrh }
1112a76b5dfcSdrh 
1113a76b5dfcSdrh /*
1114b7916a78Sdrh ** Set the ExprList.a[].zName element of the most recently added item
1115b7916a78Sdrh ** on the expression list.
1116b7916a78Sdrh **
1117b7916a78Sdrh ** pList might be NULL following an OOM error.  But pName should never be
1118b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1119b7916a78Sdrh ** is set.
1120b7916a78Sdrh */
1121b7916a78Sdrh void sqlite3ExprListSetName(
1122b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1123b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1124b7916a78Sdrh   Token *pName,           /* Name to be added */
1125b7916a78Sdrh   int dequote             /* True to cause the name to be dequoted */
1126b7916a78Sdrh ){
1127b7916a78Sdrh   assert( pList!=0 || pParse->db->mallocFailed!=0 );
1128b7916a78Sdrh   if( pList ){
1129b7916a78Sdrh     struct ExprList_item *pItem;
1130b7916a78Sdrh     assert( pList->nExpr>0 );
1131b7916a78Sdrh     pItem = &pList->a[pList->nExpr-1];
1132b7916a78Sdrh     assert( pItem->zName==0 );
1133b7916a78Sdrh     pItem->zName = sqlite3DbStrNDup(pParse->db, pName->z, pName->n);
1134b7916a78Sdrh     if( dequote && pItem->zName ) sqlite3Dequote(pItem->zName);
1135b7916a78Sdrh   }
1136b7916a78Sdrh }
1137b7916a78Sdrh 
1138b7916a78Sdrh /*
1139b7916a78Sdrh ** Set the ExprList.a[].zSpan element of the most recently added item
1140b7916a78Sdrh ** on the expression list.
1141b7916a78Sdrh **
1142b7916a78Sdrh ** pList might be NULL following an OOM error.  But pSpan should never be
1143b7916a78Sdrh ** NULL.  If a memory allocation fails, the pParse->db->mallocFailed flag
1144b7916a78Sdrh ** is set.
1145b7916a78Sdrh */
1146b7916a78Sdrh void sqlite3ExprListSetSpan(
1147b7916a78Sdrh   Parse *pParse,          /* Parsing context */
1148b7916a78Sdrh   ExprList *pList,        /* List to which to add the span. */
1149b7916a78Sdrh   ExprSpan *pSpan         /* The span to be added */
1150b7916a78Sdrh ){
1151b7916a78Sdrh   sqlite3 *db = pParse->db;
1152b7916a78Sdrh   assert( pList!=0 || db->mallocFailed!=0 );
1153b7916a78Sdrh   if( pList ){
1154b7916a78Sdrh     struct ExprList_item *pItem = &pList->a[pList->nExpr-1];
1155b7916a78Sdrh     assert( pList->nExpr>0 );
1156b7916a78Sdrh     assert( db->mallocFailed || pItem->pExpr==pSpan->pExpr );
1157b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1158b7916a78Sdrh     pItem->zSpan = sqlite3DbStrNDup(db, (char*)pSpan->zStart,
1159cf697396Sshane                                     (int)(pSpan->zEnd - pSpan->zStart));
1160b7916a78Sdrh   }
1161b7916a78Sdrh }
1162b7916a78Sdrh 
1163b7916a78Sdrh /*
11647a15a4beSdanielk1977 ** If the expression list pEList contains more than iLimit elements,
11657a15a4beSdanielk1977 ** leave an error message in pParse.
11667a15a4beSdanielk1977 */
11677a15a4beSdanielk1977 void sqlite3ExprListCheckLength(
11687a15a4beSdanielk1977   Parse *pParse,
11697a15a4beSdanielk1977   ExprList *pEList,
11707a15a4beSdanielk1977   const char *zObject
11717a15a4beSdanielk1977 ){
1172b1a6c3c1Sdrh   int mx = pParse->db->aLimit[SQLITE_LIMIT_COLUMN];
1173c5499befSdrh   testcase( pEList && pEList->nExpr==mx );
1174c5499befSdrh   testcase( pEList && pEList->nExpr==mx+1 );
1175b1a6c3c1Sdrh   if( pEList && pEList->nExpr>mx ){
11767a15a4beSdanielk1977     sqlite3ErrorMsg(pParse, "too many columns in %s", zObject);
11777a15a4beSdanielk1977   }
11787a15a4beSdanielk1977 }
11797a15a4beSdanielk1977 
11807a15a4beSdanielk1977 /*
1181a76b5dfcSdrh ** Delete an entire expression list.
1182a76b5dfcSdrh */
1183633e6d57Sdrh void sqlite3ExprListDelete(sqlite3 *db, ExprList *pList){
1184a76b5dfcSdrh   int i;
1185be5c89acSdrh   struct ExprList_item *pItem;
1186a76b5dfcSdrh   if( pList==0 ) return;
1187d872bb18Sdrh   assert( pList->a!=0 || pList->nExpr==0 );
1188be5c89acSdrh   for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
1189633e6d57Sdrh     sqlite3ExprDelete(db, pItem->pExpr);
1190633e6d57Sdrh     sqlite3DbFree(db, pItem->zName);
1191b7916a78Sdrh     sqlite3DbFree(db, pItem->zSpan);
1192a76b5dfcSdrh   }
1193633e6d57Sdrh   sqlite3DbFree(db, pList->a);
1194633e6d57Sdrh   sqlite3DbFree(db, pList);
1195a76b5dfcSdrh }
1196a76b5dfcSdrh 
1197a76b5dfcSdrh /*
11987d10d5a6Sdrh ** These routines are Walker callbacks.  Walker.u.pi is a pointer
11997d10d5a6Sdrh ** to an integer.  These routines are checking an expression to see
12007d10d5a6Sdrh ** if it is a constant.  Set *Walker.u.pi to 0 if the expression is
12017d10d5a6Sdrh ** not constant.
120273b211abSdrh **
12037d10d5a6Sdrh ** These callback routines are used to implement the following:
1204626a879aSdrh **
12057d10d5a6Sdrh **     sqlite3ExprIsConstant()
12067d10d5a6Sdrh **     sqlite3ExprIsConstantNotJoin()
12077d10d5a6Sdrh **     sqlite3ExprIsConstantOrFunction()
120887abf5c0Sdrh **
1209626a879aSdrh */
12107d10d5a6Sdrh static int exprNodeIsConstant(Walker *pWalker, Expr *pExpr){
1211626a879aSdrh 
12127d10d5a6Sdrh   /* If pWalker->u.i is 3 then any term of the expression that comes from
12130a168377Sdrh   ** the ON or USING clauses of a join disqualifies the expression
12140a168377Sdrh   ** from being considered constant. */
1215c5cd1249Sdrh   if( pWalker->u.i==3 && ExprHasProperty(pExpr, EP_FromJoin) ){
12167d10d5a6Sdrh     pWalker->u.i = 0;
12177d10d5a6Sdrh     return WRC_Abort;
12180a168377Sdrh   }
12190a168377Sdrh 
1220626a879aSdrh   switch( pExpr->op ){
1221eb55bd2fSdrh     /* Consider functions to be constant if all their arguments are constant
1222b1fba286Sdrh     ** and either pWalker->u.i==2 or the function as the SQLITE_FUNC_CONST
1223b1fba286Sdrh     ** flag. */
1224eb55bd2fSdrh     case TK_FUNCTION:
1225b1fba286Sdrh       if( pWalker->u.i==2 || ExprHasProperty(pExpr,EP_Constant) ){
1226b1fba286Sdrh         return WRC_Continue;
1227b1fba286Sdrh       }
1228eb55bd2fSdrh       /* Fall through */
1229626a879aSdrh     case TK_ID:
1230626a879aSdrh     case TK_COLUMN:
1231626a879aSdrh     case TK_AGG_FUNCTION:
123213449892Sdrh     case TK_AGG_COLUMN:
1233c5499befSdrh       testcase( pExpr->op==TK_ID );
1234c5499befSdrh       testcase( pExpr->op==TK_COLUMN );
1235c5499befSdrh       testcase( pExpr->op==TK_AGG_FUNCTION );
1236c5499befSdrh       testcase( pExpr->op==TK_AGG_COLUMN );
12377d10d5a6Sdrh       pWalker->u.i = 0;
12387d10d5a6Sdrh       return WRC_Abort;
1239626a879aSdrh     default:
1240b74b1017Sdrh       testcase( pExpr->op==TK_SELECT ); /* selectNodeIsConstant will disallow */
1241b74b1017Sdrh       testcase( pExpr->op==TK_EXISTS ); /* selectNodeIsConstant will disallow */
12427d10d5a6Sdrh       return WRC_Continue;
1243626a879aSdrh   }
1244626a879aSdrh }
124562c14b34Sdanielk1977 static int selectNodeIsConstant(Walker *pWalker, Select *NotUsed){
124662c14b34Sdanielk1977   UNUSED_PARAMETER(NotUsed);
12477d10d5a6Sdrh   pWalker->u.i = 0;
12487d10d5a6Sdrh   return WRC_Abort;
12497d10d5a6Sdrh }
12507d10d5a6Sdrh static int exprIsConst(Expr *p, int initFlag){
12517d10d5a6Sdrh   Walker w;
1252aa87f9a6Sdrh   memset(&w, 0, sizeof(w));
12537d10d5a6Sdrh   w.u.i = initFlag;
12547d10d5a6Sdrh   w.xExprCallback = exprNodeIsConstant;
12557d10d5a6Sdrh   w.xSelectCallback = selectNodeIsConstant;
12567d10d5a6Sdrh   sqlite3WalkExpr(&w, p);
12577d10d5a6Sdrh   return w.u.i;
12587d10d5a6Sdrh }
1259626a879aSdrh 
1260626a879aSdrh /*
1261fef5208cSdrh ** Walk an expression tree.  Return 1 if the expression is constant
1262eb55bd2fSdrh ** and 0 if it involves variables or function calls.
12632398937bSdrh **
12642398937bSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
12652398937bSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
12662398937bSdrh ** a constant.
1267fef5208cSdrh */
12684adee20fSdanielk1977 int sqlite3ExprIsConstant(Expr *p){
12697d10d5a6Sdrh   return exprIsConst(p, 1);
1270fef5208cSdrh }
1271fef5208cSdrh 
1272fef5208cSdrh /*
1273eb55bd2fSdrh ** Walk an expression tree.  Return 1 if the expression is constant
12740a168377Sdrh ** that does no originate from the ON or USING clauses of a join.
12750a168377Sdrh ** Return 0 if it involves variables or function calls or terms from
12760a168377Sdrh ** an ON or USING clause.
12770a168377Sdrh */
12780a168377Sdrh int sqlite3ExprIsConstantNotJoin(Expr *p){
12797d10d5a6Sdrh   return exprIsConst(p, 3);
12800a168377Sdrh }
12810a168377Sdrh 
12820a168377Sdrh /*
12830a168377Sdrh ** Walk an expression tree.  Return 1 if the expression is constant
1284eb55bd2fSdrh ** or a function call with constant arguments.  Return and 0 if there
1285eb55bd2fSdrh ** are any variables.
1286eb55bd2fSdrh **
1287eb55bd2fSdrh ** For the purposes of this function, a double-quoted string (ex: "abc")
1288eb55bd2fSdrh ** is considered a variable but a single-quoted string (ex: 'abc') is
1289eb55bd2fSdrh ** a constant.
1290eb55bd2fSdrh */
1291eb55bd2fSdrh int sqlite3ExprIsConstantOrFunction(Expr *p){
12927d10d5a6Sdrh   return exprIsConst(p, 2);
1293eb55bd2fSdrh }
1294eb55bd2fSdrh 
1295eb55bd2fSdrh /*
129673b211abSdrh ** If the expression p codes a constant integer that is small enough
1297202b2df7Sdrh ** to fit in a 32-bit integer, return 1 and put the value of the integer
1298202b2df7Sdrh ** in *pValue.  If the expression is not an integer or if it is too big
1299202b2df7Sdrh ** to fit in a signed 32-bit integer, return 0 and leave *pValue unchanged.
1300e4de1febSdrh */
13014adee20fSdanielk1977 int sqlite3ExprIsInteger(Expr *p, int *pValue){
130292b01d53Sdrh   int rc = 0;
1303cd92e84dSdrh 
1304cd92e84dSdrh   /* If an expression is an integer literal that fits in a signed 32-bit
1305cd92e84dSdrh   ** integer, then the EP_IntValue flag will have already been set */
1306cd92e84dSdrh   assert( p->op!=TK_INTEGER || (p->flags & EP_IntValue)!=0
1307cd92e84dSdrh            || sqlite3GetInt32(p->u.zToken, &rc)==0 );
1308cd92e84dSdrh 
130992b01d53Sdrh   if( p->flags & EP_IntValue ){
131033e619fcSdrh     *pValue = p->u.iValue;
1311e4de1febSdrh     return 1;
1312e4de1febSdrh   }
131392b01d53Sdrh   switch( p->op ){
13144b59ab5eSdrh     case TK_UPLUS: {
131592b01d53Sdrh       rc = sqlite3ExprIsInteger(p->pLeft, pValue);
1316f6e369a1Sdrh       break;
13174b59ab5eSdrh     }
1318e4de1febSdrh     case TK_UMINUS: {
1319e4de1febSdrh       int v;
13204adee20fSdanielk1977       if( sqlite3ExprIsInteger(p->pLeft, &v) ){
1321f6418891Smistachkin         assert( v!=(-2147483647-1) );
1322e4de1febSdrh         *pValue = -v;
132392b01d53Sdrh         rc = 1;
1324e4de1febSdrh       }
1325e4de1febSdrh       break;
1326e4de1febSdrh     }
1327e4de1febSdrh     default: break;
1328e4de1febSdrh   }
132992b01d53Sdrh   return rc;
1330e4de1febSdrh }
1331e4de1febSdrh 
1332e4de1febSdrh /*
1333039fc32eSdrh ** Return FALSE if there is no chance that the expression can be NULL.
1334039fc32eSdrh **
1335039fc32eSdrh ** If the expression might be NULL or if the expression is too complex
1336039fc32eSdrh ** to tell return TRUE.
1337039fc32eSdrh **
1338039fc32eSdrh ** This routine is used as an optimization, to skip OP_IsNull opcodes
1339039fc32eSdrh ** when we know that a value cannot be NULL.  Hence, a false positive
1340039fc32eSdrh ** (returning TRUE when in fact the expression can never be NULL) might
1341039fc32eSdrh ** be a small performance hit but is otherwise harmless.  On the other
1342039fc32eSdrh ** hand, a false negative (returning FALSE when the result could be NULL)
1343039fc32eSdrh ** will likely result in an incorrect answer.  So when in doubt, return
1344039fc32eSdrh ** TRUE.
1345039fc32eSdrh */
1346039fc32eSdrh int sqlite3ExprCanBeNull(const Expr *p){
1347039fc32eSdrh   u8 op;
1348cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1349039fc32eSdrh   op = p->op;
1350039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1351039fc32eSdrh   switch( op ){
1352039fc32eSdrh     case TK_INTEGER:
1353039fc32eSdrh     case TK_STRING:
1354039fc32eSdrh     case TK_FLOAT:
1355039fc32eSdrh     case TK_BLOB:
1356039fc32eSdrh       return 0;
1357039fc32eSdrh     default:
1358039fc32eSdrh       return 1;
1359039fc32eSdrh   }
1360039fc32eSdrh }
1361039fc32eSdrh 
1362039fc32eSdrh /*
13632f2855b6Sdrh ** Generate an OP_IsNull instruction that tests register iReg and jumps
13642f2855b6Sdrh ** to location iDest if the value in iReg is NULL.  The value in iReg
13652f2855b6Sdrh ** was computed by pExpr.  If we can look at pExpr at compile-time and
13662f2855b6Sdrh ** determine that it can never generate a NULL, then the OP_IsNull operation
13672f2855b6Sdrh ** can be omitted.
13682f2855b6Sdrh */
13692f2855b6Sdrh void sqlite3ExprCodeIsNullJump(
13702f2855b6Sdrh   Vdbe *v,            /* The VDBE under construction */
13712f2855b6Sdrh   const Expr *pExpr,  /* Only generate OP_IsNull if this expr can be NULL */
13722f2855b6Sdrh   int iReg,           /* Test the value in this register for NULL */
13732f2855b6Sdrh   int iDest           /* Jump here if the value is null */
13742f2855b6Sdrh ){
13752f2855b6Sdrh   if( sqlite3ExprCanBeNull(pExpr) ){
13762f2855b6Sdrh     sqlite3VdbeAddOp2(v, OP_IsNull, iReg, iDest);
13772f2855b6Sdrh   }
13782f2855b6Sdrh }
13792f2855b6Sdrh 
13802f2855b6Sdrh /*
1381039fc32eSdrh ** Return TRUE if the given expression is a constant which would be
1382039fc32eSdrh ** unchanged by OP_Affinity with the affinity given in the second
1383039fc32eSdrh ** argument.
1384039fc32eSdrh **
1385039fc32eSdrh ** This routine is used to determine if the OP_Affinity operation
1386039fc32eSdrh ** can be omitted.  When in doubt return FALSE.  A false negative
1387039fc32eSdrh ** is harmless.  A false positive, however, can result in the wrong
1388039fc32eSdrh ** answer.
1389039fc32eSdrh */
1390039fc32eSdrh int sqlite3ExprNeedsNoAffinityChange(const Expr *p, char aff){
1391039fc32eSdrh   u8 op;
1392039fc32eSdrh   if( aff==SQLITE_AFF_NONE ) return 1;
1393cd7f457eSdrh   while( p->op==TK_UPLUS || p->op==TK_UMINUS ){ p = p->pLeft; }
1394039fc32eSdrh   op = p->op;
1395039fc32eSdrh   if( op==TK_REGISTER ) op = p->op2;
1396039fc32eSdrh   switch( op ){
1397039fc32eSdrh     case TK_INTEGER: {
1398039fc32eSdrh       return aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC;
1399039fc32eSdrh     }
1400039fc32eSdrh     case TK_FLOAT: {
1401039fc32eSdrh       return aff==SQLITE_AFF_REAL || aff==SQLITE_AFF_NUMERIC;
1402039fc32eSdrh     }
1403039fc32eSdrh     case TK_STRING: {
1404039fc32eSdrh       return aff==SQLITE_AFF_TEXT;
1405039fc32eSdrh     }
1406039fc32eSdrh     case TK_BLOB: {
1407039fc32eSdrh       return 1;
1408039fc32eSdrh     }
14092f2855b6Sdrh     case TK_COLUMN: {
141088376ca7Sdrh       assert( p->iTable>=0 );  /* p cannot be part of a CHECK constraint */
141188376ca7Sdrh       return p->iColumn<0
14122f2855b6Sdrh           && (aff==SQLITE_AFF_INTEGER || aff==SQLITE_AFF_NUMERIC);
14132f2855b6Sdrh     }
1414039fc32eSdrh     default: {
1415039fc32eSdrh       return 0;
1416039fc32eSdrh     }
1417039fc32eSdrh   }
1418039fc32eSdrh }
1419039fc32eSdrh 
1420039fc32eSdrh /*
1421c4a3c779Sdrh ** Return TRUE if the given string is a row-id column name.
1422c4a3c779Sdrh */
14234adee20fSdanielk1977 int sqlite3IsRowid(const char *z){
14244adee20fSdanielk1977   if( sqlite3StrICmp(z, "_ROWID_")==0 ) return 1;
14254adee20fSdanielk1977   if( sqlite3StrICmp(z, "ROWID")==0 ) return 1;
14264adee20fSdanielk1977   if( sqlite3StrICmp(z, "OID")==0 ) return 1;
1427c4a3c779Sdrh   return 0;
1428c4a3c779Sdrh }
1429c4a3c779Sdrh 
14309a96b668Sdanielk1977 /*
1431b74b1017Sdrh ** Return true if we are able to the IN operator optimization on a
1432b74b1017Sdrh ** query of the form
1433b287f4b6Sdrh **
1434b74b1017Sdrh **       x IN (SELECT ...)
1435b287f4b6Sdrh **
1436b74b1017Sdrh ** Where the SELECT... clause is as specified by the parameter to this
1437b74b1017Sdrh ** routine.
1438b74b1017Sdrh **
1439b74b1017Sdrh ** The Select object passed in has already been preprocessed and no
1440b74b1017Sdrh ** errors have been found.
1441b287f4b6Sdrh */
1442b287f4b6Sdrh #ifndef SQLITE_OMIT_SUBQUERY
1443b287f4b6Sdrh static int isCandidateForInOpt(Select *p){
1444b287f4b6Sdrh   SrcList *pSrc;
1445b287f4b6Sdrh   ExprList *pEList;
1446b287f4b6Sdrh   Table *pTab;
1447b287f4b6Sdrh   if( p==0 ) return 0;                   /* right-hand side of IN is SELECT */
1448b287f4b6Sdrh   if( p->pPrior ) return 0;              /* Not a compound SELECT */
14497d10d5a6Sdrh   if( p->selFlags & (SF_Distinct|SF_Aggregate) ){
1450b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Distinct );
1451b74b1017Sdrh     testcase( (p->selFlags & (SF_Distinct|SF_Aggregate))==SF_Aggregate );
14527d10d5a6Sdrh     return 0; /* No DISTINCT keyword and no aggregate functions */
14537d10d5a6Sdrh   }
1454b74b1017Sdrh   assert( p->pGroupBy==0 );              /* Has no GROUP BY clause */
1455b287f4b6Sdrh   if( p->pLimit ) return 0;              /* Has no LIMIT clause */
1456b74b1017Sdrh   assert( p->pOffset==0 );               /* No LIMIT means no OFFSET */
1457b287f4b6Sdrh   if( p->pWhere ) return 0;              /* Has no WHERE clause */
1458b287f4b6Sdrh   pSrc = p->pSrc;
1459d1fa7bcaSdrh   assert( pSrc!=0 );
1460d1fa7bcaSdrh   if( pSrc->nSrc!=1 ) return 0;          /* Single term in FROM clause */
1461b74b1017Sdrh   if( pSrc->a[0].pSelect ) return 0;     /* FROM is not a subquery or view */
1462b287f4b6Sdrh   pTab = pSrc->a[0].pTab;
1463b74b1017Sdrh   if( NEVER(pTab==0) ) return 0;
1464b74b1017Sdrh   assert( pTab->pSelect==0 );            /* FROM clause is not a view */
1465b287f4b6Sdrh   if( IsVirtual(pTab) ) return 0;        /* FROM clause not a virtual table */
1466b287f4b6Sdrh   pEList = p->pEList;
1467b287f4b6Sdrh   if( pEList->nExpr!=1 ) return 0;       /* One column in the result set */
1468b287f4b6Sdrh   if( pEList->a[0].pExpr->op!=TK_COLUMN ) return 0; /* Result is a column */
1469b287f4b6Sdrh   return 1;
1470b287f4b6Sdrh }
1471b287f4b6Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1472b287f4b6Sdrh 
1473b287f4b6Sdrh /*
14741d8cb21fSdan ** Code an OP_Once instruction and allocate space for its flag. Return the
14751d8cb21fSdan ** address of the new instruction.
14761d8cb21fSdan */
14771d8cb21fSdan int sqlite3CodeOnce(Parse *pParse){
14781d8cb21fSdan   Vdbe *v = sqlite3GetVdbe(pParse);      /* Virtual machine being coded */
14791d8cb21fSdan   return sqlite3VdbeAddOp1(v, OP_Once, pParse->nOnce++);
14801d8cb21fSdan }
14811d8cb21fSdan 
14821d8cb21fSdan /*
14839a96b668Sdanielk1977 ** This function is used by the implementation of the IN (...) operator.
1484d4305ca6Sdrh ** The pX parameter is the expression on the RHS of the IN operator, which
1485d4305ca6Sdrh ** might be either a list of expressions or a subquery.
14869a96b668Sdanielk1977 **
1487d4305ca6Sdrh ** The job of this routine is to find or create a b-tree object that can
1488d4305ca6Sdrh ** be used either to test for membership in the RHS set or to iterate through
1489d4305ca6Sdrh ** all members of the RHS set, skipping duplicates.
1490d4305ca6Sdrh **
1491d4305ca6Sdrh ** A cursor is opened on the b-tree object that the RHS of the IN operator
1492d4305ca6Sdrh ** and pX->iTable is set to the index of that cursor.
1493d4305ca6Sdrh **
1494b74b1017Sdrh ** The returned value of this function indicates the b-tree type, as follows:
14959a96b668Sdanielk1977 **
14969a96b668Sdanielk1977 **   IN_INDEX_ROWID      - The cursor was opened on a database table.
14971ccce449Sdrh **   IN_INDEX_INDEX_ASC  - The cursor was opened on an ascending index.
14981ccce449Sdrh **   IN_INDEX_INDEX_DESC - The cursor was opened on a descending index.
14999a96b668Sdanielk1977 **   IN_INDEX_EPH        - The cursor was opened on a specially created and
15009a96b668Sdanielk1977 **                         populated epheremal table.
15019a96b668Sdanielk1977 **
1502d4305ca6Sdrh ** An existing b-tree might be used if the RHS expression pX is a simple
1503d4305ca6Sdrh ** subquery such as:
15049a96b668Sdanielk1977 **
15059a96b668Sdanielk1977 **     SELECT <column> FROM <table>
15069a96b668Sdanielk1977 **
1507d4305ca6Sdrh ** If the RHS of the IN operator is a list or a more complex subquery, then
1508d4305ca6Sdrh ** an ephemeral table might need to be generated from the RHS and then
1509d4305ca6Sdrh ** pX->iTable made to point to the ephermeral table instead of an
1510d4305ca6Sdrh ** existing table.
1511d4305ca6Sdrh **
1512b74b1017Sdrh ** If the prNotFound parameter is 0, then the b-tree will be used to iterate
15139a96b668Sdanielk1977 ** through the set members, skipping any duplicates. In this case an
15149a96b668Sdanielk1977 ** epheremal table must be used unless the selected <column> is guaranteed
15159a96b668Sdanielk1977 ** to be unique - either because it is an INTEGER PRIMARY KEY or it
1516b74b1017Sdrh ** has a UNIQUE constraint or UNIQUE index.
15170cdc022eSdanielk1977 **
1518b74b1017Sdrh ** If the prNotFound parameter is not 0, then the b-tree will be used
15190cdc022eSdanielk1977 ** for fast set membership tests. In this case an epheremal table must
15200cdc022eSdanielk1977 ** be used unless <column> is an INTEGER PRIMARY KEY or an index can
15210cdc022eSdanielk1977 ** be found with <column> as its left-most column.
15220cdc022eSdanielk1977 **
1523b74b1017Sdrh ** When the b-tree is being used for membership tests, the calling function
15240cdc022eSdanielk1977 ** needs to know whether or not the structure contains an SQL NULL
15250cdc022eSdanielk1977 ** value in order to correctly evaluate expressions like "X IN (Y, Z)".
1526e3365e6cSdrh ** If there is any chance that the (...) might contain a NULL value at
15270cdc022eSdanielk1977 ** runtime, then a register is allocated and the register number written
1528e3365e6cSdrh ** to *prNotFound. If there is no chance that the (...) contains a
15290cdc022eSdanielk1977 ** NULL value, then *prNotFound is left unchanged.
15300cdc022eSdanielk1977 **
15310cdc022eSdanielk1977 ** If a register is allocated and its location stored in *prNotFound, then
1532e3365e6cSdrh ** its initial value is NULL.  If the (...) does not remain constant
1533e3365e6cSdrh ** for the duration of the query (i.e. the SELECT within the (...)
1534b74b1017Sdrh ** is a correlated subquery) then the value of the allocated register is
1535e3365e6cSdrh ** reset to NULL each time the subquery is rerun. This allows the
1536b74b1017Sdrh ** caller to use vdbe code equivalent to the following:
15370cdc022eSdanielk1977 **
15380cdc022eSdanielk1977 **   if( register==NULL ){
15390cdc022eSdanielk1977 **     has_null = <test if data structure contains null>
15400cdc022eSdanielk1977 **     register = 1
15410cdc022eSdanielk1977 **   }
15420cdc022eSdanielk1977 **
15430cdc022eSdanielk1977 ** in order to avoid running the <test if data structure contains null>
15440cdc022eSdanielk1977 ** test more often than is necessary.
15459a96b668Sdanielk1977 */
1546284f4acaSdanielk1977 #ifndef SQLITE_OMIT_SUBQUERY
15470cdc022eSdanielk1977 int sqlite3FindInIndex(Parse *pParse, Expr *pX, int *prNotFound){
1548b74b1017Sdrh   Select *p;                            /* SELECT to the right of IN operator */
1549b74b1017Sdrh   int eType = 0;                        /* Type of RHS table. IN_INDEX_* */
1550b74b1017Sdrh   int iTab = pParse->nTab++;            /* Cursor of the RHS table */
1551b74b1017Sdrh   int mustBeUnique = (prNotFound==0);   /* True if RHS must be unique */
1552b8475df8Sdrh   Vdbe *v = sqlite3GetVdbe(pParse);     /* Virtual machine being coded */
15539a96b668Sdanielk1977 
15541450bc6eSdrh   assert( pX->op==TK_IN );
15551450bc6eSdrh 
1556b74b1017Sdrh   /* Check to see if an existing table or index can be used to
1557b74b1017Sdrh   ** satisfy the query.  This is preferable to generating a new
1558b74b1017Sdrh   ** ephemeral table.
15599a96b668Sdanielk1977   */
15606ab3a2ecSdanielk1977   p = (ExprHasProperty(pX, EP_xIsSelect) ? pX->x.pSelect : 0);
1561fd773cf9Sdrh   if( ALWAYS(pParse->nErr==0) && isCandidateForInOpt(p) ){
1562e1fb65a0Sdanielk1977     sqlite3 *db = pParse->db;              /* Database connection */
1563b07028f7Sdrh     Table *pTab;                           /* Table <table>. */
1564b07028f7Sdrh     Expr *pExpr;                           /* Expression <column> */
1565bbbdc83bSdrh     i16 iCol;                              /* Index of column <column> */
1566bbbdc83bSdrh     i16 iDb;                               /* Database idx for pTab */
1567e1fb65a0Sdanielk1977 
1568b07028f7Sdrh     assert( p );                        /* Because of isCandidateForInOpt(p) */
1569b07028f7Sdrh     assert( p->pEList!=0 );             /* Because of isCandidateForInOpt(p) */
1570b07028f7Sdrh     assert( p->pEList->a[0].pExpr!=0 ); /* Because of isCandidateForInOpt(p) */
1571b07028f7Sdrh     assert( p->pSrc!=0 );               /* Because of isCandidateForInOpt(p) */
1572b07028f7Sdrh     pTab = p->pSrc->a[0].pTab;
1573b07028f7Sdrh     pExpr = p->pEList->a[0].pExpr;
1574bbbdc83bSdrh     iCol = (i16)pExpr->iColumn;
1575b07028f7Sdrh 
1576e1fb65a0Sdanielk1977     /* Code an OP_VerifyCookie and OP_TableLock for <table>. */
1577e1fb65a0Sdanielk1977     iDb = sqlite3SchemaToIndex(db, pTab->pSchema);
1578e1fb65a0Sdanielk1977     sqlite3CodeVerifySchema(pParse, iDb);
1579e1fb65a0Sdanielk1977     sqlite3TableLock(pParse, iDb, pTab->tnum, 0, pTab->zName);
15809a96b668Sdanielk1977 
15819a96b668Sdanielk1977     /* This function is only called from two places. In both cases the vdbe
15829a96b668Sdanielk1977     ** has already been allocated. So assume sqlite3GetVdbe() is always
15839a96b668Sdanielk1977     ** successful here.
15849a96b668Sdanielk1977     */
15859a96b668Sdanielk1977     assert(v);
15869a96b668Sdanielk1977     if( iCol<0 ){
15879a96b668Sdanielk1977       int iAddr;
15889a96b668Sdanielk1977 
15891d8cb21fSdan       iAddr = sqlite3CodeOnce(pParse);
15909a96b668Sdanielk1977 
15919a96b668Sdanielk1977       sqlite3OpenTable(pParse, iTab, iDb, pTab, OP_OpenRead);
15929a96b668Sdanielk1977       eType = IN_INDEX_ROWID;
15939a96b668Sdanielk1977 
15949a96b668Sdanielk1977       sqlite3VdbeJumpHere(v, iAddr);
15959a96b668Sdanielk1977     }else{
1596e1fb65a0Sdanielk1977       Index *pIdx;                         /* Iterator variable */
1597e1fb65a0Sdanielk1977 
15989a96b668Sdanielk1977       /* The collation sequence used by the comparison. If an index is to
15999a96b668Sdanielk1977       ** be used in place of a temp-table, it must be ordered according
1600e1fb65a0Sdanielk1977       ** to this collation sequence.  */
16019a96b668Sdanielk1977       CollSeq *pReq = sqlite3BinaryCompareCollSeq(pParse, pX->pLeft, pExpr);
16029a96b668Sdanielk1977 
16039a96b668Sdanielk1977       /* Check that the affinity that will be used to perform the
16049a96b668Sdanielk1977       ** comparison is the same as the affinity of the column. If
16059a96b668Sdanielk1977       ** it is not, it is not possible to use any index.
16069a96b668Sdanielk1977       */
1607dbaee5e3Sdrh       int affinity_ok = sqlite3IndexAffinityOk(pX, pTab->aCol[iCol].affinity);
16089a96b668Sdanielk1977 
16099a96b668Sdanielk1977       for(pIdx=pTab->pIndex; pIdx && eType==0 && affinity_ok; pIdx=pIdx->pNext){
16109a96b668Sdanielk1977         if( (pIdx->aiColumn[0]==iCol)
1611b74b1017Sdrh          && sqlite3FindCollSeq(db, ENC(db), pIdx->azColl[0], 0)==pReq
1612bbbdc83bSdrh          && (!mustBeUnique || (pIdx->nKeyCol==1 && pIdx->onError!=OE_None))
16139a96b668Sdanielk1977         ){
16142ec2fb22Sdrh           int iAddr = sqlite3CodeOnce(pParse);
16152ec2fb22Sdrh           sqlite3VdbeAddOp3(v, OP_OpenRead, iTab, pIdx->tnum, iDb);
16162ec2fb22Sdrh           sqlite3VdbeSetP4KeyInfo(pParse, pIdx);
1617207872a4Sdanielk1977           VdbeComment((v, "%s", pIdx->zName));
16181ccce449Sdrh           assert( IN_INDEX_INDEX_DESC == IN_INDEX_INDEX_ASC+1 );
16191ccce449Sdrh           eType = IN_INDEX_INDEX_ASC + pIdx->aSortOrder[0];
16209a96b668Sdanielk1977 
16219a96b668Sdanielk1977           sqlite3VdbeJumpHere(v, iAddr);
16220cdc022eSdanielk1977           if( prNotFound && !pTab->aCol[iCol].notNull ){
16230cdc022eSdanielk1977             *prNotFound = ++pParse->nMem;
1624b8475df8Sdrh             sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
16250cdc022eSdanielk1977           }
16269a96b668Sdanielk1977         }
16279a96b668Sdanielk1977       }
16289a96b668Sdanielk1977     }
16299a96b668Sdanielk1977   }
16309a96b668Sdanielk1977 
16319a96b668Sdanielk1977   if( eType==0 ){
16321450bc6eSdrh     /* Could not found an existing table or index to use as the RHS b-tree.
1633b74b1017Sdrh     ** We will have to generate an ephemeral table to do the job.
1634b74b1017Sdrh     */
16358e23daf3Sdrh     u32 savedNQueryLoop = pParse->nQueryLoop;
16360cdc022eSdanielk1977     int rMayHaveNull = 0;
163741a05b7bSdanielk1977     eType = IN_INDEX_EPH;
16380cdc022eSdanielk1977     if( prNotFound ){
16390cdc022eSdanielk1977       *prNotFound = rMayHaveNull = ++pParse->nMem;
1640b8475df8Sdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, *prNotFound);
1641cf4d38aaSdrh     }else{
16424a5acf8eSdrh       testcase( pParse->nQueryLoop>0 );
16434a5acf8eSdrh       pParse->nQueryLoop = 0;
1644c5cd1249Sdrh       if( pX->pLeft->iColumn<0 && !ExprHasProperty(pX, EP_xIsSelect) ){
164541a05b7bSdanielk1977         eType = IN_INDEX_ROWID;
16460cdc022eSdanielk1977       }
1647cf4d38aaSdrh     }
164841a05b7bSdanielk1977     sqlite3CodeSubselect(pParse, pX, rMayHaveNull, eType==IN_INDEX_ROWID);
1649cf4d38aaSdrh     pParse->nQueryLoop = savedNQueryLoop;
16509a96b668Sdanielk1977   }else{
16519a96b668Sdanielk1977     pX->iTable = iTab;
16529a96b668Sdanielk1977   }
16539a96b668Sdanielk1977   return eType;
16549a96b668Sdanielk1977 }
1655284f4acaSdanielk1977 #endif
1656626a879aSdrh 
1657626a879aSdrh /*
1658d4187c71Sdrh ** Generate code for scalar subqueries used as a subquery expression, EXISTS,
1659d4187c71Sdrh ** or IN operators.  Examples:
1660626a879aSdrh **
16619cbe6352Sdrh **     (SELECT a FROM b)          -- subquery
16629cbe6352Sdrh **     EXISTS (SELECT a FROM b)   -- EXISTS subquery
16639cbe6352Sdrh **     x IN (4,5,11)              -- IN operator with list on right-hand side
16649cbe6352Sdrh **     x IN (SELECT a FROM b)     -- IN operator with subquery on the right
1665fef5208cSdrh **
16669cbe6352Sdrh ** The pExpr parameter describes the expression that contains the IN
16679cbe6352Sdrh ** operator or subquery.
166841a05b7bSdanielk1977 **
166941a05b7bSdanielk1977 ** If parameter isRowid is non-zero, then expression pExpr is guaranteed
167041a05b7bSdanielk1977 ** to be of the form "<rowid> IN (?, ?, ?)", where <rowid> is a reference
167141a05b7bSdanielk1977 ** to some integer key column of a table B-Tree. In this case, use an
167241a05b7bSdanielk1977 ** intkey B-Tree to store the set of IN(...) values instead of the usual
167341a05b7bSdanielk1977 ** (slower) variable length keys B-Tree.
1674fd773cf9Sdrh **
1675fd773cf9Sdrh ** If rMayHaveNull is non-zero, that means that the operation is an IN
1676fd773cf9Sdrh ** (not a SELECT or EXISTS) and that the RHS might contains NULLs.
1677fd773cf9Sdrh ** Furthermore, the IN is in a WHERE clause and that we really want
1678fd773cf9Sdrh ** to iterate over the RHS of the IN operator in order to quickly locate
1679fd773cf9Sdrh ** all corresponding LHS elements.  All this routine does is initialize
1680fd773cf9Sdrh ** the register given by rMayHaveNull to NULL.  Calling routines will take
1681fd773cf9Sdrh ** care of changing this register value to non-NULL if the RHS is NULL-free.
1682fd773cf9Sdrh **
1683fd773cf9Sdrh ** If rMayHaveNull is zero, that means that the subquery is being used
1684fd773cf9Sdrh ** for membership testing only.  There is no need to initialize any
1685f7b5496eSdrh ** registers to indicate the presence or absence of NULLs on the RHS.
16861450bc6eSdrh **
16871450bc6eSdrh ** For a SELECT or EXISTS operator, return the register that holds the
16881450bc6eSdrh ** result.  For IN operators or if an error occurs, the return value is 0.
1689cce7d176Sdrh */
169051522cd3Sdrh #ifndef SQLITE_OMIT_SUBQUERY
16911450bc6eSdrh int sqlite3CodeSubselect(
1692fd773cf9Sdrh   Parse *pParse,          /* Parsing context */
1693fd773cf9Sdrh   Expr *pExpr,            /* The IN, SELECT, or EXISTS operator */
1694fd773cf9Sdrh   int rMayHaveNull,       /* Register that records whether NULLs exist in RHS */
1695fd773cf9Sdrh   int isRowid             /* If true, LHS of IN operator is a rowid */
169641a05b7bSdanielk1977 ){
1697dfd2d9f6Sdrh   int testAddr = -1;                      /* One-time test address */
16981450bc6eSdrh   int rReg = 0;                           /* Register storing resulting */
1699b3bce662Sdanielk1977   Vdbe *v = sqlite3GetVdbe(pParse);
17001450bc6eSdrh   if( NEVER(v==0) ) return 0;
1701ceea3321Sdrh   sqlite3ExprCachePush(pParse);
1702fc976065Sdanielk1977 
170357dbd7b3Sdrh   /* This code must be run in its entirety every time it is encountered
170457dbd7b3Sdrh   ** if any of the following is true:
170557dbd7b3Sdrh   **
170657dbd7b3Sdrh   **    *  The right-hand side is a correlated subquery
170757dbd7b3Sdrh   **    *  The right-hand side is an expression list containing variables
170857dbd7b3Sdrh   **    *  We are inside a trigger
170957dbd7b3Sdrh   **
171057dbd7b3Sdrh   ** If all of the above are false, then we can run this code just once
171157dbd7b3Sdrh   ** save the results, and reuse the same result on subsequent invocations.
1712b3bce662Sdanielk1977   */
1713c5cd1249Sdrh   if( !ExprHasProperty(pExpr, EP_VarSelect) ){
17141d8cb21fSdan     testAddr = sqlite3CodeOnce(pParse);
1715b3bce662Sdanielk1977   }
1716b3bce662Sdanielk1977 
17174a07e3dbSdan #ifndef SQLITE_OMIT_EXPLAIN
17184a07e3dbSdan   if( pParse->explain==2 ){
17194a07e3dbSdan     char *zMsg = sqlite3MPrintf(
1720dfd2d9f6Sdrh         pParse->db, "EXECUTE %s%s SUBQUERY %d", testAddr>=0?"":"CORRELATED ",
17214a07e3dbSdan         pExpr->op==TK_IN?"LIST":"SCALAR", pParse->iNextSelectId
17224a07e3dbSdan     );
17234a07e3dbSdan     sqlite3VdbeAddOp4(v, OP_Explain, pParse->iSelectId, 0, 0, zMsg, P4_DYNAMIC);
17244a07e3dbSdan   }
17254a07e3dbSdan #endif
17264a07e3dbSdan 
1727cce7d176Sdrh   switch( pExpr->op ){
1728fef5208cSdrh     case TK_IN: {
1729d4187c71Sdrh       char affinity;              /* Affinity of the LHS of the IN */
1730b9bb7c18Sdrh       int addr;                   /* Address of OP_OpenEphemeral instruction */
1731d4187c71Sdrh       Expr *pLeft = pExpr->pLeft; /* the LHS of the IN operator */
1732323df790Sdrh       KeyInfo *pKeyInfo = 0;      /* Key information */
1733d3d39e93Sdrh 
17340cdc022eSdanielk1977       if( rMayHaveNull ){
17350cdc022eSdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, rMayHaveNull);
17360cdc022eSdanielk1977       }
17370cdc022eSdanielk1977 
173841a05b7bSdanielk1977       affinity = sqlite3ExprAffinity(pLeft);
1739e014a838Sdanielk1977 
1740e014a838Sdanielk1977       /* Whether this is an 'x IN(SELECT...)' or an 'x IN(<exprlist>)'
17418cff69dfSdrh       ** expression it is handled the same way.  An ephemeral table is
1742e014a838Sdanielk1977       ** filled with single-field index keys representing the results
1743e014a838Sdanielk1977       ** from the SELECT or the <exprlist>.
1744fef5208cSdrh       **
1745e014a838Sdanielk1977       ** If the 'x' expression is a column value, or the SELECT...
1746e014a838Sdanielk1977       ** statement returns a column value, then the affinity of that
1747e014a838Sdanielk1977       ** column is used to build the index keys. If both 'x' and the
1748e014a838Sdanielk1977       ** SELECT... statement are columns, then numeric affinity is used
1749e014a838Sdanielk1977       ** if either column has NUMERIC or INTEGER affinity. If neither
1750e014a838Sdanielk1977       ** 'x' nor the SELECT... statement are columns, then numeric affinity
1751e014a838Sdanielk1977       ** is used.
1752fef5208cSdrh       */
1753832508b7Sdrh       pExpr->iTable = pParse->nTab++;
175441a05b7bSdanielk1977       addr = sqlite3VdbeAddOp2(v, OP_OpenEphemeral, pExpr->iTable, !isRowid);
1755d4187c71Sdrh       if( rMayHaveNull==0 ) sqlite3VdbeChangeP5(v, BTREE_UNORDERED);
1756ad124329Sdrh       pKeyInfo = isRowid ? 0 : sqlite3KeyInfoAlloc(pParse->db, 1, 1);
1757e014a838Sdanielk1977 
17586ab3a2ecSdanielk1977       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
1759e014a838Sdanielk1977         /* Case 1:     expr IN (SELECT ...)
1760e014a838Sdanielk1977         **
1761e014a838Sdanielk1977         ** Generate code to write the results of the select into the temporary
1762e014a838Sdanielk1977         ** table allocated and opened above.
1763e014a838Sdanielk1977         */
17641013c932Sdrh         SelectDest dest;
1765be5c89acSdrh         ExprList *pEList;
17661013c932Sdrh 
176741a05b7bSdanielk1977         assert( !isRowid );
17681013c932Sdrh         sqlite3SelectDestInit(&dest, SRT_Set, pExpr->iTable);
17692b596da8Sdrh         dest.affSdst = (u8)affinity;
1770e014a838Sdanielk1977         assert( (pExpr->iTable&0x0000FFFF)==pExpr->iTable );
177148b5b041Sdrh         pExpr->x.pSelect->iLimit = 0;
1772812ea833Sdrh         testcase( pKeyInfo==0 ); /* Caused by OOM in sqlite3KeyInfoAlloc() */
17736ab3a2ecSdanielk1977         if( sqlite3Select(pParse, pExpr->x.pSelect, &dest) ){
17742ec2fb22Sdrh           sqlite3KeyInfoUnref(pKeyInfo);
17751450bc6eSdrh           return 0;
177694ccde58Sdrh         }
17776ab3a2ecSdanielk1977         pEList = pExpr->x.pSelect->pEList;
1778812ea833Sdrh         assert( pKeyInfo!=0 ); /* OOM will cause exit after sqlite3Select() */
17793535ec3eSdrh         assert( pEList!=0 );
17803535ec3eSdrh         assert( pEList->nExpr>0 );
17812ec2fb22Sdrh         assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
1782323df790Sdrh         pKeyInfo->aColl[0] = sqlite3BinaryCompareCollSeq(pParse, pExpr->pLeft,
1783be5c89acSdrh                                                          pEList->a[0].pExpr);
1784a7d2db17Sdrh       }else if( ALWAYS(pExpr->x.pList!=0) ){
1785fef5208cSdrh         /* Case 2:     expr IN (exprlist)
1786fef5208cSdrh         **
1787e014a838Sdanielk1977         ** For each expression, build an index key from the evaluation and
1788e014a838Sdanielk1977         ** store it in the temporary table. If <expr> is a column, then use
1789e014a838Sdanielk1977         ** that columns affinity when building index keys. If <expr> is not
1790e014a838Sdanielk1977         ** a column, use numeric affinity.
1791fef5208cSdrh         */
1792e014a838Sdanielk1977         int i;
17936ab3a2ecSdanielk1977         ExprList *pList = pExpr->x.pList;
179457dbd7b3Sdrh         struct ExprList_item *pItem;
1795ecc31805Sdrh         int r1, r2, r3;
179657dbd7b3Sdrh 
1797e014a838Sdanielk1977         if( !affinity ){
17988159a35fSdrh           affinity = SQLITE_AFF_NONE;
1799e014a838Sdanielk1977         }
1800323df790Sdrh         if( pKeyInfo ){
18012ec2fb22Sdrh           assert( sqlite3KeyInfoIsWriteable(pKeyInfo) );
1802323df790Sdrh           pKeyInfo->aColl[0] = sqlite3ExprCollSeq(pParse, pExpr->pLeft);
1803323df790Sdrh         }
1804e014a838Sdanielk1977 
1805e014a838Sdanielk1977         /* Loop through each expression in <exprlist>. */
18062d401ab8Sdrh         r1 = sqlite3GetTempReg(pParse);
18072d401ab8Sdrh         r2 = sqlite3GetTempReg(pParse);
18084e7f36a2Sdanielk1977         sqlite3VdbeAddOp2(v, OP_Null, 0, r2);
180957dbd7b3Sdrh         for(i=pList->nExpr, pItem=pList->a; i>0; i--, pItem++){
181057dbd7b3Sdrh           Expr *pE2 = pItem->pExpr;
1811e05c929bSdrh           int iValToIns;
1812e014a838Sdanielk1977 
181357dbd7b3Sdrh           /* If the expression is not constant then we will need to
181457dbd7b3Sdrh           ** disable the test that was generated above that makes sure
181557dbd7b3Sdrh           ** this code only executes once.  Because for a non-constant
181657dbd7b3Sdrh           ** expression we need to rerun this code each time.
181757dbd7b3Sdrh           */
1818dfd2d9f6Sdrh           if( testAddr>=0 && !sqlite3ExprIsConstant(pE2) ){
181948f2d3b1Sdrh             sqlite3VdbeChangeToNoop(v, testAddr);
1820dfd2d9f6Sdrh             testAddr = -1;
18214794b980Sdrh           }
1822e014a838Sdanielk1977 
1823e014a838Sdanielk1977           /* Evaluate the expression and insert it into the temp table */
1824e05c929bSdrh           if( isRowid && sqlite3ExprIsInteger(pE2, &iValToIns) ){
1825e05c929bSdrh             sqlite3VdbeAddOp3(v, OP_InsertInt, pExpr->iTable, r2, iValToIns);
1826e05c929bSdrh           }else{
1827ecc31805Sdrh             r3 = sqlite3ExprCodeTarget(pParse, pE2, r1);
182841a05b7bSdanielk1977             if( isRowid ){
1829e05c929bSdrh               sqlite3VdbeAddOp2(v, OP_MustBeInt, r3,
1830e05c929bSdrh                                 sqlite3VdbeCurrentAddr(v)+2);
183141a05b7bSdanielk1977               sqlite3VdbeAddOp3(v, OP_Insert, pExpr->iTable, r2, r3);
183241a05b7bSdanielk1977             }else{
1833ecc31805Sdrh               sqlite3VdbeAddOp4(v, OP_MakeRecord, r3, 1, r2, &affinity, 1);
18343c31fc23Sdrh               sqlite3ExprCacheAffinityChange(pParse, r3, 1);
18352d401ab8Sdrh               sqlite3VdbeAddOp2(v, OP_IdxInsert, pExpr->iTable, r2);
1836fef5208cSdrh             }
183741a05b7bSdanielk1977           }
1838e05c929bSdrh         }
18392d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r1);
18402d401ab8Sdrh         sqlite3ReleaseTempReg(pParse, r2);
1841fef5208cSdrh       }
1842323df790Sdrh       if( pKeyInfo ){
18432ec2fb22Sdrh         sqlite3VdbeChangeP4(v, addr, (void *)pKeyInfo, P4_KEYINFO);
184441a05b7bSdanielk1977       }
1845b3bce662Sdanielk1977       break;
1846fef5208cSdrh     }
1847fef5208cSdrh 
184851522cd3Sdrh     case TK_EXISTS:
1849fd773cf9Sdrh     case TK_SELECT:
1850fd773cf9Sdrh     default: {
1851fd773cf9Sdrh       /* If this has to be a scalar SELECT.  Generate code to put the
1852fef5208cSdrh       ** value of this select in a memory cell and record the number
1853fd773cf9Sdrh       ** of the memory cell in iColumn.  If this is an EXISTS, write
1854fd773cf9Sdrh       ** an integer 0 (not exists) or 1 (exists) into a memory cell
1855fd773cf9Sdrh       ** and record that memory cell in iColumn.
1856fef5208cSdrh       */
1857fd773cf9Sdrh       Select *pSel;                         /* SELECT statement to encode */
1858fd773cf9Sdrh       SelectDest dest;                      /* How to deal with SELECt result */
18591398ad36Sdrh 
1860cf697396Sshane       testcase( pExpr->op==TK_EXISTS );
1861cf697396Sshane       testcase( pExpr->op==TK_SELECT );
1862cf697396Sshane       assert( pExpr->op==TK_EXISTS || pExpr->op==TK_SELECT );
1863cf697396Sshane 
18646ab3a2ecSdanielk1977       assert( ExprHasProperty(pExpr, EP_xIsSelect) );
18656ab3a2ecSdanielk1977       pSel = pExpr->x.pSelect;
18661013c932Sdrh       sqlite3SelectDestInit(&dest, 0, ++pParse->nMem);
186751522cd3Sdrh       if( pExpr->op==TK_SELECT ){
18686c8c8ce0Sdanielk1977         dest.eDest = SRT_Mem;
18692b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, dest.iSDParm);
1870d4e70ebdSdrh         VdbeComment((v, "Init subquery result"));
187151522cd3Sdrh       }else{
18726c8c8ce0Sdanielk1977         dest.eDest = SRT_Exists;
18732b596da8Sdrh         sqlite3VdbeAddOp2(v, OP_Integer, 0, dest.iSDParm);
1874d4e70ebdSdrh         VdbeComment((v, "Init EXISTS result"));
187551522cd3Sdrh       }
1876633e6d57Sdrh       sqlite3ExprDelete(pParse->db, pSel->pLimit);
1877094430ebSdrh       pSel->pLimit = sqlite3PExpr(pParse, TK_INTEGER, 0, 0,
1878094430ebSdrh                                   &sqlite3IntTokens[1]);
187948b5b041Sdrh       pSel->iLimit = 0;
18807d10d5a6Sdrh       if( sqlite3Select(pParse, pSel, &dest) ){
18811450bc6eSdrh         return 0;
188294ccde58Sdrh       }
18832b596da8Sdrh       rReg = dest.iSDParm;
1884ebb6a65dSdrh       ExprSetVVAProperty(pExpr, EP_NoReduce);
1885b3bce662Sdanielk1977       break;
188619a775c2Sdrh     }
1887cce7d176Sdrh   }
1888b3bce662Sdanielk1977 
1889dfd2d9f6Sdrh   if( testAddr>=0 ){
189048f2d3b1Sdrh     sqlite3VdbeJumpHere(v, testAddr);
1891b3bce662Sdanielk1977   }
1892ceea3321Sdrh   sqlite3ExprCachePop(pParse, 1);
1893fc976065Sdanielk1977 
18941450bc6eSdrh   return rReg;
1895cce7d176Sdrh }
189651522cd3Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
1897cce7d176Sdrh 
1898e3365e6cSdrh #ifndef SQLITE_OMIT_SUBQUERY
1899e3365e6cSdrh /*
1900e3365e6cSdrh ** Generate code for an IN expression.
1901e3365e6cSdrh **
1902e3365e6cSdrh **      x IN (SELECT ...)
1903e3365e6cSdrh **      x IN (value, value, ...)
1904e3365e6cSdrh **
1905e3365e6cSdrh ** The left-hand side (LHS) is a scalar expression.  The right-hand side (RHS)
1906e3365e6cSdrh ** is an array of zero or more values.  The expression is true if the LHS is
1907e3365e6cSdrh ** contained within the RHS.  The value of the expression is unknown (NULL)
1908e3365e6cSdrh ** if the LHS is NULL or if the LHS is not contained within the RHS and the
1909e3365e6cSdrh ** RHS contains one or more NULL values.
1910e3365e6cSdrh **
1911e3365e6cSdrh ** This routine generates code will jump to destIfFalse if the LHS is not
1912e3365e6cSdrh ** contained within the RHS.  If due to NULLs we cannot determine if the LHS
1913e3365e6cSdrh ** is contained in the RHS then jump to destIfNull.  If the LHS is contained
1914e3365e6cSdrh ** within the RHS then fall through.
1915e3365e6cSdrh */
1916e3365e6cSdrh static void sqlite3ExprCodeIN(
1917e3365e6cSdrh   Parse *pParse,        /* Parsing and code generating context */
1918e3365e6cSdrh   Expr *pExpr,          /* The IN expression */
1919e3365e6cSdrh   int destIfFalse,      /* Jump here if LHS is not contained in the RHS */
1920e3365e6cSdrh   int destIfNull        /* Jump here if the results are unknown due to NULLs */
1921e3365e6cSdrh ){
1922e3365e6cSdrh   int rRhsHasNull = 0;  /* Register that is true if RHS contains NULL values */
1923e3365e6cSdrh   char affinity;        /* Comparison affinity to use */
1924e3365e6cSdrh   int eType;            /* Type of the RHS */
1925e3365e6cSdrh   int r1;               /* Temporary use register */
1926e3365e6cSdrh   Vdbe *v;              /* Statement under construction */
1927e3365e6cSdrh 
1928e3365e6cSdrh   /* Compute the RHS.   After this step, the table with cursor
1929e3365e6cSdrh   ** pExpr->iTable will contains the values that make up the RHS.
1930e3365e6cSdrh   */
1931e3365e6cSdrh   v = pParse->pVdbe;
1932e3365e6cSdrh   assert( v!=0 );       /* OOM detected prior to this routine */
1933e3365e6cSdrh   VdbeNoopComment((v, "begin IN expr"));
1934e3365e6cSdrh   eType = sqlite3FindInIndex(pParse, pExpr, &rRhsHasNull);
1935e3365e6cSdrh 
1936e3365e6cSdrh   /* Figure out the affinity to use to create a key from the results
1937e3365e6cSdrh   ** of the expression. affinityStr stores a static string suitable for
1938e3365e6cSdrh   ** P4 of OP_MakeRecord.
1939e3365e6cSdrh   */
1940e3365e6cSdrh   affinity = comparisonAffinity(pExpr);
1941e3365e6cSdrh 
1942e3365e6cSdrh   /* Code the LHS, the <expr> from "<expr> IN (...)".
1943e3365e6cSdrh   */
1944e3365e6cSdrh   sqlite3ExprCachePush(pParse);
1945e3365e6cSdrh   r1 = sqlite3GetTempReg(pParse);
1946e3365e6cSdrh   sqlite3ExprCode(pParse, pExpr->pLeft, r1);
1947e3365e6cSdrh 
1948094430ebSdrh   /* If the LHS is NULL, then the result is either false or NULL depending
1949094430ebSdrh   ** on whether the RHS is empty or not, respectively.
1950094430ebSdrh   */
1951094430ebSdrh   if( destIfNull==destIfFalse ){
1952094430ebSdrh     /* Shortcut for the common case where the false and NULL outcomes are
1953094430ebSdrh     ** the same. */
1954094430ebSdrh     sqlite3VdbeAddOp2(v, OP_IsNull, r1, destIfNull);
1955094430ebSdrh   }else{
1956094430ebSdrh     int addr1 = sqlite3VdbeAddOp1(v, OP_NotNull, r1);
1957094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Rewind, pExpr->iTable, destIfFalse);
1958094430ebSdrh     sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfNull);
1959094430ebSdrh     sqlite3VdbeJumpHere(v, addr1);
1960094430ebSdrh   }
1961e3365e6cSdrh 
1962e3365e6cSdrh   if( eType==IN_INDEX_ROWID ){
1963e3365e6cSdrh     /* In this case, the RHS is the ROWID of table b-tree
1964e3365e6cSdrh     */
1965e3365e6cSdrh     sqlite3VdbeAddOp2(v, OP_MustBeInt, r1, destIfFalse);
1966e3365e6cSdrh     sqlite3VdbeAddOp3(v, OP_NotExists, pExpr->iTable, destIfFalse, r1);
1967e3365e6cSdrh   }else{
1968e3365e6cSdrh     /* In this case, the RHS is an index b-tree.
1969e3365e6cSdrh     */
19708cff69dfSdrh     sqlite3VdbeAddOp4(v, OP_Affinity, r1, 1, 0, &affinity, 1);
1971e3365e6cSdrh 
1972e3365e6cSdrh     /* If the set membership test fails, then the result of the
1973e3365e6cSdrh     ** "x IN (...)" expression must be either 0 or NULL. If the set
1974e3365e6cSdrh     ** contains no NULL values, then the result is 0. If the set
1975e3365e6cSdrh     ** contains one or more NULL values, then the result of the
1976e3365e6cSdrh     ** expression is also NULL.
1977e3365e6cSdrh     */
1978e3365e6cSdrh     if( rRhsHasNull==0 || destIfFalse==destIfNull ){
1979e3365e6cSdrh       /* This branch runs if it is known at compile time that the RHS
1980e3365e6cSdrh       ** cannot contain NULL values. This happens as the result
1981e3365e6cSdrh       ** of a "NOT NULL" constraint in the database schema.
1982e3365e6cSdrh       **
1983e3365e6cSdrh       ** Also run this branch if NULL is equivalent to FALSE
1984e3365e6cSdrh       ** for this particular IN operator.
1985e3365e6cSdrh       */
19868cff69dfSdrh       sqlite3VdbeAddOp4Int(v, OP_NotFound, pExpr->iTable, destIfFalse, r1, 1);
1987e3365e6cSdrh 
1988e3365e6cSdrh     }else{
1989e3365e6cSdrh       /* In this branch, the RHS of the IN might contain a NULL and
1990e3365e6cSdrh       ** the presence of a NULL on the RHS makes a difference in the
1991e3365e6cSdrh       ** outcome.
1992e3365e6cSdrh       */
1993e3365e6cSdrh       int j1, j2, j3;
1994e3365e6cSdrh 
1995e3365e6cSdrh       /* First check to see if the LHS is contained in the RHS.  If so,
1996e3365e6cSdrh       ** then the presence of NULLs in the RHS does not matter, so jump
1997e3365e6cSdrh       ** over all of the code that follows.
1998e3365e6cSdrh       */
19998cff69dfSdrh       j1 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, r1, 1);
2000e3365e6cSdrh 
2001e3365e6cSdrh       /* Here we begin generating code that runs if the LHS is not
2002e3365e6cSdrh       ** contained within the RHS.  Generate additional code that
2003e3365e6cSdrh       ** tests the RHS for NULLs.  If the RHS contains a NULL then
2004e3365e6cSdrh       ** jump to destIfNull.  If there are no NULLs in the RHS then
2005e3365e6cSdrh       ** jump to destIfFalse.
2006e3365e6cSdrh       */
2007e3365e6cSdrh       j2 = sqlite3VdbeAddOp1(v, OP_NotNull, rRhsHasNull);
20088cff69dfSdrh       j3 = sqlite3VdbeAddOp4Int(v, OP_Found, pExpr->iTable, 0, rRhsHasNull, 1);
2009e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Integer, -1, rRhsHasNull);
2010e3365e6cSdrh       sqlite3VdbeJumpHere(v, j3);
2011e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, rRhsHasNull, 1);
2012e3365e6cSdrh       sqlite3VdbeJumpHere(v, j2);
2013e3365e6cSdrh 
2014e3365e6cSdrh       /* Jump to the appropriate target depending on whether or not
2015e3365e6cSdrh       ** the RHS contains a NULL
2016e3365e6cSdrh       */
2017e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_If, rRhsHasNull, destIfNull);
2018e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, destIfFalse);
2019e3365e6cSdrh 
2020e3365e6cSdrh       /* The OP_Found at the top of this branch jumps here when true,
2021e3365e6cSdrh       ** causing the overall IN expression evaluation to fall through.
2022e3365e6cSdrh       */
2023e3365e6cSdrh       sqlite3VdbeJumpHere(v, j1);
2024e3365e6cSdrh     }
2025e3365e6cSdrh   }
2026e3365e6cSdrh   sqlite3ReleaseTempReg(pParse, r1);
2027e3365e6cSdrh   sqlite3ExprCachePop(pParse, 1);
2028e3365e6cSdrh   VdbeComment((v, "end IN expr"));
2029e3365e6cSdrh }
2030e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2031e3365e6cSdrh 
2032cce7d176Sdrh /*
2033598f1340Sdrh ** Duplicate an 8-byte value
2034598f1340Sdrh */
2035598f1340Sdrh static char *dup8bytes(Vdbe *v, const char *in){
2036598f1340Sdrh   char *out = sqlite3DbMallocRaw(sqlite3VdbeDb(v), 8);
2037598f1340Sdrh   if( out ){
2038598f1340Sdrh     memcpy(out, in, 8);
2039598f1340Sdrh   }
2040598f1340Sdrh   return out;
2041598f1340Sdrh }
2042598f1340Sdrh 
204313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2044598f1340Sdrh /*
2045598f1340Sdrh ** Generate an instruction that will put the floating point
20469cbf3425Sdrh ** value described by z[0..n-1] into register iMem.
20470cf19ed8Sdrh **
20480cf19ed8Sdrh ** The z[] string will probably not be zero-terminated.  But the
20490cf19ed8Sdrh ** z[n] character is guaranteed to be something that does not look
20500cf19ed8Sdrh ** like the continuation of the number.
2051598f1340Sdrh */
2052b7916a78Sdrh static void codeReal(Vdbe *v, const char *z, int negateFlag, int iMem){
2053fd773cf9Sdrh   if( ALWAYS(z!=0) ){
2054598f1340Sdrh     double value;
2055598f1340Sdrh     char *zV;
20569339da1fSdrh     sqlite3AtoF(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
2057d0015161Sdrh     assert( !sqlite3IsNaN(value) ); /* The new AtoF never returns NaN */
2058598f1340Sdrh     if( negateFlag ) value = -value;
2059598f1340Sdrh     zV = dup8bytes(v, (char*)&value);
20609de221dfSdrh     sqlite3VdbeAddOp4(v, OP_Real, 0, iMem, 0, zV, P4_REAL);
2061598f1340Sdrh   }
2062598f1340Sdrh }
206313573c71Sdrh #endif
2064598f1340Sdrh 
2065598f1340Sdrh 
2066598f1340Sdrh /*
2067fec19aadSdrh ** Generate an instruction that will put the integer describe by
20689cbf3425Sdrh ** text z[0..n-1] into register iMem.
20690cf19ed8Sdrh **
20705f1d6b61Sshaneh ** Expr.u.zToken is always UTF8 and zero-terminated.
2071fec19aadSdrh */
207213573c71Sdrh static void codeInteger(Parse *pParse, Expr *pExpr, int negFlag, int iMem){
207313573c71Sdrh   Vdbe *v = pParse->pVdbe;
207492b01d53Sdrh   if( pExpr->flags & EP_IntValue ){
207533e619fcSdrh     int i = pExpr->u.iValue;
2076d50ffc41Sdrh     assert( i>=0 );
207792b01d53Sdrh     if( negFlag ) i = -i;
207892b01d53Sdrh     sqlite3VdbeAddOp2(v, OP_Integer, i, iMem);
2079fd773cf9Sdrh   }else{
20805f1d6b61Sshaneh     int c;
20815f1d6b61Sshaneh     i64 value;
2082fd773cf9Sdrh     const char *z = pExpr->u.zToken;
2083fd773cf9Sdrh     assert( z!=0 );
20845f1d6b61Sshaneh     c = sqlite3Atoi64(z, &value, sqlite3Strlen30(z), SQLITE_UTF8);
20855f1d6b61Sshaneh     if( c==0 || (c==2 && negFlag) ){
2086598f1340Sdrh       char *zV;
2087158b9cb9Sdrh       if( negFlag ){ value = c==2 ? SMALLEST_INT64 : -value; }
2088598f1340Sdrh       zV = dup8bytes(v, (char*)&value);
20899de221dfSdrh       sqlite3VdbeAddOp4(v, OP_Int64, 0, iMem, 0, zV, P4_INT64);
2090fec19aadSdrh     }else{
209113573c71Sdrh #ifdef SQLITE_OMIT_FLOATING_POINT
209213573c71Sdrh       sqlite3ErrorMsg(pParse, "oversized integer: %s%s", negFlag ? "-" : "", z);
209313573c71Sdrh #else
2094b7916a78Sdrh       codeReal(v, z, negFlag, iMem);
209513573c71Sdrh #endif
2096fec19aadSdrh     }
2097fec19aadSdrh   }
2098c9cf901dSdanielk1977 }
2099fec19aadSdrh 
2100ceea3321Sdrh /*
2101ceea3321Sdrh ** Clear a cache entry.
2102ceea3321Sdrh */
2103ceea3321Sdrh static void cacheEntryClear(Parse *pParse, struct yColCache *p){
2104ceea3321Sdrh   if( p->tempReg ){
2105ceea3321Sdrh     if( pParse->nTempReg<ArraySize(pParse->aTempReg) ){
2106ceea3321Sdrh       pParse->aTempReg[pParse->nTempReg++] = p->iReg;
2107ceea3321Sdrh     }
2108ceea3321Sdrh     p->tempReg = 0;
2109ceea3321Sdrh   }
2110ceea3321Sdrh }
2111ceea3321Sdrh 
2112ceea3321Sdrh 
2113ceea3321Sdrh /*
2114ceea3321Sdrh ** Record in the column cache that a particular column from a
2115ceea3321Sdrh ** particular table is stored in a particular register.
2116ceea3321Sdrh */
2117ceea3321Sdrh void sqlite3ExprCacheStore(Parse *pParse, int iTab, int iCol, int iReg){
2118ceea3321Sdrh   int i;
2119ceea3321Sdrh   int minLru;
2120ceea3321Sdrh   int idxLru;
2121ceea3321Sdrh   struct yColCache *p;
2122ceea3321Sdrh 
212320411ea7Sdrh   assert( iReg>0 );  /* Register numbers are always positive */
212420411ea7Sdrh   assert( iCol>=-1 && iCol<32768 );  /* Finite column numbers */
212520411ea7Sdrh 
2126b6da74ebSdrh   /* The SQLITE_ColumnCache flag disables the column cache.  This is used
2127b6da74ebSdrh   ** for testing only - to verify that SQLite always gets the same answer
2128b6da74ebSdrh   ** with and without the column cache.
2129b6da74ebSdrh   */
21307e5418e4Sdrh   if( OptimizationDisabled(pParse->db, SQLITE_ColumnCache) ) return;
2131b6da74ebSdrh 
213227ee406eSdrh   /* First replace any existing entry.
213327ee406eSdrh   **
213427ee406eSdrh   ** Actually, the way the column cache is currently used, we are guaranteed
213527ee406eSdrh   ** that the object will never already be in cache.  Verify this guarantee.
213627ee406eSdrh   */
213727ee406eSdrh #ifndef NDEBUG
2138ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
213927ee406eSdrh     assert( p->iReg==0 || p->iTable!=iTab || p->iColumn!=iCol );
2140ceea3321Sdrh   }
214127ee406eSdrh #endif
2142ceea3321Sdrh 
2143ceea3321Sdrh   /* Find an empty slot and replace it */
2144ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2145ceea3321Sdrh     if( p->iReg==0 ){
2146ceea3321Sdrh       p->iLevel = pParse->iCacheLevel;
2147ceea3321Sdrh       p->iTable = iTab;
2148ceea3321Sdrh       p->iColumn = iCol;
2149ceea3321Sdrh       p->iReg = iReg;
2150ceea3321Sdrh       p->tempReg = 0;
2151ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
2152ceea3321Sdrh       return;
2153ceea3321Sdrh     }
2154ceea3321Sdrh   }
2155ceea3321Sdrh 
2156ceea3321Sdrh   /* Replace the last recently used */
2157ceea3321Sdrh   minLru = 0x7fffffff;
2158ceea3321Sdrh   idxLru = -1;
2159ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2160ceea3321Sdrh     if( p->lru<minLru ){
2161ceea3321Sdrh       idxLru = i;
2162ceea3321Sdrh       minLru = p->lru;
2163ceea3321Sdrh     }
2164ceea3321Sdrh   }
216520411ea7Sdrh   if( ALWAYS(idxLru>=0) ){
2166ceea3321Sdrh     p = &pParse->aColCache[idxLru];
2167ceea3321Sdrh     p->iLevel = pParse->iCacheLevel;
2168ceea3321Sdrh     p->iTable = iTab;
2169ceea3321Sdrh     p->iColumn = iCol;
2170ceea3321Sdrh     p->iReg = iReg;
2171ceea3321Sdrh     p->tempReg = 0;
2172ceea3321Sdrh     p->lru = pParse->iCacheCnt++;
2173ceea3321Sdrh     return;
2174ceea3321Sdrh   }
2175ceea3321Sdrh }
2176ceea3321Sdrh 
2177ceea3321Sdrh /*
2178f49f3523Sdrh ** Indicate that registers between iReg..iReg+nReg-1 are being overwritten.
2179f49f3523Sdrh ** Purge the range of registers from the column cache.
2180ceea3321Sdrh */
2181f49f3523Sdrh void sqlite3ExprCacheRemove(Parse *pParse, int iReg, int nReg){
2182ceea3321Sdrh   int i;
2183f49f3523Sdrh   int iLast = iReg + nReg - 1;
2184ceea3321Sdrh   struct yColCache *p;
2185ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2186f49f3523Sdrh     int r = p->iReg;
2187f49f3523Sdrh     if( r>=iReg && r<=iLast ){
2188ceea3321Sdrh       cacheEntryClear(pParse, p);
2189ceea3321Sdrh       p->iReg = 0;
2190ceea3321Sdrh     }
2191ceea3321Sdrh   }
2192ceea3321Sdrh }
2193ceea3321Sdrh 
2194ceea3321Sdrh /*
2195ceea3321Sdrh ** Remember the current column cache context.  Any new entries added
2196ceea3321Sdrh ** added to the column cache after this call are removed when the
2197ceea3321Sdrh ** corresponding pop occurs.
2198ceea3321Sdrh */
2199ceea3321Sdrh void sqlite3ExprCachePush(Parse *pParse){
2200ceea3321Sdrh   pParse->iCacheLevel++;
22019ac7962aSdrh #ifdef SQLITE_DEBUG
22029ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
22039ac7962aSdrh     printf("PUSH to %d\n", pParse->iCacheLevel);
22049ac7962aSdrh   }
22059ac7962aSdrh #endif
2206ceea3321Sdrh }
2207ceea3321Sdrh 
2208ceea3321Sdrh /*
2209ceea3321Sdrh ** Remove from the column cache any entries that were added since the
2210ceea3321Sdrh ** the previous N Push operations.  In other words, restore the cache
2211ceea3321Sdrh ** to the state it was in N Pushes ago.
2212ceea3321Sdrh */
2213ceea3321Sdrh void sqlite3ExprCachePop(Parse *pParse, int N){
2214ceea3321Sdrh   int i;
2215ceea3321Sdrh   struct yColCache *p;
2216ceea3321Sdrh   assert( N>0 );
2217ceea3321Sdrh   assert( pParse->iCacheLevel>=N );
2218ceea3321Sdrh   pParse->iCacheLevel -= N;
22199ac7962aSdrh #ifdef SQLITE_DEBUG
22209ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
22219ac7962aSdrh     printf("POP  to %d\n", pParse->iCacheLevel);
22229ac7962aSdrh   }
22239ac7962aSdrh #endif
2224ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2225ceea3321Sdrh     if( p->iReg && p->iLevel>pParse->iCacheLevel ){
2226ceea3321Sdrh       cacheEntryClear(pParse, p);
2227ceea3321Sdrh       p->iReg = 0;
2228ceea3321Sdrh     }
2229ceea3321Sdrh   }
2230ceea3321Sdrh }
2231945498f3Sdrh 
2232945498f3Sdrh /*
22335cd79239Sdrh ** When a cached column is reused, make sure that its register is
22345cd79239Sdrh ** no longer available as a temp register.  ticket #3879:  that same
22355cd79239Sdrh ** register might be in the cache in multiple places, so be sure to
22365cd79239Sdrh ** get them all.
22375cd79239Sdrh */
22385cd79239Sdrh static void sqlite3ExprCachePinRegister(Parse *pParse, int iReg){
22395cd79239Sdrh   int i;
22405cd79239Sdrh   struct yColCache *p;
22415cd79239Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
22425cd79239Sdrh     if( p->iReg==iReg ){
22435cd79239Sdrh       p->tempReg = 0;
22445cd79239Sdrh     }
22455cd79239Sdrh   }
22465cd79239Sdrh }
22475cd79239Sdrh 
22485cd79239Sdrh /*
22495c092e8aSdrh ** Generate code to extract the value of the iCol-th column of a table.
22505c092e8aSdrh */
22515c092e8aSdrh void sqlite3ExprCodeGetColumnOfTable(
22525c092e8aSdrh   Vdbe *v,        /* The VDBE under construction */
22535c092e8aSdrh   Table *pTab,    /* The table containing the value */
2254313619f5Sdrh   int iTabCur,    /* The table cursor.  Or the PK cursor for WITHOUT ROWID */
22555c092e8aSdrh   int iCol,       /* Index of the column to extract */
2256313619f5Sdrh   int regOut      /* Extract the value into this register */
22575c092e8aSdrh ){
22585c092e8aSdrh   if( iCol<0 || iCol==pTab->iPKey ){
22595c092e8aSdrh     sqlite3VdbeAddOp2(v, OP_Rowid, iTabCur, regOut);
22605c092e8aSdrh   }else{
22615c092e8aSdrh     int op = IsVirtual(pTab) ? OP_VColumn : OP_Column;
2262ee0ec8e1Sdrh     int x = iCol;
2263ee0ec8e1Sdrh     if( !HasRowid(pTab) ){
2264ee0ec8e1Sdrh       x = sqlite3ColumnOfIndex(sqlite3PrimaryKeyIndex(pTab), iCol);
2265ee0ec8e1Sdrh     }
2266ee0ec8e1Sdrh     sqlite3VdbeAddOp3(v, op, iTabCur, x, regOut);
22675c092e8aSdrh   }
22685c092e8aSdrh   if( iCol>=0 ){
22695c092e8aSdrh     sqlite3ColumnDefault(v, pTab, iCol, regOut);
22705c092e8aSdrh   }
22715c092e8aSdrh }
22725c092e8aSdrh 
22735c092e8aSdrh /*
2274945498f3Sdrh ** Generate code that will extract the iColumn-th column from
2275e55cbd72Sdrh ** table pTab and store the column value in a register.  An effort
2276e55cbd72Sdrh ** is made to store the column value in register iReg, but this is
2277e55cbd72Sdrh ** not guaranteed.  The location of the column value is returned.
2278e55cbd72Sdrh **
2279e55cbd72Sdrh ** There must be an open cursor to pTab in iTable when this routine
2280e55cbd72Sdrh ** is called.  If iColumn<0 then code is generated that extracts the rowid.
2281945498f3Sdrh */
2282e55cbd72Sdrh int sqlite3ExprCodeGetColumn(
2283e55cbd72Sdrh   Parse *pParse,   /* Parsing and code generating context */
22842133d822Sdrh   Table *pTab,     /* Description of the table we are reading from */
22852133d822Sdrh   int iColumn,     /* Index of the table column */
22862133d822Sdrh   int iTable,      /* The cursor pointing to the table */
2287a748fdccSdrh   int iReg,        /* Store results here */
2288a748fdccSdrh   u8 p5            /* P5 value for OP_Column */
22892133d822Sdrh ){
2290e55cbd72Sdrh   Vdbe *v = pParse->pVdbe;
2291e55cbd72Sdrh   int i;
2292da250ea5Sdrh   struct yColCache *p;
2293e55cbd72Sdrh 
2294ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2295b6da74ebSdrh     if( p->iReg>0 && p->iTable==iTable && p->iColumn==iColumn ){
2296ceea3321Sdrh       p->lru = pParse->iCacheCnt++;
22975cd79239Sdrh       sqlite3ExprCachePinRegister(pParse, p->iReg);
2298da250ea5Sdrh       return p->iReg;
2299e55cbd72Sdrh     }
2300e55cbd72Sdrh   }
2301e55cbd72Sdrh   assert( v!=0 );
23025c092e8aSdrh   sqlite3ExprCodeGetColumnOfTable(v, pTab, iTable, iColumn, iReg);
2303a748fdccSdrh   if( p5 ){
2304a748fdccSdrh     sqlite3VdbeChangeP5(v, p5);
2305a748fdccSdrh   }else{
2306ceea3321Sdrh     sqlite3ExprCacheStore(pParse, iTable, iColumn, iReg);
2307a748fdccSdrh   }
2308e55cbd72Sdrh   return iReg;
2309e55cbd72Sdrh }
2310e55cbd72Sdrh 
2311e55cbd72Sdrh /*
2312ceea3321Sdrh ** Clear all column cache entries.
2313e55cbd72Sdrh */
2314ceea3321Sdrh void sqlite3ExprCacheClear(Parse *pParse){
2315e55cbd72Sdrh   int i;
2316ceea3321Sdrh   struct yColCache *p;
2317ceea3321Sdrh 
23189ac7962aSdrh #if SQLITE_DEBUG
23199ac7962aSdrh   if( pParse->db->flags & SQLITE_VdbeAddopTrace ){
23209ac7962aSdrh     printf("CLEAR\n");
23219ac7962aSdrh   }
23229ac7962aSdrh #endif
2323ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2324ceea3321Sdrh     if( p->iReg ){
2325ceea3321Sdrh       cacheEntryClear(pParse, p);
2326ceea3321Sdrh       p->iReg = 0;
2327e55cbd72Sdrh     }
2328da250ea5Sdrh   }
2329da250ea5Sdrh }
2330e55cbd72Sdrh 
2331e55cbd72Sdrh /*
2332da250ea5Sdrh ** Record the fact that an affinity change has occurred on iCount
2333da250ea5Sdrh ** registers starting with iStart.
2334e55cbd72Sdrh */
2335da250ea5Sdrh void sqlite3ExprCacheAffinityChange(Parse *pParse, int iStart, int iCount){
2336f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iStart, iCount);
2337e55cbd72Sdrh }
2338e55cbd72Sdrh 
2339e55cbd72Sdrh /*
2340b21e7c70Sdrh ** Generate code to move content from registers iFrom...iFrom+nReg-1
2341b21e7c70Sdrh ** over to iTo..iTo+nReg-1. Keep the column cache up-to-date.
2342e55cbd72Sdrh */
2343b21e7c70Sdrh void sqlite3ExprCodeMove(Parse *pParse, int iFrom, int iTo, int nReg){
2344e55cbd72Sdrh   int i;
2345ceea3321Sdrh   struct yColCache *p;
2346e8e4af76Sdrh   assert( iFrom>=iTo+nReg || iFrom+nReg<=iTo );
2347e8e4af76Sdrh   sqlite3VdbeAddOp3(pParse->pVdbe, OP_Move, iFrom, iTo, nReg-1);
2348ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2349ceea3321Sdrh     int x = p->iReg;
2350b21e7c70Sdrh     if( x>=iFrom && x<iFrom+nReg ){
2351ceea3321Sdrh       p->iReg += iTo-iFrom;
2352e55cbd72Sdrh     }
2353e55cbd72Sdrh   }
2354945498f3Sdrh }
2355945498f3Sdrh 
2356f49f3523Sdrh #if defined(SQLITE_DEBUG) || defined(SQLITE_COVERAGE_TEST)
235792b01d53Sdrh /*
2358652fbf55Sdrh ** Return true if any register in the range iFrom..iTo (inclusive)
2359652fbf55Sdrh ** is used as part of the column cache.
2360f49f3523Sdrh **
2361f49f3523Sdrh ** This routine is used within assert() and testcase() macros only
2362f49f3523Sdrh ** and does not appear in a normal build.
2363652fbf55Sdrh */
2364652fbf55Sdrh static int usedAsColumnCache(Parse *pParse, int iFrom, int iTo){
2365652fbf55Sdrh   int i;
2366ceea3321Sdrh   struct yColCache *p;
2367ceea3321Sdrh   for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
2368ceea3321Sdrh     int r = p->iReg;
2369f49f3523Sdrh     if( r>=iFrom && r<=iTo ) return 1;    /*NO_TEST*/
2370652fbf55Sdrh   }
2371652fbf55Sdrh   return 0;
2372652fbf55Sdrh }
2373f49f3523Sdrh #endif /* SQLITE_DEBUG || SQLITE_COVERAGE_TEST */
2374652fbf55Sdrh 
2375652fbf55Sdrh /*
2376a4c3c87eSdrh ** Convert an expression node to a TK_REGISTER
2377a4c3c87eSdrh */
2378a4c3c87eSdrh static void exprToRegister(Expr *p, int iReg){
2379a4c3c87eSdrh   p->op2 = p->op;
2380a4c3c87eSdrh   p->op = TK_REGISTER;
2381a4c3c87eSdrh   p->iTable = iReg;
2382a4c3c87eSdrh   ExprClearProperty(p, EP_Skip);
2383a4c3c87eSdrh }
2384a4c3c87eSdrh 
2385a4c3c87eSdrh /*
2386cce7d176Sdrh ** Generate code into the current Vdbe to evaluate the given
23872dcef11bSdrh ** expression.  Attempt to store the results in register "target".
23882dcef11bSdrh ** Return the register where results are stored.
2389389a1adbSdrh **
23908b213899Sdrh ** With this routine, there is no guarantee that results will
23912dcef11bSdrh ** be stored in target.  The result might be stored in some other
23922dcef11bSdrh ** register if it is convenient to do so.  The calling function
23932dcef11bSdrh ** must check the return code and move the results to the desired
23942dcef11bSdrh ** register.
2395cce7d176Sdrh */
2396678ccce8Sdrh int sqlite3ExprCodeTarget(Parse *pParse, Expr *pExpr, int target){
23972dcef11bSdrh   Vdbe *v = pParse->pVdbe;  /* The VM under construction */
23982dcef11bSdrh   int op;                   /* The opcode being coded */
23992dcef11bSdrh   int inReg = target;       /* Results stored in register inReg */
24002dcef11bSdrh   int regFree1 = 0;         /* If non-zero free this temporary register */
24012dcef11bSdrh   int regFree2 = 0;         /* If non-zero free this temporary register */
2402678ccce8Sdrh   int r1, r2, r3, r4;       /* Various register numbers */
240320411ea7Sdrh   sqlite3 *db = pParse->db; /* The database connection */
240410d1edf0Sdrh   Expr tempX;               /* Temporary expression node */
2405ffe07b2dSdrh 
24069cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
240720411ea7Sdrh   if( v==0 ){
240820411ea7Sdrh     assert( pParse->db->mallocFailed );
240920411ea7Sdrh     return 0;
241020411ea7Sdrh   }
2411389a1adbSdrh 
2412389a1adbSdrh   if( pExpr==0 ){
2413389a1adbSdrh     op = TK_NULL;
2414389a1adbSdrh   }else{
2415f2bc013cSdrh     op = pExpr->op;
2416389a1adbSdrh   }
2417f2bc013cSdrh   switch( op ){
241813449892Sdrh     case TK_AGG_COLUMN: {
241913449892Sdrh       AggInfo *pAggInfo = pExpr->pAggInfo;
242013449892Sdrh       struct AggInfo_col *pCol = &pAggInfo->aCol[pExpr->iAgg];
242113449892Sdrh       if( !pAggInfo->directMode ){
24229de221dfSdrh         assert( pCol->iMem>0 );
24239de221dfSdrh         inReg = pCol->iMem;
242413449892Sdrh         break;
242513449892Sdrh       }else if( pAggInfo->useSortingIdx ){
24265134d135Sdan         sqlite3VdbeAddOp3(v, OP_Column, pAggInfo->sortingIdxPTab,
2427389a1adbSdrh                               pCol->iSorterColumn, target);
242813449892Sdrh         break;
242913449892Sdrh       }
243013449892Sdrh       /* Otherwise, fall thru into the TK_COLUMN case */
243113449892Sdrh     }
2432967e8b73Sdrh     case TK_COLUMN: {
2433b2b9d3d7Sdrh       int iTab = pExpr->iTable;
2434b2b9d3d7Sdrh       if( iTab<0 ){
2435b2b9d3d7Sdrh         if( pParse->ckBase>0 ){
2436b2b9d3d7Sdrh           /* Generating CHECK constraints or inserting into partial index */
2437aa9b8963Sdrh           inReg = pExpr->iColumn + pParse->ckBase;
2438b2b9d3d7Sdrh           break;
2439c4a3c779Sdrh         }else{
2440b2b9d3d7Sdrh           /* Deleting from a partial index */
2441b2b9d3d7Sdrh           iTab = pParse->iPartIdxTab;
24422282792aSdrh         }
2443b2b9d3d7Sdrh       }
2444b2b9d3d7Sdrh       inReg = sqlite3ExprCodeGetColumn(pParse, pExpr->pTab,
2445b2b9d3d7Sdrh                                pExpr->iColumn, iTab, target,
2446b2b9d3d7Sdrh                                pExpr->op2);
2447cce7d176Sdrh       break;
2448cce7d176Sdrh     }
2449cce7d176Sdrh     case TK_INTEGER: {
245013573c71Sdrh       codeInteger(pParse, pExpr, 0, target);
2451fec19aadSdrh       break;
245251e9a445Sdrh     }
245313573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
2454598f1340Sdrh     case TK_FLOAT: {
245533e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
245633e619fcSdrh       codeReal(v, pExpr->u.zToken, 0, target);
2457598f1340Sdrh       break;
2458598f1340Sdrh     }
245913573c71Sdrh #endif
2460fec19aadSdrh     case TK_STRING: {
246133e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
246233e619fcSdrh       sqlite3VdbeAddOp4(v, OP_String8, 0, target, 0, pExpr->u.zToken, 0);
2463cce7d176Sdrh       break;
2464cce7d176Sdrh     }
2465f0863fe5Sdrh     case TK_NULL: {
24669de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2467f0863fe5Sdrh       break;
2468f0863fe5Sdrh     }
24695338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_BLOB_LITERAL
2470c572ef7fSdanielk1977     case TK_BLOB: {
24716c8c6cecSdrh       int n;
24726c8c6cecSdrh       const char *z;
2473ca48c90fSdrh       char *zBlob;
247433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
247533e619fcSdrh       assert( pExpr->u.zToken[0]=='x' || pExpr->u.zToken[0]=='X' );
247633e619fcSdrh       assert( pExpr->u.zToken[1]=='\'' );
247733e619fcSdrh       z = &pExpr->u.zToken[2];
2478b7916a78Sdrh       n = sqlite3Strlen30(z) - 1;
2479b7916a78Sdrh       assert( z[n]=='\'' );
2480ca48c90fSdrh       zBlob = sqlite3HexToBlob(sqlite3VdbeDb(v), z, n);
2481ca48c90fSdrh       sqlite3VdbeAddOp4(v, OP_Blob, n/2, target, 0, zBlob, P4_DYNAMIC);
2482c572ef7fSdanielk1977       break;
2483c572ef7fSdanielk1977     }
24845338a5f7Sdanielk1977 #endif
248550457896Sdrh     case TK_VARIABLE: {
248633e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
248733e619fcSdrh       assert( pExpr->u.zToken!=0 );
248833e619fcSdrh       assert( pExpr->u.zToken[0]!=0 );
2489eaf52d88Sdrh       sqlite3VdbeAddOp2(v, OP_Variable, pExpr->iColumn, target);
249033e619fcSdrh       if( pExpr->u.zToken[1]!=0 ){
249104e9eeadSdrh         assert( pExpr->u.zToken[0]=='?'
249204e9eeadSdrh              || strcmp(pExpr->u.zToken, pParse->azVar[pExpr->iColumn-1])==0 );
249304e9eeadSdrh         sqlite3VdbeChangeP4(v, -1, pParse->azVar[pExpr->iColumn-1], P4_STATIC);
2494895d7472Sdrh       }
249550457896Sdrh       break;
249650457896Sdrh     }
24974e0cff60Sdrh     case TK_REGISTER: {
24989de221dfSdrh       inReg = pExpr->iTable;
24994e0cff60Sdrh       break;
25004e0cff60Sdrh     }
25018b213899Sdrh     case TK_AS: {
25027445ffe2Sdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
25038b213899Sdrh       break;
25048b213899Sdrh     }
2505487e262fSdrh #ifndef SQLITE_OMIT_CAST
2506487e262fSdrh     case TK_CAST: {
2507487e262fSdrh       /* Expressions of the form:   CAST(pLeft AS token) */
2508f0113000Sdanielk1977       int aff, to_op;
25092dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
251033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
2511fdaac671Sdrh       aff = sqlite3AffinityType(pExpr->u.zToken, 0);
2512f0113000Sdanielk1977       to_op = aff - SQLITE_AFF_TEXT + OP_ToText;
2513f0113000Sdanielk1977       assert( to_op==OP_ToText    || aff!=SQLITE_AFF_TEXT    );
2514f0113000Sdanielk1977       assert( to_op==OP_ToBlob    || aff!=SQLITE_AFF_NONE    );
2515f0113000Sdanielk1977       assert( to_op==OP_ToNumeric || aff!=SQLITE_AFF_NUMERIC );
2516f0113000Sdanielk1977       assert( to_op==OP_ToInt     || aff!=SQLITE_AFF_INTEGER );
2517f0113000Sdanielk1977       assert( to_op==OP_ToReal    || aff!=SQLITE_AFF_REAL    );
2518c5499befSdrh       testcase( to_op==OP_ToText );
2519c5499befSdrh       testcase( to_op==OP_ToBlob );
2520c5499befSdrh       testcase( to_op==OP_ToNumeric );
2521c5499befSdrh       testcase( to_op==OP_ToInt );
2522c5499befSdrh       testcase( to_op==OP_ToReal );
25231735fa88Sdrh       if( inReg!=target ){
25241735fa88Sdrh         sqlite3VdbeAddOp2(v, OP_SCopy, inReg, target);
25251735fa88Sdrh         inReg = target;
25261735fa88Sdrh       }
25272dcef11bSdrh       sqlite3VdbeAddOp1(v, to_op, inReg);
2528c5499befSdrh       testcase( usedAsColumnCache(pParse, inReg, inReg) );
2529b3843a82Sdrh       sqlite3ExprCacheAffinityChange(pParse, inReg, 1);
2530487e262fSdrh       break;
2531487e262fSdrh     }
2532487e262fSdrh #endif /* SQLITE_OMIT_CAST */
2533c9b84a1fSdrh     case TK_LT:
2534c9b84a1fSdrh     case TK_LE:
2535c9b84a1fSdrh     case TK_GT:
2536c9b84a1fSdrh     case TK_GE:
2537c9b84a1fSdrh     case TK_NE:
2538c9b84a1fSdrh     case TK_EQ: {
2539f2bc013cSdrh       assert( TK_LT==OP_Lt );
2540f2bc013cSdrh       assert( TK_LE==OP_Le );
2541f2bc013cSdrh       assert( TK_GT==OP_Gt );
2542f2bc013cSdrh       assert( TK_GE==OP_Ge );
2543f2bc013cSdrh       assert( TK_EQ==OP_Eq );
2544f2bc013cSdrh       assert( TK_NE==OP_Ne );
2545c5499befSdrh       testcase( op==TK_LT );
2546c5499befSdrh       testcase( op==TK_LE );
2547c5499befSdrh       testcase( op==TK_GT );
2548c5499befSdrh       testcase( op==TK_GE );
2549c5499befSdrh       testcase( op==TK_EQ );
2550c5499befSdrh       testcase( op==TK_NE );
2551b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2552b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
255335573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
255435573356Sdrh                   r1, r2, inReg, SQLITE_STOREP2);
2555c5499befSdrh       testcase( regFree1==0 );
2556c5499befSdrh       testcase( regFree2==0 );
2557a37cdde0Sdanielk1977       break;
2558c9b84a1fSdrh     }
25596a2fe093Sdrh     case TK_IS:
25606a2fe093Sdrh     case TK_ISNOT: {
25616a2fe093Sdrh       testcase( op==TK_IS );
25626a2fe093Sdrh       testcase( op==TK_ISNOT );
2563b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2564b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
25656a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
25666a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
25676a2fe093Sdrh                   r1, r2, inReg, SQLITE_STOREP2 | SQLITE_NULLEQ);
25686a2fe093Sdrh       testcase( regFree1==0 );
25696a2fe093Sdrh       testcase( regFree2==0 );
25706a2fe093Sdrh       break;
25716a2fe093Sdrh     }
2572cce7d176Sdrh     case TK_AND:
2573cce7d176Sdrh     case TK_OR:
2574cce7d176Sdrh     case TK_PLUS:
2575cce7d176Sdrh     case TK_STAR:
2576cce7d176Sdrh     case TK_MINUS:
2577bf4133cbSdrh     case TK_REM:
2578bf4133cbSdrh     case TK_BITAND:
2579bf4133cbSdrh     case TK_BITOR:
258017c40294Sdrh     case TK_SLASH:
2581bf4133cbSdrh     case TK_LSHIFT:
2582855eb1cfSdrh     case TK_RSHIFT:
25830040077dSdrh     case TK_CONCAT: {
2584f2bc013cSdrh       assert( TK_AND==OP_And );
2585f2bc013cSdrh       assert( TK_OR==OP_Or );
2586f2bc013cSdrh       assert( TK_PLUS==OP_Add );
2587f2bc013cSdrh       assert( TK_MINUS==OP_Subtract );
2588f2bc013cSdrh       assert( TK_REM==OP_Remainder );
2589f2bc013cSdrh       assert( TK_BITAND==OP_BitAnd );
2590f2bc013cSdrh       assert( TK_BITOR==OP_BitOr );
2591f2bc013cSdrh       assert( TK_SLASH==OP_Divide );
2592f2bc013cSdrh       assert( TK_LSHIFT==OP_ShiftLeft );
2593f2bc013cSdrh       assert( TK_RSHIFT==OP_ShiftRight );
2594f2bc013cSdrh       assert( TK_CONCAT==OP_Concat );
2595c5499befSdrh       testcase( op==TK_AND );
2596c5499befSdrh       testcase( op==TK_OR );
2597c5499befSdrh       testcase( op==TK_PLUS );
2598c5499befSdrh       testcase( op==TK_MINUS );
2599c5499befSdrh       testcase( op==TK_REM );
2600c5499befSdrh       testcase( op==TK_BITAND );
2601c5499befSdrh       testcase( op==TK_BITOR );
2602c5499befSdrh       testcase( op==TK_SLASH );
2603c5499befSdrh       testcase( op==TK_LSHIFT );
2604c5499befSdrh       testcase( op==TK_RSHIFT );
2605c5499befSdrh       testcase( op==TK_CONCAT );
26062dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
26072dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
26085b6afba9Sdrh       sqlite3VdbeAddOp3(v, op, r2, r1, target);
2609c5499befSdrh       testcase( regFree1==0 );
2610c5499befSdrh       testcase( regFree2==0 );
26110040077dSdrh       break;
26120040077dSdrh     }
2613cce7d176Sdrh     case TK_UMINUS: {
2614fec19aadSdrh       Expr *pLeft = pExpr->pLeft;
2615fec19aadSdrh       assert( pLeft );
261613573c71Sdrh       if( pLeft->op==TK_INTEGER ){
261713573c71Sdrh         codeInteger(pParse, pLeft, 1, target);
261813573c71Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
261913573c71Sdrh       }else if( pLeft->op==TK_FLOAT ){
262033e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
262133e619fcSdrh         codeReal(v, pLeft->u.zToken, 1, target);
262213573c71Sdrh #endif
26233c84ddffSdrh       }else{
262410d1edf0Sdrh         tempX.op = TK_INTEGER;
262510d1edf0Sdrh         tempX.flags = EP_IntValue|EP_TokenOnly;
262610d1edf0Sdrh         tempX.u.iValue = 0;
262710d1edf0Sdrh         r1 = sqlite3ExprCodeTemp(pParse, &tempX, &regFree1);
2628e55cbd72Sdrh         r2 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree2);
26292dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_Subtract, r2, r1, target);
2630c5499befSdrh         testcase( regFree2==0 );
26313c84ddffSdrh       }
26329de221dfSdrh       inReg = target;
26336e142f54Sdrh       break;
26346e142f54Sdrh     }
2635bf4133cbSdrh     case TK_BITNOT:
26366e142f54Sdrh     case TK_NOT: {
2637f2bc013cSdrh       assert( TK_BITNOT==OP_BitNot );
2638f2bc013cSdrh       assert( TK_NOT==OP_Not );
2639c5499befSdrh       testcase( op==TK_BITNOT );
2640c5499befSdrh       testcase( op==TK_NOT );
2641e99fa2afSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2642e99fa2afSdrh       testcase( regFree1==0 );
2643e99fa2afSdrh       inReg = target;
2644e99fa2afSdrh       sqlite3VdbeAddOp2(v, op, r1, inReg);
2645cce7d176Sdrh       break;
2646cce7d176Sdrh     }
2647cce7d176Sdrh     case TK_ISNULL:
2648cce7d176Sdrh     case TK_NOTNULL: {
26496a288a33Sdrh       int addr;
2650f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
2651f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
2652c5499befSdrh       testcase( op==TK_ISNULL );
2653c5499befSdrh       testcase( op==TK_NOTNULL );
26549de221dfSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
26552dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
2656c5499befSdrh       testcase( regFree1==0 );
26572dcef11bSdrh       addr = sqlite3VdbeAddOp1(v, op, r1);
26589de221dfSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, -1);
26596a288a33Sdrh       sqlite3VdbeJumpHere(v, addr);
2660a37cdde0Sdanielk1977       break;
2661f2bc013cSdrh     }
26622282792aSdrh     case TK_AGG_FUNCTION: {
266313449892Sdrh       AggInfo *pInfo = pExpr->pAggInfo;
26647e56e711Sdrh       if( pInfo==0 ){
266533e619fcSdrh         assert( !ExprHasProperty(pExpr, EP_IntValue) );
266633e619fcSdrh         sqlite3ErrorMsg(pParse, "misuse of aggregate: %s()", pExpr->u.zToken);
26677e56e711Sdrh       }else{
26689de221dfSdrh         inReg = pInfo->aFunc[pExpr->iAgg].iMem;
26697e56e711Sdrh       }
26702282792aSdrh       break;
26712282792aSdrh     }
2672cce7d176Sdrh     case TK_FUNCTION: {
267312ffee8cSdrh       ExprList *pFarg;       /* List of function arguments */
267412ffee8cSdrh       int nFarg;             /* Number of function arguments */
267512ffee8cSdrh       FuncDef *pDef;         /* The function definition object */
267612ffee8cSdrh       int nId;               /* Length of the function name in bytes */
267712ffee8cSdrh       const char *zId;       /* The function name */
267812ffee8cSdrh       int constMask = 0;     /* Mask of function arguments that are constant */
267912ffee8cSdrh       int i;                 /* Loop counter */
268012ffee8cSdrh       u8 enc = ENC(db);      /* The text encoding used by this database */
268112ffee8cSdrh       CollSeq *pColl = 0;    /* A collating sequence */
268217435752Sdrh 
26836ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
2684c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
268512ffee8cSdrh         pFarg = 0;
268612ffee8cSdrh       }else{
268712ffee8cSdrh         pFarg = pExpr->x.pList;
268812ffee8cSdrh       }
268912ffee8cSdrh       nFarg = pFarg ? pFarg->nExpr : 0;
269033e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
269133e619fcSdrh       zId = pExpr->u.zToken;
2692b7916a78Sdrh       nId = sqlite3Strlen30(zId);
269312ffee8cSdrh       pDef = sqlite3FindFunction(db, zId, nId, nFarg, enc, 0);
2694feb306f5Sdrh       if( pDef==0 ){
2695feb306f5Sdrh         sqlite3ErrorMsg(pParse, "unknown function: %.*s()", nId, zId);
2696feb306f5Sdrh         break;
2697feb306f5Sdrh       }
2698ae6bb957Sdrh 
2699ae6bb957Sdrh       /* Attempt a direct implementation of the built-in COALESCE() and
2700ae6bb957Sdrh       ** IFNULL() functions.  This avoids unnecessary evalation of
2701ae6bb957Sdrh       ** arguments past the first non-NULL argument.
2702ae6bb957Sdrh       */
2703d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_COALESCE ){
2704ae6bb957Sdrh         int endCoalesce = sqlite3VdbeMakeLabel(v);
2705ae6bb957Sdrh         assert( nFarg>=2 );
2706ae6bb957Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2707ae6bb957Sdrh         for(i=1; i<nFarg; i++){
2708ae6bb957Sdrh           sqlite3VdbeAddOp2(v, OP_NotNull, target, endCoalesce);
2709f49f3523Sdrh           sqlite3ExprCacheRemove(pParse, target, 1);
2710ae6bb957Sdrh           sqlite3ExprCachePush(pParse);
2711ae6bb957Sdrh           sqlite3ExprCode(pParse, pFarg->a[i].pExpr, target);
2712ae6bb957Sdrh           sqlite3ExprCachePop(pParse, 1);
2713ae6bb957Sdrh         }
2714ae6bb957Sdrh         sqlite3VdbeResolveLabel(v, endCoalesce);
2715ae6bb957Sdrh         break;
2716ae6bb957Sdrh       }
2717ae6bb957Sdrh 
2718cca9f3d2Sdrh       /* The UNLIKELY() function is a no-op.  The result is the value
2719cca9f3d2Sdrh       ** of the first argument.
2720cca9f3d2Sdrh       */
2721cca9f3d2Sdrh       if( pDef->funcFlags & SQLITE_FUNC_UNLIKELY ){
2722cca9f3d2Sdrh         assert( nFarg>=1 );
2723cca9f3d2Sdrh         sqlite3ExprCode(pParse, pFarg->a[0].pExpr, target);
2724cca9f3d2Sdrh         break;
2725cca9f3d2Sdrh       }
2726ae6bb957Sdrh 
2727d1a01edaSdrh       for(i=0; i<nFarg; i++){
2728d1a01edaSdrh         if( i<32 && sqlite3ExprIsConstant(pFarg->a[i].pExpr) ){
2729d1a01edaSdrh           constMask |= (1<<i);
2730d1a01edaSdrh         }
2731d1a01edaSdrh         if( (pDef->funcFlags & SQLITE_FUNC_NEEDCOLL)!=0 && !pColl ){
2732d1a01edaSdrh           pColl = sqlite3ExprCollSeq(pParse, pFarg->a[i].pExpr);
2733d1a01edaSdrh         }
2734d1a01edaSdrh       }
273512ffee8cSdrh       if( pFarg ){
2736d1a01edaSdrh         if( constMask ){
2737d1a01edaSdrh           r1 = pParse->nMem+1;
2738d1a01edaSdrh           pParse->nMem += nFarg;
2739d1a01edaSdrh         }else{
274012ffee8cSdrh           r1 = sqlite3GetTempRange(pParse, nFarg);
2741d1a01edaSdrh         }
2742a748fdccSdrh 
2743a748fdccSdrh         /* For length() and typeof() functions with a column argument,
2744a748fdccSdrh         ** set the P5 parameter to the OP_Column opcode to OPFLAG_LENGTHARG
2745a748fdccSdrh         ** or OPFLAG_TYPEOFARG respectively, to avoid unnecessary data
2746a748fdccSdrh         ** loading.
2747a748fdccSdrh         */
2748d36e1041Sdrh         if( (pDef->funcFlags & (SQLITE_FUNC_LENGTH|SQLITE_FUNC_TYPEOF))!=0 ){
27494e245a4cSdrh           u8 exprOp;
2750a748fdccSdrh           assert( nFarg==1 );
2751a748fdccSdrh           assert( pFarg->a[0].pExpr!=0 );
27524e245a4cSdrh           exprOp = pFarg->a[0].pExpr->op;
27534e245a4cSdrh           if( exprOp==TK_COLUMN || exprOp==TK_AGG_COLUMN ){
2754a748fdccSdrh             assert( SQLITE_FUNC_LENGTH==OPFLAG_LENGTHARG );
2755a748fdccSdrh             assert( SQLITE_FUNC_TYPEOF==OPFLAG_TYPEOFARG );
2756b1fba286Sdrh             testcase( pDef->funcFlags & OPFLAG_LENGTHARG );
2757b1fba286Sdrh             pFarg->a[0].pExpr->op2 =
2758b1fba286Sdrh                   pDef->funcFlags & (OPFLAG_LENGTHARG|OPFLAG_TYPEOFARG);
2759a748fdccSdrh           }
2760a748fdccSdrh         }
2761a748fdccSdrh 
2762d7d385ddSdrh         sqlite3ExprCachePush(pParse);     /* Ticket 2ea2425d34be */
2763d1a01edaSdrh         sqlite3ExprCodeExprList(pParse, pFarg, r1,
2764d1a01edaSdrh                                 SQLITE_ECEL_DUP|SQLITE_ECEL_FACTOR);
2765d7d385ddSdrh         sqlite3ExprCachePop(pParse, 1);   /* Ticket 2ea2425d34be */
2766892d3179Sdrh       }else{
276712ffee8cSdrh         r1 = 0;
2768892d3179Sdrh       }
2769b7f6f68fSdrh #ifndef SQLITE_OMIT_VIRTUALTABLE
2770a43fa227Sdrh       /* Possibly overload the function if the first argument is
2771a43fa227Sdrh       ** a virtual table column.
2772a43fa227Sdrh       **
2773a43fa227Sdrh       ** For infix functions (LIKE, GLOB, REGEXP, and MATCH) use the
2774a43fa227Sdrh       ** second argument, not the first, as the argument to test to
2775a43fa227Sdrh       ** see if it is a column in a virtual table.  This is done because
2776a43fa227Sdrh       ** the left operand of infix functions (the operand we want to
2777a43fa227Sdrh       ** control overloading) ends up as the second argument to the
2778a43fa227Sdrh       ** function.  The expression "A glob B" is equivalent to
2779a43fa227Sdrh       ** "glob(B,A).  We want to use the A in "A glob B" to test
2780a43fa227Sdrh       ** for function overloading.  But we use the B term in "glob(B,A)".
2781a43fa227Sdrh       */
278212ffee8cSdrh       if( nFarg>=2 && (pExpr->flags & EP_InfixFunc) ){
278312ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[1].pExpr);
278412ffee8cSdrh       }else if( nFarg>0 ){
278512ffee8cSdrh         pDef = sqlite3VtabOverloadFunction(db, pDef, nFarg, pFarg->a[0].pExpr);
2786b7f6f68fSdrh       }
2787b7f6f68fSdrh #endif
2788d36e1041Sdrh       if( pDef->funcFlags & SQLITE_FUNC_NEEDCOLL ){
27898b213899Sdrh         if( !pColl ) pColl = db->pDfltColl;
279066a5167bSdrh         sqlite3VdbeAddOp4(v, OP_CollSeq, 0, 0, 0, (char *)pColl, P4_COLLSEQ);
2791682f68b0Sdanielk1977       }
27922dcef11bSdrh       sqlite3VdbeAddOp4(v, OP_Function, constMask, r1, target,
279366a5167bSdrh                         (char*)pDef, P4_FUNCDEF);
279412ffee8cSdrh       sqlite3VdbeChangeP5(v, (u8)nFarg);
2795d1a01edaSdrh       if( nFarg && constMask==0 ){
279612ffee8cSdrh         sqlite3ReleaseTempRange(pParse, r1, nFarg);
27972dcef11bSdrh       }
27986ec2733bSdrh       break;
27996ec2733bSdrh     }
2800fe2093d7Sdrh #ifndef SQLITE_OMIT_SUBQUERY
2801fe2093d7Sdrh     case TK_EXISTS:
280219a775c2Sdrh     case TK_SELECT: {
2803c5499befSdrh       testcase( op==TK_EXISTS );
2804c5499befSdrh       testcase( op==TK_SELECT );
28051450bc6eSdrh       inReg = sqlite3CodeSubselect(pParse, pExpr, 0, 0);
280619a775c2Sdrh       break;
280719a775c2Sdrh     }
2808fef5208cSdrh     case TK_IN: {
2809e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
2810e3365e6cSdrh       int destIfNull = sqlite3VdbeMakeLabel(v);
2811e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Null, 0, target);
2812e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
281366ba23ceSdrh       sqlite3VdbeAddOp2(v, OP_Integer, 1, target);
2814e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
2815e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_AddImm, target, 0);
2816e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfNull);
2817fef5208cSdrh       break;
2818fef5208cSdrh     }
2819e3365e6cSdrh #endif /* SQLITE_OMIT_SUBQUERY */
2820e3365e6cSdrh 
2821e3365e6cSdrh 
28222dcef11bSdrh     /*
28232dcef11bSdrh     **    x BETWEEN y AND z
28242dcef11bSdrh     **
28252dcef11bSdrh     ** This is equivalent to
28262dcef11bSdrh     **
28272dcef11bSdrh     **    x>=y AND x<=z
28282dcef11bSdrh     **
28292dcef11bSdrh     ** X is stored in pExpr->pLeft.
28302dcef11bSdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
28312dcef11bSdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
28322dcef11bSdrh     */
2833fef5208cSdrh     case TK_BETWEEN: {
2834be5c89acSdrh       Expr *pLeft = pExpr->pLeft;
28356ab3a2ecSdanielk1977       struct ExprList_item *pLItem = pExpr->x.pList->a;
2836be5c89acSdrh       Expr *pRight = pLItem->pExpr;
283735573356Sdrh 
2838b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pLeft, &regFree1);
2839b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2840c5499befSdrh       testcase( regFree1==0 );
2841c5499befSdrh       testcase( regFree2==0 );
28422dcef11bSdrh       r3 = sqlite3GetTempReg(pParse);
2843678ccce8Sdrh       r4 = sqlite3GetTempReg(pParse);
284435573356Sdrh       codeCompare(pParse, pLeft, pRight, OP_Ge,
284535573356Sdrh                   r1, r2, r3, SQLITE_STOREP2);
2846be5c89acSdrh       pLItem++;
2847be5c89acSdrh       pRight = pLItem->pExpr;
28482dcef11bSdrh       sqlite3ReleaseTempReg(pParse, regFree2);
28492dcef11bSdrh       r2 = sqlite3ExprCodeTemp(pParse, pRight, &regFree2);
2850c5499befSdrh       testcase( regFree2==0 );
2851678ccce8Sdrh       codeCompare(pParse, pLeft, pRight, OP_Le, r1, r2, r4, SQLITE_STOREP2);
2852678ccce8Sdrh       sqlite3VdbeAddOp3(v, OP_And, r3, r4, target);
28532dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r3);
2854678ccce8Sdrh       sqlite3ReleaseTempReg(pParse, r4);
2855fef5208cSdrh       break;
2856fef5208cSdrh     }
2857ae80ddeaSdrh     case TK_COLLATE:
28584f07e5fbSdrh     case TK_UPLUS: {
28592dcef11bSdrh       inReg = sqlite3ExprCodeTarget(pParse, pExpr->pLeft, target);
2860a2e00042Sdrh       break;
2861a2e00042Sdrh     }
28622dcef11bSdrh 
2863165921a7Sdan     case TK_TRIGGER: {
286465a7cd16Sdan       /* If the opcode is TK_TRIGGER, then the expression is a reference
286565a7cd16Sdan       ** to a column in the new.* or old.* pseudo-tables available to
286665a7cd16Sdan       ** trigger programs. In this case Expr.iTable is set to 1 for the
286765a7cd16Sdan       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
286865a7cd16Sdan       ** is set to the column of the pseudo-table to read, or to -1 to
286965a7cd16Sdan       ** read the rowid field.
287065a7cd16Sdan       **
287165a7cd16Sdan       ** The expression is implemented using an OP_Param opcode. The p1
287265a7cd16Sdan       ** parameter is set to 0 for an old.rowid reference, or to (i+1)
287365a7cd16Sdan       ** to reference another column of the old.* pseudo-table, where
287465a7cd16Sdan       ** i is the index of the column. For a new.rowid reference, p1 is
287565a7cd16Sdan       ** set to (n+1), where n is the number of columns in each pseudo-table.
287665a7cd16Sdan       ** For a reference to any other column in the new.* pseudo-table, p1
287765a7cd16Sdan       ** is set to (n+2+i), where n and i are as defined previously. For
287865a7cd16Sdan       ** example, if the table on which triggers are being fired is
287965a7cd16Sdan       ** declared as:
288065a7cd16Sdan       **
288165a7cd16Sdan       **   CREATE TABLE t1(a, b);
288265a7cd16Sdan       **
288365a7cd16Sdan       ** Then p1 is interpreted as follows:
288465a7cd16Sdan       **
288565a7cd16Sdan       **   p1==0   ->    old.rowid     p1==3   ->    new.rowid
288665a7cd16Sdan       **   p1==1   ->    old.a         p1==4   ->    new.a
288765a7cd16Sdan       **   p1==2   ->    old.b         p1==5   ->    new.b
288865a7cd16Sdan       */
28892832ad42Sdan       Table *pTab = pExpr->pTab;
289065a7cd16Sdan       int p1 = pExpr->iTable * (pTab->nCol+1) + 1 + pExpr->iColumn;
289165a7cd16Sdan 
289265a7cd16Sdan       assert( pExpr->iTable==0 || pExpr->iTable==1 );
289365a7cd16Sdan       assert( pExpr->iColumn>=-1 && pExpr->iColumn<pTab->nCol );
289465a7cd16Sdan       assert( pTab->iPKey<0 || pExpr->iColumn!=pTab->iPKey );
289565a7cd16Sdan       assert( p1>=0 && p1<(pTab->nCol*2+2) );
289665a7cd16Sdan 
289765a7cd16Sdan       sqlite3VdbeAddOp2(v, OP_Param, p1, target);
289876d462eeSdan       VdbeComment((v, "%s.%s -> $%d",
2899165921a7Sdan         (pExpr->iTable ? "new" : "old"),
290076d462eeSdan         (pExpr->iColumn<0 ? "rowid" : pExpr->pTab->aCol[pExpr->iColumn].zName),
290176d462eeSdan         target
2902165921a7Sdan       ));
290365a7cd16Sdan 
290444dbca83Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
290565a7cd16Sdan       /* If the column has REAL affinity, it may currently be stored as an
290665a7cd16Sdan       ** integer. Use OP_RealAffinity to make sure it is really real.  */
29072832ad42Sdan       if( pExpr->iColumn>=0
29082832ad42Sdan        && pTab->aCol[pExpr->iColumn].affinity==SQLITE_AFF_REAL
29092832ad42Sdan       ){
29102832ad42Sdan         sqlite3VdbeAddOp1(v, OP_RealAffinity, target);
29112832ad42Sdan       }
291244dbca83Sdrh #endif
2913165921a7Sdan       break;
2914165921a7Sdan     }
2915165921a7Sdan 
2916165921a7Sdan 
29172dcef11bSdrh     /*
29182dcef11bSdrh     ** Form A:
29192dcef11bSdrh     **   CASE x WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
29202dcef11bSdrh     **
29212dcef11bSdrh     ** Form B:
29222dcef11bSdrh     **   CASE WHEN e1 THEN r1 WHEN e2 THEN r2 ... WHEN eN THEN rN ELSE y END
29232dcef11bSdrh     **
29242dcef11bSdrh     ** Form A is can be transformed into the equivalent form B as follows:
29252dcef11bSdrh     **   CASE WHEN x=e1 THEN r1 WHEN x=e2 THEN r2 ...
29262dcef11bSdrh     **        WHEN x=eN THEN rN ELSE y END
29272dcef11bSdrh     **
29282dcef11bSdrh     ** X (if it exists) is in pExpr->pLeft.
2929c5cd1249Sdrh     ** Y is in the last element of pExpr->x.pList if pExpr->x.pList->nExpr is
2930c5cd1249Sdrh     ** odd.  The Y is also optional.  If the number of elements in x.pList
2931c5cd1249Sdrh     ** is even, then Y is omitted and the "otherwise" result is NULL.
29322dcef11bSdrh     ** Ei is in pExpr->pList->a[i*2] and Ri is pExpr->pList->a[i*2+1].
29332dcef11bSdrh     **
29342dcef11bSdrh     ** The result of the expression is the Ri for the first matching Ei,
29352dcef11bSdrh     ** or if there is no matching Ei, the ELSE term Y, or if there is
29362dcef11bSdrh     ** no ELSE term, NULL.
29372dcef11bSdrh     */
293833cd4909Sdrh     default: assert( op==TK_CASE ); {
29392dcef11bSdrh       int endLabel;                     /* GOTO label for end of CASE stmt */
29402dcef11bSdrh       int nextCase;                     /* GOTO label for next WHEN clause */
29412dcef11bSdrh       int nExpr;                        /* 2x number of WHEN terms */
29422dcef11bSdrh       int i;                            /* Loop counter */
29432dcef11bSdrh       ExprList *pEList;                 /* List of WHEN terms */
29442dcef11bSdrh       struct ExprList_item *aListelem;  /* Array of WHEN terms */
29452dcef11bSdrh       Expr opCompare;                   /* The X==Ei expression */
29462dcef11bSdrh       Expr *pX;                         /* The X expression */
29471bd10f8aSdrh       Expr *pTest = 0;                  /* X==Ei (form A) or just Ei (form B) */
2948ceea3321Sdrh       VVA_ONLY( int iCacheLevel = pParse->iCacheLevel; )
294917a7f8ddSdrh 
29506ab3a2ecSdanielk1977       assert( !ExprHasProperty(pExpr, EP_xIsSelect) && pExpr->x.pList );
29516ab3a2ecSdanielk1977       assert(pExpr->x.pList->nExpr > 0);
29526ab3a2ecSdanielk1977       pEList = pExpr->x.pList;
2953be5c89acSdrh       aListelem = pEList->a;
2954be5c89acSdrh       nExpr = pEList->nExpr;
29552dcef11bSdrh       endLabel = sqlite3VdbeMakeLabel(v);
29562dcef11bSdrh       if( (pX = pExpr->pLeft)!=0 ){
295710d1edf0Sdrh         tempX = *pX;
295833cd4909Sdrh         testcase( pX->op==TK_COLUMN );
295910d1edf0Sdrh         exprToRegister(&tempX, sqlite3ExprCodeTemp(pParse, pX, &regFree1));
2960c5499befSdrh         testcase( regFree1==0 );
29612dcef11bSdrh         opCompare.op = TK_EQ;
296210d1edf0Sdrh         opCompare.pLeft = &tempX;
29632dcef11bSdrh         pTest = &opCompare;
29648b1db07fSdrh         /* Ticket b351d95f9cd5ef17e9d9dbae18f5ca8611190001:
29658b1db07fSdrh         ** The value in regFree1 might get SCopy-ed into the file result.
29668b1db07fSdrh         ** So make sure that the regFree1 register is not reused for other
29678b1db07fSdrh         ** purposes and possibly overwritten.  */
29688b1db07fSdrh         regFree1 = 0;
2969cce7d176Sdrh       }
2970c5cd1249Sdrh       for(i=0; i<nExpr-1; i=i+2){
2971ceea3321Sdrh         sqlite3ExprCachePush(pParse);
29722dcef11bSdrh         if( pX ){
29731bd10f8aSdrh           assert( pTest!=0 );
29742dcef11bSdrh           opCompare.pRight = aListelem[i].pExpr;
2975f5905aa7Sdrh         }else{
29762dcef11bSdrh           pTest = aListelem[i].pExpr;
297717a7f8ddSdrh         }
29782dcef11bSdrh         nextCase = sqlite3VdbeMakeLabel(v);
297933cd4909Sdrh         testcase( pTest->op==TK_COLUMN );
29802dcef11bSdrh         sqlite3ExprIfFalse(pParse, pTest, nextCase, SQLITE_JUMPIFNULL);
2981c5499befSdrh         testcase( aListelem[i+1].pExpr->op==TK_COLUMN );
29829de221dfSdrh         sqlite3ExprCode(pParse, aListelem[i+1].pExpr, target);
29832dcef11bSdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, endLabel);
2984ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
29852dcef11bSdrh         sqlite3VdbeResolveLabel(v, nextCase);
2986f570f011Sdrh       }
2987c5cd1249Sdrh       if( (nExpr&1)!=0 ){
2988ceea3321Sdrh         sqlite3ExprCachePush(pParse);
2989c5cd1249Sdrh         sqlite3ExprCode(pParse, pEList->a[nExpr-1].pExpr, target);
2990ceea3321Sdrh         sqlite3ExprCachePop(pParse, 1);
299117a7f8ddSdrh       }else{
29929de221dfSdrh         sqlite3VdbeAddOp2(v, OP_Null, 0, target);
299317a7f8ddSdrh       }
2994c1f4a19bSdanielk1977       assert( db->mallocFailed || pParse->nErr>0
2995c1f4a19bSdanielk1977            || pParse->iCacheLevel==iCacheLevel );
29962dcef11bSdrh       sqlite3VdbeResolveLabel(v, endLabel);
29976f34903eSdanielk1977       break;
29986f34903eSdanielk1977     }
29995338a5f7Sdanielk1977 #ifndef SQLITE_OMIT_TRIGGER
30006f34903eSdanielk1977     case TK_RAISE: {
3001165921a7Sdan       assert( pExpr->affinity==OE_Rollback
3002165921a7Sdan            || pExpr->affinity==OE_Abort
3003165921a7Sdan            || pExpr->affinity==OE_Fail
3004165921a7Sdan            || pExpr->affinity==OE_Ignore
3005165921a7Sdan       );
3006e0af83acSdan       if( !pParse->pTriggerTab ){
3007e0af83acSdan         sqlite3ErrorMsg(pParse,
3008e0af83acSdan                        "RAISE() may only be used within a trigger-program");
3009e0af83acSdan         return 0;
3010e0af83acSdan       }
3011e0af83acSdan       if( pExpr->affinity==OE_Abort ){
3012e0af83acSdan         sqlite3MayAbort(pParse);
3013e0af83acSdan       }
301433e619fcSdrh       assert( !ExprHasProperty(pExpr, EP_IntValue) );
3015e0af83acSdan       if( pExpr->affinity==OE_Ignore ){
3016e0af83acSdan         sqlite3VdbeAddOp4(
3017e0af83acSdan             v, OP_Halt, SQLITE_OK, OE_Ignore, 0, pExpr->u.zToken,0);
3018e0af83acSdan       }else{
3019433dccfbSdrh         sqlite3HaltConstraint(pParse, SQLITE_CONSTRAINT_TRIGGER,
3020f9c8ce3cSdrh                               pExpr->affinity, pExpr->u.zToken, 0, 0);
3021e0af83acSdan       }
3022e0af83acSdan 
3023ffe07b2dSdrh       break;
302417a7f8ddSdrh     }
30255338a5f7Sdanielk1977 #endif
3026ffe07b2dSdrh   }
30272dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
30282dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
30292dcef11bSdrh   return inReg;
30305b6afba9Sdrh }
30312dcef11bSdrh 
30322dcef11bSdrh /*
3033d1a01edaSdrh ** Factor out the code of the given expression to initialization time.
3034d1a01edaSdrh */
3035d673cddaSdrh void sqlite3ExprCodeAtInit(
3036d673cddaSdrh   Parse *pParse,    /* Parsing context */
3037d673cddaSdrh   Expr *pExpr,      /* The expression to code when the VDBE initializes */
3038d673cddaSdrh   int regDest,      /* Store the value in this register */
3039d673cddaSdrh   u8 reusable       /* True if this expression is reusable */
3040d673cddaSdrh ){
3041d1a01edaSdrh   ExprList *p;
3042d9f158e7Sdrh   assert( ConstFactorOk(pParse) );
3043d1a01edaSdrh   p = pParse->pConstExpr;
3044d1a01edaSdrh   pExpr = sqlite3ExprDup(pParse->db, pExpr, 0);
3045d1a01edaSdrh   p = sqlite3ExprListAppend(pParse, p, pExpr);
3046d673cddaSdrh   if( p ){
3047d673cddaSdrh      struct ExprList_item *pItem = &p->a[p->nExpr-1];
3048d673cddaSdrh      pItem->u.iConstExprReg = regDest;
3049d673cddaSdrh      pItem->reusable = reusable;
3050d673cddaSdrh   }
3051d1a01edaSdrh   pParse->pConstExpr = p;
3052d1a01edaSdrh }
3053d1a01edaSdrh 
3054d1a01edaSdrh /*
30552dcef11bSdrh ** Generate code to evaluate an expression and store the results
30562dcef11bSdrh ** into a register.  Return the register number where the results
30572dcef11bSdrh ** are stored.
30582dcef11bSdrh **
30592dcef11bSdrh ** If the register is a temporary register that can be deallocated,
3060678ccce8Sdrh ** then write its number into *pReg.  If the result register is not
30612dcef11bSdrh ** a temporary, then set *pReg to zero.
3062f30a969bSdrh **
3063f30a969bSdrh ** If pExpr is a constant, then this routine might generate this
3064f30a969bSdrh ** code to fill the register in the initialization section of the
3065f30a969bSdrh ** VDBE program, in order to factor it out of the evaluation loop.
30662dcef11bSdrh */
30672dcef11bSdrh int sqlite3ExprCodeTemp(Parse *pParse, Expr *pExpr, int *pReg){
3068f30a969bSdrh   int r2;
3069f30a969bSdrh   pExpr = sqlite3ExprSkipCollate(pExpr);
3070d9f158e7Sdrh   if( ConstFactorOk(pParse)
3071f30a969bSdrh    && pExpr->op!=TK_REGISTER
3072f30a969bSdrh    && sqlite3ExprIsConstantNotJoin(pExpr)
3073f30a969bSdrh   ){
3074f30a969bSdrh     ExprList *p = pParse->pConstExpr;
3075f30a969bSdrh     int i;
3076f30a969bSdrh     *pReg  = 0;
3077f30a969bSdrh     if( p ){
3078d673cddaSdrh       struct ExprList_item *pItem;
3079d673cddaSdrh       for(pItem=p->a, i=p->nExpr; i>0; pItem++, i--){
3080d673cddaSdrh         if( pItem->reusable && sqlite3ExprCompare(pItem->pExpr,pExpr,-1)==0 ){
3081d673cddaSdrh           return pItem->u.iConstExprReg;
3082f30a969bSdrh         }
3083f30a969bSdrh       }
3084f30a969bSdrh     }
3085f30a969bSdrh     r2 = ++pParse->nMem;
3086d673cddaSdrh     sqlite3ExprCodeAtInit(pParse, pExpr, r2, 1);
3087f30a969bSdrh   }else{
30882dcef11bSdrh     int r1 = sqlite3GetTempReg(pParse);
3089f30a969bSdrh     r2 = sqlite3ExprCodeTarget(pParse, pExpr, r1);
30902dcef11bSdrh     if( r2==r1 ){
30912dcef11bSdrh       *pReg = r1;
30922dcef11bSdrh     }else{
30932dcef11bSdrh       sqlite3ReleaseTempReg(pParse, r1);
30942dcef11bSdrh       *pReg = 0;
30952dcef11bSdrh     }
3096f30a969bSdrh   }
30972dcef11bSdrh   return r2;
30982dcef11bSdrh }
30992dcef11bSdrh 
31002dcef11bSdrh /*
31012dcef11bSdrh ** Generate code that will evaluate expression pExpr and store the
31022dcef11bSdrh ** results in register target.  The results are guaranteed to appear
31032dcef11bSdrh ** in register target.
31042dcef11bSdrh */
31052dcef11bSdrh int sqlite3ExprCode(Parse *pParse, Expr *pExpr, int target){
31069cbf3425Sdrh   int inReg;
31079cbf3425Sdrh 
31089cbf3425Sdrh   assert( target>0 && target<=pParse->nMem );
3109ebc16717Sdrh   if( pExpr && pExpr->op==TK_REGISTER ){
3110ebc16717Sdrh     sqlite3VdbeAddOp2(pParse->pVdbe, OP_Copy, pExpr->iTable, target);
3111ebc16717Sdrh   }else{
31129cbf3425Sdrh     inReg = sqlite3ExprCodeTarget(pParse, pExpr, target);
31130e359b30Sdrh     assert( pParse->pVdbe || pParse->db->mallocFailed );
31140e359b30Sdrh     if( inReg!=target && pParse->pVdbe ){
31159cbf3425Sdrh       sqlite3VdbeAddOp2(pParse->pVdbe, OP_SCopy, inReg, target);
311617a7f8ddSdrh     }
3117ebc16717Sdrh   }
3118389a1adbSdrh   return target;
3119cce7d176Sdrh }
3120cce7d176Sdrh 
3121cce7d176Sdrh /*
31222dcef11bSdrh ** Generate code that evalutes the given expression and puts the result
3123de4fcfddSdrh ** in register target.
312425303780Sdrh **
31252dcef11bSdrh ** Also make a copy of the expression results into another "cache" register
31262dcef11bSdrh ** and modify the expression so that the next time it is evaluated,
31272dcef11bSdrh ** the result is a copy of the cache register.
31282dcef11bSdrh **
31292dcef11bSdrh ** This routine is used for expressions that are used multiple
31302dcef11bSdrh ** times.  They are evaluated once and the results of the expression
31312dcef11bSdrh ** are reused.
313225303780Sdrh */
31332dcef11bSdrh int sqlite3ExprCodeAndCache(Parse *pParse, Expr *pExpr, int target){
313425303780Sdrh   Vdbe *v = pParse->pVdbe;
31352dcef11bSdrh   int inReg;
31362dcef11bSdrh   inReg = sqlite3ExprCode(pParse, pExpr, target);
3137de4fcfddSdrh   assert( target>0 );
3138c2acc4e4Sdrh   /* The only place, other than this routine, where expressions can be
3139c2acc4e4Sdrh   ** converted to TK_REGISTER is internal subexpressions in BETWEEN and
3140c2acc4e4Sdrh   ** CASE operators.  Neither ever calls this routine.  And this routine
3141c2acc4e4Sdrh   ** is never called twice on the same expression.  Hence it is impossible
3142c2acc4e4Sdrh   ** for the input to this routine to already be a register.  Nevertheless,
3143c2acc4e4Sdrh   ** it seems prudent to keep the ALWAYS() in case the conditions above
3144c2acc4e4Sdrh   ** change with future modifications or enhancements. */
314520bc393cSdrh   if( ALWAYS(pExpr->op!=TK_REGISTER) ){
314625303780Sdrh     int iMem;
31472dcef11bSdrh     iMem = ++pParse->nMem;
31482dcef11bSdrh     sqlite3VdbeAddOp2(v, OP_Copy, inReg, iMem);
3149a4c3c87eSdrh     exprToRegister(pExpr, iMem);
315025303780Sdrh   }
31512dcef11bSdrh   return inReg;
315225303780Sdrh }
31532dcef11bSdrh 
3154678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
31557e02e5e6Sdrh /*
31567e02e5e6Sdrh ** Generate a human-readable explanation of an expression tree.
31577e02e5e6Sdrh */
3158a84203a0Sdrh void sqlite3ExplainExpr(Vdbe *pOut, Expr *pExpr){
3159a84203a0Sdrh   int op;                   /* The opcode being coded */
3160a84203a0Sdrh   const char *zBinOp = 0;   /* Binary operator */
3161a84203a0Sdrh   const char *zUniOp = 0;   /* Unary operator */
3162a84203a0Sdrh   if( pExpr==0 ){
3163a84203a0Sdrh     op = TK_NULL;
31647e02e5e6Sdrh   }else{
3165a84203a0Sdrh     op = pExpr->op;
31667e02e5e6Sdrh   }
3167a84203a0Sdrh   switch( op ){
3168a84203a0Sdrh     case TK_AGG_COLUMN: {
316904b8342bSdrh       sqlite3ExplainPrintf(pOut, "AGG{%d:%d}",
317004b8342bSdrh             pExpr->iTable, pExpr->iColumn);
3171a84203a0Sdrh       break;
31727e02e5e6Sdrh     }
3173a84203a0Sdrh     case TK_COLUMN: {
3174a84203a0Sdrh       if( pExpr->iTable<0 ){
3175a84203a0Sdrh         /* This only happens when coding check constraints */
3176a84203a0Sdrh         sqlite3ExplainPrintf(pOut, "COLUMN(%d)", pExpr->iColumn);
3177a84203a0Sdrh       }else{
317804b8342bSdrh         sqlite3ExplainPrintf(pOut, "{%d:%d}",
317904b8342bSdrh                              pExpr->iTable, pExpr->iColumn);
3180a84203a0Sdrh       }
3181a84203a0Sdrh       break;
3182a84203a0Sdrh     }
3183a84203a0Sdrh     case TK_INTEGER: {
3184a84203a0Sdrh       if( pExpr->flags & EP_IntValue ){
318504b8342bSdrh         sqlite3ExplainPrintf(pOut, "%d", pExpr->u.iValue);
3186a84203a0Sdrh       }else{
318704b8342bSdrh         sqlite3ExplainPrintf(pOut, "%s", pExpr->u.zToken);
3188a84203a0Sdrh       }
3189a84203a0Sdrh       break;
3190a84203a0Sdrh     }
3191a84203a0Sdrh #ifndef SQLITE_OMIT_FLOATING_POINT
3192a84203a0Sdrh     case TK_FLOAT: {
319304b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3194a84203a0Sdrh       break;
3195a84203a0Sdrh     }
3196a84203a0Sdrh #endif
3197a84203a0Sdrh     case TK_STRING: {
319804b8342bSdrh       sqlite3ExplainPrintf(pOut,"%Q", pExpr->u.zToken);
3199a84203a0Sdrh       break;
3200a84203a0Sdrh     }
3201a84203a0Sdrh     case TK_NULL: {
3202a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"NULL");
3203a84203a0Sdrh       break;
3204a84203a0Sdrh     }
3205a84203a0Sdrh #ifndef SQLITE_OMIT_BLOB_LITERAL
3206a84203a0Sdrh     case TK_BLOB: {
320704b8342bSdrh       sqlite3ExplainPrintf(pOut,"%s", pExpr->u.zToken);
3208a84203a0Sdrh       break;
3209a84203a0Sdrh     }
3210a84203a0Sdrh #endif
3211a84203a0Sdrh     case TK_VARIABLE: {
3212a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"VARIABLE(%s,%d)",
3213a84203a0Sdrh                            pExpr->u.zToken, pExpr->iColumn);
3214a84203a0Sdrh       break;
3215a84203a0Sdrh     }
3216a84203a0Sdrh     case TK_REGISTER: {
3217a84203a0Sdrh       sqlite3ExplainPrintf(pOut,"REGISTER(%d)", pExpr->iTable);
3218a84203a0Sdrh       break;
3219a84203a0Sdrh     }
3220a84203a0Sdrh     case TK_AS: {
3221a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3222a84203a0Sdrh       break;
3223a84203a0Sdrh     }
3224a84203a0Sdrh #ifndef SQLITE_OMIT_CAST
3225a84203a0Sdrh     case TK_CAST: {
3226a84203a0Sdrh       /* Expressions of the form:   CAST(pLeft AS token) */
3227a84203a0Sdrh       const char *zAff = "unk";
3228fdaac671Sdrh       switch( sqlite3AffinityType(pExpr->u.zToken, 0) ){
3229a84203a0Sdrh         case SQLITE_AFF_TEXT:    zAff = "TEXT";     break;
3230a84203a0Sdrh         case SQLITE_AFF_NONE:    zAff = "NONE";     break;
3231a84203a0Sdrh         case SQLITE_AFF_NUMERIC: zAff = "NUMERIC";  break;
3232a84203a0Sdrh         case SQLITE_AFF_INTEGER: zAff = "INTEGER";  break;
3233a84203a0Sdrh         case SQLITE_AFF_REAL:    zAff = "REAL";     break;
3234a84203a0Sdrh       }
3235a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CAST-%s(", zAff);
3236a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3237a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3238a84203a0Sdrh       break;
3239a84203a0Sdrh     }
3240a84203a0Sdrh #endif /* SQLITE_OMIT_CAST */
3241a84203a0Sdrh     case TK_LT:      zBinOp = "LT";     break;
3242a84203a0Sdrh     case TK_LE:      zBinOp = "LE";     break;
3243a84203a0Sdrh     case TK_GT:      zBinOp = "GT";     break;
3244a84203a0Sdrh     case TK_GE:      zBinOp = "GE";     break;
3245a84203a0Sdrh     case TK_NE:      zBinOp = "NE";     break;
3246a84203a0Sdrh     case TK_EQ:      zBinOp = "EQ";     break;
3247a84203a0Sdrh     case TK_IS:      zBinOp = "IS";     break;
3248a84203a0Sdrh     case TK_ISNOT:   zBinOp = "ISNOT";  break;
3249a84203a0Sdrh     case TK_AND:     zBinOp = "AND";    break;
3250a84203a0Sdrh     case TK_OR:      zBinOp = "OR";     break;
3251a84203a0Sdrh     case TK_PLUS:    zBinOp = "ADD";    break;
3252a84203a0Sdrh     case TK_STAR:    zBinOp = "MUL";    break;
3253a84203a0Sdrh     case TK_MINUS:   zBinOp = "SUB";    break;
3254a84203a0Sdrh     case TK_REM:     zBinOp = "REM";    break;
3255a84203a0Sdrh     case TK_BITAND:  zBinOp = "BITAND"; break;
3256a84203a0Sdrh     case TK_BITOR:   zBinOp = "BITOR";  break;
3257a84203a0Sdrh     case TK_SLASH:   zBinOp = "DIV";    break;
3258a84203a0Sdrh     case TK_LSHIFT:  zBinOp = "LSHIFT"; break;
3259a84203a0Sdrh     case TK_RSHIFT:  zBinOp = "RSHIFT"; break;
3260a84203a0Sdrh     case TK_CONCAT:  zBinOp = "CONCAT"; break;
3261a84203a0Sdrh 
3262a84203a0Sdrh     case TK_UMINUS:  zUniOp = "UMINUS"; break;
3263a84203a0Sdrh     case TK_UPLUS:   zUniOp = "UPLUS";  break;
3264a84203a0Sdrh     case TK_BITNOT:  zUniOp = "BITNOT"; break;
3265a84203a0Sdrh     case TK_NOT:     zUniOp = "NOT";    break;
3266a84203a0Sdrh     case TK_ISNULL:  zUniOp = "ISNULL"; break;
3267a84203a0Sdrh     case TK_NOTNULL: zUniOp = "NOTNULL"; break;
3268a84203a0Sdrh 
32697a66da13Sdrh     case TK_COLLATE: {
32707a66da13Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
32717a66da13Sdrh       sqlite3ExplainPrintf(pOut,".COLLATE(%s)",pExpr->u.zToken);
32727a66da13Sdrh       break;
32737a66da13Sdrh     }
32747a66da13Sdrh 
3275a84203a0Sdrh     case TK_AGG_FUNCTION:
3276a84203a0Sdrh     case TK_FUNCTION: {
3277a84203a0Sdrh       ExprList *pFarg;       /* List of function arguments */
3278c5cd1249Sdrh       if( ExprHasProperty(pExpr, EP_TokenOnly) ){
3279a84203a0Sdrh         pFarg = 0;
3280a84203a0Sdrh       }else{
3281a84203a0Sdrh         pFarg = pExpr->x.pList;
3282a84203a0Sdrh       }
3283ed551b95Sdrh       if( op==TK_AGG_FUNCTION ){
3284ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "AGG_FUNCTION%d:%s(",
3285ed551b95Sdrh                              pExpr->op2, pExpr->u.zToken);
3286ed551b95Sdrh       }else{
3287ed551b95Sdrh         sqlite3ExplainPrintf(pOut, "FUNCTION:%s(", pExpr->u.zToken);
3288ed551b95Sdrh       }
3289a84203a0Sdrh       if( pFarg ){
3290a84203a0Sdrh         sqlite3ExplainExprList(pOut, pFarg);
32917e02e5e6Sdrh       }
32927e02e5e6Sdrh       sqlite3ExplainPrintf(pOut, ")");
3293a84203a0Sdrh       break;
3294a84203a0Sdrh     }
3295a84203a0Sdrh #ifndef SQLITE_OMIT_SUBQUERY
3296a84203a0Sdrh     case TK_EXISTS: {
3297a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "EXISTS(");
3298a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3299a84203a0Sdrh       sqlite3ExplainPrintf(pOut,")");
3300a84203a0Sdrh       break;
3301a84203a0Sdrh     }
3302a84203a0Sdrh     case TK_SELECT: {
3303a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "(");
3304a84203a0Sdrh       sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3305a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3306a84203a0Sdrh       break;
3307a84203a0Sdrh     }
3308a84203a0Sdrh     case TK_IN: {
3309a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "IN(");
3310a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3311a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3312a84203a0Sdrh       if( ExprHasProperty(pExpr, EP_xIsSelect) ){
3313a84203a0Sdrh         sqlite3ExplainSelect(pOut, pExpr->x.pSelect);
3314a84203a0Sdrh       }else{
3315a84203a0Sdrh         sqlite3ExplainExprList(pOut, pExpr->x.pList);
3316a84203a0Sdrh       }
3317a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3318a84203a0Sdrh       break;
3319a84203a0Sdrh     }
3320a84203a0Sdrh #endif /* SQLITE_OMIT_SUBQUERY */
3321a84203a0Sdrh 
3322a84203a0Sdrh     /*
3323a84203a0Sdrh     **    x BETWEEN y AND z
3324a84203a0Sdrh     **
3325a84203a0Sdrh     ** This is equivalent to
3326a84203a0Sdrh     **
3327a84203a0Sdrh     **    x>=y AND x<=z
3328a84203a0Sdrh     **
3329a84203a0Sdrh     ** X is stored in pExpr->pLeft.
3330a84203a0Sdrh     ** Y is stored in pExpr->pList->a[0].pExpr.
3331a84203a0Sdrh     ** Z is stored in pExpr->pList->a[1].pExpr.
3332a84203a0Sdrh     */
3333a84203a0Sdrh     case TK_BETWEEN: {
3334a84203a0Sdrh       Expr *pX = pExpr->pLeft;
3335a84203a0Sdrh       Expr *pY = pExpr->x.pList->a[0].pExpr;
3336a84203a0Sdrh       Expr *pZ = pExpr->x.pList->a[1].pExpr;
3337a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "BETWEEN(");
3338a84203a0Sdrh       sqlite3ExplainExpr(pOut, pX);
3339a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3340a84203a0Sdrh       sqlite3ExplainExpr(pOut, pY);
3341a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3342a84203a0Sdrh       sqlite3ExplainExpr(pOut, pZ);
3343a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ")");
3344a84203a0Sdrh       break;
3345a84203a0Sdrh     }
3346a84203a0Sdrh     case TK_TRIGGER: {
3347a84203a0Sdrh       /* If the opcode is TK_TRIGGER, then the expression is a reference
3348a84203a0Sdrh       ** to a column in the new.* or old.* pseudo-tables available to
3349a84203a0Sdrh       ** trigger programs. In this case Expr.iTable is set to 1 for the
3350a84203a0Sdrh       ** new.* pseudo-table, or 0 for the old.* pseudo-table. Expr.iColumn
3351a84203a0Sdrh       ** is set to the column of the pseudo-table to read, or to -1 to
3352a84203a0Sdrh       ** read the rowid field.
3353a84203a0Sdrh       */
3354a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "%s(%d)",
3355a84203a0Sdrh           pExpr->iTable ? "NEW" : "OLD", pExpr->iColumn);
3356a84203a0Sdrh       break;
3357a84203a0Sdrh     }
3358a84203a0Sdrh     case TK_CASE: {
3359a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "CASE(");
3360a84203a0Sdrh       sqlite3ExplainExpr(pOut, pExpr->pLeft);
3361a84203a0Sdrh       sqlite3ExplainPrintf(pOut, ",");
3362a84203a0Sdrh       sqlite3ExplainExprList(pOut, pExpr->x.pList);
3363a84203a0Sdrh       break;
3364a84203a0Sdrh     }
3365a84203a0Sdrh #ifndef SQLITE_OMIT_TRIGGER
3366a84203a0Sdrh     case TK_RAISE: {
3367a84203a0Sdrh       const char *zType = "unk";
3368a84203a0Sdrh       switch( pExpr->affinity ){
3369a84203a0Sdrh         case OE_Rollback:   zType = "rollback";  break;
3370a84203a0Sdrh         case OE_Abort:      zType = "abort";     break;
3371a84203a0Sdrh         case OE_Fail:       zType = "fail";      break;
3372a84203a0Sdrh         case OE_Ignore:     zType = "ignore";    break;
3373a84203a0Sdrh       }
3374a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "RAISE-%s(%s)", zType, pExpr->u.zToken);
3375a84203a0Sdrh       break;
3376a84203a0Sdrh     }
3377a84203a0Sdrh #endif
3378a84203a0Sdrh   }
3379a84203a0Sdrh   if( zBinOp ){
3380a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zBinOp);
3381a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3382a84203a0Sdrh     sqlite3ExplainPrintf(pOut,",");
3383a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pRight);
3384a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3385a84203a0Sdrh   }else if( zUniOp ){
3386a84203a0Sdrh     sqlite3ExplainPrintf(pOut,"%s(", zUniOp);
3387a84203a0Sdrh     sqlite3ExplainExpr(pOut, pExpr->pLeft);
3388a84203a0Sdrh     sqlite3ExplainPrintf(pOut,")");
3389a84203a0Sdrh   }
33907e02e5e6Sdrh }
3391678a9aa7Sdrh #endif /* defined(SQLITE_ENABLE_TREE_EXPLAIN) */
33927e02e5e6Sdrh 
3393678a9aa7Sdrh #if defined(SQLITE_ENABLE_TREE_EXPLAIN)
33947e02e5e6Sdrh /*
33957e02e5e6Sdrh ** Generate a human-readable explanation of an expression list.
33967e02e5e6Sdrh */
33977e02e5e6Sdrh void sqlite3ExplainExprList(Vdbe *pOut, ExprList *pList){
33987e02e5e6Sdrh   int i;
3399a84203a0Sdrh   if( pList==0 || pList->nExpr==0 ){
34007e02e5e6Sdrh     sqlite3ExplainPrintf(pOut, "(empty-list)");
34017e02e5e6Sdrh     return;
3402a84203a0Sdrh   }else if( pList->nExpr==1 ){
3403a84203a0Sdrh     sqlite3ExplainExpr(pOut, pList->a[0].pExpr);
3404a84203a0Sdrh   }else{
34057e02e5e6Sdrh     sqlite3ExplainPush(pOut);
34067e02e5e6Sdrh     for(i=0; i<pList->nExpr; i++){
3407a84203a0Sdrh       sqlite3ExplainPrintf(pOut, "item[%d] = ", i);
34087e02e5e6Sdrh       sqlite3ExplainPush(pOut);
34097e02e5e6Sdrh       sqlite3ExplainExpr(pOut, pList->a[i].pExpr);
3410b66e21fdSdrh       sqlite3ExplainPop(pOut);
34113e3f1a5bSdrh       if( pList->a[i].zName ){
34123e3f1a5bSdrh         sqlite3ExplainPrintf(pOut, " AS %s", pList->a[i].zName);
34133e3f1a5bSdrh       }
34143e3f1a5bSdrh       if( pList->a[i].bSpanIsTab ){
34153e3f1a5bSdrh         sqlite3ExplainPrintf(pOut, " (%s)", pList->a[i].zSpan);
34163e3f1a5bSdrh       }
34177e02e5e6Sdrh       if( i<pList->nExpr-1 ){
34187e02e5e6Sdrh         sqlite3ExplainNL(pOut);
34197e02e5e6Sdrh       }
34207e02e5e6Sdrh     }
34217e02e5e6Sdrh     sqlite3ExplainPop(pOut);
34227e02e5e6Sdrh   }
3423a84203a0Sdrh }
34247e02e5e6Sdrh #endif /* SQLITE_DEBUG */
34257e02e5e6Sdrh 
3426678ccce8Sdrh /*
3427268380caSdrh ** Generate code that pushes the value of every element of the given
34289cbf3425Sdrh ** expression list into a sequence of registers beginning at target.
3429268380caSdrh **
3430892d3179Sdrh ** Return the number of elements evaluated.
3431d1a01edaSdrh **
3432d1a01edaSdrh ** The SQLITE_ECEL_DUP flag prevents the arguments from being
3433d1a01edaSdrh ** filled using OP_SCopy.  OP_Copy must be used instead.
3434d1a01edaSdrh **
3435d1a01edaSdrh ** The SQLITE_ECEL_FACTOR argument allows constant arguments to be
3436d1a01edaSdrh ** factored out into initialization code.
3437268380caSdrh */
34384adee20fSdanielk1977 int sqlite3ExprCodeExprList(
3439268380caSdrh   Parse *pParse,     /* Parsing context */
3440389a1adbSdrh   ExprList *pList,   /* The expression list to be coded */
3441191b54cbSdrh   int target,        /* Where to write results */
3442d1a01edaSdrh   u8 flags           /* SQLITE_ECEL_* flags */
3443268380caSdrh ){
3444268380caSdrh   struct ExprList_item *pItem;
34459cbf3425Sdrh   int i, n;
3446d1a01edaSdrh   u8 copyOp = (flags & SQLITE_ECEL_DUP) ? OP_Copy : OP_SCopy;
34479d8b3072Sdrh   assert( pList!=0 );
34489cbf3425Sdrh   assert( target>0 );
3449d81a142bSdrh   assert( pParse->pVdbe!=0 );  /* Never gets this far otherwise */
3450268380caSdrh   n = pList->nExpr;
3451d9f158e7Sdrh   if( !ConstFactorOk(pParse) ) flags &= ~SQLITE_ECEL_FACTOR;
3452191b54cbSdrh   for(pItem=pList->a, i=0; i<n; i++, pItem++){
34537445ffe2Sdrh     Expr *pExpr = pItem->pExpr;
3454d1a01edaSdrh     if( (flags & SQLITE_ECEL_FACTOR)!=0 && sqlite3ExprIsConstant(pExpr) ){
3455d673cddaSdrh       sqlite3ExprCodeAtInit(pParse, pExpr, target+i, 0);
3456d1a01edaSdrh     }else{
34577445ffe2Sdrh       int inReg = sqlite3ExprCodeTarget(pParse, pExpr, target+i);
3458746fd9ccSdrh       if( inReg!=target+i ){
34594eded604Sdrh         VdbeOp *pOp;
34604eded604Sdrh         Vdbe *v = pParse->pVdbe;
34614eded604Sdrh         if( copyOp==OP_Copy
34624eded604Sdrh          && (pOp=sqlite3VdbeGetOp(v, -1))->opcode==OP_Copy
34634eded604Sdrh          && pOp->p1+pOp->p3+1==inReg
34644eded604Sdrh          && pOp->p2+pOp->p3+1==target+i
34654eded604Sdrh         ){
34664eded604Sdrh           pOp->p3++;
34674eded604Sdrh         }else{
34684eded604Sdrh           sqlite3VdbeAddOp2(v, copyOp, inReg, target+i);
34694eded604Sdrh         }
3470d1a01edaSdrh       }
3471d176611bSdrh     }
3472268380caSdrh   }
3473f9b596ebSdrh   return n;
3474268380caSdrh }
3475268380caSdrh 
3476268380caSdrh /*
347736c563a2Sdrh ** Generate code for a BETWEEN operator.
347836c563a2Sdrh **
347936c563a2Sdrh **    x BETWEEN y AND z
348036c563a2Sdrh **
348136c563a2Sdrh ** The above is equivalent to
348236c563a2Sdrh **
348336c563a2Sdrh **    x>=y AND x<=z
348436c563a2Sdrh **
348536c563a2Sdrh ** Code it as such, taking care to do the common subexpression
348636c563a2Sdrh ** elementation of x.
348736c563a2Sdrh */
348836c563a2Sdrh static void exprCodeBetween(
348936c563a2Sdrh   Parse *pParse,    /* Parsing and code generating context */
349036c563a2Sdrh   Expr *pExpr,      /* The BETWEEN expression */
349136c563a2Sdrh   int dest,         /* Jump here if the jump is taken */
349236c563a2Sdrh   int jumpIfTrue,   /* Take the jump if the BETWEEN is true */
349336c563a2Sdrh   int jumpIfNull    /* Take the jump if the BETWEEN is NULL */
349436c563a2Sdrh ){
349536c563a2Sdrh   Expr exprAnd;     /* The AND operator in  x>=y AND x<=z  */
349636c563a2Sdrh   Expr compLeft;    /* The  x>=y  term */
349736c563a2Sdrh   Expr compRight;   /* The  x<=z  term */
349836c563a2Sdrh   Expr exprX;       /* The  x  subexpression */
349936c563a2Sdrh   int regFree1 = 0; /* Temporary use register */
350036c563a2Sdrh 
350136c563a2Sdrh   assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
350236c563a2Sdrh   exprX = *pExpr->pLeft;
350336c563a2Sdrh   exprAnd.op = TK_AND;
350436c563a2Sdrh   exprAnd.pLeft = &compLeft;
350536c563a2Sdrh   exprAnd.pRight = &compRight;
350636c563a2Sdrh   compLeft.op = TK_GE;
350736c563a2Sdrh   compLeft.pLeft = &exprX;
350836c563a2Sdrh   compLeft.pRight = pExpr->x.pList->a[0].pExpr;
350936c563a2Sdrh   compRight.op = TK_LE;
351036c563a2Sdrh   compRight.pLeft = &exprX;
351136c563a2Sdrh   compRight.pRight = pExpr->x.pList->a[1].pExpr;
3512a4c3c87eSdrh   exprToRegister(&exprX, sqlite3ExprCodeTemp(pParse, &exprX, &regFree1));
351336c563a2Sdrh   if( jumpIfTrue ){
351436c563a2Sdrh     sqlite3ExprIfTrue(pParse, &exprAnd, dest, jumpIfNull);
351536c563a2Sdrh   }else{
351636c563a2Sdrh     sqlite3ExprIfFalse(pParse, &exprAnd, dest, jumpIfNull);
351736c563a2Sdrh   }
351836c563a2Sdrh   sqlite3ReleaseTempReg(pParse, regFree1);
351936c563a2Sdrh 
352036c563a2Sdrh   /* Ensure adequate test coverage */
352136c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1==0 );
352236c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull==0 && regFree1!=0 );
352336c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1==0 );
352436c563a2Sdrh   testcase( jumpIfTrue==0 && jumpIfNull!=0 && regFree1!=0 );
352536c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1==0 );
352636c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull==0 && regFree1!=0 );
352736c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1==0 );
352836c563a2Sdrh   testcase( jumpIfTrue!=0 && jumpIfNull!=0 && regFree1!=0 );
352936c563a2Sdrh }
353036c563a2Sdrh 
353136c563a2Sdrh /*
3532cce7d176Sdrh ** Generate code for a boolean expression such that a jump is made
3533cce7d176Sdrh ** to the label "dest" if the expression is true but execution
3534cce7d176Sdrh ** continues straight thru if the expression is false.
3535f5905aa7Sdrh **
3536f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false), then
353735573356Sdrh ** take the jump if the jumpIfNull flag is SQLITE_JUMPIFNULL.
3538f2bc013cSdrh **
3539f2bc013cSdrh ** This code depends on the fact that certain token values (ex: TK_EQ)
3540f2bc013cSdrh ** are the same as opcode values (ex: OP_Eq) that implement the corresponding
3541f2bc013cSdrh ** operation.  Special comments in vdbe.c and the mkopcodeh.awk script in
3542f2bc013cSdrh ** the make process cause these values to align.  Assert()s in the code
3543f2bc013cSdrh ** below verify that the numbers are aligned correctly.
3544cce7d176Sdrh */
35454adee20fSdanielk1977 void sqlite3ExprIfTrue(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3546cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3547cce7d176Sdrh   int op = 0;
35482dcef11bSdrh   int regFree1 = 0;
35492dcef11bSdrh   int regFree2 = 0;
35502dcef11bSdrh   int r1, r2;
35512dcef11bSdrh 
355235573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
355348864df9Smistachkin   if( NEVER(v==0) )     return;  /* Existence of VDBE checked by caller */
355433cd4909Sdrh   if( NEVER(pExpr==0) ) return;  /* No way this can happen */
3555f2bc013cSdrh   op = pExpr->op;
3556f2bc013cSdrh   switch( op ){
3557cce7d176Sdrh     case TK_AND: {
35584adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3559c5499befSdrh       testcase( jumpIfNull==0 );
356035573356Sdrh       sqlite3ExprIfFalse(pParse, pExpr->pLeft, d2,jumpIfNull^SQLITE_JUMPIFNULL);
356154e2adb5Sdrh       sqlite3ExprCachePush(pParse);
35624adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
35634adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3564ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3565cce7d176Sdrh       break;
3566cce7d176Sdrh     }
3567cce7d176Sdrh     case TK_OR: {
3568c5499befSdrh       testcase( jumpIfNull==0 );
35694adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
357054e2adb5Sdrh       sqlite3ExprCachePush(pParse);
35714adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pRight, dest, jumpIfNull);
357254e2adb5Sdrh       sqlite3ExprCachePop(pParse, 1);
3573cce7d176Sdrh       break;
3574cce7d176Sdrh     }
3575cce7d176Sdrh     case TK_NOT: {
3576c5499befSdrh       testcase( jumpIfNull==0 );
35774adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
3578cce7d176Sdrh       break;
3579cce7d176Sdrh     }
3580cce7d176Sdrh     case TK_LT:
3581cce7d176Sdrh     case TK_LE:
3582cce7d176Sdrh     case TK_GT:
3583cce7d176Sdrh     case TK_GE:
3584cce7d176Sdrh     case TK_NE:
35850ac65892Sdrh     case TK_EQ: {
3586f2bc013cSdrh       assert( TK_LT==OP_Lt );
3587f2bc013cSdrh       assert( TK_LE==OP_Le );
3588f2bc013cSdrh       assert( TK_GT==OP_Gt );
3589f2bc013cSdrh       assert( TK_GE==OP_Ge );
3590f2bc013cSdrh       assert( TK_EQ==OP_Eq );
3591f2bc013cSdrh       assert( TK_NE==OP_Ne );
3592c5499befSdrh       testcase( op==TK_LT );
3593c5499befSdrh       testcase( op==TK_LE );
3594c5499befSdrh       testcase( op==TK_GT );
3595c5499befSdrh       testcase( op==TK_GE );
3596c5499befSdrh       testcase( op==TK_EQ );
3597c5499befSdrh       testcase( op==TK_NE );
3598c5499befSdrh       testcase( jumpIfNull==0 );
3599b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3600b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
360135573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36022dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3603c5499befSdrh       testcase( regFree1==0 );
3604c5499befSdrh       testcase( regFree2==0 );
3605cce7d176Sdrh       break;
3606cce7d176Sdrh     }
36076a2fe093Sdrh     case TK_IS:
36086a2fe093Sdrh     case TK_ISNOT: {
36096a2fe093Sdrh       testcase( op==TK_IS );
36106a2fe093Sdrh       testcase( op==TK_ISNOT );
3611b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3612b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
36136a2fe093Sdrh       op = (op==TK_IS) ? TK_EQ : TK_NE;
36146a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
36156a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
36166a2fe093Sdrh       testcase( regFree1==0 );
36176a2fe093Sdrh       testcase( regFree2==0 );
36186a2fe093Sdrh       break;
36196a2fe093Sdrh     }
3620cce7d176Sdrh     case TK_ISNULL:
3621cce7d176Sdrh     case TK_NOTNULL: {
3622f2bc013cSdrh       assert( TK_ISNULL==OP_IsNull );
3623f2bc013cSdrh       assert( TK_NOTNULL==OP_NotNull );
3624c5499befSdrh       testcase( op==TK_ISNULL );
3625c5499befSdrh       testcase( op==TK_NOTNULL );
36262dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
36272dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3628c5499befSdrh       testcase( regFree1==0 );
3629cce7d176Sdrh       break;
3630cce7d176Sdrh     }
3631fef5208cSdrh     case TK_BETWEEN: {
36325c03f30aSdrh       testcase( jumpIfNull==0 );
363336c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 1, jumpIfNull);
3634fef5208cSdrh       break;
3635fef5208cSdrh     }
3636bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3637e3365e6cSdrh     case TK_IN: {
3638e3365e6cSdrh       int destIfFalse = sqlite3VdbeMakeLabel(v);
3639e3365e6cSdrh       int destIfNull = jumpIfNull ? dest : destIfFalse;
3640e3365e6cSdrh       sqlite3ExprCodeIN(pParse, pExpr, destIfFalse, destIfNull);
3641e3365e6cSdrh       sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3642e3365e6cSdrh       sqlite3VdbeResolveLabel(v, destIfFalse);
3643e3365e6cSdrh       break;
3644e3365e6cSdrh     }
3645bb201344Sshaneh #endif
3646cce7d176Sdrh     default: {
3647991a1985Sdrh       if( exprAlwaysTrue(pExpr) ){
3648991a1985Sdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3649991a1985Sdrh       }else if( exprAlwaysFalse(pExpr) ){
3650991a1985Sdrh         /* No-op */
3651991a1985Sdrh       }else{
36522dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
36532dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_If, r1, dest, jumpIfNull!=0);
3654c5499befSdrh         testcase( regFree1==0 );
3655c5499befSdrh         testcase( jumpIfNull==0 );
3656991a1985Sdrh       }
3657cce7d176Sdrh       break;
3658cce7d176Sdrh     }
3659cce7d176Sdrh   }
36602dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
36612dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3662cce7d176Sdrh }
3663cce7d176Sdrh 
3664cce7d176Sdrh /*
366566b89c8fSdrh ** Generate code for a boolean expression such that a jump is made
3666cce7d176Sdrh ** to the label "dest" if the expression is false but execution
3667cce7d176Sdrh ** continues straight thru if the expression is true.
3668f5905aa7Sdrh **
3669f5905aa7Sdrh ** If the expression evaluates to NULL (neither true nor false) then
367035573356Sdrh ** jump if jumpIfNull is SQLITE_JUMPIFNULL or fall through if jumpIfNull
367135573356Sdrh ** is 0.
3672cce7d176Sdrh */
36734adee20fSdanielk1977 void sqlite3ExprIfFalse(Parse *pParse, Expr *pExpr, int dest, int jumpIfNull){
3674cce7d176Sdrh   Vdbe *v = pParse->pVdbe;
3675cce7d176Sdrh   int op = 0;
36762dcef11bSdrh   int regFree1 = 0;
36772dcef11bSdrh   int regFree2 = 0;
36782dcef11bSdrh   int r1, r2;
36792dcef11bSdrh 
368035573356Sdrh   assert( jumpIfNull==SQLITE_JUMPIFNULL || jumpIfNull==0 );
368148864df9Smistachkin   if( NEVER(v==0) ) return; /* Existence of VDBE checked by caller */
368233cd4909Sdrh   if( pExpr==0 )    return;
3683f2bc013cSdrh 
3684f2bc013cSdrh   /* The value of pExpr->op and op are related as follows:
3685f2bc013cSdrh   **
3686f2bc013cSdrh   **       pExpr->op            op
3687f2bc013cSdrh   **       ---------          ----------
3688f2bc013cSdrh   **       TK_ISNULL          OP_NotNull
3689f2bc013cSdrh   **       TK_NOTNULL         OP_IsNull
3690f2bc013cSdrh   **       TK_NE              OP_Eq
3691f2bc013cSdrh   **       TK_EQ              OP_Ne
3692f2bc013cSdrh   **       TK_GT              OP_Le
3693f2bc013cSdrh   **       TK_LE              OP_Gt
3694f2bc013cSdrh   **       TK_GE              OP_Lt
3695f2bc013cSdrh   **       TK_LT              OP_Ge
3696f2bc013cSdrh   **
3697f2bc013cSdrh   ** For other values of pExpr->op, op is undefined and unused.
3698f2bc013cSdrh   ** The value of TK_ and OP_ constants are arranged such that we
3699f2bc013cSdrh   ** can compute the mapping above using the following expression.
3700f2bc013cSdrh   ** Assert()s verify that the computation is correct.
3701f2bc013cSdrh   */
3702f2bc013cSdrh   op = ((pExpr->op+(TK_ISNULL&1))^1)-(TK_ISNULL&1);
3703f2bc013cSdrh 
3704f2bc013cSdrh   /* Verify correct alignment of TK_ and OP_ constants
3705f2bc013cSdrh   */
3706f2bc013cSdrh   assert( pExpr->op!=TK_ISNULL || op==OP_NotNull );
3707f2bc013cSdrh   assert( pExpr->op!=TK_NOTNULL || op==OP_IsNull );
3708f2bc013cSdrh   assert( pExpr->op!=TK_NE || op==OP_Eq );
3709f2bc013cSdrh   assert( pExpr->op!=TK_EQ || op==OP_Ne );
3710f2bc013cSdrh   assert( pExpr->op!=TK_LT || op==OP_Ge );
3711f2bc013cSdrh   assert( pExpr->op!=TK_LE || op==OP_Gt );
3712f2bc013cSdrh   assert( pExpr->op!=TK_GT || op==OP_Le );
3713f2bc013cSdrh   assert( pExpr->op!=TK_GE || op==OP_Lt );
3714f2bc013cSdrh 
3715cce7d176Sdrh   switch( pExpr->op ){
3716cce7d176Sdrh     case TK_AND: {
3717c5499befSdrh       testcase( jumpIfNull==0 );
37184adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pLeft, dest, jumpIfNull);
371954e2adb5Sdrh       sqlite3ExprCachePush(pParse);
37204adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
372154e2adb5Sdrh       sqlite3ExprCachePop(pParse, 1);
3722cce7d176Sdrh       break;
3723cce7d176Sdrh     }
3724cce7d176Sdrh     case TK_OR: {
37254adee20fSdanielk1977       int d2 = sqlite3VdbeMakeLabel(v);
3726c5499befSdrh       testcase( jumpIfNull==0 );
372735573356Sdrh       sqlite3ExprIfTrue(pParse, pExpr->pLeft, d2, jumpIfNull^SQLITE_JUMPIFNULL);
372854e2adb5Sdrh       sqlite3ExprCachePush(pParse);
37294adee20fSdanielk1977       sqlite3ExprIfFalse(pParse, pExpr->pRight, dest, jumpIfNull);
37304adee20fSdanielk1977       sqlite3VdbeResolveLabel(v, d2);
3731ceea3321Sdrh       sqlite3ExprCachePop(pParse, 1);
3732cce7d176Sdrh       break;
3733cce7d176Sdrh     }
3734cce7d176Sdrh     case TK_NOT: {
37355c03f30aSdrh       testcase( jumpIfNull==0 );
37364adee20fSdanielk1977       sqlite3ExprIfTrue(pParse, pExpr->pLeft, dest, jumpIfNull);
3737cce7d176Sdrh       break;
3738cce7d176Sdrh     }
3739cce7d176Sdrh     case TK_LT:
3740cce7d176Sdrh     case TK_LE:
3741cce7d176Sdrh     case TK_GT:
3742cce7d176Sdrh     case TK_GE:
3743cce7d176Sdrh     case TK_NE:
3744cce7d176Sdrh     case TK_EQ: {
3745c5499befSdrh       testcase( op==TK_LT );
3746c5499befSdrh       testcase( op==TK_LE );
3747c5499befSdrh       testcase( op==TK_GT );
3748c5499befSdrh       testcase( op==TK_GE );
3749c5499befSdrh       testcase( op==TK_EQ );
3750c5499befSdrh       testcase( op==TK_NE );
3751c5499befSdrh       testcase( jumpIfNull==0 );
3752b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3753b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
375435573356Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37552dcef11bSdrh                   r1, r2, dest, jumpIfNull);
3756c5499befSdrh       testcase( regFree1==0 );
3757c5499befSdrh       testcase( regFree2==0 );
3758cce7d176Sdrh       break;
3759cce7d176Sdrh     }
37606a2fe093Sdrh     case TK_IS:
37616a2fe093Sdrh     case TK_ISNOT: {
37626d4486aeSdrh       testcase( pExpr->op==TK_IS );
37636d4486aeSdrh       testcase( pExpr->op==TK_ISNOT );
3764b6da74ebSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
3765b6da74ebSdrh       r2 = sqlite3ExprCodeTemp(pParse, pExpr->pRight, &regFree2);
37666a2fe093Sdrh       op = (pExpr->op==TK_IS) ? TK_NE : TK_EQ;
37676a2fe093Sdrh       codeCompare(pParse, pExpr->pLeft, pExpr->pRight, op,
37686a2fe093Sdrh                   r1, r2, dest, SQLITE_NULLEQ);
37696a2fe093Sdrh       testcase( regFree1==0 );
37706a2fe093Sdrh       testcase( regFree2==0 );
37716a2fe093Sdrh       break;
37726a2fe093Sdrh     }
3773cce7d176Sdrh     case TK_ISNULL:
3774cce7d176Sdrh     case TK_NOTNULL: {
3775c5499befSdrh       testcase( op==TK_ISNULL );
3776c5499befSdrh       testcase( op==TK_NOTNULL );
37772dcef11bSdrh       r1 = sqlite3ExprCodeTemp(pParse, pExpr->pLeft, &regFree1);
37782dcef11bSdrh       sqlite3VdbeAddOp2(v, op, r1, dest);
3779c5499befSdrh       testcase( regFree1==0 );
3780cce7d176Sdrh       break;
3781cce7d176Sdrh     }
3782fef5208cSdrh     case TK_BETWEEN: {
37835c03f30aSdrh       testcase( jumpIfNull==0 );
378436c563a2Sdrh       exprCodeBetween(pParse, pExpr, dest, 0, jumpIfNull);
3785fef5208cSdrh       break;
3786fef5208cSdrh     }
3787bb201344Sshaneh #ifndef SQLITE_OMIT_SUBQUERY
3788e3365e6cSdrh     case TK_IN: {
3789e3365e6cSdrh       if( jumpIfNull ){
3790e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, dest);
3791e3365e6cSdrh       }else{
3792e3365e6cSdrh         int destIfNull = sqlite3VdbeMakeLabel(v);
3793e3365e6cSdrh         sqlite3ExprCodeIN(pParse, pExpr, dest, destIfNull);
3794e3365e6cSdrh         sqlite3VdbeResolveLabel(v, destIfNull);
3795e3365e6cSdrh       }
3796e3365e6cSdrh       break;
3797e3365e6cSdrh     }
3798bb201344Sshaneh #endif
3799cce7d176Sdrh     default: {
3800991a1985Sdrh       if( exprAlwaysFalse(pExpr) ){
3801991a1985Sdrh         sqlite3VdbeAddOp2(v, OP_Goto, 0, dest);
3802991a1985Sdrh       }else if( exprAlwaysTrue(pExpr) ){
3803991a1985Sdrh         /* no-op */
3804991a1985Sdrh       }else{
38052dcef11bSdrh         r1 = sqlite3ExprCodeTemp(pParse, pExpr, &regFree1);
38062dcef11bSdrh         sqlite3VdbeAddOp3(v, OP_IfNot, r1, dest, jumpIfNull!=0);
3807c5499befSdrh         testcase( regFree1==0 );
3808c5499befSdrh         testcase( jumpIfNull==0 );
3809991a1985Sdrh       }
3810cce7d176Sdrh       break;
3811cce7d176Sdrh     }
3812cce7d176Sdrh   }
38132dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree1);
38142dcef11bSdrh   sqlite3ReleaseTempReg(pParse, regFree2);
3815cce7d176Sdrh }
38162282792aSdrh 
38172282792aSdrh /*
38181d9da70aSdrh ** Do a deep comparison of two expression trees.  Return 0 if the two
38191d9da70aSdrh ** expressions are completely identical.  Return 1 if they differ only
38201d9da70aSdrh ** by a COLLATE operator at the top level.  Return 2 if there are differences
38211d9da70aSdrh ** other than the top-level COLLATE operator.
3822d40aab0eSdrh **
3823619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3824619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3825619a1305Sdrh **
382666518ca7Sdrh ** The pA side might be using TK_REGISTER.  If that is the case and pB is
382766518ca7Sdrh ** not using TK_REGISTER but is otherwise equivalent, then still return 0.
382866518ca7Sdrh **
38291d9da70aSdrh ** Sometimes this routine will return 2 even if the two expressions
3830d40aab0eSdrh ** really are equivalent.  If we cannot prove that the expressions are
38311d9da70aSdrh ** identical, we return 2 just to be safe.  So if this routine
38321d9da70aSdrh ** returns 2, then you do not really know for certain if the two
38331d9da70aSdrh ** expressions are the same.  But if you get a 0 or 1 return, then you
3834d40aab0eSdrh ** can be sure the expressions are the same.  In the places where
38351d9da70aSdrh ** this routine is used, it does not hurt to get an extra 2 - that
3836d40aab0eSdrh ** just might result in some slightly slower code.  But returning
38371d9da70aSdrh ** an incorrect 0 or 1 could lead to a malfunction.
38382282792aSdrh */
3839619a1305Sdrh int sqlite3ExprCompare(Expr *pA, Expr *pB, int iTab){
384010d1edf0Sdrh   u32 combinedFlags;
38414b202ae2Sdanielk1977   if( pA==0 || pB==0 ){
38421d9da70aSdrh     return pB==pA ? 0 : 2;
38432282792aSdrh   }
384410d1edf0Sdrh   combinedFlags = pA->flags | pB->flags;
384510d1edf0Sdrh   if( combinedFlags & EP_IntValue ){
384610d1edf0Sdrh     if( (pA->flags&pB->flags&EP_IntValue)!=0 && pA->u.iValue==pB->u.iValue ){
384710d1edf0Sdrh       return 0;
384810d1edf0Sdrh     }
38491d9da70aSdrh     return 2;
38506ab3a2ecSdanielk1977   }
3851c2acc4e4Sdrh   if( pA->op!=pB->op ){
3852619a1305Sdrh     if( pA->op==TK_COLLATE && sqlite3ExprCompare(pA->pLeft, pB, iTab)<2 ){
3853ae80ddeaSdrh       return 1;
3854ae80ddeaSdrh     }
3855619a1305Sdrh     if( pB->op==TK_COLLATE && sqlite3ExprCompare(pA, pB->pLeft, iTab)<2 ){
3856ae80ddeaSdrh       return 1;
3857ae80ddeaSdrh     }
3858ae80ddeaSdrh     return 2;
3859ae80ddeaSdrh   }
386010d1edf0Sdrh   if( pA->op!=TK_COLUMN && ALWAYS(pA->op!=TK_AGG_COLUMN) && pA->u.zToken ){
386110d1edf0Sdrh     if( strcmp(pA->u.zToken,pB->u.zToken)!=0 ){
386210d1edf0Sdrh       return pA->op==TK_COLLATE ? 1 : 2;
386310d1edf0Sdrh     }
386410d1edf0Sdrh   }
386510d1edf0Sdrh   if( (pA->flags & EP_Distinct)!=(pB->flags & EP_Distinct) ) return 2;
386685f8aa79Sdrh   if( ALWAYS((combinedFlags & EP_TokenOnly)==0) ){
386710d1edf0Sdrh     if( combinedFlags & EP_xIsSelect ) return 2;
3868619a1305Sdrh     if( sqlite3ExprCompare(pA->pLeft, pB->pLeft, iTab) ) return 2;
3869619a1305Sdrh     if( sqlite3ExprCompare(pA->pRight, pB->pRight, iTab) ) return 2;
3870619a1305Sdrh     if( sqlite3ExprListCompare(pA->x.pList, pB->x.pList, iTab) ) return 2;
387185f8aa79Sdrh     if( ALWAYS((combinedFlags & EP_Reduced)==0) ){
3872619a1305Sdrh       if( pA->iColumn!=pB->iColumn ) return 2;
387366518ca7Sdrh       if( pA->iTable!=pB->iTable
387485f8aa79Sdrh        && (pA->iTable!=iTab || NEVER(pB->iTable>=0)) ) return 2;
38751d9da70aSdrh     }
38761d9da70aSdrh   }
38772646da7eSdrh   return 0;
38782646da7eSdrh }
38792282792aSdrh 
38808c6f666bSdrh /*
38818c6f666bSdrh ** Compare two ExprList objects.  Return 0 if they are identical and
38828c6f666bSdrh ** non-zero if they differ in any way.
38838c6f666bSdrh **
3884619a1305Sdrh ** If any subelement of pB has Expr.iTable==(-1) then it is allowed
3885619a1305Sdrh ** to compare equal to an equivalent element in pA with Expr.iTable==iTab.
3886619a1305Sdrh **
38878c6f666bSdrh ** This routine might return non-zero for equivalent ExprLists.  The
38888c6f666bSdrh ** only consequence will be disabled optimizations.  But this routine
38898c6f666bSdrh ** must never return 0 if the two ExprList objects are different, or
38908c6f666bSdrh ** a malfunction will result.
38918c6f666bSdrh **
38928c6f666bSdrh ** Two NULL pointers are considered to be the same.  But a NULL pointer
38938c6f666bSdrh ** always differs from a non-NULL pointer.
38948c6f666bSdrh */
3895619a1305Sdrh int sqlite3ExprListCompare(ExprList *pA, ExprList *pB, int iTab){
38968c6f666bSdrh   int i;
38978c6f666bSdrh   if( pA==0 && pB==0 ) return 0;
38988c6f666bSdrh   if( pA==0 || pB==0 ) return 1;
38998c6f666bSdrh   if( pA->nExpr!=pB->nExpr ) return 1;
39008c6f666bSdrh   for(i=0; i<pA->nExpr; i++){
39018c6f666bSdrh     Expr *pExprA = pA->a[i].pExpr;
39028c6f666bSdrh     Expr *pExprB = pB->a[i].pExpr;
39038c6f666bSdrh     if( pA->a[i].sortOrder!=pB->a[i].sortOrder ) return 1;
3904619a1305Sdrh     if( sqlite3ExprCompare(pExprA, pExprB, iTab) ) return 1;
39058c6f666bSdrh   }
39068c6f666bSdrh   return 0;
39078c6f666bSdrh }
390813449892Sdrh 
39092282792aSdrh /*
39104bd5f73fSdrh ** Return true if we can prove the pE2 will always be true if pE1 is
39114bd5f73fSdrh ** true.  Return false if we cannot complete the proof or if pE2 might
39124bd5f73fSdrh ** be false.  Examples:
39134bd5f73fSdrh **
3914619a1305Sdrh **     pE1: x==5       pE2: x==5             Result: true
39154bd5f73fSdrh **     pE1: x>0        pE2: x==5             Result: false
3916619a1305Sdrh **     pE1: x=21       pE2: x=21 OR y=43     Result: true
39174bd5f73fSdrh **     pE1: x!=123     pE2: x IS NOT NULL    Result: true
3918619a1305Sdrh **     pE1: x!=?1      pE2: x IS NOT NULL    Result: true
3919619a1305Sdrh **     pE1: x IS NULL  pE2: x IS NOT NULL    Result: false
3920619a1305Sdrh **     pE1: x IS ?2    pE2: x IS NOT NULL    Reuslt: false
39214bd5f73fSdrh **
39224bd5f73fSdrh ** When comparing TK_COLUMN nodes between pE1 and pE2, if pE2 has
39234bd5f73fSdrh ** Expr.iTable<0 then assume a table number given by iTab.
39244bd5f73fSdrh **
39254bd5f73fSdrh ** When in doubt, return false.  Returning true might give a performance
39264bd5f73fSdrh ** improvement.  Returning false might cause a performance reduction, but
39274bd5f73fSdrh ** it will always give the correct answer and is hence always safe.
39284bd5f73fSdrh */
39294bd5f73fSdrh int sqlite3ExprImpliesExpr(Expr *pE1, Expr *pE2, int iTab){
3930619a1305Sdrh   if( sqlite3ExprCompare(pE1, pE2, iTab)==0 ){
3931619a1305Sdrh     return 1;
3932619a1305Sdrh   }
3933619a1305Sdrh   if( pE2->op==TK_OR
3934619a1305Sdrh    && (sqlite3ExprImpliesExpr(pE1, pE2->pLeft, iTab)
3935619a1305Sdrh              || sqlite3ExprImpliesExpr(pE1, pE2->pRight, iTab) )
3936619a1305Sdrh   ){
3937619a1305Sdrh     return 1;
3938619a1305Sdrh   }
3939619a1305Sdrh   if( pE2->op==TK_NOTNULL
3940619a1305Sdrh    && sqlite3ExprCompare(pE1->pLeft, pE2->pLeft, iTab)==0
3941619a1305Sdrh    && (pE1->op!=TK_ISNULL && pE1->op!=TK_IS)
3942619a1305Sdrh   ){
3943619a1305Sdrh     return 1;
3944619a1305Sdrh   }
3945619a1305Sdrh   return 0;
39464bd5f73fSdrh }
39474bd5f73fSdrh 
39484bd5f73fSdrh /*
3949030796dfSdrh ** An instance of the following structure is used by the tree walker
3950030796dfSdrh ** to count references to table columns in the arguments of an
3951ed551b95Sdrh ** aggregate function, in order to implement the
3952ed551b95Sdrh ** sqlite3FunctionThisSrc() routine.
3953374fdce4Sdrh */
3954030796dfSdrh struct SrcCount {
3955030796dfSdrh   SrcList *pSrc;   /* One particular FROM clause in a nested query */
3956030796dfSdrh   int nThis;       /* Number of references to columns in pSrcList */
3957030796dfSdrh   int nOther;      /* Number of references to columns in other FROM clauses */
3958030796dfSdrh };
3959030796dfSdrh 
3960030796dfSdrh /*
3961030796dfSdrh ** Count the number of references to columns.
3962030796dfSdrh */
3963030796dfSdrh static int exprSrcCount(Walker *pWalker, Expr *pExpr){
3964fb0a6081Sdrh   /* The NEVER() on the second term is because sqlite3FunctionUsesThisSrc()
3965fb0a6081Sdrh   ** is always called before sqlite3ExprAnalyzeAggregates() and so the
3966fb0a6081Sdrh   ** TK_COLUMNs have not yet been converted into TK_AGG_COLUMN.  If
3967fb0a6081Sdrh   ** sqlite3FunctionUsesThisSrc() is used differently in the future, the
3968fb0a6081Sdrh   ** NEVER() will need to be removed. */
3969fb0a6081Sdrh   if( pExpr->op==TK_COLUMN || NEVER(pExpr->op==TK_AGG_COLUMN) ){
3970374fdce4Sdrh     int i;
3971030796dfSdrh     struct SrcCount *p = pWalker->u.pSrcCount;
3972030796dfSdrh     SrcList *pSrc = p->pSrc;
3973374fdce4Sdrh     for(i=0; i<pSrc->nSrc; i++){
3974030796dfSdrh       if( pExpr->iTable==pSrc->a[i].iCursor ) break;
3975374fdce4Sdrh     }
3976030796dfSdrh     if( i<pSrc->nSrc ){
3977030796dfSdrh       p->nThis++;
3978374fdce4Sdrh     }else{
3979030796dfSdrh       p->nOther++;
3980374fdce4Sdrh     }
3981374fdce4Sdrh   }
3982030796dfSdrh   return WRC_Continue;
3983030796dfSdrh }
3984374fdce4Sdrh 
3985374fdce4Sdrh /*
3986030796dfSdrh ** Determine if any of the arguments to the pExpr Function reference
3987030796dfSdrh ** pSrcList.  Return true if they do.  Also return true if the function
3988030796dfSdrh ** has no arguments or has only constant arguments.  Return false if pExpr
3989030796dfSdrh ** references columns but not columns of tables found in pSrcList.
3990374fdce4Sdrh */
3991030796dfSdrh int sqlite3FunctionUsesThisSrc(Expr *pExpr, SrcList *pSrcList){
3992374fdce4Sdrh   Walker w;
3993030796dfSdrh   struct SrcCount cnt;
3994374fdce4Sdrh   assert( pExpr->op==TK_AGG_FUNCTION );
3995374fdce4Sdrh   memset(&w, 0, sizeof(w));
3996030796dfSdrh   w.xExprCallback = exprSrcCount;
3997030796dfSdrh   w.u.pSrcCount = &cnt;
3998030796dfSdrh   cnt.pSrc = pSrcList;
3999030796dfSdrh   cnt.nThis = 0;
4000030796dfSdrh   cnt.nOther = 0;
4001030796dfSdrh   sqlite3WalkExprList(&w, pExpr->x.pList);
4002030796dfSdrh   return cnt.nThis>0 || cnt.nOther==0;
4003374fdce4Sdrh }
4004374fdce4Sdrh 
4005374fdce4Sdrh /*
400613449892Sdrh ** Add a new element to the pAggInfo->aCol[] array.  Return the index of
400713449892Sdrh ** the new element.  Return a negative number if malloc fails.
40082282792aSdrh */
400917435752Sdrh static int addAggInfoColumn(sqlite3 *db, AggInfo *pInfo){
401013449892Sdrh   int i;
4011cf643729Sdrh   pInfo->aCol = sqlite3ArrayAllocate(
401217435752Sdrh        db,
4013cf643729Sdrh        pInfo->aCol,
4014cf643729Sdrh        sizeof(pInfo->aCol[0]),
4015cf643729Sdrh        &pInfo->nColumn,
4016cf643729Sdrh        &i
4017cf643729Sdrh   );
401813449892Sdrh   return i;
40192282792aSdrh }
402013449892Sdrh 
402113449892Sdrh /*
402213449892Sdrh ** Add a new element to the pAggInfo->aFunc[] array.  Return the index of
402313449892Sdrh ** the new element.  Return a negative number if malloc fails.
402413449892Sdrh */
402517435752Sdrh static int addAggInfoFunc(sqlite3 *db, AggInfo *pInfo){
402613449892Sdrh   int i;
4027cf643729Sdrh   pInfo->aFunc = sqlite3ArrayAllocate(
402817435752Sdrh        db,
4029cf643729Sdrh        pInfo->aFunc,
4030cf643729Sdrh        sizeof(pInfo->aFunc[0]),
4031cf643729Sdrh        &pInfo->nFunc,
4032cf643729Sdrh        &i
4033cf643729Sdrh   );
403413449892Sdrh   return i;
40352282792aSdrh }
40362282792aSdrh 
40372282792aSdrh /*
40387d10d5a6Sdrh ** This is the xExprCallback for a tree walker.  It is used to
40397d10d5a6Sdrh ** implement sqlite3ExprAnalyzeAggregates().  See sqlite3ExprAnalyzeAggregates
4040626a879aSdrh ** for additional information.
40412282792aSdrh */
40427d10d5a6Sdrh static int analyzeAggregate(Walker *pWalker, Expr *pExpr){
40432282792aSdrh   int i;
40447d10d5a6Sdrh   NameContext *pNC = pWalker->u.pNC;
4045a58fdfb1Sdanielk1977   Parse *pParse = pNC->pParse;
4046a58fdfb1Sdanielk1977   SrcList *pSrcList = pNC->pSrcList;
404713449892Sdrh   AggInfo *pAggInfo = pNC->pAggInfo;
404813449892Sdrh 
40492282792aSdrh   switch( pExpr->op ){
405089c69d00Sdrh     case TK_AGG_COLUMN:
4051967e8b73Sdrh     case TK_COLUMN: {
40528b213899Sdrh       testcase( pExpr->op==TK_AGG_COLUMN );
40538b213899Sdrh       testcase( pExpr->op==TK_COLUMN );
405413449892Sdrh       /* Check to see if the column is in one of the tables in the FROM
405513449892Sdrh       ** clause of the aggregate query */
405620bc393cSdrh       if( ALWAYS(pSrcList!=0) ){
405713449892Sdrh         struct SrcList_item *pItem = pSrcList->a;
405813449892Sdrh         for(i=0; i<pSrcList->nSrc; i++, pItem++){
405913449892Sdrh           struct AggInfo_col *pCol;
4060c5cd1249Sdrh           assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
406113449892Sdrh           if( pExpr->iTable==pItem->iCursor ){
406213449892Sdrh             /* If we reach this point, it means that pExpr refers to a table
406313449892Sdrh             ** that is in the FROM clause of the aggregate query.
406413449892Sdrh             **
406513449892Sdrh             ** Make an entry for the column in pAggInfo->aCol[] if there
406613449892Sdrh             ** is not an entry there already.
406713449892Sdrh             */
40687f906d63Sdrh             int k;
406913449892Sdrh             pCol = pAggInfo->aCol;
40707f906d63Sdrh             for(k=0; k<pAggInfo->nColumn; k++, pCol++){
407113449892Sdrh               if( pCol->iTable==pExpr->iTable &&
407213449892Sdrh                   pCol->iColumn==pExpr->iColumn ){
40732282792aSdrh                 break;
40742282792aSdrh               }
40752282792aSdrh             }
40761e536953Sdanielk1977             if( (k>=pAggInfo->nColumn)
40771e536953Sdanielk1977              && (k = addAggInfoColumn(pParse->db, pAggInfo))>=0
40781e536953Sdanielk1977             ){
40797f906d63Sdrh               pCol = &pAggInfo->aCol[k];
40800817d0dfSdanielk1977               pCol->pTab = pExpr->pTab;
408113449892Sdrh               pCol->iTable = pExpr->iTable;
408213449892Sdrh               pCol->iColumn = pExpr->iColumn;
40830a07c107Sdrh               pCol->iMem = ++pParse->nMem;
408413449892Sdrh               pCol->iSorterColumn = -1;
40855774b806Sdrh               pCol->pExpr = pExpr;
408613449892Sdrh               if( pAggInfo->pGroupBy ){
408713449892Sdrh                 int j, n;
408813449892Sdrh                 ExprList *pGB = pAggInfo->pGroupBy;
408913449892Sdrh                 struct ExprList_item *pTerm = pGB->a;
409013449892Sdrh                 n = pGB->nExpr;
409113449892Sdrh                 for(j=0; j<n; j++, pTerm++){
409213449892Sdrh                   Expr *pE = pTerm->pExpr;
409313449892Sdrh                   if( pE->op==TK_COLUMN && pE->iTable==pExpr->iTable &&
409413449892Sdrh                       pE->iColumn==pExpr->iColumn ){
409513449892Sdrh                     pCol->iSorterColumn = j;
409613449892Sdrh                     break;
40972282792aSdrh                   }
409813449892Sdrh                 }
409913449892Sdrh               }
410013449892Sdrh               if( pCol->iSorterColumn<0 ){
410113449892Sdrh                 pCol->iSorterColumn = pAggInfo->nSortingColumn++;
410213449892Sdrh               }
410313449892Sdrh             }
410413449892Sdrh             /* There is now an entry for pExpr in pAggInfo->aCol[] (either
410513449892Sdrh             ** because it was there before or because we just created it).
410613449892Sdrh             ** Convert the pExpr to be a TK_AGG_COLUMN referring to that
410713449892Sdrh             ** pAggInfo->aCol[] entry.
410813449892Sdrh             */
4109ebb6a65dSdrh             ExprSetVVAProperty(pExpr, EP_NoReduce);
411013449892Sdrh             pExpr->pAggInfo = pAggInfo;
411113449892Sdrh             pExpr->op = TK_AGG_COLUMN;
4112cf697396Sshane             pExpr->iAgg = (i16)k;
411313449892Sdrh             break;
411413449892Sdrh           } /* endif pExpr->iTable==pItem->iCursor */
411513449892Sdrh         } /* end loop over pSrcList */
4116a58fdfb1Sdanielk1977       }
41177d10d5a6Sdrh       return WRC_Prune;
41182282792aSdrh     }
41192282792aSdrh     case TK_AGG_FUNCTION: {
41203a8c4be7Sdrh       if( (pNC->ncFlags & NC_InAggFunc)==0
4121ed551b95Sdrh        && pWalker->walkerDepth==pExpr->op2
41223a8c4be7Sdrh       ){
412313449892Sdrh         /* Check to see if pExpr is a duplicate of another aggregate
412413449892Sdrh         ** function that is already in the pAggInfo structure
412513449892Sdrh         */
412613449892Sdrh         struct AggInfo_func *pItem = pAggInfo->aFunc;
412713449892Sdrh         for(i=0; i<pAggInfo->nFunc; i++, pItem++){
4128619a1305Sdrh           if( sqlite3ExprCompare(pItem->pExpr, pExpr, -1)==0 ){
41292282792aSdrh             break;
41302282792aSdrh           }
41312282792aSdrh         }
413213449892Sdrh         if( i>=pAggInfo->nFunc ){
413313449892Sdrh           /* pExpr is original.  Make a new entry in pAggInfo->aFunc[]
413413449892Sdrh           */
413514db2665Sdanielk1977           u8 enc = ENC(pParse->db);
41361e536953Sdanielk1977           i = addAggInfoFunc(pParse->db, pAggInfo);
413713449892Sdrh           if( i>=0 ){
41386ab3a2ecSdanielk1977             assert( !ExprHasProperty(pExpr, EP_xIsSelect) );
413913449892Sdrh             pItem = &pAggInfo->aFunc[i];
414013449892Sdrh             pItem->pExpr = pExpr;
41410a07c107Sdrh             pItem->iMem = ++pParse->nMem;
414233e619fcSdrh             assert( !ExprHasProperty(pExpr, EP_IntValue) );
414313449892Sdrh             pItem->pFunc = sqlite3FindFunction(pParse->db,
414433e619fcSdrh                    pExpr->u.zToken, sqlite3Strlen30(pExpr->u.zToken),
41456ab3a2ecSdanielk1977                    pExpr->x.pList ? pExpr->x.pList->nExpr : 0, enc, 0);
4146fd357974Sdrh             if( pExpr->flags & EP_Distinct ){
4147fd357974Sdrh               pItem->iDistinct = pParse->nTab++;
4148fd357974Sdrh             }else{
4149fd357974Sdrh               pItem->iDistinct = -1;
4150fd357974Sdrh             }
41512282792aSdrh           }
415213449892Sdrh         }
415313449892Sdrh         /* Make pExpr point to the appropriate pAggInfo->aFunc[] entry
415413449892Sdrh         */
4155c5cd1249Sdrh         assert( !ExprHasProperty(pExpr, EP_TokenOnly|EP_Reduced) );
4156ebb6a65dSdrh         ExprSetVVAProperty(pExpr, EP_NoReduce);
4157cf697396Sshane         pExpr->iAgg = (i16)i;
415813449892Sdrh         pExpr->pAggInfo = pAggInfo;
41593a8c4be7Sdrh         return WRC_Prune;
41606e83a57fSdrh       }else{
41616e83a57fSdrh         return WRC_Continue;
41626e83a57fSdrh       }
41632282792aSdrh     }
4164a58fdfb1Sdanielk1977   }
41657d10d5a6Sdrh   return WRC_Continue;
41667d10d5a6Sdrh }
41677d10d5a6Sdrh static int analyzeAggregatesInSelect(Walker *pWalker, Select *pSelect){
4168d5a336efSdrh   UNUSED_PARAMETER(pWalker);
4169d5a336efSdrh   UNUSED_PARAMETER(pSelect);
41707d10d5a6Sdrh   return WRC_Continue;
4171a58fdfb1Sdanielk1977 }
4172626a879aSdrh 
4173626a879aSdrh /*
4174e8abb4caSdrh ** Analyze the pExpr expression looking for aggregate functions and
4175e8abb4caSdrh ** for variables that need to be added to AggInfo object that pNC->pAggInfo
4176e8abb4caSdrh ** points to.  Additional entries are made on the AggInfo object as
4177e8abb4caSdrh ** necessary.
4178626a879aSdrh **
4179626a879aSdrh ** This routine should only be called after the expression has been
41807d10d5a6Sdrh ** analyzed by sqlite3ResolveExprNames().
4181626a879aSdrh */
4182d2b3e23bSdrh void sqlite3ExprAnalyzeAggregates(NameContext *pNC, Expr *pExpr){
41837d10d5a6Sdrh   Walker w;
4184374fdce4Sdrh   memset(&w, 0, sizeof(w));
41857d10d5a6Sdrh   w.xExprCallback = analyzeAggregate;
41867d10d5a6Sdrh   w.xSelectCallback = analyzeAggregatesInSelect;
41877d10d5a6Sdrh   w.u.pNC = pNC;
418820bc393cSdrh   assert( pNC->pSrcList!=0 );
41897d10d5a6Sdrh   sqlite3WalkExpr(&w, pExpr);
41902282792aSdrh }
41915d9a4af9Sdrh 
41925d9a4af9Sdrh /*
41935d9a4af9Sdrh ** Call sqlite3ExprAnalyzeAggregates() for every expression in an
41945d9a4af9Sdrh ** expression list.  Return the number of errors.
41955d9a4af9Sdrh **
41965d9a4af9Sdrh ** If an error is found, the analysis is cut short.
41975d9a4af9Sdrh */
4198d2b3e23bSdrh void sqlite3ExprAnalyzeAggList(NameContext *pNC, ExprList *pList){
41995d9a4af9Sdrh   struct ExprList_item *pItem;
42005d9a4af9Sdrh   int i;
42015d9a4af9Sdrh   if( pList ){
4202d2b3e23bSdrh     for(pItem=pList->a, i=0; i<pList->nExpr; i++, pItem++){
4203d2b3e23bSdrh       sqlite3ExprAnalyzeAggregates(pNC, pItem->pExpr);
42045d9a4af9Sdrh     }
42055d9a4af9Sdrh   }
42065d9a4af9Sdrh }
4207892d3179Sdrh 
4208892d3179Sdrh /*
4209ceea3321Sdrh ** Allocate a single new register for use to hold some intermediate result.
4210892d3179Sdrh */
4211892d3179Sdrh int sqlite3GetTempReg(Parse *pParse){
4212e55cbd72Sdrh   if( pParse->nTempReg==0 ){
4213892d3179Sdrh     return ++pParse->nMem;
4214892d3179Sdrh   }
42152f425f6bSdanielk1977   return pParse->aTempReg[--pParse->nTempReg];
4216892d3179Sdrh }
4217ceea3321Sdrh 
4218ceea3321Sdrh /*
4219ceea3321Sdrh ** Deallocate a register, making available for reuse for some other
4220ceea3321Sdrh ** purpose.
4221ceea3321Sdrh **
4222ceea3321Sdrh ** If a register is currently being used by the column cache, then
4223ceea3321Sdrh ** the dallocation is deferred until the column cache line that uses
4224ceea3321Sdrh ** the register becomes stale.
4225ceea3321Sdrh */
4226892d3179Sdrh void sqlite3ReleaseTempReg(Parse *pParse, int iReg){
42272dcef11bSdrh   if( iReg && pParse->nTempReg<ArraySize(pParse->aTempReg) ){
4228ceea3321Sdrh     int i;
4229ceea3321Sdrh     struct yColCache *p;
4230ceea3321Sdrh     for(i=0, p=pParse->aColCache; i<SQLITE_N_COLCACHE; i++, p++){
4231ceea3321Sdrh       if( p->iReg==iReg ){
4232ceea3321Sdrh         p->tempReg = 1;
4233ceea3321Sdrh         return;
4234ceea3321Sdrh       }
4235ceea3321Sdrh     }
4236892d3179Sdrh     pParse->aTempReg[pParse->nTempReg++] = iReg;
4237892d3179Sdrh   }
4238892d3179Sdrh }
4239892d3179Sdrh 
4240892d3179Sdrh /*
4241892d3179Sdrh ** Allocate or deallocate a block of nReg consecutive registers
4242892d3179Sdrh */
4243892d3179Sdrh int sqlite3GetTempRange(Parse *pParse, int nReg){
4244e55cbd72Sdrh   int i, n;
4245892d3179Sdrh   i = pParse->iRangeReg;
4246e55cbd72Sdrh   n = pParse->nRangeReg;
4247f49f3523Sdrh   if( nReg<=n ){
4248f49f3523Sdrh     assert( !usedAsColumnCache(pParse, i, i+n-1) );
4249892d3179Sdrh     pParse->iRangeReg += nReg;
4250892d3179Sdrh     pParse->nRangeReg -= nReg;
4251892d3179Sdrh   }else{
4252892d3179Sdrh     i = pParse->nMem+1;
4253892d3179Sdrh     pParse->nMem += nReg;
4254892d3179Sdrh   }
4255892d3179Sdrh   return i;
4256892d3179Sdrh }
4257892d3179Sdrh void sqlite3ReleaseTempRange(Parse *pParse, int iReg, int nReg){
4258f49f3523Sdrh   sqlite3ExprCacheRemove(pParse, iReg, nReg);
4259892d3179Sdrh   if( nReg>pParse->nRangeReg ){
4260892d3179Sdrh     pParse->nRangeReg = nReg;
4261892d3179Sdrh     pParse->iRangeReg = iReg;
4262892d3179Sdrh   }
4263892d3179Sdrh }
4264cdc69557Sdrh 
4265cdc69557Sdrh /*
4266cdc69557Sdrh ** Mark all temporary registers as being unavailable for reuse.
4267cdc69557Sdrh */
4268cdc69557Sdrh void sqlite3ClearTempRegCache(Parse *pParse){
4269cdc69557Sdrh   pParse->nTempReg = 0;
4270cdc69557Sdrh   pParse->nRangeReg = 0;
4271cdc69557Sdrh }
4272