blob: 8f7f66a78b0f7ed14d0371416a624452ffed9d55 [file] [log] [blame]
drhdc04c582002-02-24 01:55:15 +00001/*
2** 2002 February 23
3**
4** The author disclaims copyright to this source code. In place of
5** a legal notice, here is a blessing:
6**
7** May you do good and not evil.
8** May you find forgiveness for yourself and forgive others.
9** May you share freely, never taking more than you give.
10**
11*************************************************************************
12** This file contains the C functions that implement various SQL
13** functions of SQLite.
14**
15** There is only one exported symbol in this file - the function
16** sqliteRegisterBuildinFunctions() found at the bottom of the file.
17** All other code has file scope.
18**
drh07d31172009-02-02 21:57:05 +000019** $Id: func.c,v 1.218 2009/02/02 21:57:05 drh Exp $
drhdc04c582002-02-24 01:55:15 +000020*/
drhb659e9b2005-01-28 01:29:08 +000021#include "sqliteInt.h"
drhd3a149e2002-02-24 17:12:53 +000022#include <stdlib.h>
drh0bce8352002-02-28 00:41:10 +000023#include <assert.h>
danielk197788208052004-05-25 01:13:20 +000024#include "vdbeInt.h"
drh0bce8352002-02-28 00:41:10 +000025
drh55ef4d92005-08-14 01:20:37 +000026/*
27** Return the collating function associated with a function.
28*/
danielk1977dc1bdc42004-06-11 10:51:27 +000029static CollSeq *sqlite3GetFuncCollSeq(sqlite3_context *context){
30 return context->pColl;
31}
32
drh0bce8352002-02-28 00:41:10 +000033/*
34** Implementation of the non-aggregate min() and max() functions
35*/
drhf9b596e2004-05-26 16:54:42 +000036static void minmaxFunc(
37 sqlite3_context *context,
38 int argc,
39 sqlite3_value **argv
40){
drh0bce8352002-02-28 00:41:10 +000041 int i;
drh268380c2004-02-25 13:47:31 +000042 int mask; /* 0 for min() or 0xffffffff for max() */
drhf9b596e2004-05-26 16:54:42 +000043 int iBest;
danielk1977dc1bdc42004-06-11 10:51:27 +000044 CollSeq *pColl;
drh0bce8352002-02-28 00:41:10 +000045
drh65595cd2009-02-02 16:32:55 +000046 assert( argc>1 );
drhc44af712004-09-02 15:53:56 +000047 mask = sqlite3_user_data(context)==0 ? 0 : -1;
danielk1977dc1bdc42004-06-11 10:51:27 +000048 pColl = sqlite3GetFuncCollSeq(context);
49 assert( pColl );
danielk1977c572ef72004-05-27 09:28:41 +000050 assert( mask==-1 || mask==0 );
drhf9b596e2004-05-26 16:54:42 +000051 iBest = 0;
drh9c054832004-05-31 18:51:57 +000052 if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
drhf9b596e2004-05-26 16:54:42 +000053 for(i=1; i<argc; i++){
drh9c054832004-05-31 18:51:57 +000054 if( sqlite3_value_type(argv[i])==SQLITE_NULL ) return;
danielk1977dc1bdc42004-06-11 10:51:27 +000055 if( (sqlite3MemCompare(argv[iBest], argv[i], pColl)^mask)>=0 ){
drh65595cd2009-02-02 16:32:55 +000056 testcase( mask==0 );
drhf9b596e2004-05-26 16:54:42 +000057 iBest = i;
drh0bce8352002-02-28 00:41:10 +000058 }
59 }
drhf4479502004-05-27 03:12:53 +000060 sqlite3_result_value(context, argv[iBest]);
drh0bce8352002-02-28 00:41:10 +000061}
drh0bce8352002-02-28 00:41:10 +000062
drh268380c2004-02-25 13:47:31 +000063/*
64** Return the type of the argument.
65*/
drhf9b596e2004-05-26 16:54:42 +000066static void typeofFunc(
67 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +000068 int NotUsed,
drhf9b596e2004-05-26 16:54:42 +000069 sqlite3_value **argv
70){
danielk197735bb9d02004-05-24 12:55:54 +000071 const char *z = 0;
danielk197762c14b32008-11-19 09:05:26 +000072 UNUSED_PARAMETER(NotUsed);
danielk197735bb9d02004-05-24 12:55:54 +000073 switch( sqlite3_value_type(argv[0]) ){
drh9c054832004-05-31 18:51:57 +000074 case SQLITE_INTEGER: z = "integer"; break;
75 case SQLITE_TEXT: z = "text"; break;
76 case SQLITE_FLOAT: z = "real"; break;
77 case SQLITE_BLOB: z = "blob"; break;
drh65595cd2009-02-02 16:32:55 +000078 default: z = "null"; break;
danielk197735bb9d02004-05-24 12:55:54 +000079 }
danielk1977d8123362004-06-12 09:25:12 +000080 sqlite3_result_text(context, z, -1, SQLITE_STATIC);
drh0bce8352002-02-28 00:41:10 +000081}
82
drh5708d2d2005-06-22 10:53:59 +000083
84/*
drh0bce8352002-02-28 00:41:10 +000085** Implementation of the length() function
86*/
drhf9b596e2004-05-26 16:54:42 +000087static void lengthFunc(
88 sqlite3_context *context,
89 int argc,
90 sqlite3_value **argv
91){
drh0bce8352002-02-28 00:41:10 +000092 int len;
93
94 assert( argc==1 );
danielk1977f3d3c272008-11-19 16:52:44 +000095 UNUSED_PARAMETER(argc);
drhf9b596e2004-05-26 16:54:42 +000096 switch( sqlite3_value_type(argv[0]) ){
drh9c054832004-05-31 18:51:57 +000097 case SQLITE_BLOB:
98 case SQLITE_INTEGER:
99 case SQLITE_FLOAT: {
drhf4479502004-05-27 03:12:53 +0000100 sqlite3_result_int(context, sqlite3_value_bytes(argv[0]));
drhf9b596e2004-05-26 16:54:42 +0000101 break;
102 }
drh9c054832004-05-31 18:51:57 +0000103 case SQLITE_TEXT: {
drh2646da72005-12-09 20:02:05 +0000104 const unsigned char *z = sqlite3_value_text(argv[0]);
drh7a521cf2007-04-25 18:23:52 +0000105 if( z==0 ) return;
drh4a919112007-05-15 11:55:09 +0000106 len = 0;
107 while( *z ){
108 len++;
109 SQLITE_SKIP_UTF8(z);
110 }
drhf4479502004-05-27 03:12:53 +0000111 sqlite3_result_int(context, len);
drhf9b596e2004-05-26 16:54:42 +0000112 break;
113 }
114 default: {
115 sqlite3_result_null(context);
116 break;
117 }
118 }
drh0bce8352002-02-28 00:41:10 +0000119}
120
121/*
122** Implementation of the abs() function
123*/
danielk19770ae8b832004-05-25 12:05:56 +0000124static void absFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
drh0bce8352002-02-28 00:41:10 +0000125 assert( argc==1 );
danielk1977f3d3c272008-11-19 16:52:44 +0000126 UNUSED_PARAMETER(argc);
drhf9b596e2004-05-26 16:54:42 +0000127 switch( sqlite3_value_type(argv[0]) ){
drh9c054832004-05-31 18:51:57 +0000128 case SQLITE_INTEGER: {
danielk1977f93bbbe2004-05-27 10:30:52 +0000129 i64 iVal = sqlite3_value_int64(argv[0]);
drh52fc8492006-02-23 21:43:55 +0000130 if( iVal<0 ){
131 if( (iVal<<1)==0 ){
132 sqlite3_result_error(context, "integer overflow", -1);
133 return;
134 }
135 iVal = -iVal;
136 }
danielk1977f93bbbe2004-05-27 10:30:52 +0000137 sqlite3_result_int64(context, iVal);
drhf9b596e2004-05-26 16:54:42 +0000138 break;
139 }
drh9c054832004-05-31 18:51:57 +0000140 case SQLITE_NULL: {
drhf9b596e2004-05-26 16:54:42 +0000141 sqlite3_result_null(context);
142 break;
143 }
144 default: {
danielk1977f93bbbe2004-05-27 10:30:52 +0000145 double rVal = sqlite3_value_double(argv[0]);
drh52fc8492006-02-23 21:43:55 +0000146 if( rVal<0 ) rVal = -rVal;
danielk1977f93bbbe2004-05-27 10:30:52 +0000147 sqlite3_result_double(context, rVal);
drhf9b596e2004-05-26 16:54:42 +0000148 break;
149 }
150 }
drh0bce8352002-02-28 00:41:10 +0000151}
152
153/*
drhf764e6f2007-05-15 01:13:47 +0000154** Implementation of the substr() function.
155**
156** substr(x,p1,p2) returns p2 characters of x[] beginning with p1.
157** p1 is 1-indexed. So substr(x,1,1) returns the first character
158** of x. If x is text, then we actually count UTF-8 characters.
159** If x is a blob, then we count bytes.
160**
161** If p1 is negative, then we begin abs(p1) from the end of x[].
drh0bce8352002-02-28 00:41:10 +0000162*/
drhf9b596e2004-05-26 16:54:42 +0000163static void substrFunc(
164 sqlite3_context *context,
165 int argc,
166 sqlite3_value **argv
167){
drh2646da72005-12-09 20:02:05 +0000168 const unsigned char *z;
169 const unsigned char *z2;
drh023ae032007-05-08 12:12:16 +0000170 int len;
drhf764e6f2007-05-15 01:13:47 +0000171 int p0type;
drh023ae032007-05-08 12:12:16 +0000172 i64 p1, p2;
drh65595cd2009-02-02 16:32:55 +0000173 int negP2 = 0;
drhf9b596e2004-05-26 16:54:42 +0000174
drh64f31512007-10-12 19:11:55 +0000175 assert( argc==3 || argc==2 );
drh8198d252009-02-01 19:42:37 +0000176 if( sqlite3_value_type(argv[1])==SQLITE_NULL
177 || (argc==3 && sqlite3_value_type(argv[2])==SQLITE_NULL)
178 ){
179 return;
180 }
drhf764e6f2007-05-15 01:13:47 +0000181 p0type = sqlite3_value_type(argv[0]);
182 if( p0type==SQLITE_BLOB ){
183 len = sqlite3_value_bytes(argv[0]);
184 z = sqlite3_value_blob(argv[0]);
185 if( z==0 ) return;
drh1f0feef2007-05-15 13:27:07 +0000186 assert( len==sqlite3_value_bytes(argv[0]) );
drhf764e6f2007-05-15 01:13:47 +0000187 }else{
188 z = sqlite3_value_text(argv[0]);
189 if( z==0 ) return;
drh4a919112007-05-15 11:55:09 +0000190 len = 0;
191 for(z2=z; *z2; len++){
192 SQLITE_SKIP_UTF8(z2);
193 }
drhf764e6f2007-05-15 01:13:47 +0000194 }
danielk197751ad0ec2004-05-24 12:39:02 +0000195 p1 = sqlite3_value_int(argv[1]);
drh64f31512007-10-12 19:11:55 +0000196 if( argc==3 ){
197 p2 = sqlite3_value_int(argv[2]);
drh65595cd2009-02-02 16:32:55 +0000198 if( p2<0 ){
199 p2 = -p2;
200 negP2 = 1;
201 }
drh64f31512007-10-12 19:11:55 +0000202 }else{
drhbb4957f2008-03-20 14:03:29 +0000203 p2 = sqlite3_context_db_handle(context)->aLimit[SQLITE_LIMIT_LENGTH];
drh64f31512007-10-12 19:11:55 +0000204 }
drh0bce8352002-02-28 00:41:10 +0000205 if( p1<0 ){
drh89425d52002-02-28 03:04:48 +0000206 p1 += len;
drh653bc752002-02-28 03:31:10 +0000207 if( p1<0 ){
208 p2 += p1;
drh65595cd2009-02-02 16:32:55 +0000209 if( p2<0 ) p2 = 0;
drh653bc752002-02-28 03:31:10 +0000210 p1 = 0;
211 }
drh0bce8352002-02-28 00:41:10 +0000212 }else if( p1>0 ){
213 p1--;
drh65595cd2009-02-02 16:32:55 +0000214 }else if( p2>0 ){
215 p2--;
drh0bce8352002-02-28 00:41:10 +0000216 }
drh65595cd2009-02-02 16:32:55 +0000217 if( negP2 ){
218 p1 -= p2;
drh4e79c592009-02-01 19:23:32 +0000219 if( p1<0 ){
220 p2 += p1;
221 p1 = 0;
222 }
223 }
drh65595cd2009-02-02 16:32:55 +0000224 assert( p1>=0 && p2>=0 );
drh0bce8352002-02-28 00:41:10 +0000225 if( p1+p2>len ){
226 p2 = len-p1;
227 }
drhf764e6f2007-05-15 01:13:47 +0000228 if( p0type!=SQLITE_BLOB ){
drh4a919112007-05-15 11:55:09 +0000229 while( *z && p1 ){
230 SQLITE_SKIP_UTF8(z);
231 p1--;
drhf764e6f2007-05-15 01:13:47 +0000232 }
drh4a919112007-05-15 11:55:09 +0000233 for(z2=z; *z2 && p2; p2--){
234 SQLITE_SKIP_UTF8(z2);
drhf764e6f2007-05-15 01:13:47 +0000235 }
drh1bd10f82008-12-10 21:19:56 +0000236 sqlite3_result_text(context, (char*)z, (int)(z2-z), SQLITE_TRANSIENT);
drhf764e6f2007-05-15 01:13:47 +0000237 }else{
drh1bd10f82008-12-10 21:19:56 +0000238 sqlite3_result_blob(context, (char*)&z[p1], (int)p2, SQLITE_TRANSIENT);
drh0bce8352002-02-28 00:41:10 +0000239 }
drh0bce8352002-02-28 00:41:10 +0000240}
241
242/*
243** Implementation of the round() function
244*/
danielk19770ae8b832004-05-25 12:05:56 +0000245static void roundFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
danielk197751ad0ec2004-05-24 12:39:02 +0000246 int n = 0;
drh0bce8352002-02-28 00:41:10 +0000247 double r;
drh592ac8c2005-08-13 03:07:47 +0000248 char zBuf[500]; /* larger than the %f representation of the largest double */
drh0bce8352002-02-28 00:41:10 +0000249 assert( argc==1 || argc==2 );
danielk197751ad0ec2004-05-24 12:39:02 +0000250 if( argc==2 ){
drh9c054832004-05-31 18:51:57 +0000251 if( SQLITE_NULL==sqlite3_value_type(argv[1]) ) return;
danielk197751ad0ec2004-05-24 12:39:02 +0000252 n = sqlite3_value_int(argv[1]);
253 if( n>30 ) n = 30;
254 if( n<0 ) n = 0;
255 }
drhd589a922006-03-02 03:02:48 +0000256 if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
drh4f26d6c2004-05-26 23:25:30 +0000257 r = sqlite3_value_double(argv[0]);
drhe866fcb2005-07-09 02:38:06 +0000258 sqlite3_snprintf(sizeof(zBuf),zBuf,"%.*f",n,r);
drh502b9622006-04-07 13:26:42 +0000259 sqlite3AtoF(zBuf, &r);
260 sqlite3_result_double(context, r);
drh0bce8352002-02-28 00:41:10 +0000261}
drhdc04c582002-02-24 01:55:15 +0000262
danielk197726783a52007-08-29 14:06:22 +0000263/*
264** Allocate nByte bytes of space using sqlite3_malloc(). If the
265** allocation fails, call sqlite3_result_error_nomem() to notify
266** the database handle that malloc() has failed.
267*/
drhb1a6c3c2008-03-20 16:30:17 +0000268static void *contextMalloc(sqlite3_context *context, i64 nByte){
drhbb4957f2008-03-20 14:03:29 +0000269 char *z;
270 if( nByte>sqlite3_context_db_handle(context)->aLimit[SQLITE_LIMIT_LENGTH] ){
271 sqlite3_result_error_toobig(context);
272 z = 0;
273 }else{
drh1bd10f82008-12-10 21:19:56 +0000274 z = sqlite3Malloc((int)nByte);
drhbb4957f2008-03-20 14:03:29 +0000275 if( !z && nByte>0 ){
276 sqlite3_result_error_nomem(context);
277 }
danielk1977a1644fd2007-08-29 12:31:25 +0000278 }
279 return z;
280}
281
drhdc04c582002-02-24 01:55:15 +0000282/*
283** Implementation of the upper() and lower() SQL functions.
284*/
danielk19770ae8b832004-05-25 12:05:56 +0000285static void upperFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
drh7a521cf2007-04-25 18:23:52 +0000286 char *z1;
287 const char *z2;
drh9310ef22007-04-27 17:16:20 +0000288 int i, n;
drh7a521cf2007-04-25 18:23:52 +0000289 z2 = (char*)sqlite3_value_text(argv[0]);
drh1f0feef2007-05-15 13:27:07 +0000290 n = sqlite3_value_bytes(argv[0]);
291 /* Verify that the call to _bytes() does not invalidate the _text() pointer */
292 assert( z2==(char*)sqlite3_value_text(argv[0]) );
drh7a521cf2007-04-25 18:23:52 +0000293 if( z2 ){
drhb1a6c3c2008-03-20 16:30:17 +0000294 z1 = contextMalloc(context, ((i64)n)+1);
drh7a521cf2007-04-25 18:23:52 +0000295 if( z1 ){
drh5bb3eb92007-05-04 13:15:55 +0000296 memcpy(z1, z2, n+1);
drh7a521cf2007-04-25 18:23:52 +0000297 for(i=0; z1[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +0000298 z1[i] = (char)sqlite3Toupper(z1[i]);
drh7a521cf2007-04-25 18:23:52 +0000299 }
300 sqlite3_result_text(context, z1, -1, sqlite3_free);
301 }
drhdc04c582002-02-24 01:55:15 +0000302 }
303}
danielk19770ae8b832004-05-25 12:05:56 +0000304static void lowerFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
danielk197778ca0e72009-01-20 16:53:39 +0000305 u8 *z1;
drh7a521cf2007-04-25 18:23:52 +0000306 const char *z2;
drh9310ef22007-04-27 17:16:20 +0000307 int i, n;
drh7a521cf2007-04-25 18:23:52 +0000308 z2 = (char*)sqlite3_value_text(argv[0]);
drh1f0feef2007-05-15 13:27:07 +0000309 n = sqlite3_value_bytes(argv[0]);
310 /* Verify that the call to _bytes() does not invalidate the _text() pointer */
311 assert( z2==(char*)sqlite3_value_text(argv[0]) );
drh7a521cf2007-04-25 18:23:52 +0000312 if( z2 ){
drhb1a6c3c2008-03-20 16:30:17 +0000313 z1 = contextMalloc(context, ((i64)n)+1);
drh7a521cf2007-04-25 18:23:52 +0000314 if( z1 ){
drh5bb3eb92007-05-04 13:15:55 +0000315 memcpy(z1, z2, n+1);
drh7a521cf2007-04-25 18:23:52 +0000316 for(i=0; z1[i]; i++){
danielk197778ca0e72009-01-20 16:53:39 +0000317 z1[i] = sqlite3Tolower(z1[i]);
drh7a521cf2007-04-25 18:23:52 +0000318 }
danielk197778ca0e72009-01-20 16:53:39 +0000319 sqlite3_result_text(context, (char *)z1, -1, sqlite3_free);
drh7a521cf2007-04-25 18:23:52 +0000320 }
drhdc04c582002-02-24 01:55:15 +0000321 }
322}
323
324/*
drhfbc99082002-02-28 03:14:18 +0000325** Implementation of the IFNULL(), NVL(), and COALESCE() functions.
jplyonb6c9e6e2004-01-19 04:53:24 +0000326** All three do the same thing. They return the first non-NULL
327** argument.
drh3212e182002-02-28 00:46:26 +0000328*/
drhf9b596e2004-05-26 16:54:42 +0000329static void ifnullFunc(
330 sqlite3_context *context,
331 int argc,
332 sqlite3_value **argv
333){
drhfbc99082002-02-28 03:14:18 +0000334 int i;
335 for(i=0; i<argc; i++){
drh9c054832004-05-31 18:51:57 +0000336 if( SQLITE_NULL!=sqlite3_value_type(argv[i]) ){
drhf4479502004-05-27 03:12:53 +0000337 sqlite3_result_value(context, argv[i]);
drhfbc99082002-02-28 03:14:18 +0000338 break;
339 }
340 }
drh3212e182002-02-28 00:46:26 +0000341}
342
343/*
drhf9ffac92002-03-02 19:00:31 +0000344** Implementation of random(). Return a random integer.
345*/
drhf9b596e2004-05-26 16:54:42 +0000346static void randomFunc(
347 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +0000348 int NotUsed,
349 sqlite3_value **NotUsed2
drhf9b596e2004-05-26 16:54:42 +0000350){
drh52fc8492006-02-23 21:43:55 +0000351 sqlite_int64 r;
danielk197762c14b32008-11-19 09:05:26 +0000352 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drh2fa18682008-03-19 14:15:34 +0000353 sqlite3_randomness(sizeof(r), &r);
drh874abbe2006-02-23 21:51:12 +0000354 if( (r<<1)==0 ) r = 0; /* Prevent 0x8000.... as the result so that we */
355 /* can always do abs() of the result */
drh52fc8492006-02-23 21:43:55 +0000356 sqlite3_result_int64(context, r);
drhf9ffac92002-03-02 19:00:31 +0000357}
358
359/*
drh137c7282007-01-29 17:58:28 +0000360** Implementation of randomblob(N). Return a random blob
361** that is N bytes long.
drh63cf66f2007-01-29 15:50:05 +0000362*/
drh137c7282007-01-29 17:58:28 +0000363static void randomBlob(
drh63cf66f2007-01-29 15:50:05 +0000364 sqlite3_context *context,
365 int argc,
366 sqlite3_value **argv
367){
drh137c7282007-01-29 17:58:28 +0000368 int n;
369 unsigned char *p;
drh63cf66f2007-01-29 15:50:05 +0000370 assert( argc==1 );
danielk1977f3d3c272008-11-19 16:52:44 +0000371 UNUSED_PARAMETER(argc);
drh63cf66f2007-01-29 15:50:05 +0000372 n = sqlite3_value_int(argv[0]);
drh023ae032007-05-08 12:12:16 +0000373 if( n<1 ){
374 n = 1;
375 }
danielk1977a1644fd2007-08-29 12:31:25 +0000376 p = contextMalloc(context, n);
drh02d85832007-05-07 19:31:15 +0000377 if( p ){
drh2fa18682008-03-19 14:15:34 +0000378 sqlite3_randomness(n, p);
drh17435752007-08-16 04:30:38 +0000379 sqlite3_result_blob(context, (char*)p, n, sqlite3_free);
drh02d85832007-05-07 19:31:15 +0000380 }
drh63cf66f2007-01-29 15:50:05 +0000381}
382
383/*
drh6ed41ad2002-04-06 14:10:47 +0000384** Implementation of the last_insert_rowid() SQL function. The return
danielk197724b03fd2004-05-10 10:34:34 +0000385** value is the same as the sqlite3_last_insert_rowid() API function.
drh6ed41ad2002-04-06 14:10:47 +0000386*/
danielk197751ad0ec2004-05-24 12:39:02 +0000387static void last_insert_rowid(
danielk19770ae8b832004-05-25 12:05:56 +0000388 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +0000389 int NotUsed,
390 sqlite3_value **NotUsed2
danielk197751ad0ec2004-05-24 12:39:02 +0000391){
drhfa4a4b92008-03-19 21:45:51 +0000392 sqlite3 *db = sqlite3_context_db_handle(context);
danielk197762c14b32008-11-19 09:05:26 +0000393 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhf9b596e2004-05-26 16:54:42 +0000394 sqlite3_result_int64(context, sqlite3_last_insert_rowid(db));
drh6ed41ad2002-04-06 14:10:47 +0000395}
396
rdcf146a772004-02-25 22:51:06 +0000397/*
danielk1977b28af712004-06-21 06:50:26 +0000398** Implementation of the changes() SQL function. The return value is the
399** same as the sqlite3_changes() API function.
rdcf146a772004-02-25 22:51:06 +0000400*/
danielk1977b28af712004-06-21 06:50:26 +0000401static void changes(
drhf9b596e2004-05-26 16:54:42 +0000402 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +0000403 int NotUsed,
404 sqlite3_value **NotUsed2
drhf9b596e2004-05-26 16:54:42 +0000405){
drhfa4a4b92008-03-19 21:45:51 +0000406 sqlite3 *db = sqlite3_context_db_handle(context);
danielk197762c14b32008-11-19 09:05:26 +0000407 UNUSED_PARAMETER2(NotUsed, NotUsed2);
drhf4479502004-05-27 03:12:53 +0000408 sqlite3_result_int(context, sqlite3_changes(db));
rdcb0c374f2004-02-20 22:53:38 +0000409}
rdcf146a772004-02-25 22:51:06 +0000410
411/*
danielk1977b28af712004-06-21 06:50:26 +0000412** Implementation of the total_changes() SQL function. The return value is
413** the same as the sqlite3_total_changes() API function.
rdcf146a772004-02-25 22:51:06 +0000414*/
danielk1977b28af712004-06-21 06:50:26 +0000415static void total_changes(
416 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +0000417 int NotUsed,
418 sqlite3_value **NotUsed2
danielk197751ad0ec2004-05-24 12:39:02 +0000419){
drhfa4a4b92008-03-19 21:45:51 +0000420 sqlite3 *db = sqlite3_context_db_handle(context);
danielk197762c14b32008-11-19 09:05:26 +0000421 UNUSED_PARAMETER2(NotUsed, NotUsed2);
danielk1977b28af712004-06-21 06:50:26 +0000422 sqlite3_result_int(context, sqlite3_total_changes(db));
rdcb0c374f2004-02-20 22:53:38 +0000423}
424
drh6ed41ad2002-04-06 14:10:47 +0000425/*
drh4e5ffc52004-08-31 00:52:37 +0000426** A structure defining how to do GLOB-style comparisons.
danielk1977d02eb1f2004-06-06 09:44:03 +0000427*/
drh4e5ffc52004-08-31 00:52:37 +0000428struct compareInfo {
429 u8 matchAll;
430 u8 matchOne;
431 u8 matchSet;
432 u8 noCase;
danielk1977d02eb1f2004-06-06 09:44:03 +0000433};
drh55ef4d92005-08-14 01:20:37 +0000434
drhb9175ae2007-12-07 18:39:04 +0000435/*
436** For LIKE and GLOB matching on EBCDIC machines, assume that every
437** character is exactly one byte in size. Also, all characters are
438** able to participate in upper-case-to-lower-case mappings in EBCDIC
439** whereas only characters less than 0x80 do in ASCII.
440*/
441#if defined(SQLITE_EBCDIC)
442# define sqlite3Utf8Read(A,B,C) (*(A++))
drh6ed4b782007-12-10 18:07:20 +0000443# define GlogUpperToLower(A) A = sqlite3UpperToLower[A]
drhb9175ae2007-12-07 18:39:04 +0000444#else
drh6ed4b782007-12-10 18:07:20 +0000445# define GlogUpperToLower(A) if( A<0x80 ){ A = sqlite3UpperToLower[A]; }
drhb9175ae2007-12-07 18:39:04 +0000446#endif
447
drh4e5ffc52004-08-31 00:52:37 +0000448static const struct compareInfo globInfo = { '*', '?', '[', 0 };
drh55ef4d92005-08-14 01:20:37 +0000449/* The correct SQL-92 behavior is for the LIKE operator to ignore
450** case. Thus 'a' LIKE 'A' would be true. */
451static const struct compareInfo likeInfoNorm = { '%', '_', 0, 1 };
452/* If SQLITE_CASE_SENSITIVE_LIKE is defined, then the LIKE operator
453** is case sensitive causing 'a' LIKE 'A' to be false */
454static const struct compareInfo likeInfoAlt = { '%', '_', 0, 0 };
danielk1977d02eb1f2004-06-06 09:44:03 +0000455
456/*
drh4e5ffc52004-08-31 00:52:37 +0000457** Compare two UTF-8 strings for equality where the first string can
458** potentially be a "glob" expression. Return true (1) if they
459** are the same and false (0) if they are different.
drh0ac65892002-04-20 14:24:41 +0000460**
drh4e5ffc52004-08-31 00:52:37 +0000461** Globbing rules:
drh0ac65892002-04-20 14:24:41 +0000462**
drh4e5ffc52004-08-31 00:52:37 +0000463** '*' Matches any sequence of zero or more characters.
danielk1977d02eb1f2004-06-06 09:44:03 +0000464**
drh4e5ffc52004-08-31 00:52:37 +0000465** '?' Matches exactly one character.
466**
467** [...] Matches one character from the enclosed list of
468** characters.
469**
470** [^...] Matches one character not in the enclosed list.
471**
472** With the [...] and [^...] matching, a ']' character can be included
473** in the list by making it the first character after '[' or '^'. A
474** range of characters can be specified using '-'. Example:
475** "[a-z]" matches any single lower-case letter. To match a '-', make
476** it the last character in the list.
477**
478** This routine is usually quick, but can be N**2 in the worst case.
479**
480** Hints: to match '*' or '?', put them in "[]". Like this:
481**
482** abc[*]xyz Matches "abc*xyz" only
drh0ac65892002-04-20 14:24:41 +0000483*/
danielk19777c6303c2004-11-17 16:41:29 +0000484static int patternCompare(
drh4e5ffc52004-08-31 00:52:37 +0000485 const u8 *zPattern, /* The glob pattern */
486 const u8 *zString, /* The string to compare against the glob */
danielk19777c6303c2004-11-17 16:41:29 +0000487 const struct compareInfo *pInfo, /* Information about how to do the compare */
488 const int esc /* The escape character */
danielk197751ad0ec2004-05-24 12:39:02 +0000489){
drh66150952007-07-23 19:12:41 +0000490 int c, c2;
drh4e5ffc52004-08-31 00:52:37 +0000491 int invert;
492 int seen;
drh4e5ffc52004-08-31 00:52:37 +0000493 u8 matchOne = pInfo->matchOne;
494 u8 matchAll = pInfo->matchAll;
495 u8 matchSet = pInfo->matchSet;
496 u8 noCase = pInfo->noCase;
danielk19777c6303c2004-11-17 16:41:29 +0000497 int prevEscape = 0; /* True if the previous character was 'escape' */
danielk1977d02eb1f2004-06-06 09:44:03 +0000498
drh66150952007-07-23 19:12:41 +0000499 while( (c = sqlite3Utf8Read(zPattern,0,&zPattern))!=0 ){
danielk19777c6303c2004-11-17 16:41:29 +0000500 if( !prevEscape && c==matchAll ){
drh66150952007-07-23 19:12:41 +0000501 while( (c=sqlite3Utf8Read(zPattern,0,&zPattern)) == matchAll
502 || c == matchOne ){
503 if( c==matchOne && sqlite3Utf8Read(zString, 0, &zString)==0 ){
504 return 0;
drh4e5ffc52004-08-31 00:52:37 +0000505 }
danielk1977ad7dd422004-06-06 12:41:49 +0000506 }
drh66150952007-07-23 19:12:41 +0000507 if( c==0 ){
508 return 1;
509 }else if( c==esc ){
510 c = sqlite3Utf8Read(zPattern, 0, &zPattern);
511 if( c==0 ){
512 return 0;
513 }
514 }else if( c==matchSet ){
515 assert( esc==0 ); /* This is GLOB, not LIKE */
516 assert( matchSet<0x80 ); /* '[' is a single-byte character */
517 while( *zString && patternCompare(&zPattern[-1],zString,pInfo,esc)==0 ){
drh4a919112007-05-15 11:55:09 +0000518 SQLITE_SKIP_UTF8(zString);
drh4e5ffc52004-08-31 00:52:37 +0000519 }
520 return *zString!=0;
drh66150952007-07-23 19:12:41 +0000521 }
522 while( (c2 = sqlite3Utf8Read(zString,0,&zString))!=0 ){
523 if( noCase ){
drh6ed4b782007-12-10 18:07:20 +0000524 GlogUpperToLower(c2);
525 GlogUpperToLower(c);
drh66150952007-07-23 19:12:41 +0000526 while( c2 != 0 && c2 != c ){
527 c2 = sqlite3Utf8Read(zString, 0, &zString);
drh6ed4b782007-12-10 18:07:20 +0000528 GlogUpperToLower(c2);
drh4e5ffc52004-08-31 00:52:37 +0000529 }
drh66150952007-07-23 19:12:41 +0000530 }else{
531 while( c2 != 0 && c2 != c ){
532 c2 = sqlite3Utf8Read(zString, 0, &zString);
533 }
drh4e5ffc52004-08-31 00:52:37 +0000534 }
drh66150952007-07-23 19:12:41 +0000535 if( c2==0 ) return 0;
536 if( patternCompare(zPattern,zString,pInfo,esc) ) return 1;
537 }
538 return 0;
539 }else if( !prevEscape && c==matchOne ){
540 if( sqlite3Utf8Read(zString, 0, &zString)==0 ){
drh4e5ffc52004-08-31 00:52:37 +0000541 return 0;
danielk1977d02eb1f2004-06-06 09:44:03 +0000542 }
drh4e5ffc52004-08-31 00:52:37 +0000543 }else if( c==matchSet ){
544 int prior_c = 0;
danielk19777c6303c2004-11-17 16:41:29 +0000545 assert( esc==0 ); /* This only occurs for GLOB, not LIKE */
drh4e5ffc52004-08-31 00:52:37 +0000546 seen = 0;
547 invert = 0;
drh66150952007-07-23 19:12:41 +0000548 c = sqlite3Utf8Read(zString, 0, &zString);
drh4e5ffc52004-08-31 00:52:37 +0000549 if( c==0 ) return 0;
drh66150952007-07-23 19:12:41 +0000550 c2 = sqlite3Utf8Read(zPattern, 0, &zPattern);
551 if( c2=='^' ){
552 invert = 1;
553 c2 = sqlite3Utf8Read(zPattern, 0, &zPattern);
554 }
drh4e5ffc52004-08-31 00:52:37 +0000555 if( c2==']' ){
556 if( c==']' ) seen = 1;
drh66150952007-07-23 19:12:41 +0000557 c2 = sqlite3Utf8Read(zPattern, 0, &zPattern);
drh4e5ffc52004-08-31 00:52:37 +0000558 }
drh66150952007-07-23 19:12:41 +0000559 while( c2 && c2!=']' ){
560 if( c2=='-' && zPattern[0]!=']' && zPattern[0]!=0 && prior_c>0 ){
561 c2 = sqlite3Utf8Read(zPattern, 0, &zPattern);
drh4e5ffc52004-08-31 00:52:37 +0000562 if( c>=prior_c && c<=c2 ) seen = 1;
563 prior_c = 0;
drh4e5ffc52004-08-31 00:52:37 +0000564 }else{
drh66150952007-07-23 19:12:41 +0000565 if( c==c2 ){
566 seen = 1;
567 }
drh4e5ffc52004-08-31 00:52:37 +0000568 prior_c = c2;
569 }
drh66150952007-07-23 19:12:41 +0000570 c2 = sqlite3Utf8Read(zPattern, 0, &zPattern);
drh4e5ffc52004-08-31 00:52:37 +0000571 }
drh66150952007-07-23 19:12:41 +0000572 if( c2==0 || (seen ^ invert)==0 ){
573 return 0;
574 }
575 }else if( esc==c && !prevEscape ){
danielk19777c6303c2004-11-17 16:41:29 +0000576 prevEscape = 1;
drh4e5ffc52004-08-31 00:52:37 +0000577 }else{
drh66150952007-07-23 19:12:41 +0000578 c2 = sqlite3Utf8Read(zString, 0, &zString);
drh4e5ffc52004-08-31 00:52:37 +0000579 if( noCase ){
drh6ed4b782007-12-10 18:07:20 +0000580 GlogUpperToLower(c);
581 GlogUpperToLower(c2);
drh4e5ffc52004-08-31 00:52:37 +0000582 }
drh66150952007-07-23 19:12:41 +0000583 if( c!=c2 ){
584 return 0;
585 }
danielk19777c6303c2004-11-17 16:41:29 +0000586 prevEscape = 0;
danielk1977d02eb1f2004-06-06 09:44:03 +0000587 }
danielk197751ad0ec2004-05-24 12:39:02 +0000588 }
drh4e5ffc52004-08-31 00:52:37 +0000589 return *zString==0;
drh0ac65892002-04-20 14:24:41 +0000590}
drh4e5ffc52004-08-31 00:52:37 +0000591
drh55ef4d92005-08-14 01:20:37 +0000592/*
593** Count the number of times that the LIKE operator (or GLOB which is
594** just a variation of LIKE) gets called. This is used for testing
595** only.
596*/
597#ifdef SQLITE_TEST
598int sqlite3_like_count = 0;
599#endif
600
danielk19773f6b0872004-06-17 05:36:44 +0000601
602/*
603** Implementation of the like() SQL function. This function implements
604** the build-in LIKE operator. The first argument to the function is the
605** pattern and the second argument is the string. So, the SQL statements:
606**
607** A LIKE B
608**
609** is implemented as like(B,A).
610**
drh55ef4d92005-08-14 01:20:37 +0000611** This same function (with a different compareInfo structure) computes
612** the GLOB operator.
danielk19773f6b0872004-06-17 05:36:44 +0000613*/
614static void likeFunc(
615 sqlite3_context *context,
616 int argc,
617 sqlite3_value **argv
618){
drhbeb818d2007-05-08 15:34:47 +0000619 const unsigned char *zA, *zB;
drh85892bd2007-05-10 13:23:22 +0000620 int escape = 0;
drhbb4957f2008-03-20 14:03:29 +0000621 sqlite3 *db = sqlite3_context_db_handle(context);
drhbeb818d2007-05-08 15:34:47 +0000622
drh1f0feef2007-05-15 13:27:07 +0000623 zB = sqlite3_value_text(argv[0]);
624 zA = sqlite3_value_text(argv[1]);
625
drhbeb818d2007-05-08 15:34:47 +0000626 /* Limit the length of the LIKE or GLOB pattern to avoid problems
627 ** of deep recursion and N*N behavior in patternCompare().
628 */
drhbb4957f2008-03-20 14:03:29 +0000629 if( sqlite3_value_bytes(argv[0]) >
630 db->aLimit[SQLITE_LIMIT_LIKE_PATTERN_LENGTH] ){
drhbeb818d2007-05-08 15:34:47 +0000631 sqlite3_result_error(context, "LIKE or GLOB pattern too complex", -1);
632 return;
633 }
drh1f0feef2007-05-15 13:27:07 +0000634 assert( zB==sqlite3_value_text(argv[0]) ); /* Encoding did not change */
drhbeb818d2007-05-08 15:34:47 +0000635
danielk19777c6303c2004-11-17 16:41:29 +0000636 if( argc==3 ){
637 /* The escape character string must consist of a single UTF-8 character.
638 ** Otherwise, return an error.
639 */
640 const unsigned char *zEsc = sqlite3_value_text(argv[2]);
drh7a521cf2007-04-25 18:23:52 +0000641 if( zEsc==0 ) return;
drhee858132007-05-08 20:37:38 +0000642 if( sqlite3Utf8CharLen((char*)zEsc, -1)!=1 ){
danielk19777c6303c2004-11-17 16:41:29 +0000643 sqlite3_result_error(context,
644 "ESCAPE expression must be a single character", -1);
645 return;
646 }
drh66150952007-07-23 19:12:41 +0000647 escape = sqlite3Utf8Read(zEsc, 0, &zEsc);
danielk19777c6303c2004-11-17 16:41:29 +0000648 }
danielk19773f6b0872004-06-17 05:36:44 +0000649 if( zA && zB ){
drh55ef4d92005-08-14 01:20:37 +0000650 struct compareInfo *pInfo = sqlite3_user_data(context);
651#ifdef SQLITE_TEST
652 sqlite3_like_count++;
653#endif
drhbeb818d2007-05-08 15:34:47 +0000654
danielk1977b56fe1f2007-05-09 08:24:44 +0000655 sqlite3_result_int(context, patternCompare(zB, zA, pInfo, escape));
danielk197751ad0ec2004-05-24 12:39:02 +0000656 }
drh8912d102002-05-26 21:34:58 +0000657}
658
659/*
660** Implementation of the NULLIF(x,y) function. The result is the first
661** argument if the arguments are different. The result is NULL if the
662** arguments are equal to each other.
663*/
drhf9b596e2004-05-26 16:54:42 +0000664static void nullifFunc(
665 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +0000666 int NotUsed,
drhf9b596e2004-05-26 16:54:42 +0000667 sqlite3_value **argv
668){
danielk1977dc1bdc42004-06-11 10:51:27 +0000669 CollSeq *pColl = sqlite3GetFuncCollSeq(context);
danielk197762c14b32008-11-19 09:05:26 +0000670 UNUSED_PARAMETER(NotUsed);
danielk1977dc1bdc42004-06-11 10:51:27 +0000671 if( sqlite3MemCompare(argv[0], argv[1], pColl)!=0 ){
drhf4479502004-05-27 03:12:53 +0000672 sqlite3_result_value(context, argv[0]);
drh8912d102002-05-26 21:34:58 +0000673 }
drh0ac65892002-04-20 14:24:41 +0000674}
675
drh647cb0e2002-11-04 19:32:25 +0000676/*
677** Implementation of the VERSION(*) function. The result is the version
678** of the SQLite library that is running.
679*/
drhf9b596e2004-05-26 16:54:42 +0000680static void versionFunc(
681 sqlite3_context *context,
danielk197762c14b32008-11-19 09:05:26 +0000682 int NotUsed,
683 sqlite3_value **NotUsed2
drhf9b596e2004-05-26 16:54:42 +0000684){
danielk197762c14b32008-11-19 09:05:26 +0000685 UNUSED_PARAMETER2(NotUsed, NotUsed2);
danielk1977d8123362004-06-12 09:25:12 +0000686 sqlite3_result_text(context, sqlite3_version, -1, SQLITE_STATIC);
drh647cb0e2002-11-04 19:32:25 +0000687}
688
drh137c7282007-01-29 17:58:28 +0000689/* Array for converting from half-bytes (nybbles) into ASCII hex
690** digits. */
691static const char hexdigits[] = {
692 '0', '1', '2', '3', '4', '5', '6', '7',
693 '8', '9', 'A', 'B', 'C', 'D', 'E', 'F'
694};
danielk1977d641d642004-11-18 15:44:29 +0000695
drh47394702003-08-20 01:03:33 +0000696/*
697** EXPERIMENTAL - This is not an official function. The interface may
698** change. This function may disappear. Do not write code that depends
699** on this function.
700**
701** Implementation of the QUOTE() function. This function takes a single
702** argument. If the argument is numeric, the return value is the same as
703** the argument. If the argument is NULL, the return value is the string
704** "NULL". Otherwise, the argument is enclosed in single quotes with
705** single-quote escapes.
706*/
danielk19770ae8b832004-05-25 12:05:56 +0000707static void quoteFunc(sqlite3_context *context, int argc, sqlite3_value **argv){
drha0df4cc2009-02-02 17:29:59 +0000708 assert( argc==1 );
drhf9b596e2004-05-26 16:54:42 +0000709 switch( sqlite3_value_type(argv[0]) ){
drh9c054832004-05-31 18:51:57 +0000710 case SQLITE_INTEGER:
711 case SQLITE_FLOAT: {
drhf4479502004-05-27 03:12:53 +0000712 sqlite3_result_value(context, argv[0]);
drhf9b596e2004-05-26 16:54:42 +0000713 break;
714 }
danielk19773f41e972004-06-08 00:39:01 +0000715 case SQLITE_BLOB: {
danielk19773f41e972004-06-08 00:39:01 +0000716 char *zText = 0;
danielk19773f41e972004-06-08 00:39:01 +0000717 char const *zBlob = sqlite3_value_blob(argv[0]);
drh1f0feef2007-05-15 13:27:07 +0000718 int nBlob = sqlite3_value_bytes(argv[0]);
719 assert( zBlob==sqlite3_value_blob(argv[0]) ); /* No encoding change */
drhb1a6c3c2008-03-20 16:30:17 +0000720 zText = (char *)contextMalloc(context, (2*(i64)nBlob)+4);
danielk1977a1644fd2007-08-29 12:31:25 +0000721 if( zText ){
danielk19773f41e972004-06-08 00:39:01 +0000722 int i;
723 for(i=0; i<nBlob; i++){
724 zText[(i*2)+2] = hexdigits[(zBlob[i]>>4)&0x0F];
725 zText[(i*2)+3] = hexdigits[(zBlob[i])&0x0F];
726 }
727 zText[(nBlob*2)+2] = '\'';
728 zText[(nBlob*2)+3] = '\0';
729 zText[0] = 'X';
730 zText[1] = '\'';
danielk1977d8123362004-06-12 09:25:12 +0000731 sqlite3_result_text(context, zText, -1, SQLITE_TRANSIENT);
drh17435752007-08-16 04:30:38 +0000732 sqlite3_free(zText);
danielk19773f41e972004-06-08 00:39:01 +0000733 }
734 break;
735 }
drh9c054832004-05-31 18:51:57 +0000736 case SQLITE_TEXT: {
drh023ae032007-05-08 12:12:16 +0000737 int i,j;
738 u64 n;
drh2646da72005-12-09 20:02:05 +0000739 const unsigned char *zArg = sqlite3_value_text(argv[0]);
drhf9b596e2004-05-26 16:54:42 +0000740 char *z;
741
drh7a521cf2007-04-25 18:23:52 +0000742 if( zArg==0 ) return;
drh023ae032007-05-08 12:12:16 +0000743 for(i=0, n=0; zArg[i]; i++){ if( zArg[i]=='\'' ) n++; }
drhb1a6c3c2008-03-20 16:30:17 +0000744 z = contextMalloc(context, ((i64)i)+((i64)n)+3);
danielk1977a1644fd2007-08-29 12:31:25 +0000745 if( z ){
746 z[0] = '\'';
747 for(i=0, j=1; zArg[i]; i++){
748 z[j++] = zArg[i];
749 if( zArg[i]=='\'' ){
750 z[j++] = '\'';
751 }
drhf9b596e2004-05-26 16:54:42 +0000752 }
danielk1977a1644fd2007-08-29 12:31:25 +0000753 z[j++] = '\'';
754 z[j] = 0;
755 sqlite3_result_text(context, z, j, sqlite3_free);
drhf9b596e2004-05-26 16:54:42 +0000756 }
drha0df4cc2009-02-02 17:29:59 +0000757 break;
758 }
759 default: {
760 assert( sqlite3_value_type(argv[0])==SQLITE_NULL );
761 sqlite3_result_text(context, "NULL", 4, SQLITE_STATIC);
762 break;
drhf9b596e2004-05-26 16:54:42 +0000763 }
drh47394702003-08-20 01:03:33 +0000764 }
765}
766
drh137c7282007-01-29 17:58:28 +0000767/*
768** The hex() function. Interpret the argument as a blob. Return
769** a hexadecimal rendering as text.
770*/
771static void hexFunc(
772 sqlite3_context *context,
773 int argc,
774 sqlite3_value **argv
775){
776 int i, n;
777 const unsigned char *pBlob;
778 char *zHex, *z;
779 assert( argc==1 );
danielk1977f3d3c272008-11-19 16:52:44 +0000780 UNUSED_PARAMETER(argc);
drh1f0feef2007-05-15 13:27:07 +0000781 pBlob = sqlite3_value_blob(argv[0]);
drh137c7282007-01-29 17:58:28 +0000782 n = sqlite3_value_bytes(argv[0]);
drh1f0feef2007-05-15 13:27:07 +0000783 assert( pBlob==sqlite3_value_blob(argv[0]) ); /* No encoding change */
drhb1a6c3c2008-03-20 16:30:17 +0000784 z = zHex = contextMalloc(context, ((i64)n)*2 + 1);
danielk1977a1644fd2007-08-29 12:31:25 +0000785 if( zHex ){
786 for(i=0; i<n; i++, pBlob++){
787 unsigned char c = *pBlob;
788 *(z++) = hexdigits[(c>>4)&0xf];
789 *(z++) = hexdigits[c&0xf];
790 }
791 *z = 0;
792 sqlite3_result_text(context, zHex, n*2, sqlite3_free);
drh137c7282007-01-29 17:58:28 +0000793 }
drh137c7282007-01-29 17:58:28 +0000794}
795
drh26b6d902007-03-17 13:27:54 +0000796/*
drh8cff3822007-05-02 02:08:28 +0000797** The zeroblob(N) function returns a zero-filled blob of size N bytes.
798*/
799static void zeroblobFunc(
800 sqlite3_context *context,
801 int argc,
802 sqlite3_value **argv
803){
drh98640a32007-06-07 19:08:32 +0000804 i64 n;
drh8cff3822007-05-02 02:08:28 +0000805 assert( argc==1 );
danielk1977f3d3c272008-11-19 16:52:44 +0000806 UNUSED_PARAMETER(argc);
drh98640a32007-06-07 19:08:32 +0000807 n = sqlite3_value_int64(argv[0]);
808 if( n>SQLITE_MAX_LENGTH ){
809 sqlite3_result_error_toobig(context);
810 }else{
drh1bd10f82008-12-10 21:19:56 +0000811 sqlite3_result_zeroblob(context, (int)n);
drh98640a32007-06-07 19:08:32 +0000812 }
drh8cff3822007-05-02 02:08:28 +0000813}
814
815/*
drh26b6d902007-03-17 13:27:54 +0000816** The replace() function. Three arguments are all strings: call
817** them A, B, and C. The result is also a string which is derived
818** from A by replacing every occurance of B with C. The match
819** must be exact. Collating sequences are not used.
820*/
821static void replaceFunc(
822 sqlite3_context *context,
823 int argc,
824 sqlite3_value **argv
825){
826 const unsigned char *zStr; /* The input string A */
827 const unsigned char *zPattern; /* The pattern string B */
828 const unsigned char *zRep; /* The replacement string C */
829 unsigned char *zOut; /* The output */
830 int nStr; /* Size of zStr */
831 int nPattern; /* Size of zPattern */
832 int nRep; /* Size of zRep */
drh2e6400b2007-05-08 15:46:18 +0000833 i64 nOut; /* Maximum size of zOut */
drh26b6d902007-03-17 13:27:54 +0000834 int loopLimit; /* Last zStr[] that might match zPattern[] */
835 int i, j; /* Loop counters */
836
837 assert( argc==3 );
danielk1977f3d3c272008-11-19 16:52:44 +0000838 UNUSED_PARAMETER(argc);
drh26b6d902007-03-17 13:27:54 +0000839 zStr = sqlite3_value_text(argv[0]);
drh7a521cf2007-04-25 18:23:52 +0000840 if( zStr==0 ) return;
drh1f0feef2007-05-15 13:27:07 +0000841 nStr = sqlite3_value_bytes(argv[0]);
842 assert( zStr==sqlite3_value_text(argv[0]) ); /* No encoding change */
drh26b6d902007-03-17 13:27:54 +0000843 zPattern = sqlite3_value_text(argv[1]);
drha605fe82009-02-01 18:08:40 +0000844 if( zPattern==0 ){
845 assert( sqlite3_value_type(argv[1])==SQLITE_NULL );
846 return;
847 }
848 if( zPattern[0]==0 ){
849 assert( sqlite3_value_type(argv[1])!=SQLITE_NULL );
850 sqlite3_result_value(context, argv[0]);
851 return;
852 }
drh1f0feef2007-05-15 13:27:07 +0000853 nPattern = sqlite3_value_bytes(argv[1]);
854 assert( zPattern==sqlite3_value_text(argv[1]) ); /* No encoding change */
drh26b6d902007-03-17 13:27:54 +0000855 zRep = sqlite3_value_text(argv[2]);
drh7a521cf2007-04-25 18:23:52 +0000856 if( zRep==0 ) return;
drh1f0feef2007-05-15 13:27:07 +0000857 nRep = sqlite3_value_bytes(argv[2]);
858 assert( zRep==sqlite3_value_text(argv[2]) );
drh2e6400b2007-05-08 15:46:18 +0000859 nOut = nStr + 1;
860 assert( nOut<SQLITE_MAX_LENGTH );
drhb1a6c3c2008-03-20 16:30:17 +0000861 zOut = contextMalloc(context, (i64)nOut);
drh2e6400b2007-05-08 15:46:18 +0000862 if( zOut==0 ){
863 return;
drh26b6d902007-03-17 13:27:54 +0000864 }
drh26b6d902007-03-17 13:27:54 +0000865 loopLimit = nStr - nPattern;
866 for(i=j=0; i<=loopLimit; i++){
867 if( zStr[i]!=zPattern[0] || memcmp(&zStr[i], zPattern, nPattern) ){
868 zOut[j++] = zStr[i];
869 }else{
drh4a50aac2007-08-23 02:47:53 +0000870 u8 *zOld;
drhbb4957f2008-03-20 14:03:29 +0000871 sqlite3 *db = sqlite3_context_db_handle(context);
drh2e6400b2007-05-08 15:46:18 +0000872 nOut += nRep - nPattern;
drhbb4957f2008-03-20 14:03:29 +0000873 if( nOut>=db->aLimit[SQLITE_LIMIT_LENGTH] ){
drha0206bc2007-05-08 15:15:02 +0000874 sqlite3_result_error_toobig(context);
drh633e6d52008-07-28 19:34:53 +0000875 sqlite3DbFree(db, zOut);
danielk197717374e82007-05-08 14:39:04 +0000876 return;
877 }
drh4a50aac2007-08-23 02:47:53 +0000878 zOld = zOut;
drh2e6400b2007-05-08 15:46:18 +0000879 zOut = sqlite3_realloc(zOut, (int)nOut);
880 if( zOut==0 ){
danielk1977a1644fd2007-08-29 12:31:25 +0000881 sqlite3_result_error_nomem(context);
drh633e6d52008-07-28 19:34:53 +0000882 sqlite3DbFree(db, zOld);
drh2e6400b2007-05-08 15:46:18 +0000883 return;
884 }
drh26b6d902007-03-17 13:27:54 +0000885 memcpy(&zOut[j], zRep, nRep);
886 j += nRep;
887 i += nPattern-1;
888 }
889 }
drh2e6400b2007-05-08 15:46:18 +0000890 assert( j+nStr-i+1==nOut );
drh26b6d902007-03-17 13:27:54 +0000891 memcpy(&zOut[j], &zStr[i], nStr-i);
892 j += nStr - i;
893 assert( j<=nOut );
894 zOut[j] = 0;
895 sqlite3_result_text(context, (char*)zOut, j, sqlite3_free);
896}
897
drh309b3382007-03-17 17:52:42 +0000898/*
899** Implementation of the TRIM(), LTRIM(), and RTRIM() functions.
900** The userdata is 0x1 for left trim, 0x2 for right trim, 0x3 for both.
901*/
902static void trimFunc(
903 sqlite3_context *context,
904 int argc,
905 sqlite3_value **argv
906){
907 const unsigned char *zIn; /* Input string */
908 const unsigned char *zCharSet; /* Set of characters to trim */
909 int nIn; /* Number of bytes in input */
drh7209c692008-04-27 18:40:11 +0000910 int flags; /* 1: trimleft 2: trimright 3: trim */
drhd1e3a612007-04-27 21:59:52 +0000911 int i; /* Loop counter */
drh1bd10f82008-12-10 21:19:56 +0000912 unsigned char *aLen = 0; /* Length of each character in zCharSet */
913 unsigned char **azChar = 0; /* Individual characters in zCharSet */
drhd1e3a612007-04-27 21:59:52 +0000914 int nChar; /* Number of characters in zCharSet */
915
drh309b3382007-03-17 17:52:42 +0000916 if( sqlite3_value_type(argv[0])==SQLITE_NULL ){
917 return;
918 }
919 zIn = sqlite3_value_text(argv[0]);
drh7a521cf2007-04-25 18:23:52 +0000920 if( zIn==0 ) return;
drh1f0feef2007-05-15 13:27:07 +0000921 nIn = sqlite3_value_bytes(argv[0]);
922 assert( zIn==sqlite3_value_text(argv[0]) );
drh309b3382007-03-17 17:52:42 +0000923 if( argc==1 ){
drhd1e3a612007-04-27 21:59:52 +0000924 static const unsigned char lenOne[] = { 1 };
danielk1977a4de4532008-09-02 15:44:08 +0000925 static unsigned char * const azOne[] = { (u8*)" " };
drhd1e3a612007-04-27 21:59:52 +0000926 nChar = 1;
drh8cff3822007-05-02 02:08:28 +0000927 aLen = (u8*)lenOne;
danielk1977bc67da42007-12-11 04:23:19 +0000928 azChar = (unsigned char **)azOne;
drhd1e3a612007-04-27 21:59:52 +0000929 zCharSet = 0;
drh7a521cf2007-04-25 18:23:52 +0000930 }else if( (zCharSet = sqlite3_value_text(argv[1]))==0 ){
drh309b3382007-03-17 17:52:42 +0000931 return;
drhd1e3a612007-04-27 21:59:52 +0000932 }else{
933 const unsigned char *z;
934 for(z=zCharSet, nChar=0; *z; nChar++){
drh4a919112007-05-15 11:55:09 +0000935 SQLITE_SKIP_UTF8(z);
drhd1e3a612007-04-27 21:59:52 +0000936 }
937 if( nChar>0 ){
drhb1a6c3c2008-03-20 16:30:17 +0000938 azChar = contextMalloc(context, ((i64)nChar)*(sizeof(char*)+1));
drhd1e3a612007-04-27 21:59:52 +0000939 if( azChar==0 ){
940 return;
941 }
942 aLen = (unsigned char*)&azChar[nChar];
943 for(z=zCharSet, nChar=0; *z; nChar++){
danielk1977bc67da42007-12-11 04:23:19 +0000944 azChar[nChar] = (unsigned char *)z;
drh4a919112007-05-15 11:55:09 +0000945 SQLITE_SKIP_UTF8(z);
drh3abbd392008-12-10 23:04:13 +0000946 aLen[nChar] = (u8)(z - azChar[nChar]);
drhd1e3a612007-04-27 21:59:52 +0000947 }
948 }
drh309b3382007-03-17 17:52:42 +0000949 }
drhd1e3a612007-04-27 21:59:52 +0000950 if( nChar>0 ){
shane1fc41292008-07-08 22:28:48 +0000951 flags = SQLITE_PTR_TO_INT(sqlite3_user_data(context));
drh309b3382007-03-17 17:52:42 +0000952 if( flags & 1 ){
drhd1e3a612007-04-27 21:59:52 +0000953 while( nIn>0 ){
drh1bd10f82008-12-10 21:19:56 +0000954 int len = 0;
drhd1e3a612007-04-27 21:59:52 +0000955 for(i=0; i<nChar; i++){
956 len = aLen[i];
957 if( memcmp(zIn, azChar[i], len)==0 ) break;
958 }
959 if( i>=nChar ) break;
960 zIn += len;
961 nIn -= len;
drh309b3382007-03-17 17:52:42 +0000962 }
963 }
964 if( flags & 2 ){
drhd1e3a612007-04-27 21:59:52 +0000965 while( nIn>0 ){
drh1bd10f82008-12-10 21:19:56 +0000966 int len = 0;
drhd1e3a612007-04-27 21:59:52 +0000967 for(i=0; i<nChar; i++){
968 len = aLen[i];
969 if( len<=nIn && memcmp(&zIn[nIn-len],azChar[i],len)==0 ) break;
970 }
971 if( i>=nChar ) break;
972 nIn -= len;
drh309b3382007-03-17 17:52:42 +0000973 }
974 }
drhd1e3a612007-04-27 21:59:52 +0000975 if( zCharSet ){
976 sqlite3_free(azChar);
977 }
drh309b3382007-03-17 17:52:42 +0000978 }
979 sqlite3_result_text(context, (char*)zIn, nIn, SQLITE_TRANSIENT);
980}
drh26b6d902007-03-17 13:27:54 +0000981
danielk1977a4de4532008-09-02 15:44:08 +0000982
drhd24cc422003-03-27 12:51:24 +0000983#ifdef SQLITE_SOUNDEX
984/*
985** Compute the soundex encoding of a word.
986*/
drh137c7282007-01-29 17:58:28 +0000987static void soundexFunc(
988 sqlite3_context *context,
989 int argc,
990 sqlite3_value **argv
991){
drhd24cc422003-03-27 12:51:24 +0000992 char zResult[8];
drh4c755c02004-08-08 20:22:17 +0000993 const u8 *zIn;
drhd24cc422003-03-27 12:51:24 +0000994 int i, j;
995 static const unsigned char iCode[] = {
996 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
997 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
998 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
999 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
1000 0, 0, 1, 2, 3, 0, 1, 2, 0, 0, 2, 2, 4, 5, 5, 0,
1001 1, 2, 6, 2, 3, 0, 1, 0, 2, 0, 2, 0, 0, 0, 0, 0,
1002 0, 0, 1, 2, 3, 0, 1, 2, 0, 0, 2, 2, 4, 5, 5, 0,
1003 1, 2, 6, 2, 3, 0, 1, 0, 2, 0, 2, 0, 0, 0, 0, 0,
1004 };
1005 assert( argc==1 );
drh4c755c02004-08-08 20:22:17 +00001006 zIn = (u8*)sqlite3_value_text(argv[0]);
drhbdf67e02006-08-19 11:34:01 +00001007 if( zIn==0 ) zIn = (u8*)"";
drhdc86e2b2009-01-24 11:30:42 +00001008 for(i=0; zIn[i] && !sqlite3Isalpha(zIn[i]); i++){}
drhd24cc422003-03-27 12:51:24 +00001009 if( zIn[i] ){
drhbdf67e02006-08-19 11:34:01 +00001010 u8 prevcode = iCode[zIn[i]&0x7f];
danielk197778ca0e72009-01-20 16:53:39 +00001011 zResult[0] = sqlite3Toupper(zIn[i]);
drhd24cc422003-03-27 12:51:24 +00001012 for(j=1; j<4 && zIn[i]; i++){
1013 int code = iCode[zIn[i]&0x7f];
1014 if( code>0 ){
drhbdf67e02006-08-19 11:34:01 +00001015 if( code!=prevcode ){
1016 prevcode = code;
1017 zResult[j++] = code + '0';
1018 }
1019 }else{
1020 prevcode = 0;
drhd24cc422003-03-27 12:51:24 +00001021 }
1022 }
1023 while( j<4 ){
1024 zResult[j++] = '0';
1025 }
1026 zResult[j] = 0;
danielk1977d8123362004-06-12 09:25:12 +00001027 sqlite3_result_text(context, zResult, 4, SQLITE_TRANSIENT);
drhd24cc422003-03-27 12:51:24 +00001028 }else{
danielk1977d8123362004-06-12 09:25:12 +00001029 sqlite3_result_text(context, "?000", 4, SQLITE_STATIC);
drhd24cc422003-03-27 12:51:24 +00001030 }
1031}
1032#endif
1033
drhfdb83b22006-06-17 14:12:47 +00001034#ifndef SQLITE_OMIT_LOAD_EXTENSION
1035/*
1036** A function that loads a shared-library extension then returns NULL.
1037*/
1038static void loadExt(sqlite3_context *context, int argc, sqlite3_value **argv){
danielk197765fd59f2006-06-24 11:51:33 +00001039 const char *zFile = (const char *)sqlite3_value_text(argv[0]);
drh7a521cf2007-04-25 18:23:52 +00001040 const char *zProc;
drhfa4a4b92008-03-19 21:45:51 +00001041 sqlite3 *db = sqlite3_context_db_handle(context);
drhfdb83b22006-06-17 14:12:47 +00001042 char *zErrMsg = 0;
1043
1044 if( argc==2 ){
danielk197765fd59f2006-06-24 11:51:33 +00001045 zProc = (const char *)sqlite3_value_text(argv[1]);
drh7a521cf2007-04-25 18:23:52 +00001046 }else{
1047 zProc = 0;
drhfdb83b22006-06-17 14:12:47 +00001048 }
drh7a521cf2007-04-25 18:23:52 +00001049 if( zFile && sqlite3_load_extension(db, zFile, zProc, &zErrMsg) ){
drhfdb83b22006-06-17 14:12:47 +00001050 sqlite3_result_error(context, zErrMsg, -1);
1051 sqlite3_free(zErrMsg);
1052 }
1053}
1054#endif
1055
danielk197701427a62005-01-11 13:02:33 +00001056
drh0ac65892002-04-20 14:24:41 +00001057/*
drhd3a149e2002-02-24 17:12:53 +00001058** An instance of the following structure holds the context of a
drhdd5baa92002-02-27 19:50:59 +00001059** sum() or avg() aggregate computation.
1060*/
1061typedef struct SumCtx SumCtx;
1062struct SumCtx {
drh8c08e862006-02-11 17:34:00 +00001063 double rSum; /* Floating point sum */
1064 i64 iSum; /* Integer sum */
1065 i64 cnt; /* Number of elements summed */
1066 u8 overflow; /* True if integer overflow seen */
1067 u8 approx; /* True if non-integer value was input to the sum */
drhdd5baa92002-02-27 19:50:59 +00001068};
1069
1070/*
drha97fdd32006-01-12 22:17:50 +00001071** Routines used to compute the sum, average, and total.
1072**
1073** The SUM() function follows the (broken) SQL standard which means
1074** that it returns NULL if it sums over no inputs. TOTAL returns
1075** 0.0 in that case. In addition, TOTAL always returns a float where
1076** SUM might return an integer if it never encounters a floating point
drhc806d852006-05-11 13:25:39 +00001077** value. TOTAL never fails, but SUM might through an exception if
1078** it overflows an integer.
drhdd5baa92002-02-27 19:50:59 +00001079*/
danielk19770ae8b832004-05-25 12:05:56 +00001080static void sumStep(sqlite3_context *context, int argc, sqlite3_value **argv){
drhdd5baa92002-02-27 19:50:59 +00001081 SumCtx *p;
drh3d1d95e2005-09-08 10:37:01 +00001082 int type;
drh3f219f42005-09-08 19:45:57 +00001083 assert( argc==1 );
danielk1977f3d3c272008-11-19 16:52:44 +00001084 UNUSED_PARAMETER(argc);
drh4f26d6c2004-05-26 23:25:30 +00001085 p = sqlite3_aggregate_context(context, sizeof(*p));
drh29d72102006-02-09 22:13:41 +00001086 type = sqlite3_value_numeric_type(argv[0]);
drh3d1d95e2005-09-08 10:37:01 +00001087 if( p && type!=SQLITE_NULL ){
drh739105c2002-05-29 23:22:23 +00001088 p->cnt++;
drh29d72102006-02-09 22:13:41 +00001089 if( type==SQLITE_INTEGER ){
drh8c08e862006-02-11 17:34:00 +00001090 i64 v = sqlite3_value_int64(argv[0]);
1091 p->rSum += v;
1092 if( (p->approx|p->overflow)==0 ){
1093 i64 iNewSum = p->iSum + v;
drh1bd10f82008-12-10 21:19:56 +00001094 int s1 = (int)(p->iSum >> (sizeof(i64)*8-1));
1095 int s2 = (int)(v >> (sizeof(i64)*8-1));
1096 int s3 = (int)(iNewSum >> (sizeof(i64)*8-1));
1097 p->overflow = ((s1&s2&~s3) | (~s1&~s2&s3))?1:0;
drh8c08e862006-02-11 17:34:00 +00001098 p->iSum = iNewSum;
drh29d72102006-02-09 22:13:41 +00001099 }
1100 }else{
drh8c08e862006-02-11 17:34:00 +00001101 p->rSum += sqlite3_value_double(argv[0]);
drh29d72102006-02-09 22:13:41 +00001102 p->approx = 1;
drh3f219f42005-09-08 19:45:57 +00001103 }
drh739105c2002-05-29 23:22:23 +00001104 }
drhdd5baa92002-02-27 19:50:59 +00001105}
danielk19770ae8b832004-05-25 12:05:56 +00001106static void sumFinalize(sqlite3_context *context){
drhdd5baa92002-02-27 19:50:59 +00001107 SumCtx *p;
drhabfcea22005-09-06 20:36:48 +00001108 p = sqlite3_aggregate_context(context, 0);
drhc2bd9132005-09-08 20:37:43 +00001109 if( p && p->cnt>0 ){
drh8c08e862006-02-11 17:34:00 +00001110 if( p->overflow ){
1111 sqlite3_result_error(context,"integer overflow",-1);
1112 }else if( p->approx ){
1113 sqlite3_result_double(context, p->rSum);
drhc2bd9132005-09-08 20:37:43 +00001114 }else{
drh8c08e862006-02-11 17:34:00 +00001115 sqlite3_result_int64(context, p->iSum);
drhc2bd9132005-09-08 20:37:43 +00001116 }
drh3d1d95e2005-09-08 10:37:01 +00001117 }
drhdd5baa92002-02-27 19:50:59 +00001118}
danielk19770ae8b832004-05-25 12:05:56 +00001119static void avgFinalize(sqlite3_context *context){
drhdd5baa92002-02-27 19:50:59 +00001120 SumCtx *p;
drhabfcea22005-09-06 20:36:48 +00001121 p = sqlite3_aggregate_context(context, 0);
drh739105c2002-05-29 23:22:23 +00001122 if( p && p->cnt>0 ){
drh8c08e862006-02-11 17:34:00 +00001123 sqlite3_result_double(context, p->rSum/(double)p->cnt);
drhdd5baa92002-02-27 19:50:59 +00001124 }
1125}
drha97fdd32006-01-12 22:17:50 +00001126static void totalFinalize(sqlite3_context *context){
1127 SumCtx *p;
1128 p = sqlite3_aggregate_context(context, 0);
drh8c08e862006-02-11 17:34:00 +00001129 sqlite3_result_double(context, p ? p->rSum : 0.0);
drha97fdd32006-01-12 22:17:50 +00001130}
drhdd5baa92002-02-27 19:50:59 +00001131
1132/*
drh0bce8352002-02-28 00:41:10 +00001133** The following structure keeps track of state information for the
1134** count() aggregate function.
1135*/
1136typedef struct CountCtx CountCtx;
1137struct CountCtx {
drhfc6ad392006-02-09 13:38:19 +00001138 i64 n;
drh0bce8352002-02-28 00:41:10 +00001139};
drhdd5baa92002-02-27 19:50:59 +00001140
drh0bce8352002-02-28 00:41:10 +00001141/*
1142** Routines to implement the count() aggregate function.
1143*/
danielk19770ae8b832004-05-25 12:05:56 +00001144static void countStep(sqlite3_context *context, int argc, sqlite3_value **argv){
drh0bce8352002-02-28 00:41:10 +00001145 CountCtx *p;
drh4f26d6c2004-05-26 23:25:30 +00001146 p = sqlite3_aggregate_context(context, sizeof(*p));
drh9c054832004-05-31 18:51:57 +00001147 if( (argc==0 || SQLITE_NULL!=sqlite3_value_type(argv[0])) && p ){
drh0bce8352002-02-28 00:41:10 +00001148 p->n++;
1149 }
1150}
danielk19770ae8b832004-05-25 12:05:56 +00001151static void countFinalize(sqlite3_context *context){
drh0bce8352002-02-28 00:41:10 +00001152 CountCtx *p;
drhabfcea22005-09-06 20:36:48 +00001153 p = sqlite3_aggregate_context(context, 0);
drhfc6ad392006-02-09 13:38:19 +00001154 sqlite3_result_int64(context, p ? p->n : 0);
drh0bce8352002-02-28 00:41:10 +00001155}
1156
1157/*
drh0bce8352002-02-28 00:41:10 +00001158** Routines to implement min() and max() aggregate functions.
1159*/
danielk197762c14b32008-11-19 09:05:26 +00001160static void minmaxStep(
1161 sqlite3_context *context,
1162 int NotUsed,
1163 sqlite3_value **argv
1164){
danielk197788208052004-05-25 01:13:20 +00001165 Mem *pArg = (Mem *)argv[0];
drh9eb516c2004-07-18 20:52:32 +00001166 Mem *pBest;
danielk197762c14b32008-11-19 09:05:26 +00001167 UNUSED_PARAMETER(NotUsed);
drh9eb516c2004-07-18 20:52:32 +00001168
1169 if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
1170 pBest = (Mem *)sqlite3_aggregate_context(context, sizeof(*pBest));
danielk19773aeab9e2004-06-24 00:20:04 +00001171 if( !pBest ) return;
drh268380c2004-02-25 13:47:31 +00001172
danielk197788208052004-05-25 01:13:20 +00001173 if( pBest->flags ){
drh9eb516c2004-07-18 20:52:32 +00001174 int max;
1175 int cmp;
danielk1977dc1bdc42004-06-11 10:51:27 +00001176 CollSeq *pColl = sqlite3GetFuncCollSeq(context);
danielk19777e18c252004-05-25 11:47:24 +00001177 /* This step function is used for both the min() and max() aggregates,
1178 ** the only difference between the two being that the sense of the
1179 ** comparison is inverted. For the max() aggregate, the
1180 ** sqlite3_user_data() function returns (void *)-1. For min() it
1181 ** returns (void *)db, where db is the sqlite3* database pointer.
1182 ** Therefore the next statement sets variable 'max' to 1 for the max()
1183 ** aggregate, or 0 for min().
1184 */
drh309b3382007-03-17 17:52:42 +00001185 max = sqlite3_user_data(context)!=0;
danielk1977dc1bdc42004-06-11 10:51:27 +00001186 cmp = sqlite3MemCompare(pBest, pArg, pColl);
danielk197788208052004-05-25 01:13:20 +00001187 if( (max && cmp<0) || (!max && cmp>0) ){
drhb21c8cd2007-08-21 19:33:56 +00001188 sqlite3VdbeMemCopy(pBest, pArg);
danielk197788208052004-05-25 01:13:20 +00001189 }
drh268380c2004-02-25 13:47:31 +00001190 }else{
drhb21c8cd2007-08-21 19:33:56 +00001191 sqlite3VdbeMemCopy(pBest, pArg);
drh0bce8352002-02-28 00:41:10 +00001192 }
1193}
danielk19770ae8b832004-05-25 12:05:56 +00001194static void minMaxFinalize(sqlite3_context *context){
danielk197788208052004-05-25 01:13:20 +00001195 sqlite3_value *pRes;
drhabfcea22005-09-06 20:36:48 +00001196 pRes = (sqlite3_value *)sqlite3_aggregate_context(context, 0);
1197 if( pRes ){
1198 if( pRes->flags ){
1199 sqlite3_result_value(context, pRes);
1200 }
1201 sqlite3VdbeMemRelease(pRes);
drh0bce8352002-02-28 00:41:10 +00001202 }
1203}
drhdd5baa92002-02-27 19:50:59 +00001204
drhb0689692007-11-01 17:38:30 +00001205/*
1206** group_concat(EXPR, ?SEPARATOR?)
1207*/
1208static void groupConcatStep(
1209 sqlite3_context *context,
1210 int argc,
1211 sqlite3_value **argv
1212){
1213 const char *zVal;
drhade86482007-11-28 22:36:40 +00001214 StrAccum *pAccum;
drhb0689692007-11-01 17:38:30 +00001215 const char *zSep;
drh07d31172009-02-02 21:57:05 +00001216 int nVal, nSep;
1217 assert( argc==1 || argc==2 );
1218 if( sqlite3_value_type(argv[0])==SQLITE_NULL ) return;
drhade86482007-11-28 22:36:40 +00001219 pAccum = (StrAccum*)sqlite3_aggregate_context(context, sizeof(*pAccum));
1220
1221 if( pAccum ){
drhbb4957f2008-03-20 14:03:29 +00001222 sqlite3 *db = sqlite3_context_db_handle(context);
drhade86482007-11-28 22:36:40 +00001223 pAccum->useMalloc = 1;
drhbb4957f2008-03-20 14:03:29 +00001224 pAccum->mxAlloc = db->aLimit[SQLITE_LIMIT_LENGTH];
drhade86482007-11-28 22:36:40 +00001225 if( pAccum->nChar ){
drh07d31172009-02-02 21:57:05 +00001226 if( argc==2 ){
1227 zSep = (char*)sqlite3_value_text(argv[1]);
1228 nSep = sqlite3_value_bytes(argv[1]);
drhb0689692007-11-01 17:38:30 +00001229 }else{
1230 zSep = ",";
drhade86482007-11-28 22:36:40 +00001231 nSep = 1;
drhb0689692007-11-01 17:38:30 +00001232 }
drhade86482007-11-28 22:36:40 +00001233 sqlite3StrAccumAppend(pAccum, zSep, nSep);
drhb0689692007-11-01 17:38:30 +00001234 }
drh07d31172009-02-02 21:57:05 +00001235 zVal = (char*)sqlite3_value_text(argv[0]);
1236 nVal = sqlite3_value_bytes(argv[0]);
1237 sqlite3StrAccumAppend(pAccum, zVal, nVal);
drhb0689692007-11-01 17:38:30 +00001238 }
1239}
1240static void groupConcatFinalize(sqlite3_context *context){
drhade86482007-11-28 22:36:40 +00001241 StrAccum *pAccum;
1242 pAccum = sqlite3_aggregate_context(context, 0);
1243 if( pAccum ){
1244 if( pAccum->tooBig ){
1245 sqlite3_result_error_toobig(context);
1246 }else if( pAccum->mallocFailed ){
1247 sqlite3_result_error_nomem(context);
1248 }else{
1249 sqlite3_result_text(context, sqlite3StrAccumFinish(pAccum), -1,
1250 sqlite3_free);
1251 }
drhb0689692007-11-01 17:38:30 +00001252 }
1253}
drh4e5ffc52004-08-31 00:52:37 +00001254
drhd3a149e2002-02-24 17:12:53 +00001255/*
drha2ed5602002-02-26 23:55:31 +00001256** This function registered all of the above C functions as SQL
1257** functions. This should be the only routine in this file with
1258** external linkage.
drhdc04c582002-02-24 01:55:15 +00001259*/
drh9bb575f2004-09-06 17:24:11 +00001260void sqlite3RegisterBuiltinFunctions(sqlite3 *db){
drh1f01ec12005-02-15 21:36:18 +00001261#ifndef SQLITE_OMIT_ALTERTABLE
1262 sqlite3AlterFunctions(db);
1263#endif
danielk19771e536952007-08-16 10:09:01 +00001264 if( !db->mallocFailed ){
danielk1977832a58a2007-06-22 15:21:15 +00001265 int rc = sqlite3_overload_function(db, "MATCH", 2);
1266 assert( rc==SQLITE_NOMEM || rc==SQLITE_OK );
1267 if( rc==SQLITE_NOMEM ){
danielk19771e536952007-08-16 10:09:01 +00001268 db->mallocFailed = 1;
danielk1977832a58a2007-06-22 15:21:15 +00001269 }
1270 }
danielk1977fd9e1f32005-05-22 10:44:34 +00001271#ifdef SQLITE_SSE
drh37527852006-03-16 16:19:56 +00001272 (void)sqlite3SseFunctions(db);
danielk1977fd9e1f32005-05-22 10:44:34 +00001273#endif
drh55ef4d92005-08-14 01:20:37 +00001274}
1275
1276/*
1277** Set the LIKEOPT flag on the 2-argument function with the given name.
1278*/
drh1bd10f82008-12-10 21:19:56 +00001279static void setLikeOptFlag(sqlite3 *db, const char *zName, u8 flagVal){
drh55ef4d92005-08-14 01:20:37 +00001280 FuncDef *pDef;
drhea678832008-12-10 19:26:22 +00001281 pDef = sqlite3FindFunction(db, zName, sqlite3Strlen30(zName),
1282 2, SQLITE_UTF8, 0);
drh55ef4d92005-08-14 01:20:37 +00001283 if( pDef ){
drhd64fe2f2005-08-28 17:00:23 +00001284 pDef->flags = flagVal;
drh55ef4d92005-08-14 01:20:37 +00001285 }
1286}
1287
1288/*
1289** Register the built-in LIKE and GLOB functions. The caseSensitive
1290** parameter determines whether or not the LIKE operator is case
1291** sensitive. GLOB is always case sensitive.
1292*/
1293void sqlite3RegisterLikeFunctions(sqlite3 *db, int caseSensitive){
1294 struct compareInfo *pInfo;
1295 if( caseSensitive ){
1296 pInfo = (struct compareInfo*)&likeInfoAlt;
1297 }else{
1298 pInfo = (struct compareInfo*)&likeInfoNorm;
1299 }
danielk1977771151b2006-01-17 13:21:40 +00001300 sqlite3CreateFunc(db, "like", 2, SQLITE_UTF8, pInfo, likeFunc, 0, 0);
1301 sqlite3CreateFunc(db, "like", 3, SQLITE_UTF8, pInfo, likeFunc, 0, 0);
1302 sqlite3CreateFunc(db, "glob", 2, SQLITE_UTF8,
drh55ef4d92005-08-14 01:20:37 +00001303 (struct compareInfo*)&globInfo, likeFunc, 0,0);
drhd64fe2f2005-08-28 17:00:23 +00001304 setLikeOptFlag(db, "glob", SQLITE_FUNC_LIKE | SQLITE_FUNC_CASE);
1305 setLikeOptFlag(db, "like",
1306 caseSensitive ? (SQLITE_FUNC_LIKE | SQLITE_FUNC_CASE) : SQLITE_FUNC_LIKE);
drh55ef4d92005-08-14 01:20:37 +00001307}
1308
1309/*
1310** pExpr points to an expression which implements a function. If
1311** it is appropriate to apply the LIKE optimization to that function
1312** then set aWc[0] through aWc[2] to the wildcard characters and
1313** return TRUE. If the function is not a LIKE-style function then
1314** return FALSE.
1315*/
drhd64fe2f2005-08-28 17:00:23 +00001316int sqlite3IsLikeFunction(sqlite3 *db, Expr *pExpr, int *pIsNocase, char *aWc){
drh55ef4d92005-08-14 01:20:37 +00001317 FuncDef *pDef;
danielk1977cdbd8ef2007-05-12 06:11:12 +00001318 if( pExpr->op!=TK_FUNCTION || !pExpr->pList ){
drh55ef4d92005-08-14 01:20:37 +00001319 return 0;
1320 }
1321 if( pExpr->pList->nExpr!=2 ){
1322 return 0;
1323 }
drh2646da72005-12-09 20:02:05 +00001324 pDef = sqlite3FindFunction(db, (char*)pExpr->token.z, pExpr->token.n, 2,
drh55ef4d92005-08-14 01:20:37 +00001325 SQLITE_UTF8, 0);
drhd64fe2f2005-08-28 17:00:23 +00001326 if( pDef==0 || (pDef->flags & SQLITE_FUNC_LIKE)==0 ){
drh55ef4d92005-08-14 01:20:37 +00001327 return 0;
1328 }
1329
1330 /* The memcpy() statement assumes that the wildcard characters are
1331 ** the first three statements in the compareInfo structure. The
1332 ** asserts() that follow verify that assumption
1333 */
1334 memcpy(aWc, pDef->pUserData, 3);
1335 assert( (char*)&likeInfoAlt == (char*)&likeInfoAlt.matchAll );
1336 assert( &((char*)&likeInfoAlt)[1] == (char*)&likeInfoAlt.matchOne );
1337 assert( &((char*)&likeInfoAlt)[2] == (char*)&likeInfoAlt.matchSet );
drhd64fe2f2005-08-28 17:00:23 +00001338 *pIsNocase = (pDef->flags & SQLITE_FUNC_CASE)==0;
drh55ef4d92005-08-14 01:20:37 +00001339 return 1;
drhdc04c582002-02-24 01:55:15 +00001340}
danielk19778c0a7912008-08-20 14:49:23 +00001341
drh70a8ca32008-08-21 18:49:27 +00001342/*
drh777c5382008-08-21 20:21:34 +00001343** All all of the FuncDef structures in the aBuiltinFunc[] array above
1344** to the global function hash table. This occurs at start-time (as
1345** a consequence of calling sqlite3_initialize()).
1346**
1347** After this routine runs
drh70a8ca32008-08-21 18:49:27 +00001348*/
1349void sqlite3RegisterGlobalFunctions(void){
danielk197793ce7412008-09-01 19:14:02 +00001350 /*
1351 ** The following array holds FuncDef structures for all of the functions
1352 ** defined in this file.
1353 **
1354 ** The array cannot be constant since changes are made to the
1355 ** FuncDef.pHash elements at start-time. The elements of this array
1356 ** are read-only after initialization is complete.
1357 */
1358 static SQLITE_WSD FuncDef aBuiltinFunc[] = {
1359 FUNCTION(ltrim, 1, 1, 0, trimFunc ),
1360 FUNCTION(ltrim, 2, 1, 0, trimFunc ),
1361 FUNCTION(rtrim, 1, 2, 0, trimFunc ),
1362 FUNCTION(rtrim, 2, 2, 0, trimFunc ),
1363 FUNCTION(trim, 1, 3, 0, trimFunc ),
1364 FUNCTION(trim, 2, 3, 0, trimFunc ),
1365 FUNCTION(min, -1, 0, 1, minmaxFunc ),
1366 FUNCTION(min, 0, 0, 1, 0 ),
1367 AGGREGATE(min, 1, 0, 1, minmaxStep, minMaxFinalize ),
1368 FUNCTION(max, -1, 1, 1, minmaxFunc ),
1369 FUNCTION(max, 0, 1, 1, 0 ),
1370 AGGREGATE(max, 1, 1, 1, minmaxStep, minMaxFinalize ),
1371 FUNCTION(typeof, 1, 0, 0, typeofFunc ),
1372 FUNCTION(length, 1, 0, 0, lengthFunc ),
1373 FUNCTION(substr, 2, 0, 0, substrFunc ),
1374 FUNCTION(substr, 3, 0, 0, substrFunc ),
1375 FUNCTION(abs, 1, 0, 0, absFunc ),
1376 FUNCTION(round, 1, 0, 0, roundFunc ),
1377 FUNCTION(round, 2, 0, 0, roundFunc ),
1378 FUNCTION(upper, 1, 0, 0, upperFunc ),
1379 FUNCTION(lower, 1, 0, 0, lowerFunc ),
1380 FUNCTION(coalesce, 1, 0, 0, 0 ),
1381 FUNCTION(coalesce, -1, 0, 0, ifnullFunc ),
1382 FUNCTION(coalesce, 0, 0, 0, 0 ),
1383 FUNCTION(hex, 1, 0, 0, hexFunc ),
1384 FUNCTION(ifnull, 2, 0, 1, ifnullFunc ),
drh9373b012009-02-02 01:50:39 +00001385 FUNCTION(random, 0, 0, 0, randomFunc ),
danielk197793ce7412008-09-01 19:14:02 +00001386 FUNCTION(randomblob, 1, 0, 0, randomBlob ),
1387 FUNCTION(nullif, 2, 0, 1, nullifFunc ),
1388 FUNCTION(sqlite_version, 0, 0, 0, versionFunc ),
1389 FUNCTION(quote, 1, 0, 0, quoteFunc ),
1390 FUNCTION(last_insert_rowid, 0, 0, 0, last_insert_rowid),
1391 FUNCTION(changes, 0, 0, 0, changes ),
1392 FUNCTION(total_changes, 0, 0, 0, total_changes ),
1393 FUNCTION(replace, 3, 0, 0, replaceFunc ),
1394 FUNCTION(zeroblob, 1, 0, 0, zeroblobFunc ),
1395 #ifdef SQLITE_SOUNDEX
1396 FUNCTION(soundex, 1, 0, 0, soundexFunc ),
1397 #endif
1398 #ifndef SQLITE_OMIT_LOAD_EXTENSION
1399 FUNCTION(load_extension, 1, 0, 0, loadExt ),
1400 FUNCTION(load_extension, 2, 0, 0, loadExt ),
1401 #endif
1402 AGGREGATE(sum, 1, 0, 0, sumStep, sumFinalize ),
1403 AGGREGATE(total, 1, 0, 0, sumStep, totalFinalize ),
1404 AGGREGATE(avg, 1, 0, 0, sumStep, avgFinalize ),
1405 AGGREGATE(count, 0, 0, 0, countStep, countFinalize ),
1406 AGGREGATE(count, 1, 0, 0, countStep, countFinalize ),
drh07d31172009-02-02 21:57:05 +00001407 AGGREGATE(group_concat, 1, 0, 0, groupConcatStep, groupConcatFinalize),
1408 AGGREGATE(group_concat, 2, 0, 0, groupConcatStep, groupConcatFinalize),
danielk197793ce7412008-09-01 19:14:02 +00001409
1410 LIKEFUNC(glob, 2, &globInfo, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
1411 #ifdef SQLITE_CASE_SENSITIVE_LIKE
1412 LIKEFUNC(like, 2, &likeInfoAlt, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
1413 LIKEFUNC(like, 3, &likeInfoAlt, SQLITE_FUNC_LIKE|SQLITE_FUNC_CASE),
1414 #else
1415 LIKEFUNC(like, 2, &likeInfoNorm, SQLITE_FUNC_LIKE),
1416 LIKEFUNC(like, 3, &likeInfoNorm, SQLITE_FUNC_LIKE),
1417 #endif
1418 };
1419
drh70a8ca32008-08-21 18:49:27 +00001420 int i;
danielk197793ce7412008-09-01 19:14:02 +00001421 FuncDefHash *pHash = &GLOBAL(FuncDefHash, sqlite3GlobalFunctions);
drh106cee52008-09-03 17:11:16 +00001422 FuncDef *aFunc = (FuncDef*)&GLOBAL(FuncDef, aBuiltinFunc);
danielk197793ce7412008-09-01 19:14:02 +00001423
drh70a8ca32008-08-21 18:49:27 +00001424 for(i=0; i<ArraySize(aBuiltinFunc); i++){
danielk197793ce7412008-09-01 19:14:02 +00001425 sqlite3FuncDefInsert(pHash, &aFunc[i]);
drh70a8ca32008-08-21 18:49:27 +00001426 }
drh777c5382008-08-21 20:21:34 +00001427 sqlite3RegisterDateTimeFunctions();
drh70a8ca32008-08-21 18:49:27 +00001428}