← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/field.h

  • Committer: Brian Aker
  • Date: 2010-09-22 22:25:29 UTC
  • mto: (1791.1.1 drizzle)
  • mto: This revision was merged to the branch mainline in revision 1792.
  • Revision ID: brian@tangent.org-20100922222529-geo4wggmu5ntqa5k
Current boost work (more conversion).

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/field.h
1
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
2
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
3
3
 *
4
 
 *  Copyright (C) 2008 Sun Microsystems, Inc.
 
4
 *  Copyright (C) 2008 Sun Microsystems
5
5
 *
6
6
 *  This program is free software; you can redistribute it and/or modify
7
7
 *  it under the terms of the GNU General Public License as published by
22
22
  variables must declare the size_of() member function.
23
23
*/
24
24
 
25
 
 
26
 
 
27
25
#ifndef DRIZZLED_FIELD_H
28
26
#define DRIZZLED_FIELD_H
29
27
 
30
28
#include "drizzled/sql_error.h"
31
 
#include "drizzled/type/decimal.h"
 
29
#include "drizzled/decimal.h"
32
30
#include "drizzled/key_map.h"
 
31
#include "drizzled/sql_bitmap.h"
33
32
#include "drizzled/sql_list.h"
34
33
#include "drizzled/structs.h"
35
34
#include "drizzled/charset_info.h"
36
35
#include "drizzled/item_result.h"
37
 
#include "drizzled/charset_info.h"
38
36
 
39
37
#include <string>
40
38
#include <vector>
41
39
 
42
 
#include "drizzled/visibility.h"
43
 
 
44
40
namespace drizzled
45
41
{
46
42
 
51
47
#define ASSERT_COLUMN_MARKED_FOR_READ assert(!getTable() || (getTable()->read_set == NULL || isReadSet()))
52
48
#define ASSERT_COLUMN_MARKED_FOR_WRITE assert(!getTable() || (getTable()->write_set == NULL || isWriteSet()))
53
49
#else
54
 
#define ASSERT_COLUMN_MARKED_FOR_READ assert(getTable())
55
 
#define ASSERT_COLUMN_MARKED_FOR_WRITE assert(getTable())
 
50
#define ASSERT_COLUMN_MARKED_FOR_READ
 
51
#define ASSERT_COLUMN_MARKED_FOR_WRITE
56
52
#endif
57
53
 
58
54
typedef struct st_typelib TYPELIB;
67
63
 
68
64
int field_conv(Field *to,Field *from);
69
65
 
 
66
inline uint32_t get_enum_pack_length(int elements)
 
67
{
 
68
  return elements < 256 ? 1 : 2;
 
69
}
 
70
 
70
71
/**
71
72
 * Class representing a Field in a Table
72
73
 *
80
81
 * The store_xxx() methods take various input and convert
81
82
 * the input into the raw bytes stored in the ptr member variable.
82
83
 */
83
 
class DRIZZLED_API Field
 
84
class Field
84
85
{
85
86
  /* Prevent use of these */
86
87
  Field(const Field&);
87
88
  void operator=(Field &);
88
 
 
89
89
public:
90
90
  unsigned char *ptr; /**< Position to field in record. Stores raw field value */
91
91
  unsigned char *null_ptr; /**< Byte where null_bit is */
98
98
   */
99
99
private:
100
100
  Table *table;
101
 
 
102
101
public:
103
102
  Table *getTable()
104
103
  {
147
146
  utype unireg_check;
148
147
  uint32_t field_length; /**< Length of this field in bytes */
149
148
  uint32_t flags;
150
 
 
151
 
  bool isUnsigned() const
152
 
  {
153
 
    return flags & UNSIGNED_FLAG;
154
 
  }
155
 
 
156
 
private:
157
149
  uint16_t field_index; /**< Index of this Field in Table::fields array */
158
 
 
159
 
public:
160
 
 
161
 
  uint16_t position() const
162
 
  {
163
 
    return field_index;
164
 
  }
165
 
 
166
 
  void setPosition(uint32_t arg)
167
 
  {
168
 
    field_index= arg;
169
 
  }
170
 
 
171
150
  unsigned char null_bit; /**< Bit used to test null bit */
172
151
  /**
173
152
     If true, this field was created in create_tmp_field_from_item from a NULL
183
162
  static void *operator new(size_t size, memory::Root *mem_root);
184
163
  static void operator delete(void *, size_t)
185
164
  { }
186
 
  static void operator delete(void *, memory::Root *)
187
 
  { }
188
165
 
189
166
  Field(unsigned char *ptr_arg,
190
167
        uint32_t length_arg,
193
170
        utype unireg_check_arg,
194
171
        const char *field_name_arg);
195
172
  virtual ~Field() {}
196
 
 
197
 
  bool hasDefault() const
198
 
  {
199
 
    return not (flags & NO_DEFAULT_VALUE_FLAG);
200
 
  }
201
 
 
202
173
  /* Store functions returns 1 on overflow and -1 on fatal error */
203
174
  virtual int store(const char *to,
204
175
                    uint32_t length,
205
176
                    const CHARSET_INFO * const cs)=0;
206
177
  virtual int store(double nr)=0;
207
178
  virtual int store(int64_t nr, bool unsigned_val)=0;
208
 
  virtual int store_decimal(const type::Decimal *d)=0;
209
 
  int store_and_check(enum_check_fields check_level,
210
 
                      const char *to,
211
 
                      uint32_t length,
212
 
                      const CHARSET_INFO * const cs);
 
179
  virtual int store_decimal(const my_decimal *d)=0;
 
180
  int store(const char *to,
 
181
            uint32_t length,
 
182
            const CHARSET_INFO * const cs,
 
183
            enum_check_fields check_level);
213
184
  /**
214
185
    This is called when storing a date in a string.
215
186
 
216
187
    @note
217
188
      Needs to be changed if/when we want to support different time formats.
218
189
  */
219
 
  virtual int store_time(type::Time &ltime, type::timestamp_t t_type);
220
 
  virtual double val_real()=0;
221
 
  virtual int64_t val_int()=0;
222
 
  virtual type::Decimal *val_decimal(type::Decimal *);
223
 
  String *val_str_internal(String *str)
 
190
  virtual int store_time(DRIZZLE_TIME *ltime, enum enum_drizzle_timestamp_type t_type);
 
191
  virtual double val_real(void)=0;
 
192
  virtual int64_t val_int(void)=0;
 
193
  virtual my_decimal *val_decimal(my_decimal *);
 
194
  inline String *val_str(String *str)
224
195
  {
225
196
    return val_str(str, str);
226
197
  }
227
 
 
228
198
  /*
229
199
     val_str(buf1, buf2) gets two buffers and should use them as follows:
230
200
     if it needs a temp buffer to convert result to string - use buf1
238
208
     This trickery is used to decrease a number of malloc calls.
239
209
  */
240
210
  virtual String *val_str(String*, String *)=0;
241
 
 
242
211
  /*
243
212
   str_needs_quotes() returns true if the value returned by val_str() needs
244
213
   to be quoted when used in constructing an SQL query.
247
216
  virtual Item_result result_type () const=0;
248
217
  virtual Item_result cmp_type () const { return result_type(); }
249
218
  virtual Item_result cast_to_int_type () const { return result_type(); }
250
 
 
251
219
  /**
252
220
     Check whether a field type can be partially indexed by a key.
253
221
 
294
262
   */
295
263
  virtual bool eq_def(Field *field);
296
264
 
297
 
  virtual bool is_timestamp() const
298
 
  {
299
 
    return false;
300
 
  }
301
 
 
302
265
  /**
303
266
   * Returns size (in bytes) used to store field data in memory
304
267
   * (i.e. it returns the maximum size of the field in a row of the table,
342
305
  virtual uint32_t key_length() const;
343
306
  virtual enum_field_types type() const =0;
344
307
  virtual enum_field_types real_type() const;
345
 
  virtual int cmp_max(const unsigned char *a, const unsigned char *b, uint32_t max_len);
 
308
  inline  int cmp(const unsigned char *str) { return cmp(ptr,str); }
 
309
  virtual int cmp_max(const unsigned char *a, const unsigned char *b,
 
310
                      uint32_t max_len);
346
311
  virtual int cmp(const unsigned char *,const unsigned char *)=0;
347
 
  int cmp_internal(const unsigned char *str) { return cmp(ptr,str); }
348
312
  virtual int cmp_binary(const unsigned char *a,const unsigned char *b,
349
313
                         uint32_t max_length=UINT32_MAX);
350
314
  virtual int cmp_offset(uint32_t row_offset);
396
360
                               uint32_t new_null_bit);
397
361
  /** This is used to generate a field in Table from TableShare */
398
362
  Field *clone(memory::Root *mem_root, Table *new_table);
399
 
  void move_field(unsigned char *ptr_arg,unsigned char *null_ptr_arg,unsigned char null_bit_arg)
 
363
  inline void move_field(unsigned char *ptr_arg,unsigned char *null_ptr_arg,unsigned char null_bit_arg)
400
364
  {
401
365
    ptr= ptr_arg;
402
366
    null_ptr= null_ptr_arg;
403
367
    null_bit= null_bit_arg;
404
368
  }
405
 
  void move_field(unsigned char *ptr_arg) { ptr=ptr_arg; }
 
369
  inline void move_field(unsigned char *ptr_arg) { ptr=ptr_arg; }
406
370
  virtual void move_field_offset(ptrdiff_t ptr_diff)
407
371
  {
408
372
    ptr= ADD_TO_PTR(ptr,ptr_diff, unsigned char*);
460
424
  {
461
425
    set_image(buff,length, &my_charset_bin);
462
426
  }
463
 
  int64_t val_int_offset(uint32_t row_offset)
 
427
  inline int64_t val_int_offset(uint32_t row_offset)
464
428
  {
465
429
    ptr+=row_offset;
466
430
    int64_t tmp=val_int();
468
432
    return tmp;
469
433
  }
470
434
 
471
 
  int64_t val_int_internal(const unsigned char *new_ptr)
 
435
  inline int64_t val_int(const unsigned char *new_ptr)
472
436
  {
473
437
    unsigned char *old_ptr= ptr;
474
438
    int64_t return_value;
477
441
    ptr= old_ptr;
478
442
    return return_value;
479
443
  }
480
 
 
481
 
  String *val_str_internal(String *str, const unsigned char *new_ptr)
 
444
  inline String *val_str(String *str, const unsigned char *new_ptr)
482
445
  {
483
446
    unsigned char *old_ptr= ptr;
484
447
    ptr= const_cast<unsigned char*>(new_ptr);
485
 
    val_str_internal(str);
 
448
    val_str(str);
486
449
    ptr= old_ptr;
487
450
    return str;
488
451
  }
591
554
    return max_length;
592
555
  }
593
556
 
594
 
  uint32_t offset(const unsigned char *record)
 
557
  inline uint32_t offset(const unsigned char *record)
595
558
  {
596
559
    return (uint32_t) (ptr - record);
597
560
  }
598
561
  void copy_from_tmp(int offset);
599
562
  uint32_t fill_cache_field(CacheField *copy);
600
 
  virtual bool get_date(type::Time &ltime,uint32_t fuzzydate);
601
 
  virtual bool get_time(type::Time &ltime);
 
563
  virtual bool get_date(DRIZZLE_TIME *ltime,uint32_t fuzzydate);
 
564
  virtual bool get_time(DRIZZLE_TIME *ltime);
602
565
  virtual const CHARSET_INFO *charset(void) const { return &my_charset_bin; }
603
566
  virtual const CHARSET_INFO *sort_charset(void) const { return charset(); }
604
567
  virtual bool has_charset(void) const { return false; }
630
593
      0 otherwise
631
594
  */
632
595
  bool set_warning(DRIZZLE_ERROR::enum_warning_level,
633
 
                   drizzled::error_t code,
 
596
                   unsigned int code,
634
597
                   int cuted_increment);
635
598
  /**
636
599
    Produce warning or note about datetime string data saved into field.
648
611
      thread.
649
612
  */
650
613
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level,
651
 
                            drizzled::error_t code,
 
614
                            uint32_t code,
652
615
                            const char *str,
653
616
                            uint32_t str_len,
654
 
                            type::timestamp_t ts_type,
 
617
                            enum enum_drizzle_timestamp_type ts_type,
655
618
                            int cuted_increment);
656
619
  /**
657
620
    Produce warning or note about integer datetime value saved into field.
668
631
      thread.
669
632
  */
670
633
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level,
671
 
                            drizzled::error_t code,
 
634
                            uint32_t code,
672
635
                            int64_t nr,
673
 
                            type::timestamp_t ts_type,
 
636
                            enum enum_drizzle_timestamp_type ts_type,
674
637
                            int cuted_increment);
675
638
  /**
676
639
    Produce warning or note about double datetime data saved into field.
686
649
      thread.
687
650
  */
688
651
  void set_datetime_warning(DRIZZLE_ERROR::enum_warning_level,
689
 
                            const drizzled::error_t code,
 
652
                            const uint32_t code,
690
653
                            double nr,
691
 
                            type::timestamp_t ts_type);
692
 
  bool check_overflow(int op_result)
 
654
                            enum enum_drizzle_timestamp_type ts_type);
 
655
  inline bool check_overflow(int op_result)
693
656
  {
694
657
    return (op_result == E_DEC_OVERFLOW);
695
658
  }
723
686
    @return
724
687
      value converted from val
725
688
  */
726
 
  int64_t convert_decimal2int64_t(const type::Decimal *val,
 
689
  int64_t convert_decimal2int64_t(const my_decimal *val,
727
690
                                  bool unsigned_flag,
728
691
                                  int *err);
729
692
  /* The max. number of characters */
730
 
  uint32_t char_length() const
 
693
  inline uint32_t char_length() const
731
694
  {
732
695
    return field_length / charset()->mbmaxlen;
733
696
  }
734
697
 
735
 
  enum column_format_type column_format() const
 
698
  inline enum column_format_type column_format() const
736
699
  {
737
700
    return (enum column_format_type)
738
701
      ((flags >> COLUMN_FORMAT_FLAGS) & COLUMN_FORMAT_MASK);
759
722
  bool isWriteSet();
760
723
  void setReadSet(bool arg= true);
761
724
  void setWriteSet(bool arg= true);
762
 
 
763
 
protected:
764
 
 
765
 
  void pack_num(uint64_t arg, unsigned char *destination= NULL);
766
 
  void pack_num(uint32_t arg, unsigned char *destination= NULL);
767
 
  uint64_t unpack_num(uint64_t &destination, const unsigned char *arg= NULL) const;
768
 
  uint32_t unpack_num(uint32_t &destination, const unsigned char *arg= NULL) const;
769
725
};
770
726
 
771
 
std::ostream& operator<<(std::ostream& output, const Field &field);
772
 
 
773
727
} /* namespace drizzled */
774
728
 
775
729
/** @TODO Why is this in the middle of the file???*/
802
756
  SendField() {}
803
757
};
804
758
 
 
759
/**
 
760
 * A class for quick copying data to fields
 
761
 */
 
762
class CopyField :public memory::SqlAlloc
 
763
{
 
764
  /**
 
765
    Convenience definition of a copy function returned by
 
766
    get_copy_func.
 
767
  */
 
768
  typedef void Copy_func(CopyField*);
 
769
  Copy_func *get_copy_func(Field *to, Field *from);
 
770
public:
 
771
  unsigned char *from_ptr;
 
772
  unsigned char *to_ptr;
 
773
  unsigned char *from_null_ptr;
 
774
  unsigned char *to_null_ptr;
 
775
  bool *null_row;
 
776
  uint32_t from_bit;
 
777
  uint32_t to_bit;
 
778
  uint32_t from_length;
 
779
  uint32_t to_length;
 
780
  Field *from_field;
 
781
  Field *to_field;
 
782
  String tmp;                                   // For items
 
783
 
 
784
  CopyField() {}
 
785
  ~CopyField() {}
 
786
  void set(Field *to,Field *from,bool save);    // Field to field
 
787
  void set(unsigned char *to,Field *from);              // Field to string
 
788
  void (*do_copy)(CopyField *);
 
789
  void (*do_copy2)(CopyField *);                // Used to handle null values
 
790
};
 
791
 
805
792
uint32_t pack_length_to_packflag(uint32_t type);
806
793
uint32_t calc_pack_length(enum_field_types type,uint32_t length);
807
794
int set_field_to_null(Field *field);