Require.File

This module contains functions for file handling. The names of the functions and data types are chosen in a way to suggest a qualified import.

import qualified Require.File as File

Documentation

newtype Name

Wraps the name of a file as given by the user. Usually this corresponds to the file's path.

Constructors

Name Text

data Input

Associates a file's contents with the path from which it was read.

Constructors

Input

Fields

• inputName :: Name
• inputContent :: Text

newtype LineNumber

A type-safe wrapper for line numbers.

Constructors

LineNumber Int

Instances

Enum LineNumber

Defined in Require.File

Methods

succ :: LineNumber -> LineNumber

pred :: LineNumber -> LineNumber

toEnum :: Int -> LineNumber

fromEnum :: LineNumber -> Int

enumFrom :: LineNumber -> [LineNumber]

enumFromThen :: LineNumber -> LineNumber -> [LineNumber]

enumFromTo :: LineNumber -> LineNumber -> [LineNumber]

enumFromThenTo :: LineNumber -> LineNumber -> LineNumber -> [LineNumber]

data LineTag

Identifies a specific line in a file.

Constructors

LineTag !Name !LineNumber

initialLineTag :: Input -> LineTag

Returns the LineTag referencing the first line in a given FileInput.

Note that the tag's line number is 1-based, which fits well with how GHC understands {-# LINE ... #-} pragmas.

advanceLineTag :: LineTag -> LineTag

Returns a line tag from the same file but referencing the next line.

read :: Name -> IO Input

read name reads the contents of the file identified by name.

writeLines :: Name -> [Text] -> IO ()

write name lines writes all every line in lines to the file identified by name and appends a newline.

inputLines :: Input -> [(LineTag, Text)]

Splits the input into lines and annotates each with a LineTag.

nameToPath :: Name -> FilePath

Returns the FilePath corresponding a given Name.