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_functions_func_h
21
#define drizzled_functions_func_h
23
/// TODO: Rename this file - func.h is stupid.
25
#include <drizzled/item.h>
26
#include <drizzled/item_func.h>
27
#include <drizzled/sql_list.h>
31
extern "C" /* Bug in BSDI include file */
37
class Item_func :public Item_result_field
40
Item **args, *tmp_arg[2];
42
Allowed numbers of columns in result (usually 1, which means scalar value)
43
0 means get this number from first argument
45
uint32_t allowed_arg_cols;
48
table_map used_tables_cache, not_null_tables_cache;
49
bool const_item_cache;
50
enum Functype { UNKNOWN_FUNC,EQ_FUNC,EQUAL_FUNC,NE_FUNC,LT_FUNC,LE_FUNC,
52
LIKE_FUNC,ISNULL_FUNC,ISNOTNULL_FUNC,
53
COND_AND_FUNC, COND_OR_FUNC, COND_XOR_FUNC,
54
BETWEEN, IN_FUNC, MULT_EQUAL_FUNC,
55
INTERVAL_FUNC, ISNOTNULLTEST_FUNC,
56
NOT_FUNC, NOT_ALL_FUNC,
57
NOW_FUNC, TRIG_COND_FUNC,
58
SUSERVAR_FUNC, GUSERVAR_FUNC, COLLATE_FUNC,
59
EXTRACT_FUNC, CHAR_TYPECAST_FUNC, FUNC_SP,
61
enum optimize_type { OPTIMIZE_NONE,OPTIMIZE_KEY,OPTIMIZE_OP, OPTIMIZE_NULL,
63
enum Type type() const { return FUNC_ITEM; }
64
virtual enum Functype functype() const { return UNKNOWN_FUNC; }
66
allowed_arg_cols(1), arg_count(0)
71
allowed_arg_cols(1), arg_count(1)
75
with_sum_func= a->with_sum_func;
77
Item_func(Item *a,Item *b):
78
allowed_arg_cols(1), arg_count(2)
81
args[0]= a; args[1]= b;
82
with_sum_func= a->with_sum_func || b->with_sum_func;
84
Item_func(Item *a,Item *b,Item *c):
88
if ((args= (Item**) sql_alloc(sizeof(Item*)*3)))
91
args[0]= a; args[1]= b; args[2]= c;
92
with_sum_func= a->with_sum_func || b->with_sum_func || c->with_sum_func;
95
Item_func(Item *a,Item *b,Item *c,Item *d):
99
if ((args= (Item**) sql_alloc(sizeof(Item*)*4)))
102
args[0]= a; args[1]= b; args[2]= c; args[3]= d;
103
with_sum_func= a->with_sum_func || b->with_sum_func ||
104
c->with_sum_func || d->with_sum_func;
107
Item_func(Item *a,Item *b,Item *c,Item *d,Item* e):
111
if ((args= (Item**) sql_alloc(sizeof(Item*)*5)))
113
args[0]= a; args[1]= b; args[2]= c; args[3]= d; args[4]= e;
114
with_sum_func= a->with_sum_func || b->with_sum_func ||
115
c->with_sum_func || d->with_sum_func || e->with_sum_func ;
118
Item_func(List<Item> &list);
119
// Constructor used for Item_cond_and/or (see Item comment)
120
Item_func(THD *thd, Item_func *item);
121
bool fix_fields(THD *, Item **ref);
122
void fix_after_pullout(st_select_lex *new_parent, Item **ref);
123
table_map used_tables() const;
124
table_map not_null_tables() const;
125
void update_used_tables();
126
bool eq(const Item *item, bool binary_cmp) const;
127
virtual optimize_type select_optimize() const { return OPTIMIZE_NONE; }
128
virtual bool have_rev_func() const { return 0; }
129
virtual Item *key_item() const { return args[0]; }
131
This method is used for debug purposes to print the name of an
132
item to the debug log. The second use of this method is as
133
a helper function of print(), where it is applicable.
134
To suit both goals it should return a meaningful,
135
distinguishable and sintactically correct string. This method
136
should not be used for runtime type identification, use enum
137
{Sum}Functype and Item_func::functype()/Item_sum::sum_func()
140
virtual const char *func_name() const { return NULL; };
141
virtual bool const_item() const { return const_item_cache; }
142
Item **arguments() const { return args; }
143
void set_arguments(List<Item> &list);
144
uint32_t argument_count() const { return arg_count; }
145
void remove_arguments() { arg_count=0; }
146
void split_sum_func(THD *thd, Item **ref_pointer_array, List<Item> &fields);
147
virtual void print(String *str, enum_query_type query_type);
148
void print_op(String *str, enum_query_type query_type);
149
void print_args(String *str, uint32_t from, enum_query_type query_type);
150
virtual void fix_num_length_and_dec();
151
void count_only_length();
152
void count_real_length();
153
void count_decimal_length();
155
bool get_arg0_date(DRIZZLE_TIME *ltime, uint32_t fuzzy_date);
156
bool get_arg0_time(DRIZZLE_TIME *ltime);
160
void signal_divide_by_null();
162
Field *tmp_table_field() { return result_field; }
163
Field *tmp_table_field(Table *t_arg);
164
Item *get_tmp_table_item(THD *thd);
166
my_decimal *val_decimal(my_decimal *);
168
bool agg_arg_collations(DTCollation &c, Item **items, uint32_t nitems,
170
bool agg_arg_collations_for_comparison(DTCollation &c,
171
Item **items, uint32_t nitems,
173
bool agg_arg_charsets(DTCollation &c, Item **items, uint32_t nitems,
174
uint32_t flags, int item_sep);
175
bool walk(Item_processor processor, bool walk_subquery, unsigned char *arg);
176
Item *transform(Item_transformer transformer, unsigned char *arg);
177
Item* compile(Item_analyzer analyzer, unsigned char **arg_p,
178
Item_transformer transformer, unsigned char *arg_t);
179
void traverse_cond(Cond_traverser traverser,
180
void * arg, traverse_order order);
181
double fix_result(double value);