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 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565 1566 1567 1568 1569 1570 1571 1572 1573 1574 1575 1576 1577 1578 1579 1580 1581 1582 1583 1584 1585 1586 1587 1588 1589 1590 1591 1592 1593 1594 1595 1596 1597 1598 1599 1600 1601 1602 1603 1604 1605 1606 1607 1608 1609 1610 1611 1612 1613 1614 1615 1616 1617 1618 1619 1620 1621 1622 1623 1624 1625 1626 1627 1628 1629 1630 1631 1632 1633 1634 1635 1636 1637 1638 1639 1640 1641 1642 1643 1644 1645 1646 1647 1648 1649 1650 1651 1652 1653 1654 1655 1656 1657 1658 1659 1660 1661 1662 1663 1664 1665 1666 1667 1668 1669 1670 1671 1672 1673 1674 1675 1676 1677 1678 1679 1680 1681 1682 1683 1684 1685 1686 1687 1688 1689 1690 1691 1692 1693 1694 1695 1696 1697 1698 1699 1700 1701 1702 1703 1704 1705 1706 1707 1708 1709 1710 1711 1712 1713 1714 1715 1716 1717 1718 1719 1720 1721 1722 1723 1724 1725 1726 1727 1728 1729 1730 1731 1732 1733 1734 1735 1736 1737 1738 1739 1740 1741 1742 1743 1744 1745 1746 1747 1748 1749 1750 1751 1752 1753 1754 1755 1756 1757 1758 1759 1760 1761 1762 1763 1764 1765 1766 1767 1768 1769 1770 1771 1772 1773 1774 1775 1776 1777 1778 1779 1780 1781 1782 1783 1784 1785 1786 1787 1788 1789 1790 1791 1792 1793 1794 1795 1796 1797 1798 1799 1800 1801 1802 1803 1804 1805 1806 1807 1808 1809 1810 1811 1812 1813 1814 1815 1816 1817 1818 1819 1820 1821 1822 1823 1824 1825 1826 1827 1828 1829 1830 1831 1832 1833 1834 1835 1836 1837 1838 1839 1840 1841 1842 1843 1844 1845 1846 1847 1848 1849 1850 1851 1852 1853 1854 1855 1856 1857 1858 1859 1860 1861 1862 1863 1864 1865 1866 1867 1868 1869 1870 1871 1872 1873 1874 1875 1876 1877 1878 1879 1880 1881 1882 1883 1884 1885 1886 1887 1888 1889 1890 1891 1892 1893 1894 1895 1896 1897 1898 1899 1900 1901 1902 1903 1904 1905 1906 1907 1908 1909 1910 1911 1912 1913 1914 1915 1916 1917 1918 1919 1920 1921 1922 1923 1924 1925 1926 1927 1928 1929 1930 1931 1932 1933 1934 1935 1936 1937 1938 1939 1940 1941 1942 1943 1944 1945 1946 1947 1948 1949 1950 1951 1952 1953 1954 1955 1956 1957 1958 1959 1960 1961 1962 1963 1964 1965 1966 1967 1968 1969 1970 1971 1972 1973 1974 1975
/*!
This crate provides a `parse` function to convert English time expressions into a pair
of timestamps representing a time range. It converts "today" into the first and last
moments of today, "May 6, 1968" into the first and last moments of that day, "last year"
into the first and last moments of that year, and so on. It does this even for expressions
generally interpreted as referring to a point in time, such as "3 PM", though for these it
always assumes a granularity of one second. For pointwise expression the first moment is the
point explicitly named. The `parse` expression actually returns a 3-tuple consisting of the
two timestamps and whether the expression is literally a range -- two time expressions
separated by a preposition such as "to", "through", "up to", or "until".
# Example
```rust
extern crate two_timer;
use two_timer::{parse, Config};
extern crate chrono;
use chrono::naive::NaiveDate;
pub fn main() {
let phrases = [
"now",
"this year",
"last Friday",
"from now to the end of time",
"Ragnarok",
"at 3:00 pm today",
"5/6/69",
"Tuesday, May 6, 1969 at 3:52 AM",
"March 15, 44 BC",
"Friday the 13th",
"five minutes before and after midnight",
];
// find the maximum phrase length for pretty formatting
let max = phrases
.iter()
.max_by(|a, b| a.len().cmp(&b.len()))
.unwrap()
.len();
for phrase in phrases.iter() {
match parse(phrase, None) {
Ok((d1, d2, _)) => println!("{:width$} => {} --- {}", phrase, d1, d2, width = max),
Err(e) => println!("{:?}", e),
}
}
let now = NaiveDate::from_ymd_opt(1066, 10, 14).unwrap().and_hms(12, 30, 15);
println!("\nlet \"now\" be some moment during the Battle of Hastings, specifically {}\n", now);
let conf = Config::new().now(now);
for phrase in phrases.iter() {
match parse(phrase, Some(conf.clone())) {
Ok((d1, d2, _)) => println!("{:width$} => {} --- {}", phrase, d1, d2, width = max),
Err(e) => println!("{:?}", e),
}
}
}
```
produces
```text
now => 2019-02-03 14:40:00 --- 2019-02-03 14:41:00
this year => 2019-01-01 00:00:00 --- 2020-01-01 00:00:00
last Friday => 2019-01-25 00:00:00 --- 2019-01-26 00:00:00
from now to the end of time => 2019-02-03 14:40:00 --- +262143-12-31 23:59:59.999
Ragnarok => +262143-12-31 23:59:59.999 --- +262143-12-31 23:59:59.999
at 3:00 pm today => 2019-02-03 15:00:00 --- 2019-02-03 15:01:00
5/6/69 => 1969-05-06 00:00:00 --- 1969-05-07 00:00:00
Tuesday, May 6, 1969 at 3:52 AM => 1969-05-06 03:52:00 --- 1969-05-06 03:53:00
March 15, 44 BC => -0043-03-15 00:00:00 --- -0043-03-16 00:00:00
Friday the 13th => 2018-07-13 00:00:00 --- 2018-07-14 00:00:00
five minutes before and after midnight => 2019-02-02 23:55:00 --- 2019-02-03 00:05:00
let "now" be some moment during the Battle of Hastings, specifically 1066-10-14 12:30:15
now => 1066-10-14 12:30:00 --- 1066-10-14 12:31:00
this year => 1066-01-01 00:00:00 --- 1067-01-01 00:00:00
last Friday => 1066-10-05 00:00:00 --- 1066-10-06 00:00:00
from now to the end of time => 1066-10-14 12:30:00 --- +262143-12-31 23:59:59.999
Ragnarok => +262143-12-31 23:59:59.999 --- +262143-12-31 23:59:59.999
at 3:00 pm today => 1066-10-14 15:00:00 --- 1066-10-14 15:01:00
5/6/69 => 0969-05-06 00:00:00 --- 0969-05-07 00:00:00
Tuesday, May 6, 1969 at 3:52 AM => 1969-05-06 03:52:00 --- 1969-05-06 03:53:00
March 15, 44 BC => -0043-03-15 00:00:00 --- -0043-03-16 00:00:00
Friday the 13th => 1066-07-13 00:00:00 --- 1066-07-14 00:00:00
five minutes before and after midnight => 1066-10-13 23:55:00 --- 1066-10-14 00:05:00
```
For the full grammar of time expressions, view the source of the `parse` function and
scroll up. The grammar is provided at the top of the file.
# Relative Times
It is common in English to use time expressions which must be interpreted relative to some
context. The context may be verb tense, other events in the discourse, or other semantic or
pragmatic clues. The `two_timer` `parse` function doesn't attempt to infer context perfectly, but
it does make some attempt to get the context right. So, for instance "last Monday through Friday", said
on Saturday, will end on a different day from "next Monday through Friday". The general rules
are
1. a fully-specified expression in a pair will provide the context for the other expression
2. a relative expression will be interpreted as appropriate given its order -- the second expression
describes a time after the first
3. if neither expression is fully-specified, the first will be interpreted relative to "now" and the
second relative to the first
4. a moment interpreted relative to "now" will be assumed to be before now unless the configuration
parameter `default_to_past` is set to `false`, in which case it will be assumed to be after now
The rules of interpretation for relative time expressions in ranges will likely be refined further
in the future.
# Clock Time
The parse function interprets expressions such as "3:00" as referring to time on a 24 hour clock, so
"3:00" will be interpreted as "3:00 AM". This is true even in ranges such as "3:00 PM to 4", where the
more natural interpretation might be "3:00 PM to 4:00 PM".
# Years Near 0
Since it is common to abbreviate years to the last two digits of the century, two-digit
years will be interpreted as abbreviated unless followed by a suffix such as "B.C.E." or "AD".
They will be interpreted by default as the the nearest appropriate *previous* year to the current moment,
so in 2010 "'11" will be interpreted as 1911, not 2011. If you set the configuration parameter
`default_to_past` to `false` this is reversed, so "'11" in 2020 will be interpreted as 2111.
# The Second Time in Ranges
For single expressions, like "this year", "today", "3:00", or "next month", the second of the
two timestamps is straightforward -- it is the end of the relevant temporal unit. "1971" will
be interpreted as the first moment of the first day of 1971 through, but excluding, the first
moment of the first day of 1972, so the second timestamp will be this first excluded moment.
When the parsed expression describes a range, we're really dealing with two potentially overlapping
pairs of timestamps and the choice of the terminal timestamp gets trickier. The general rule
will be that if the second interval is shorter than a day, the first timestamp is the first excluded moment,
so "today to 3:00 PM" means the first moment of the day up to, but excluding, 3:00 PM. If the second
unit is as big as or larger than a day, which timestamp is used varies according to the preposition.
"This week up to Friday" excludes all of Friday. "This week through Friday" includes all of Friday.
Prepositions are assumed to fall into either the "to" class or the "through" class. You may also use
a series of dashes as a synonym for "through", so "this week - fri" is equivalent to "this week through Friday".
For the most current list of prepositions in each class, consult the grammar used for parsing, but
as of the moment, these are the rules:
```text
up_to => [["to", "until", "up to", "till"]]
through => [["up through", "through", "thru"]] | r("-+")
```
# Pay Periods
I'm writing this library in anticipation of, for the sake of amusement, rewriting [JobLog](https://metacpan.org/pod/App::JobLog)
in Rust. This means I need the time expressions parsed to include pay periods. Pay periods, though,
are defined relative to some reference date -- a particular Sunday, say -- and have a variable period.
`two_timer`, and JobLog, assume pay periods are of a fixed length and tile the timeline without overlap, so a
pay period of a calendrical month is problematic.
If you need to interpret "last pay period", say, you will need to specify when this pay period began, or
when some pay period began or will begin, and a pay period length in days. The `parse` function has a second
optional argument, a `Config` object, whose chief function outside of testing is to provide this information. So,
for example, you could do this:
```rust
# extern crate two_timer;
# use two_timer::{parse, Config};
let (reference_time, _, _) = parse("5/6/69", None).unwrap();
let config = Config::new().pay_period_start(Some(reference_time.date()));
let (t1, t2, _) = parse("next pay period", Some(config)).unwrap();
```
# Ambiguous Year Formats
`two_timer` will try various year-month-day permutations until one of them parses given that days are in the range 1-31 and
months, 1-12. This is the order in which it tries these permutations:
1. year/month/day
2. year/day/month
3. month/day/year
4. day/month/year
The potential unit separators are `/`, `.`, and `-`. Whitespace is optional.
# Timezones
At the moment `two_timer` only produces "naive" times. Sorry about that.
# Optional Features
The regular expression used by two-timer is extremely efficient once compiled but extremely slow to compile.
This means that the first use of the regular expression will ocassion a perceptible delay. I wrote two-timer as
a component of a Rust re-write of a Perl command line application I also wrote, [App::JobLog](https://metacpan.org/pod/distribution/App-JobLog/bin/job).
Compiling the full time grammar required by two-timer makes the common use cases for the Rust version of the application
slower than the Perl version. To address this I added an optional feature to two-timer that one can enable like so:
```toml
[dependencies.two_timer]
version = "~2.2"
features = ["small_grammar"]
```
This will cause two-timer to attempt to parse a time expression initially with a simplified grammar containing
only the typical expressions used with JobLog, falling back on the full grammar if this fails. These are
1. Days of the week, optionally abbreviated
* Tuesday
* tue
* tu
2. Month names
* June
* Jun
3. Days, months, or fixed periods of time modified by "this" or "last"
* this month
* last week
* this year
* this pay period
* last Monday
4. Certain temporal adverbs
* now
* today
* yesterday
});
*/
#![recursion_limit = "1024"]
#[macro_use]
extern crate pidgin;
#[macro_use]
extern crate lazy_static;
extern crate chrono;
extern crate serde_json;
use chrono::naive::{NaiveDate, NaiveDateTime};
use chrono::{Datelike, Duration, Local, Timelike, Weekday};
use pidgin::{Grammar, Match, Matcher};
use regex::Regex;
lazy_static! {
// making this public is useful for testing, but best to keep it hidden to
// limit complexity and commitment
#[doc(hidden)]
pub static ref GRAMMAR: Grammar = grammar!{
(?ibBw)
TOP -> r(r"\A") <time_expression> r(r"\z")
// non-terminal patterns
// these are roughly ordered by dependency
time_expression => <universal> | <particular>
particular => <one_time> | <two_times>
one_time => <moment_or_period>
two_times -> ("from")? <moment_or_period> <to> <moment_or_period> | <since_time>
since_time -> <since> <clusivity>? <moment_or_period>
clusivity -> ("the") <terminus> ("of")
terminus => <beginning> | <end>
to => <up_to> | <through>
moment_or_period => <moment> | <period>
period => <named_period> | <specific_period>
specific_period => <modified_period> | <month_and_year> | <year> | <relative_period>
modified_period -> <modifier>? <modifiable_period>
modifiable_period => [["week", "month", "year", "pay period", "payperiod", "pp", "weekend"]] | <a_month> | <a_day>
month_and_year -> <a_month> <year>
year => <short_year> | ("-")? <n_year>
year -> <suffix_year> <year_suffix>
year_suffix => <ce> | <bce>
relative_period -> <count> <displacement> <from_now_or_ago>
count => r(r"[1-9][0-9]*") | <a_count>
named_period => <a_day> | <a_month>
moment -> <adjustment>? <point_in_time>
adjustment -> <amount> <direction> // two minutes before
amount -> <count> <unit>
point_in_time -> <at_time_on>? <some_day> <at_time>? | <specific_time> | <time>
at_time_on -> ("at")? <time> ("on")?
some_day => <specific_day> | <relative_day>
specific_day => <adverb> | <date_with_year>
date_with_year => <n_date> | <a_date>
n_date -> <year> r("[./-]") <n_month> r("[./-]") <n_day>
n_date -> <year> r("[./-]") <n_day> r("[./-]") <n_month>
n_date -> <n_month> r("[./-]") <n_day> r("[./-]") <year>
n_date -> <n_day> r("[./-]") <n_month> r("[./-]") <year>
a_date -> <day_prefix>? <a_month> <o_n_day> (",") <year>
a_date -> <day_prefix>? <n_day> <a_month> <year>
a_date -> <day_prefix>? ("the") <o_day> ("of") <a_month> <year>
day_prefix => <a_day> (",")?
relative_day => <a_day> | <a_day_in_month>
at_time -> ("at") <time>
specific_time => <first_time> | <last_time> | <precise_time>
precise_time -> <n_date> <hour_24>
time -> <hour_12> <am_pm>? | <hour_24> | <named_time>
hour_12 => <h12>
hour_12 => <h12> (":") <minute>
hour_12 => <h12> (":") <minute> (":") <second>
hour_24 => <h24>
hour_24 => <h24> (":") <minute>
hour_24 => <h24> (":") <minute> (":") <second>
a_day_in_month => <ordinal_day> | <day_and_month>
ordinal_day -> <day_prefix>? ("the") <o_day> // the first
o_day => <n_ordinal> | <a_ordinal> | <roman>
day_and_month -> <n_month> r("[./-]") <n_day> // 5-6
day_and_month -> <a_month> ("the")? <o_n_day> // June 5, June 5th, June fifth, June the fifth
day_and_month -> ("the") <o_day> ("of") <a_month> // the 5th of June, the fifth of June
o_n_day => <n_day> | <o_day>
// terminal patterns
// these are organized into single-line and multi-line patterns, with each group alphabetized
// various phrases all meaning from the first measurable moment to the last
a_count => [["one", "two", "three", "four", "five", "six", "seven", "eight", "nine", "ten"]]
adverb => [["now", "today", "tomorrow", "yesterday"]]
am_pm => (?-ib) [["am", "AM", "pm", "PM", "a.m.", "A.M.", "p.m.", "P.M."]]
bce => (?-ib) [["bce", "b.c.e.", "bc", "b.c.", "BCE", "B.C.E.", "BC", "B.C."]]
beginning => [["beginning", "start"]]
ce => (?-ib) [["ce", "c.e.", "ad", "a.d.", "CE", "C.E.", "AD", "A.D."]]
direction -> [["before", "after", "around", "before and after"]]
displacement => [["week", "day", "hour", "minute", "second"]] ("s")? // not handling variable-width periods like months or years
end => ("end")
from_now_or_ago => [["from now", "ago"]]
h12 => (?-B) [(1..=12).into_iter().collect::<Vec<_>>()]
h24 => [(1..=24).into_iter().flat_map(|i| vec![format!("{}", i), format!("{:02}", i)]).collect::<Vec<_>>()]
minute => (?-B) [ (0..60).into_iter().map(|i| format!("{:02}", i)).collect::<Vec<_>>() ]
modifier => [["the", "this", "last", "next"]]
named_time => [["noon", "midnight"]]
n_year => r(r"\b(?:[1-9][0-9]{0,4}|0)\b")
roman => [["nones", "ides", "kalends"]]
since => [["since", "after"]]
unit => [["week", "day", "hour", "minute", "second"]] ("s")?
universal => [["always", "ever", "all time", "forever", "from beginning to end", "from the beginning to the end"]]
up_to => [["to", "until", "up to", "till"]]
second => (?-B) [ (0..60).into_iter().map(|i| format!("{:02}", i)).collect::<Vec<_>>() ]
suffix_year => r(r"\b[1-9][0-9]{0,4}")
through => [["up through", "through", "thru"]] | r("-+")
a_day => (?-i) [["M", "T", "W", "R", "F", "S", "U"]]
a_day => [
"Sunday Monday Tuesday Wednesday Thursday Friday Saturday Tues Weds Thurs Tues. Weds. Thurs."
.split(" ")
.into_iter()
.flat_map(|w| vec![
w.to_string(),
w[0..2].to_string(),
w[0..3].to_string(),
format!("{}.", w[0..2].to_string()),
format!("{}.", w[0..3].to_string()),
])
.collect::<Vec<_>>()
]
a_month => [
"January February March April May June July August September October November December"
.split(" ")
.into_iter()
.flat_map(|w| vec![w.to_string(), w[0..3].to_string()])
.collect::<Vec<_>>()
]
a_ordinal => [[
"first",
"second",
"third",
"fourth",
"fifth",
"sixth",
"seventh",
"eighth",
"ninth",
"tenth",
"eleventh",
"twelfth",
"thirteenth",
"fourteenth",
"fifteenth",
"sixteenth",
"seventeenth",
"eighteenth",
"nineteenth",
"twentieth",
"twenty-first",
"twenty-second",
"twenty-third",
"twenty-fourth",
"twenty-fifth",
"twenty-sixth",
"twenty-seventh",
"twenty-eighth",
"twenty-ninth",
"thirtieth",
"thirty-first"
]]
first_time => [[
"the beginning",
"the beginning of time",
"the first moment",
"the start",
"the very start",
"the first instant",
"the dawn of time",
"the big bang",
"the birth of the universe",
]]
last_time => [[
"the end",
"the end of time",
"the very end",
"the last moment",
"eternity",
"infinity",
"doomsday",
"the crack of doom",
"armageddon",
"ragnarok",
"the big crunch",
"the heat death of the universe",
"doom",
"death",
"perdition",
"the last hurrah",
"ever after",
"the last syllable of recorded time",
]]
n_day => [
(1..=31)
.into_iter()
.flat_map(|i| vec![i.to_string(), format!("{:02}", i)])
.collect::<Vec<_>>()
]
n_month => [
(1..=12)
.into_iter()
.flat_map(|i| vec![format!("{:02}", i), format!("{}", i)])
.collect::<Vec<_>>()
]
n_ordinal => [[
"1st",
"2nd",
"3rd",
"4th",
"5th",
"6th",
"7th",
"8th",
"9th",
"10th",
"11th",
"12th",
"13th",
"14th",
"15th",
"16th",
"17th",
"18th",
"19th",
"20th",
"21st",
"22nd",
"23rd",
"24th",
"25th",
"26th",
"27th",
"28th",
"29th",
"30th",
"31st",
]]
short_year => [
(0..=99)
.into_iter()
.flat_map(|i| vec![format!("'{:02}", i), format!("{:02}", i)])
.collect::<Vec<_>>()
]
};
}
// code generated via cargo run --bin serializer
// this saves the cost of generating GRAMMAR
lazy_static! {
#[doc(hidden)]
pub static ref MATCHER: Matcher = GRAMMAR.matcher().unwrap();
}
lazy_static! {
// making this public is useful for testing, but best to keep it hidden to
// limit complexity and commitment
#[doc(hidden)]
// this is a stripped-down version of GRAMMAR that just containst the most commonly used expressions
pub static ref SMALL_GRAMMAR: Grammar = grammar!{
(?ibBw)
TOP -> r(r"\A") <time_expression> r(r"\z")
// non-terminal patterns
// these are roughly ordered by dependency
time_expression => <particular>
particular => <one_time>
one_time => <moment_or_period>
moment_or_period => <moment> | <period>
period => <named_period> | <specific_period>
specific_period => <modified_period>
modified_period -> <modifier>? <modifiable_period>
modifiable_period => [["week", "month", "year", "pay period", "pp"]] | <a_month> | <a_day>
named_period => <a_day> | <a_month>
moment -> <point_in_time>
point_in_time -> <some_day>
some_day => <specific_day> | <relative_day>
specific_day => <adverb>
relative_day => <a_day>
// terminal patterns
// these are organized into single-line and multi-line patterns, with each group alphabetized
// various phrases all meaning from the first measurable moment to the last
adverb => [["now", "today", "yesterday"]]
modifier => [["the", "this", "last"]]
a_day => [
"Sunday Monday Tuesday Wednesday Thursday Friday Saturday Tues Weds Thurs Tues. Weds. Thurs."
.split(" ")
.into_iter()
.flat_map(|w| vec![
w.to_string(),
w[0..2].to_string(),
w[0..3].to_string(),
format!("{}.", w[0..2].to_string()),
format!("{}.", w[0..3].to_string()),
])
.collect::<Vec<_>>()
]
a_month => [
"January February March April May June July August September October November December"
.split(" ")
.into_iter()
.flat_map(|w| vec![w.to_string(), w[0..3].to_string()])
.collect::<Vec<_>>()
]
};
}
// code generated via cargo run --bin serializer
// this saves the cost of generating GRAMMAR
lazy_static! {
#[doc(hidden)]
pub static ref SMALL_MATCHER : Matcher = SMALL_GRAMMAR.matcher().unwrap();
}
/// Simply returns whether the given phrase is parsable as a time expression. This is slightly
/// more efficient than `parse(expression, None).is_ok()` as no parse tree is generated.
///
/// # Examples
///
/// ```rust
/// # extern crate two_timer;
/// # use two_timer::{parsable};
/// let copacetic = parsable("5/6/69");
/// ```
pub fn parsable(phrase: &str) -> bool {
if cfg!(feature = "small_grammar") {
SMALL_MATCHER.rx.is_match(phrase) || MATCHER.rx.is_match(phrase)
} else {
MATCHER.rx.is_match(phrase)
}
}
/// Converts a time expression into a pair or timestamps and a boolean indicating whether
/// the expression was literally a range, such as "9 to 11", as opposed to "9 AM", say.
///
/// The second parameter is an optional `Config` object. In general you will not need to
/// use this except in testing or in the interpretation of pay periods.
///
/// # Examples
///
/// ```rust
/// # extern crate two_timer;
/// # use two_timer::{parse, Config};
/// let (reference_time, _, _) = parse("5/6/69", None).unwrap();
/// ```
pub fn parse(
phrase: &str,
config: Option<Config>,
) -> Result<(NaiveDateTime, NaiveDateTime, bool), TimeError> {
let parse = if cfg!(feature = "small_grammar") {
SMALL_MATCHER
.parse(phrase)
.or_else(|| MATCHER.parse(phrase))
} else {
MATCHER.parse(phrase)
};
if parse.is_none() {
return Err(TimeError::Parse(format!(
"could not parse \"{}\" as a time expression",
phrase
)));
}
let parse = parse.unwrap();
if parse.has("universal") {
return Ok((first_moment(), last_moment(), false));
}
let parse = parse.name("particular").unwrap();
let config = config.unwrap_or(Config::new());
if let Some(moment) = parse.name("one_time") {
return match handle_one_time(moment, &config) {
Err(e) => Err(e),
Ok((d1, d2, b)) => {
let (d3, d4) = adjust(d1, d2, moment);
if d1 == d3 {
Ok((d1, d2, b))
} else {
Ok((d3, d4, b))
}
}
};
}
if let Some(two_times) = parse.name("two_times") {
let mut inclusive = two_times.has("beginning");
let exclusive = !inclusive && two_times.has("end"); // note this is *explicitly* exclusive
if !(inclusive || exclusive) && (two_times.has("time") || two_times.has("precise_time")) {
// treating "since noon" as including 12:00:00 and "since 2am" as including 14:00:00
inclusive = true;
}
if let Some(previous_time) = two_times.name("since_time") {
if specific(previous_time) {
return match specific_moment(previous_time, &config) {
Ok((d1, d2)) => {
let t = if inclusive { d1 } else { d2 };
// if *implicitly* exclusive and we find things misordered, we become inclusive
let t = if !(inclusive || exclusive) && t > config.now {
d1
} else {
t
};
if t > config.now {
Err(TimeError::Misordered(format!(
"the inferred times, {} and {}, are misordered",
t, config.now
)))
} else {
Ok((t, config.now.clone(), false))
}
}
Err(s) => Err(s),
};
}
return match relative_moment(previous_time, &config, &config.now, true) {
Ok((d1, d2)) => {
let t = if inclusive { d1 } else { d2 };
let t = if !(inclusive || exclusive) && t > config.now {
d1
} else {
t
};
if t > config.now {
Err(TimeError::Misordered(format!(
"the inferred times, {} and {}, are misordered",
t, config.now
)))
} else {
Ok((t, config.now.clone(), false))
}
}
Err(s) => Err(s),
};
}
let first = &two_times.children().unwrap()[0];
let last = &two_times.children().unwrap()[2];
let is_through = two_times.has("through");
if specific(first) {
if specific(last) {
return match specific_moment(first, &config) {
Ok((d1, d2)) => {
let (d1, _) = adjust(d1, d2, first);
match specific_moment(last, &config) {
Ok((d2, d3)) => {
let (d2, d3) = adjust(d2, d3, last);
let d2 = pick_terminus(d2, d3, is_through);
if d1 <= d2 {
Ok((d1, d2, true))
} else {
Err(TimeError::Misordered(format!(
"{} is after {}",
first.as_str(),
last.as_str()
)))
}
}
Err(s) => Err(s),
}
}
Err(s) => Err(s),
};
} else {
return match specific_moment(first, &config) {
Ok((d1, d2)) => {
let (d1, _) = adjust(d1, d2, first);
match relative_moment(last, &config, &d1, false) {
Ok((d2, d3)) => {
let (d2, d3) = adjust(d2, d3, last);
let d2 = pick_terminus(d2, d3, is_through);
Ok((d1, d2, true))
}
Err(s) => Err(s),
}
}
Err(s) => Err(s),
};
}
} else if specific(last) {
return match specific_moment(last, &config) {
Ok((d2, d3)) => {
let (d2, d3) = adjust(d2, d3, last);
let d2 = pick_terminus(d2, d3, is_through);
match relative_moment(first, &config, &d2, true) {
Ok((d1, d3)) => {
let (d1, _) = adjust(d1, d3, first);
Ok((d1, d2, true))
}
Err(s) => Err(s),
}
}
Err(s) => Err(s),
};
} else {
// the first moment is assumed to be before now if default_to_past is true, otherwise it is after
return match relative_moment(first, &config, &config.now, config.default_to_past) {
Ok((d1, d2)) => {
let (d1, _) = adjust(d1, d2, first);
// the second moment is necessarily after the first moment
match relative_moment(last, &config, &d1, false) {
Ok((d2, d3)) => {
let (d2, d3) = adjust(d2, d3, last);
let d2 = pick_terminus(d2, d3, is_through);
Ok((d1, d2, true))
}
Err(s) => Err(s),
}
}
Err(s) => Err(s),
};
}
}
unreachable!();
}
/// A collection of parameters that can influence the interpretation
/// of time expressions.
#[derive(Debug, Clone)]
pub struct Config {
now: NaiveDateTime,
monday_starts_week: bool,
period: Period,
pay_period_length: u32,
pay_period_start: Option<NaiveDate>,
default_to_past: bool,
}
impl Config {
/// Constructs an expression with the default parameters.
pub fn new() -> Config {
Config {
now: Local::now().naive_local(),
monday_starts_week: true,
period: Period::Minute,
pay_period_length: 7,
pay_period_start: None,
default_to_past: true,
}
}
/// Returns a copy of the configuration parameters with the "now" moment
/// set to the parameter supplied.
pub fn now(&self, n: NaiveDateTime) -> Config {
let mut c = self.clone();
c.now = n;
c
}
fn period(&self, period: Period) -> Config {
let mut c = self.clone();
c.period = period;
c
}
/// Returns a copy of the configuration parameters with whether
/// Monday is regarded as the first day of the week set to the parameter
/// supplied. By default Monday *is* regarded as the first day. If this
/// parameter is set to `false`, Sunday will be regarded as the first weekday.
pub fn monday_starts_week(&self, monday_starts_week: bool) -> Config {
let mut c = self.clone();
c.monday_starts_week = monday_starts_week;
c
}
/// Returns a copy of the configuration parameters with the pay period
/// length in days set to the parameter supplied. The default pay period
/// length is 7 days.
pub fn pay_period_length(&self, pay_period_length: u32) -> Config {
let mut c = self.clone();
c.pay_period_length = pay_period_length;
c
}
/// Returns a copy of the configuration parameters with the reference start
/// date for a pay period set to the parameter supplied. By default this date
/// is undefined. Unless it is defined, expressions containing the phrase "pay period"
/// or "pp" cannot be interpreted.
pub fn pay_period_start(&self, pay_period_start: Option<NaiveDate>) -> Config {
let mut c = self.clone();
c.pay_period_start = pay_period_start;
c
}
/// Returns a copy of the configuration parameters with the `default_to_past`
/// parameter set as specified. This allows the interpretation of relative time expressions
/// like "Friday" and "12:00". By default, these expressions are assumed to refer to the
/// most recent such interval in the *past*. By setting `default_to_past` to `false`
/// the rule changes so they are assumed to refer to the nearest such interval in the future.
pub fn default_to_past(&self, default_to_past: bool) -> Config {
let mut c = self.clone();
c.default_to_past = default_to_past;
c
}
}
/// A simple categorization of things that could go wrong.
///
/// Every error provides a descriptive string that can be displayed.
#[derive(Debug, Clone)]
pub enum TimeError {
/// The time expression cannot be parsed by the available grammar.
Parse(String),
/// The time expression consists of a time range and the end of the range is before
/// the beginning.
Misordered(String),
/// The time expression specifies an impossible date, such as the 31st of September.
ImpossibleDate(String),
/// The time expression specifies a weekday different from that required by the rest
/// of the expression, such as Wednesday, May 5, 1969, which was a Tuesday.
Weekday(String),
/// The time expression refers to a pay period, but the starting date of a reference
/// pay period has not been provided, so the pay period is undefined.
NoPayPeriod(String),
}
impl TimeError {
/// Extracts error message.
pub fn msg(&self) -> &str {
match self {
TimeError::Parse(s) => s.as_ref(),
TimeError::Misordered(s) => s.as_ref(),
TimeError::ImpossibleDate(s) => s.as_ref(),
TimeError::Weekday(s) => s.as_ref(),
TimeError::NoPayPeriod(s) => s.as_ref(),
}
}
}
impl std::error::Error for TimeError {}
impl std::fmt::Display for TimeError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
match self {
TimeError::Parse(s) => write!(f, "Parse error: {}", s),
TimeError::Misordered(s) => write!(f, "Misordered error: {}", s),
TimeError::ImpossibleDate(s) => write!(f, "Impossible date: {}", s),
TimeError::Weekday(s) => write!(f, "Weekday error: {}", s),
TimeError::NoPayPeriod(s) => write!(f, "No Pay Period error: {}", s),
}
}
}
// for the end time, if the span is less than a day, use the first, otherwise use the second
// e.g., Monday through Friday at 3 PM should end at 3 PM, but Monday through Friday should end at the end of Friday
fn pick_terminus(d1: NaiveDateTime, d2: NaiveDateTime, through: bool) -> NaiveDateTime {
if through {
d2
} else {
d1
}
}
/// The moment regarded as the beginning of time.
///
/// # Examples
///
/// ```rust
/// # extern crate two_timer;
/// # use two_timer::first_moment;
/// println!("{}", first_moment()); // -262144-01-01 00:00:00
/// ```
pub fn first_moment() -> NaiveDateTime {
NaiveDate::MIN.and_hms_milli_opt(0, 0, 0, 0).unwrap()
}
/// The moment regarded as the end of time.
///
/// # Examples
///
/// ```rust
/// # extern crate two_timer;
/// # use two_timer::last_moment;
/// println!("{}", last_moment()); // +262143-12-31 23:59:59.999
/// ```
pub fn last_moment() -> NaiveDateTime {
NaiveDate::MAX.and_hms_milli_opt(23, 59, 59, 999).unwrap()
}
fn specific(m: &Match) -> bool {
m.has("specific_day") || m.has("specific_period") || m.has("specific_time")
}
fn n_date(date: &Match, config: &Config) -> Result<NaiveDate, TimeError> {
let year = year(date, config);
let month = n_month(date);
let day = n_day(date);
match NaiveDate::from_ymd_opt(year, month, day) {
None => Err(TimeError::ImpossibleDate(format!(
"cannot construct date with year {}, month {}, and day {}",
year, month, day
))),
Some(d) => Ok(d),
}
}
fn handle_specific_day(
m: &Match,
config: &Config,
) -> Result<(NaiveDateTime, NaiveDateTime), TimeError> {
let now = config.now.clone();
let mut times = m.all_names("time");
if times.len() > 1 {
return Err(TimeError::Parse(format!(
"more than one daytime specified in {}",
m.as_str()
)));
}
let time = times.pop();
if let Some(adverb) = m.name("adverb") {
return match adverb.as_str().chars().nth(0).expect("empty string") {
// now
'n' | 'N' => Ok(moment_and_time(config, time)),
't' | 'T' => match adverb.as_str().chars().nth(2).expect("impossible string") {
// today
'd' | 'D' => Ok(moment_and_time(&config.period(Period::Day), time)),
// tomorrow
'm' | 'M' => Ok(moment_and_time(
&Config::new()
.now(now + Duration::days(1))
.period(Period::Day),
time,
)),
_ => unreachable!(),
},
// yesterday
'y' | 'Y' => Ok(moment_and_time(
&Config::new()
.now(now - Duration::days(1))
.period(Period::Day),
time,
)),
_ => unreachable!(),
};
}
if let Some(date) = m.name("date_with_year") {
if let Some(date) = date.name("n_date") {
return match n_date(date, config) {
Err(s) => Err(s),
Ok(d1) => {
let d1 = d1.and_hms_opt(0, 0, 0).unwrap();
Ok(moment_and_time(
&Config::new().now(d1).period(Period::Day),
time,
))
}
};
}
if let Some(date) = date.name("a_date") {
let year = year(date, config);
let month = a_month(date);
let day = if date.has("n_day") {
n_day(date)
} else {
o_day(date, month)
};
let d_opt = NaiveDate::from_ymd_opt(year, month, day);
return match d_opt {
None => Err(TimeError::ImpossibleDate(format!(
"cannot construct date with year {}, month {}, and day {}",
year, month, day
))),
Some(d1) => {
if let Some(wd) = date.name("a_day") {
let wd = weekday(wd.as_str());
if wd == d1.weekday() {
let d1 = d1.and_hms_opt(0, 0, 0).unwrap();
Ok(moment_and_time(
&Config::new().now(d1).period(Period::Day),
time,
))
} else {
Err(TimeError::Weekday(format!(
"the weekday of year {}, month {}, day {} is not {}",
year,
month,
day,
date.name("a_day").unwrap().as_str()
)))
}
} else {
let d1 = d1.and_hms_opt(0, 0, 0).unwrap();
Ok(moment_and_time(
&Config::new().now(d1).period(Period::Day),
time,
))
}
}
};
}
unreachable!();
}
unimplemented!();
}
fn handle_specific_period(
moment: &Match,
config: &Config,
) -> Result<(NaiveDateTime, NaiveDateTime), TimeError> {
if let Some(moment) = moment.name("relative_period") {
let count = count(moment.name("count").unwrap()) as i64;
let (displacement, period) = match moment
.name("displacement")
.unwrap()
.as_str()
.chars()
.nth(0)
.unwrap()
{
'w' | 'W' => (Duration::weeks(count), Period::Week),
'd' | 'D' => (Duration::days(count), Period::Day),
'h' | 'H' => (Duration::hours(count), Period::Hour),
'm' | 'M' => (Duration::minutes(count), Period::Minute),
's' | 'S' => (Duration::seconds(count), Period::Second),
_ => unreachable!(),
};
let d = match moment
.name("from_now_or_ago")
.unwrap()
.as_str()
.chars()
.nth(0)
.unwrap()
{
'a' | 'A' => config.now - displacement,
'f' | 'F' => config.now + displacement,
_ => unreachable!(),
};
let span = match period {
Period::Week => (d, d + Duration::weeks(1)),
_ => moment_to_period(d, &period, config),
};
return Ok(span);
}
if let Some(moment) = moment.name("month_and_year") {
let y = year(moment, &config);
let m = a_month(moment);
return match NaiveDate::from_ymd_opt(y, m, 1) {
None => unreachable!(),
Some(d1) => {
let d1 = d1.and_hms_opt(0, 0, 0).unwrap();
Ok(moment_and_time(
&Config::new().now(d1).period(Period::Month),
None,
))
}
};
}
if let Some(moment) = moment.name("modified_period") {
let modifier = PeriodModifier::from_match(moment.name("modifier"));
if let Some(month) = moment.name("a_month") {
let d = config.now.with_month(a_month(month)).unwrap();
let (d, _) = moment_to_period(d, &Period::Month, config);
let d = match modifier {
PeriodModifier::Next => d.with_year(d.year() + 1).unwrap(),
PeriodModifier::Last => d.with_year(d.year() - 1).unwrap(),
PeriodModifier::This => d,
};
return Ok(moment_to_period(d, &Period::Month, config));
}
if let Some(wd) = moment.name("a_day") {
let wd = weekday(wd.as_str());
let offset = config.now.weekday().num_days_from_monday() as i64
- wd.num_days_from_monday() as i64;
let d = config.now.date() - Duration::days(offset);
let d = match modifier {
PeriodModifier::Next => d + Duration::days(7),
PeriodModifier::Last => d - Duration::days(7),
PeriodModifier::This => d,
};
return Ok(moment_to_period(
d.and_hms_opt(0, 0, 0).unwrap(),
&Period::Day,
config,
));
}
return match ModifiablePeriod::from_match(moment.name("modifiable_period").unwrap()) {
ModifiablePeriod::Week => {
let (d, _) = moment_to_period(config.now, &Period::Week, config);
let d = match modifier {
PeriodModifier::Next => d + Duration::days(7),
PeriodModifier::Last => d - Duration::days(7),
PeriodModifier::This => d,
};
Ok(moment_to_period(d, &Period::Week, config))
}
ModifiablePeriod::Weekend => {
let (_, d2) =
moment_to_period(config.now, &Period::Week, &config.monday_starts_week(true));
let d2 = match modifier {
PeriodModifier::Next => d2 + Duration::days(7),
PeriodModifier::Last => d2 - Duration::days(7),
PeriodModifier::This => d2,
};
let d1 = d2 - Duration::days(2);
Ok((d1, d2))
}
ModifiablePeriod::Month => {
let (d, _) = moment_to_period(config.now, &Period::Month, config);
let d = match modifier {
PeriodModifier::Next => {
if d.month() == 12 {
d.with_year(d.year() + 1).unwrap().with_month(1).unwrap()
} else {
d.with_month(d.month() + 1).unwrap()
}
}
PeriodModifier::Last => {
if d.month() == 1 {
d.with_year(d.year() - 1).unwrap().with_month(12).unwrap()
} else {
d.with_month(d.month() - 1).unwrap()
}
}
PeriodModifier::This => d,
};
Ok(moment_to_period(d, &Period::Month, config))
}
ModifiablePeriod::Year => {
let (d, _) = moment_to_period(config.now, &Period::Year, config);
let d = match modifier {
PeriodModifier::Next => d.with_year(d.year() + 1).unwrap(),
PeriodModifier::Last => d.with_year(d.year() - 1).unwrap(),
PeriodModifier::This => d,
};
Ok(moment_to_period(d, &Period::Year, config))
}
ModifiablePeriod::PayPeriod => {
if config.pay_period_start.is_some() {
let (d, _) = moment_to_period(config.now, &Period::PayPeriod, config);
let d = match modifier {
PeriodModifier::Next => d + Duration::days(config.pay_period_length as i64),
PeriodModifier::Last => d - Duration::days(config.pay_period_length as i64),
PeriodModifier::This => d,
};
Ok(moment_to_period(d, &Period::PayPeriod, config))
} else {
Err(TimeError::NoPayPeriod(String::from(
"no pay period start date provided",
)))
}
}
};
}
if let Some(moment) = moment.name("year") {
let year = year(moment, config);
return Ok(moment_to_period(
first_moment_of_day(year, 1, 1),
&Period::Year,
config,
));
}
unreachable!()
}
enum ModifiablePeriod {
Week,
Month,
Year,
PayPeriod,
Weekend,
}
impl ModifiablePeriod {
fn from_match(m: &Match) -> ModifiablePeriod {
match m.as_str().chars().nth(0).expect("unreachable") {
'w' | 'W' => {
if m.as_str().len() == 4 {
ModifiablePeriod::Week
} else {
ModifiablePeriod::Weekend
}
}
'm' | 'M' => ModifiablePeriod::Month,
'y' | 'Y' => ModifiablePeriod::Year,
'p' | 'P' => ModifiablePeriod::PayPeriod,
_ => unreachable!(),
}
}
}
enum PeriodModifier {
This,
Next,
Last,
}
impl PeriodModifier {
fn from_match(m: Option<&Match>) -> PeriodModifier {
if let Some(m) = m {
match m.as_str().chars().nth(0).expect("unreachable") {
't' | 'T' => PeriodModifier::This,
'l' | 'L' => PeriodModifier::Last,
'n' | 'N' => PeriodModifier::Next,
_ => unreachable!(),
}
} else {
PeriodModifier::This
}
}
}
fn handle_specific_time(
moment: &Match,
config: &Config,
) -> Result<(NaiveDateTime, NaiveDateTime), TimeError> {
if let Some(moment) = moment.name("precise_time") {
return match n_date(moment, config) {
Err(s) => Err(s),
Ok(d) => {
let (hour, minute, second, _) = time(moment);
let m = d.and_hms_opt(hour, minute, second).unwrap();
Ok(moment_to_period(m, &Period::Second, config))
}
};
}
return if moment.has("first_time") {
Ok(moment_to_period(first_moment(), &config.period, config))
} else {
Ok((last_moment(), last_moment()))
};
}
fn handle_one_time(
moment: &Match,
config: &Config,
) -> Result<(NaiveDateTime, NaiveDateTime, bool), TimeError> {
let r = if moment.has("specific_day") {
handle_specific_day(moment, config)
} else if let Some(moment) = moment.name("specific_period") {
handle_specific_period(moment, config)
} else if let Some(moment) = moment.name("specific_time") {
handle_specific_time(moment, config)
} else {
relative_moment(moment, config, &config.now, config.default_to_past)
};
match r {
Ok((d1, d2)) => Ok((d1, d2, false)),
Err(e) => Err(e),
}
}
// add time to a date
fn moment_and_time(config: &Config, daytime: Option<&Match>) -> (NaiveDateTime, NaiveDateTime) {
if let Some(daytime) = daytime {
let (hour, minute, second, is_midnight) = time(daytime);
let mut m = config
.now
.with_hour(hour)
.unwrap()
.with_minute(minute)
.unwrap()
.with_second(second)
.unwrap();
if is_midnight {
m = m + Duration::days(1); // midnight is second 0 *of the next day*
}
moment_to_period(m, &Period::Second, config)
} else {
moment_to_period(config.now, &config.period, config)
}
}
fn relative_moment(
m: &Match,
config: &Config,
other_time: &NaiveDateTime,
before: bool, // whether the time found should be before or after the reference time
) -> Result<(NaiveDateTime, NaiveDateTime), TimeError> {
if let Some(a_month_and_a_day) = m.name("a_day_in_month") {
return match month_and_a_day(a_month_and_a_day, config, other_time, before) {
Ok(d) => Ok(moment_and_time(
&config
.now(d.and_hms_opt(0, 0, 0).unwrap())
.period(Period::Day),
m.name("time"),
)),
Err(e) => Err(e),
};
}
if let Some(day) = m.name("a_day") {
let wd = weekday(day.as_str());
let mut delta =
other_time.weekday().num_days_from_sunday() as i64 - wd.num_days_from_sunday() as i64;
if delta <= 0 {
delta += 7;
}
let mut d = other_time.date() - Duration::days(delta);
if !before {
d = d + Duration::days(7);
}
return Ok(moment_and_time(
&config
.now(d.and_hms_opt(0, 0, 0).unwrap())
.period(Period::Day),
m.name("time"),
));
}
if let Some(t) = m.name("time") {
let (hour, minute, second, is_midnight) = time(t);
let mut t = other_time
.with_hour(hour)
.unwrap()
.with_minute(minute)
.unwrap()
.with_second(second)
.unwrap();
if is_midnight {
t = t + Duration::days(1); // midnight is second 0 *of the next day*
}
if before && t > *other_time {
t = t - Duration::days(1);
} else if !before && t < *other_time {
t = t + Duration::days(1);
}
return Ok(moment_to_period(t, &Period::Second, config));
}
if let Some(month) = m.name("a_month") {
let month = a_month(month);
let year = if before {
if month > other_time.month() {
other_time.year() - 1
} else {
other_time.year()
}
} else {
if month < other_time.month() {
other_time.year() + 1
} else {
other_time.year()
}
};
let d = first_moment_of_day(year, month, 1);
let (d1, d2) = moment_to_period(d, &Period::Month, config);
if before && d1 >= *other_time {
return Ok(moment_to_period(
d1.with_year(d1.year() - 1).unwrap(),
&Period::Month,
config,
));
} else if !before && d2 <= *other_time {
return Ok(moment_to_period(
d1.with_year(d1.year() + 1).unwrap(),
&Period::Month,
config,
));
}
return Ok((d1, d2));
}
unreachable!()
}
// for things like "the fifth", "March fifth", "5-6"
fn month_and_a_day(
m: &Match,
config: &Config,
other_time: &NaiveDateTime,
before: bool,
) -> Result<NaiveDate, TimeError> {
if m.has("ordinal_day") {
let mut year = config.now.year();
let mut month = other_time.month();
let day = o_day(m, month);
let wd = if let Some(a_day) = m.name("a_day") {
Some(weekday(a_day.as_str()))
} else {
None
};
// search backwards through the calendar for a possible day
for _ in 0..4 * 7 * 12 {
if let Some(d) = NaiveDate::from_ymd_opt(year, month, day) {
if wd.is_none() || d.weekday() == wd.unwrap() {
return Ok(d);
}
}
if month == 1 {
month = 12;
year -= 1;
} else {
month -= 1;
}
}
return Err(TimeError::ImpossibleDate(format!(
"there is no day {} in the year {}",
m.as_str(),
config.now.year()
)));
}
let (month, day) = if let Some(month) = m.name("n_month") {
let month = n_month(month);
let day = m.name("n_day").unwrap();
(month, n_day(day))
} else {
let month = a_month(m);
let day = if let Some(day) = m.name("n_day") {
n_day(day)
} else {
o_day(m, month)
};
(month, day)
};
let year = if before {
config.now.year()
} else {
if month < other_time.month() {
other_time.year() + 1
} else {
other_time.year()
}
};
match NaiveDate::from_ymd_opt(year, month, day) {
Some(d) => Ok(d),
None => Err(TimeError::ImpossibleDate(format!(
"could not construct date from {} with year {}, month {}, and day {}",
m.as_str(),
year,
month,
day
))),
}
}
fn specific_moment(
m: &Match,
config: &Config,
) -> Result<(NaiveDateTime, NaiveDateTime), TimeError> {
if m.has("specific_day") {
return handle_specific_day(m, config);
}
if let Some(m) = m.name("specific_period") {
return handle_specific_period(m, config);
}
if let Some(m) = m.name("specific_time") {
return handle_specific_time(m, config);
}
unreachable!()
}
fn a_month(m: &Match) -> u32 {
match m.name("a_month").unwrap().as_str()[0..3]
.to_lowercase()
.as_ref()
{
"jan" => 1,
"feb" => 2,
"mar" => 3,
"apr" => 4,
"may" => 5,
"jun" => 6,
"jul" => 7,
"aug" => 8,
"sep" => 9,
"oct" => 10,
"nov" => 11,
"dec" => 12,
_ => unreachable!(),
}
}
// extract hour, minute, and second from time match
// last parameter is basically whether the value returned is for "midnight", which requires special handling
fn time(m: &Match) -> (u32, u32, u32, bool) {
if let Some(m) = m.name("named_time") {
return match m.as_str().chars().nth(0).unwrap() {
'n' | 'N' => (12, 0, 0, false),
_ => (0, 0, 0, true),
};
}
let hour = if let Some(hour_24) = m.name("hour_24") {
let hour = s_to_n(hour_24.name("h24").unwrap().as_str());
if hour == 24 {
0
} else {
hour
}
} else if let Some(hour_12) = m.name("hour_12") {
let mut hour = s_to_n(hour_12.name("h12").unwrap().as_str());
hour = if let Some(am_pm) = m.name("am_pm") {
match am_pm.as_str().chars().nth(0).expect("empty string") {
'a' | 'A' => hour,
_ => hour + 12,
}
} else {
hour
};
if hour == 24 {
0
} else {
hour
}
} else {
unreachable!()
};
if let Some(minute) = m.name("minute") {
let minute = s_to_n(minute.as_str());
if let Some(second) = m.name("second") {
let second = s_to_n(second.as_str());
(hour, minute, second, false)
} else {
(hour, minute, 0, false)
}
} else {
(hour, 0, 0, false)
}
}
fn n_month(m: &Match) -> u32 {
lazy_static! {
static ref MONTH: Regex = Regex::new(r"\A0?(\d{1,2})\z").unwrap();
}
let cap = MONTH.captures(m.name("n_month").unwrap().as_str()).unwrap();
cap[1].parse::<u32>().unwrap()
}
fn year(m: &Match, config: &Config) -> i32 {
let year = m.name("year").unwrap();
if let Some(sy) = year.name("short_year") {
let y = s_to_n(sy.as_str()) as i32;
let this_year = config.now.year() % 100;
if config.default_to_past {
if this_year < y {
// previous century
config.now.year() - this_year - 100 + y
} else {
// this century
config.now.year() - this_year + y
}
} else {
if this_year > y {
// next century
config.now.year() - this_year + 100 + y
} else {
// this century
config.now.year() - this_year + y
}
}
} else if let Some(suffix) = year.name("year_suffix") {
let y = s_to_n(year.name("suffix_year").unwrap().as_str()) as i32;
if suffix.has("bce") {
1 - y // there is no year 0
} else {
y
}
} else {
let y = s_to_n(year.name("n_year").unwrap().as_str()) as i32;
if year.as_str().chars().nth(0).expect("unreachable") == '-' {
-y
} else {
y
}
}
}
fn s_to_n(s: &str) -> u32 {
lazy_static! {
static ref S_TO_N: Regex = Regex::new(r"\A[\D0]*(\d+)\z").unwrap();
}
S_TO_N.captures(s).unwrap()[1].parse::<u32>().unwrap()
}
fn n_day(m: &Match) -> u32 {
m.name("n_day").unwrap().as_str().parse::<u32>().unwrap()
}
fn o_day(m: &Match, month: u32) -> u32 {
let m = m.name("o_day").unwrap();
let s = m.as_str();
if m.has("a_ordinal") {
ordinal(s)
} else if m.has("n_ordinal") {
s[0..s.len() - 2].parse::<u32>().unwrap()
} else {
// roman
match s.chars().nth(0).expect("empty string") {
'n' | 'N' => {
// nones
match month {
3 | 5 | 7 | 10 => 7, // March, May, July, October
_ => 5,
}
}
'i' | 'I' => {
// ides
match month {
3 | 5 | 7 | 10 => 15, // March, May, July, October
_ => 13,
}
}
_ => 1, // kalends
}
}
}
// converts the ordinals up to thirty-first
fn ordinal(s: &str) -> u32 {
match s.chars().nth(0).expect("empty string") {
'f' | 'F' => {
match s.chars().nth(1).expect("too short") {
'i' | 'I' => {
match s.chars().nth(2).expect("too short") {
'r' | 'R' => 1, // first
_ => {
if s.len() == 5 {
5 // fifth
} else {
15 // fifteenth
}
}
}
}
_ => {
if s.len() == 6 {
4 // fourth
} else {
14 // fourteenth
}
}
}
}
's' | 'S' => {
match s.chars().nth(1).expect("too short") {
'e' | 'E' => {
match s.len() {
6 => 2, // second
7 => 7, // seventh
_ => 17, // seventeenth
}
}
_ => {
if s.len() == 5 {
6 // sixth
} else {
16 // sixteenth
}
}
}
}
't' | 'T' => {
match s.chars().nth(1).expect("too short") {
'h' | 'H' => {
match s.chars().nth(4).expect("too short") {
'd' | 'D' => 3, //third
_ => {
match s.chars().nth(5).expect("too short") {
'e' | 'E' => 13, // thirteenth
'i' | 'I' => 30, // thirtieth
_ => 31, // thirty-first
}
}
}
}
'e' | 'E' => 10, // tenth
_ => {
match s.chars().nth(3).expect("too short") {
'l' | 'L' => 12, // twelfth
_ => {
if s.len() == 9 {
20 // twentiety
} else {
20 + ordinal(&s[7..s.len()]) // twenty-first...
}
}
}
}
}
}
'e' | 'E' => {
match s.chars().nth(1).expect("too short") {
'i' | 'I' => {
if s.len() == 6 {
8 // eight
} else {
18 // eighteen
}
}
_ => 11, // eleventh
}
}
_ => {
if s.len() == 5 {
9 // ninth
} else {
19 // nineteenth
}
}
}
}
/// expand a moment to the period containing it
fn moment_to_period(
now: NaiveDateTime,
period: &Period,
config: &Config,
) -> (NaiveDateTime, NaiveDateTime) {
match period {
Period::Year => {
let d1 = first_moment_of_day(now.year(), 1, 1);
let d2 = first_moment_of_day(now.year() + 1, 1, 1);
(d1, d2)
}
Period::Month => {
let d1 = first_moment_of_day(now.year(), now.month(), 1);
let d2 = if now.month() == 12 {
first_moment_of_day(now.year() + 1, 1, 1)
} else {
first_moment_of_day(now.year(), now.month() + 1, 1)
};
(d1, d2)
}
Period::Week => {
let offset = if config.monday_starts_week {
now.weekday().num_days_from_monday()
} else {
now.weekday().num_days_from_sunday()
};
let d1 = first_moment_of_day(now.year(), now.month(), now.day())
- Duration::days(offset as i64);
(d1, d1 + Duration::days(7))
}
Period::Day => {
let d1 = first_moment_of_day(now.year(), now.month(), now.day());
(d1, d1 + Duration::days(1))
}
Period::Hour => {
let d1 = precise_moment(now.year(), now.month(), now.day(), now.hour(), 0, 0);
(d1, d1 + Duration::hours(1))
}
Period::Minute => {
let d1 = precise_moment(
now.year(),
now.month(),
now.day(),
now.hour(),
now.minute(),
0,
);
(d1, d1 + Duration::minutes(1))
}
Period::Second => {
let d1 = precise_moment(
now.year(),
now.month(),
now.day(),
now.hour(),
now.minute(),
now.second(),
);
(d1, d1 + Duration::seconds(1))
}
Period::PayPeriod => {
if let Some(pps) = config.pay_period_start {
// find the current pay period start
let offset = now.num_days_from_ce() - pps.num_days_from_ce();
let ppl = config.pay_period_length as i32;
let mut offset = (offset % ppl) as i64;
if offset < 0 {
offset += config.pay_period_length as i64;
}
let d1 = (now.date() - Duration::days(offset))
.and_hms_opt(0, 0, 0)
.unwrap();
(d1, d1 + Duration::days(config.pay_period_length as i64))
} else {
unreachable!()
}
}
}
}
#[derive(Debug, Clone)]
enum Period {
Year,
Month,
Week,
Day,
Hour,
Minute,
Second,
PayPeriod,
}
fn weekday(s: &str) -> Weekday {
match s.chars().nth(0).expect("empty string") {
'm' | 'M' => Weekday::Mon,
't' | 'T' => {
if s.len() == 1 {
Weekday::Tue
} else {
match s.chars().nth(1).unwrap() {
'u' | 'U' => Weekday::Tue,
'h' | 'H' => Weekday::Thu,
_ => unreachable!(),
}
}
}
'w' | 'W' => Weekday::Wed,
'H' => Weekday::Thu,
'F' | 'f' => Weekday::Fri,
'S' | 's' => {
if s.len() == 1 {
Weekday::Sat
} else {
match s.chars().nth(1).unwrap() {
'a' | 'A' => Weekday::Sat,
'u' | 'U' => Weekday::Sun,
_ => unreachable!(),
}
}
}
'U' => Weekday::Sun,
_ => unreachable!(),
}
}
// adjust a period relative to another period -- e.g., "one week before June" or "five minutes around 12:00 PM"
fn adjust(d1: NaiveDateTime, d2: NaiveDateTime, m: &Match) -> (NaiveDateTime, NaiveDateTime) {
if let Some(adjustment) = m.name("adjustment") {
let count = count(adjustment.name("count").unwrap()) as i64;
let unit = match adjustment
.name("unit")
.unwrap()
.as_str()
.chars()
.nth(0)
.unwrap()
{
'w' | 'W' => Duration::weeks(count),
'd' | 'D' => Duration::days(count),
'h' | 'H' => Duration::hours(count),
'm' | 'M' => Duration::minutes(count),
_ => Duration::seconds(count),
};
let direction = adjustment.name("direction").unwrap().as_str();
match direction.chars().nth(0).unwrap() {
'b' | 'B' => {
if direction.len() == 6 {
// before
let d = d1 - unit;
(d, d)
} else {
// before and after
(d1 - unit, d1 + unit)
}
}
_ => match direction.chars().nth(1).unwrap() {
'f' | 'F' => {
let d = d2 + unit;
(d, d)
}
_ => {
let d1 = d1 - Duration::milliseconds(unit.num_milliseconds() / 2);
let d2 = d1 + unit;
(d1, d2)
}
},
}
} else {
(d1, d2)
}
}
// for converting a few cardinal numbers and integer expressions
fn count(m: &Match) -> u32 {
let s = m.as_str();
if m.has("a_count") {
// cardinal numbers
match s.chars().nth(0).expect("impossibly short") {
'o' | 'O' => 1,
't' | 'T' => match s.chars().nth(1).expect("impossibly short") {
'w' | 'W' => 2,
'h' | 'H' => 3,
_ => 10,
},
'f' | 'F' => match s.chars().nth(1).expect("impossibly short") {
'o' | 'O' => 4,
_ => 5,
},
's' | 'S' => match s.chars().nth(1).expect("impossibly short") {
'i' | 'I' => 6,
_ => 7,
},
'e' | 'E' => 8,
_ => 9,
}
} else {
s.parse::<u32>().unwrap()
}
}
fn first_moment_of_day(year: i32, month: u32, day: u32) -> NaiveDateTime {
NaiveDate::from_ymd_opt(year, month, day)
.unwrap()
.and_hms_opt(0, 0, 0)
.unwrap()
}
fn precise_moment(
year: i32,
month: u32,
day: u32,
hour: u32,
minute: u32,
second: u32,
) -> NaiveDateTime {
NaiveDate::from_ymd_opt(year, month, day)
.unwrap()
.and_hms_opt(hour, minute, second)
.unwrap()
}