GHCup.Prelude.File

Documentation

mergeFileTree

Arguments

:: (MonadMask m, MonadAsync m, MonadReader env m, HasDirs env, HasLog env, MonadCatch m)

=> GHCupPath

source base directory from which to install findFiles

-> InstallDirResolved

destination base dir

-> Tool

-> GHCTargetVersion

-> (FilePath -> FilePath -> m ())

file copy operation

-> Excepts '[MergeFileTreeError] m ()

Merge one file tree to another given a copy operation.

Records every successfully installed file into the destination returned by recordedInstallationFile.

If any copy operation fails, the record file is deleted, as well as the partially installed files.

copyFileE :: (CopyError :< xs, MonadCatch m, MonadIO m) => FilePath -> FilePath -> Bool -> Excepts xs m ()

findFilesDeep :: GHCupPath -> Regex -> IO [FilePath]

getDirectoryContentsRecursive :: (MonadCatch m, MonadAsync m, MonadMask m) => GHCupPath -> SerialT m FilePath

getDirectoryContentsRecursiveBFS :: (MonadCatch m, MonadAsync m, MonadMask m) => GHCupPath -> SerialT m FilePath

getDirectoryContentsRecursiveDFS :: (MonadCatch m, MonadAsync m, MonadMask m) => GHCupPath -> SerialT m FilePath

List all the files in a directory and all subdirectories.

The order places files in sub-directories after all the files in their parent directories. The list is generated lazily so is not well defined if the source directory structure changes before the list is used.

depth first

getDirectoryContentsRecursiveUnsafe :: (MonadCatch m, MonadAsync m, MonadMask m) => FilePath -> SerialT m FilePath

getDirectoryContentsRecursiveBFSUnsafe :: (MonadMask m, MonadIO m, MonadAsync m) => FilePath -> SerialT m FilePath

getDirectoryContentsRecursiveDFSUnsafe :: (MonadMask m, MonadIO m, MonadAsync m) => FilePath -> SerialT m FilePath

recordedInstallationFile :: (MonadReader env m, HasDirs env) => Tool -> GHCTargetVersion -> m FilePath

module GHCup.Prelude.File.Search

chmod_755 :: MonadIO m => FilePath -> m ()

isBrokenSymlink :: FilePath -> IO Bool

Checks whether the binary is a broken link.

copyFile

Arguments

:: FilePath

source file

-> FilePath

destination file

-> Bool

fail if file exists

-> IO ()

deleteFile :: FilePath -> IO ()

Deletes the given file. Raises eISDIR if run on a directory. Does not follow symbolic links.

Throws:

• InappropriateType for wrong file type (directory)
• NoSuchThing if the file does not exist
• PermissionDenied if the directory cannot be read

Notes: calls unlink

install :: FilePath -> FilePath -> Bool -> IO ()

removeEmptyDirectory :: FilePath -> IO ()

removeDirIfEmptyOrIsSymlink :: (MonadMask m, MonadIO m, MonadCatch m) => FilePath -> m ()

removeEmptyDirsRecursive :: (MonadMask m, MonadIO m, MonadCatch m) => FilePath -> m ()

rmFileForce :: (MonadMask m, MonadIO m) => FilePath -> m ()

createDirRecursive' :: FilePath -> IO ()

More permissive version of createDirRecursive. This doesn't error when the destination is a symlink to a directory.

recyclePathForcibly :: (MonadIO m, MonadReader env m, HasDirs env, MonadMask m) => GHCupPath -> m ()

rmDirectory :: (MonadIO m, MonadMask m) => GHCupPath -> m ()

recycleFile :: (MonadIO m, MonadMask m, MonadReader env m, HasDirs env) => FilePath -> m ()

rmFile :: (MonadIO m, MonadMask m) => FilePath -> m ()

rmDirectoryLink :: (MonadIO m, MonadMask m, MonadReader env m, HasDirs env) => FilePath -> m ()

moveFilePortable :: FilePath -> FilePath -> IO ()

moveFile :: FilePath -> FilePath -> IO ()

rmPathForcibly :: (MonadIO m, MonadMask m) => GHCupPath -> m ()

exeExt :: String

The file extension for executables.

exeExt' :: ByteString

The file extension for executables.

getLinkTarget :: FilePath -> IO FilePath

On unix, we can use symlinks, so we just get the symbolic link target.

On windows, we have to emulate symlinks via shims, see createLink.

pathIsLink :: FilePath -> IO Bool

Checks whether the path is a link.

rmLink :: (MonadReader env m, HasDirs env, MonadIO m, MonadMask m) => FilePath -> m ()

createLink

Arguments

:: (MonadMask m, MonadThrow m, HasLog env, MonadIO m, MonadReader env m, HasDirs env, MonadUnliftIO m, MonadFail m)

=> FilePath

path to the target executable

-> FilePath

path to be created

-> m ()

Creates a symbolic link on unix and a fake symlink on windows for executables, which: 1. is a shim exe 2. has a corresponding .shim file in the same directory that contains the target

This overwrites previously existing files.

On windows, this requires that ensureGlobalTools was run beforehand.