my_decimal.h 8.79 KB
Newer Older
unknown's avatar
unknown committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38
/* Copyright (C) 2004 MySQL AB & MySQL Finland AB & TCX DataKonsult AB

   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
   the Free Software Foundation; either version 2 of the License, or
   (at your option) any later version.

   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.

   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 */

/*
  It is interface module to fixed precision decimals library.

  Most functions use 'uint mask' as parameter, if during operation error
  which fit in this mask is detected then it will be processed automatically
  here. (errors are E_DEC_* constants, see include/decimal.h)

  Most function are just inline wrappers around library calls
*/

#ifndef my_decimal_h
#define my_decimal_h

C_MODE_START
#include <decimal.h>
C_MODE_END

#define DECIMAL_LONGLONG_DIGITS 22
#define DECIMAL_LONG_DIGITS 10
#define DECIMAL_LONG3_DIGITS 8

/* maximum length of buffer in our big digits (uint32) */
unknown's avatar
unknown committed
39
#define DECIMAL_BUFF_LENGTH 9
unknown's avatar
unknown committed
40
/*
unknown's avatar
unknown committed
41
  maximum guaranteed precision of number in decimal digits (number of our
unknown's avatar
unknown committed
42 43 44 45
  digits * number of decimal digits in one our big digit - number of decimal
  digits in one our big digit decreased on 1 (because we always put decimal
  point on the border of our big digits))
*/
unknown's avatar
unknown committed
46 47 48 49
#define DECIMAL_MAX_PRECISION ((DECIMAL_BUFF_LENGTH * 9) - 8*2)
#define DECIMAL_MAX_SCALE 30
#define DECIMAL_NOT_SPECIFIED 31

unknown's avatar
unknown committed
50 51 52 53
/*
  maximum length of string representation (number of maximum decimal
  digits + 1 position for sign + 1 position for decimal point)
*/
unknown's avatar
unknown committed
54
#define DECIMAL_MAX_STR_LENGTH (DECIMAL_MAX_PRECISION + 2)
unknown's avatar
unknown committed
55 56 57
/*
  maximum size of packet length
*/
unknown's avatar
unknown committed
58
#define DECIMAL_MAX_FIELD_SIZE DECIMAL_MAX_PRECISION
unknown's avatar
unknown committed
59 60 61 62 63 64 65 66 67 68 69 70


inline uint my_decimal_size(uint precision, uint scale)
{
  /*
    Always allocate more space to allow library to put decimal point
    where it want
  */
  return decimal_size(precision, scale) + 1;
}


unknown's avatar
unknown committed
71 72 73 74 75 76
inline int my_decimal_int_part(uint precision, uint decimals)
{
  return precision - ((decimals == DECIMAL_NOT_SPECIFIED) ? 0 : decimals);
}


77
/*
78
  my_decimal class limits 'decimal_t' type to what we need in MySQL
79 80 81 82 83
  It contains internally all necessary space needed by the instance so
  no extra memory is needed. One should call fix_buffer_pointer() function
  when he moves my_decimal objects in memory
*/

84
class my_decimal :public decimal_t
unknown's avatar
unknown committed
85
{
86
  decimal_digit_t buffer[DECIMAL_BUFF_LENGTH];
unknown's avatar
unknown committed
87 88 89 90 91 92 93

public:

  void init()
  {
    len= DECIMAL_BUFF_LENGTH;
    buf= buffer;
94
#if !defined (HAVE_purify) && !defined(DBUG_OFF)
95
    /* Set buffer to 'random' value to find wrong buffer usage */
unknown's avatar
unknown committed
96 97 98 99 100 101 102 103 104 105
    for (uint i= 0; i < DECIMAL_BUFF_LENGTH; i++)
      buffer[i]= i;
#endif
  }
  my_decimal()
  {
    init();
  }
  void fix_buffer_pointer() { buf= buffer; }

106 107
  bool sign() const { return decimal_t::sign; }
  void sign(bool s) { decimal_t::sign= s; }
unknown's avatar
unknown committed
108
  uint precision() const { return intg + frac; }
unknown's avatar
unknown committed
109 110 111 112 113 114
};


#ifndef DBUG_OFF
void print_decimal(const my_decimal *dec);
void print_decimal_buff(const my_decimal *dec, const byte* ptr, int length);
unknown's avatar
unknown committed
115
const char *dbug_decimal_as_string(char *buff, const my_decimal *val);
116
#else
unknown's avatar
unknown committed
117
#define dbug_decimal_as_string(A) NULL
unknown's avatar
unknown committed
118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135
#endif

#ifndef MYSQL_CLIENT
int decimal_operation_results(int result);
#else
inline int decimal_operation_results(int result)
{
  return result;
}
#endif /*MYSQL_CLIENT*/

inline int check_result(uint mask, int result)
{
  if (result & mask)
    decimal_operation_results(result);
  return result;
}

unknown's avatar
unknown committed
136 137 138 139 140 141 142 143 144 145 146 147
inline uint my_decimal_length_to_precision(uint length, uint scale,
                                           bool unsigned_flag)
{
  return (uint) (length - (scale>0 ? 1:0) - (unsigned_flag ? 0:1));
}

inline uint32 my_decimal_precision_to_length(uint precision, uint8 scale,
                                             bool unsigned_flag)
{
  set_if_smaller(precision, DECIMAL_MAX_PRECISION);
  return (uint32)(precision + (scale>0 ? 1:0) + (unsigned_flag ? 0:1));
}
unknown's avatar
unknown committed
148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178

inline
int my_decimal_string_length(const my_decimal *d)
{
  return decimal_string_size(d);
}


inline
int my_decimal_max_length(const my_decimal *d)
{
  /* -1 because we do not count \0 */
  return decimal_string_size(d) - 1;
}


inline
int my_decimal_get_binary_size(uint precision, uint scale)
{
  return decimal_bin_size((int)precision, (int)scale);
}


inline
void my_decimal2decimal(const my_decimal *from, my_decimal *to)
{
  *to= *from;
  to->fix_buffer_pointer();
}


179
int my_decimal2binary(uint mask, const my_decimal *d, char *bin, int prec,
unknown's avatar
unknown committed
180 181 182 183
		      int scale);


inline
184
int binary2my_decimal(uint mask, const char *bin, my_decimal *d, int prec,
unknown's avatar
unknown committed
185 186
		      int scale)
{
187
  return check_result(mask, bin2decimal((char *)bin, (decimal_t*) d, prec,
unknown's avatar
unknown committed
188 189 190 191 192 193 194
					scale));
}


inline
int my_decimal_set_zero(my_decimal *d)
{
195
  decimal_make_zero(((decimal_t*) d));
unknown's avatar
unknown committed
196 197 198 199 200 201 202
  return 0;
}


inline
bool my_decimal_is_zero(const my_decimal *decimal_value)
{
203
  return decimal_is_zero((decimal_t*) decimal_value);
unknown's avatar
unknown committed
204 205 206 207 208 209 210
}


inline
int my_decimal_round(uint mask, const my_decimal *from, int scale,
                     bool truncate, my_decimal *to)
{
211
  return check_result(mask, decimal_round((decimal_t*) from, to, scale,
unknown's avatar
unknown committed
212 213 214 215 216 217 218
					  (truncate ? TRUNCATE : HALF_UP)));
}


inline
int my_decimal_floor(uint mask, const my_decimal *from, my_decimal *to)
{
219
  return check_result(mask, decimal_round((decimal_t*) from, to, 0, FLOOR));
unknown's avatar
unknown committed
220 221 222 223 224 225
}


inline
int my_decimal_ceiling(uint mask, const my_decimal *from, my_decimal *to)
{
226
  return check_result(mask, decimal_round((decimal_t*) from, to, 0, CEILING));
unknown's avatar
unknown committed
227 228 229 230
}


#ifndef MYSQL_CLIENT
unknown's avatar
unknown committed
231 232
int my_decimal2string(uint mask, const my_decimal *d, uint fixed_prec,
		      uint fixed_dec, char filler, String *str);
unknown's avatar
unknown committed
233 234 235 236 237 238 239 240
#endif

inline
int my_decimal2int(uint mask, const my_decimal *d, my_bool unsigned_flag,
		   longlong *l)
{
  my_decimal rounded;
  /* decimal_round can return only E_DEC_TRUNCATED */
241
  decimal_round((decimal_t*)d, &rounded, 0, HALF_UP);
unknown's avatar
unknown committed
242 243 244 245 246 247 248 249 250
  return check_result(mask, (unsigned_flag ?
			     decimal2ulonglong(&rounded, (ulonglong *)l) :
			     decimal2longlong(&rounded, l)));
}


inline
int my_decimal2double(uint mask, const my_decimal *d, double *result)
{
251
  /* No need to call check_result as this will always succeed */
252
  return decimal2double((decimal_t*) d, result);
unknown's avatar
unknown committed
253 254 255 256
}


inline
257
int str2my_decimal(uint mask, const char *str, my_decimal *d, char **end)
unknown's avatar
unknown committed
258
{
259
  return check_result(mask, string2decimal(str, (decimal_t*) d, end));
unknown's avatar
unknown committed
260 261 262 263 264 265
}


int str2my_decimal(uint mask, const char *from, uint length,
                   CHARSET_INFO *charset, my_decimal *decimal_value);

266
#if defined(MYSQL_SERVER) || defined(EMBEDDED_LIBRARY)
unknown's avatar
unknown committed
267 268 269 270 271 272 273 274 275 276
inline
int string2my_decimal(uint mask, const String *str, my_decimal *d)
{
  return str2my_decimal(mask, str->ptr(), str->length(), str->charset(), d);
}
#endif

inline
int double2my_decimal(uint mask, double val, my_decimal *d)
{
277
  return check_result(mask, double2decimal(val, (decimal_t*) d));
unknown's avatar
unknown committed
278 279 280 281 282 283 284 285 286 287 288 289 290
}


inline
int int2my_decimal(uint mask, longlong i, my_bool unsigned_flag, my_decimal *d)
{
  return check_result(mask, (unsigned_flag ?
			     ulonglong2decimal((ulonglong)i, d) :
			     longlong2decimal(i, d)));
}


inline
291
void my_decimal_neg(decimal_t *arg)
unknown's avatar
unknown committed
292
{
unknown's avatar
unknown committed
293 294 295 296 297
  if (decimal_is_zero(arg))
  {
    arg->sign= 0;
    return;
  }
unknown's avatar
unknown committed
298 299 300 301 302 303 304 305
  decimal_neg(arg);
}


inline
int my_decimal_add(uint mask, my_decimal *res, const my_decimal *a,
		   const my_decimal *b)
{
306
  return check_result(mask, decimal_add((decimal_t*) a, (decimal_t*) b, res));
unknown's avatar
unknown committed
307 308 309 310 311 312 313
}


inline
int my_decimal_sub(uint mask, my_decimal *res, const my_decimal *a,
		   const my_decimal *b)
{
314
  return check_result(mask, decimal_sub((decimal_t*) a, (decimal_t*) b, res));
unknown's avatar
unknown committed
315 316 317 318 319 320 321
}


inline
int my_decimal_mul(uint mask, my_decimal *res, const my_decimal *a,
		   const my_decimal *b)
{
322
  return check_result(mask, decimal_mul((decimal_t*) a, (decimal_t*) b, res));
unknown's avatar
unknown committed
323 324 325 326 327 328 329
}


inline
int my_decimal_div(uint mask, my_decimal *res, const my_decimal *a,
		   const my_decimal *b, int div_scale_inc)
{
330
  return check_result(mask, decimal_div((decimal_t*) a, (decimal_t*) b, res,
unknown's avatar
unknown committed
331 332 333 334 335 336 337 338
					div_scale_inc));
}


inline
int my_decimal_mod(uint mask, my_decimal *res, const my_decimal *a,
		   const my_decimal *b)
{
339
  return check_result(mask, decimal_mod((decimal_t*) a, (decimal_t*) b, res));
unknown's avatar
unknown committed
340 341 342 343 344 345 346
}


/* Returns -1 if a<b, 1 if a>b and 0 if a==b */
inline
int my_decimal_cmp(const my_decimal *a, const my_decimal *b)
{
347
  return decimal_cmp((decimal_t*) a, (decimal_t*) b);
unknown's avatar
unknown committed
348 349 350 351 352
}

inline
void max_my_decimal(my_decimal *to, int precision, int frac)
{
unknown's avatar
unknown committed
353 354
  DBUG_ASSERT((precision <= DECIMAL_MAX_PRECISION)&&
              (frac <= DECIMAL_MAX_SCALE));
355
  max_decimal(precision, frac, (decimal_t*) to);
unknown's avatar
unknown committed
356 357 358 359
}

#endif /*my_decimal_h*/