← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/field/str.h

  • Committer: Brian Aker
  • Date: 2009-07-11 08:51:36 UTC
  • mfrom: (1089.3.11 merge)
  • Revision ID: brian@gaz-20090711085136-qj01nwm3qynghwtc
Merge Monty

Show diffs side-by-side

added added

removed removed

Lines of Context:
drizzled/field/str.h
 
1
/* - mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 MySQL
 
5
 *
 
6
 *  This program is free software; you can redistribute it and/or modify
 
7
 *  it under the terms of the GNU General Public License as published by
 
8
 *  the Free Software Foundation; either version 2 of the License, or
 
9
 *  (at your option) any later version.
 
10
 *
 
11
 *  This program is distributed in the hope that it will be useful,
 
12
 *  but WITHOUT ANY WARRANTY; without even the implied warranty of
 
13
 *  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 
14
 *  GNU General Public License for more details.
 
15
 *
 
16
 *  You should have received a copy of the GNU General Public License
 
17
 *  along with this program; if not, write to the Free Software
 
18
 *  Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 
19
 */
 
20
 
 
21
#ifndef DRIZZLE_SERVER_FIELD_STR
 
22
#define DRIZZLE_SERVER_FIELD_STR
 
23
 
 
24
#include <drizzled/field.h>
 
25
 
 
26
typedef struct charset_info_st CHARSET_INFO;
 
27
 
 
28
/* base class for all string related classes */
 
29
 
 
30
class Field_str :public Field {
 
31
protected:
 
32
  const CHARSET_INFO *field_charset;
 
33
  enum Derivation field_derivation;
 
34
  int  report_if_important_data(const char *ptr, const char *end);
 
35
public:
 
36
  Field_str(unsigned char *ptr_arg,uint32_t len_arg,
 
37
            unsigned char *null_ptr_arg,
 
38
            unsigned char null_bit_arg, utype unireg_check_arg,
 
39
            const char *field_name_arg, const CHARSET_INFO * const charset);
 
40
  Item_result result_type () const { return STRING_RESULT; }
 
41
  uint32_t decimals() const { return NOT_FIXED_DEC; }
 
42
 
 
43
  using Field::store;
 
44
  int  store(double nr);
 
45
  int  store(int64_t nr, bool unsigned_val)=0;
 
46
  int  store_decimal(const my_decimal *);
 
47
  int  store(const char *to,uint32_t length, const CHARSET_INFO * const cs)=0;
 
48
 
 
49
  uint32_t size_of() const { return sizeof(*this); }
 
50
  const CHARSET_INFO *charset(void) const { return field_charset; }
 
51
  void set_charset(const CHARSET_INFO * const charset_arg)
 
52
  { field_charset= charset_arg; }
 
53
  enum Derivation derivation(void) const { return field_derivation; }
 
54
  virtual void set_derivation(enum Derivation derivation_arg)
 
55
  { field_derivation= derivation_arg; }
 
56
  bool binary() const { return field_charset == &my_charset_bin; }
 
57
  uint32_t max_display_length() { return field_length; }
 
58
  friend class CreateField;
 
59
  my_decimal *val_decimal(my_decimal *);
 
60
  virtual bool str_needs_quotes() { return true; }
 
61
  bool compare_str_field_flags(CreateField *new_field, uint32_t flags);
 
62
  uint32_t is_equal(CreateField *new_field);
 
63
  uint32_t max_data_length() const;
 
64
};
 
65
 
 
66
/*
 
67
  Report "not well formed" or "cannot convert" error
 
68
  after storing a character string info a field.
 
69
 
 
70
  SYNOPSIS
 
71
    check_string_copy_error()
 
72
    field                    - Field
 
73
    well_formed_error_pos    - where not well formed data was first met
 
74
    cannot_convert_error_pos - where a not-convertable character was first met
 
75
    end                      - end of the string
 
76
    cs                       - character set of the string
 
77
 
 
78
  NOTES
 
79
    As of version 5.0 both cases return the same error:
 
80
 
 
81
      "Invalid string value: 'xxx' for column 't' at row 1"
 
82
 
 
83
  Future versions will possibly introduce a new error message:
 
84
 
 
85
      "Cannot convert character string: 'xxx' for column 't' at row 1"
 
86
 
 
87
  RETURN
 
88
    false - If errors didn't happen
 
89
    true  - If an error happened
 
90
*/
 
91
 
 
92
bool check_string_copy_error(Field_str *field,
 
93
                             const char *well_formed_error_pos,
 
94
                             const char *cannot_convert_error_pos,
 
95
                             const char *end,
 
96
                             const CHARSET_INFO * const cs);
 
97
 
 
98
 
 
99
#endif