item.h 82.8 KB
Newer Older
unknown's avatar
unknown committed
1
/* Copyright (C) 2000-2006 MySQL AB
unknown's avatar
unknown committed
2

unknown's avatar
unknown committed
3 4
   This program is free software; you can redistribute it and/or modify
   it under the terms of the GNU General Public License as published by
unknown's avatar
unknown committed
5
   the Free Software Foundation; version 2 of the License.
unknown's avatar
unknown committed
6

unknown's avatar
unknown committed
7 8 9 10
   This program is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
   GNU General Public License for more details.
unknown's avatar
unknown committed
11

unknown's avatar
unknown committed
12 13 14 15 16
   You should have received a copy of the GNU General Public License
   along with this program; if not, write to the Free Software
   Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA */


17
#ifdef USE_PRAGMA_INTERFACE
unknown's avatar
unknown committed
18 19 20
#pragma interface			/* gcc class implementation */
#endif

21
class Protocol;
22
struct TABLE_LIST;
unknown's avatar
unknown committed
23
void item_init(void);			/* Init item functions */
24
class Item_field;
unknown's avatar
unknown committed
25

26 27
/*
   "Declared Type Collation"
unknown's avatar
unknown committed
28
   A combination of collation and its derivation.
29

30
  Flags for collation aggregation modes:
unknown's avatar
unknown committed
31 32 33 34
  MY_COLL_ALLOW_SUPERSET_CONV  - allow conversion to a superset
  MY_COLL_ALLOW_COERCIBLE_CONV - allow conversion of a coercible value
                                 (i.e. constant).
  MY_COLL_ALLOW_CONV           - allow any kind of conversion
unknown's avatar
unknown committed
35
                                 (combination of the above two)
unknown's avatar
unknown committed
36 37 38 39
  MY_COLL_DISALLOW_NONE        - don't allow return DERIVATION_NONE
                                 (e.g. when aggregating for comparison)
  MY_COLL_CMP_CONV             - combination of MY_COLL_ALLOW_CONV
                                 and MY_COLL_DISALLOW_NONE
40 41 42 43
*/

#define MY_COLL_ALLOW_SUPERSET_CONV   1
#define MY_COLL_ALLOW_COERCIBLE_CONV  2
unknown's avatar
unknown committed
44 45 46
#define MY_COLL_ALLOW_CONV            3
#define MY_COLL_DISALLOW_NONE         4
#define MY_COLL_CMP_CONV              7
47

48 49 50 51 52 53 54 55 56 57 58 59 60 61 62
class DTCollation {
public:
  CHARSET_INFO     *collation;
  enum Derivation derivation;
  
  DTCollation()
  {
    collation= &my_charset_bin;
    derivation= DERIVATION_NONE;
  }
  DTCollation(CHARSET_INFO *collation_arg, Derivation derivation_arg)
  {
    collation= collation_arg;
    derivation= derivation_arg;
  }
63
  void set(DTCollation &dt)
64
  { 
65 66
    collation= dt.collation;
    derivation= dt.derivation;
67 68 69 70 71 72 73 74 75 76
  }
  void set(CHARSET_INFO *collation_arg, Derivation derivation_arg)
  {
    collation= collation_arg;
    derivation= derivation_arg;
  }
  void set(CHARSET_INFO *collation_arg)
  { collation= collation_arg; }
  void set(Derivation derivation_arg)
  { derivation= derivation_arg; }
77 78 79
  bool aggregate(DTCollation &dt, uint flags= 0);
  bool set(DTCollation &dt1, DTCollation &dt2, uint flags= 0)
  { set(dt1); return aggregate(dt2, flags); }
80 81 82 83
  const char *derivation_name() const
  {
    switch(derivation)
    {
84
      case DERIVATION_IGNORABLE: return "IGNORABLE";
85 86
      case DERIVATION_COERCIBLE: return "COERCIBLE";
      case DERIVATION_IMPLICIT:  return "IMPLICIT";
87
      case DERIVATION_SYSCONST:  return "SYSCONST";
88 89 90 91 92 93 94
      case DERIVATION_EXPLICIT:  return "EXPLICIT";
      case DERIVATION_NONE:      return "NONE";
      default: return "UNKNOWN";
    }
  }
};

95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148

/*************************************************************************/
/*
  A framework to easily handle different return types for hybrid items
  (hybrid item is an item whose operand can be of any type, e.g. integer,
  real, decimal).
*/

struct Hybrid_type_traits;

struct Hybrid_type
{
  longlong integer;

  double real;
  /*
    Use two decimal buffers interchangeably to speed up += operation
    which has no native support in decimal library.
    Hybrid_type+= arg is implemented as dec_buf[1]= dec_buf[0] + arg.
    The third decimal is used as a handy temporary storage.
  */
  my_decimal dec_buf[3];
  int used_dec_buf_no;

  /*
    Traits moved to a separate class to
      a) be able to easily change object traits in runtime
      b) they work as a differentiator for the union above
  */
  const Hybrid_type_traits *traits;

  Hybrid_type() {}
  /* XXX: add traits->copy() when needed */
  Hybrid_type(const Hybrid_type &rhs) :traits(rhs.traits) {}
};


/* Hybryd_type_traits interface + default implementation for REAL_RESULT */

struct Hybrid_type_traits
{
  virtual Item_result type() const { return REAL_RESULT; }

  virtual void
  fix_length_and_dec(Item *item, Item *arg) const;

  /* Hybrid_type operations. */
  virtual void set_zero(Hybrid_type *val) const { val->real= 0.0; }
  virtual void add(Hybrid_type *val, Field *f) const
  { val->real+= f->val_real(); }
  virtual void div(Hybrid_type *val, ulonglong u) const
  { val->real/= ulonglong2double(u); }

  virtual longlong val_int(Hybrid_type *val, bool unsigned_flag) const
149
  { return (longlong) rint(val->real); }
150 151 152 153
  virtual double val_real(Hybrid_type *val) const { return val->real; }
  virtual my_decimal *val_decimal(Hybrid_type *val, my_decimal *buf) const;
  virtual String *val_str(Hybrid_type *val, String *buf, uint8 decimals) const;
  static const Hybrid_type_traits *instance();
154 155
  Hybrid_type_traits() {}
  virtual ~Hybrid_type_traits() {}
156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176
};


struct Hybrid_type_traits_decimal: public Hybrid_type_traits
{
  virtual Item_result type() const { return DECIMAL_RESULT; }

  virtual void
  fix_length_and_dec(Item *arg, Item *item) const;

  /* Hybrid_type operations. */
  virtual void set_zero(Hybrid_type *val) const;
  virtual void add(Hybrid_type *val, Field *f) const;
  virtual void div(Hybrid_type *val, ulonglong u) const;

  virtual longlong val_int(Hybrid_type *val, bool unsigned_flag) const;
  virtual double val_real(Hybrid_type *val) const;
  virtual my_decimal *val_decimal(Hybrid_type *val, my_decimal *buf) const
  { return &val->dec_buf[val->used_dec_buf_no]; }
  virtual String *val_str(Hybrid_type *val, String *buf, uint8 decimals) const;
  static const Hybrid_type_traits_decimal *instance();
177
  Hybrid_type_traits_decimal() {};
178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207
};


struct Hybrid_type_traits_integer: public Hybrid_type_traits
{
  virtual Item_result type() const { return INT_RESULT; }

  virtual void
  fix_length_and_dec(Item *arg, Item *item) const;

  /* Hybrid_type operations. */
  virtual void set_zero(Hybrid_type *val) const
  { val->integer= 0; }
  virtual void add(Hybrid_type *val, Field *f) const
  { val->integer+= f->val_int(); }
  virtual void div(Hybrid_type *val, ulonglong u) const
  { val->integer/= (longlong) u; }

  virtual longlong val_int(Hybrid_type *val, bool unsigned_flag) const
  { return val->integer; }
  virtual double val_real(Hybrid_type *val) const
  { return (double) val->integer; }
  virtual my_decimal *val_decimal(Hybrid_type *val, my_decimal *buf) const
  {
    int2my_decimal(E_DEC_FATAL_ERROR, val->integer, 0, &val->dec_buf[2]);
    return &val->dec_buf[2];
  }
  virtual String *val_str(Hybrid_type *val, String *buf, uint8 decimals) const
  { buf->set(val->integer, &my_charset_bin); return buf;}
  static const Hybrid_type_traits_integer *instance();
208
  Hybrid_type_traits_integer() {};
209 210
};

211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230

void dummy_error_processor(THD *thd, void *data);

void view_error_processor(THD *thd, void *data);

/*
  Instances of Name_resolution_context store the information necesary for
  name resolution of Items and other context analysis of a query made in
  fix_fields().

  This structure is a part of SELECT_LEX, a pointer to this structure is
  assigned when an item is created (which happens mostly during  parsing
  (sql_yacc.yy)), but the structure itself will be initialized after parsing
  is complete

  TODO: move subquery of INSERT ... SELECT and CREATE ... SELECT to
  separate SELECT_LEX which allow to remove tricks of changing this
  structure before and after INSERT/CREATE and its SELECT to make correct
  field name resolution.
*/
231
struct Name_resolution_context: Sql_alloc
232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247
{
  /*
    The name resolution context to search in when an Item cannot be
    resolved in this context (the context of an outer select)
  */
  Name_resolution_context *outer_context;

  /*
    List of tables used to resolve the items of this context.  Usually these
    are tables from the FROM clause of SELECT statement.  The exceptions are
    INSERT ... SELECT and CREATE ... SELECT statements, where SELECT
    subquery is not moved to a separate SELECT_LEX.  For these types of
    statements we have to change this member dynamically to ensure correct
    name resolution of different parts of the statement.
  */
  TABLE_LIST *table_list;
unknown's avatar
unknown committed
248 249 250 251 252 253 254 255 256 257 258 259 260
  /*
    In most cases the two table references below replace 'table_list' above
    for the purpose of name resolution. The first and last name resolution
    table references allow us to search only in a sub-tree of the nested
    join tree in a FROM clause. This is needed for NATURAL JOIN, JOIN ... USING
    and JOIN ... ON. 
  */
  TABLE_LIST *first_name_resolution_table;
  /*
    Last table to search in the list of leaf table references that begins
    with first_name_resolution_table.
  */
  TABLE_LIST *last_name_resolution_table;
261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284

  /*
    SELECT_LEX item belong to, in case of merged VIEW it can differ from
    SELECT_LEX where item was created, so we can't use table_list/field_list
    from there
  */
  st_select_lex *select_lex;

  /*
    Processor of errors caused during Item name resolving, now used only to
    hide underlying tables in errors about views (i.e. it substitute some
    errors for views)
  */
  void (*error_processor)(THD *, void *);
  void *error_processor_data;

  /*
    When TRUE items are resolved in this context both against the
    SELECT list and this->table_list. If FALSE, items are resolved
    only against this->table_list.
  */
  bool resolve_in_select_list;

  /*
285 286
    Security context of this name resolution context. It's used for views
    and is non-zero only if the view is defined with SQL SECURITY DEFINER.
287
  */
288
  Security_context *security_ctx;
289 290 291 292

  Name_resolution_context()
    :outer_context(0), table_list(0), select_lex(0),
    error_processor_data(0),
293
    security_ctx(0)
294 295 296 297 298 299
    {}

  void init()
  {
    resolve_in_select_list= FALSE;
    error_processor= &dummy_error_processor;
unknown's avatar
unknown committed
300 301
    first_name_resolution_table= NULL;
    last_name_resolution_table= NULL;
302 303 304 305
  }

  void resolve_in_table_list_only(TABLE_LIST *tables)
  {
unknown's avatar
unknown committed
306
    table_list= first_name_resolution_table= tables;
307 308 309 310 311 312 313 314 315 316
    resolve_in_select_list= FALSE;
  }

  void process_error(THD *thd)
  {
    (*error_processor)(thd, error_processor_data);
  }
};


317 318 319 320 321 322 323 324 325 326 327
/*
  Store and restore the current state of a name resolution context.
*/

class Name_resolution_context_state
{
private:
  TABLE_LIST *save_table_list;
  TABLE_LIST *save_first_name_resolution_table;
  TABLE_LIST *save_next_name_resolution_table;
  bool        save_resolve_in_select_list;
328
  TABLE_LIST *save_next_local;
329 330

public:
331
  Name_resolution_context_state() {}          /* Remove gcc warning */
332 333 334 335 336 337 338 339 340

public:
  /* Save the state of a name resolution context. */
  void save_state(Name_resolution_context *context, TABLE_LIST *table_list)
  {
    save_table_list=                  context->table_list;
    save_first_name_resolution_table= context->first_name_resolution_table;
    save_resolve_in_select_list=      context->resolve_in_select_list;
    save_next_local=                  table_list->next_local;
341
    save_next_name_resolution_table=  table_list->next_name_resolution_table;
342 343 344 345 346 347
  }

  /* Restore a name resolution context from saved state. */
  void restore_state(Name_resolution_context *context, TABLE_LIST *table_list)
  {
    table_list->next_local=                save_next_local;
348
    table_list->next_name_resolution_table= save_next_name_resolution_table;
349 350 351 352
    context->table_list=                   save_table_list;
    context->first_name_resolution_table=  save_first_name_resolution_table;
    context->resolve_in_select_list=       save_resolve_in_select_list;
  }
353 354 355 356 357

  TABLE_LIST *get_first_name_resolution_table()
  {
    return save_first_name_resolution_table;
  }
358 359
};

360 361
/*************************************************************************/

362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377
class sp_rcontext;


class Settable_routine_parameter
{
public:
  /*
    Set required privileges for accessing the parameter.

    SYNOPSIS
      set_required_privilege()
        rw        if 'rw' is true then we are going to read and set the
                  parameter, so SELECT and UPDATE privileges might be
                  required, otherwise we only reading it and SELECT
                  privilege might be required.
  */
378 379
  Settable_routine_parameter() {}
  virtual ~Settable_routine_parameter() {}
380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395
  virtual void set_required_privilege(bool rw) {};

  /*
    Set parameter value.

    SYNOPSIS
      set_value()
        thd       thread handle
        ctx       context to which parameter belongs (if it is local
                  variable).
        it        item which represents new value

    RETURN
      FALSE if parameter value has been set,
      TRUE if error has occured.
  */
396
  virtual bool set_value(THD *thd, sp_rcontext *ctx, Item **it)= 0;
397 398 399
};


400
typedef bool (Item::*Item_processor) (byte *arg);
401 402 403 404 405 406 407 408 409 410 411
/*
  Analyzer function
    SYNOPSIS
      argp   in/out IN:  Analysis parameter
                    OUT: Parameter to be passed to the transformer

    RETURN 
      TRUE   Invoke the transformer
      FALSE  Don't do it

*/
412
typedef bool (Item::*Item_analyzer) (byte **argp);
unknown's avatar
unknown committed
413
typedef Item* (Item::*Item_transformer) (byte *arg);
414
typedef void (*Cond_traverser) (const Item *item, void *arg);
415

416

unknown's avatar
unknown committed
417
class Item {
unknown's avatar
unknown committed
418
  Item(const Item &);			/* Prevent use of these */
unknown's avatar
unknown committed
419 420
  void operator=(Item &);
public:
421 422
  static void *operator new(size_t size)
  { return (void*) sql_alloc((uint) size); }
423
  static void *operator new(size_t size, MEM_ROOT *mem_root)
424
  { return (void*) alloc_root(mem_root, (uint) size); }
unknown's avatar
unknown committed
425
  static void operator delete(void *ptr,size_t size) { TRASH(ptr, size); }
426
  static void operator delete(void *ptr, MEM_ROOT *mem_root) {}
unknown's avatar
unknown committed
427

428
  enum Type {FIELD_ITEM= 0, FUNC_ITEM, SUM_FUNC_ITEM, STRING_ITEM,
429
	     INT_ITEM, REAL_ITEM, NULL_ITEM, VARBIN_ITEM,
unknown's avatar
SCRUM  
unknown committed
430
	     COPY_STR_ITEM, FIELD_AVG_ITEM, DEFAULT_VALUE_ITEM,
unknown's avatar
unknown committed
431 432
	     PROC_ITEM,COND_ITEM, REF_ITEM, FIELD_STD_ITEM,
	     FIELD_VARIANCE_ITEM, INSERT_VALUE_ITEM,
433
             SUBSELECT_ITEM, ROW_ITEM, CACHE_ITEM, TYPE_HOLDER,
434 435
             PARAM_ITEM, TRIGGER_FIELD_ITEM, DECIMAL_ITEM,
             VIEW_FIXER_ITEM};
unknown's avatar
SCRUM  
unknown committed
436

unknown's avatar
unknown committed
437
  enum cond_result { COND_UNDEF,COND_OK,COND_TRUE,COND_FALSE };
438 439

  enum traverse_order { POSTFIX, PREFIX };
440
  
441 442 443
  /* Reuse size, only used by SP local variable assignment, otherwize 0 */
  uint rsize;

unknown's avatar
unknown committed
444 445 446 447 448
  /*
    str_values's main purpose is to be used to cache the value in
    save_in_field
  */
  String str_value;
unknown's avatar
unknown committed
449
  my_string name;			/* Name from select */
450 451
  /* Original item name (if it was renamed)*/
  my_string orig_name;
unknown's avatar
unknown committed
452 453
  Item *next;
  uint32 max_length;
454
  uint name_length;                     /* Length of name */
455 456
  int8 marker;
  uint8 decimals;
unknown's avatar
unknown committed
457 458
  my_bool maybe_null;			/* If item may be null */
  my_bool null_value;			/* if item is null */
459
  my_bool unsigned_flag;
unknown's avatar
unknown committed
460
  my_bool with_sum_func;
461
  my_bool fixed;                        /* If item fixed with fix_fields */
462 463
  my_bool is_autogenerated_name;        /* indicate was name of this Item
                                           autogenerated or set by user */
464
  DTCollation collation;
465 466 467
  my_bool with_subselect;               /* If this item is a subselect or some
                                           of its arguments is or contains a
                                           subselect */
468
  Item_result cmp_context;              /* Comparison context */
unknown's avatar
unknown committed
469 470
  // alloc & destruct is done as start of select using sql_alloc
  Item();
471
  /*
unknown's avatar
unknown committed
472
     Constructor used by Item_field, Item_ref & aggregate (sum) functions.
473 474
     Used for duplicating lists in processing queries with temporary
     tables
475
     Also it used for Item_cond_and/Item_cond_or for creating
unknown's avatar
unknown committed
476
     top AND/OR structure of WHERE clause to protect it of
477
     optimisation changes in prepared statements
478
  */
479
  Item(THD *thd, Item *item);
unknown's avatar
unknown committed
480 481
  virtual ~Item()
  {
unknown's avatar
unknown committed
482
#ifdef EXTRA_DEBUG
unknown's avatar
unknown committed
483
    name=0;
unknown's avatar
unknown committed
484
#endif
unknown's avatar
unknown committed
485
  }		/*lint -e1509 */
486
  void set_name(const char *str, uint length, CHARSET_INFO *cs);
487
  void rename(char *new_name);
unknown's avatar
unknown committed
488
  void init_make_field(Send_field *tmp_field,enum enum_field_types type);
489
  virtual void cleanup();
490
  virtual void make_field(Send_field *field);
491
  Field *make_string_field(TABLE *table);
492
  virtual bool fix_fields(THD *, Item **);
unknown's avatar
unknown committed
493
  /*
unknown's avatar
unknown committed
494
    should be used in case where we are sure that we do not need
unknown's avatar
unknown committed
495 496 497
    complete fix_fields() procedure.
  */
  inline void quick_fix_field() { fixed= 1; }
unknown's avatar
unknown committed
498
  /* Function returns 1 on overflow and -1 on fatal errors */
499
  int save_in_field_no_warnings(Field *field, bool no_conversions);
unknown's avatar
unknown committed
500
  virtual int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
501
  virtual void save_org_in_field(Field *field)
502
  { (void) save_in_field(field, 1); }
unknown's avatar
unknown committed
503
  virtual int save_safe_in_field(Field *field)
504
  { return save_in_field(field, 1); }
505
  virtual bool send(Protocol *protocol, String *str);
506
  virtual bool eq(const Item *, bool binary_cmp) const;
507 508
  virtual Item_result result_type() const { return REAL_RESULT; }
  virtual Item_result cast_to_int_type() const { return result_type(); }
509
  virtual enum_field_types field_type() const;
unknown's avatar
unknown committed
510
  virtual enum Type type() const =0;
511
  /* valXXX methods must return NULL or 0 or 0.0 if null_value is set. */
unknown's avatar
unknown committed
512 513 514 515 516 517 518 519 520 521
  /*
    Return double precision floating point representation of item.

    SYNOPSIS
      val_real()

    RETURN
      In case of NULL value return 0.0 and set null_value flag to TRUE.
      If value is not null null_value flag will be reset to FALSE.
  */
522
  virtual double val_real()=0;
unknown's avatar
unknown committed
523 524 525 526 527 528 529 530 531 532
  /*
    Return integer representation of item.

    SYNOPSIS
      val_int()

    RETURN
      In case of NULL value return 0 and set null_value flag to TRUE.
      If value is not null null_value flag will be reset to FALSE.
  */
unknown's avatar
unknown committed
533
  virtual longlong val_int()=0;
534 535 536 537 538
  /*
    This is just a shortcut to avoid the cast. You should still use
    unsigned_flag to check the sign of the item.
  */
  inline ulonglong val_uint() { return (ulonglong) val_int(); }
539 540 541
  /*
    Return string representation of this item object.

unknown's avatar
unknown committed
542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598
    SYNOPSIS
      val_str()
      str   an allocated buffer this or any nested Item object can use to
            store return value of this method.

    NOTE
      Buffer passed via argument  should only be used if the item itself
      doesn't have an own String buffer. In case when the item maintains
      it's own string buffer, it's preferable to return it instead to
      minimize number of mallocs/memcpys.
      The caller of this method can modify returned string, but only in case
      when it was allocated on heap, (is_alloced() is true).  This allows
      the caller to efficiently use a buffer allocated by a child without
      having to allocate a buffer of it's own. The buffer, given to
      val_str() as argument, belongs to the caller and is later used by the
      caller at it's own choosing.
      A few implications from the above:
      - unless you return a string object which only points to your buffer
        but doesn't manages it you should be ready that it will be
        modified.
      - even for not allocated strings (is_alloced() == false) the caller
        can change charset (see Item_func_{typecast/binary}. XXX: is this
        a bug?
      - still you should try to minimize data copying and return internal
        object whenever possible.

    RETURN
      In case of NULL value return 0 (NULL pointer) and set null_value flag
      to TRUE.
      If value is not null null_value flag will be reset to FALSE.
  */
  virtual String *val_str(String *str)=0;
  /*
    Return decimal representation of item with fixed point.

    SYNOPSIS
      val_decimal()
      decimal_buffer  buffer which can be used by Item for returning value
                      (but can be not)

    NOTE
      Returned value should not be changed if it is not the same which was
      passed via argument.

    RETURN
      Return pointer on my_decimal (it can be other then passed via argument)
        if value is not NULL (null_value flag will be reset to FALSE).
      In case of NULL value it return 0 pointer and set null_value flag
        to TRUE.
  */
  virtual my_decimal *val_decimal(my_decimal *decimal_buffer)= 0;
  /*
    Return boolean value of item.

    RETURN
      FALSE value is false or NULL
      TRUE value is true (not equal to 0)
599
  */
unknown's avatar
unknown committed
600
  virtual bool val_bool();
601 602 603 604 605 606 607
  /* Helper functions, see item_sum.cc */
  String *val_string_from_real(String *str);
  String *val_string_from_int(String *str);
  String *val_string_from_decimal(String *str);
  my_decimal *val_decimal_from_real(my_decimal *decimal_value);
  my_decimal *val_decimal_from_int(my_decimal *decimal_value);
  my_decimal *val_decimal_from_string(my_decimal *decimal_value);
608 609
  my_decimal *val_decimal_from_date(my_decimal *decimal_value);
  my_decimal *val_decimal_from_time(my_decimal *decimal_value);
610 611 612
  longlong val_int_from_decimal();
  double val_real_from_decimal();

613 614
  int save_time_in_field(Field *field);
  int save_date_in_field(Field *field);
615
  int save_str_value_in_field(Field *field, String *result);
616

617
  virtual Field *get_tmp_table_field() { return 0; }
unknown's avatar
unknown committed
618
  /* This is also used to create fields in CREATE ... SELECT: */
619
  virtual Field *tmp_table_field(TABLE *t_arg) { return 0; }
unknown's avatar
unknown committed
620
  virtual const char *full_name() const { return name ? name : "???"; }
unknown's avatar
unknown committed
621 622 623 624 625 626 627

  /*
    *result* family of methods is analog of *val* family (see above) but
    return value of result_field of item if it is present. If Item have not
    result field, it return val(). This methods set null_value flag in same
    way as *val* methods do it.
  */
628
  virtual double  val_result() { return val_real(); }
unknown's avatar
unknown committed
629 630
  virtual longlong val_int_result() { return val_int(); }
  virtual String *str_result(String* tmp) { return val_str(tmp); }
unknown's avatar
unknown committed
631 632 633 634
  virtual my_decimal *val_decimal_result(my_decimal *val)
  { return val_decimal(val); }
  virtual bool val_bool_result() { return val_bool(); }

635
  /* bit map of tables used by item */
unknown's avatar
unknown committed
636
  virtual table_map used_tables() const { return (table_map) 0L; }
637 638 639 640 641 642 643 644 645 646 647 648 649 650
  /*
    Return table map of tables that can't be NULL tables (tables that are
    used in a context where if they would contain a NULL row generated
    by a LEFT or RIGHT join, the item would not be true).
    This expression is used on WHERE item to determinate if a LEFT JOIN can be
    converted to a normal join.
    Generally this function should return used_tables() if the function
    would return null if any of the arguments are null
    As this is only used in the beginning of optimization, the value don't
    have to be updated in update_used_tables()
  */
  virtual table_map not_null_tables() const { return used_tables(); }
  /*
    Returns true if this is a simple constant item like an integer, not
651
    a constant expression. Used in the optimizer to propagate basic constants.
652
  */
unknown's avatar
unknown committed
653
  virtual bool basic_const_item() const { return 0; }
unknown's avatar
unknown committed
654
  /* cloning of constant items (0 if it is not const) */
655
  virtual Item *clone_item() { return 0; }
unknown's avatar
unknown committed
656 657 658
  virtual cond_result eq_cmp_result() const { return COND_OK; }
  inline uint float_length(uint decimals_par) const
  { return decimals != NOT_FIXED_DEC ? (DBL_DIG+2+decimals_par) : DBL_DIG+8;}
unknown's avatar
unknown committed
659 660 661
  virtual uint decimal_precision() const;
  inline int decimal_int_part() const
  { return my_decimal_int_part(decimal_precision(), decimals); }
662 663 664 665
  /* 
    Returns true if this is constant (during query execution, i.e. its value
    will not change until next fix_fields) and its value is known.
  */
unknown's avatar
unknown committed
666
  virtual bool const_item() const { return used_tables() == 0; }
667 668 669 670 671 672
  /* 
    Returns true if this is constant but its value may be not known yet.
    (Can be used for parameters of prep. stmts or of stored procedures.)
  */
  virtual bool const_during_execution() const 
  { return (used_tables() & ~PARAM_TABLE_BIT) == 0; }
673 674 675 676 677 678 679 680 681 682 683 684
  /*
    This is an essential method for correct functioning of VIEWS.
    To save a view in an .frm file we need its unequivocal
    definition in SQL that takes into account sql_mode and
    environmental settings.  Currently such definition is restored
    by traversing through the parsed tree of a view and
    print()'ing SQL syntax of every node to a String buffer. This
    method is used to print the SQL definition of an item. The
    second use of this method is for EXPLAIN EXTENDED, to print
    the SQL of a query after all optimizations of the parsed tree
    have been done.
  */
unknown's avatar
unknown committed
685
  virtual void print(String *str_arg) { str_arg->append(full_name()); }
unknown's avatar
unknown committed
686
  void print_item_w_name(String *);
unknown's avatar
unknown committed
687
  virtual void update_used_tables() {}
688 689
  virtual void split_sum_func(THD *thd, Item **ref_pointer_array,
                              List<Item> &fields) {}
690 691
  /* Called for items that really have to be split */
  void split_sum_func2(THD *thd, Item **ref_pointer_array, List<Item> &fields,
unknown's avatar
unknown committed
692
                       Item **ref, bool skip_registered);
693 694 695
  virtual bool get_date(MYSQL_TIME *ltime,uint fuzzydate);
  virtual bool get_time(MYSQL_TIME *ltime);
  virtual bool get_date_result(MYSQL_TIME *ltime,uint fuzzydate)
696
  { return get_date(ltime,fuzzydate); }
697
  /*
698 699 700 701 702
    The method allows to determine nullness of a complex expression 
    without fully evaluating it, instead of calling val/result*() then 
    checking null_value. Used in Item_func_isnull/Item_func_isnotnull
    and Item_sum_count/Item_sum_count_distinct.
    Any new item which can be NULL must implement this method.
703
  */
704
  virtual bool is_null() { return 0; }
705

706 707 708 709 710
  /*
   Make sure the null_value member has a correct value.
  */
  virtual void update_null_value () { (void) val_int(); }

unknown's avatar
unknown committed
711
  /*
712 713 714 715 716 717 718 719
    Inform the item that there will be no distinction between its result
    being FALSE or NULL.

    NOTE
      This function will be called for eg. Items that are top-level AND-parts
      of the WHERE clause. Items implementing this function (currently
      Item_cond_and and subquery-related item) enable special optimizations
      when they are "top level".
unknown's avatar
unknown committed
720
  */
721
  virtual void top_level_item() {}
unknown's avatar
unknown committed
722 723
  /*
    set field of temporary table for Item which can be switched on temporary
unknown's avatar
unknown committed
724
    table during query processing (grouping and so on)
unknown's avatar
unknown committed
725
  */
unknown's avatar
unknown committed
726 727
  virtual void set_result_field(Field *field) {}
  virtual bool is_result_field() { return 0; }
unknown's avatar
unknown committed
728
  virtual bool is_bool_func() { return 0; }
unknown's avatar
unknown committed
729
  virtual void save_in_result_field(bool no_conversions) {}
unknown's avatar
unknown committed
730
  /*
unknown's avatar
unknown committed
731
    set value of aggregate function in case of no rows for grouping were found
unknown's avatar
unknown committed
732
  */
unknown's avatar
unknown committed
733
  virtual void no_rows_in_result() {}
734
  virtual Item *copy_or_same(THD *thd) { return this; }
735
  virtual Item *copy_andor_structure(THD *thd) { return this; }
unknown's avatar
unknown committed
736
  virtual Item *real_item() { return this; }
737
  virtual Item *get_tmp_table_item(THD *thd) { return copy_or_same(thd); }
unknown's avatar
unknown committed
738

739
  static CHARSET_INFO *default_charset();
740
  virtual CHARSET_INFO *compare_collation() { return NULL; }
unknown's avatar
unknown committed
741 742 743 744 745 746

  virtual bool walk(Item_processor processor, byte *arg)
  {
    return (this->*processor)(arg);
  }

747
  virtual Item* transform(Item_transformer transformer, byte *arg);
748

749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764
  /*
    This function performs a generic "compilation" of the Item tree.
    The process of compilation is assumed to go as follows: 
    
    compile()
    { 
      if (this->*some_analyzer(...))
      {
        compile children if any;
        this->*some_transformer(...);
      }
    }

    i.e. analysis is performed top-down while transformation is done
    bottom-up.      
  */
765 766 767 768 769 770 771 772
  virtual Item* compile(Item_analyzer analyzer, byte **arg_p,
                        Item_transformer transformer, byte *arg_t)
  {
    if ((this->*analyzer) (arg_p))
      return ((this->*transformer) (arg_t));
    return 0;
  }

773 774
   virtual void traverse_cond(Cond_traverser traverser,
                              void *arg, traverse_order order)
775 776 777
   {
     (*traverser)(this, arg);
   }
778

unknown's avatar
unknown committed
779
  virtual bool remove_dependence_processor(byte * arg) { return 0; }
780
  virtual bool remove_fixed(byte * arg) { fixed= 0; return 0; }
unknown's avatar
unknown committed
781
  virtual bool cleanup_processor(byte *arg);
782
  virtual bool collect_item_field_processor(byte * arg) { return 0; }
unknown's avatar
unknown committed
783
  virtual bool find_item_in_field_list_processor(byte *arg) { return 0; }
784
  virtual bool change_context_processor(byte *context) { return 0; }
785
  virtual bool reset_query_id_processor(byte *query_id_arg) { return 0; }
786
  virtual bool is_expensive_processor(byte *arg) { return 0; }
787 788 789 790 791 792
  virtual bool subst_argument_checker(byte **arg)
  { 
    if (*arg)
      *arg= NULL; 
    return TRUE;     
  }
793

794
  virtual Item *equal_fields_propagator(byte * arg) { return this; }
795
  virtual bool set_no_const_sub(byte *arg) { return FALSE; }
unknown's avatar
unknown committed
796
  virtual Item *replace_equal_field(byte * arg) { return this; }
797 798 799 800 801 802

  /*
    For SP local variable returns pointer to Item representing its
    current value and pointer to current Item otherwise.
  */
  virtual Item *this_item() { return this; }
803 804
  virtual const Item *this_item() const { return this; }

805 806 807 808
  /*
    For SP local variable returns address of pointer to Item representing its
    current value and pointer passed via parameter otherwise.
  */
809
  virtual Item **this_item_addr(THD *thd, Item **addr_arg) { return addr_arg; }
unknown's avatar
unknown committed
810 811 812

  // Row emulation
  virtual uint cols() { return 1; }
813
  virtual Item* element_index(uint i) { return this; }
814
  virtual Item** addr(uint i) { return 0; }
unknown's avatar
unknown committed
815
  virtual bool check_cols(uint c);
unknown's avatar
unknown committed
816
  // It is not row => null inside is impossible
817 818 819
  virtual bool null_inside() { return 0; }
  // used in row subselects to get value of elements
  virtual void bring_value() {}
820 821

  Field *tmp_table_field_from_field_type(TABLE *table);
822
  virtual Item_field *filed_for_view_update() { return 0; }
unknown's avatar
unknown committed
823

824
  virtual Item *neg_transformer(THD *thd) { return NULL; }
825
  virtual Item *update_value_transformer(byte *select_arg) { return this; }
unknown's avatar
unknown committed
826
  virtual Item *safe_charset_converter(CHARSET_INFO *tocs);
827 828 829 830
  void delete_self()
  {
    cleanup();
    delete this;
unknown's avatar
unknown committed
831
  }
832 833

  virtual bool is_splocal() { return 0; } /* Needed for error checking */
834 835 836 837 838 839 840 841 842

  /*
    Return Settable_routine_parameter interface of the Item.  Return 0
    if this Item is not Settable_routine_parameter.
  */
  virtual Settable_routine_parameter *get_settable_routine_parameter()
  {
    return 0;
  }
843 844 845 846 847 848 849 850
  /*
    result_as_longlong() must return TRUE for Items representing DATE/TIME
    functions and DATE/TIME table fields.
    Those Items have result_type()==STRING_RESULT (and not INT_RESULT), but
    their values should be compared as integers (because the integer
    representation is more precise than the string one).
  */
  virtual bool result_as_longlong() { return FALSE; }
851
  bool is_datetime();
unknown's avatar
unknown committed
852 853 854
};


855 856
class sp_head;

857

858 859 860 861 862 863 864 865
/*****************************************************************************
  The class is a base class for representation of stored routine variables in
  the Item-hierarchy. There are the following kinds of SP-vars:
    - local variables (Item_splocal);
    - CASE expression (Item_case_expr);
*****************************************************************************/

class Item_sp_variable :public Item
866
{
867 868 869 870 871 872 873 874 875 876
protected:
  /*
    THD, which is stored in fix_fields() and is used in this_item() to avoid
    current_thd use.
  */
  THD *m_thd;

public:
  LEX_STRING m_name;

877
public:
878 879 880 881 882
#ifndef DBUG_OFF
  /*
    Routine to which this Item_splocal belongs. Used for checking if correct
    runtime context is used for variable handling.
  */
883
  sp_head *m_sp;
884
#endif
885

886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942
public:
  Item_sp_variable(char *sp_var_name_str, uint sp_var_name_length);

public:
  bool fix_fields(THD *thd, Item **);

  double val_real();
  longlong val_int();
  String *val_str(String *sp);
  my_decimal *val_decimal(my_decimal *decimal_value);
  bool is_null();

public:
  inline void make_field(Send_field *field);
  
  inline bool const_item() const;
  
  inline int save_in_field(Field *field, bool no_conversions);
  inline bool send(Protocol *protocol, String *str);
}; 

/*****************************************************************************
  Item_sp_variable inline implementation.
*****************************************************************************/

inline void Item_sp_variable::make_field(Send_field *field)
{
  Item *it= this_item();

  if (name)
    it->set_name(name, (uint) strlen(name), system_charset_info);
  else
    it->set_name(m_name.str, m_name.length, system_charset_info);
  it->make_field(field);
}

inline bool Item_sp_variable::const_item() const
{
  return TRUE;
}

inline int Item_sp_variable::save_in_field(Field *field, bool no_conversions)
{
  return this_item()->save_in_field(field, no_conversions);
}

inline bool Item_sp_variable::send(Protocol *protocol, String *str)
{
  return this_item()->send(protocol, str);
}


/*****************************************************************************
  A reference to local SP variable (incl. reference to SP parameter), used in
  runtime.
*****************************************************************************/

943 944
class Item_splocal :public Item_sp_variable,
                    private Settable_routine_parameter
945 946 947 948 949
{
  uint m_var_idx;

  Type m_type;
  Item_result m_result_type;
950
  enum_field_types m_field_type;
951
public:
952 953 954 955 956 957 958 959 960 961
  /* 
    Position of this reference to SP variable in the statement (the
    statement itself is in sp_instr_stmt::m_query).
    This is valid only for references to SP variables in statements,
    excluding DECLARE CURSOR statement. It is used to replace references to SP
    variables with NAME_CONST calls when putting statements into the binary
    log.
    Value of 0 means that this object doesn't corresponding to reference to
    SP variable in query text.
  */
962
  uint pos_in_query;
963

964 965
  Item_splocal(const LEX_STRING &sp_var_name, uint sp_var_idx,
               enum_field_types sp_var_type, uint pos_in_q= 0);
966

967 968
  bool is_splocal() { return 1; } /* Needed for error checking */

969
  Item *this_item();
970
  const Item *this_item() const;
971
  Item **this_item_addr(THD *thd, Item **);
972

973
  void print(String *str);
unknown's avatar
unknown committed
974

975 976
public:
  inline const LEX_STRING *my_name() const;
977

978
  inline uint get_var_idx() const;
979

980 981
  inline enum Type type() const;
  inline Item_result result_type() const;
982
  inline enum_field_types field_type() const { return m_field_type; }
983 984

private:
985
  bool set_value(THD *thd, sp_rcontext *ctx, Item **it);
986 987 988 989 990 991

public:
  Settable_routine_parameter *get_settable_routine_parameter()
  {
    return this;
  }
992
};
993

994 995 996
/*****************************************************************************
  Item_splocal inline implementation.
*****************************************************************************/
997

998 999 1000 1001
inline const LEX_STRING *Item_splocal::my_name() const
{
  return &m_name;
}
1002

1003 1004 1005 1006
inline uint Item_splocal::get_var_idx() const
{
  return m_var_idx;
}
1007

1008 1009 1010 1011
inline enum Item::Type Item_splocal::type() const
{
  return m_type;
}
1012

1013 1014 1015 1016
inline Item_result Item_splocal::result_type() const
{
  return m_result_type;
}
unknown's avatar
unknown committed
1017

1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045

/*****************************************************************************
  A reference to case expression in SP, used in runtime.
*****************************************************************************/

class Item_case_expr :public Item_sp_variable
{
public:
  Item_case_expr(int case_expr_id);

public:
  Item *this_item();
  const Item *this_item() const;
  Item **this_item_addr(THD *thd, Item **);

  inline enum Type type() const;
  inline Item_result result_type() const;

public:
  /*
    NOTE: print() is intended to be used from views and for debug.
    Item_case_expr can not occur in views, so here it is only for debug
    purposes.
  */
  void print(String *str);

private:
  int m_case_expr_id;
1046 1047
};

1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061
/*****************************************************************************
  Item_case_expr inline implementation.
*****************************************************************************/

inline enum Item::Type Item_case_expr::type() const
{
  return this_item()->type();
}

inline Item_result Item_case_expr::result_type() const
{
  return this_item()->result_type();
}

1062

1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081
/*
  NAME_CONST(given_name, const_value). 
  This 'function' has all properties of the supplied const_value (which is 
  assumed to be a literal constant), and the name given_name. 

  This is used to replace references to SP variables when we write PROCEDURE
  statements into the binary log.

  TODO
    Together with Item_splocal and Item::this_item() we can actually extract
    common a base of this class and Item_splocal. Maybe it is possible to
    extract a common base with class Item_ref, too.
*/

class Item_name_const : public Item
{
  Item *value_item;
  Item *name_item;
public:
1082 1083
  Item_name_const(Item *name_arg, Item *val):
    value_item(val), name_item(name_arg)
1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112
  {
    Item::maybe_null= TRUE;
  }

  bool fix_fields(THD *, Item **);

  enum Type type() const;
  double val_real();
  longlong val_int();
  String *val_str(String *sp);
  my_decimal *val_decimal(my_decimal *);
  bool is_null();
  void print(String *str);

  Item_result result_type() const
  {
    return value_item->result_type();
  }

  bool const_item() const
  {
    return TRUE;
  }

  int save_in_field(Field *field, bool no_conversions)
  {
    return  value_item->save_in_field(field, no_conversions);
  }

1113
  bool send(Protocol *protocol, String *str)
1114 1115 1116 1117 1118
  {
    return value_item->send(protocol, str);
  }
};

1119
bool agg_item_collations(DTCollation &c, const char *name,
1120
                         Item **items, uint nitems, uint flags, int item_sep);
1121
bool agg_item_collations_for_comparison(DTCollation &c, const char *name,
1122
                                        Item **items, uint nitems, uint flags);
1123
bool agg_item_charsets(DTCollation &c, const char *name,
1124
                       Item **items, uint nitems, uint flags, int item_sep);
1125 1126


1127 1128 1129
class Item_num: public Item
{
public:
1130
  Item_num() {}                               /* Remove gcc warning */
unknown's avatar
unknown committed
1131
  virtual Item_num *neg()= 0;
unknown's avatar
unknown committed
1132
  Item *safe_charset_converter(CHARSET_INFO *tocs);
1133 1134
};

1135
#define NO_CACHED_FIELD_INDEX ((uint)(-1))
1136

unknown's avatar
unknown committed
1137
class st_select_lex;
unknown's avatar
unknown committed
1138 1139
class Item_ident :public Item
{
1140
protected:
1141 1142 1143 1144 1145 1146 1147 1148 1149
  /* 
    We have to store initial values of db_name, table_name and field_name
    to be able to restore them during cleanup() because they can be 
    updated during fix_fields() to values from Field object and life-time 
    of those is shorter than life-time of Item_field.
  */
  const char *orig_db_name;
  const char *orig_table_name;
  const char *orig_field_name;
1150

unknown's avatar
unknown committed
1151
public:
1152
  Name_resolution_context *context;
unknown's avatar
unknown committed
1153 1154 1155
  const char *db_name;
  const char *table_name;
  const char *field_name;
unknown's avatar
unknown committed
1156
  bool alias_name_used; /* true if item was resolved against alias */
1157 1158
  /* 
    Cached value of index for this field in table->field array, used by prep. 
1159 1160 1161 1162 1163 1164 1165 1166
    stmts for speeding up their re-execution. Holds NO_CACHED_FIELD_INDEX 
    if index value is not known.
  */
  uint cached_field_index;
  /*
    Cached pointer to table which contains this field, used for the same reason
    by prep. stmt. too in case then we have not-fully qualified field.
    0 - means no cached value.
1167
  */
1168
  TABLE_LIST *cached_table;
unknown's avatar
unknown committed
1169
  st_select_lex *depended_from;
1170 1171 1172
  Item_ident(Name_resolution_context *context_arg,
             const char *db_name_arg, const char *table_name_arg,
             const char *field_name_arg);
unknown's avatar
unknown committed
1173
  Item_ident(THD *thd, Item_ident *item);
unknown's avatar
unknown committed
1174
  const char *full_name() const;
1175
  void cleanup();
unknown's avatar
unknown committed
1176
  bool remove_dependence_processor(byte * arg);
1177
  void print(String *str);
1178 1179
  virtual bool change_context_processor(byte *cntx)
    { context= (Name_resolution_context *)cntx; return FALSE; }
unknown's avatar
unknown committed
1180 1181 1182 1183
  friend bool insert_fields(THD *thd, Name_resolution_context *context,
                            const char *db_name,
                            const char *table_name, List_iterator<Item> *it,
                            bool any_privileges);
unknown's avatar
unknown committed
1184 1185
};

1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207

class Item_ident_for_show :public Item
{
public:
  Field *field;
  const char *db_name;
  const char *table_name;

  Item_ident_for_show(Field *par_field, const char *db_arg,
                      const char *table_name_arg)
    :field(par_field), db_name(db_arg), table_name(table_name_arg)
  {}

  enum Type type() const { return FIELD_ITEM; }
  double val_real() { return field->val_real(); }
  longlong val_int() { return field->val_int(); }
  String *val_str(String *str) { return field->val_str(str); }
  my_decimal *val_decimal(my_decimal *dec) { return field->val_decimal(dec); }
  void make_field(Send_field *tmp_field);
};


1208 1209
class Item_equal;
class COND_EQUAL;
unknown's avatar
unknown committed
1210

unknown's avatar
unknown committed
1211 1212
class Item_field :public Item_ident
{
1213
protected:
unknown's avatar
unknown committed
1214 1215 1216
  void set_field(Field *field);
public:
  Field *field,*result_field;
unknown's avatar
unknown committed
1217 1218
  Item_equal *item_equal;
  bool no_const_subst;
unknown's avatar
VIEW  
unknown committed
1219 1220 1221 1222 1223 1224 1225
  /*
    if any_privileges set to TRUE then here real effective privileges will
    be stored
  */
  uint have_privileges;
  /* field need any privileges (for VIEW creation) */
  bool any_privileges;
1226 1227 1228
  Item_field(Name_resolution_context *context_arg,
             const char *db_arg,const char *table_name_arg,
	     const char *field_name_arg);
1229 1230 1231
  /*
    Constructor needed to process subselect with temporary tables (see Item)
  */
1232
  Item_field(THD *thd, Item_field *item);
1233
  /*
1234 1235 1236
    Constructor used inside setup_wild(), ensures that field, table,
    and database names will live as long as Item_field (this is important
    in prepared statements).
1237
  */
1238
  Item_field(THD *thd, Name_resolution_context *context_arg, Field *field);
1239 1240 1241
  /*
    If this constructor is used, fix_fields() won't work, because
    db_name, table_name and column_name are unknown. It's necessary to call
1242
    reset_field() before fix_fields() for all fields created this way.
1243
  */
unknown's avatar
unknown committed
1244 1245
  Item_field(Field *field);
  enum Type type() const { return FIELD_ITEM; }
1246
  bool eq(const Item *item, bool binary_cmp) const;
1247
  double val_real();
unknown's avatar
unknown committed
1248
  longlong val_int();
unknown's avatar
unknown committed
1249
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
1250 1251 1252 1253
  String *val_str(String*);
  double val_result();
  longlong val_int_result();
  String *str_result(String* tmp);
unknown's avatar
unknown committed
1254 1255
  my_decimal *val_decimal_result(my_decimal *);
  bool val_bool_result();
1256
  bool send(Protocol *protocol, String *str_arg);
1257
  void reset_field(Field *f);
1258
  bool fix_fields(THD *, Item **);
1259
  void make_field(Send_field *tmp_field);
unknown's avatar
unknown committed
1260
  int save_in_field(Field *field,bool no_conversions);
unknown's avatar
unknown committed
1261 1262 1263 1264 1265 1266
  void save_org_in_field(Field *field);
  table_map used_tables() const;
  enum Item_result result_type () const
  {
    return field->result_type();
  }
1267 1268 1269 1270
  Item_result cast_to_int_type() const
  {
    return field->cast_to_int_type();
  }
unknown's avatar
unknown committed
1271
  enum_field_types field_type() const
1272 1273 1274
  {
    return field->type();
  }
1275
  Field *get_tmp_table_field() { return result_field; }
1276
  Field *tmp_table_field(TABLE *t_arg) { return result_field; }
1277 1278 1279
  bool get_date(MYSQL_TIME *ltime,uint fuzzydate);
  bool get_date_result(MYSQL_TIME *ltime,uint fuzzydate);
  bool get_time(MYSQL_TIME *ltime);
unknown's avatar
unknown committed
1280
  bool is_null() { return field->is_null(); }
1281
  void update_null_value();
1282
  Item *get_tmp_table_item(THD *thd);
1283
  bool collect_item_field_processor(byte * arg);
unknown's avatar
unknown committed
1284
  bool find_item_in_field_list_processor(byte *arg);
unknown's avatar
unknown committed
1285 1286 1287 1288 1289 1290 1291
  bool reset_query_id_processor(byte *arg)
  {
    field->query_id= *((query_id_t *) arg);
    if (result_field)
      result_field->query_id= field->query_id;
    return 0;
  }
unknown's avatar
unknown committed
1292
  void cleanup();
1293 1294 1295 1296
  bool result_as_longlong()
  {
    return field->can_be_compared_as_longlong();
  }
1297
  Item_equal *find_item_equal(COND_EQUAL *cond_equal);
1298
  bool subst_argument_checker(byte **arg);
1299
  Item *equal_fields_propagator(byte *arg);
1300
  bool set_no_const_sub(byte *arg);
unknown's avatar
unknown committed
1301
  Item *replace_equal_field(byte *arg);
1302
  inline uint32 max_disp_length() { return field->max_display_length(); }
1303
  Item_field *filed_for_view_update() { return this; }
unknown's avatar
unknown committed
1304
  Item *safe_charset_converter(CHARSET_INFO *tocs);
1305
  int fix_outer_field(THD *thd, Field **field, Item **reference);
1306
  virtual Item *update_value_transformer(byte *select_arg);
1307
  void print(String *str);
1308 1309 1310 1311 1312
  Field::geometry_type get_geometry_type()
  {
    DBUG_ASSERT(field_type() == MYSQL_TYPE_GEOMETRY);
    return field->get_geometry_type();
  }
unknown's avatar
SCRUM  
unknown committed
1313
  friend class Item_default_value;
unknown's avatar
unknown committed
1314
  friend class Item_insert_value;
unknown's avatar
unknown committed
1315
  friend class st_select_lex_unit;
unknown's avatar
unknown committed
1316 1317 1318 1319 1320 1321
};

class Item_null :public Item
{
public:
  Item_null(char *name_par=0)
unknown's avatar
unknown committed
1322 1323 1324 1325 1326
  {
    maybe_null= null_value= TRUE;
    max_length= 0;
    name= name_par ? name_par : (char*) "NULL";
    fixed= 1;
1327
    collation.set(&my_charset_bin, DERIVATION_IGNORABLE);
unknown's avatar
unknown committed
1328
  }
unknown's avatar
unknown committed
1329
  enum Type type() const { return NULL_ITEM; }
1330
  bool eq(const Item *item, bool binary_cmp) const;
1331
  double val_real();
unknown's avatar
unknown committed
1332 1333
  longlong val_int();
  String *val_str(String *str);
unknown's avatar
unknown committed
1334
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
1335
  int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
1336
  int save_safe_in_field(Field *field);
unknown's avatar
unknown committed
1337
  bool send(Protocol *protocol, String *str);
1338 1339
  enum Item_result result_type () const { return STRING_RESULT; }
  enum_field_types field_type() const   { return MYSQL_TYPE_NULL; }
unknown's avatar
unknown committed
1340
  /* to prevent drop fixed flag (no need parent cleanup call) */
unknown's avatar
unknown committed
1341
  void cleanup() {}
unknown's avatar
unknown committed
1342
  bool basic_const_item() const { return 1; }
1343
  Item *clone_item() { return new Item_null(name); }
unknown's avatar
unknown committed
1344
  bool is_null() { return 1; }
1345
  void print(String *str) { str->append(STRING_WITH_LEN("NULL")); }
unknown's avatar
unknown committed
1346
  Item *safe_charset_converter(CHARSET_INFO *tocs);
unknown's avatar
unknown committed
1347 1348
};

unknown's avatar
unknown committed
1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359
class Item_null_result :public Item_null
{
public:
  Field *result_field;
  Item_null_result() : Item_null(), result_field(0) {}
  bool is_result_field() { return result_field != 0; }
  void save_in_result_field(bool no_conversions)
  {
    save_in_field(result_field, no_conversions);
  }
};  
1360 1361 1362

/* Item represents one placeholder ('?') of prepared statement */

unknown's avatar
unknown committed
1363 1364
class Item_param :public Item
{
unknown's avatar
unknown committed
1365 1366 1367
  char cnvbuf[MAX_FIELD_WIDTH];
  String cnvstr;
  Item *cnvitem;
1368 1369
  bool strict_type;
  enum Item_result required_result_type;
unknown's avatar
unknown committed
1370

1371
public:
1372 1373 1374
  enum enum_item_param_state
  {
    NO_VALUE, NULL_VALUE, INT_VALUE, REAL_VALUE,
unknown's avatar
unknown committed
1375 1376
    STRING_VALUE, TIME_VALUE, LONG_DATA_VALUE,
    DECIMAL_VALUE
1377 1378
  } state;

1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389
  /*
    A buffer for string and long data values. Historically all allocated
    values returned from val_str() were treated as eligible to
    modification. I. e. in some cases Item_func_concat can append it's
    second argument to return value of the first one. Because of that we
    can't return the original buffer holding string data from val_str(),
    and have to have one buffer for data and another just pointing to
    the data. This is the latter one and it's returned from val_str().
    Can not be declared inside the union as it's not a POD type.
  */
  String str_value_ptr;
unknown's avatar
unknown committed
1390
  my_decimal decimal_value;
1391 1392
  union
  {
1393 1394
    longlong integer;
    double   real;
1395 1396 1397 1398 1399 1400 1401 1402 1403
    /*
      Character sets conversion info for string values.
      Character sets of client and connection defined at bind time are used
      for all conversions, even if one of them is later changed (i.e.
      between subsequent calls to mysql_stmt_execute).
    */
    struct CONVERSION_INFO
    {
      CHARSET_INFO *character_set_client;
1404
      CHARSET_INFO *character_set_of_placeholder;
1405 1406 1407
      /*
        This points at character set of connection if conversion
        to it is required (i. e. if placeholder typecode is not BLOB).
1408
        Otherwise it's equal to character_set_client (to simplify
1409 1410 1411 1412
        check in convert_str_value()).
      */
      CHARSET_INFO *final_character_set_of_str_value;
    } cs_info;
1413
    MYSQL_TIME     time;
1414 1415 1416
  } value;

  /* Cached values for virtual methods to save us one switch.  */
unknown's avatar
unknown committed
1417 1418
  enum Item_result item_result_type;
  enum Type item_type;
1419 1420 1421 1422 1423 1424 1425 1426 1427 1428

  /*
    Used when this item is used in a temporary table.
    This is NOT placeholder metadata sent to client, as this value
    is assigned after sending metadata (in setup_one_conversion_function).
    For example in case of 'SELECT ?' you'll get MYSQL_TYPE_STRING both
    in result set and placeholders metadata, no matter what type you will
    supply for this placeholder in mysql_stmt_execute.
  */
  enum enum_field_types param_type;
1429
  /*
1430 1431
    Offset of placeholder inside statement text. Used to create
    no-placeholders version of this statement for the binary log.
1432
  */
1433
  uint pos_in_query;
unknown's avatar
unknown committed
1434

1435 1436 1437
  Item_param(uint pos_in_query_arg);

  enum Item_result result_type () const { return item_result_type; }
unknown's avatar
unknown committed
1438
  enum Type type() const { return item_type; }
1439
  enum_field_types field_type() const { return param_type; }
1440

1441
  double val_real();
unknown's avatar
unknown committed
1442
  longlong val_int();
unknown's avatar
unknown committed
1443
  my_decimal *val_decimal(my_decimal*);
unknown's avatar
unknown committed
1444
  String *val_str(String*);
1445 1446
  bool get_time(MYSQL_TIME *tm);
  bool get_date(MYSQL_TIME *tm, uint fuzzydate);
unknown's avatar
unknown committed
1447
  int  save_in_field(Field *field, bool no_conversions);
1448

unknown's avatar
unknown committed
1449
  void set_null();
1450
  void set_int(longlong i, uint32 max_length_arg);
unknown's avatar
unknown committed
1451
  void set_double(double i);
unknown's avatar
unknown committed
1452
  void set_decimal(const char *str, ulong length);
1453 1454
  bool set_str(const char *str, ulong length);
  bool set_longdata(const char *str, ulong length);
1455
  void set_time(MYSQL_TIME *tm, timestamp_type type, uint32 max_length_arg);
1456
  bool set_from_user_var(THD *thd, const user_var_entry *entry);
1457
  void reset();
1458 1459 1460 1461 1462 1463 1464 1465
  /*
    Assign placeholder value from bind data.
    Note, that 'len' has different semantics in embedded library (as we
    don't need to check that packet is not broken there). See
    sql_prepare.cc for details.
  */
  void (*set_param_func)(Item_param *param, uchar **pos, ulong len);

1466 1467 1468
  const String *query_val_str(String *str) const;

  bool convert_str_value(THD *thd);
1469 1470 1471 1472

  /*
    If value for parameter was not set we treat it as non-const
    so noone will use parameters value in fix_fields still
1473 1474 1475
    parameter is constant during execution.
  */
  virtual table_map used_tables() const
1476
  { return state != NO_VALUE ? (table_map)0 : PARAM_TABLE_BIT; }
1477
  void print(String *str);
1478 1479
  bool is_null()
  { DBUG_ASSERT(state != NO_VALUE); return state == NULL_VALUE; }
1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490
  bool basic_const_item() const;
  /*
    This method is used to make a copy of a basic constant item when
    propagating constants in the optimizer. The reason to create a new
    item and not use the existing one is not precisely known (2005/04/16).
    Probably we are trying to preserve tree structure of items, in other
    words, avoid pointing at one item from two different nodes of the tree.
    Return a new basic constant item if parameter value is a basic
    constant, assert otherwise. This method is called only if
    basic_const_item returned TRUE.
  */
1491
  Item *safe_charset_converter(CHARSET_INFO *tocs);
1492
  Item *clone_item();
1493 1494 1495 1496 1497 1498
  /*
    Implement by-value equality evaluation if parameter value
    is set and is a basic constant (integer, real or string).
    Otherwise return FALSE.
  */
  bool eq(const Item *item, bool binary_cmp) const;
1499 1500 1501 1502 1503
  void set_strict_type(enum Item_result result_type_arg)
  {
    strict_type= TRUE;
    required_result_type= result_type_arg;
  }
unknown's avatar
unknown committed
1504
};
unknown's avatar
unknown committed
1505

1506

1507
class Item_int :public Item_num
unknown's avatar
unknown committed
1508 1509
{
public:
1510
  longlong value;
1511 1512
  Item_int(int32 i,uint length= MY_INT32_NUM_DECIMAL_DIGITS)
    :value((longlong) i)
1513
    { max_length=length; fixed= 1; }
1514 1515
  Item_int(longlong i,uint length= MY_INT64_NUM_DECIMAL_DIGITS)
    :value(i)
unknown's avatar
unknown committed
1516
    { max_length=length; fixed= 1; }
1517 1518
  Item_int(ulonglong i, uint length= MY_INT64_NUM_DECIMAL_DIGITS)
    :value((longlong)i)
1519
    { max_length=length; fixed= 1; unsigned_flag= 1; }
unknown's avatar
unknown committed
1520
  Item_int(const char *str_arg,longlong i,uint length) :value(i)
1521
    { max_length=length; name=(char*) str_arg; fixed= 1; }
unknown's avatar
unknown committed
1522
  Item_int(const char *str_arg, uint length=64);
unknown's avatar
unknown committed
1523
  enum Type type() const { return INT_ITEM; }
1524 1525
  enum Item_result result_type () const { return INT_RESULT; }
  enum_field_types field_type() const { return MYSQL_TYPE_LONGLONG; }
1526
  longlong val_int() { DBUG_ASSERT(fixed == 1); return value; }
1527
  double val_real() { DBUG_ASSERT(fixed == 1); return (double) value; }
unknown's avatar
unknown committed
1528
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
1529
  String *val_str(String*);
unknown's avatar
unknown committed
1530
  int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
1531
  bool basic_const_item() const { return 1; }
1532
  Item *clone_item() { return new Item_int(name,value,max_length); }
1533
  // to prevent drop fixed flag (no need parent cleanup call)
unknown's avatar
unknown committed
1534
  void cleanup() {}
unknown's avatar
unknown committed
1535
  void print(String *str);
unknown's avatar
unknown committed
1536
  Item_num *neg() { value= -value; return this; }
unknown's avatar
unknown committed
1537 1538
  uint decimal_precision() const
  { return (uint)(max_length - test(value < 0)); }
1539
  bool eq(const Item *, bool binary_cmp) const;
unknown's avatar
unknown committed
1540 1541 1542
};


unknown's avatar
unknown committed
1543 1544 1545
class Item_uint :public Item_int
{
public:
unknown's avatar
unknown committed
1546
  Item_uint(const char *str_arg, uint length);
1547
  Item_uint(ulonglong i) :Item_int((ulonglong) i, 10) {}
1548
  Item_uint(const char *str_arg, longlong i, uint length);
1549
  double val_real()
1550
    { DBUG_ASSERT(fixed == 1); return ulonglong2double((ulonglong)value); }
unknown's avatar
unknown committed
1551
  String *val_str(String*);
1552
  Item *clone_item() { return new Item_uint(name,max_length); }
unknown's avatar
unknown committed
1553
  int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
1554
  void print(String *str);
unknown's avatar
unknown committed
1555
  Item_num *neg ();
unknown's avatar
unknown committed
1556
  uint decimal_precision() const { return max_length; }
unknown's avatar
unknown committed
1557 1558 1559
};


unknown's avatar
unknown committed
1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582
/* decimal (fixed point) constant */
class Item_decimal :public Item_num
{
protected:
  my_decimal decimal_value;
public:
  Item_decimal(const char *str_arg, uint length, CHARSET_INFO *charset);
  Item_decimal(const char *str, const my_decimal *val_arg,
               uint decimal_par, uint length);
  Item_decimal(my_decimal *value_par);
  Item_decimal(longlong val, bool unsig);
  Item_decimal(double val, int precision, int scale);
  Item_decimal(const char *bin, int precision, int scale);

  enum Type type() const { return DECIMAL_ITEM; }
  enum Item_result result_type () const { return DECIMAL_RESULT; }
  enum_field_types field_type() const { return MYSQL_TYPE_NEWDECIMAL; }
  longlong val_int();
  double val_real();
  String *val_str(String*);
  my_decimal *val_decimal(my_decimal *val) { return &decimal_value; }
  int save_in_field(Field *field, bool no_conversions);
  bool basic_const_item() const { return 1; }
1583
  Item *clone_item()
unknown's avatar
unknown committed
1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595
  {
    return new Item_decimal(name, &decimal_value, decimals, max_length);
  }
  // to prevent drop fixed flag (no need parent cleanup call)
  void cleanup() {}
  void print(String *str);
  Item_num *neg()
  {
    my_decimal_neg(&decimal_value);
    unsigned_flag= !decimal_value.sign();
    return this;
  }
unknown's avatar
unknown committed
1596
  uint decimal_precision() const { return decimal_value.precision(); }
1597
  bool eq(const Item *, bool binary_cmp) const;
1598
  void set_decimal_value(my_decimal *value_par);
unknown's avatar
unknown committed
1599 1600
};

1601

unknown's avatar
unknown committed
1602
class Item_float :public Item_num
unknown's avatar
unknown committed
1603
{
1604
  char *presentation;
unknown's avatar
unknown committed
1605
public:
1606
  double value;
unknown's avatar
unknown committed
1607
  // Item_real() :value(0) {}
unknown's avatar
unknown committed
1608 1609
  Item_float(const char *str_arg, uint length);
  Item_float(const char *str,double val_arg,uint decimal_par,uint length)
unknown's avatar
unknown committed
1610 1611
    :value(val_arg)
  {
1612
    presentation= name=(char*) str;
unknown's avatar
unknown committed
1613
    decimals=(uint8) decimal_par;
unknown's avatar
unknown committed
1614
    max_length=length;
unknown's avatar
unknown committed
1615
    fixed= 1;
unknown's avatar
unknown committed
1616
  }
unknown's avatar
unknown committed
1617 1618
  Item_float(double value_par) :presentation(0), value(value_par) { fixed= 1; }

unknown's avatar
unknown committed
1619
  int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
1620
  enum Type type() const { return REAL_ITEM; }
1621
  enum_field_types field_type() const { return MYSQL_TYPE_DOUBLE; }
1622
  double val_real() { DBUG_ASSERT(fixed == 1); return value; }
1623 1624 1625
  longlong val_int()
  {
    DBUG_ASSERT(fixed == 1);
1626 1627 1628 1629 1630 1631 1632 1633
    if (value <= (double) LONGLONG_MIN)
    {
       return LONGLONG_MIN;
    }
    else if (value >= (double) (ulonglong) LONGLONG_MAX)
    {
      return LONGLONG_MAX;
    }
1634
    return (longlong) rint(value);
1635
  }
unknown's avatar
unknown committed
1636
  String *val_str(String*);
unknown's avatar
unknown committed
1637
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
1638
  bool basic_const_item() const { return 1; }
unknown's avatar
unknown committed
1639 1640
  // to prevent drop fixed flag (no need parent cleanup call)
  void cleanup() {}
1641
  Item *clone_item()
unknown's avatar
unknown committed
1642
  { return new Item_float(name, value, decimals, max_length); }
unknown's avatar
unknown committed
1643
  Item_num *neg() { value= -value; return this; }
1644
  void print(String *str);
1645
  bool eq(const Item *, bool binary_cmp) const;
unknown's avatar
unknown committed
1646 1647 1648
};


unknown's avatar
unknown committed
1649
class Item_static_float_func :public Item_float
1650 1651 1652
{
  const char *func_name;
public:
unknown's avatar
unknown committed
1653
  Item_static_float_func(const char *str, double val_arg, uint decimal_par,
1654
                        uint length)
unknown's avatar
unknown committed
1655
    :Item_float(NullS, val_arg, decimal_par, length), func_name(str)
1656 1657
  {}
  void print(String *str) { str->append(func_name); }
1658
  Item *safe_charset_converter(CHARSET_INFO *tocs);
1659 1660 1661
};


unknown's avatar
unknown committed
1662 1663 1664
class Item_string :public Item
{
public:
unknown's avatar
unknown committed
1665
  Item_string(const char *str,uint length,
1666
  	      CHARSET_INFO *cs, Derivation dv= DERIVATION_COERCIBLE)
unknown's avatar
unknown committed
1667
  {
1668
    collation.set(cs, dv);
unknown's avatar
unknown committed
1669
    str_value.set_or_copy_aligned(str,length,cs);
1670 1671 1672 1673 1674 1675 1676
    /*
      We have to have a different max_length than 'length' here to
      ensure that we get the right length if we do use the item
      to create a new table. In this case max_length must be the maximum
      number of chars for a string of this type because we in create_field::
      divide the max_length with mbmaxlen).
    */
1677
    max_length= str_value.numchars()*cs->mbmaxlen;
unknown's avatar
unknown committed
1678
    set_name(str, length, cs);
unknown's avatar
unknown committed
1679
    decimals=NOT_FIXED_DEC;
1680 1681
    // it is constant => can be used without fix_fields (and frequently used)
    fixed= 1;
unknown's avatar
unknown committed
1682
  }
1683 1684 1685 1686 1687 1688 1689 1690 1691
  /* Just create an item and do not fill string representation */
  Item_string(CHARSET_INFO *cs, Derivation dv= DERIVATION_COERCIBLE)
  {
    collation.set(cs, dv);
    max_length= 0;
    set_name(NULL, 0, cs);
    decimals= NOT_FIXED_DEC;
    fixed= 1;
  }
1692
  Item_string(const char *name_par, const char *str, uint length,
1693
	      CHARSET_INFO *cs, Derivation dv= DERIVATION_COERCIBLE)
unknown's avatar
unknown committed
1694
  {
1695
    collation.set(cs, dv);
unknown's avatar
unknown committed
1696
    str_value.set_or_copy_aligned(str,length,cs);
1697
    max_length= str_value.numchars()*cs->mbmaxlen;
1698
    set_name(name_par, 0, cs);
unknown's avatar
unknown committed
1699
    decimals=NOT_FIXED_DEC;
1700 1701
    // it is constant => can be used without fix_fields (and frequently used)
    fixed= 1;
unknown's avatar
unknown committed
1702
  }
1703 1704 1705 1706 1707 1708 1709 1710 1711
  /*
    This is used in stored procedures to avoid memory leaks and
    does a deep copy of its argument.
  */
  void set_str_with_copy(const char *str_arg, uint length_arg)
  {
    str_value.copy(str_arg, length_arg, collation.collation);
    max_length= str_value.numchars() * collation.collation->mbmaxlen;
  }
unknown's avatar
unknown committed
1712
  enum Type type() const { return STRING_ITEM; }
1713 1714
  double val_real();
  longlong val_int();
1715 1716 1717 1718 1719
  String *val_str(String*)
  {
    DBUG_ASSERT(fixed == 1);
    return (String*) &str_value;
  }
unknown's avatar
unknown committed
1720
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
1721
  int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
1722
  enum Item_result result_type () const { return STRING_RESULT; }
1723
  enum_field_types field_type() const { return MYSQL_TYPE_VARCHAR; }
unknown's avatar
unknown committed
1724
  bool basic_const_item() const { return 1; }
1725
  bool eq(const Item *item, bool binary_cmp) const;
1726
  Item *clone_item() 
1727
  {
1728
    return new Item_string(name, str_value.ptr(), 
unknown's avatar
unknown committed
1729
    			   str_value.length(), collation.collation);
1730
  }
unknown's avatar
unknown committed
1731
  Item *safe_charset_converter(CHARSET_INFO *tocs);
1732 1733 1734 1735 1736
  inline void append(char *str, uint length)
  {
    str_value.append(str, length);
    max_length= str_value.numchars() * collation.collation->mbmaxlen;
  }
unknown's avatar
unknown committed
1737
  void print(String *str);
unknown's avatar
unknown committed
1738 1739
  // to prevent drop fixed flag (no need parent cleanup call)
  void cleanup() {}
unknown's avatar
unknown committed
1740 1741
};

1742 1743 1744 1745 1746 1747 1748 1749 1750 1751

class Item_static_string_func :public Item_string
{
  const char *func_name;
public:
  Item_static_string_func(const char *name_par, const char *str, uint length,
                          CHARSET_INFO *cs,
                          Derivation dv= DERIVATION_COERCIBLE)
    :Item_string(NullS, str, length, cs, dv), func_name(name_par)
  {}
1752
  Item *safe_charset_converter(CHARSET_INFO *tocs);
1753 1754 1755 1756
  void print(String *str) { str->append(func_name); }
};


unknown's avatar
unknown committed
1757 1758 1759 1760 1761
/* for show tables */

class Item_datetime :public Item_string
{
public:
unknown's avatar
unknown committed
1762
  Item_datetime(const char *item_name): Item_string(item_name,"",0,
unknown's avatar
unknown committed
1763
                                                    &my_charset_bin)
unknown's avatar
unknown committed
1764
  { max_length=19;}
1765
  enum_field_types field_type() const { return MYSQL_TYPE_DATETIME; }
unknown's avatar
unknown committed
1766 1767
};

1768 1769 1770 1771 1772 1773
/**
  Item_empty_string -- is a utility class to put an item into List<Item>
  which is then used in protocol.send_fields() when sending SHOW output to
  the client.
*/

unknown's avatar
unknown committed
1774 1775 1776
class Item_empty_string :public Item_string
{
public:
1777
  Item_empty_string(const char *header,uint length, CHARSET_INFO *cs= NULL) :
1778
    Item_string("",0, cs ? cs : &my_charset_utf8_general_ci)
1779
    { name=(char*) header; max_length= cs ? length * cs->mbmaxlen : length; }
1780
  void make_field(Send_field *field);
unknown's avatar
unknown committed
1781 1782
};

1783 1784 1785 1786
class Item_return_int :public Item_int
{
  enum_field_types int_field_type;
public:
1787
  Item_return_int(const char *name_arg, uint length,
1788
		  enum_field_types field_type_arg)
1789
    :Item_int(name_arg, 0, length), int_field_type(field_type_arg)
1790 1791 1792 1793 1794 1795 1796
  {
    unsigned_flag=1;
  }
  enum_field_types field_type() const { return int_field_type; }
};


unknown's avatar
unknown committed
1797
class Item_hex_string: public Item
unknown's avatar
unknown committed
1798 1799
{
public:
unknown's avatar
unknown committed
1800 1801
  Item_hex_string(): Item() {}
  Item_hex_string(const char *str,uint str_length);
unknown's avatar
unknown committed
1802
  enum Type type() const { return VARBIN_ITEM; }
1803
  double val_real()
unknown's avatar
unknown committed
1804 1805 1806 1807
  { 
    DBUG_ASSERT(fixed == 1); 
    return (double) (ulonglong) Item_hex_string::val_int();
  }
unknown's avatar
unknown committed
1808
  longlong val_int();
unknown's avatar
unknown committed
1809
  bool basic_const_item() const { return 1; }
1810
  String *val_str(String*) { DBUG_ASSERT(fixed == 1); return &str_value; }
unknown's avatar
unknown committed
1811
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
1812
  int save_in_field(Field *field, bool no_conversions);
1813
  enum Item_result result_type () const { return STRING_RESULT; }
1814
  enum Item_result cast_to_int_type() const { return INT_RESULT; }
1815
  enum_field_types field_type() const { return MYSQL_TYPE_VARCHAR; }
unknown's avatar
unknown committed
1816 1817
  // to prevent drop fixed flag (no need parent cleanup call)
  void cleanup() {}
1818
  bool eq(const Item *item, bool binary_cmp) const;
unknown's avatar
unknown committed
1819
  virtual Item *safe_charset_converter(CHARSET_INFO *tocs);
unknown's avatar
unknown committed
1820 1821 1822
};


unknown's avatar
unknown committed
1823 1824 1825 1826 1827 1828
class Item_bin_string: public Item_hex_string
{
public:
  Item_bin_string(const char *str,uint str_length);
};

unknown's avatar
unknown committed
1829 1830 1831 1832 1833
class Item_result_field :public Item	/* Item with result field */
{
public:
  Field *result_field;				/* Save result here */
  Item_result_field() :result_field(0) {}
1834
  // Constructor used for Item_sum/Item_cond_and/or (see Item comment)
1835 1836
  Item_result_field(THD *thd, Item_result_field *item):
    Item(thd, item), result_field(item->result_field)
1837
  {}
unknown's avatar
unknown committed
1838
  ~Item_result_field() {}			/* Required with gcc 2.95 */
1839
  Field *get_tmp_table_field() { return result_field; }
1840
  Field *tmp_table_field(TABLE *t_arg) { return result_field; }
unknown's avatar
unknown committed
1841
  table_map used_tables() const { return 1; }
unknown's avatar
unknown committed
1842
  virtual void fix_length_and_dec()=0;
unknown's avatar
unknown committed
1843 1844 1845 1846 1847 1848
  void set_result_field(Field *field) { result_field= field; }
  bool is_result_field() { return 1; }
  void save_in_result_field(bool no_conversions)
  {
    save_in_field(result_field, no_conversions);
  }
1849
  void cleanup();
unknown's avatar
unknown committed
1850 1851 1852 1853 1854
};


class Item_ref :public Item_ident
{
1855 1856
protected:
  void set_properties();
unknown's avatar
unknown committed
1857
public:
1858
  enum Ref_Type { REF, DIRECT_REF, VIEW_REF, OUTER_REF };
unknown's avatar
unknown committed
1859
  Field *result_field;			 /* Save result here */
unknown's avatar
unknown committed
1860
  Item **ref;
1861 1862 1863 1864 1865
  Item_ref(Name_resolution_context *context_arg,
           const char *db_arg, const char *table_name_arg,
           const char *field_name_arg)
    :Item_ident(context_arg, db_arg, table_name_arg, field_name_arg),
     result_field(0), ref(0) {}
1866
  /*
1867 1868 1869 1870 1871 1872 1873 1874 1875 1876
    This constructor is used in two scenarios:
    A) *item = NULL
      No initialization is performed, fix_fields() call will be necessary.
      
    B) *item points to an Item this Item_ref will refer to. This is 
      used for GROUP BY. fix_fields() will not be called in this case,
      so we call set_properties to make this item "fixed". set_properties
      performs a subset of action Item_ref::fix_fields does, and this subset
      is enough for Item_ref's used in GROUP BY.
    
1877 1878 1879
    TODO we probably fix a superset of problems like in BUG#6658. Check this 
         with Bar, and if we have a more broader set of problems like this.
  */
1880
  Item_ref(Name_resolution_context *context_arg, Item **item,
unknown's avatar
unknown committed
1881 1882
           const char *table_name_arg, const char *field_name_arg,
           bool alias_name_used_arg= FALSE);
1883

1884
  /* Constructor need to process subselect with temporary tables (see Item) */
1885 1886
  Item_ref(THD *thd, Item_ref *item)
    :Item_ident(thd, item), result_field(item->result_field), ref(item->ref) {}
unknown's avatar
unknown committed
1887
  enum Type type() const		{ return REF_ITEM; }
1888
  bool eq(const Item *item, bool binary_cmp) const
unknown's avatar
unknown committed
1889 1890 1891 1892
  { 
    Item *it= ((Item *) item)->real_item();
    return ref && (*ref)->eq(it, binary_cmp);
  }
unknown's avatar
unknown committed
1893 1894 1895 1896 1897 1898
  double val_real();
  longlong val_int();
  my_decimal *val_decimal(my_decimal *);
  bool val_bool();
  String *val_str(String* tmp);
  bool is_null();
1899
  bool get_date(MYSQL_TIME *ltime,uint fuzzydate);
1900 1901 1902
  double val_result();
  longlong val_int_result();
  String *str_result(String* tmp);
unknown's avatar
unknown committed
1903 1904
  my_decimal *val_decimal_result(my_decimal *);
  bool val_bool_result();
1905
  bool send(Protocol *prot, String *tmp);
1906 1907
  void make_field(Send_field *field);
  bool fix_fields(THD *, Item **);
1908
  int save_in_field(Field *field, bool no_conversions);
unknown's avatar
unknown committed
1909
  void save_org_in_field(Field *field);
unknown's avatar
unknown committed
1910
  enum Item_result result_type () const { return (*ref)->result_type(); }
1911
  enum_field_types field_type() const   { return (*ref)->field_type(); }
unknown's avatar
unknown committed
1912 1913
  Field *get_tmp_table_field()
  { return result_field ? result_field : (*ref)->get_tmp_table_field(); }
unknown's avatar
unknown committed
1914
  Item *get_tmp_table_item(THD *thd);
1915
  table_map used_tables() const		
1916
  {
1917 1918
    return depended_from ? OUTER_REF_TABLE_BIT : (*ref)->used_tables(); 
  }
unknown's avatar
unknown committed
1919 1920 1921 1922 1923
  void update_used_tables() 
  { 
    if (!depended_from) 
      (*ref)->update_used_tables(); 
  }
1924
  table_map not_null_tables() const { return (*ref)->not_null_tables(); }
1925
  void set_result_field(Field *field)	{ result_field= field; }
unknown's avatar
unknown committed
1926 1927 1928 1929 1930
  bool is_result_field() { return 1; }
  void save_in_result_field(bool no_conversions)
  {
    (*ref)->save_in_field(result_field, no_conversions);
  }
unknown's avatar
unknown committed
1931 1932
  Item *real_item()
  {
unknown's avatar
unknown committed
1933
    return ref ? (*ref)->real_item() : this;
1934
  }
1935 1936
  bool walk(Item_processor processor, byte *arg)
  { return (*ref)->walk(processor, arg); }
unknown's avatar
unknown committed
1937
  void print(String *str);
1938 1939 1940 1941
  bool result_as_longlong()
  {
    return (*ref)->result_as_longlong();
  }
unknown's avatar
unknown committed
1942
  void cleanup();
1943 1944
  Item_field *filed_for_view_update()
    { return (*ref)->filed_for_view_update(); }
1945
  virtual Ref_Type ref_type() { return REF; }
unknown's avatar
unknown committed
1946 1947
};

1948

unknown's avatar
unknown committed
1949 1950 1951 1952
/*
  The same as Item_ref, but get value from val_* family of method to get
  value of item on which it referred instead of result* family.
*/
1953 1954 1955
class Item_direct_ref :public Item_ref
{
public:
1956 1957
  Item_direct_ref(Name_resolution_context *context_arg, Item **item,
                  const char *table_name_arg,
unknown's avatar
unknown committed
1958 1959 1960 1961 1962
                  const char *field_name_arg,
                  bool alias_name_used_arg= FALSE)
    :Item_ref(context_arg, item, table_name_arg,
              field_name_arg, alias_name_used_arg)
  {}
1963 1964
  /* Constructor need to process subselect with temporary tables (see Item) */
  Item_direct_ref(THD *thd, Item_direct_ref *item) : Item_ref(thd, item) {}
1965

unknown's avatar
unknown committed
1966 1967 1968 1969 1970 1971
  double val_real();
  longlong val_int();
  String *val_str(String* tmp);
  my_decimal *val_decimal(my_decimal *);
  bool val_bool();
  bool is_null();
1972
  bool get_date(MYSQL_TIME *ltime,uint fuzzydate);
1973
  virtual Ref_Type ref_type() { return DIRECT_REF; }
1974 1975
};

1976 1977 1978 1979 1980 1981 1982 1983 1984 1985 1986 1987 1988 1989 1990 1991
/*
  Class for view fields, the same as Item_direct_ref, but call fix_fields
  of reference if it is not called yet
*/
class Item_direct_view_ref :public Item_direct_ref
{
public:
  Item_direct_view_ref(Name_resolution_context *context_arg, Item **item,
                  const char *table_name_arg,
                  const char *field_name_arg)
    :Item_direct_ref(context_arg, item, table_name_arg, field_name_arg) {}
  /* Constructor need to process subselect with temporary tables (see Item) */
  Item_direct_view_ref(THD *thd, Item_direct_ref *item)
    :Item_direct_ref(thd, item) {}

  bool fix_fields(THD *, Item **);
1992
  bool eq(const Item *item, bool binary_cmp) const;
unknown's avatar
unknown committed
1993 1994 1995 1996 1997 1998
  Item *get_tmp_table_item(THD *thd)
  {
    Item *item= Item_ref::get_tmp_table_item(thd);
    item->name= name;
    return item;
  }
1999
  virtual Ref_Type ref_type() { return VIEW_REF; }
2000 2001
};

2002

2003 2004 2005 2006 2007 2008 2009 2010 2011 2012 2013
/*
  Class for outer fields.
  An object of this class is created when the select where the outer field was
  resolved is a grouping one. After it has been fixed the ref field will point
  to either an Item_ref or an Item_direct_ref object which will be used to
  access the field.
  See also comments for the fix_inner_refs() and the
  Item_field::fix_outer_field() functions.
*/

class Item_sum;
2014 2015 2016
class Item_outer_ref :public Item_direct_ref
{
public:
2017 2018 2019 2020 2021 2022 2023 2024
  Item *outer_ref;
  /* The aggregate function under which this outer ref is used, if any. */
  Item_sum *in_sum_func;
  /*
    TRUE <=> that the outer_ref is already present in the select list
    of the outer select.
  */
  bool found_in_select_list;
2025 2026 2027
  Item_outer_ref(Name_resolution_context *context_arg,
                 Item_field *outer_field_arg)
    :Item_direct_ref(context_arg, 0, outer_field_arg->table_name,
2028 2029 2030
                     outer_field_arg->field_name),
    outer_ref(outer_field_arg), in_sum_func(0),
    found_in_select_list(0)
2031
  {
2032
    ref= &outer_ref;
2033 2034 2035
    set_properties();
    fixed= 0;
  }
2036 2037 2038 2039 2040 2041 2042
  Item_outer_ref(Name_resolution_context *context_arg, Item **item,
                 const char *table_name_arg, const char *field_name_arg,
                 bool alias_name_used_arg)
    :Item_direct_ref(context_arg, item, table_name_arg, field_name_arg,
                     alias_name_used_arg),
    outer_ref(0), in_sum_func(0), found_in_select_list(1)
  {}
2043 2044
  void save_in_result_field(bool no_conversions)
  {
2045
    outer_ref->save_org_in_field(result_field);
2046 2047 2048 2049 2050 2051 2052 2053 2054 2055
  }
  bool fix_fields(THD *, Item **);
  table_map used_tables() const
  {
    return (*ref)->const_item() ? 0 : OUTER_REF_TABLE_BIT;
  }
  virtual Ref_Type ref_type() { return OUTER_REF; }
};


2056
class Item_in_subselect;
2057

2058 2059 2060 2061 2062 2063 2064 2065 2066 2067

/*
  An object of this class:
   - Converts val_XXX() calls to ref->val_XXX_result() calls, like Item_ref.
   - Sets owner->was_null=TRUE if it has returned a NULL value from any
     val_XXX() function. This allows to inject an Item_ref_null_helper
     object into subquery and then check if the subquery has produced a row
     with NULL value.
*/

2068 2069 2070 2071 2072
class Item_ref_null_helper: public Item_ref
{
protected:
  Item_in_subselect* owner;
public:
2073 2074 2075 2076 2077
  Item_ref_null_helper(Name_resolution_context *context_arg,
                       Item_in_subselect* master, Item **item,
		       const char *table_name_arg, const char *field_name_arg)
    :Item_ref(context_arg, item, table_name_arg, field_name_arg),
     owner(master) {}
2078
  double val_real();
2079 2080
  longlong val_int();
  String* val_str(String* s);
unknown's avatar
unknown committed
2081 2082
  my_decimal *val_decimal(my_decimal *);
  bool val_bool();
2083
  bool get_date(MYSQL_TIME *ltime, uint fuzzydate);
unknown's avatar
unknown committed
2084
  void print(String *str);
2085 2086 2087 2088 2089 2090 2091 2092 2093
  /*
    we add RAND_TABLE_BIT to prevent moving this item from HAVING to WHERE
  */
  table_map used_tables() const
  {
    return (depended_from ?
            OUTER_REF_TABLE_BIT :
            (*ref)->used_tables() | RAND_TABLE_BIT);
  }
2094 2095
};

2096
/*
2097
  The following class is used to optimize comparing of date and bigint columns
2098 2099 2100 2101 2102
  We need to save the original item ('ref') to be able to call
  ref->save_in_field(). This is used to create index search keys.
  
  An instance of Item_int_with_ref may have signed or unsigned integer value.
  
2103 2104 2105 2106 2107 2108
*/

class Item_int_with_ref :public Item_int
{
  Item *ref;
public:
unknown's avatar
unknown committed
2109 2110
  Item_int_with_ref(longlong i, Item *ref_arg, my_bool unsigned_arg) :
    Item_int(i), ref(ref_arg)
2111
  {
unknown's avatar
unknown committed
2112
    unsigned_flag= unsigned_arg;
2113
  }
unknown's avatar
unknown committed
2114
  int save_in_field(Field *field, bool no_conversions)
2115
  {
2116
    return ref->save_in_field(field, no_conversions);
2117
  }
2118
  Item *clone_item();
2119
  virtual Item *real_item() { return ref; }
2120 2121 2122
};


2123
#include "gstream.h"
unknown's avatar
unknown committed
2124
#include "spatial.h"
unknown's avatar
unknown committed
2125 2126
#include "item_sum.h"
#include "item_func.h"
2127
#include "item_row.h"
unknown's avatar
unknown committed
2128 2129
#include "item_cmpfunc.h"
#include "item_strfunc.h"
2130
#include "item_geofunc.h"
unknown's avatar
unknown committed
2131 2132
#include "item_timefunc.h"
#include "item_uniq.h"
2133
#include "item_subselect.h"
unknown's avatar
unknown committed
2134 2135 2136

class Item_copy_string :public Item
{
2137
  enum enum_field_types cached_field_type;
unknown's avatar
unknown committed
2138 2139 2140 2141 2142 2143 2144 2145
public:
  Item *item;
  Item_copy_string(Item *i) :item(i)
  {
    null_value=maybe_null=item->maybe_null;
    decimals=item->decimals;
    max_length=item->max_length;
    name=item->name;
2146
    cached_field_type= item->field_type();
unknown's avatar
unknown committed
2147 2148 2149
  }
  enum Type type() const { return COPY_STR_ITEM; }
  enum Item_result result_type () const { return STRING_RESULT; }
2150
  enum_field_types field_type() const { return cached_field_type; }
2151
  double val_real()
2152
  {
unknown's avatar
unknown committed
2153 2154
    int err_not_used;
    char *end_not_used;
2155 2156
    return (null_value ? 0.0 :
	    my_strntod(str_value.charset(), (char*) str_value.ptr(),
unknown's avatar
unknown committed
2157
		       str_value.length(), &end_not_used, &err_not_used));
2158
  }
unknown's avatar
unknown committed
2159
  longlong val_int()
unknown's avatar
unknown committed
2160
  {
2161
    int err;
unknown's avatar
unknown committed
2162 2163 2164
    return null_value ? LL(0) : my_strntoll(str_value.charset(),str_value.ptr(),
                                            str_value.length(),10, (char**) 0,
                                            &err); 
2165
  }
unknown's avatar
unknown committed
2166
  String *val_str(String*);
unknown's avatar
unknown committed
2167
  my_decimal *val_decimal(my_decimal *);
unknown's avatar
unknown committed
2168 2169
  void make_field(Send_field *field) { item->make_field(field); }
  void copy();
2170 2171 2172 2173
  int save_in_field(Field *field, bool no_conversions)
  {
    return save_str_value_in_field(field, &str_value);
  }
unknown's avatar
unknown committed
2174 2175
  table_map used_tables() const { return (table_map) 1L; }
  bool const_item() const { return 0; }
unknown's avatar
unknown committed
2176
  bool is_null() { return null_value; }
unknown's avatar
unknown committed
2177 2178 2179
};


unknown's avatar
unknown committed
2180
class Cached_item :public Sql_alloc
unknown's avatar
unknown committed
2181 2182 2183
{
public:
  my_bool null_value;
unknown's avatar
unknown committed
2184
  Cached_item() :null_value(0) {}
unknown's avatar
unknown committed
2185
  virtual bool cmp(void)=0;
unknown's avatar
unknown committed
2186
  virtual ~Cached_item(); /*line -e1509 */
unknown's avatar
unknown committed
2187 2188
};

unknown's avatar
unknown committed
2189
class Cached_item_str :public Cached_item
unknown's avatar
unknown committed
2190 2191 2192 2193
{
  Item *item;
  String value,tmp_value;
public:
unknown's avatar
unknown committed
2194
  Cached_item_str(THD *thd, Item *arg);
unknown's avatar
unknown committed
2195
  bool cmp(void);
unknown's avatar
unknown committed
2196
  ~Cached_item_str();                           // Deallocate String:s
unknown's avatar
unknown committed
2197 2198 2199
};


unknown's avatar
unknown committed
2200
class Cached_item_real :public Cached_item
unknown's avatar
unknown committed
2201 2202 2203 2204
{
  Item *item;
  double value;
public:
unknown's avatar
unknown committed
2205
  Cached_item_real(Item *item_par) :item(item_par),value(0.0) {}
unknown's avatar
unknown committed
2206 2207 2208
  bool cmp(void);
};

unknown's avatar
unknown committed
2209
class Cached_item_int :public Cached_item
unknown's avatar
unknown committed
2210 2211 2212 2213
{
  Item *item;
  longlong value;
public:
unknown's avatar
unknown committed
2214
  Cached_item_int(Item *item_par) :item(item_par),value(0) {}
unknown's avatar
unknown committed
2215 2216 2217 2218
  bool cmp(void);
};


unknown's avatar
unknown committed
2219
class Cached_item_decimal :public Cached_item
unknown's avatar
unknown committed
2220 2221 2222 2223
{
  Item *item;
  my_decimal value;
public:
unknown's avatar
unknown committed
2224
  Cached_item_decimal(Item *item_par);
unknown's avatar
unknown committed
2225 2226 2227
  bool cmp(void);
};

unknown's avatar
unknown committed
2228
class Cached_item_field :public Cached_item
unknown's avatar
unknown committed
2229 2230 2231 2232 2233 2234
{
  char *buff;
  Field *field;
  uint length;

public:
unknown's avatar
unknown committed
2235
  Cached_item_field(Item_field *item)
unknown's avatar
unknown committed
2236
  {
unknown's avatar
unknown committed
2237
    field= item->field;
unknown's avatar
unknown committed
2238 2239 2240 2241 2242
    buff= (char*) sql_calloc(length=field->pack_length());
  }
  bool cmp(void);
};

unknown's avatar
SCRUM  
unknown committed
2243 2244 2245 2246
class Item_default_value : public Item_field
{
public:
  Item *arg;
2247 2248 2249 2250 2251 2252 2253 2254
  Item_default_value(Name_resolution_context *context_arg)
    :Item_field(context_arg, (const char *)NULL, (const char *)NULL,
               (const char *)NULL),
     arg(NULL) {}
  Item_default_value(Name_resolution_context *context_arg, Item *a)
    :Item_field(context_arg, (const char *)NULL, (const char *)NULL,
                (const char *)NULL),
     arg(a) {}
unknown's avatar
SCRUM  
unknown committed
2255
  enum Type type() const { return DEFAULT_VALUE_ITEM; }
unknown's avatar
SCRUM  
unknown committed
2256
  bool eq(const Item *item, bool binary_cmp) const;
2257
  bool fix_fields(THD *, Item **);
unknown's avatar
SCRUM  
unknown committed
2258
  void print(String *str);
2259
  int save_in_field(Field *field_arg, bool no_conversions);
unknown's avatar
SCRUM  
unknown committed
2260
  table_map used_tables() const { return (table_map)0L; }
unknown's avatar
unknown committed
2261

unknown's avatar
unknown committed
2262 2263 2264 2265 2266
  bool walk(Item_processor processor, byte *args)
  {
    return arg->walk(processor, args) ||
      (this->*processor)(args);
  }
2267

2268
  Item *transform(Item_transformer transformer, byte *args);
unknown's avatar
unknown committed
2269
};
unknown's avatar
unknown committed
2270

2271 2272 2273 2274 2275 2276 2277 2278 2279 2280
/*
  Item_insert_value -- an implementation of VALUES() function.
  You can use the VALUES(col_name) function in the UPDATE clause
  to refer to column values from the INSERT portion of the INSERT
  ... UPDATE statement. In other words, VALUES(col_name) in the
  UPDATE clause refers to the value of col_name that would be
  inserted, had no duplicate-key conflict occurred.
  In all other places this function returns NULL.
*/

unknown's avatar
unknown committed
2281 2282 2283 2284
class Item_insert_value : public Item_field
{
public:
  Item *arg;
2285 2286 2287 2288
  Item_insert_value(Name_resolution_context *context_arg, Item *a)
    :Item_field(context_arg, (const char *)NULL, (const char *)NULL,
               (const char *)NULL),
     arg(a) {}
unknown's avatar
unknown committed
2289
  bool eq(const Item *item, bool binary_cmp) const;
2290
  bool fix_fields(THD *, Item **);
unknown's avatar
unknown committed
2291
  void print(String *str);
2292
  int save_in_field(Field *field_arg, bool no_conversions)
unknown's avatar
unknown committed
2293
  {
2294
    return Item_field::save_in_field(field_arg, no_conversions);
unknown's avatar
unknown committed
2295
  }
2296 2297 2298 2299 2300
  /* 
   We use RAND_TABLE_BIT to prevent Item_insert_value from
   being treated as a constant and precalculated before execution
  */
  table_map used_tables() const { return RAND_TABLE_BIT; }
unknown's avatar
unknown committed
2301 2302 2303 2304 2305 2306

  bool walk(Item_processor processor, byte *args)
  {
    return arg->walk(processor, args) ||
	    (this->*processor)(args);
  }
unknown's avatar
unknown committed
2307 2308
};

2309 2310 2311 2312 2313 2314 2315 2316 2317 2318

/*
  We need this two enums here instead of sql_lex.h because
  at least one of them is used by Item_trigger_field interface.

  Time when trigger is invoked (i.e. before or after row actually
  inserted/updated/deleted).
*/
enum trg_action_time_type
{
2319
  TRG_ACTION_BEFORE= 0, TRG_ACTION_AFTER= 1, TRG_ACTION_MAX
2320 2321
};

unknown's avatar
unknown committed
2322 2323
class Table_triggers_list;

2324 2325 2326 2327
/*
  Represents NEW/OLD version of field of row which is
  changed/read in trigger.

unknown's avatar
unknown committed
2328 2329 2330 2331 2332 2333
  Note: For this item main part of actual binding to Field object happens
        not during fix_fields() call (like for Item_field) but right after
        parsing of trigger definition, when table is opened, with special
        setup_field() call. On fix_fields() stage we simply choose one of
        two Field instances representing either OLD or NEW version of this
        field.
2334
*/
2335 2336
class Item_trigger_field : public Item_field,
                           private Settable_routine_parameter
2337 2338 2339 2340 2341
{
public:
  /* Is this item represents row from NEW or OLD row ? */
  enum row_version_type {OLD_ROW, NEW_ROW};
  row_version_type row_version;
2342 2343
  /* Next in list of all Item_trigger_field's in trigger */
  Item_trigger_field *next_trg_field;
unknown's avatar
unknown committed
2344 2345 2346 2347
  /* Index of the field in the TABLE::field array */
  uint field_idx;
  /* Pointer to Table_trigger_list object for table of this trigger */
  Table_triggers_list *triggers;
2348

2349 2350
  Item_trigger_field(Name_resolution_context *context_arg,
                     row_version_type row_ver_arg,
unknown's avatar
unknown committed
2351
                     const char *field_name_arg,
2352
                     ulong priv, const bool ro)
2353 2354
    :Item_field(context_arg,
               (const char *)NULL, (const char *)NULL, field_name_arg),
2355 2356
     row_version(row_ver_arg), field_idx((uint)-1), original_privilege(priv),
     want_privilege(priv), table_grants(NULL), read_only (ro)
2357
  {}
unknown's avatar
unknown committed
2358
  void setup_field(THD *thd, TABLE *table, GRANT_INFO *table_grant_info);
2359 2360
  enum Type type() const { return TRIGGER_FIELD_ITEM; }
  bool eq(const Item *item, bool binary_cmp) const;
2361
  bool fix_fields(THD *, Item **);
2362 2363
  void print(String *str);
  table_map used_tables() const { return (table_map)0L; }
2364 2365 2366
  Field *get_tmp_table_field() { return 0; }
  Item *copy_or_same(THD *thd) { return this; }
  Item *get_tmp_table_item(THD *thd) { return copy_or_same(thd); }
2367
  void cleanup();
unknown's avatar
unknown committed
2368 2369

private:
2370
  void set_required_privilege(bool rw);
2371
  bool set_value(THD *thd, sp_rcontext *ctx, Item **it);
2372 2373 2374 2375 2376 2377 2378

public:
  Settable_routine_parameter *get_settable_routine_parameter()
  {
    return (read_only ? 0 : this);
  }

2379
  bool set_value(THD *thd, Item **it)
2380 2381 2382 2383 2384 2385 2386 2387 2388 2389 2390 2391 2392 2393 2394 2395 2396
  {
    return set_value(thd, NULL, it);
  }

private:
  /*
    'want_privilege' holds privileges required to perform operation on
    this trigger field (SELECT_ACL if we are going to read it and
    UPDATE_ACL if we are going to update it).  It is initialized at
    parse time but can be updated later if this trigger field is used
    as OUT or INOUT parameter of stored routine (in this case
    set_required_privilege() is called to appropriately update
    want_privilege and cleanup() is responsible for restoring of
    original want_privilege once parameter's value is updated).
  */
  ulong original_privilege;
  ulong want_privilege;
unknown's avatar
unknown committed
2397
  GRANT_INFO *table_grants;
2398 2399 2400 2401 2402
  /*
    Trigger field is read-only unless it belongs to the NEW row in a
    BEFORE INSERT of BEFORE UPDATE trigger.
  */
  bool read_only;
2403 2404 2405
};


2406 2407
class Item_cache: public Item
{
unknown's avatar
unknown committed
2408 2409
protected:
  Item *example;
2410
  table_map used_table_map;
2411
public:
unknown's avatar
unknown committed
2412
  Item_cache(): example(0), used_table_map(0) {fixed= 1; null_value= 1;}
2413 2414 2415

  void set_used_tables(table_map map) { used_table_map= map; }

unknown's avatar
unknown committed
2416
  virtual bool allocate(uint i) { return 0; }
2417
  virtual bool setup(Item *item)
2418
  {
2419 2420 2421 2422
    example= item;
    max_length= item->max_length;
    decimals= item->decimals;
    collation.set(item->collation);
2423
    unsigned_flag= item->unsigned_flag;
2424 2425
    return 0;
  };
2426 2427
  virtual void store(Item *)= 0;
  enum Type type() const { return CACHE_ITEM; }
2428
  static Item_cache* get_cache(Item_result type);
2429
  table_map used_tables() const { return used_table_map; }
2430
  virtual void keep_array() {}
2431
  // to prevent drop fixed flag (no need parent cleanup call)
unknown's avatar
unknown committed
2432
  void cleanup() {}
unknown's avatar
unknown committed
2433
  void print(String *str);
2434 2435
};

unknown's avatar
unknown committed
2436

2437 2438
class Item_cache_int: public Item_cache
{
unknown's avatar
unknown committed
2439
protected:
2440 2441
  longlong value;
public:
2442
  Item_cache_int(): Item_cache(), value(0) {}
unknown's avatar
unknown committed
2443

unknown's avatar
unknown committed
2444
  void store(Item *item);
2445
  void store(Item *item, longlong val_arg);
2446
  double val_real() { DBUG_ASSERT(fixed == 1); return (double) value; }
2447
  longlong val_int() { DBUG_ASSERT(fixed == 1); return value; }
unknown's avatar
unknown committed
2448 2449
  String* val_str(String *str);
  my_decimal *val_decimal(my_decimal *);
2450
  enum Item_result result_type() const { return INT_RESULT; }
2451
  bool result_as_longlong() { return TRUE; }
2452 2453
};

unknown's avatar
unknown committed
2454

2455 2456 2457 2458
class Item_cache_real: public Item_cache
{
  double value;
public:
2459
  Item_cache_real(): Item_cache(), value(0) {}
2460

unknown's avatar
unknown committed
2461
  void store(Item *item);
2462
  double val_real() { DBUG_ASSERT(fixed == 1); return value; }
unknown's avatar
unknown committed
2463 2464 2465
  longlong val_int();
  String* val_str(String *str);
  my_decimal *val_decimal(my_decimal *);
2466 2467 2468
  enum Item_result result_type() const { return REAL_RESULT; }
};

unknown's avatar
unknown committed
2469 2470 2471 2472 2473 2474 2475 2476 2477 2478 2479 2480 2481 2482 2483 2484 2485

class Item_cache_decimal: public Item_cache
{
protected:
  my_decimal decimal_value;
public:
  Item_cache_decimal(): Item_cache() {}

  void store(Item *item);
  double val_real();
  longlong val_int();
  String* val_str(String *str);
  my_decimal *val_decimal(my_decimal *);
  enum Item_result result_type() const { return DECIMAL_RESULT; }
};


2486 2487
class Item_cache_str: public Item_cache
{
unknown's avatar
unknown committed
2488
  char buffer[STRING_BUFFER_USUAL_SIZE];
2489
  String *value, value_buff;
2490
public:
2491
  Item_cache_str(): Item_cache(), value(0) { }
unknown's avatar
unknown committed
2492

2493
  void store(Item *item);
2494
  double val_real();
2495
  longlong val_int();
2496
  String* val_str(String *) { DBUG_ASSERT(fixed == 1); return value; }
unknown's avatar
unknown committed
2497
  my_decimal *val_decimal(my_decimal *);
2498 2499 2500 2501
  enum Item_result result_type() const { return STRING_RESULT; }
  CHARSET_INFO *charset() const { return value->charset(); };
};

unknown's avatar
unknown committed
2502 2503 2504
class Item_cache_row: public Item_cache
{
  Item_cache  **values;
unknown's avatar
unknown committed
2505
  uint item_count;
2506
  bool save_array;
unknown's avatar
unknown committed
2507
public:
2508 2509
  Item_cache_row()
    :Item_cache(), values(0), item_count(2), save_array(0) {}
unknown's avatar
unknown committed
2510 2511 2512 2513 2514 2515 2516 2517 2518 2519 2520 2521 2522 2523 2524 2525 2526
  
  /*
    'allocate' used only in row transformer, to preallocate space for row 
    cache.
  */
  bool allocate(uint num);
  /*
    'setup' is needed only by row => it not called by simple row subselect
    (only by IN subselect (in subselect optimizer))
  */
  bool setup(Item *item);
  void store(Item *item);
  void illegal_method_call(const char *);
  void make_field(Send_field *)
  {
    illegal_method_call((const char*)"make_field");
  };
2527
  double val_real()
unknown's avatar
unknown committed
2528 2529 2530 2531 2532 2533 2534 2535 2536 2537 2538 2539 2540 2541
  {
    illegal_method_call((const char*)"val");
    return 0;
  };
  longlong val_int()
  {
    illegal_method_call((const char*)"val_int");
    return 0;
  };
  String *val_str(String *)
  {
    illegal_method_call((const char*)"val_str");
    return 0;
  };
unknown's avatar
unknown committed
2542 2543 2544 2545 2546 2547
  my_decimal *val_decimal(my_decimal *val)
  {
    illegal_method_call((const char*)"val_decimal");
    return 0;
  };

unknown's avatar
unknown committed
2548 2549
  enum Item_result result_type() const { return ROW_RESULT; }
  
unknown's avatar
unknown committed
2550
  uint cols() { return item_count; }
2551 2552
  Item *element_index(uint i) { return values[i]; }
  Item **addr(uint i) { return (Item **) (values + i); }
unknown's avatar
unknown committed
2553 2554 2555
  bool check_cols(uint c);
  bool null_inside();
  void bring_value();
2556
  void keep_array() { save_array= 1; }
unknown's avatar
unknown committed
2557 2558
  void cleanup()
  {
unknown's avatar
unknown committed
2559
    DBUG_ENTER("Item_cache_row::cleanup");
unknown's avatar
unknown committed
2560
    Item_cache::cleanup();
2561 2562 2563 2564
    if (save_array)
      bzero(values, item_count*sizeof(Item**));
    else
      values= 0;
unknown's avatar
unknown committed
2565
    DBUG_VOID_RETURN;
unknown's avatar
unknown committed
2566
  }
unknown's avatar
unknown committed
2567 2568
};

2569 2570

/*
2571 2572 2573 2574 2575
  Item_type_holder used to store type. name, length of Item for UNIONS &
  derived tables.

  Item_type_holder do not need cleanup() because its time of live limited by
  single SP/PS execution.
2576 2577 2578 2579
*/
class Item_type_holder: public Item
{
protected:
2580 2581
  TYPELIB *enum_set_typelib;
  enum_field_types fld_type;
2582
  Field::geometry_type geometry_type;
2583 2584

  void get_full_info(Item *item);
unknown's avatar
unknown committed
2585 2586 2587

  /* It is used to count decimal precision in join_types */
  int prev_decimal_int_part;
2588
public:
2589
  Item_type_holder(THD*, Item*);
2590

2591
  Item_result result_type() const;
2592
  enum_field_types field_type() const { return fld_type; };
2593
  enum Type type() const { return TYPE_HOLDER; }
2594
  double val_real();
2595
  longlong val_int();
unknown's avatar
unknown committed
2596
  my_decimal *val_decimal(my_decimal *);
2597
  String *val_str(String*);
2598 2599 2600 2601
  bool join_types(THD *thd, Item *);
  Field *make_field_by_type(TABLE *table);
  static uint32 display_length(Item *item);
  static enum_field_types get_real_type(Item *);
2602
  Field::geometry_type get_geometry_type() { return geometry_type; };
2603 2604
};

2605

2606 2607 2608
class st_select_lex;
void mark_select_range_as_dependent(THD *thd,
                                    st_select_lex *last_select,
unknown's avatar
unknown committed
2609
                                    st_select_lex *current_sel,
2610 2611
                                    Field *found_field, Item *found_item,
                                    Item_ident *resolved_item);
2612

unknown's avatar
unknown committed
2613
extern Cached_item *new_Cached_item(THD *thd, Item *item);
unknown's avatar
unknown committed
2614
extern Item_result item_cmp_type(Item_result a,Item_result b);
2615
extern void resolve_const_item(THD *thd, Item **ref, Item *cmp_item);
unknown's avatar
unknown committed
2616
extern bool field_is_equal_to_item(Field *field,Item *item);