1/*
2 * Copyright © 2010 Codethink Limited
3 *
4 * This library is free software; you can redistribute it and/or modify
5 * it under the terms of the GNU Lesser General Public License as
6 * published by the Free Software Foundation; either version 2 of the
7 * licence, or (at your option) any later version.
8 *
9 * This library is distributed in the hope that it will be useful, but
10 * WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Lesser General Public License for more details.
13 *
14 * You should have received a copy of the GNU Lesser General Public
15 * License along with this library; if not, see <http://www.gnu.org/licenses/>.
16 *
17 * Author: Ryan Lortie <desrt@desrt.ca>
18 */
19
20#ifndef __G_TIME_ZONE_H__
21#define __G_TIME_ZONE_H__
22
23#if !defined (__GLIB_H_INSIDE__) && !defined (GLIB_COMPILATION)
24#error "Only <glib.h> can be included directly."
25#endif
26
27#include <glib/gtypes.h>
28
29G_BEGIN_DECLS
30
31typedef struct _GTimeZone GTimeZone;
32
33/**
34 * GTimeType:
35 * @G_TIME_TYPE_STANDARD: the time is in local standard time
36 * @G_TIME_TYPE_DAYLIGHT: the time is in local daylight time
37 * @G_TIME_TYPE_UNIVERSAL: the time is in UTC
38 *
39 * Disambiguates a given time in two ways.
40 *
41 * First, specifies if the given time is in universal or local time.
42 *
43 * Second, if the time is in local time, specifies if it is local
44 * standard time or local daylight time. This is important for the case
45 * where the same local time occurs twice (during daylight savings time
46 * transitions, for example).
47 */
48typedef enum
49{
50 G_TIME_TYPE_STANDARD,
51 G_TIME_TYPE_DAYLIGHT,
52 G_TIME_TYPE_UNIVERSAL
53} GTimeType;
54
55GLIB_AVAILABLE_IN_ALL
56GTimeZone * g_time_zone_new (const gchar *identifier);
57GLIB_AVAILABLE_IN_ALL
58GTimeZone * g_time_zone_new_utc (void);
59GLIB_AVAILABLE_IN_ALL
60GTimeZone * g_time_zone_new_local (void);
61
62GLIB_AVAILABLE_IN_ALL
63GTimeZone * g_time_zone_ref (GTimeZone *tz);
64GLIB_AVAILABLE_IN_ALL
65void g_time_zone_unref (GTimeZone *tz);
66
67GLIB_AVAILABLE_IN_ALL
68gint g_time_zone_find_interval (GTimeZone *tz,
69 GTimeType type,
70 gint64 time_);
71
72GLIB_AVAILABLE_IN_ALL
73gint g_time_zone_adjust_time (GTimeZone *tz,
74 GTimeType type,
75 gint64 *time_);
76
77GLIB_AVAILABLE_IN_ALL
78const gchar * g_time_zone_get_abbreviation (GTimeZone *tz,
79 gint interval);
80GLIB_AVAILABLE_IN_ALL
81gint32 g_time_zone_get_offset (GTimeZone *tz,
82 gint interval);
83GLIB_AVAILABLE_IN_ALL
84gboolean g_time_zone_is_dst (GTimeZone *tz,
85 gint interval);
86
87G_END_DECLS
88
89#endif /* __G_TIME_ZONE_H__ */
90