src/Pure/General/date.scala
author wenzelm
Mon, 11 Sep 2023 19:30:48 +0200
changeset 78659 b5f3d1051b13
parent 77163 7ceed24c88dc
child 79817 7308e402451f
permissions -rw-r--r--
tuned;
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     1
/*  Title:      Pure/General/date.scala
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     2
    Author:     Makarius
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     3
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     4
Date and time, with time zone.
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     5
*/
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     6
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     7
package isabelle
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     8
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
     9
64096
5edeb60a7ec5 more flexible date formats;
wenzelm
parents: 64094
diff changeset
    10
import java.util.Locale
74943
afd8cb7b2be1 tuned imports;
wenzelm
parents: 74925
diff changeset
    11
import java.time.{Instant, ZonedDateTime, LocalTime, ZoneId}
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    12
import java.time.format.{DateTimeFormatter, DateTimeParseException}
64059
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    13
import java.time.temporal.TemporalAccessor
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    14
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    15
import scala.annotation.tailrec
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    16
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    17
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    18
object Date {
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    19
  /* format */
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    20
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    21
  object Format {
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    22
    def make(fmts: List[DateTimeFormatter], tune: String => String = s => s): Format = {
73120
c3589f2dff31 more informative errors: simplify diagnosis of spurious failures reported by users;
wenzelm
parents: 71601
diff changeset
    23
      require(fmts.nonEmpty, "no date formats")
64059
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    24
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    25
      new Format {
64059
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    26
        def apply(date: Date): String = fmts.head.format(date.rep)
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    27
        def parse(str: String): Date =
64098
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    28
          new Date(ZonedDateTime.from(Formatter.try_variants(fmts, tune(str))))
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    29
      }
64059
365d367d2b45 more flexibile formatting;
wenzelm
parents: 64057
diff changeset
    30
    }
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    31
64098
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    32
    def apply(pats: String*): Format =
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69980
diff changeset
    33
      make(pats.toList.map(Date.Formatter.pattern))
64060
f3fa0bb3f666 tuned signature;
wenzelm
parents: 64059
diff changeset
    34
64098
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    35
    val default: Format = Format("dd-MMM-uuuu HH:mm:ss xx")
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    36
    val date: Format = Format("dd-MMM-uuuu")
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    37
    val time: Format = Format("HH:mm:ss")
73649
029de1598940 tuned signature;
wenzelm
parents: 73120
diff changeset
    38
    val alt_date: Format = Format("uuuuMMdd")
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    39
  }
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    40
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    41
  abstract class Format private {
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    42
    def apply(date: Date): String
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    43
    def parse(str: String): Date
64098
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    44
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    45
    def unapply(str: String): Option[Date] =
64098
099518e8af2c misc tuning and clarification;
wenzelm
parents: 64096
diff changeset
    46
      try { Some(parse(str)) } catch { case _: DateTimeParseException => None }
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
    47
  }
64057
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    48
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    49
  object Formatter {
64099
wenzelm
parents: 64098
diff changeset
    50
    def pattern(pat: String): DateTimeFormatter = DateTimeFormatter.ofPattern(pat)
wenzelm
parents: 64098
diff changeset
    51
wenzelm
parents: 64098
diff changeset
    52
    def variants(pats: List[String], locs: List[Locale] = Nil): List[DateTimeFormatter] =
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    53
      pats.flatMap { pat =>
64099
wenzelm
parents: 64098
diff changeset
    54
        val fmt = pattern(pat)
71601
97ccf48c2f0c misc tuning based on hints by IntelliJ IDEA;
wenzelm
parents: 69980
diff changeset
    55
        if (locs.isEmpty) List(fmt) else locs.map(fmt.withLocale)
75394
42267c650205 tuned formatting;
wenzelm
parents: 75393
diff changeset
    56
      }
64099
wenzelm
parents: 64098
diff changeset
    57
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    58
    @tailrec def try_variants(
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    59
      fmts: List[DateTimeFormatter],
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    60
      str: String,
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    61
      last_exn: Option[DateTimeParseException] = None
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    62
    ): TemporalAccessor = {
64099
wenzelm
parents: 64098
diff changeset
    63
      fmts match {
wenzelm
parents: 64098
diff changeset
    64
        case Nil =>
wenzelm
parents: 64098
diff changeset
    65
          throw last_exn.getOrElse(new DateTimeParseException("Failed to parse date", str, 0))
wenzelm
parents: 64098
diff changeset
    66
        case fmt :: rest =>
wenzelm
parents: 64098
diff changeset
    67
          try { ZonedDateTime.from(fmt.parse(str)) }
wenzelm
parents: 64098
diff changeset
    68
          catch { case exn: DateTimeParseException => try_variants(rest, str, Some(exn)) }
wenzelm
parents: 64098
diff changeset
    69
      }
wenzelm
parents: 64098
diff changeset
    70
    }
wenzelm
parents: 64098
diff changeset
    71
  }
wenzelm
parents: 64098
diff changeset
    72
64057
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    73
74925
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    74
  /* ordering */
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    75
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    76
  object Ordering extends scala.math.Ordering[Date] {
74925
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    77
    def compare(date1: Date, date2: Date): Int =
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    78
      date1.instant.compareTo(date2.instant)
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    79
  }
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    80
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
    81
  object Rev_Ordering extends scala.math.Ordering[Date] {
74925
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    82
    def compare(date1: Date, date2: Date): Int =
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    83
      date2.instant.compareTo(date1.instant)
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    84
  }
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    85
4bc306cb2832 more data integrity: name vs. address;
wenzelm
parents: 73649
diff changeset
    86
64057
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    87
  /* date operations */
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    88
69980
f2e3adfd916f tuned signature;
wenzelm
parents: 65733
diff changeset
    89
  def timezone_utc: ZoneId = ZoneId.of("UTC")
f2e3adfd916f tuned signature;
wenzelm
parents: 65733
diff changeset
    90
  def timezone_berlin: ZoneId = ZoneId.of("Europe/Berlin")
f2e3adfd916f tuned signature;
wenzelm
parents: 65733
diff changeset
    91
64057
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    92
  def timezone(): ZoneId = ZoneId.systemDefault
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    93
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    94
  def now(zone: ZoneId = timezone()): Date = new Date(ZonedDateTime.now(zone))
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
    95
65014
97a622d01609 support for type Date;
wenzelm
parents: 64117
diff changeset
    96
  def instant(t: Instant, zone: ZoneId = timezone()): Date =
97a622d01609 support for type Date;
wenzelm
parents: 64117
diff changeset
    97
    new Date(ZonedDateTime.ofInstant(t, zone))
97a622d01609 support for type Date;
wenzelm
parents: 64117
diff changeset
    98
97a622d01609 support for type Date;
wenzelm
parents: 64117
diff changeset
    99
  def apply(t: Time, zone: ZoneId = timezone()): Date = instant(t.instant, zone)
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
   100
}
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
   101
75393
87ebf5a50283 clarified formatting, for the sake of scala3;
wenzelm
parents: 74943
diff changeset
   102
sealed case class Date(rep: ZonedDateTime) {
64117
c2b41b073d8a build_history log files with formal meta info;
wenzelm
parents: 64111
diff changeset
   103
  def midnight: Date =
c2b41b073d8a build_history log files with formal meta info;
wenzelm
parents: 64111
diff changeset
   104
    new Date(ZonedDateTime.of(rep.toLocalDate, LocalTime.MIDNIGHT, rep.getZone))
c2b41b073d8a build_history log files with formal meta info;
wenzelm
parents: 64111
diff changeset
   105
64111
b2290b9d0175 prefer local timezone;
wenzelm
parents: 64100
diff changeset
   106
  def to(zone: ZoneId): Date = new Date(rep.withZoneSameInstant(zone))
b2290b9d0175 prefer local timezone;
wenzelm
parents: 64100
diff changeset
   107
65733
wenzelm
parents: 65021
diff changeset
   108
  def unix_epoch: Long = rep.toEpochSecond
77163
7ceed24c88dc alternate AFP tests on lrzcloud2, to fit better into one day;
wenzelm
parents: 75394
diff changeset
   109
  def unix_epoch_day: Long = rep.toLocalDate.toEpochDay
65014
97a622d01609 support for type Date;
wenzelm
parents: 64117
diff changeset
   110
  def instant: Instant = Instant.from(rep)
97a622d01609 support for type Date;
wenzelm
parents: 64117
diff changeset
   111
  def time: Time = Time.instant(instant)
64057
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
   112
  def timezone: ZoneId = rep.getZone
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
   113
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
   114
  def format(fmt: Date.Format = Date.Format.default): String = fmt(this)
fd73e0019605 more operations;
wenzelm
parents: 64056
diff changeset
   115
  override def toString: String = format()
64056
0edc966bee55 more date and time operations from Java 8;
wenzelm
parents:
diff changeset
   116
}