Safe Haskell	Safe-Inferred

Development.Shake.FilePath

Description

A module for FilePath operations, to be used instead of System.FilePath when writing build systems. In build systems, when using the file name as a key for indexing rules, it is important that two different strings do not refer to the same on-disk file. We therefore follow the conventions:

Always use / as the directory separator, even on Windows.
When combining FilePath values with </> we squash any /./ components.

Synopsis

module System.FilePath.Posix
dropDirectory1 :: FilePath -> FilePath
takeDirectory1 :: FilePath -> FilePath
normalise :: FilePath -> FilePath
toNative :: FilePath -> FilePath
(</>) :: FilePath -> FilePath -> FilePath
combine :: FilePath -> FilePath -> FilePath

Documentation

module System.FilePath.Posix

dropDirectory1 :: FilePath -> FilePath Source

Drop the first directory from a FilePath . Should only be used on relative paths.

 dropDirectory1 "aaa/bbb" == "bbb"
 dropDirectory1 "aaa/" == ""
 dropDirectory1 "aaa" == ""
 dropDirectory1 "" == ""

takeDirectory1 :: FilePath -> FilePath Source

Take the first component of a FilePath . Should only be used on relative paths.

 takeDirectory1 "aaa/bbb" == "aaa"
 takeDirectory1 "aaa/" == "aaa"
 takeDirectory1 "aaa" == "aaa"

normalise :: FilePath -> FilePath Source

Normalise a FilePath , applying the standard FilePath normalisation, plus translating any path separators to / and removing foo/.. components where possible.

toNative :: FilePath -> FilePath Source

Convert to native path separators, namely \ on Windows.

(</>) :: FilePath -> FilePath -> FilePath Source

Combine two file paths, an alias for combine .

combine :: FilePath -> FilePath -> FilePath Source

Combine two file paths. Any leading ./ or ../ components in the right file are eliminated.

 combine "aaa/bbb" "ccc" == "aaa/bbb/ccc"
 combine "aaa/bbb" "./ccc" == "aaa/bbb/ccc"
 combine "aaa/bbb" "../ccc" == "aaa/ccc"