-
Notifications
You must be signed in to change notification settings - Fork 125
/
date.opa
1107 lines (990 loc) · 35.7 KB
/
date.opa
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
/*
Copyright © 2011, 2012 MLstate
This file is part of OPA.
OPA is free software: you can redistribute it and/or modify it under the
terms of the GNU Affero General Public License, version 3, as published by
the Free Software Foundation.
OPA is distributed in the hope that it will be useful, but WITHOUT ANY
WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
FOR A PARTICULAR PURPOSE. See the GNU Affero General Public License for
more details.
You should have received a copy of the GNU Affero General Public License
along with OPA. If not, see <http://www.gnu.org/licenses/>.
*/
import stdlib.core.{parser, map, set}
/**
* @author Adam Koprowski
* @category data
*
*
* {1 About this module}
*
* This module contains functions to manipulate dates and times.
* If instead you are interested in time durations (intervals) or date
* ranges (durations fixed in time), see, respectively, the {!Duration}
* and {!DateRange} modules.
*
* {1 When to use this module}
*
* This module will let you manipulate dates, compute the duration between times,
* etc.
*
* {1 Where should I start?}
*
* {1 What if I need more?}
**/
/* TODO Here we combine daily date & time into one. Sometimes one is interested
only in one of those (i.e. a date, but not caring about time or a time of
the day, for on day in particular). How to nicely provide this separation? */
/* TODO time zones */
/**
* {1 Types defined in this module}
**/
/**
* The twelve months of the Western calendar.
*/
type Date.month = {january} / {february} / {march} / {april} / {may} / {june} / {july} / {august} / {september} / {october} / {november} / {december}
/**
* The seven weekdays.
*/
type Date.weekday = {monday} / {tuesday} / {wednesday} / {thursday} / {friday} / {saturday} / {sunday}
/**
* A representation of a date (i.e. date and time, with millisecond precision).
*
* This type is useful for date manipulation. For presentation purposes see {!Date.human_readable}
**/
@abstract type Date.date = int
/**
* A data-type representing a calendar year
**/
type Date.year = int
/**
* A data-type representing a day of the month
**/
type Date.day = int
/**
* A date, split into components (decompressed in a more understandable format.
*/
type Date.human_readable = {
/** Year since the origin of the calendar (that's 0 AD on most computers) **/
year : Date.year
/** Month of the year **/
month : Date.month
/** Day of the month (1..31) **/
day : Date.day
/** Day of the week **/
wday : Date.weekday
/** Hour (0..23) **/
h : int
/** Minute (0..59) */
min : int
/** Second (0..59) */
s : int
/** Millisecond (0..999) */
ms : int
}
/**
* A type of date printers, i.e. objects capable of rendering dates as strings
* (according to some format). See {!Date.try_generate_printer}.
**/
@abstract type Date.printer = (Date.date -> string)
/**
* A type of date parsers, i.e. objects capable of constructing dates from their
* string descriptions (according to some format). See {!Date.try_generate_parser}.
**/
type Date.scanner = Parser.general_parser(Date.human_readable -> Date.human_readable)
/**
* The ordering of dates
**/
type Date.order = Order.default
/**
* A map from dates to values, using the default ordering on dates.
**/
type Date.map('a) = ordered_map(Date.date, 'a, Date.order)
/**
* A set of dates.
**/
type Date.set = ordered_set(Date.date, Date.order)
/**
* A low-level type representing dates. Not for casual users.
**/
// FIXME Should we merge Date.date & time_t ?
type time_t = external
@both Date =
{{
/**
* {1 Date constructors}
**/
/**
* The arbitrary date of January 1st, 1970, at 0000
**/
epoch : Date.date =
0
/**
* The current *local* time.
*
* Note: depending on whether the function is executed on the client or on the
* server this function will return, respectively, the client/server time.
*
* If instead of local time you want GMT time, please consult {!Date.now_gmt}
*
**/
now : -> Date.date = Date_private.time_now
/**
* The current GMT time.
*
* Note: depending on whether the function is executed on the client or on the
* server this function will return, respectively, the client/server time.
*
* If instead of GMT time you want local time, please consult {!Date.now_gmt}
**/
now_gmt() : Date.date =
t = now()
offset = Date_private.time_local_timezone_offset() |> Duration.min
Date.advance(t, offset)
/**
* Constructs a specific date.
*
* Different level of detail allowed. If milliseconds not provided, set to 0;
* if all time data not provided set to midnight on a given day.
**/
build(date : {year : Date.year; month : Date.month; day : Date.day; h : int; min : int; s : int; ms : int}
/ {year : Date.year; month : Date.month; day : Date.day; h : int; min : int; s : int}
/ {year : Date.year; month : Date.month; day : Date.day}
/ {year : Date.year; week : int; weekday : Date.weekday}
) : Date.date =
dummy_date = {year=1970 month={january} day=1 h=0 min=0 s=0 ms=0 wday={monday}}
match date with
| ~{year month day h min s ms} ->
~{dummy_date with year month day h min s ms} |> of_human_readable
| ~{year month day h min s} ->
~{dummy_date with year month day h min s} |> of_human_readable
| ~{year month day} ->
~{dummy_date with year month day} |> of_human_readable
| ~{year week weekday} ->
get_first_week(year)
|> advance(_, Duration.weeks(week-1))
|> move_to_weekday(_, {forward}, weekday)
/**
* Converts a low-level representation into a Date.
* Not for casual users.
**/
ll_import : time_t -> Date.date = Date_private.ll_import
/**
* Converts an integer to a low-level representation of a Date.
* Not for casual users.
**/
time_t_of_int : int -> time_t =
v -> Date_private.ll_export(v : Date.date)
/**
* {1 Date modifications}
**/
/**
* [Date.round_to_day(date)] returns [date] rounded down to the full day (i.e.
* it returns a date on midnight of the given day).
**/
round_to_day(date : Date.date) : Date.date =
{~year ~month ~day h=_ min=_ s=_ ms=_ wday=_} = to_human_readable(date)
of_human_readable({~year ~month ~day h=0 min=0 s=0; ms=0; wday={monday}})
/**
* [Date.round_to_second(date)] returns [date] rounded down to a full second
* (i.e. milliseconds are dropped).
**/
round_to_second(date : Date.date) : Date.date =
{~year ~month ~day ~h ~min ~s ms=_ wday=_} = to_human_readable(date)
of_human_readable({~year ~month ~day ~h ~min ~s ms=0 wday={monday}})
/**
* Advance a time by a fixed-time duration.
*
* E.g.: February 2, 2010 + 1 month = March 5, 2010
* E.g.: February 2, 2012 + 1 month = March 4, 2012
*
* @param date Any reference date.
* @param duration Any duration.
*
* @return The date obtain by advancing [date] by [duration]. If [duration] is positive,
* the result will be after [date], if it is negative, the result will be before [date].
* If [duration] is infinite, the result will be infinite.
**/
advance(date: Date.date, duration: Duration.duration) : Date.date =
date + duration
/**
* Advances a date (as [advance]) by the duration of [days] days.
*
* @param date A reference date
* @param days A number of days (possibly negative)
*
* @return [date] shifted by [days] days.
**/
advance_by_days(date : Date.date, days : int) : Date.date =
Date.advance(date, Duration.days(days))
/**
* Shifts a given date (forward or backward) until it represents a date on a given
* weekday. The time of the date is not changed (see {!Date.round_to_day} to "reset"
* time of the day).
*
* @param date A reference date
* @param dir Direction of the shift ([{forward}] or [{backward}])
* @param wday A weekday; [date] will be shifted until reaching that day of the week.
*
* @return [date] shifted in the direction [dir] until reaching [wday].
**/
move_to_weekday(date: Date.date, dir : {forward} / {backward}, wday: Date.weekday) : Date.date =
rec shift(date) =
d = to_human_readable(date)
if Weekday.equals(d.wday, wday) then
date
else
shift(advance_by_days(date, match dir with {forward} -> 1 | {backward} -> -1))
shift(date)
/**
* As {!Date.advance}.
**/
shift_forward = advance
/**
* Go back in time by a duration.
**/
shift_backward(date : Date.date, duration : Duration.duration) : Date.date =
date - duration
/**
* Advance a time by a calendar duration (i.e. not a fixed time-span) in [human_readable] format.
*
* E.g.: February 2 + 1 month = March 2 (in any year)
*
* @param date Any reference date.
* @param shift Any human-readable duration.
*
* @return The date obtained by advancing [date] by [shift] (or shifting backwards if [shift.forward] is [false])
* Any field of [shift] may be negative, and the shifting will be done accordingly.
**/
// Note: this function relies on the fact that [of_human_readable] accepts and normalizes incorrect dates in a consistent way.
// TODO: Clean, check & test this function.
calendar_advance(date : Date.date, shift : Duration.human_readable) : Date.date =
date = to_human_readable(date)
{~year ~month ~day ~h ~min ~s ~ms wday=_} = date
{~forward year=d_year month=d_month day=d_day h=d_h min=d_min s=d_s ms=d_ms} = shift
`++` = if forward then Int.`+` else Int.`-`
/* because months have their own type, we need to normalize them into [0..11] range */
rec normalize(month, dy) =
if month >= 12 then
normalize(month - 12, dy + 1)
else if month < 0 then
normalize(month + 12, dy - 1)
else
(month, dy)
(month, extra_year) = normalize(Month.to_int(month) ++ d_month, 0)
date = {date with year=year++d_year++extra_year month=Month.of_int(month) day=day++d_day h=h++d_h min=min++d_min s=s++d_s ms=ms++d_ms}
of_human_readable(date)
/**
* Compute the duration between two dates
*
* @param date1 first date
* @param date2 second date
*
* @return The duration between [date1] and [date2]
**/
between(date1 : Date.date, date2 : Date.date) : Duration.duration =
date2 - date1
/**
* Returns a date, exactly in between two other dates.
* Can be useful for binary search with dates; see also {!Date.binary_search).
*
* @param date1 a date
* @param date2 another date ([date1] does not need to come before
* [date2]).
* @return a date exactly in between [date1] and [date2].
**/
in_between(date1 : Date.date, date2 : Date.date) : Date.date =
(date1 + date2) / 2
/**
* Performs binary search within a range of dates.
*
* Please note that binary search can be used only if the
* function under consideration is monotonic.
*
* @param f a function; [f(date, range)] should check whether
* the value for [date] is the value that is being
* searched and if so return [{eq}], if it is too
* late return [{lt}] and if too early [{gt}].
* The additional parameter [range] indicates the
* current range being considered in the binary search
* and will usually be ignored. (One possible use if
* we are looking for some approximation, hence can
* never really return [{eq}]; but if we never do
* then the function will return [{none}], which is
* not very useful. The solution in this case is to
* return [{eq}] when the [range] is small enough to
* consider our approximation acceptable as a solution)
* @param range the range in which the binary search should
* be conducted.
* @return The date for which [f] returns [{eq}], or [{none}]
* if such value was not found.
**/
binary_search(f : Date.date, DateRange.range -> Order.ordering,
range : DateRange.range) : option(Date.date) =
(low, high) = range
if high < low then
none
else
mid = Date.in_between(low, high)
match f(mid, range) with
| {eq} -> some(mid)
| {lt} -> binary_search(f, (low, mid-1))
| {gt} -> binary_search(f, (mid+1, high))
/**
* {1 Date comparison & ordering}
**/
/**
* Date comparison.
**/
compare(date1 : Date.date, date2 : Date.date) : Order.comparison =
compare_int(date1, date2)
/**
* Date ordering.
**/
ordering(date1 : Date.date, date2 : Date.date) : Order.ordering =
Int.ordering(date1, date2)
order : order(Date.date, Date.order) =
Order.make(ordering)
/**
* {1 Date accessors}
**/
/**
* Returns the number of milliseconds (within a second) represented by this date
* interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The number of milliseconds (within a second) represented by [date].
* Returned value is in the range [0..999].
**/
get_msec : Date.date -> int = Date_private.time_local_msec
/**
* Returns the number of seconds (within a minute) represented by this date
* interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The number of seconds (within a minute) represented by [date].
* Returned value is in the range [0..59].
**/
get_sec : Date.date -> int = Date_private.time_local_sec
/**
* Returns the number of minutes (within an hour) represented by this date
* interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The number of minutes (within an hour) represented by [date].
* Returned value is in the range [0..59].
**/
get_min : Date.date -> int = Date_private.time_local_min
/**
* Returns the number of hours (within a day) represented by this date
* interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The number of hours (within a day) represented by [date].
* Returned value is in the range [0..23].
**/
get_hour : Date.date -> int = Date_private.time_local_hour
/**
* Returns the local timezone (+hhmm or -hhmm).
*
* On the server side, this will be a constant. On the client side
* it will depend on whatever the user has set on their system.
*
* @return The local timezone (+hhmm or -hhmm).
**/
get_local_timezone : -> string = -> (
delta : int = Date_private.time_local_timezone_offset()
// delta is the timezone in minutes, so we need to convert it into
// +hhmm or -hhmm. If delta is positive, the timezone is -hhmm. Otherwise
// the timezone is +hhmm.
h : int = Int.abs(delta) / 60
m : int = mod(Int.abs(delta), 60)
s : string = if delta > 0 then "-" else "+"
p = {pad_with_zeros}
h_str : string = Date_private.ToString.pad(h, p, p, 2)
m_str : string = Date_private.ToString.pad(m, p, p, 2)
"{s}{h_str}{m_str}"
)
/**
* Returns the weekday represented by this date interpreted in the local
* time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The weekday represented by [date].
**/
get_weekday(date : Date.date) : Date.weekday =
Weekday.of_int(Date_private.time_local_wday(date))
/**
* Returns the day number (within a month) represented by this date
* interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The day number (within a month) represented by [date].
* Returned value is in the range [1..31].
**/
get_day : Date.date -> Date.day = Date_private.time_local_mday
/**
* Returns the month represented by this date interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The month represented by [date].
**/
get_month(date : Date.date) : Date.month =
Month.of_int(Date_private.time_local_mon(date))
/**
* Returns the year represented by this date interpreted in the local time zone.
* If you need to completely decompose a date consider using {!Date.to_human_readable}.
*
* @param date A date
* @return The year represented by [date].
**/
get_year : Date.date -> Date.year = Date_private.time_local_year
/**
* Returns the Monday of the first week of a given year.
*
* This routine follows ISO 8601 and hence assumes that "the first week of a year
* is the week that contains the first Thursday of the year" and that "weeks start
* with Monday". See {{:http://en.wikipedia.org/wiki/ISO_week_date} for more details}.
*
* @param year A year
* @return The date on Monday of the first week of the year [year].
**/
get_first_week(year : Date.year) : Date.date =
build({~year month={january} day=1}) |>
move_to_weekday(_, {forward}, {thursday}) |>
move_to_weekday(_, {backward}, {monday})
/**
* Returns the week number corresponding to the given date.
*
* This routine follows ISO 8601 and hence assumes that "the first week of a year
* is the week that contains the first Thursday of the year" and that "weeks start
* with Monday". See {{:http://en.wikipedia.org/wiki/ISO_week_date} for more details}.
*
* @param date A date
* @return The week number of the [date].
**/
get_week_number(d : Date.date) : int =
to_human_readable(d) |>
_.year |>
get_first_week |>
Duration.between(_, d) |>
Duration.in_days |>
_ / 7. |>
Float.floor |>
Float.to_int |>
_ + 1
/**
* {1 Date conversions}
**/
/**
* Convert a date to a human-understandable format.
*
* Behavior is unspecified when the date is infinite.
**/
to_human_readable(date : Date.date) : Date.human_readable =
// FIXME many BSL calls, causing many date conversions. Should be done with one call/conversion
{ ms = get_msec(date)
s = get_sec(date)
min = get_min(date)
h = get_hour(date)
wday = get_weekday(date)
day = get_day(date)
month = get_month(date)
year = get_year(date)
}
/**
* Convert a human-understandable format to date.
**/
of_human_readable({~year ~month ~day ~h ~min ~s ~ms wday=_} : Date.human_readable) : Date.date =
mktime = %%BslTime.mktime%% : int, int, int, int, int, int, int -> time_t
Date_private.ll_import(mktime(year, Month.to_int(month), day, h, min, s, ms))
/**
* Converts a date to a duration in reference to 1st of January 1970
* (see {!Date.epoch}). So for instance {!Date.to_duration} applied on 2nd of
* January 1970 will return a positive duration of 1 day.
* See also {!Date.of_duration}.
**/
to_duration(date : Date.date) : Duration.duration =
between(epoch, date)
/**
* Converts a duration to a date in reference to 1st of January 1970
* (see {!Date.epoch}). So for instance {!Date.of_duration} applied on positive
* duration of 1 day will return 2nd of January 1970.
* See also {!Date.to_duration}.
**/
of_duration(duration : Duration.duration) : Date.date =
advance(epoch, duration)
/**
* @deprecated Use {!Date.of_human_readable} instead
**/
@deprecated({use="of_human_readable"})
human_readable_to = of_human_readable
/**
* @deprecated Use {!Date.to_human_readable} instead
**/
@deprecated({use="to_human_readable"})
human_readable_of = to_human_readable
/**
* Returns the number of milliseconds since 1st January 1970 at 0000 till [date].
*
* This is a perfect hash function for dates. It can also be useful to convert
* dates to "identifiers".
*
* But in general use with caution. Converting to milliseconds, doing integer
* arithmetic and then converting back to a date is *strongly* discouraged.
* You have been warned.
**/
in_milliseconds(date : Date.date) : int =
date
/**
* Converts a number of milliseconds since 1st January 1970 at 0000 into a date.
*
* Use with care. Check the comment of {!Date.in_milliseconds}.
**/
milliseconds(m : int) : Date.date =
m
/**
* Converts date into its low-level representation.
* Not for casual users.
**/
ll_export : Date.date -> time_t = Date_private.ll_export
/**
* A module for dealing with hours.
**/
Hour = {{
/**
* Converts a 24h-based value to a 12h-based one.
*
* @param hour an integer in the range [0..23]
* @return [hour] in 12h format
**/
convert_24h_to_12h(hour : int) : int =
if hour == 0 then
12
else if hour <= 12 then
hour
else if hour <= 23 then
hour - 12
else
error("Date.Hour.convert_24h_to_12h({Int.to_string(hour)})")
/**
* Is the given hour AM; as opposed to PM? (ante meridiem = before mid day)
*
* @param hour an integer in the range [0..23]
**/
is_am(hour : int) : bool = hour < 12
}}
/**
* Handling of weekdays.
**/
Weekday = {{
equals(a:Date.weekday, b:Date.weekday): bool =
to_int(a) == to_int(b)
/**
* Converts an integer to a week-day (0 = sunday, 1 = monday, ... 6 = saturday)
*
* @param i an integer in the range [0..6]
**/
of_int : int -> Date.weekday =
| 0 -> {sunday}
| 1 -> {monday}
| 2 -> {tuesday}
| 3 -> {wednesday}
| 4 -> {thursday}
| 5 -> {friday}
| 6 -> {saturday}
| _ -> error("Date.Weekday.of_int")
: Date.weekday
/**
* Converts a week-day to an integer (sunday = 0, monday = 1, ... saturday = 6)
*
* @param i an integer in the range [0..6]
*/
to_int : Date.weekday -> int =
| {monday} -> 1
| {tuesday} -> 2
| {wednesday} -> 3
| {thursday} -> 4
| {friday} -> 5
| {saturday} -> 6
| {sunday} -> 0
/**
* Converts a week-day to a string representation (in English)
*
* @param wday weekday to convert
*/
@stringifier(Date.weekday) to_string : Date.weekday -> string =
| {monday} -> "Monday"
| {tuesday} -> "Tuesday"
| {wednesday} -> "Wednesday"
| {thursday} -> "Thursday"
| {friday} -> "Friday"
| {saturday} -> "Saturday"
| {sunday} -> "Sunday"
/**
* Converts a week-day to an abbreviated, 3-letter string representation (in English, i.e. Mon, Tue, ...)
*
* @param wday weekday to convert
*/
to_short_string : Date.weekday -> string =
| {monday} -> "Mon"
| {tuesday} -> "Tue"
| {wednesday} -> "Wed"
| {thursday} -> "Thu"
| {friday} -> "Fri"
| {saturday} -> "Sat"
| {sunday} -> "Sun"
}}
/**
* Handling of months
**/
Month =
{{
equals(a:Date.month, b:Date.month): bool =
to_int(a) == to_int(b)
/**
* Converts an integer to a month (0 = january, ... 11 = december)
*
* Results in a run-time error when the integer is not in the range [0..11].
*
* @param i an integer in the range [0..11]
* @return month corresponding to [i]
**/
of_int : int -> Date.month=
| 0 -> {january}
| 1 -> {february}
| 2 -> {march}
| 3 -> {april}
| 4 -> {may}
| 5 -> {june}
| 6 -> {july}
| 7 -> {august}
| 8 -> {september}
| 9 -> {october}
| 10 -> {november}
| 11 -> {december}
| _ -> error("Date.Month.of_int")
/**
* Converts a month to an integer (january = 0, ... december = 11)
*
* @param i an integer in the range [0..11]
**/
to_int : Date.month -> int =
| {january} -> 0
| {february} -> 1
| {march} -> 2
| {april} -> 3
| {may} -> 4
| {june} -> 5
| {july} -> 6
| {august} -> 7
| {september} -> 8
| {october} -> 9
| {november} -> 10
| {december} -> 11
/**
* Converts a month to a string representation (in English)
*
* @param month a month to convert
**/
@stringifier(Date.month) to_string : Date.month -> string =
| {january} -> "January"
| {february} -> "February"
| {march} -> "March"
| {april} -> "April"
| {may} -> "May"
| {june} -> "June"
| {july} -> "July"
| {august} -> "August"
| {september} -> "September"
| {october} -> "October"
| {november} -> "November"
| {december} -> "December"
/**
* Converts a month to an abbreviated, 3 letter string representation (in English, i.e. Jan, Feb, ...)
*
* @param month a month to convert
*/
to_short_string : Date.month -> string =
| {january} -> "Jan"
| {february} -> "Feb"
| {march} -> "Mar"
| {april} -> "Apr"
| {may} -> "May"
| {june} -> "Jun"
| {july} -> "Jul"
| {august} -> "Aug"
| {september} -> "Sep"
| {october} -> "Oct"
| {november} -> "Nov"
| {december} -> "Dec"
/**
* Gives the succeeding month.
*
* @param d a month
* @return [some(nd)], where [nd] is the month succeeding [d], or [none] if [d] is December.
*/
next(d : Date.month) : option(Date.month) =
di = to_int(d)
if di < 11 then
some(of_int(di + 1))
else
none
/**
* Gives the preceding month.
*
* @param d a month
* @return [some(nd)], where [nd] is the month preceding [d], or [none] if [d] is January.
*/
prev(d : Date.month) : option(Date.month) =
di = to_int(d)
if di > 0 then
some(of_int(di - 1))
else
none
}}
/**
* {1 Date printing & parsing}
**/
/**
* This function builds a date printer, that can than be used with
* {!Date.to_formatted_string} function.
*
* It takes a format for printing dates as the only argument. The
* format is largely based on the format accepted by the Unix date
* command and the following documentation largely borrows from
* date's man page (author: David MacKenzie).
*
* The interpreted sequences in the string format are the following:
*
* - [%%] a literal [%],
* - [%a] abbreviated weekday name (ex. Mon, Tue, Wed, ...)
* - [%A] full weekday name (ex. Monday, Tuesday, Wednesday, ...)
* - [%b] abbreviated month name (ex. Jan, Feb, Mar, ...)
* - [%B] full month name (ex. January, February, ...)
* - [%c] date and time; same as [%a %b %_d %Y %T] (ex, Thu Mar 3 2005 23:05:25)
* - [%C] century, like [%Y] but with last two digits omitted (ex. 20)
* - [%d] day of month (01-31)
* - [%e] day of month, space padded; same as [%_d] (ex. 3; with space in front of 3)
* - [%E] day of month with suffixes 'st', 'nd' or 'th'
* - [%D] date; same as [%m/%d/%y] (ex. 03/07/10)
* - [%F] full date; same as [%Y-%m-%d] (ex. 2010-03-07)
* - [%h] same as [%b] (ex. Jan, Feb, Mar, ...)
* - [%H] hour (00..23)
* - [%I] hour (01..12)
* - [%k] hour ( 0..23)
* - [%l] hour ( 1..12)
* - [%m] month (01..12)
* - [%M] minute (00..59)
* - [%n] a newline
* - [%p] 12h period name (AM/PM)
* - [%P] like [%p], but lower case (am/pm)
* - [%R] 24-hour hour and minute; same as [%H:%M] (ex. 17:35)
* - [%S] second (00..59)
* - [%x] millisecond (000..999)
* - [%t] a tab
* - [%T] time; same as [%H:%M:%S] (ex. 17:35:12)
* - [%u] day of week (1..7); 1 is Monday
* - [%w] day of week (0..6); 0 is Sunday
* - [%y] last two digits of year (00..99)
* - [%Y] year (ex. 2010)
* - [%z] +hhmm numeric timezone (e.g., -0400)
*
* By default, numeric fields are padded with zeroes. The following optional flags
* may follow `%':
* - [-] (hyphen) do not pad the field
* - [_] (underscore) pad with spaces
* - [0] (zero) pad with zeros
*
* For now the following sequences used in Unix's date are unsupported:
* - [%g] the last two digits of the year corresponding to the %V week number
* - [%G] the year corresponding to the %V week number
* - [%j] day of year (001..366)
* - [%N] nanoseconds (000000000..999999999)
* - [%s] seconds since 1970-01-01 00:00:00 UTC
* - [%U] week number of year with Sunday as first day of week (00..53)
* - [%V] week number of year with Monday as first day of week (01..53)
* - [%W] week number of year with Monday as first day of week (00..53)
* - [%:z] +hh:mm numeric timezone (e.g., -04:00)
*
* Also the padding directives are not supported:
* - [%^] use upper case if possible
* - [%#] use opposite case if possible
*
* Moreover, the following locale-sensitive sequences for now work with the fixed
* English locale:
* [%a], [%A], [%b], [%B], [%c], [%p], [%P], [%r], [%x], [%X]
*
* @param format a format for printing dates (as described above)
* @return either [success(printer)] where [printer] is a printer for dates
* using [format], or [failure(error)] where [error] is a string
* description of the problem with [format].
**/
try_generate_printer(format : string) : outcome(Date.printer, string) =
Date_private.ToString.generate_printer(format)
/**
* Generates a date printer for a given format. This function behaves almost
* as {!Date.try_generate_printer} but it assumes that the format is correct
* and returns a printer (not an optional one). It will result in an runtime error
* if the [format] is not correct.
**/
generate_printer(format : string) : Date.printer =
match try_generate_printer(format) with
| ~{success} -> success
| ~{failure} -> error("Date.generate_printer({format}) -> problem with the format: {failure}")
/**
* The default format for printing dates.
**/
default_printer_fmt = "%c"
/**
* A format for printing time part of a date.
**/
time_only_printer_fmt = "%H:%M:%S"
/**
* A format for printing date (without the time part).
**/
date_only_printer_fmt = "%F"
/**
* A format for printing full dates in debug/log friendly format
**/
debug_printer_fmt = "%Y-%m-%d | %H:%M:%S.%x"
/**
* A default printer for dates.
* e.x.: "Thu Mar 7 2010 23:05:25"
**/
@both_implem default_printer = generate_printer(default_printer_fmt)
/**
* A printer for dates, displaying only the time part,
* e.x.: "23:05:25"
**/
@both_implem time_only_printer = generate_printer(time_only_printer_fmt)
/**
* A printer for dates, displaying only the date part (without time),
* ex. "2010-03-07"
**/
@both_implem date_only_printer = generate_printer(date_only_printer_fmt)
/**
* A printer for full dates in debug/log friendly format.
* ex. "2010-03-07 | 23:05:25.113"
**/
@both_implem debug_printer = generate_printer(debug_printer_fmt)
/**
* This function prints a date using a given printer.
* For ways of generating date printers see {!Date.generate_printer} and
* {!Date.try_generate_printer}.
*
* @param printer a date printer
* @param date a date to be printed
* @return string representation of [date] with [printer]
**/
to_formatted_string(printer : Date.printer, date : Date.date) : string =
printer(date)
/**
* Converts a given date to a string, ignoring the date and presenting only the
* time part, in the format "12:34:47".
*
* Use {!Date.to_formatted_string} to customize the format e.g. for a specific language.