Safe Haskell	Safe-Inferred
Language	Haskell2010

Drasil.FileHandling.Legacy

Synopsis

blank :: Doc
indent :: Doc -> Doc
indentList :: [Doc] -> Doc
contSep :: Separator
listToDoc :: [String] -> Doc
type Separator = Doc
createDirIfMissing :: Bool -> FilePath -> IO ()
createFile :: FilePath -> String -> IO ()
data RelativeFile
relativeFile :: String -> RelativeFile
relFileToStr :: RelativeFile -> String

Documentation

blank :: Doc Source #

Creates a blank document with no text.

indent :: Doc -> Doc Source #

Indents a document (by 4 spaces).

indentList :: [Doc] -> Doc Source #

Indents a list of Docs and combines into one Doc.

contSep :: Separator Source #

listToDoc :: [String] -> Doc Source #

Merge a list of Strings into a Doc format:

e.g., `listToDoc [a,b,c,...] ~= a, b, c, ...`

type Separator = Doc Source #

Separates document sections.

createDirIfMissing :: Bool -> FilePath -> IO () Source #

Creates a directory if it does not already exist (optionally with all missing parent directories).

Implementation uses doesPathExist to check if the directory exists rather than createDirectoryIfMissing True, which would create the directory regardless of whether it exists or not, potentially leading to an error that appears in `make debug` logs.

createFile :: FilePath -> String -> IO () Source #

Write a String to a given FilePath.

data RelativeFile Source #

A valid, relative file path with an extension in canonical form.

Instances

Instances details

Eq RelativeFile Source #
Instance details Defined in Drasil.FileHandling.Legacy.FilePath Methods (==) :: RelativeFile -> RelativeFile -> Bool # (/=) :: RelativeFile -> RelativeFile -> Bool #

relativeFile :: String -> RelativeFile Source #

Create a RelativeFile given a String that must be in canonical form, be a valid file path, contain a file extension, and be relative (not absolute); otherwise, an error is raised.

relFileToStr :: RelativeFile -> String Source #