UHC.Util.FPath

Library for manipulating a more structured version of FilePath. Note: the library should use System.FilePath functionality but does not do so yet.

FPath datatype, FPATH class for overloaded construction

data FPath

File path representation making explicit (possible) directory, base and (possible) suffix

Constructors

FPath

Fields

• fpathMbDir :: !(Maybe FilePath)
• fpathBase :: !String
• fpathMbSuff :: !(Maybe String)

Instances

Eq FPath

Methods

(==) :: FPath -> FPath -> Bool

(/=) :: FPath -> FPath -> Bool

Ord FPath

Methods

compare :: FPath -> FPath -> Ordering

(<) :: FPath -> FPath -> Bool

(<=) :: FPath -> FPath -> Bool

(>) :: FPath -> FPath -> Bool

(>=) :: FPath -> FPath -> Bool

max :: FPath -> FPath -> FPath

min :: FPath -> FPath -> FPath

Show FPath

Methods

showsPrec :: Int -> FPath -> ShowS

show :: FPath -> String

showList :: [FPath] -> ShowS

Generic FPath

Associated Types

type Rep FPath :: * -> *

Methods

from :: FPath -> Rep FPath x

to :: Rep FPath x -> FPath

FPATH FPath

Methods

mkFPath :: FPath -> FPath

type Rep FPath

type Rep FPath = D1 (MetaData "FPath" "UHC.Util.FPath" "uhc-util-0.1.6.7-6t9ue1OogRx64o0dPcpUzP" False) (C1 (MetaCons "FPath" PrefixI True) ((:*:) (S1 (MetaSel (Just Symbol "fpathMbDir") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe FilePath))) ((:*:) (S1 (MetaSel (Just Symbol "fpathBase") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 String)) (S1 (MetaSel (Just Symbol "fpathMbSuff") NoSourceUnpackedness SourceStrict DecidedStrict) (Rec0 (Maybe String))))))

fpathSuff :: FPath -> String

Get suffix, being empty equals the empty String

class FPATH f where

Construct a FPath from some type

Minimal complete definition

mkFPath

Methods

mkFPath :: f -> FPath

Instances

FPATH String

Methods

mkFPath :: String -> FPath

FPATH FPath

Methods

mkFPath :: FPath -> FPath

FPATH Nm

Methods

mkFPath :: Nm -> FPath

class FPathError e

Is error related to FPath

Instances

FPathError String

emptyFPath :: FPath

Empty FPath

Construction, deconstruction, predicates

fpathFromStr :: FilePath -> FPath

Construct FPath from FilePath

mkFPathFromDirsFile :: Show s => [s] -> s -> FPath

fpathToStr :: FPath -> FilePath

Conversion to FilePath

fpathIsEmpty :: FPath -> Bool

Is FPath empty?

fpathSetBase :: String -> FPath -> FPath

Set the base

fpathSetSuff :: String -> FPath -> FPath

Set suffix, empty String removes it

fpathSetDir :: FilePath -> FPath -> FPath

Set directory, empty FilePath removes it

fpathUpdBase :: (String -> String) -> FPath -> FPath

Modify the base

fpathRemoveSuff :: FPath -> FPath

Remove suffix

fpathRemoveDir :: FPath -> FPath

Remove dir

fpathIsAbsolute :: FPath -> Bool

fpathAppendDir :: FPath -> FilePath -> FPath

Append directory (to directory part)

fpathUnAppendDir :: FPath -> FilePath -> FPath

Remove common trailing part of dir. Note: does not check whether it really is a suffix.

fpathPrependDir :: FilePath -> FPath -> FPath

Prepend directory

fpathUnPrependDir :: FilePath -> FPath -> FPath

Remove directory (prefix), using fpathSplitDirBy

fpathSplitDirBy :: FilePath -> FPath -> Maybe (String, String)

Split FPath into given directory (prefix) and remainder, fails if not a prefix

mkTopLevelFPath

Arguments

:: String

suffix

-> FilePath

file name

-> FPath

Make FPath from FilePath, setting the suffix when absent

SearchPath

type SearchPath = [String]

type FileSuffixes = [FileSuffix]

type FileSuffixesWith x = [FileSuffixWith x]

FileSuffix with extra payload

type FileSuffix = Maybe String

type FileSuffixWith x = (Maybe String, x)

FileSuffix with extra payload

mkInitSearchPath :: FPath -> SearchPath

searchPathFromFPath :: FPath -> SearchPath

searchPathFromFPaths :: [FPath] -> SearchPath

searchPathFromString :: String -> [String]

searchFPathFromLoc :: FilePath -> FPath -> [(FilePath, FPath)]

searchLocationsForReadableFilesWith

Arguments

:: (loc -> FPath -> [(loc, FPath, [e])])

get the locations for a name, possibly with errors

-> Bool

stop when first is found

-> [loc]

locations to search

-> FileSuffixesWith s

suffixes to try, with associated info

-> FPath

search for a path

-> IO [(FPath, loc, s, [e])]

Search for file in locations, with possible suffices

searchLocationsForReadableFiles

Arguments

:: (loc -> FPath -> [(loc, FPath, [e])])

get the locations for a name, possibly with errors

-> Bool

stop when first is found

-> [loc]

locations to search

-> FileSuffixes

suffixes to try

-> FPath

search for a path

-> IO [(FPath, loc, [e])]

Search for file in locations, with possible suffices

searchPathForReadableFiles :: Bool -> SearchPath -> FileSuffixes -> FPath -> IO [FPath]

searchPathForReadableFile :: SearchPath -> FileSuffixes -> FPath -> IO (Maybe FPath)

fpathEnsureExists :: FPath -> IO ()

Path as prefix

filePathMkPrefix :: FilePath -> FilePath

Construct a filepath to be a prefix (i.e. ending with / as last char)

filePathUnPrefix :: FilePath -> FilePath

Remove from a filepath a possibly present / as last char

filePathCoalesceSeparator :: FilePath -> FilePath

Remove consecutive occurrences of /

filePathMkAbsolute :: FilePath -> FilePath

Make a filepath an absolute filepath by prefixing with /

filePathUnAbsolute :: FilePath -> FilePath

Make a filepath an relative filepath by removing prefixed /-s

Misc

fpathGetModificationTime :: FPath -> IO UTCTime

fpathDirSep :: String

fpathDirSepChar :: Char

fpathOpenOrStdin :: FPath -> IO (FPath, Handle)

openFPath :: FPath -> IOMode -> Bool -> IO (String, Handle)