~drizzle-trunk/drizzle/development

« back to all changes in this revision

Viewing changes to drizzled/tztime.h

  • Committer: Monty Taylor
  • Date: 2011-02-13 17:26:39 UTC
  • mfrom: (2157.2.2 give-in-to-pkg-config)
  • mto: This revision was merged to the branch mainline in revision 2166.
  • Revision ID: mordred@inaugust.com-20110213172639-nhy7i72sfhoq13ms
Merged in pkg-config fixes.

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
/* -*- mode: c++; c-basic-offset: 2; indent-tabs-mode: nil; -*-
 
2
 *  vim:expandtab:shiftwidth=2:tabstop=2:smarttab:
 
3
 *
 
4
 *  Copyright (C) 2008 Sun Microsystems, Inc.
 
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 DRIZZLED_TZTIME_H
 
22
#define DRIZZLED_TZTIME_H
 
23
 
 
24
#include <drizzled/memory/sql_alloc.h>
 
25
#include <drizzled/type/time.h>
 
26
 
 
27
#include "drizzled/type/time.h"
 
28
 
 
29
namespace drizzled
 
30
{
 
31
 
 
32
class String;
 
33
 
 
34
/**
 
35
  This class represents abstract time zone and provides
 
36
  basic interface for type::Time <-> type::Time::epoch_t conversion.
 
37
  Actual time zones which are specified by DB, or via offset
 
38
  or use system functions are its descendants.
 
39
*/
 
40
class Time_zone: public memory::SqlAlloc
 
41
{
 
42
public:
 
43
  Time_zone() {}                              /* Remove gcc warning */
 
44
  /**
 
45
    Converts local time in broken down type::Time representation to
 
46
    type::Time::epoch_t (UTC seconds since Epoch) represenation.
 
47
    Returns 0 in case of error. Sets in_dst_time_gap to true if date provided
 
48
    falls into spring time-gap (or lefts it untouched otherwise).
 
49
  */
 
50
  virtual type::Time::epoch_t TIME_to_gmt_sec(const type::Time &t,
 
51
                                              bool *in_dst_time_gap) const = 0;
 
52
  /**
 
53
    Converts time in type::Time::epoch_t representation to local time in
 
54
    broken down type::Time representation.
 
55
  */
 
56
  virtual void gmt_sec_to_TIME(type::Time &tmp, type::Time::epoch_t t) const = 0;
 
57
 
 
58
  /**
 
59
    Because of constness of String returned by get_name() time zone name
 
60
    have to be already zeroended to be able to use String::ptr() instead
 
61
    of c_ptr().
 
62
  */
 
63
  virtual const String * get_name() const = 0;
 
64
 
 
65
  /**
 
66
    We need this only for surpressing warnings, objects of this type are
 
67
    allocated on memory::Root and should not require destruction.
 
68
  */
 
69
  virtual ~Time_zone() {};
 
70
};
 
71
 
 
72
extern Time_zone * my_tz_SYSTEM;
 
73
Time_zone * my_tz_find(Session *session, const String *name);
 
74
bool     my_tz_init(Session *org_session, const char *default_tzname);
 
75
 
 
76
} /* namespace drizzled */
 
77
 
 
78
#endif /* DRIZZLED_TZTIME_H */