Prelude.hs

{-# LANGUAGE CPP #-}

-- | Those functions and types we can't do without!
module Freckle.App.Prelude
  ( module Prelude

    -- * Commonly imported types
  , Alternative
  , Generic
  , HasCallStack
  , Hashable
  , HashMap
  , HashSet
  , Int64
  , Map
  , MonadIO
  , MonadReader
  , MonadUnliftIO
  , NominalDiffTime
  , NonEmpty
  , PrimMonad
  , ReaderT
  , Set
  , Text
  , UTCTime
  , Vector

    -- * Commonly used functions

    -- ** Lifts
  , lift
  , liftIO

    -- ** 'Text'
  , tshow
  , pack
  , unpack
  , encodeUtf8
  , decodeUtf8

    -- ** 'Maybe'
  , catMaybes
  , fromMaybe
  , isJust
  , isNothing
  , listToMaybe
  , mapMaybe
  , maybeToList

    -- ** Safe alternatives to partial prelude functions (e.g. 'headMay')
  , module SafeAlternatives

    -- ** 'Either'
  , partitionEithers

    -- ** 'Foldable'
  , module Foldable

    -- ** 'Traversable'
  , module Traversable

    -- ** 'Functor'
  , (<$$>)

    -- ** 'Bifunctor'
  , bimap
  , first
  , second

    -- ** 'Applicative'
  , (<|>)
  , liftA2
  , optional

    -- ** 'Monad'
  , (<=<)
  , (>=>)
  , guard
  , join
  , unless
  , void
  , when

    -- ** 'Arrow'
  , (&&&)
  , (***)

    -- ** 'UTCTime'
  , getCurrentTime

    -- * Exceptions
  , throwM
  , throwString
  , fromJustNoteM
  , catch
  , catchJust
  , catches
  , try
  , tryJust
  , impossible
  , ExceptionHandler (..)
  , Exception (displayException)
  , SomeException (..)
  ) where

-- Use 'Prelude' as the starting point, removing common partial functions

import Prelude hiding
  ( cycle
  , foldl1
  , foldr1
  , head
  , init
  , last
#if MIN_VERSION_base(4,18,0)
  , liftA2
#endif
  , maximum
  , minimum
  , read
  , tail
  , (!!)
  )

-- Commonly used types (and their commonly used functions)

import Control.Applicative (Alternative, liftA2, optional, (<|>))
import Control.Monad.IO.Class (liftIO)
import Control.Monad.Primitive (PrimMonad)
import Control.Monad.Reader (MonadReader, ReaderT)
import Data.HashMap.Strict (HashMap)
import Data.HashSet (HashSet)
import Data.Hashable (Hashable)
import Data.Int (Int64)
import Data.List.NonEmpty (NonEmpty)
import Data.Map.Strict (Map)
import Data.Set (Set)
import Data.Text (Text, pack, unpack)
import Data.Time (NominalDiffTime, UTCTime, getCurrentTime)
import Data.Vector (Vector)
import Freckle.App.Exception
import GHC.Generics (Generic)

-- Safe alternatives to prelude functions

import Data.Semigroup.Foldable as SafeAlternatives (fold1, foldMap1)
import Safe as SafeAlternatives
  ( atMay
  , cycleMay
  , headMay
  , initMay
  , lastMay
  , maximumMay
  , minimumMay
  , readMay
  , tailMay
  )

-- Commonly used functions

import Control.Arrow ((&&&), (***))
import Control.Monad (guard, join, unless, void, when, (<=<), (>=>))
import Control.Monad.Trans (lift)
import Data.Bifunctor (bimap, first, second)
import Data.Either (partitionEithers)
import Data.Foldable as Foldable hiding (foldl1, foldr1)
import Data.Maybe
  ( catMaybes
  , fromMaybe
  , isJust
  , isNothing
  , listToMaybe
  , mapMaybe
  , maybeToList
  )
import Data.Text.Encoding (decodeUtf8, encodeUtf8)
import Data.Traversable as Traversable

infixl 4 <$$>
(<$$>) :: (Functor c, Functor d) => (a -> b) -> c (d a) -> c (d b)
f <$$> as = (f <$>) <$> as

-- | 'Show' as 'Text'
tshow :: Show a => a -> Text
tshow = pack . show