-
-
Notifications
You must be signed in to change notification settings - Fork 694
/
timezone.d
3535 lines (2888 loc) · 126 KB
/
timezone.d
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Written in the D programming language
/++
$(SCRIPT inhibitQuickIndex = 1;)
$(DIVC quickindex,
$(BOOKTABLE,
$(TR $(TH Category) $(TH Functions))
$(TR $(TD Time zones) $(TD
$(LREF TimeZone)
$(LREF UTC)
$(LREF LocalTime)
$(LREF PosixTimeZone)
$(LREF WindowsTimeZone)
$(LREF SimpleTimeZone)
))
$(TR $(TD Utilities) $(TD
$(LREF clearTZEnvVar)
$(LREF parseTZConversions)
$(LREF setTZEnvVar)
$(LREF TZConversions)
))
))
License: $(HTTP www.boost.org/LICENSE_1_0.txt, Boost License 1.0).
Authors: $(HTTP jmdavisprog.com, Jonathan M Davis)
Source: $(PHOBOSSRC std/datetime/timezone.d)
+/
module std.datetime.timezone;
import core.time : abs, convert, dur, Duration, hours, minutes;
import std.datetime.systime : Clock, stdTimeToUnixTime, SysTime;
import std.range.primitives : back, empty, front, isOutputRange, popFront;
import std.traits : isIntegral, isSomeString;
version (OSX)
version = Darwin;
else version (iOS)
version = Darwin;
else version (TVOS)
version = Darwin;
else version (WatchOS)
version = Darwin;
version (Windows)
{
import core.stdc.time : time_t;
import core.sys.windows.winbase;
import core.sys.windows.winsock2;
import std.windows.registry;
// Uncomment and run unittests to print missing Windows TZ translations.
// Please subscribe to Microsoft Daylight Saving Time & Time Zone Blog
// (https://blogs.technet.microsoft.com/dst2007/) if you feel responsible
// for updating the translations.
// version = UpdateWindowsTZTranslations;
}
else version (Posix)
{
import core.sys.posix.signal : timespec;
import core.sys.posix.sys.types : time_t;
}
version (StdUnittest) import std.exception : assertThrown;
/++
Represents a time zone. It is used with $(REF SysTime,std,datetime,systime)
to indicate the time zone of a $(REF SysTime,std,datetime,systime).
+/
abstract class TimeZone
{
public:
/++
The name of the time zone. Exactly how the time zone name is formatted
depends on the derived class. In the case of $(LREF PosixTimeZone), it's
the TZ Database name, whereas with $(LREF WindowsTimeZone), it's the
name that Windows chose to give the registry key for that time zone
(typically the name that they give $(LREF stdTime) if the OS is in
English). For other time zone types, what it is depends on how they're
implemented.
See_Also:
$(HTTP en.wikipedia.org/wiki/Tz_database, Wikipedia entry on TZ
Database)<br>
$(HTTP en.wikipedia.org/wiki/List_of_tz_database_time_zones, List of
Time Zones)
+/
@property string name() @safe const nothrow
{
return _name;
}
/++
Typically, the abbreviation (generally 3 or 4 letters) for the time zone
when DST is $(I not) in effect (e.g. PST). It is not necessarily unique.
However, on Windows, it may be the unabbreviated name (e.g. Pacific
Standard Time). Regardless, it is not the same as name.
+/
@property string stdName() @safe const nothrow
{
return _stdName;
}
/++
Typically, the abbreviation (generally 3 or 4 letters) for the time zone
when DST $(I is) in effect (e.g. PDT). It is not necessarily unique.
However, on Windows, it may be the unabbreviated name (e.g. Pacific
Daylight Time). Regardless, it is not the same as name.
+/
@property string dstName() @safe const nothrow
{
return _dstName;
}
/++
Whether this time zone has Daylight Savings Time at any point in time.
Note that for some time zone types it may not have DST for current dates
but will still return true for `hasDST` because the time zone did at
some point have DST.
+/
@property abstract bool hasDST() @safe const nothrow;
/++
Takes the number of hnsecs (100 ns) since midnight, January 1st, 1 A.D.
in UTC time (i.e. std time) and returns whether DST is effect in this
time zone at the given point in time.
Params:
stdTime = The UTC time that needs to be checked for DST in this time
zone.
+/
abstract bool dstInEffect(long stdTime) @safe const nothrow;
/++
Takes the number of hnsecs (100 ns) since midnight, January 1st, 1 A.D.
in UTC time (i.e. std time) and converts it to this time zone's time.
Params:
stdTime = The UTC time that needs to be adjusted to this time zone's
time.
+/
abstract long utcToTZ(long stdTime) @safe const nothrow;
/++
Takes the number of hnsecs (100 ns) since midnight, January 1st, 1 A.D.
in this time zone's time and converts it to UTC (i.e. std time).
Params:
adjTime = The time in this time zone that needs to be adjusted to
UTC time.
+/
abstract long tzToUTC(long adjTime) @safe const nothrow;
/++
Returns what the offset from UTC is at the given std time.
It includes the DST offset in effect at that time (if any).
Params:
stdTime = The UTC time for which to get the offset from UTC for this
time zone.
+/
Duration utcOffsetAt(long stdTime) @safe const nothrow
{
return dur!"hnsecs"(utcToTZ(stdTime) - stdTime);
}
// The purpose of this is to handle the case where a Windows time zone is
// new and exists on an up-to-date Windows box but does not exist on Windows
// boxes which have not been properly updated. The "date added" is included
// on the theory that we'll be able to remove them at some point in the
// the future once enough time has passed, and that way, we know how much
// time has passed.
private static string _getOldName(string windowsTZName) @safe pure nothrow
{
switch (windowsTZName)
{
case "Belarus Standard Time": return "Kaliningrad Standard Time"; // Added 2014-10-08
case "Russia Time Zone 10": return "Magadan Standard Time"; // Added 2014-10-08
case "Russia Time Zone 11": return "Magadan Standard Time"; // Added 2014-10-08
case "Russia Time Zone 3": return "Russian Standard Time"; // Added 2014-10-08
default: return null;
}
}
// Since reading in the time zone files could be expensive, most unit tests
// are consolidated into this one unittest block which minimizes how often
// it reads a time zone file.
@system unittest
{
import core.exception : AssertError;
import std.conv : to;
import std.file : exists, isFile;
import std.format : format;
import std.path : chainPath;
import std.stdio : writefln;
import std.typecons : tuple;
version (Posix) alias getTimeZone = PosixTimeZone.getTimeZone;
else version (Windows) alias getTimeZone = WindowsTimeZone.getTimeZone;
version (Posix) scope(exit) clearTZEnvVar();
static immutable(TimeZone) testTZ(string tzName,
string stdName,
string dstName,
Duration utcOffset,
Duration dstOffset,
bool north = true)
{
scope(failure) writefln("Failed time zone: %s", tzName);
version (Posix)
{
immutable tz = PosixTimeZone.getTimeZone(tzName);
assert(tz.name == tzName);
}
else version (Windows)
{
immutable tz = WindowsTimeZone.getTimeZone(tzName);
assert(tz.name == stdName);
}
immutable hasDST = dstOffset != Duration.zero;
//assert(tz.stdName == stdName); //Locale-dependent
//assert(tz.dstName == dstName); //Locale-dependent
assert(tz.hasDST == hasDST);
import std.datetime.date : DateTime;
immutable stdDate = DateTime(2010, north ? 1 : 7, 1, 6, 0, 0);
immutable dstDate = DateTime(2010, north ? 7 : 1, 1, 6, 0, 0);
auto std = SysTime(stdDate, tz);
auto dst = SysTime(dstDate, tz);
auto stdUTC = SysTime(stdDate - utcOffset, UTC());
auto dstUTC = SysTime(stdDate - utcOffset + dstOffset, UTC());
assert(!std.dstInEffect);
assert(dst.dstInEffect == hasDST);
assert(tz.utcOffsetAt(std.stdTime) == utcOffset);
assert(tz.utcOffsetAt(dst.stdTime) == utcOffset + dstOffset);
assert(cast(DateTime) std == stdDate);
assert(cast(DateTime) dst == dstDate);
assert(std == stdUTC);
version (Posix)
{
setTZEnvVar(tzName);
static void testTM(scope const SysTime st)
{
import core.stdc.time : tm;
import core.sys.posix.time : localtime_r;
time_t unixTime = st.toUnixTime();
tm osTimeInfo = void;
localtime_r(&unixTime, &osTimeInfo);
tm ourTimeInfo = st.toTM();
assert(ourTimeInfo.tm_sec == osTimeInfo.tm_sec);
assert(ourTimeInfo.tm_min == osTimeInfo.tm_min);
assert(ourTimeInfo.tm_hour == osTimeInfo.tm_hour);
assert(ourTimeInfo.tm_mday == osTimeInfo.tm_mday);
assert(ourTimeInfo.tm_mon == osTimeInfo.tm_mon);
assert(ourTimeInfo.tm_year == osTimeInfo.tm_year);
assert(ourTimeInfo.tm_wday == osTimeInfo.tm_wday);
assert(ourTimeInfo.tm_yday == osTimeInfo.tm_yday);
assert(ourTimeInfo.tm_isdst == osTimeInfo.tm_isdst);
assert(ourTimeInfo.tm_gmtoff == osTimeInfo.tm_gmtoff);
assert(to!string(ourTimeInfo.tm_zone) == to!string(osTimeInfo.tm_zone));
}
testTM(std);
testTM(dst);
// Apparently, right/ does not exist on Mac OS X. I don't know
// whether or not it exists on FreeBSD. It's rather pointless
// normally, since the Posix standard requires that leap seconds
// be ignored, so it does make some sense that right/ wouldn't
// be there, but since PosixTimeZone _does_ use leap seconds if
// the time zone file does, we'll test that functionality if the
// appropriate files exist.
if (chainPath(PosixTimeZone.defaultTZDatabaseDir, "right", tzName).exists)
{
auto leapTZ = PosixTimeZone.getTimeZone("right/" ~ tzName);
assert(leapTZ.name == "right/" ~ tzName);
//assert(leapTZ.stdName == stdName); //Locale-dependent
//assert(leapTZ.dstName == dstName); //Locale-dependent
assert(leapTZ.hasDST == hasDST);
auto leapSTD = SysTime(std.stdTime, leapTZ);
auto leapDST = SysTime(dst.stdTime, leapTZ);
assert(!leapSTD.dstInEffect);
assert(leapDST.dstInEffect == hasDST);
assert(leapSTD.stdTime == std.stdTime);
assert(leapDST.stdTime == dst.stdTime);
// Whenever a leap second is added/removed,
// this will have to be adjusted.
//enum leapDiff = convert!("seconds", "hnsecs")(25);
//assert(leapSTD.adjTime - leapDiff == std.adjTime);
//assert(leapDST.adjTime - leapDiff == dst.adjTime);
}
}
return tz;
}
import std.datetime.date : DateTime;
auto dstSwitches = [/+America/Los_Angeles+/ tuple(DateTime(2012, 3, 11), DateTime(2012, 11, 4), 2, 2),
/+America/New_York+/ tuple(DateTime(2012, 3, 11), DateTime(2012, 11, 4), 2, 2),
///+America/Santiago+/ tuple(DateTime(2011, 8, 21), DateTime(2011, 5, 8), 0, 0),
/+Europe/London+/ tuple(DateTime(2012, 3, 25), DateTime(2012, 10, 28), 1, 2),
/+Europe/Paris+/ tuple(DateTime(2012, 3, 25), DateTime(2012, 10, 28), 2, 3),
/+Australia/Adelaide+/ tuple(DateTime(2012, 10, 7), DateTime(2012, 4, 1), 2, 3)];
import std.datetime.date : DateTimeException;
version (Posix)
{
version (FreeBSD) enum utcZone = "Etc/UTC";
else version (NetBSD) enum utcZone = "UTC";
else version (DragonFlyBSD) enum utcZone = "UTC";
else version (linux) enum utcZone = "UTC";
else version (Darwin) enum utcZone = "UTC";
else version (Solaris) enum utcZone = "UTC";
else static assert(0, "The location of the UTC timezone file on this Posix platform must be set.");
auto tzs = [testTZ("America/Los_Angeles", "PST", "PDT", dur!"hours"(-8), dur!"hours"(1)),
testTZ("America/New_York", "EST", "EDT", dur!"hours"(-5), dur!"hours"(1)),
//testTZ("America/Santiago", "CLT", "CLST", dur!"hours"(-4), dur!"hours"(1), false),
testTZ("Europe/London", "GMT", "BST", dur!"hours"(0), dur!"hours"(1)),
testTZ("Europe/Paris", "CET", "CEST", dur!"hours"(1), dur!"hours"(1)),
// Per www.timeanddate.com, it should be "CST" and "CDT",
// but the OS insists that it's "CST" for both. We should
// probably figure out how to report an error in the TZ
// database and report it.
testTZ("Australia/Adelaide", "CST", "CST",
dur!"hours"(9) + dur!"minutes"(30), dur!"hours"(1), false)];
testTZ(utcZone, "UTC", "UTC", dur!"hours"(0), dur!"hours"(0));
assertThrown!DateTimeException(PosixTimeZone.getTimeZone("hello_world"));
}
else version (Windows)
{
auto tzs = [testTZ("Pacific Standard Time", "Pacific Standard Time",
"Pacific Daylight Time", dur!"hours"(-8), dur!"hours"(1)),
testTZ("Eastern Standard Time", "Eastern Standard Time",
"Eastern Daylight Time", dur!"hours"(-5), dur!"hours"(1)),
//testTZ("Pacific SA Standard Time", "Pacific SA Standard Time",
//"Pacific SA Daylight Time", dur!"hours"(-4), dur!"hours"(1), false),
testTZ("GMT Standard Time", "GMT Standard Time",
"GMT Daylight Time", dur!"hours"(0), dur!"hours"(1)),
testTZ("Romance Standard Time", "Romance Standard Time",
"Romance Daylight Time", dur!"hours"(1), dur!"hours"(1)),
testTZ("Cen. Australia Standard Time", "Cen. Australia Standard Time",
"Cen. Australia Daylight Time",
dur!"hours"(9) + dur!"minutes"(30), dur!"hours"(1), false)];
testTZ("Greenwich Standard Time", "Greenwich Standard Time",
"Greenwich Daylight Time", dur!"hours"(0), dur!"hours"(0));
assertThrown!DateTimeException(WindowsTimeZone.getTimeZone("hello_world"));
}
else
assert(0, "OS not supported.");
foreach (i; 0 .. tzs.length)
{
auto tz = tzs[i];
immutable spring = dstSwitches[i][2];
immutable fall = dstSwitches[i][3];
auto stdOffset = SysTime(dstSwitches[i][0] + dur!"days"(-1), tz).utcOffset;
auto dstOffset = stdOffset + dur!"hours"(1);
// Verify that creating a SysTime in the given time zone results
// in a SysTime with the correct std time during and surrounding
// a DST switch.
foreach (hour; -12 .. 13)
{
import std.exception : enforce;
auto st = SysTime(dstSwitches[i][0] + dur!"hours"(hour), tz);
immutable targetHour = hour < 0 ? hour + 24 : hour;
static void testHour(SysTime st, int hour, string tzName, size_t line = __LINE__)
{
enforce(st.hour == hour,
new AssertError(format("[%s] [%s]: [%s] [%s]", st, tzName, st.hour, hour),
__FILE__, line));
}
void testOffset1(Duration offset, bool dstInEffect, size_t line = __LINE__)
{
AssertError msg(string tag)
{
return new AssertError(format("%s [%s] [%s]: [%s] [%s] [%s]",
tag, st, tz.name, st.utcOffset, stdOffset, dstOffset),
__FILE__, line);
}
enforce(st.dstInEffect == dstInEffect, msg("1"));
enforce(st.utcOffset == offset, msg("2"));
enforce((st + dur!"minutes"(1)).utcOffset == offset, msg("3"));
}
if (hour == spring)
{
testHour(st, spring + 1, tz.name);
testHour(st + dur!"minutes"(1), spring + 1, tz.name);
}
else
{
testHour(st, targetHour, tz.name);
testHour(st + dur!"minutes"(1), targetHour, tz.name);
}
if (hour < spring)
testOffset1(stdOffset, false);
else
testOffset1(dstOffset, true);
st = SysTime(dstSwitches[i][1] + dur!"hours"(hour), tz);
testHour(st, targetHour, tz.name);
// Verify that 01:00 is the first 01:00 (or whatever hour before the switch is).
if (hour == fall - 1)
testHour(st + dur!"hours"(1), targetHour, tz.name);
if (hour < fall)
testOffset1(dstOffset, true);
else
testOffset1(stdOffset, false);
}
// Verify that converting a time in UTC to a time in another
// time zone results in the correct time during and surrounding
// a DST switch.
bool first = true;
auto springSwitch = SysTime(dstSwitches[i][0] + dur!"hours"(spring), UTC()) - stdOffset;
auto fallSwitch = SysTime(dstSwitches[i][1] + dur!"hours"(fall), UTC()) - dstOffset;
// https://issues.dlang.org/show_bug.cgi?id=3659 makes this necessary.
auto fallSwitchMinus1 = fallSwitch - dur!"hours"(1);
foreach (hour; -24 .. 25)
{
auto utc = SysTime(dstSwitches[i][0] + dur!"hours"(hour), UTC());
auto local = utc.toOtherTZ(tz);
void testOffset2(Duration offset, size_t line = __LINE__)
{
AssertError msg(string tag)
{
return new AssertError(format("%s [%s] [%s]: [%s] [%s]", tag, hour, tz.name, utc, local),
__FILE__, line);
}
import std.exception : enforce;
enforce((utc + offset).hour == local.hour, msg("1"));
enforce((utc + offset + dur!"minutes"(1)).hour == local.hour, msg("2"));
}
if (utc < springSwitch)
testOffset2(stdOffset);
else
testOffset2(dstOffset);
utc = SysTime(dstSwitches[i][1] + dur!"hours"(hour), UTC());
local = utc.toOtherTZ(tz);
if (utc == fallSwitch || utc == fallSwitchMinus1)
{
if (first)
{
testOffset2(dstOffset);
first = false;
}
else
testOffset2(stdOffset);
}
else if (utc > fallSwitch)
testOffset2(stdOffset);
else
testOffset2(dstOffset);
}
}
}
protected:
/++
Params:
name = The name of the time zone.
stdName = The abbreviation for the time zone during std time.
dstName = The abbreviation for the time zone during DST.
+/
this(string name, string stdName, string dstName) @safe immutable pure
{
_name = name;
_stdName = stdName;
_dstName = dstName;
}
private:
immutable string _name;
immutable string _stdName;
immutable string _dstName;
}
/++
A TimeZone which represents the current local time zone on
the system running your program.
This uses the underlying C calls to adjust the time rather than using
specific D code based off of system settings to calculate the time such as
$(LREF PosixTimeZone) and $(LREF WindowsTimeZone) do. That also means that
it will use whatever the current time zone is on the system, even if the
system's time zone changes while the program is running.
+/
final class LocalTime : TimeZone
{
public:
/++
$(LREF LocalTime) is a singleton class. $(LREF LocalTime) returns its
only instance.
+/
static immutable(LocalTime) opCall() @trusted pure nothrow
{
alias FuncType = immutable(LocalTime) function() @safe pure nothrow;
return (cast(FuncType)&singleton)();
}
version (StdDdoc)
{
/++
In principle, this is the name of the local time zone. However,
this always returns the empty string. This is because time zones
cannot be uniquely identified by the attributes given by the
OS (such as the `stdName` and `dstName`), and neither Posix systems
nor Windows systems provide an easy way to get the TZ Database name
of the local time zone.
See_Also:
$(HTTP en.wikipedia.org/wiki/Tz_database, Wikipedia entry on TZ
Database)<br>
$(HTTP en.wikipedia.org/wiki/List_of_tz_database_time_zones, List
of Time Zones)
+/
@property override string name() @safe const nothrow;
}
/++
Typically, the abbreviation (generally 3 or 4 letters) for the time zone
when DST is $(I not) in effect (e.g. PST). It is not necessarily unique.
However, on Windows, it may be the unabbreviated name (e.g. Pacific
Standard Time). Regardless, it is not the same as name.
This property is overridden because the local time of the system could
change while the program is running and we need to determine it
dynamically rather than it being fixed like it would be with most time
zones.
+/
@property override string stdName() @trusted const nothrow
{
version (Posix)
{
import core.stdc.time : tzname;
import std.conv : to;
try
return to!string(tzname[0]);
catch (Exception e)
assert(0, "to!string(tzname[0]) failed.");
}
else version (Windows)
{
TIME_ZONE_INFORMATION tzInfo;
GetTimeZoneInformation(&tzInfo);
// Cannot use to!string() like this should, probably due to bug
// https://issues.dlang.org/show_bug.cgi?id=5016
//return to!string(tzInfo.StandardName);
wchar[32] str;
foreach (i, ref wchar c; str)
c = tzInfo.StandardName[i];
string retval;
try
{
foreach (dchar c; str)
{
if (c == '\0')
break;
retval ~= c;
}
return retval;
}
catch (Exception e)
assert(0, "GetTimeZoneInformation() returned invalid UTF-16.");
}
}
@safe unittest
{
version (FreeBSD)
{
// A bug on FreeBSD 9+ makes it so that this test fails.
// https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=168862
}
else version (NetBSD)
{
// The same bug on NetBSD 7+
}
else
{
assert(LocalTime().stdName !is null);
version (Posix)
{
scope(exit) clearTZEnvVar();
setTZEnvVar("America/Los_Angeles");
assert(LocalTime().stdName == "PST");
setTZEnvVar("America/New_York");
assert(LocalTime().stdName == "EST");
}
}
}
/++
Typically, the abbreviation (generally 3 or 4 letters) for the time zone
when DST $(I is) in effect (e.g. PDT). It is not necessarily unique.
However, on Windows, it may be the unabbreviated name (e.g. Pacific
Daylight Time). Regardless, it is not the same as name.
This property is overridden because the local time of the system could
change while the program is running and we need to determine it
dynamically rather than it being fixed like it would be with most time
zones.
+/
@property override string dstName() @trusted const nothrow
{
version (Posix)
{
import core.stdc.time : tzname;
import std.conv : to;
try
return to!string(tzname[1]);
catch (Exception e)
assert(0, "to!string(tzname[1]) failed.");
}
else version (Windows)
{
TIME_ZONE_INFORMATION tzInfo;
GetTimeZoneInformation(&tzInfo);
// Cannot use to!string() like this should, probably due to bug
// https://issues.dlang.org/show_bug.cgi?id=5016
//return to!string(tzInfo.DaylightName);
wchar[32] str;
foreach (i, ref wchar c; str)
c = tzInfo.DaylightName[i];
string retval;
try
{
foreach (dchar c; str)
{
if (c == '\0')
break;
retval ~= c;
}
return retval;
}
catch (Exception e)
assert(0, "GetTimeZoneInformation() returned invalid UTF-16.");
}
}
@safe unittest
{
// tzname, called from dstName, isn't set by default for Musl.
version (CRuntime_Musl)
assert(LocalTime().dstName is null);
else
assert(LocalTime().dstName !is null);
version (Posix)
{
scope(exit) clearTZEnvVar();
version (FreeBSD)
{
// A bug on FreeBSD 9+ makes it so that this test fails.
// https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=168862
}
else version (NetBSD)
{
// The same bug on NetBSD 7+
}
else
{
setTZEnvVar("America/Los_Angeles");
assert(LocalTime().dstName == "PDT");
setTZEnvVar("America/New_York");
assert(LocalTime().dstName == "EDT");
}
}
}
/++
Whether this time zone has Daylight Savings Time at any point in time.
Note that for some time zone types it may not have DST for current
dates but will still return true for `hasDST` because the time zone
did at some point have DST.
+/
@property override bool hasDST() @trusted const nothrow
{
version (Posix)
{
static if (is(typeof(daylight)))
return cast(bool)(daylight);
else
{
try
{
import std.datetime.date : Date;
auto currYear = (cast(Date) Clock.currTime()).year;
auto janOffset = SysTime(Date(currYear, 1, 4), cast(immutable) this).stdTime -
SysTime(Date(currYear, 1, 4), UTC()).stdTime;
auto julyOffset = SysTime(Date(currYear, 7, 4), cast(immutable) this).stdTime -
SysTime(Date(currYear, 7, 4), UTC()).stdTime;
return janOffset != julyOffset;
}
catch (Exception e)
assert(0, "Clock.currTime() threw.");
}
}
else version (Windows)
{
TIME_ZONE_INFORMATION tzInfo;
GetTimeZoneInformation(&tzInfo);
return tzInfo.DaylightDate.wMonth != 0;
}
}
@safe unittest
{
LocalTime().hasDST;
version (Posix)
{
scope(exit) clearTZEnvVar();
setTZEnvVar("America/Los_Angeles");
assert(LocalTime().hasDST);
setTZEnvVar("America/New_York");
assert(LocalTime().hasDST);
setTZEnvVar("UTC");
assert(!LocalTime().hasDST);
}
}
/++
Takes the number of hnsecs (100 ns) since midnight, January 1st, 1 A.D.
in UTC time (i.e. std time) and returns whether DST is in effect in this
time zone at the given point in time.
Params:
stdTime = The UTC time that needs to be checked for DST in this time
zone.
+/
override bool dstInEffect(long stdTime) @trusted const nothrow
{
import core.stdc.time : tm;
time_t unixTime = stdTimeToUnixTime(stdTime);
version (Posix)
{
import core.sys.posix.time : localtime_r;
tm timeInfo = void;
localtime_r(&unixTime, &timeInfo);
return cast(bool)(timeInfo.tm_isdst);
}
else version (Windows)
{
import core.stdc.time : localtime;
// Apparently Windows isn't smart enough to deal with negative time_t.
if (unixTime >= 0)
{
tm* timeInfo = localtime(&unixTime);
if (timeInfo)
return cast(bool)(timeInfo.tm_isdst);
}
TIME_ZONE_INFORMATION tzInfo;
GetTimeZoneInformation(&tzInfo);
return WindowsTimeZone._dstInEffect(&tzInfo, stdTime);
}
}
@safe unittest
{
auto currTime = Clock.currStdTime;
LocalTime().dstInEffect(currTime);
}
/++
Returns hnsecs in the local time zone using the standard C function
calls on Posix systems and the standard Windows system calls on Windows
systems to adjust the time to the appropriate time zone from std time.
Params:
stdTime = The UTC time that needs to be adjusted to this time zone's
time.
See_Also:
`TimeZone.utcToTZ`
+/
override long utcToTZ(long stdTime) @trusted const nothrow
{
version (Solaris)
return stdTime + convert!("seconds", "hnsecs")(tm_gmtoff(stdTime));
else version (Posix)
{
import core.stdc.time : tm;
import core.sys.posix.time : localtime_r;
time_t unixTime = stdTimeToUnixTime(stdTime);
tm timeInfo = void;
localtime_r(&unixTime, &timeInfo);
return stdTime + convert!("seconds", "hnsecs")(timeInfo.tm_gmtoff);
}
else version (Windows)
{
TIME_ZONE_INFORMATION tzInfo;
GetTimeZoneInformation(&tzInfo);
return WindowsTimeZone._utcToTZ(&tzInfo, stdTime, hasDST);
}
}
@safe unittest
{
LocalTime().utcToTZ(0);
}
/++
Returns std time using the standard C function calls on Posix systems
and the standard Windows system calls on Windows systems to adjust the
time to UTC from the appropriate time zone.
See_Also:
`TimeZone.tzToUTC`
Params:
adjTime = The time in this time zone that needs to be adjusted to
UTC time.
+/
override long tzToUTC(long adjTime) @trusted const nothrow
{
version (Posix)
{
import core.stdc.time : tm;
import core.sys.posix.time : localtime_r;
time_t unixTime = stdTimeToUnixTime(adjTime);
immutable past = unixTime - cast(time_t) convert!("days", "seconds")(1);
tm timeInfo = void;
localtime_r(past < unixTime ? &past : &unixTime, &timeInfo);
immutable pastOffset = timeInfo.tm_gmtoff;
immutable future = unixTime + cast(time_t) convert!("days", "seconds")(1);
localtime_r(future > unixTime ? &future : &unixTime, &timeInfo);
immutable futureOffset = timeInfo.tm_gmtoff;
if (pastOffset == futureOffset)
return adjTime - convert!("seconds", "hnsecs")(pastOffset);
if (pastOffset < futureOffset)
unixTime -= cast(time_t) convert!("hours", "seconds")(1);
unixTime -= pastOffset;
localtime_r(&unixTime, &timeInfo);
return adjTime - convert!("seconds", "hnsecs")(timeInfo.tm_gmtoff);
}
else version (Windows)
{
TIME_ZONE_INFORMATION tzInfo;
GetTimeZoneInformation(&tzInfo);
return WindowsTimeZone._tzToUTC(&tzInfo, adjTime, hasDST);
}
}
@safe unittest
{
import core.exception : AssertError;
import std.format : format;
import std.typecons : tuple;
assert(LocalTime().tzToUTC(LocalTime().utcToTZ(0)) == 0);
assert(LocalTime().utcToTZ(LocalTime().tzToUTC(0)) == 0);
assert(LocalTime().tzToUTC(LocalTime().utcToTZ(0)) == 0);
assert(LocalTime().utcToTZ(LocalTime().tzToUTC(0)) == 0);
version (Posix)
{
scope(exit) clearTZEnvVar();
import std.datetime.date : DateTime;
auto tzInfos = [tuple("America/Los_Angeles", DateTime(2012, 3, 11), DateTime(2012, 11, 4), 2, 2),
tuple("America/New_York", DateTime(2012, 3, 11), DateTime(2012, 11, 4), 2, 2),
//tuple("America/Santiago", DateTime(2011, 8, 21), DateTime(2011, 5, 8), 0, 0),
tuple("Atlantic/Azores", DateTime(2011, 3, 27), DateTime(2011, 10, 30), 0, 1),
tuple("Europe/London", DateTime(2012, 3, 25), DateTime(2012, 10, 28), 1, 2),
tuple("Europe/Paris", DateTime(2012, 3, 25), DateTime(2012, 10, 28), 2, 3),
tuple("Australia/Adelaide", DateTime(2012, 10, 7), DateTime(2012, 4, 1), 2, 3)];
foreach (i; 0 .. tzInfos.length)
{
import std.exception : enforce;
auto tzName = tzInfos[i][0];
setTZEnvVar(tzName);
immutable spring = tzInfos[i][3];
immutable fall = tzInfos[i][4];
auto stdOffset = SysTime(tzInfos[i][1] + dur!"hours"(-12)).utcOffset;
auto dstOffset = stdOffset + dur!"hours"(1);
// Verify that creating a SysTime in the given time zone results
// in a SysTime with the correct std time during and surrounding
// a DST switch.
foreach (hour; -12 .. 13)
{
auto st = SysTime(tzInfos[i][1] + dur!"hours"(hour));
immutable targetHour = hour < 0 ? hour + 24 : hour;
static void testHour(SysTime st, int hour, string tzName, size_t line = __LINE__)
{
enforce(st.hour == hour,
new AssertError(format("[%s] [%s]: [%s] [%s]", st, tzName, st.hour, hour),
__FILE__, line));
}
void testOffset1(Duration offset, bool dstInEffect, size_t line = __LINE__)
{
AssertError msg(string tag)
{
return new AssertError(format("%s [%s] [%s]: [%s] [%s] [%s]",
tag, st, tzName, st.utcOffset, stdOffset, dstOffset),
__FILE__, line);
}