-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/


-- | High-level, byte-based file and directory path manipulations
--   
--   High-level, byte-based file and directory path manipulations
@package system-filepath
@version 0.2


-- | High‐level, byte‐based file and directory path manipulations. You
--   probably want to import <a>System.FilePath.CurrentOS</a> instead,
--   since it handles detecting which rules to use in the current
--   compilation.
module System.FilePath
data FilePath

-- | A file path with no root, directory, or filename
empty :: FilePath

-- | <pre>
--   null p = (p == <a>empty</a>)
--   </pre>
null :: FilePath -> Bool

-- | Retrieves the <a>FilePath</a>’s root.
root :: FilePath -> FilePath

-- | Retrieves the <a>FilePath</a>’s directory. If the path is already a
--   directory, it is returned unchanged.
directory :: FilePath -> FilePath

-- | Retrieves the <a>FilePath</a>’s parent directory.
parent :: FilePath -> FilePath

-- | Retrieve a <a>FilePath</a>’s filename component.
--   
--   <pre>
--   filename "foo/bar.txt" == "bar.txt"
--   </pre>
filename :: FilePath -> FilePath

-- | Retrieve a <a>FilePath</a>’s basename component.
--   
--   <pre>
--   basename "foo/bar.txt" == "bar"
--   </pre>
basename :: FilePath -> FilePath

-- | Test whether a path is absolute.
absolute :: FilePath -> Bool

-- | Test whether a path is relative.
relative :: FilePath -> Bool

-- | Appends two <a>FilePath</a>s. If the second path is absolute, it is
--   returned unchanged.
append :: FilePath -> FilePath -> FilePath

-- | An alias for <a>append</a>.
(</>) :: FilePath -> FilePath -> FilePath

-- | A fold over <a>append</a>.
concat :: [FilePath] -> FilePath

-- | Find the greatest common prefix between a list of <a>FilePath</a>s.
commonPrefix :: [FilePath] -> FilePath

-- | Remove <tt>"."</tt> and <tt>".."</tt> directories from a path.
--   
--   Note that if any of the elements are symbolic links, <a>collapse</a>
--   may change which file the path resolves to.
--   
--   Since: 0.2
collapse :: FilePath -> FilePath

-- | Get a <a>FilePath</a>’s last extension, or <a>Nothing</a> if it has no
--   extensions.
extension :: FilePath -> Maybe ByteString

-- | Get a <a>FilePath</a>’s full extension list.
extensions :: FilePath -> [ByteString]

-- | Get whether a <a>FilePath</a>’s last extension is the predicate.
hasExtension :: FilePath -> ByteString -> Bool

-- | Append an extension to the end of a <a>FilePath</a>.
addExtension :: FilePath -> ByteString -> FilePath

-- | An alias for <a>addExtension</a>.
(<.>) :: FilePath -> ByteString -> FilePath

-- | Remove a <a>FilePath</a>’s last extension.
dropExtension :: FilePath -> FilePath

-- | Replace a <a>FilePath</a>’s last extension.
replaceExtension :: FilePath -> ByteString -> FilePath

-- | Append many extensions to the end of a <a>FilePath</a>.
addExtensions :: FilePath -> [ByteString] -> FilePath

-- | Remove all extensions from a <a>FilePath</a>.
dropExtensions :: FilePath -> FilePath

-- | Remove all extensions from a <a>FilePath</a>, and replace them with a
--   new list.
replaceExtensions :: FilePath -> [ByteString] -> FilePath

-- | <pre>
--   splitExtension p = (<a>dropExtension</a> p, <a>extension</a> p)
--   </pre>
splitExtension :: FilePath -> (FilePath, Maybe ByteString)

-- | <pre>
--   splitExtensions p = (<a>dropExtensions</a> p, <a>extensions</a> p)
--   </pre>
splitExtensions :: FilePath -> (FilePath, [ByteString])
instance Monoid FilePath


module System.FilePath.Rules
data Rules

-- | Linux, BSD, OS X, and other UNIX or UNIX-like operating systems.
posix :: Rules

-- | Windows and DOS
windows :: Rules

-- | Convert a <a>FilePath</a> into a strict <a>ByteString</a>, suitable
--   for passing to OS libraries.
toBytes :: Rules -> FilePath -> ByteString

-- | Parse a strict <a>ByteString</a>, such as those received from OS
--   libraries, into a <a>FilePath</a>.
fromBytes :: Rules -> ByteString -> FilePath

-- | Attempt to convert a <a>FilePath</a> to human‐readable text.
--   
--   If the path is decoded successfully, the result is a <a>Right</a>
--   containing the decoded text. Successfully decoded text can be
--   converted back to the original path using <a>fromText</a>.
--   
--   If the path cannot be decoded, the result is a <a>Left</a> containing
--   an approximation of the original path. If displayed to the user, this
--   value should be accompanied by some warning that the path has an
--   invalid encoding. Approximated text cannot be converted back to the
--   original path.
--   
--   This function ignores the user’s locale, and assumes all file paths
--   are encoded in UTF8. If you need to display file paths with an unusual
--   or obscure encoding, use <a>toBytes</a> and then decode them manually.
--   
--   Since: 0.2
toText :: Rules -> FilePath -> Either Text Text

-- | Convert human‐readable text into a <a>FilePath</a>.
--   
--   This function ignores the user’s locale, and assumes all file paths
--   are encoded in UTF8. If you need to create file paths with an unusual
--   or obscure encoding, encode them manually and then use
--   <a>fromBytes</a>.
--   
--   Since: 0.2
fromText :: Rules -> Text -> FilePath

-- | Check if a <a>FilePath</a> is valid; it must not contain any illegal
--   characters, and must have a root appropriate to the current
--   <a>Rules</a>.
valid :: Rules -> FilePath -> Bool

-- | Split a search path, such as <tt>$PATH</tt> or <tt>$PYTHONPATH</tt>,
--   into a list of <a>FilePath</a>s.
splitSearchPath :: Rules -> ByteString -> [FilePath]


-- | Re‐exports contents of <a>System.FilePath.Rules</a>, defaulting to the
--   current OS’s rules when needed.
--   
--   Also enables <a>Show</a> and <a>IsString</a> instances for
--   <a>FilePath</a>.
module System.FilePath.CurrentOS
currentOS :: Rules

-- | Convert a <a>FilePath</a> into a strict <a>ByteString</a>, suitable
--   for passing to OS libraries.
toBytes :: FilePath -> ByteString

-- | Parse a strict <a>ByteString</a>, such as those received from OS
--   libraries, into a <a>FilePath</a>.
fromBytes :: ByteString -> FilePath

-- | Attempt to convert a <a>FilePath</a> to human‐readable text.
--   
--   If the path is decoded successfully, the result is a <a>Right</a>
--   containing the decoded text. Successfully decoded text can be
--   converted back to the original path using <a>fromText</a>.
--   
--   If the path cannot be decoded, the result is a <a>Left</a> containing
--   an approximation of the original path. If displayed to the user, this
--   value should be accompanied by some warning that the path has an
--   invalid encoding. Approximated text cannot be converted back to the
--   original path.
--   
--   This function ignores the user’s locale, and assumes all file paths
--   are encoded in UTF8. If you need to display file paths with an unusual
--   or obscure encoding, use <a>toBytes</a> and then decode them manually.
--   
--   Since: 0.2
toText :: FilePath -> Either Text Text

-- | Convert human‐readable text into a <a>FilePath</a>.
--   
--   This function ignores the user’s locale, and assumes all file paths
--   are encoded in UTF8. If you need to create file paths with an unusual
--   or obscure encoding, encode them manually and then use
--   <a>fromBytes</a>.
--   
--   Since: 0.2
fromText :: Text -> FilePath

-- | Check if a <a>FilePath</a> is valid; it must not contain any illegal
--   characters, and must have a root appropriate to the current
--   <a>Rules</a>.
valid :: FilePath -> Bool

-- | Split a search path, such as <tt>$PATH</tt> or <tt>$PYTHONPATH</tt>,
--   into a list of <a>FilePath</a>s.
splitSearchPath :: ByteString -> [FilePath]
instance Show FilePath
instance IsString FilePath