 | Cabal-1.10.1.0: A framework for packaging Haskell software | Contents | Index |
| Distribution.Simple.Utils |
|
| Contents |
| cabalVersion :: Version | ||||
| die :: String -> IO a | ||||
| dieWithLocation :: FilePath -> Maybe Int -> String -> IO a | ||||
| topHandler :: IO a -> IO a | ||||
| warn :: Verbosity -> String -> IO () | ||||
| notice :: Verbosity -> String -> IO () | ||||
| setupMessage :: Verbosity -> String -> PackageIdentifier -> IO () | ||||
| info :: Verbosity -> String -> IO () | ||||
| debug :: Verbosity -> String -> IO () | ||||
| chattyTry :: String -> IO () -> IO () | ||||
| rawSystemExit :: Verbosity -> FilePath -> [String] -> IO () | ||||
| rawSystemExitWithEnv :: Verbosity -> FilePath -> [String] -> [(String, String)] -> IO () | ||||
| rawSystemStdout :: Verbosity -> FilePath -> [String] -> IO String | ||||
| rawSystemStdInOut :: Verbosity -> FilePath -> [String] -> Maybe (String, Bool) -> Bool -> IO (String, String, ExitCode) | ||||
| maybeExit :: IO ExitCode -> IO () | ||||
| xargs :: Int -> ([String] -> IO ()) -> [String] -> [String] -> IO () | ||||
| findProgramLocation :: Verbosity -> FilePath -> IO (Maybe FilePath) | ||||
| findProgramVersion :: String -> (String -> String) -> Verbosity -> FilePath -> IO (Maybe Version) | ||||
| smartCopySources :: Verbosity -> [FilePath] -> FilePath -> [ModuleName] -> [String] -> IO () | ||||
| createDirectoryIfMissingVerbose :: Verbosity -> Bool -> FilePath -> IO () | ||||
| copyFileVerbose :: Verbosity -> FilePath -> FilePath -> IO () | ||||
| copyDirectoryRecursiveVerbose :: Verbosity -> FilePath -> FilePath -> IO () | ||||
| copyFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO () | ||||
| installOrdinaryFile :: Verbosity -> FilePath -> FilePath -> IO () | ||||
| installExecutableFile :: Verbosity -> FilePath -> FilePath -> IO () | ||||
| installOrdinaryFiles :: Verbosity -> FilePath -> [(FilePath, FilePath)] -> IO () | ||||
| installDirectoryContents :: Verbosity -> FilePath -> FilePath -> IO () | ||||
| currentDir :: FilePath | ||||
| findFile :: [FilePath] -> FilePath -> IO FilePath | ||||
| findFileWithExtension :: [String] -> [FilePath] -> FilePath -> IO (Maybe FilePath) | ||||
| findFileWithExtension' :: [String] -> [FilePath] -> FilePath -> IO (Maybe (FilePath, FilePath)) | ||||
| findModuleFile :: [FilePath] -> [String] -> ModuleName -> IO (FilePath, FilePath) | ||||
| findModuleFiles :: [FilePath] -> [String] -> [ModuleName] -> IO [(FilePath, FilePath)] | ||||
| getDirectoryContentsRecursive :: FilePath -> IO [FilePath] | ||||
| matchFileGlob :: FilePath -> IO [FilePath] | ||||
| matchDirFileGlob :: FilePath -> FilePath -> IO [FilePath] | ||||
| parseFileGlob :: FilePath -> Maybe FileGlob | ||||
| ||||
| withTempFile :: FilePath -> String -> (FilePath -> Handle -> IO a) -> IO a | ||||
| withTempDirectory :: Verbosity -> FilePath -> String -> (FilePath -> IO a) -> IO a | ||||
| defaultPackageDesc :: Verbosity -> IO FilePath | ||||
| findPackageDesc :: FilePath -> IO FilePath | ||||
| defaultHookedPackageDesc :: IO (Maybe FilePath) | ||||
| findHookedPackageDesc :: FilePath -> IO (Maybe FilePath) | ||||
| withFileContents :: FilePath -> (String -> IO a) -> IO a | ||||
| writeFileAtomic :: FilePath -> String -> IO () | ||||
| rewriteFile :: FilePath -> String -> IO () | ||||
| fromUTF8 :: String -> String | ||||
| toUTF8 :: String -> String | ||||
| readUTF8File :: FilePath -> IO String | ||||
| withUTF8FileContents :: FilePath -> (String -> IO a) -> IO a | ||||
| writeUTF8File :: FilePath -> String -> IO () | ||||
| normaliseLineEndings :: String -> String | ||||
| equating :: Eq a => (b -> a) -> b -> b -> Bool | ||||
| comparing :: Ord a => (b -> a) -> b -> b -> Ordering | ||||
| isInfixOf :: String -> String -> Bool | ||||
| intercalate :: [a] -> [[a]] -> [a] | ||||
| lowercase :: String -> String | ||||
| wrapText :: String -> String | ||||
| wrapLine :: Int -> [String] -> [[String]] |
Non fatal conditions that may be indicative of an error or problem.
We display these at the normal verbosity level.
Useful status messages.
We display these at the normal verbosity level.
This is for the ordinary helpful status messages that users see. Just enough information to know that things are working but not floods of detail.
More detail on the operation of some action.
We display these messages when the verbosity level is verbose
Detailed internal debugging information
We display these messages when the verbosity level is deafening
| :: String | a description of the action we were attempting |
| -> IO () | the action itself |
| -> IO () | |
| Perform an IO action, catching any IO exceptions and printing an error if one occurs. | |
Run a command and return its output.
The output is assumed to be text in the locale encoding.
| :: Verbosity | |
| -> FilePath | |
| -> [String] | |
| -> Maybe (String, Bool) | input text and binary mode |
| -> Bool | output in binary mode |
| -> IO (String, String, ExitCode) | output, errors, exit |
| Run a command and return its output, errors and exit status. Optionally also supply some input. Also provides control over whether the binary/text mode of the input and output. | |
Like the unix xargs program. Useful for when we've got very long command lines that might overflow an OS limit on command line length and so you need to invoke a command multiple times to get all the args in.
Use it with either of the rawSystem variants above. For example:
xargs (32*1024) (rawSystemExit verbosity) prog fixedArgs bigArgs
| :: String | version args |
| -> String -> String | function to select version number from program output |
| -> Verbosity | |
| -> FilePath | location |
| -> IO (Maybe Version) | |
| Look for a program and try to find it's version number. It can accept either an absolute path or the name of a program binary, in which case we will look for the program on the path. | |
Copies a file without copying file permissions. The target file is created with default permissions. Any existing target file is replaced.
At higher verbosity levels it logs an info message.
Copies a bunch of files to a target directory, preserving the directory structure in the target location. The target directories are created if they do not exist.
The files are identified by a pair of base directory and a path relative to that base. It is only the relative part that is preserved in the destination.
For example:
copyFiles normal "dist/src"
[("", "src/Foo.hs"), ("dist/build/", "src/Bar.hs")]
This would copy "src/Foo.hs" to "dist/src/src/Foo.hs" and copy "dist/build/src/Bar.hs" to "dist/src/src/Bar.hs".
This operation is not atomic. Any IO failure during the copy (including any missing source files) leaves the target in an unknown state so it is best to use it with a freshly created directory so that it can be simply deleted if anything goes wrong.
| :: [FilePath] | search locations |
| -> FilePath | File Name |
| -> IO FilePath | |
| Find a file by looking in a search path. The file path must match exactly. | |
| :: [FilePath] | build prefix (location of objects) |
| -> [String] | search suffixes |
| -> ModuleName | module |
| -> IO (FilePath, FilePath) | |
Find the file corresponding to a Haskell module name. This is similar to findFileWithExtension' but specialised to a module name. The function fails if the file corresponding to the module is missing. | |
| :: [FilePath] | build prefix (location of objects) |
| -> [String] | search suffixes |
| -> [ModuleName] | modules |
| -> IO [(FilePath, FilePath)] | |
Finds the files corresponding to a list of Haskell module names. As findModuleFile but for a list of module names. | |
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.
| Constructors | ||||
|
| :: FilePath | Temp dir to create the file in |
| -> String | File name template. See openTempFile. |
| -> FilePath -> Handle -> IO a | |
| -> IO a | |
| Use a temporary filename that doesn't already exist. | |
Create and use a temporary directory.
Creates a new temporary directory inside the given directory, making use of the template. The temp directory is deleted after use. For example:
withTempDirectory verbosity "src" "sdist." $ \tmpDir -> do ...
The tmpDir will be a new subdirectory of the given directory, e.g. src/sdist.342.
| :: FilePath | Where to look |
| -> IO FilePath | pkgname.cabal |
| Find a package description file in the given directory. Looks for .cabal files. | |
| :: FilePath | Directory to search |
| -> IO (Maybe FilePath) | dir/pkgname.buildinfo, if present |
| Find auxiliary package information in the given directory. Looks for .buildinfo files. | |
Gets the contents of a file, but guarantee that it gets closed.
The file is read lazily but if it is not fully consumed by the action then the remaining input is truncated and the file is closed.
Writes a file atomically.
The file is either written sucessfully or an IO exception is raised and the original file is left unchanged.
On windows it is not possible to delete a file that is open by a process. This case will give an IO exception but the atomic property is not affected.
Reads a UTF8 encoded text file as a Unicode String
Reads lazily using ordinary readFile.
Reads a UTF8 encoded text file as a Unicode String
Same behaviour as withFileContents.
Writes a Unicode String as a UTF8 encoded text file.
Uses writeFileAtomic, so provides the same guarantees.