Add functions to set a date from a time_t and from a GTimeVal.
[platform/upstream/glib.git] / glib / gdate.h
1 /* GLIB - Library of useful routines for C programming
2  * Copyright (C) 1995-1997  Peter Mattis, Spencer Kimball and Josh MacDonald
3  *
4  * This library is free software; you can redistribute it and/or
5  * modify it under the terms of the GNU Lesser General Public
6  * License as published by the Free Software Foundation; either
7  * version 2 of the License, or (at your option) any later version.
8  *
9  * This library is distributed in the hope that it will be useful,
10  * but 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, write to the
16  * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17  * Boston, MA 02111-1307, USA.
18  */
19
20 /*
21  * Modified by the GLib Team and others 1997-2000.  See the AUTHORS
22  * file for a list of people on the GLib Team.  See the ChangeLog
23  * files for a list of changes.  These files are distributed with
24  * GLib at ftp://ftp.gtk.org/pub/gtk/. 
25  */
26
27 #ifndef __G_DATE_H__
28 #define __G_DATE_H__
29
30 #include <time.h>
31
32 #include <glib/gtypes.h>
33 #include <glib/gquark.h>
34
35 G_BEGIN_DECLS
36
37 /* GDate
38  *
39  * Date calculations (not time for now, to be resolved). These are a
40  * mutant combination of Steffen Beyer's DateCalc routines
41  * (http://www.perl.com/CPAN/authors/id/STBEY/) and Jon Trowbridge's
42  * date routines (written for in-house software).  Written by Havoc
43  * Pennington <hp@pobox.com>
44  */
45
46 typedef gint32  GTime;
47 typedef guint16 GDateYear;
48 typedef guint8  GDateDay;   /* day of the month */
49 typedef struct _GDate GDate;
50 /* make struct tm known without having to include time.h */
51 struct tm;
52
53 /* enum used to specify order of appearance in parsed date strings */
54 typedef enum
55 {
56   G_DATE_DAY   = 0,
57   G_DATE_MONTH = 1,
58   G_DATE_YEAR  = 2
59 } GDateDMY;
60
61 /* actual week and month values */
62 typedef enum
63 {
64   G_DATE_BAD_WEEKDAY  = 0,
65   G_DATE_MONDAY       = 1,
66   G_DATE_TUESDAY      = 2,
67   G_DATE_WEDNESDAY    = 3,
68   G_DATE_THURSDAY     = 4,
69   G_DATE_FRIDAY       = 5,
70   G_DATE_SATURDAY     = 6,
71   G_DATE_SUNDAY       = 7
72 } GDateWeekday;
73 typedef enum
74 {
75   G_DATE_BAD_MONTH = 0,
76   G_DATE_JANUARY   = 1,
77   G_DATE_FEBRUARY  = 2,
78   G_DATE_MARCH     = 3,
79   G_DATE_APRIL     = 4,
80   G_DATE_MAY       = 5,
81   G_DATE_JUNE      = 6,
82   G_DATE_JULY      = 7,
83   G_DATE_AUGUST    = 8,
84   G_DATE_SEPTEMBER = 9,
85   G_DATE_OCTOBER   = 10,
86   G_DATE_NOVEMBER  = 11,
87   G_DATE_DECEMBER  = 12
88 } GDateMonth;
89
90 #define G_DATE_BAD_JULIAN 0U
91 #define G_DATE_BAD_DAY    0U
92 #define G_DATE_BAD_YEAR   0U
93
94 /* Note: directly manipulating structs is generally a bad idea, but
95  * in this case it's an *incredibly* bad idea, because all or part
96  * of this struct can be invalid at any given time. Use the functions,
97  * or you will get hosed, I promise.
98  */
99 struct _GDate
100 {
101   guint julian_days : 32; /* julian days representation - we use a
102                            *  bitfield hoping that 64 bit platforms
103                            *  will pack this whole struct in one big
104                            *  int
105                            */
106
107   guint julian : 1;    /* julian is valid */
108   guint dmy    : 1;    /* dmy is valid */
109
110   /* DMY representation */
111   guint day    : 6;
112   guint month  : 4;
113   guint year   : 16;
114 };
115
116 /* g_date_new() returns an invalid date, you then have to _set() stuff
117  * to get a usable object. You can also allocate a GDate statically,
118  * then call g_date_clear() to initialize.
119  */
120 GDate*       g_date_new                   (void);
121 GDate*       g_date_new_dmy               (GDateDay     day,
122                                            GDateMonth   month,
123                                            GDateYear    year);
124 GDate*       g_date_new_julian            (guint32      julian_day);
125 void         g_date_free                  (GDate       *date);
126
127 /* check g_date_valid() after doing an operation that might fail, like
128  * _parse.  Almost all g_date operations are undefined on invalid
129  * dates (the exceptions are the mutators, since you need those to
130  * return to validity).
131  */
132 gboolean     g_date_valid                 (const GDate *date);
133 gboolean     g_date_valid_day             (GDateDay     day) G_GNUC_CONST;
134 gboolean     g_date_valid_month           (GDateMonth month) G_GNUC_CONST;
135 gboolean     g_date_valid_year            (GDateYear  year) G_GNUC_CONST;
136 gboolean     g_date_valid_weekday         (GDateWeekday weekday) G_GNUC_CONST;
137 gboolean     g_date_valid_julian          (guint32 julian_date) G_GNUC_CONST;
138 gboolean     g_date_valid_dmy             (GDateDay     day,
139                                            GDateMonth   month,
140                                            GDateYear    year) G_GNUC_CONST;
141
142 GDateWeekday g_date_get_weekday           (const GDate *date);
143 GDateMonth   g_date_get_month             (const GDate *date);
144 GDateYear    g_date_get_year              (const GDate *date);
145 GDateDay     g_date_get_day               (const GDate *date);
146 guint32      g_date_get_julian            (const GDate *date);
147 guint        g_date_get_day_of_year       (const GDate *date);
148 /* First monday/sunday is the start of week 1; if we haven't reached
149  * that day, return 0. These are not ISO weeks of the year; that
150  * routine needs to be added.
151  * these functions return the number of weeks, starting on the
152  * corrsponding day
153  */
154 guint        g_date_get_monday_week_of_year (const GDate *date);
155 guint        g_date_get_sunday_week_of_year (const GDate *date);
156 guint        g_date_get_iso8601_week_of_year (const GDate *date);
157
158 /* If you create a static date struct you need to clear it to get it
159  * in a sane state before use. You can clear a whole array at
160  * once with the ndates argument.
161  */
162 void         g_date_clear                 (GDate       *date,
163                                            guint        n_dates);
164
165 /* The parse routine is meant for dates typed in by a user, so it
166  * permits many formats but tries to catch common typos. If your data
167  * needs to be strictly validated, it is not an appropriate function.
168  */
169 void         g_date_set_parse             (GDate       *date,
170                                            const gchar *str);
171 void         g_date_set_time_t            (GDate       *date,
172                                            time_t       timet);
173 void         g_date_set_time_val          (GDate       *date,
174                                            GTimeVal    *timeval);
175 #ifndef G_DISABLE_DEPRECATED
176 void         g_date_set_time              (GDate       *date,
177                                            GTime        time_);
178 #endif
179 void         g_date_set_month             (GDate       *date,
180                                            GDateMonth   month);
181 void         g_date_set_day               (GDate       *date,
182                                            GDateDay     day);
183 void         g_date_set_year              (GDate       *date,
184                                            GDateYear    year);
185 void         g_date_set_dmy               (GDate       *date,
186                                            GDateDay     day,
187                                            GDateMonth   month,
188                                            GDateYear    y);
189 void         g_date_set_julian            (GDate       *date,
190                                            guint32      julian_date);
191 gboolean     g_date_is_first_of_month     (const GDate *date);
192 gboolean     g_date_is_last_of_month      (const GDate *date);
193
194 /* To go forward by some number of weeks just go forward weeks*7 days */
195 void         g_date_add_days              (GDate       *date,
196                                            guint        n_days);
197 void         g_date_subtract_days         (GDate       *date,
198                                            guint        n_days);
199
200 /* If you add/sub months while day > 28, the day might change */
201 void         g_date_add_months            (GDate       *date,
202                                            guint        n_months);
203 void         g_date_subtract_months       (GDate       *date,
204                                            guint        n_months);
205
206 /* If it's feb 29, changing years can move you to the 28th */
207 void         g_date_add_years             (GDate       *date,
208                                            guint        n_years);
209 void         g_date_subtract_years        (GDate       *date,
210                                            guint        n_years);
211 gboolean     g_date_is_leap_year          (GDateYear    year) G_GNUC_CONST;
212 guint8       g_date_get_days_in_month     (GDateMonth   month,
213                                            GDateYear    year) G_GNUC_CONST;
214 guint8       g_date_get_monday_weeks_in_year  (GDateYear    year) G_GNUC_CONST;
215 guint8       g_date_get_sunday_weeks_in_year  (GDateYear    year) G_GNUC_CONST;
216
217 /* Returns the number of days between the two dates.  If date2 comes
218    before date1, a negative value is return. */
219 gint         g_date_days_between          (const GDate *date1,
220                                            const GDate *date2);
221
222 /* qsort-friendly (with a cast...) */
223 gint         g_date_compare               (const GDate *lhs,
224                                            const GDate *rhs);
225 void         g_date_to_struct_tm          (const GDate *date,
226                                            struct tm   *tm);
227
228 void         g_date_clamp                 (GDate *date,
229                                            const GDate *min_date,
230                                            const GDate *max_date);
231
232 /* Swap date1 and date2's values if date1 > date2. */
233 void         g_date_order                 (GDate *date1, GDate *date2);
234
235 /* Just like strftime() except you can only use date-related formats.
236  *   Using a time format is undefined.
237  */
238 gsize        g_date_strftime              (gchar       *s,
239                                            gsize        slen,
240                                            const gchar *format,
241                                            const GDate *date);
242
243 #ifndef G_DISABLE_DEPRECATED
244
245 #define g_date_weekday                  g_date_get_weekday
246 #define g_date_month                    g_date_get_month
247 #define g_date_year                     g_date_get_year
248 #define g_date_day                      g_date_get_day
249 #define g_date_julian                   g_date_get_julian
250 #define g_date_day_of_year              g_date_get_day_of_year
251 #define g_date_monday_week_of_year      g_date_get_monday_week_of_year
252 #define g_date_sunday_week_of_year      g_date_get_sunday_week_of_year
253 #define g_date_days_in_month            g_date_get_days_in_month
254 #define g_date_monday_weeks_in_year     g_date_get_monday_weeks_in_year
255 #define g_date_sunday_weeks_in_year     g_date_get_sunday_weeks_in_year
256
257 #endif /* G_DISABLE_DEPRECATED */
258
259 G_END_DECLS
260
261 #endif /* __G_DATE_H__ */
262