GHCup.Utils.File

This module handles file and executable handling. Some of these functions use sophisticated logging.

Documentation

data ProcessError

Constructors

NonZeroExit Int ByteString [ByteString]

PTerminated ByteString [ByteString]

PStopped ByteString [ByteString]

NoSuchPid ByteString [ByteString]

Instances

Show ProcessError

Defined in GHCup.Utils.File

Methods

showsPrec :: Int -> ProcessError -> ShowS

show :: ProcessError -> String

showList :: [ProcessError] -> ShowS

Pretty ProcessError

Defined in GHCup.Utils.File

Methods

pPrintPrec :: PrettyLevel -> Rational -> ProcessError -> Doc

pPrint :: ProcessError -> Doc

pPrintList :: PrettyLevel -> [ProcessError] -> Doc

data CapturedProcess

Constructors

CapturedProcess

Fields

• _exitCode :: ExitCode
• _stdOut :: ByteString
• _stdErr :: ByteString

Instances

Eq CapturedProcess

Defined in GHCup.Utils.File

Methods

(==) :: CapturedProcess -> CapturedProcess -> Bool

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

Show CapturedProcess

Defined in GHCup.Utils.File

Methods

showsPrec :: Int -> CapturedProcess -> ShowS

show :: CapturedProcess -> String

showList :: [CapturedProcess] -> ShowS

stdOut :: Lens' CapturedProcess ByteString

stdErr :: Lens' CapturedProcess ByteString

exitCode :: Lens' CapturedProcess ExitCode

findExecutable :: Path Rel -> IO (Maybe (Path Abs))

Find the given executable by searching all *absolute* PATH components. Relative paths in PATH are ignored.

This shouldn't throw IO exceptions, unless getting the environment variable PATH does.

executeOut

Arguments

:: Path b

command as filename, e.g. ls

-> [ByteString]

arguments to the command

-> Maybe (Path Abs)

chdir to this path

-> IO CapturedProcess

Execute the given command and collect the stdout, stderr and the exit code. The command is run in a subprocess.

execLogged

Arguments

:: (MonadReader AppState m, MonadIO m, MonadThrow m)

=> ByteString

thing to execute

-> Bool

whether to search PATH for the thing

-> [ByteString]

args for the thing

-> Path Rel

log filename

-> Maybe (Path Abs)

optionally chdir into this

-> Maybe [(ByteString, ByteString)]

optional environment

-> m (Either ProcessError ())

captureOutStreams

Arguments

:: IO a

the action to execute in a subprocess

-> IO CapturedProcess

Capture the stdout and stderr of the given action, which is run in a subprocess. Stdin is closed. You might want to race this to make sure it terminates.

actionWithPipes :: ((Fd, Fd) -> IO b) -> IO b

cleanup :: [Fd] -> IO ()

createRegularFileFd :: FileMode -> Path b -> IO Fd

Create a new regular file in write-only mode. The file must not exist.

exec

Arguments

:: ByteString

thing to execute

-> Bool

whether to search PATH for the thing

-> [ByteString]

args for the thing

-> Maybe (Path Abs)

optionally chdir into this

-> Maybe [(ByteString, ByteString)]

optional environment

-> IO (Either ProcessError ())

Thin wrapper around executeFile.

toProcessError :: ByteString -> [ByteString] -> Maybe ProcessStatus -> Either ProcessError ()

searchPath :: [Path Abs] -> Path Rel -> IO (Maybe (Path Abs))

Search for a file in the search paths.

Catches PermissionDenied and NoSuchThing and returns Nothing.

isShadowed :: Path Abs -> IO (Maybe (Path Abs))

Check wether a binary is shadowed by another one that comes before it in PATH. Returns the path to said binary, if any.

isInPath :: Path Abs -> IO Bool

Check whether the binary is in PATH. This returns only True if the directory containing the binary is part of PATH.

findFiles :: Path Abs -> Regex -> IO [Path Rel]

findFiles' :: Path Abs -> Parsec Void Text () -> IO [Path Rel]

isBrokenSymlink :: Path Abs -> IO Bool

chmod_755 :: (MonadLogger m, MonadIO m) => Path a -> m ()