CalendarDiffTime.hs

{-# LANGUAGE CPP #-}
{-# LANGUAGE Safe #-}

module Data.Time.LocalTime.Internal.CalendarDiffTime where

import Control.DeepSeq
import Data.Data
import Data.Time.Calendar.CalendarDiffDays
import Data.Time.Calendar.Gregorian
import Data.Time.Clock.Internal.NominalDiffTime
import Data.Time.Clock.Internal.UTCDiff
import Data.Time.Clock.Internal.UTCTime
import GHC.Generics
#if __GLASGOW_HASKELL__ >= 914
import qualified Language.Haskell.TH.Lift as TH
#else
import qualified Language.Haskell.TH.Syntax as TH
#endif

data CalendarDiffTime = CalendarDiffTime
    { ctMonths :: Integer
    , ctTime :: NominalDiffTime
    }
    deriving (Eq, Typeable, Data, Generic, TH.Lift)

instance NFData CalendarDiffTime where
    rnf (CalendarDiffTime m t) = rnf m `seq` rnf t `seq` ()

-- | Additive
instance Semigroup CalendarDiffTime where
    CalendarDiffTime m1 d1 <> CalendarDiffTime m2 d2 = CalendarDiffTime (m1 + m2) (d1 + d2)

-- | Additive
instance Monoid CalendarDiffTime where
    mempty = CalendarDiffTime 0 0
    mappend = (<>)

calendarTimeDays :: CalendarDiffDays -> CalendarDiffTime
calendarTimeDays (CalendarDiffDays m d) = CalendarDiffTime m $ fromInteger d * nominalDay

calendarTimeTime :: NominalDiffTime -> CalendarDiffTime
calendarTimeTime dt = CalendarDiffTime 0 dt

-- | Scale by a factor. Note that @scaleCalendarDiffTime (-1)@ will not perfectly invert a duration, due to variable month lengths.
scaleCalendarDiffTime :: Integer -> CalendarDiffTime -> CalendarDiffTime
scaleCalendarDiffTime k (CalendarDiffTime m d) = CalendarDiffTime (k * m) (fromInteger k * d)

addUTCDurationClip :: CalendarDiffTime -> UTCTime -> UTCTime
addUTCDurationClip (CalendarDiffTime m d) (UTCTime day t) =
    addUTCTime d $ UTCTime (addGregorianMonthsClip m day) t

addUTCDurationRollOver :: CalendarDiffTime -> UTCTime -> UTCTime
addUTCDurationRollOver (CalendarDiffTime m d) (UTCTime day t) =
    addUTCTime d $ UTCTime (addGregorianMonthsRollOver m day) t

diffUTCDurationClip :: UTCTime -> UTCTime -> CalendarDiffTime
diffUTCDurationClip (UTCTime day1 t1) (UTCTime day2 t2) =
    let
        CalendarDiffTime m t = calendarTimeDays $ diffGregorianDurationClip day1 day2
    in
        CalendarDiffTime m $ t + realToFrac (t1 - t2)

diffUTCDurationRollOver :: UTCTime -> UTCTime -> CalendarDiffTime
diffUTCDurationRollOver (UTCTime day1 t1) (UTCTime day2 t2) =
    let
        CalendarDiffTime m t = calendarTimeDays $ diffGregorianDurationRollOver day1 day2
    in
        CalendarDiffTime m $ t + realToFrac (t1 - t2)