← Back to branch summary

~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to mysys/my_time.h

  • Committer: Monty Taylor
  • Date: 2010-12-24 02:13:05 UTC
  • mto: This revision was merged to the branch mainline in revision 2038.
  • Revision ID: mordred@inaugust.com-20101224021305-e3slv1cyjczqorij
Changed the bzrignore file.

Show diffs side-by-side

added added

removed removed

Lines of Context:
mysys/my_time.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
 
/*
22
 
  This is a private header of sql-common library, containing
23
 
  declarations for my_time.c
24
 
*/
25
 
 
26
 
#ifndef _libdrizzle_my_time_h_
27
 
#define _libdrizzle_my_time_h_
28
 
 
29
 
#include <drizzled/global.h>
30
 
#include "drizzle_time.h"
31
 
 
32
 
#ifdef __cplusplus
33
 
extern "C" {
34
 
#endif
35
 
 
36
 
extern uint64_t log_10_int[20];
37
 
extern unsigned char days_in_month[];
38
 
 
39
 
/*
40
 
  Portable time_t replacement.
41
 
  Should be signed and hold seconds for 1902 -- 2038-01-19 range
42
 
  i.e at least a 32bit variable
43
 
 
44
 
  Using the system built in time_t is not an option as
45
 
  we rely on the above requirements in the time functions
46
 
 
47
 
  For example QNX has an unsigned time_t type
48
 
*/
49
 
typedef long my_time_t;
50
 
 
51
 
#define MY_TIME_T_MAX INT32_MAX
52
 
#define MY_TIME_T_MIN INT32_MIN
53
 
 
54
 
/* Time handling defaults */
55
 
#define TIMESTAMP_MAX_YEAR 2038
56
 
#define TIMESTAMP_MIN_YEAR (1900 + YY_PART_YEAR - 1)
57
 
#define TIMESTAMP_MAX_VALUE INT32_MAX
58
 
#define TIMESTAMP_MIN_VALUE 1
59
 
 
60
 
/* two-digit years < this are 20..; >= this are 19.. */
61
 
#define YY_PART_YEAR       70
62
 
 
63
 
/* Flags to str_to_datetime */
64
 
#define TIME_FUZZY_DATE         1
65
 
#define TIME_DATETIME_ONLY      2
66
 
/* Must be same as MODE_NO_ZERO_IN_DATE */
67
 
#define TIME_NO_ZERO_IN_DATE    (65536L*2*2*2*2*2*2*2)
68
 
/* Must be same as MODE_NO_ZERO_DATE */
69
 
#define TIME_NO_ZERO_DATE       (TIME_NO_ZERO_IN_DATE*2)
70
 
#define TIME_INVALID_DATES      (TIME_NO_ZERO_DATE*2)
71
 
 
72
 
#define DRIZZLE_TIME_WARN_TRUNCATED    1
73
 
#define DRIZZLE_TIME_WARN_OUT_OF_RANGE 2
74
 
 
75
 
/* Limits for the TIME data type */
76
 
#define TIME_MAX_HOUR 838
77
 
#define TIME_MAX_MINUTE 59
78
 
#define TIME_MAX_SECOND 59
79
 
#define TIME_MAX_VALUE (TIME_MAX_HOUR*10000 + TIME_MAX_MINUTE*100 + \
80
 
                        TIME_MAX_SECOND)
81
 
#define TIME_MAX_VALUE_SECONDS (TIME_MAX_HOUR * 3600L + \
82
 
                                TIME_MAX_MINUTE * 60L + TIME_MAX_SECOND)
83
 
 
84
 
bool check_date(const DRIZZLE_TIME *ltime, bool not_zero_date,
85
 
                   uint32_t flags, int *was_cut);
86
 
enum enum_drizzle_timestamp_type
87
 
str_to_datetime(const char *str, uint32_t length, DRIZZLE_TIME *l_time,
88
 
                uint32_t flags, int *was_cut);
89
 
int64_t number_to_datetime(int64_t nr, DRIZZLE_TIME *time_res,
90
 
                            uint32_t flags, int *was_cut);
91
 
uint64_t TIME_to_uint64_t_datetime(const DRIZZLE_TIME *);
92
 
uint64_t TIME_to_uint64_t_date(const DRIZZLE_TIME *);
93
 
uint64_t TIME_to_uint64_t_time(const DRIZZLE_TIME *);
94
 
uint64_t TIME_to_uint64_t(const DRIZZLE_TIME *);
95
 
 
96
 
 
97
 
bool str_to_time(const char *str,uint32_t length, DRIZZLE_TIME *l_time,
98
 
                 int *warning);
99
 
 
100
 
int check_time_range(DRIZZLE_TIME *my_time, int *warning);
101
 
 
102
 
long calc_daynr(uint32_t year,uint32_t month,uint32_t day);
103
 
uint32_t calc_days_in_year(uint32_t year);
104
 
uint32_t year_2000_handling(uint32_t year);
105
 
 
106
 
void init_time(void);
107
 
 
108
 
 
109
 
/*
110
 
  Function to check sanity of a TIMESTAMP value
111
 
 
112
 
  DESCRIPTION
113
 
    Check if a given DRIZZLE_TIME value fits in TIMESTAMP range.
114
 
    This function doesn't make precise check, but rather a rough
115
 
    estimate.
116
 
 
117
 
  RETURN VALUES
118
 
    false   The value seems sane
119
 
    true    The DRIZZLE_TIME value is definitely out of range
120
 
*/
121
 
 
122
 
static inline bool validate_timestamp_range(const DRIZZLE_TIME *t)
123
 
{
124
 
  if ((t->year > TIMESTAMP_MAX_YEAR || t->year < TIMESTAMP_MIN_YEAR) ||
125
 
      (t->year == TIMESTAMP_MAX_YEAR && (t->month > 1 || t->day > 19)) ||
126
 
      (t->year == TIMESTAMP_MIN_YEAR && (t->month < 12 || t->day < 31)))
127
 
    return false;
128
 
 
129
 
  return true;
130
 
}
131
 
 
132
 
my_time_t 
133
 
my_system_gmt_sec(const DRIZZLE_TIME *t, long *my_timezone,
134
 
                  bool *in_dst_time_gap);
135
 
 
136
 
void set_zero_time(DRIZZLE_TIME *tm, enum enum_drizzle_timestamp_type time_type);
137
 
 
138
 
/*
139
 
  Required buffer length for my_time_to_str, my_date_to_str,
140
 
  my_datetime_to_str and TIME_to_string functions. Note, that the
141
 
  caller is still responsible to check that given TIME structure
142
 
  has values in valid ranges, otherwise size of the buffer could
143
 
  be not enough. We also rely on the fact that even wrong values
144
 
  sent using binary protocol fit in this buffer.
145
 
*/
146
 
#define MAX_DATE_STRING_REP_LENGTH 30
147
 
 
148
 
int my_time_to_str(const DRIZZLE_TIME *l_time, char *to);
149
 
int my_date_to_str(const DRIZZLE_TIME *l_time, char *to);
150
 
int my_datetime_to_str(const DRIZZLE_TIME *l_time, char *to);
151
 
int my_TIME_to_str(const DRIZZLE_TIME *l_time, char *to);
152
 
 
153
 
/* 
154
 
  Available interval types used in any statement.
155
 
 
156
 
  'interval_type' must be sorted so that simple intervals comes first,
157
 
  ie year, quarter, month, week, day, hour, etc. The order based on
158
 
  interval size is also important and the intervals should be kept in a
159
 
  large to smaller order. (get_interval_value() depends on this)
160
 
 
161
 
  Note: If you change the order of elements in this enum you should fix 
162
 
  order of elements in 'interval_type_to_name' and 'interval_names' 
163
 
  arrays 
164
 
  
165
 
  See also interval_type_to_name, get_interval_value, interval_names
166
 
*/
167
 
 
168
 
enum interval_type
169
 
{
170
 
  INTERVAL_YEAR, INTERVAL_QUARTER, INTERVAL_MONTH, INTERVAL_WEEK, INTERVAL_DAY,
171
 
  INTERVAL_HOUR, INTERVAL_MINUTE, INTERVAL_SECOND, INTERVAL_MICROSECOND,
172
 
  INTERVAL_YEAR_MONTH, INTERVAL_DAY_HOUR, INTERVAL_DAY_MINUTE,
173
 
  INTERVAL_DAY_SECOND, INTERVAL_HOUR_MINUTE, INTERVAL_HOUR_SECOND,
174
 
  INTERVAL_MINUTE_SECOND, INTERVAL_DAY_MICROSECOND, INTERVAL_HOUR_MICROSECOND,
175
 
  INTERVAL_MINUTE_MICROSECOND, INTERVAL_SECOND_MICROSECOND, INTERVAL_LAST
176
 
};
177
 
 
178
 
#ifdef __cplusplus
179
 
}
180
 
#endif
181
 
 
182
 
#endif /* _libdrizzle_my_time_h_ */