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
20
#ifndef DRIZZLED_ITEM_STRFUNC_H
21
#define DRIZZLED_ITEM_STRFUNC_H
23
/* This file defines all string functions */
26
class Item_str_func :public Item_func
29
Item_str_func() :Item_func() { decimals=NOT_FIXED_DEC; }
30
Item_str_func(Item *a) :Item_func(a) {decimals=NOT_FIXED_DEC; }
31
Item_str_func(Item *a,Item *b) :Item_func(a,b) { decimals=NOT_FIXED_DEC; }
32
Item_str_func(Item *a,Item *b,Item *c) :Item_func(a,b,c) { decimals=NOT_FIXED_DEC; }
33
Item_str_func(Item *a,Item *b,Item *c,Item *d) :Item_func(a,b,c,d) {decimals=NOT_FIXED_DEC; }
34
Item_str_func(Item *a,Item *b,Item *c,Item *d, Item* e) :Item_func(a,b,c,d,e) {decimals=NOT_FIXED_DEC; }
35
Item_str_func(List<Item> &list) :Item_func(list) {decimals=NOT_FIXED_DEC; }
38
my_decimal *val_decimal(my_decimal *);
39
enum Item_result result_type () const { return STRING_RESULT; }
40
void left_right_max_length();
41
bool fix_fields(Session *session, Item **ref);
45
class Item_func_concat :public Item_str_func
49
Item_func_concat(List<Item> &list) :Item_str_func(list) {}
50
Item_func_concat(Item *a,Item *b) :Item_str_func(a,b) {}
51
String *val_str(String *);
52
void fix_length_and_dec();
53
const char *func_name() const { return "concat"; }
56
class Item_func_concat_ws :public Item_str_func
60
Item_func_concat_ws(List<Item> &list) :Item_str_func(list) {}
61
String *val_str(String *);
62
void fix_length_and_dec();
63
const char *func_name() const { return "concat_ws"; }
64
table_map not_null_tables() const { return 0; }
67
class Item_func_reverse :public Item_str_func
71
Item_func_reverse(Item *a) :Item_str_func(a) {}
72
String *val_str(String *);
73
void fix_length_and_dec();
74
const char *func_name() const { return "reverse"; }
78
class Item_func_replace :public Item_str_func
80
String tmp_value,tmp_value2;
82
Item_func_replace(Item *org,Item *find,Item *replace)
83
:Item_str_func(org,find,replace) {}
84
String *val_str(String *);
85
void fix_length_and_dec();
86
const char *func_name() const { return "replace"; }
90
class Item_func_insert :public Item_str_func
94
Item_func_insert(Item *org,Item *start,Item *length,Item *new_str)
95
:Item_str_func(org,start,length,new_str) {}
96
String *val_str(String *);
97
void fix_length_and_dec();
98
const char *func_name() const { return "insert"; }
102
class Item_str_conv :public Item_str_func
106
my_charset_conv_case converter;
109
Item_str_conv(Item *item) :Item_str_func(item) {}
110
String *val_str(String *);
114
class Item_func_lcase :public Item_str_conv
117
Item_func_lcase(Item *item) :Item_str_conv(item) {}
118
const char *func_name() const { return "lcase"; }
119
void fix_length_and_dec();
122
class Item_func_ucase :public Item_str_conv
125
Item_func_ucase(Item *item) :Item_str_conv(item) {}
126
const char *func_name() const { return "ucase"; }
127
void fix_length_and_dec();
131
class Item_func_left :public Item_str_func
135
Item_func_left(Item *a,Item *b) :Item_str_func(a,b) {}
136
String *val_str(String *);
137
void fix_length_and_dec();
138
const char *func_name() const { return "left"; }
142
class Item_func_right :public Item_str_func
146
Item_func_right(Item *a,Item *b) :Item_str_func(a,b) {}
147
String *val_str(String *);
148
void fix_length_and_dec();
149
const char *func_name() const { return "right"; }
153
class Item_func_substr :public Item_str_func
157
Item_func_substr(Item *a,Item *b) :Item_str_func(a,b) {}
158
Item_func_substr(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
159
String *val_str(String *);
160
void fix_length_and_dec();
161
const char *func_name() const { return "substr"; }
165
class Item_func_substr_index :public Item_str_func
169
Item_func_substr_index(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
170
String *val_str(String *);
171
void fix_length_and_dec();
172
const char *func_name() const { return "substring_index"; }
176
class Item_func_trim :public Item_str_func
182
Item_func_trim(Item *a,Item *b) :Item_str_func(a,b) {}
183
Item_func_trim(Item *a) :Item_str_func(a) {}
184
String *val_str(String *);
185
void fix_length_and_dec();
186
const char *func_name() const { return "trim"; }
187
virtual void print(String *str, enum_query_type query_type);
188
virtual const char *mode_name() const { return "both"; }
192
class Item_func_ltrim :public Item_func_trim
195
Item_func_ltrim(Item *a,Item *b) :Item_func_trim(a,b) {}
196
Item_func_ltrim(Item *a) :Item_func_trim(a) {}
197
String *val_str(String *);
198
const char *func_name() const { return "ltrim"; }
199
const char *mode_name() const { return "leading"; }
203
class Item_func_rtrim :public Item_func_trim
206
Item_func_rtrim(Item *a,Item *b) :Item_func_trim(a,b) {}
207
Item_func_rtrim(Item *a) :Item_func_trim(a) {}
208
String *val_str(String *);
209
const char *func_name() const { return "rtrim"; }
210
const char *mode_name() const { return "trailing"; }
214
class Item_func_sysconst :public Item_str_func
218
{ collation.set(system_charset_info,DERIVATION_SYSCONST); }
219
Item *safe_charset_converter(const CHARSET_INFO * const tocs);
221
Used to create correct Item name in new converted item in
222
safe_charset_converter, return string representation of this function
225
virtual const char *fully_qualified_func_name() const = 0;
226
bool check_vcol_func_processor(unsigned char *int_arg __attribute__((unused)))
231
class Item_func_database :public Item_func_sysconst
234
Item_func_database() :Item_func_sysconst() {}
235
String *val_str(String *);
236
void fix_length_and_dec()
238
max_length= MAX_FIELD_NAME * system_charset_info->mbmaxlen;
241
const char *func_name() const { return "database"; }
242
const char *fully_qualified_func_name() const { return "database()"; }
246
class Item_func_user :public Item_func_sysconst
249
bool init (const char *user, const char *host);
254
str_value.set("", 0, system_charset_info);
256
String *val_str(String *)
259
return (null_value ? 0 : &str_value);
261
bool fix_fields(Session *session, Item **ref);
262
void fix_length_and_dec()
264
max_length= (USERNAME_CHAR_LENGTH + HOSTNAME_LENGTH + 1) *
265
system_charset_info->mbmaxlen;
267
const char *func_name() const { return "user"; }
268
const char *fully_qualified_func_name() const { return "user()"; }
269
int save_in_field(Field *field,
270
bool no_conversions __attribute__((unused)))
272
return save_str_value_in_field(field, &str_value);
277
class Item_func_current_user :public Item_func_user
279
Name_resolution_context *context;
282
Item_func_current_user(Name_resolution_context *context_arg)
283
: context(context_arg) {}
284
bool fix_fields(Session *session, Item **ref);
285
const char *func_name() const { return "current_user"; }
286
const char *fully_qualified_func_name() const { return "current_user()"; }
290
class Item_func_soundex :public Item_str_func
294
Item_func_soundex(Item *a) :Item_str_func(a) {}
295
String *val_str(String *);
296
void fix_length_and_dec();
297
const char *func_name() const { return "soundex"; }
301
class Item_func_elt :public Item_str_func
304
Item_func_elt(List<Item> &list) :Item_str_func(list) {}
307
String *val_str(String *str);
308
void fix_length_and_dec();
309
const char *func_name() const { return "elt"; }
313
class Item_func_make_set :public Item_str_func
319
Item_func_make_set(Item *a,List<Item> &list) :Item_str_func(list),item(a) {}
320
String *val_str(String *str);
321
bool fix_fields(Session *session, Item **ref)
324
return ((!item->fixed && item->fix_fields(session, &item)) ||
325
item->check_cols(1) ||
326
Item_func::fix_fields(session, ref));
328
void split_sum_func(Session *session, Item **ref_pointer_array, List<Item> &fields);
329
void fix_length_and_dec();
330
void update_used_tables();
331
const char *func_name() const { return "make_set"; }
333
bool walk(Item_processor processor, bool walk_subquery, unsigned char *arg)
335
return item->walk(processor, walk_subquery, arg) ||
336
Item_str_func::walk(processor, walk_subquery, arg);
338
Item *transform(Item_transformer transformer, unsigned char *arg);
339
virtual void print(String *str, enum_query_type query_type);
343
class Item_func_format :public Item_str_func
347
Item_func_format(Item *org, Item *dec);
348
String *val_str(String *);
349
void fix_length_and_dec();
350
const char *func_name() const { return "format"; }
351
virtual void print(String *str, enum_query_type query_type);
355
class Item_func_char :public Item_str_func
358
Item_func_char(List<Item> &list) :Item_str_func(list)
359
{ collation.set(&my_charset_bin); }
360
Item_func_char(List<Item> &list, const CHARSET_INFO * const cs) :Item_str_func(list)
361
{ collation.set(cs); }
362
String *val_str(String *);
363
void fix_length_and_dec()
365
max_length= arg_count * 4;
367
const char *func_name() const { return "char"; }
371
class Item_func_repeat :public Item_str_func
375
Item_func_repeat(Item *arg1,Item *arg2) :Item_str_func(arg1,arg2) {}
376
String *val_str(String *);
377
void fix_length_and_dec();
378
const char *func_name() const { return "repeat"; }
382
class Item_func_rpad :public Item_str_func
384
String tmp_value, rpad_str;
386
Item_func_rpad(Item *arg1,Item *arg2,Item *arg3)
387
:Item_str_func(arg1,arg2,arg3) {}
388
String *val_str(String *);
389
void fix_length_and_dec();
390
const char *func_name() const { return "rpad"; }
394
class Item_func_lpad :public Item_str_func
396
String tmp_value, lpad_str;
398
Item_func_lpad(Item *arg1,Item *arg2,Item *arg3)
399
:Item_str_func(arg1,arg2,arg3) {}
400
String *val_str(String *);
401
void fix_length_and_dec();
402
const char *func_name() const { return "lpad"; }
406
class Item_func_conv :public Item_str_func
409
Item_func_conv(Item *a,Item *b,Item *c) :Item_str_func(a,b,c) {}
410
const char *func_name() const { return "conv"; }
411
String *val_str(String *);
412
void fix_length_and_dec()
414
collation.set(default_charset());
421
class Item_func_hex :public Item_str_func
425
Item_func_hex(Item *a) :Item_str_func(a) {}
426
const char *func_name() const { return "hex"; }
427
String *val_str(String *);
428
void fix_length_and_dec()
430
collation.set(default_charset());
432
max_length=args[0]->max_length*2*collation.collation->mbmaxlen;
436
class Item_func_unhex :public Item_str_func
440
Item_func_unhex(Item *a) :Item_str_func(a)
442
/* there can be bad hex strings */
445
const char *func_name() const { return "unhex"; }
446
String *val_str(String *);
447
void fix_length_and_dec()
449
collation.set(&my_charset_bin);
451
max_length=(1+args[0]->max_length)/2;
456
class Item_func_binary :public Item_str_func
459
Item_func_binary(Item *a) :Item_str_func(a) {}
460
String *val_str(String *a)
463
String *tmp=args[0]->val_str(a);
464
null_value=args[0]->null_value;
466
tmp->set_charset(&my_charset_bin);
469
void fix_length_and_dec()
471
collation.set(&my_charset_bin);
472
max_length=args[0]->max_length;
474
virtual void print(String *str, enum_query_type query_type);
475
const char *func_name() const { return "cast_as_binary"; }
479
class Item_load_file :public Item_str_func
483
Item_load_file(Item *a) :Item_str_func(a) {}
484
String *val_str(String *);
485
const char *func_name() const { return "load_file"; }
486
void fix_length_and_dec()
488
collation.set(&my_charset_bin, DERIVATION_COERCIBLE);
490
max_length=MAX_BLOB_WIDTH;
492
bool check_vcol_func_processor(unsigned char *int_arg __attribute__((unused)))
497
class Item_func_export_set: public Item_str_func
500
Item_func_export_set(Item *a,Item *b,Item* c) :Item_str_func(a,b,c) {}
501
Item_func_export_set(Item *a,Item *b,Item* c,Item* d) :Item_str_func(a,b,c,d) {}
502
Item_func_export_set(Item *a,Item *b,Item* c,Item* d,Item* e) :Item_str_func(a,b,c,d,e) {}
503
String *val_str(String *str);
504
void fix_length_and_dec();
505
const char *func_name() const { return "export_set"; }
508
class Item_func_quote :public Item_str_func
512
Item_func_quote(Item *a) :Item_str_func(a) {}
513
const char *func_name() const { return "quote"; }
514
String *val_str(String *);
515
void fix_length_and_dec()
517
collation.set(args[0]->collation);
518
max_length= args[0]->max_length * 2 + 2;
522
class Item_func_conv_charset :public Item_str_func
524
bool use_cached_value;
527
const CHARSET_INFO *conv_charset; // keep it public
528
Item_func_conv_charset(Item *a, const CHARSET_INFO * const cs) :Item_str_func(a)
529
{ conv_charset= cs; use_cached_value= 0; safe= 0; }
530
Item_func_conv_charset(Item *a, const CHARSET_INFO * const cs, bool cache_if_const)
533
assert(args[0]->fixed);
535
if (cache_if_const && args[0]->const_item())
538
String tmp, *str= args[0]->val_str(&tmp);
539
if (!str || str_value.copy(str->ptr(), str->length(),
540
str->charset(), conv_charset, &errors))
543
str_value.mark_as_const();
550
Conversion from and to "binary" is safe.
551
Conversion to Unicode is safe.
552
Other kind of conversions are potentially lossy.
554
safe= (args[0]->collation.collation == &my_charset_bin ||
555
cs == &my_charset_bin ||
556
(cs->state & MY_CS_UNICODE));
559
String *val_str(String *);
560
void fix_length_and_dec();
561
const char *func_name() const { return "convert"; }
562
virtual void print(String *str, enum_query_type query_type);
565
class Item_func_set_collation :public Item_str_func
568
Item_func_set_collation(Item *a, Item *b) :Item_str_func(a,b) {};
569
String *val_str(String *);
570
void fix_length_and_dec();
571
bool eq(const Item *item, bool binary_cmp) const;
572
const char *func_name() const { return "collate"; }
573
enum Functype functype() const { return COLLATE_FUNC; }
574
virtual void print(String *str, enum_query_type query_type);
575
Item_field *filed_for_view_update()
577
/* this function is transparent for view updating */
578
return args[0]->filed_for_view_update();
582
class Item_func_charset :public Item_str_func
585
Item_func_charset(Item *a) :Item_str_func(a) {}
586
String *val_str(String *);
587
const char *func_name() const { return "charset"; }
588
void fix_length_and_dec()
590
collation.set(system_charset_info);
591
max_length= 64 * collation.collation->mbmaxlen; // should be enough
594
table_map not_null_tables() const { return 0; }
597
class Item_func_collation :public Item_str_func
600
Item_func_collation(Item *a) :Item_str_func(a) {}
601
String *val_str(String *);
602
const char *func_name() const { return "collation"; }
603
void fix_length_and_dec()
605
collation.set(system_charset_info);
606
max_length= 64 * collation.collation->mbmaxlen; // should be enough
609
table_map not_null_tables() const { return 0; }
613
class Item_func_weight_string :public Item_str_func
619
Item_func_weight_string(Item *a, uint32_t nweights_arg, uint32_t flags_arg)
620
:Item_str_func(a) { nweights= nweights_arg; flags= flags_arg; }
621
const char *func_name() const { return "weight_string"; }
622
String *val_str(String *);
623
void fix_length_and_dec();
625
TODO: Currently this Item is not allowed for virtual columns
626
only due to a bug in generating virtual column value.
628
bool check_vcol_func_processor(unsigned char *int_arg __attribute__((unused)))
632
#define UUID_LENGTH (8+1+4+1+4+1+4+1+12)
633
class Item_func_uuid: public Item_str_func
636
Item_func_uuid(): Item_str_func() {}
637
void fix_length_and_dec() {
638
collation.set(system_charset_info);
640
NOTE! uuid() should be changed to use 'ascii'
641
charset when hex(), format(), md5(), etc, and implicit
642
number-to-string conversion will use 'ascii'
644
max_length= UUID_LENGTH * system_charset_info->mbmaxlen;
646
const char *func_name() const{ return "uuid"; }
647
String *val_str(String *);
648
bool check_vcol_func_processor(unsigned char *int_arg __attribute__((unused)))
652
#endif /* DRIZZLED_ITEM_STRFUNC_H */