API: lib: renamed TimeZone to StaticTimeZone, along with API functions
[barry.git] / src / time.cc
blob67f27bd0c82d464690feb260e3f9141450ee6d6e
1 ///
2 /// \file time.cc
3 /// Conversion between time_t and cenmin_t and back.
4 /// time_t is the POSIX time, seconds from Jan 1, 1970
5 /// min1900_t is the minutes from Jan 1, 1900
6 ///
8 /*
9 Copyright (C) 2005-2012, Net Direct Inc. (http://www.netdirect.ca/)
11 This program is free software; you can redistribute it and/or modify
12 it under the terms of the GNU General Public License as published by
13 the Free Software Foundation; either version 2 of the License, or
14 (at your option) any later version.
16 This program is distributed in the hope that it will be useful,
17 but WITHOUT ANY WARRANTY; without even the implied warranty of
18 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
20 See the GNU General Public License in the COPYING file at the
21 root directory of this project for more details.
24 #include "time.h"
25 #include "endian.h"
26 #include "debug.h"
27 #include "platform.h"
29 namespace Barry {
31 StaticTimeZone Zones[] = {
32 { 0x0000, -12, 0, "Eniwetok, Kwajalein (-12)" },
33 { 0x0001, -12, 0, "Midway Island, Samoa (-12)" },
34 { 0x0002, -10, 0, "Hawaii (-10)" },
35 { 0x0003, -9, 0, "Alaska (-9)" },
36 { 0x0004, -8, 0, "Pacific Time (US & Canada), Tijuana (-8)" },
37 { 0x000a, -7, 0, "Mountain Time (US & Canada) (-7)" },
38 { 0x000f, -7, 0, "Arizona (-7)" },
39 { 0x000d, -7, 0, "Chihuahua, La Paz, Mazatlan (-7)" },
40 { 0x0014, -6, 0, "Central Time (US & Canada) (-6)" },
41 { 0x0021, -6, 0, "Central America (-6)" },
42 { 0x0019, -6, 0, "Saskatchewan (-6)" },
43 { 0x001e, -6, 0, "Mexico City (-6)" },
44 { 0x0023, -5, 0, "Eastern Time (US & Canada) (-5)" },
45 { 0x002d, -5, 0, "Bogota, Lima, Quito (-5)" },
46 { 0x0028, -5, 0, "Indiana (East) (-5)" },
47 { 0x0032, -4, 0, "Atlantic Time (Canada) (-4)" },
48 { 0x0037, -4, 0, "Caracas, La Paz (-4)" },
49 { 0x0038, -4, 0, "Santiago (-4)" },
50 { 0x003c, -3, -30, "Newfoundland (-3.5)" },
51 { 0x0046, -3, 0, "Buenos Aires, Georgetown (-3)" },
52 { 0x0041, -3, 0, "Brasilia (-3)" },
53 { 0x0049, -3, 0, "Greenland (-3)" },
54 { 0x004b, -2, 0, "Mid-Atlantic (-2)" },
55 { 0x0053, -1, 0, "Cape Verde Island (-1)" },
56 { 0x0050, -1, 0, "Azores (-1)" },
57 { 0x0055, 0, 0, "Dublin, Edinburgh, Lisbon, London (GMT)" },
58 { 0x005a, 0, 0, "Casablanca, Monrovia (GMT)" },
59 { 0x006e, 1, 0, "Amsterdam, Berlin, Bern, Rome, Stockholm, Vienna (+1)" },
60 { 0x0071, 1, 0, "West Central Africa (+1)" },
61 { 0x005f, 1, 0, "Belgrade, Bratislava, Budapest, Ljubljana, Prague (+1)" },
62 { 0x0069, 1, 0, "Brussels, Copenhagen, Madrid, Paris (+1)" },
63 { 0x0064, 1, 0, "Sarajevo, Skopje, Sofija, Vilnius, Warsaw, Zagreb (+1)" },
64 { 0x008c, 2, 0, "Harare, Pretoria (+2)" },
65 { 0x0087, 2, 0, "Jerusalem (+2)" },
66 { 0x0073, 2, 0, "Bucharest (+2)" },
67 { 0x0078, 2, 0, "Cairo (+2)" },
68 { 0x0082, 2, 0, "Athens, Istanbul, Minsk (+2)" },
69 { 0x007d, 2, 0, "Helsinki, Riga, Tallinn (+2)" },
70 { 0x0096, 3, 0, "Kuwait, Riyadh (+3)" },
71 { 0x009b, 3, 0, "Nairobi (+3)" },
72 { 0x009e, 3, 0, "Baghdad (+3)" },
73 { 0x0091, 3, 0, "Moscow, St. Petersburg, Volgograd (+3)" },
74 { 0x00a0, 3, 30, "Tehran (+3.5)" },
75 { 0x00a5, 4, 0, "Abu Dhabi, Muscat (+4)" },
76 { 0x00aa, 4, 0, "Baku, Tbilisi, Yerevan (+4)" },
77 { 0x00af, 4, 30, "Kabul (+4.5)" },
78 { 0x00b9, 5, 0, "Islamabad, Karachi, Tashkent (+5)" },
79 { 0x00b4, 5, 0, "Ekaterinburg (+5)" },
80 { 0x00be, 5, 30, "Calcutta, Chennai, Mumbai, New Delhi (+5.5)" },
81 { 0x00c1, 5, 45, "Kathmandu (+5.75)" },
82 { 0x00c3, 6, 0, "Astana, Dhaka (+6)" },
83 { 0x00c8, 6, 0, "Sri Lanka (+6)" },
84 { 0x00c9, 6, 0, "Almaty, Novosibirsk (+6)" },
85 { 0x00cb, 6, 30, "Rangoon (+6.5)" },
86 { 0x00cd, 7, 0, "Bangkok, Hanoi, Jakarta (+7)" },
87 { 0x00cf, 7, 0, "Krasnoyarsk (+7)" },
88 { 0x00d2, 8, 0, "Beijing, Chongqing, Hong Kong, Urumqi (+8)" },
89 { 0x00d7, 8, 0, "Kuala Lumpur, Singapore (+8)" },
90 { 0x00e1, 8, 0, "Perth (+8)" },
91 { 0x00dc, 8, 0, "Taipei (+8)" },
92 { 0x00e3, 8, 0, "Irkutsk, Ulaan Bataar (+8)" },
93 { 0x00eb, 9, 0, "Osaka, Sapporo, Tokyo (+9)" },
94 { 0x00e6, 9, 0, "Seoul (+9)" },
95 { 0x00f0, 9, 0, "Yakutsk (+9)" },
96 { 0x00f5, 9, 30, "Darwin (+9.5)" },
97 { 0x00fa, 9, 30, "Adelaide (+9.5)" },
98 { 0x0104, 10, 0, "Brisbane (+10)" },
99 { 0x0113, 10, 0, "Guam, Port Moresby (+10)" },
100 { 0x00ff, 10, 0, "Canberra, Melbourne, Sydney (+10)" },
101 { 0x0109, 10, 0, "Hobart (+10)" },
102 { 0x010e, 10, 0, "Vladivostok (+10)" },
103 { 0x0118, 11, 0, "Magadan, Solomon Islands, New Caledonia (+11)" },
104 { 0x011d, 12, 0, "Fiji, Kamchatka, Marshall Islands (+12)" },
105 { 0x0122, 12, 0, "Auckland, Wellington (+12)" },
106 { 0x012c, 13, 0, "Nuku'alofa (+13)" },
107 { 0, 0, 0, 0 }
110 min1900_t time2min(time_t t)
112 if( t == 0 )
113 return htobl(0xffffffff);
115 min1900_t r = t / 60 + STDC_MIN1900_DIFF;
116 return htobl(r);
119 time_t min2time(min1900_t m)
121 if( (unsigned long) btohl(m) == 0xffffffff )
122 return 0;
123 else
124 return (btohl(m) - STDC_MIN1900_DIFF) * 60;
129 // GetStaticTimeZoneTable
131 /// Returns a pointer to an array of StaticTimeZone structs.
132 /// The last struct contains 0 in all fields, and can be used as
133 /// an "end of array" marker.
135 const StaticTimeZone* GetStaticTimeZoneTable()
137 return Zones;
141 // GetStaticTimeZone
143 /// Searches the internal timezone code table for the given Code
144 /// and returns a pointer to a StaticTimeZone struct found. If the
145 /// code is not found, a pointer to a valid StaticTimeZone struct is
146 /// is still returned, but the struct's Code contains STATIC_TIME_ZONE_CODE_ERR,
147 /// and the name is "Unknown time zone." The unknown timezone
148 /// is the same offset as GMT.
150 const StaticTimeZone* GetStaticTimeZone(uint16_t Code)
152 static StaticTimeZone Unknown = { STATIC_TIME_ZONE_CODE_ERR, 0, 0, "Unknown time zone" };
154 for( StaticTimeZone *z = Zones; z->Name; z++ ) {
155 if( Code == z->Code )
156 return z;
158 return &Unknown;
162 // GetStaticTimeZoneCode
164 /// Searches the internal timezone table for the first matching
165 /// Code. If no matching Code is found, STATIC_TIME_ZONE_CODE_ERR is returned.
167 /// This function does not adjust for daylight saving time.
169 uint16_t GetStaticTimeZoneCode(signed short HourOffset,
170 signed short MinOffset)
172 for( StaticTimeZone *z = Zones; z->Name; z++ ) {
173 if( HourOffset == z->HourOffset && MinOffset == z->MinOffset )
174 return z->Code;
176 return STATIC_TIME_ZONE_CODE_ERR;
179 /// This routine takes the day of the year and
180 /// returns a time_t adjusted from the first of
181 /// the year.
183 /// FIXME This function assumes the year hasn't changed,
184 /// but I don't have enough information to determine
185 /// where the year is in this header info
187 time_t DayToDate( uint16_t Day )
189 struct tm *now, then;
190 time_t t = time( NULL );
192 now = localtime( &t ); // need this to get year
193 // set to Jan 1 midnight, this year;
194 then.tm_sec = 0;
195 then.tm_min = 0;
196 then.tm_hour = 0;
197 then.tm_mday = 0;
198 then.tm_mon = 0;
199 then.tm_year = now->tm_year;
200 then.tm_isdst = -1;
201 t = mktime(&then);
202 t -= 60*60; // need to subract an hour
203 t += Day * 24 * 60 * 60; // Add the day converted to seconds
205 return t;
209 // Message2Time
211 /// Localize the funky math used to convert a Blackberry message
212 /// timestamp into a time_t.
214 /// Both r_date and r_time are expected to be fed in from the
215 /// Protocol::MessageRecord struct in raw form, without endian
216 /// conversion. This function handles that.
218 time_t Message2Time(uint16_t r_date, uint16_t r_time)
220 dout("Message2Time(0x" << std::hex << btohs(r_date) << ", 0x"
221 << btohs(r_time) << ")");
223 time_t result = ( btohs(r_date) & 0x01ff ) - 0x29;
224 result = DayToDate( result );
225 result += (time_t)( btohs(r_time)*1.77 );
227 dout("Message2Time result: " << ctime(&result));
228 return result;
232 // ThreadTimeout
234 /// Creates a pthread_cond_timedwait() compatible timespec struct,
235 /// based on a given timeout in milliseconds. Note that the resulting
236 /// timespec is time-sensitive: the 'timer' starts as soon as this function
237 /// returns, since timespec is a specific time in the future,
238 /// and ThreadTimeout() calculates it based on the current time.
240 /// Returns the spec pointer, to make it easy to use with
241 /// pthread_cond_timedwait()
243 struct timespec* ThreadTimeout(int timeout_ms, struct timespec *spec)
245 #ifndef WIN32
246 struct timeval now;
247 gettimeofday(&now, NULL);
249 spec->tv_sec = now.tv_sec + timeout_ms / 1000;
250 spec->tv_nsec = (now.tv_usec + timeout_ms % 1000 * 1000) * 1000;
251 #else
252 SYSTEMTIME now;
253 GetSystemTime(&now);
255 spec->tv_sec = now.wSecond + timeout_ms / 1000;
256 spec->tv_nsec = (now.wMilliseconds + timeout_ms) * 1000;
257 #endif
259 return spec;
264 } // namespace Barry
267 #ifdef __TEST_MODE__
269 #include <iostream>
270 #include <iomanip>
272 using namespace std;
273 using namespace Barry;
275 void display(const char *msg, time_t t)
277 cout << msg << ": " << ctime(&t);
278 cout << msg << " seconds: "
279 << setbase(10) << t
280 << "(0x" << setbase(16) << t << ")"
281 << endl;
282 cout << msg << " minutes: "
283 << setbase(10) << (t/60)
284 << "(0x" << setbase(16) << (t/60) << ")"
285 << endl;
286 cout << endl;
289 void calc(const char *msg, time_t t, min1900_t dbval)
291 cout << msg << endl;
292 display(" Initial time", t);
293 display(" DB Val", min2time(dbval));
296 int main()
298 struct tm start;
299 time_t t;
301 // set to Oct 4, 2005, 2pm;
302 start.tm_sec = 0;
303 start.tm_min = 0;
304 start.tm_hour = 14;
305 start.tm_mday = 4;
306 start.tm_mon = 9;
307 start.tm_year = 105;
308 start.tm_isdst = -1;
309 t = mktime(&start);
310 calc("Oct 4", t, 0x0350c118);
312 // comparison
313 t = time(NULL);
314 min1900_t m = time2min(t);
315 time_t tc = min2time(m);
316 cout << "Original time: " << t << endl;
317 cout << "time2min: " << m << endl;
318 cout << "min2time: " << tc << endl;
319 if( t == (tc + t % 60) )
320 cout << "Success! (orig == converted + mod)" << endl;
321 else
322 cout << "Failed!" << endl;
324 // time zone
325 cout << "Should say Eastern: " << GetStaticTimeZone(0x23)->Name << endl;
326 cout << "should say Unknown: " << GetStaticTimeZone(0xffff)->Name << endl;
329 #endif