-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | Time utilities
--   
--   Please see the README on GitHub at
--   <a>https://github.com/jlamothe/timeutils#readme</a>
@package timeutils
@version 0.1.0


-- | timeutils
--   
--   Copyright (C) 2019 Jonathan Lamothe <a>jlamothe1980@gmail.com</a>
--   
--   This program is free software: you can redistribute it and/or modify
--   it under the terms of the GNU General Public License as published by
--   the Free Software Foundation, either version 3 of the License, or (at
--   your option) any later version.
--   
--   This program is distributed in the hope that it will be useful, but
--   WITHOUT ANY WARRANTY; without even the implied warranty of
--   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
--   General Public License for more details.
--   
--   You should have received a copy of the GNU General Public License
--   along with this program. If not, see
--   <a>https://www.gnu.org/licenses/</a>.
module Data.Time.Utils

-- | A type that keeps track of the passage of time
data Timer
Timer :: NominalDiffTime -> Maybe UTCTime -> Timer

-- | The amount of time previously logged
[timerOffset] :: Timer -> NominalDiffTime

-- | The time the <a>Timer</a> was last started (<a>Nothing</a> if not
--   currently running)
[timerStartTime] :: Timer -> Maybe UTCTime

-- | Represents a <a>NominalDiffTime</a> broken down into days, hours,
--   minutes, seconds and milliseconds
data TimeParts
TimeParts :: Int -> Int -> Int -> Int -> Int -> TimeParts

-- | The number of days
[tpDays] :: TimeParts -> Int

-- | The number of hours
[tpHours] :: TimeParts -> Int

-- | The number of minutes
[tpMinutes] :: TimeParts -> Int

-- | The number of seconds
[tpSeconds] :: TimeParts -> Int

-- | The number of milliseconds
[tpMillis] :: TimeParts -> Int

-- | Represents a timed countdown
data Countdown
Countdown :: NominalDiffTime -> Timer -> Countdown

-- | The length of time
[countdownLength] :: Countdown -> NominalDiffTime

-- | The timer which runs the <a>Countdown</a>
[countdownTimer] :: Countdown -> Timer

-- | Tracks the time of multiple laps
data Stopwatch
Stopwatch :: Timer -> [NominalDiffTime] -> Stopwatch

-- | The <a>Timer</a> for the current lap
[stopwatchTimer] :: Stopwatch -> Timer

-- | The times of previous laps (most recent first)
[stopwatchLaps] :: Stopwatch -> [NominalDiffTime]

-- | Lens for the <a>timerOffset</a> attribute
timerOffsetL :: Lens' Timer NominalDiffTime

-- | Lens for the <a>timerStartTime</a> attribute
timerStartTimeL :: Lens' Timer (Maybe UTCTime)

-- | Lens for the <a>tpDays</a> attribute
tpDaysL :: Lens' TimeParts Int

-- | Lens for the <a>tpHours</a> attribute
tpHoursL :: Lens' TimeParts Int

-- | Lens for the <a>tpMinutes</a> attribute
tpMinutesL :: Lens' TimeParts Int

-- | Lens for the <a>tpSeconds</a> attribute
tpSecondsL :: Lens' TimeParts Int

-- | Lens for the <a>tpMillis</a> attribute
tpMillisL :: Lens' TimeParts Int

-- | Lens for the <a>countdownLength</a> attribute
countdownLengthL :: Lens' Countdown NominalDiffTime

-- | Lens for the <a>countdownTimer</a> attribute
countdownTimerL :: Lens' Countdown Timer

-- | Lens for the <a>stopwatchTimer</a> attribute
stopwatchTimerL :: Lens' Stopwatch Timer

-- | Lens for the <a>stopwatchLaps</a> attribute
stopwatchLapsL :: Lens' Stopwatch [NominalDiffTime]

-- | New instance of a <a>Timer</a>
newTimer :: Timer

-- | New instance of a <a>TimeParts</a> value
newTimeParts :: TimeParts

-- | New instance of a <a>Countdown</a>
newCountdown :: NominalDiffTime -> Countdown

-- | New instance of a stopwatch
newStopwatch :: Stopwatch

-- | Starts a <a>Timer</a>
startTimer :: Timer -> IO Timer

-- | Stops a <a>Timer</a>
stopTimer :: Timer -> IO Timer

-- | Calculates the amount of time elapsed on a <a>Timer</a>
timeElapsed :: Timer -> IO NominalDiffTime

-- | Starts a <a>Countdown</a>
startCountdown :: Countdown -> IO Countdown

-- | Stops a <a>Countdown</a>
stopCountdown :: Countdown -> IO Countdown

-- | Calculates the amount of time remaining in a <a>Countdown</a>
timeRemaining :: Countdown -> IO NominalDiffTime

-- | Determines whether or not a <a>Countdown</a> has completed.
countdownIsCompleted :: Countdown -> IO Bool

-- | Starts a <a>Stopwatch</a>
startStopwatch :: Stopwatch -> IO Stopwatch

-- | Stops a <a>Stopwatch</a>
stopStopwatch :: Stopwatch -> IO Stopwatch

-- | Starts a new lap
newLap :: Stopwatch -> IO Stopwatch

-- | Returns the time of the current lap from a <a>Stopwatch</a>
currentLap :: Stopwatch -> IO NominalDiffTime

-- | Returns the lap times for a <a>Stopwatch</a>
allLaps :: Stopwatch -> IO [NominalDiffTime]

-- | Calculates the total run time of a <a>Stopwatch</a>
totalStopwatchTime :: Stopwatch -> IO NominalDiffTime

-- | Converts a <a>NominalDiffTime</a> to a <a>TimeParts</a> value
decomposeNDT :: NominalDiffTime -> TimeParts

-- | Converts a <a>TimeParts</a> value to a <a>NominalDiffTime</a>
composeNDT :: TimeParts -> NominalDiffTime

-- | Converts a <a>NominalDiffTime</a> into a more human-readable format
humanNDT :: NominalDiffTime -> String

-- | Determines whether or not a <a>Timer</a> is running
timerIsRunning :: Timer -> Bool

-- | Determines whether or not a <a>Timer</a> has been started (even if it
--   is currently stopped)
timerIsStarted :: Timer -> Bool

-- | Starts a <a>Timer</a> from a given time
startTimerAt :: UTCTime -> Timer -> Timer

-- | Stops a <a>Timer</a> from a given time
stopTimerAt :: UTCTime -> Timer -> Timer

-- | Calculates the amount of time elapsed on a <a>Timer</a> from a given
--   time
timeElapsedAt :: UTCTime -> Timer -> NominalDiffTime

-- | Determines whether or not a <a>Countdown</a> is running
countdownIsRunning :: Countdown -> Bool

-- | Determines whether or not a <a>Countdown</a> has been started (even if
--   subsequently stopped)
countdownIsStarted :: Countdown -> Bool

-- | Starts a <a>Countdown</a> using a given time
startCountdownAt :: UTCTime -> Countdown -> Countdown

-- | Stops a <a>Countdown</a> using a given time
stopCountdownAt :: UTCTime -> Countdown -> Countdown

-- | Calculates the amount of time remaining in a <a>Countdown</a> at a
--   given time
timeRemainingAt :: UTCTime -> Countdown -> NominalDiffTime

-- | Determines if a <a>Countdown</a> is completed at a given time
countdownIsCompletedAt :: UTCTime -> Countdown -> Bool

-- | Determines whether or not a <a>Stopwatch</a> is running
stopwatchIsRunning :: Stopwatch -> Bool

-- | Determines whether or not a stopwatch has been started (even if
--   subsequently stopped)
stopwatchIsStarted :: Stopwatch -> Bool

-- | Starts a <a>Stopwatch</a> at a given time
startStopwatchAt :: UTCTime -> Stopwatch -> Stopwatch

-- | Stops a <a>Stopwatch</a> at a given time
stopStopwatchAt :: UTCTime -> Stopwatch -> Stopwatch

-- | Starts a new lap at a given time
newLapAt :: UTCTime -> Stopwatch -> Stopwatch

-- | Determines the length of the current lap given a time
currentLapAt :: UTCTime -> Stopwatch -> NominalDiffTime

-- | Returns the lap times from a <a>Stopwatch</a> given a time
allLapsAt :: UTCTime -> Stopwatch -> [NominalDiffTime]

-- | Calculates the total runtime of a <a>Stopwatch</a> given a time
totalStopwatchTimeAt :: UTCTime -> Stopwatch -> NominalDiffTime
instance GHC.Show.Show Data.Time.Utils.Stopwatch
instance GHC.Classes.Eq Data.Time.Utils.Stopwatch
instance GHC.Show.Show Data.Time.Utils.Countdown
instance GHC.Classes.Eq Data.Time.Utils.Countdown
instance GHC.Show.Show Data.Time.Utils.TimeParts
instance GHC.Classes.Eq Data.Time.Utils.TimeParts
instance GHC.Show.Show Data.Time.Utils.Timer
instance GHC.Classes.Eq Data.Time.Utils.Timer