1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
* vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
4
* Copyright (C) 2008 Sun Microsystems
6
* This program is free software; you can redistribute it and/or modify
7
* it under the terms of the GNU General Public License as published by
8
* the Free Software Foundation; version 2 of the License.
10
* This program is distributed in the hope that it will be useful,
11
* but WITHOUT ANY WARRANTY; without even the implied warranty of
12
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13
* GNU General Public License for more details.
15
* You should have received a copy of the GNU General Public License
16
* along with this program; if not, write to the Free Software
17
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21
/* This file defines all string functions */
23
#ifdef USE_PRAGMA_INTERFACE
24
#pragma interface /* gcc class implementation */
27
class Item_str_func :public Item_func
30
Item_str_func() :Item_func() { decimals=NOT_FIXED_DEC; }
31
Item_str_func(Item *a) :Item_func(a) {decimals=NOT_FIXED_DEC; }
32
Item_str_func(Item *a,Item *b) :Item_func(a,b) { decimals=NOT_FIXED_DEC; }
33
Item_str_func(Item *a,Item *b,Item *c) :Item_func(a,b,c) { decimals=NOT_FIXED_DEC; }
34
Item_str_func(Item *a,Item *b,Item *c,Item *d) :Item_func(a,b,c,d) {decimals=NOT_FIXED_DEC; }
35
Item_str_func(Item *a,Item *b,Item *c,Item *d, Item* e) :Item_func(a,b,c,d,e) {decimals=NOT_FIXED_DEC; }
36
Item_str_func(List<Item> &list) :Item_func(list) {decimals=NOT_FIXED_DEC; }
39
my_decimal *val_decimal(my_decimal *);
40
enum Item_result result_type () const { return STRING_RESULT; }
41
void left_right_max_length();
42
bool fix_fields(THD *thd, Item **ref);
46
class Item_func_concat :public Item_str_func
50
Item_func_concat(List<Item> &list) :Item_str_func(list) {}
51
Item_func_concat(Item *a,Item *b) :Item_str_func(a,b) {}
52
String *val_str(String *);
53
void fix_length_and_dec();
54
const char *func_name() const { return "concat"; }
57
class Item_func_concat_ws :public Item_str_func
61
Item_func_concat_ws(List<Item> &list) :Item_str_func(list) {}
62
String *val_str(String *);
63
void fix_length_and_dec();
64
const char *func_name() const { return "concat_ws"; }
65
table_map not_null_tables() const { return 0; }
68
class Item_func_reverse :public Item_str_func
72
Item_func_reverse(Item *a) :Item_str_func(a) {}
73
String *val_str(String *);
74
void fix_length_and_dec();
75
const char *func_name() const { return "reverse"; }
79
class Item_func_replace :public Item_str_func
81
String tmp_value,tmp_value2;
83
Item_func_replace(Item *org,Item *find,Item *replace)
84
:Item_str_func(org,find,replace) {}
85
String *val_str(String *);
86
void fix_length_and_dec();
87
const char *func_name() const { return "replace"; }
91
class Item_func_insert :public Item_str_func
95
Item_func_insert(Item *org,Item *start,Item *length,Item *new_str)
96
:Item_str_func(org,start,length,new_str) {}
97
String *val_str(String *);
98
void fix_length_and_dec();
99
const char *func_name() const { return "insert"; }
103
class Item_str_conv :public Item_str_func
107
my_charset_conv_case converter;
110
Item_str_conv(Item *item) :Item_str_func(item) {}
111
String *val_str(String *);
115
class Item_func_lcase :public Item_str_conv
118
Item_func_lcase(Item *item) :Item_str_conv(item) {}
119
const char *func_name() const { return "lcase"; }
120
void fix_length_and_dec();
123
class Item_func_ucase :public Item_str_conv
126
Item_func_ucase(Item *item) :Item_str_conv(item) {}
127
const char *func_name() const { return "ucase"; }
128
void fix_length_and_dec();
132
class Item_func_left :public Item_str_func
136
Item_func_left(Item *a,Item *b) :Item_str_func(a,b) {}
137
String *val_str(String *);
138
void fix_length_and_dec();
139
const char *func_name() const { return "left"; }
143
class Item_func_right :public Item_str_func
147
Item_func_right(Item *a,Item *b) :Item_str_func(a,b) {}
148
String *val_str(String *);
149
void fix_length_and_dec();
150
const char *func_name() const { return "right"; }
154
class Item_func_substr :public Item_str_func
158
Item_func_substr(Item *a,Item *b) :Item_str_func(a,b) {}
159
Item_func_substr(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
160
String *val_str(String *);
161
void fix_length_and_dec();
162
const char *func_name() const { return "substr"; }
166
class Item_func_substr_index :public Item_str_func
170
Item_func_substr_index(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
171
String *val_str(String *);
172
void fix_length_and_dec();
173
const char *func_name() const { return "substring_index"; }
177
class Item_func_trim :public Item_str_func
183
Item_func_trim(Item *a,Item *b) :Item_str_func(a,b) {}
184
Item_func_trim(Item *a) :Item_str_func(a) {}
185
String *val_str(String *);
186
void fix_length_and_dec();
187
const char *func_name() const { return "trim"; }
188
virtual void print(String *str, enum_query_type query_type);
189
virtual const char *mode_name() const { return "both"; }
193
class Item_func_ltrim :public Item_func_trim
196
Item_func_ltrim(Item *a,Item *b) :Item_func_trim(a,b) {}
197
Item_func_ltrim(Item *a) :Item_func_trim(a) {}
198
String *val_str(String *);
199
const char *func_name() const { return "ltrim"; }
200
const char *mode_name() const { return "leading"; }
204
class Item_func_rtrim :public Item_func_trim
207
Item_func_rtrim(Item *a,Item *b) :Item_func_trim(a,b) {}
208
Item_func_rtrim(Item *a) :Item_func_trim(a) {}
209
String *val_str(String *);
210
const char *func_name() const { return "rtrim"; }
211
const char *mode_name() const { return "trailing"; }
215
class Item_func_sysconst :public Item_str_func
219
{ collation.set(system_charset_info,DERIVATION_SYSCONST); }
220
Item *safe_charset_converter(const CHARSET_INFO * const tocs);
222
Used to create correct Item name in new converted item in
223
safe_charset_converter, return string representation of this function
226
virtual const char *fully_qualified_func_name() const = 0;
230
class Item_func_database :public Item_func_sysconst
233
Item_func_database() :Item_func_sysconst() {}
234
String *val_str(String *);
235
void fix_length_and_dec()
237
max_length= MAX_FIELD_NAME * system_charset_info->mbmaxlen;
240
const char *func_name() const { return "database"; }
241
const char *fully_qualified_func_name() const { return "database()"; }
245
class Item_func_user :public Item_func_sysconst
248
bool init (const char *user, const char *host);
253
str_value.set("", 0, system_charset_info);
255
String *val_str(String *)
258
return (null_value ? 0 : &str_value);
260
bool fix_fields(THD *thd, Item **ref);
261
void fix_length_and_dec()
263
max_length= (USERNAME_CHAR_LENGTH + HOSTNAME_LENGTH + 1) *
264
system_charset_info->mbmaxlen;
266
const char *func_name() const { return "user"; }
267
const char *fully_qualified_func_name() const { return "user()"; }
268
int save_in_field(Field *field,
269
bool no_conversions __attribute__((unused)))
271
return save_str_value_in_field(field, &str_value);
276
class Item_func_current_user :public Item_func_user
278
Name_resolution_context *context;
281
Item_func_current_user(Name_resolution_context *context_arg)
282
: context(context_arg) {}
283
bool fix_fields(THD *thd, Item **ref);
284
const char *func_name() const { return "current_user"; }
285
const char *fully_qualified_func_name() const { return "current_user()"; }
289
class Item_func_soundex :public Item_str_func
293
Item_func_soundex(Item *a) :Item_str_func(a) {}
294
String *val_str(String *);
295
void fix_length_and_dec();
296
const char *func_name() const { return "soundex"; }
300
class Item_func_elt :public Item_str_func
303
Item_func_elt(List<Item> &list) :Item_str_func(list) {}
306
String *val_str(String *str);
307
void fix_length_and_dec();
308
const char *func_name() const { return "elt"; }
312
class Item_func_make_set :public Item_str_func
318
Item_func_make_set(Item *a,List<Item> &list) :Item_str_func(list),item(a) {}
319
String *val_str(String *str);
320
bool fix_fields(THD *thd, Item **ref)
323
return ((!item->fixed && item->fix_fields(thd, &item)) ||
324
item->check_cols(1) ||
325
Item_func::fix_fields(thd, ref));
327
void split_sum_func(THD *thd, Item **ref_pointer_array, List<Item> &fields);
328
void fix_length_and_dec();
329
void update_used_tables();
330
const char *func_name() const { return "make_set"; }
332
bool walk(Item_processor processor, bool walk_subquery, unsigned char *arg)
334
return item->walk(processor, walk_subquery, arg) ||
335
Item_str_func::walk(processor, walk_subquery, arg);
337
Item *transform(Item_transformer transformer, unsigned char *arg);
338
virtual void print(String *str, enum_query_type query_type);
342
class Item_func_format :public Item_str_func
346
Item_func_format(Item *org, Item *dec);
347
String *val_str(String *);
348
void fix_length_and_dec();
349
const char *func_name() const { return "format"; }
350
virtual void print(String *str, enum_query_type query_type);
354
class Item_func_char :public Item_str_func
357
Item_func_char(List<Item> &list) :Item_str_func(list)
358
{ collation.set(&my_charset_bin); }
359
Item_func_char(List<Item> &list, const CHARSET_INFO * const cs) :Item_str_func(list)
360
{ collation.set(cs); }
361
String *val_str(String *);
362
void fix_length_and_dec()
364
max_length= arg_count * 4;
366
const char *func_name() const { return "char"; }
370
class Item_func_repeat :public Item_str_func
374
Item_func_repeat(Item *arg1,Item *arg2) :Item_str_func(arg1,arg2) {}
375
String *val_str(String *);
376
void fix_length_and_dec();
377
const char *func_name() const { return "repeat"; }
381
class Item_func_rpad :public Item_str_func
383
String tmp_value, rpad_str;
385
Item_func_rpad(Item *arg1,Item *arg2,Item *arg3)
386
:Item_str_func(arg1,arg2,arg3) {}
387
String *val_str(String *);
388
void fix_length_and_dec();
389
const char *func_name() const { return "rpad"; }
393
class Item_func_lpad :public Item_str_func
395
String tmp_value, lpad_str;
397
Item_func_lpad(Item *arg1,Item *arg2,Item *arg3)
398
:Item_str_func(arg1,arg2,arg3) {}
399
String *val_str(String *);
400
void fix_length_and_dec();
401
const char *func_name() const { return "lpad"; }
405
class Item_func_conv :public Item_str_func
408
Item_func_conv(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
409
const char *func_name() const { return "conv"; }
410
String *val_str(String *);
411
void fix_length_and_dec()
413
collation.set(default_charset());
420
class Item_func_hex :public Item_str_func
424
Item_func_hex(Item *a) :Item_str_func(a) {}
425
const char *func_name() const { return "hex"; }
426
String *val_str(String *);
427
void fix_length_and_dec()
429
collation.set(default_charset());
431
max_length=args[0]->max_length*2*collation.collation->mbmaxlen;
435
class Item_func_unhex :public Item_str_func
439
Item_func_unhex(Item *a) :Item_str_func(a)
441
/* there can be bad hex strings */
444
const char *func_name() const { return "unhex"; }
445
String *val_str(String *);
446
void fix_length_and_dec()
448
collation.set(&my_charset_bin);
450
max_length=(1+args[0]->max_length)/2;
455
class Item_func_binary :public Item_str_func
458
Item_func_binary(Item *a) :Item_str_func(a) {}
459
String *val_str(String *a)
462
String *tmp=args[0]->val_str(a);
463
null_value=args[0]->null_value;
465
tmp->set_charset(&my_charset_bin);
468
void fix_length_and_dec()
470
collation.set(&my_charset_bin);
471
max_length=args[0]->max_length;
473
virtual void print(String *str, enum_query_type query_type);
474
const char *func_name() const { return "cast_as_binary"; }
478
class Item_load_file :public Item_str_func
482
Item_load_file(Item *a) :Item_str_func(a) {}
483
String *val_str(String *);
484
const char *func_name() const { return "load_file"; }
485
void fix_length_and_dec()
487
collation.set(&my_charset_bin, DERIVATION_COERCIBLE);
489
max_length=MAX_BLOB_WIDTH;
494
class Item_func_export_set: public Item_str_func
497
Item_func_export_set(Item *a,Item *b,Item* c) :Item_str_func(a,b,c) {}
498
Item_func_export_set(Item *a,Item *b,Item* c,Item* d) :Item_str_func(a,b,c,d) {}
499
Item_func_export_set(Item *a,Item *b,Item* c,Item* d,Item* e) :Item_str_func(a,b,c,d,e) {}
500
String *val_str(String *str);
501
void fix_length_and_dec();
502
const char *func_name() const { return "export_set"; }
505
class Item_func_quote :public Item_str_func
509
Item_func_quote(Item *a) :Item_str_func(a) {}
510
const char *func_name() const { return "quote"; }
511
String *val_str(String *);
512
void fix_length_and_dec()
514
collation.set(args[0]->collation);
515
max_length= args[0]->max_length * 2 + 2;
519
class Item_func_conv_charset :public Item_str_func
521
bool use_cached_value;
524
const CHARSET_INFO *conv_charset; // keep it public
525
Item_func_conv_charset(Item *a, const CHARSET_INFO * const cs) :Item_str_func(a)
526
{ conv_charset= cs; use_cached_value= 0; safe= 0; }
527
Item_func_conv_charset(Item *a, const CHARSET_INFO * const cs, bool cache_if_const)
530
assert(args[0]->fixed);
532
if (cache_if_const && args[0]->const_item())
535
String tmp, *str= args[0]->val_str(&tmp);
536
if (!str || str_value.copy(str->ptr(), str->length(),
537
str->charset(), conv_charset, &errors))
540
str_value.mark_as_const();
547
Conversion from and to "binary" is safe.
548
Conversion to Unicode is safe.
549
Other kind of conversions are potentially lossy.
551
safe= (args[0]->collation.collation == &my_charset_bin ||
552
cs == &my_charset_bin ||
553
(cs->state & MY_CS_UNICODE));
556
String *val_str(String *);
557
void fix_length_and_dec();
558
const char *func_name() const { return "convert"; }
559
virtual void print(String *str, enum_query_type query_type);
562
class Item_func_set_collation :public Item_str_func
565
Item_func_set_collation(Item *a, Item *b) :Item_str_func(a,b) {};
566
String *val_str(String *);
567
void fix_length_and_dec();
568
bool eq(const Item *item, bool binary_cmp) const;
569
const char *func_name() const { return "collate"; }
570
enum Functype functype() const { return COLLATE_FUNC; }
571
virtual void print(String *str, enum_query_type query_type);
572
Item_field *filed_for_view_update()
574
/* this function is transparent for view updating */
575
return args[0]->filed_for_view_update();
579
class Item_func_charset :public Item_str_func
582
Item_func_charset(Item *a) :Item_str_func(a) {}
583
String *val_str(String *);
584
const char *func_name() const { return "charset"; }
585
void fix_length_and_dec()
587
collation.set(system_charset_info);
588
max_length= 64 * collation.collation->mbmaxlen; // should be enough
591
table_map not_null_tables() const { return 0; }
594
class Item_func_collation :public Item_str_func
597
Item_func_collation(Item *a) :Item_str_func(a) {}
598
String *val_str(String *);
599
const char *func_name() const { return "collation"; }
600
void fix_length_and_dec()
602
collation.set(system_charset_info);
603
max_length= 64 * collation.collation->mbmaxlen; // should be enough
606
table_map not_null_tables() const { return 0; }
610
class Item_func_weight_string :public Item_str_func
616
Item_func_weight_string(Item *a, uint32_t nweights_arg, uint32_t flags_arg)
617
:Item_str_func(a) { nweights= nweights_arg; flags= flags_arg; }
618
const char *func_name() const { return "weight_string"; }
619
String *val_str(String *);
620
void fix_length_and_dec();
623
#define UUID_LENGTH (8+1+4+1+4+1+4+1+12)
624
class Item_func_uuid: public Item_str_func
627
Item_func_uuid(): Item_str_func() {}
628
void fix_length_and_dec() {
629
collation.set(system_charset_info);
631
NOTE! uuid() should be changed to use 'ascii'
632
charset when hex(), format(), md5(), etc, and implicit
633
number-to-string conversion will use 'ascii'
635
max_length= UUID_LENGTH * system_charset_info->mbmaxlen;
637
const char *func_name() const{ return "uuid"; }
638
String *val_str(String *);