safer-file-handles-text-0.1: Data/Text/IO/SaferFileHandles.hs

{-# LANGUAGE UnicodeSyntax, NoImplicitPrelude, CPP #-}

-------------------------------------------------------------------------------
-- |
-- Module      :  Data.Text.IO.SaferFileHandles
-- Copyright   :  (c) 2010 Bas van Dijk
-- License     :  BSD3 (see the file LICENSE)
-- Maintainer  :  Bas van Dijk <v.dijk.bas@gmail.com>
--
-- This module lifts the 'Text' IO operations into the region monad.
--
-------------------------------------------------------------------------------

module Data.Text.IO.SaferFileHandles
    ( hGetLine
    , hGetContents

    , hPutStr
    , hPutStrLn
    ) where


-------------------------------------------------------------------------------
-- Imports
-------------------------------------------------------------------------------

-- from transformers:
import Control.Monad.IO.Class ( MonadIO )

-- from text:
import Data.Text ( Text )

#ifdef __HADDOCK__
import qualified Data.Text.IO as T ( hGetLine
                                   , hGetContents

                                   , hPutStr
                                   , hPutStrLn
                                   )
#endif

-- from explicit-iomodes-text:
import qualified Data.Text.IO.ExplicitIOModes as E ( hGetLine
                                                   , hGetContents

                                                   , hPutStr
                                                   , hPutStrLn
                                                   )
-- from regions:
import Control.Monad.Trans.Region ( ParentOf )

-- from safer-file-handles:
import System.IO.SaferFileHandles ( RegionalFileHandle
                                  , ReadModes, WriteModes
                                  )
import System.IO.SaferFileHandles.Unsafe ( wrap, wrap2 )


-------------------------------------------------------------------------------
-- Text I/O with regional file handles
-------------------------------------------------------------------------------

-- | Wraps: @Data.Text.IO.'T.hGetLine'@.
hGetLine ∷ (pr `ParentOf` cr, MonadIO cr, ReadModes ioMode)
         ⇒ RegionalFileHandle ioMode pr → cr Text
hGetLine = wrap E.hGetLine

-- | Wraps: @Data.Text.IO.'T.hGetContents'@.
hGetContents ∷ (pr `ParentOf` cr, MonadIO cr, ReadModes ioMode)
             ⇒ RegionalFileHandle ioMode pr → cr Text
hGetContents = wrap E.hGetContents


-- | Wraps: @Data.Text.IO.'T.hPutStr'@.
hPutStr ∷ (pr `ParentOf` cr, MonadIO cr, WriteModes ioMode)
        ⇒ RegionalFileHandle ioMode pr → Text → cr ()
hPutStr = wrap2 E.hPutStr

-- | Wraps: @Data.Text.IO.'T.hPutStrLn'@.
hPutStrLn ∷ (pr `ParentOf` cr, MonadIO cr, WriteModes ioMode)
          ⇒ RegionalFileHandle ioMode pr → Text → cr ()
hPutStrLn = wrap2 E.hPutStrLn


-- The End ---------------------------------------------------------------------