 | Cabal-1.2.2.0: A framework for packaging Haskell software | Contents | Index |
|
| Distribution.Simple.Utils | | Portability | portable | | Stability | alpha | | Maintainer | Isaac Jones <ijones@syntaxpolice.org> |
|
|
|
| Description |
| Explanation: Misc. Utilities, especially file-related utilities.
Stuff used by multiple modules that doesn't fit elsewhere.
|
|
| Synopsis |
|
|
|
| Documentation |
|
| die :: String -> IO a |
|
| dieWithLocation :: FilePath -> Maybe Int -> String -> IO a |
|
| warn :: Verbosity -> String -> IO () |
Non fatal conditions that may be indicative of an error or problem.
We display these at the normal verbosity level.
|
|
| notice :: Verbosity -> String -> IO () |
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.
|
|
| info :: Verbosity -> String -> IO () |
More detail on the operation of some action.
We display these messages when the verbosity level is verbose
|
|
| debug :: Verbosity -> String -> IO () |
Detailed internal debugging information
We display these messages when the verbosity level is deafening
|
|
| breaks :: (a -> Bool) -> [a] -> [[a]] |
|
| wrapText :: Int -> [String] -> [String] |
|
| rawSystemExit :: Verbosity -> FilePath -> [String] -> IO () |
|
| rawSystemStdout :: Verbosity -> FilePath -> [String] -> IO String |
|
| rawSystemStdout' :: Verbosity -> FilePath -> [String] -> IO (String, ExitCode) |
|
| maybeExit :: IO ExitCode -> IO () |
|
| xargs :: Int -> ([String] -> IO ()) -> [String] -> [String] -> IO () |
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) (rawSystemPathExit verbosity) prog fixedArgs bigArgs
|
|
| matchesDescFile :: FilePath -> Bool |
|
| rawSystemPathExit :: Verbosity -> String -> [String] -> IO () |
|
| smartCopySources |
| :: Verbosity | verbosity
| | -> [FilePath] | build prefix (location of objects)
| | -> FilePath | Target directory
| | -> [String] | Modules
| | -> [String] | search suffixes
| | -> Bool | Exit if no such modules
| | -> Bool | Preserve directory structure
| | -> IO () | | | Copy the source files into the right directory. Looks in the
build prefix for files that look like the input modules, based on
the input search suffixes. It copies the files into the target
directory.
|
|
|
| createDirectoryIfMissingVerbose :: Verbosity -> Bool -> FilePath -> IO () |
|
| copyFileVerbose :: Verbosity -> FilePath -> FilePath -> IO () |
|
| copyDirectoryRecursiveVerbose :: Verbosity -> FilePath -> FilePath -> IO () |
|
| moduleToFilePath |
| :: [FilePath] | search locations
| | -> String | Module Name
| | -> [String] | possible suffixes
| | -> IO [FilePath] | | | Get the file path for this particular module. In the IO monad
because it looks for the actual file. Might eventually interface
with preprocessor libraries in order to correctly locate more
filenames.
Returns empty list if no such files exist.
|
|
|
| moduleToFilePath2 |
| :: [FilePath] | search locations
| | -> String | Module Name
| | -> [String] | possible suffixes
| | -> IO [(FilePath, FilePath)] | locations and relative names
| | Like moduleToFilePath, but return the location and the rest of
the path as separate results.
|
|
|
| mkLibName |
| :: FilePath | file Prefix
| | -> String | library name.
| | -> String | |
|
|
| mkProfLibName |
| :: FilePath | file Prefix
| | -> String | library name.
| | -> String | |
|
|
| mkSharedLibName |
| :: FilePath | file Prefix
| | -> String | library name.
| | -> PackageIdentifier | package identifier of the compiler
| | -> String | |
|
|
| currentDir :: FilePath |
| The path name that represents the current directory.
In Unix, it's ".", but this is system-specific.
(E.g. AmigaOS uses the empty string "" for the current directory.)
|
|
| dotToSep :: String -> String |
|
| findFile |
| :: [FilePath] | search locations
| | -> FilePath | File Name
| | -> IO FilePath | |
|
|
| defaultPackageDesc :: Verbosity -> IO FilePath |
| Package description file (pkgname.cabal)
|
|
| findPackageDesc |
| :: Verbosity | Verbosity
| | -> FilePath | Where to look
| | -> IO FilePath | | | Find a package description file in the given directory. Looks for
.cabal files.
|
|
|
| defaultHookedPackageDesc :: IO (Maybe FilePath) |
| Optional auxiliary package information file (pkgname.buildinfo)
|
|
| findHookedPackageDesc |
| :: FilePath | Directory to search
| | -> IO (Maybe FilePath) | dir/pkgname.buildinfo, if present
| | Find auxiliary package information in the given directory.
Looks for .buildinfo files.
|
|
|
| exeExtension :: String |
| Extension for executable files
(typically "" on Unix and "exe" on Windows or OS/2)
|
|
| objExtension :: String |
| Extension for object files. For GHC and NHC the extension is "o".
Hugs uses either "o" or "obj" depending on the used C compiler.
|
|
| dllExtension :: String |
| Extension for dynamically linked (or shared) libraries
(typically "so" on Unix and "dll" on Windows)
|
|
| Produced by Haddock version 0.8 |