ghc/lib/required/Time.lhs

   1 %
   2 % (c) The GRASP/AQUA Project, Glasgow University, 1995-97
   3 %
   4 \section[Time]{Haskell 1.4 Time of Day Library}
   5
   6 The {\em Time} library provides standard functionality for
   7 clock times, including timezone information (i.e, the functionality of
   8 "time.h",  adapted to the Haskell environment), It follows RFC 1129 in
   9 its use of Coordinated Universal Time (UTC).
  10
  11 \begin{code}
  12 {-# OPTIONS -#include "cbits/timezone.h" -#include "cbits/stgio.h"  #-}
  13
  14 module Time
  15        (
  16         CalendarTime(..),
  17         Month,
  18         Day,
  19         CalendarTime(CalendarTime),
  20         TimeDiff(TimeDiff),
  21         ClockTime(..), -- non-standard, lib. report gives this as abstract
  22         getClockTime, addToClockTime, diffClockTimes,
  23         toCalendarTime, toUTCTime, toClockTime,
  24         calendarTimeToString, formatCalendarTime
  25        ) where
  26
  27 import PrelBase
  28 import ST
  29 import IOBase
  30 import ArrBase
  31 import STBase
  32 import ST
  33 import Ix
  34 import Foreign( Addr(..) )
  35 import Char (intToDigit)
  36 import PackedString (unpackPS, packCBytesST)
  37 import Locale
  38
  39 \end{code}
  40
  41 One way to partition and give name to chunks of a year and a week:
  42
  43 \begin{code}
  44 data Month
  45  = January   | February | March    | April
  46  | May       | June     | July     | August
  47  | September | October  | November | December
  48  deriving (Eq, Ord, Enum, Bounded, Ix, Read, Show)
  49
  50 data Day
  51  = Sunday | Monday | Tuesday | Wednesday
  52  | Thursday | Friday | Saturday
  53  deriving (Eq, Ord, Enum, Bounded, Ix, Read, Show)
  54
  55 \end{code}
  56
  57 @ClockTime@ is an abstract type, used for the internal clock time.
  58 Clock times may be compared, converted to strings, or converted to an
  59 external calendar time @CalendarTime@.
  60
  61 \begin{code}
  62 data ClockTime = TOD Integer Integer deriving (Eq, Ord)
  63 \end{code}
  64
  65 When a @ClockTime@ is shown, it is converted to a string of the form
  66 @"Mon Nov 28 21:45:41 GMT 1994"@.
  67
  68 For now, we are restricted to roughly:
  69 Fri Dec 13 20:45:52 1901 through Tue Jan 19 03:14:07 2038, because
  70 we use the C library routines based on 32 bit integers.
  71
  72 \begin{code}
  73 instance Show ClockTime where
  74     showsPrec p (TOD sec@(J# a# s# d#) nsec) = showString $ unsafePerformPrimIO $
  75             allocChars 32               >>= \ buf ->
  76             _ccall_ showTime (I# s#) (ByteArray bottom d#) buf
  77                                         >>= \ str ->
  78             _ccall_ strlen str          >>= \ len ->
  79             packCBytesST len str        >>= \ ps ->
  80             return (unpackPS ps)
  81
  82     showList = showList__ (showsPrec 0)
  83 \end{code}
  84
  85
  86 @CalendarTime@ is a user-readable and manipulable
  87 representation of the internal $ClockTime$ type.  The
  88 numeric fields have the following ranges.
  89
  90 \begin{verbatim}
  91 Value         Range             Comments
  92 -----         -----             --------
  93
  94 year    -maxInt .. maxInt       [Pre-Gregorian dates are inaccurate]
  95 mon           0 .. 11           [Jan = 0, Dec = 11]
  96 day           1 .. 31
  97 hour          0 .. 23
  98 min           0 .. 59
  99 sec           0 .. 61           [Allows for two leap seconds]
 100 picosec       0 .. (10^12)-1    [This could be over-precise?]
 101 wday          0 .. 6            [Sunday = 0, Saturday = 6]
 102 yday          0 .. 365          [364 in non-Leap years]
 103 tz       -43200 .. 43200        [Variation from UTC in seconds]
 104 \end{verbatim}
 105
 106 The {\em tzname} field is the name of the time zone.  The {\em isdst}
 107 field indicates whether Daylight Savings Time would be in effect.
 108
 109 \begin{code}
 110 data CalendarTime
 111  = CalendarTime  {
 112      ctYear    :: Int,
 113      ctMonth   :: Int,
 114      ctDay     :: Int,
 115      ctHour    :: Int,
 116      ctMin     :: Int,
 117      ctSec     :: Int,
 118      ctPicosec :: Integer,
 119      ctWDay    :: Day,
 120      ctYDay    :: Int,
 121      ctTZName  :: String,
 122      ctTZ      :: Int,
 123      ctIsDST   :: Bool
 124  }
 125  deriving (Eq,Ord,Read,Show)
 126
 127 \end{code}
 128
 129 The @TimeDiff@ type records the difference between two clock times in
 130 a user-readable way.
 131
 132 \begin{code}
 133 data TimeDiff
 134  = TimeDiff {
 135      tdYear    :: Int,
 136      tdMonth   :: Int,
 137      tdDay     :: Int,
 138      tdHour    :: Int,
 139      tdMin     :: Int,
 140      tdSec     :: Int,
 141      tdPicosec :: Integer -- not standard
 142    }
 143    deriving (Eq,Ord,Read,Show)
 144 \end{code}
 145
 146 @getClockTime@ returns the current time in its internal representation.
 147
 148 \begin{code}
 149 getClockTime :: IO ClockTime
 150 getClockTime =
 151     malloc1                                         `thenIO_Prim` \ i1 ->
 152     malloc1                                         `thenIO_Prim` \ i2 ->
 153     _ccall_ getClockTime i1 i2                      `thenIO_Prim` \ rc ->
 154     if rc == 0 then
 155         cvtUnsigned i1                              `thenIO_Prim` \ sec ->
 156         cvtUnsigned i2                              `thenIO_Prim` \ nsec ->
 157         return (TOD sec (nsec * 1000))
 158     else
 159         constructErrorAndFail "getClockTime"
 160   where
 161     malloc1 = ST $ \ (S# s#) ->
 162         case newIntArray# 1# s# of
 163           StateAndMutableByteArray# s2# barr# -> (MutableByteArray bottom barr#, S# s2#)
 164
 165     -- The C routine fills in an unsigned word.  We don't have `unsigned2Integer#,'
 166     -- so we freeze the data bits and use them for an MP_INT structure.  Note that
 167     -- zero is still handled specially, although (J# 1# 1# (ptr to 0#)) is probably
 168     -- acceptable to gmp.
 169
 170     cvtUnsigned (MutableByteArray _ arr#) = ST $ \ (S# s#) ->
 171         case readIntArray# arr# 0# s# of
 172           StateAndInt# s2# r# ->
 173             if r# ==# 0# then
 174                 (0, S# s2#)
 175             else
 176                 case unsafeFreezeByteArray# arr# s2# of
 177                   StateAndByteArray# s3# frozen# -> (J# 1# 1# frozen#, S# s3#)
 178
 179 \end{code}
 180
 181 @addToClockTime@ {\em d} {\em t} adds a time difference {\em d} and a
 182 clock time {\em t} to yield a new clock time.  The difference {\em d}
 183 may be either positive or negative.  @[diffClockTimes@ {\em t1} {\em
 184 t2} returns the difference between two clock times {\em t1} and {\em
 185 t2} as a @TimeDiff@.
 186
 187
 188 \begin{code}
 189 addToClockTime  :: TimeDiff  -> ClockTime -> ClockTime
 190 addToClockTime (TimeDiff year mon day hour min sec psec)
 191                (TOD c_sec c_psec) = unsafePerformPrimIO $
 192     allocWords (``sizeof(time_t)'') >>= \ res ->
 193     _ccall_ toClockSec year mon day hour min sec 0 res
 194                                     >>= \ ptr@(A# ptr#) ->
 195     if ptr /= ``NULL'' then
 196        let
 197         diff_sec  = (int2Integer# (indexIntOffAddr# ptr# 0#))
 198         diff_psec = psec
 199        in
 200        return (TOD (c_sec + diff_sec) (c_psec + diff_psec))
 201     else
 202        error "Time.addToClockTime: can't perform conversion of TimeDiff"
 203
 204
 205 diffClockTimes  :: ClockTime -> ClockTime -> TimeDiff
 206 diffClockTimes tod_a tod_b =
 207   let
 208    CalendarTime year_a mon_a day_a hour_a min_a sec_a psec_a _ _ _ _ _ = toCalendarTime tod_a
 209    CalendarTime year_b mon_b day_b hour_b min_b sec_b psec_b _ _ _ _ _ = toCalendarTime tod_b
 210   in
 211   TimeDiff (year_a - year_b)
 212            (mon_a  - mon_b)
 213            (day_a  - day_b)
 214            (hour_a - hour_b)
 215            (min_b  - min_a)
 216            (sec_a  - sec_b)
 217            (psec_a - psec_b)
 218 \end{code}
 219
 220 @toCalendarTime@ {\em t} converts {\em t} to a local time, modified by
 221 the current timezone and daylight savings time settings.  @toUTCTime@
 222 {\em t} converts {\em t} into UTC time.  @toClockTime@ {\em l}
 223 converts {\em l} into the corresponding internal @ClockTime@.  The
 224 {\em wday}, {\em yday}, {\em tzname}, and {\em isdst} fields are
 225 ignored.
 226
 227 \begin{code}
 228 toCalendarTime :: ClockTime -> CalendarTime
 229 toCalendarTime (TOD sec@(J# a# s# d#) psec) = unsafePerformPrimIO $
 230     allocWords (``sizeof(struct tm)''::Int)         >>= \ res ->
 231     allocChars 32                                   >>= \ zoneNm ->
 232     _casm_ ``SETZONE((struct tm *)%0,(char *)%1); '' res zoneNm   >>= \ () ->
 233     _ccall_ toLocalTime (I# s#) (ByteArray bottom d#) res
 234                                                     >>= \ tm ->
 235     if tm == (``NULL''::Addr) then
 236         error "Time.toCalendarTime: out of range"
 237     else
 238         _casm_ ``%r = ((struct tm *)%0)->tm_sec;'' tm   >>= \ sec ->
 239         _casm_ ``%r = ((struct tm *)%0)->tm_min;'' tm   >>= \ min ->
 240         _casm_ ``%r = ((struct tm *)%0)->tm_hour;'' tm  >>= \ hour ->
 241         _casm_ ``%r = ((struct tm *)%0)->tm_mday;'' tm  >>= \ mday ->
 242         _casm_ ``%r = ((struct tm *)%0)->tm_mon;'' tm   >>= \ mon ->
 243         _casm_ ``%r = ((struct tm *)%0)->tm_year;'' tm  >>= \ year ->
 244         _casm_ ``%r = ((struct tm *)%0)->tm_wday;'' tm  >>= \ wday ->
 245         _casm_ ``%r = ((struct tm *)%0)->tm_yday;'' tm  >>= \ yday ->
 246         _casm_ ``%r = ((struct tm *)%0)->tm_isdst;'' tm >>= \ isdst ->
 247         _ccall_ ZONE tm                                 >>= \ zone ->
 248         _ccall_ GMTOFF tm                               >>= \ tz ->
 249         _ccall_ strlen zone                             >>= \ len ->
 250         packCBytesST len zone                           >>= \ tzname ->
 251         returnPrimIO (CalendarTime (1900+year) mon mday hour min sec psec
 252                       (toEnum wday) yday (unpackPS tzname) tz (isdst /= 0))
 253
 254 toUTCTime :: ClockTime -> CalendarTime
 255 toUTCTime  (TOD sec@(J# a# s# d#) psec) = unsafePerformPrimIO (
 256         allocWords (``sizeof(struct tm)''::Int)                     >>= \ res ->
 257         allocChars 32                                               >>= \ zoneNm ->
 258         _casm_ ``SETZONE((struct tm *)%0,(char *)%1); '' res zoneNm >>= \ () ->
 259         _ccall_ toUTCTime (I# s#) (ByteArray bottom d#) res
 260                                                     >>= \ tm ->
 261     if tm == (``NULL''::Addr) then
 262         error "Time.toUTCTime: out of range"
 263     else
 264         _casm_ ``%r = ((struct tm *)%0)->tm_sec;'' tm   >>= \ sec ->
 265         _casm_ ``%r = ((struct tm *)%0)->tm_min;'' tm   >>= \ min ->
 266         _casm_ ``%r = ((struct tm *)%0)->tm_hour;'' tm  >>= \ hour ->
 267         _casm_ ``%r = ((struct tm *)%0)->tm_mday;'' tm  >>= \ mday ->
 268         _casm_ ``%r = ((struct tm *)%0)->tm_mon;'' tm   >>= \ mon ->
 269         _casm_ ``%r = ((struct tm *)%0)->tm_year;'' tm  >>= \ year ->
 270         _casm_ ``%r = ((struct tm *)%0)->tm_wday;'' tm  >>= \ wday ->
 271         _casm_ ``%r = ((struct tm *)%0)->tm_yday;'' tm  >>= \ yday ->
 272         returnPrimIO (CalendarTime (1900+year) mon mday hour min sec psec
 273                       (toEnum wday) yday "UTC" 0 False)
 274     )
 275
 276 toClockTime :: CalendarTime -> ClockTime
 277 toClockTime (CalendarTime year mon mday hour min sec psec wday yday tzname tz isdst) =
 278     if psec < 0 || psec > 999999999999 then
 279         error "Time.toClockTime: picoseconds out of range"
 280     else if tz < -43200 || tz > 43200 then
 281         error "Time.toClockTime: timezone offset out of range"
 282     else
 283         unsafePerformPrimIO (
 284             allocWords (``sizeof(time_t)'') >>= \ res ->
 285             _ccall_ toClockSec year mon mday hour min sec isDst res
 286                                                     >>= \ ptr@(A# ptr#) ->
 287             if ptr /= ``NULL'' then
 288                 returnPrimIO (TOD (int2Integer# (indexIntOffAddr# ptr# 0#)) psec)
 289             else
 290                 error "Time.toClockTime: can't perform conversion"
 291         )
 292     where
 293      isDst = if isdst then (1::Int) else 0
 294
 295 bottom :: (Int,Int)
 296 bottom = error "Time.bottom"
 297
 298
 299 -- (copied from PosixUtil, for now)
 300 -- Allocate a mutable array of characters with no indices.
 301
 302 allocChars :: Int -> ST s (MutableByteArray s ())
 303 allocChars (I# size#) = ST $ \ (S# s#) ->
 304     case newCharArray# size# s# of
 305       StateAndMutableByteArray# s2# barr# -> (MutableByteArray bot barr#, S# s2#)
 306   where
 307     bot = error "Time.allocChars"
 308
 309 -- Allocate a mutable array of words with no indices
 310
 311 allocWords :: Int -> ST s (MutableByteArray s ())
 312 allocWords (I# size#) = ST $ \ (S# s#) ->
 313     case newIntArray# size# s# of
 314       StateAndMutableByteArray# s2# barr# -> (MutableByteArray bot barr#, S# s2#)
 315   where
 316     bot = error "Time.allocWords"
 317
 318 \end{code}
 319
 320 \begin{code}
 321 calendarTimeToString  :: CalendarTime -> String
 322 calendarTimeToString  =  formatCalendarTime defaultTimeLocale "%c"
 323
 324 formatCalendarTime :: TimeLocale -> String -> CalendarTime -> String
 325 formatCalendarTime l fmt ct@(CalendarTime year mon day hour min sec sdec
 326                                            wday yday tzname _ _) =
 327         doFmt fmt
 328   where doFmt ('%':c:cs) = decode c ++ doFmt cs
 329         doFmt (c:cs) = c : doFmt cs
 330         doFmt "" = ""
 331         to12 h = let h' = h `mod` 12 in if h == 0 then 12 else h
 332         decode 'A' = fst (wDays l  !! fromEnum wday)
 333         decode 'a' = snd (wDays l  !! fromEnum wday)
 334         decode 'B' = fst (months l !! fromEnum mon)
 335         decode 'b' = snd (months l !! fromEnum mon)
 336         decode 'h' = snd (months l !! fromEnum mon)
 337         decode 'C' = show2 (year `quot` 100)
 338         decode 'c' = doFmt (dateTimeFmt l)
 339         decode 'D' = doFmt "%m/%d/%y"
 340         decode 'd' = show2 day
 341         decode 'e' = show2' day
 342         decode 'H' = show2 hour
 343         decode 'I' = show2 (to12 hour)
 344         decode 'j' = show3 yday
 345         decode 'k' = show2' hour
 346         decode 'l' = show2' (to12 hour)
 347         decode 'M' = show2 min
 348         decode 'm' = show2 (fromEnum mon+1)
 349         decode 'n' = "\n"
 350         decode 'p' = (if hour < 12 then fst else snd) (amPm l)
 351         decode 'R' = doFmt "%H:%M"
 352         decode 'r' = doFmt (time12Fmt l)
 353         decode 'T' = doFmt "%H:%M:%S"
 354         decode 't' = "\t"
 355         decode 'S' = show2 sec
 356         decode 's' = show2 sec -- Implementation-dependent, sez the lib doc..
 357         decode 'U' = show2 ((yday + 7 - fromEnum wday) `div` 7)
 358         decode 'u' = show (let n = fromEnum wday in
 359                            if n == 0 then 7 else n)
 360         decode 'V' =
 361             let (week, days) =
 362                    (yday + 7 - if fromEnum wday > 0 then
 363                                fromEnum wday - 1 else 6) `divMod` 7
 364             in  show2 (if days >= 4 then
 365                           week+1
 366                        else if week == 0 then 53 else week)
 367
 368         decode 'W' =
 369             show2 ((yday + 7 - if fromEnum wday > 0 then
 370                                fromEnum wday - 1 else 6) `div` 7)
 371         decode 'w' = show (fromEnum wday)
 372         decode 'X' = doFmt (timeFmt l)
 373         decode 'x' = doFmt (dateFmt l)
 374         decode 'Y' = show year
 375         decode 'y' = show2 (year `rem` 100)
 376         decode 'Z' = tzname
 377         decode '%' = "%"
 378         decode c   = [c]
 379
 380 show2, show2', show3 :: Int -> String
 381 show2 x = [intToDigit (x `quot` 10), intToDigit (x `rem` 10)]
 382
 383 show2' x = if x < 10 then [ ' ', intToDigit x] else show2 x
 384
 385 show3 x = intToDigit (x `quot` 100) : show2 (x `rem` 100)
 386 \end{code}