| Cabal-1.8.0.6: A framework for packaging Haskell software | Contents | Index

Distribution.ModuleName

Portability | portable
Maintainer | cabal-devel@haskell.org

Description
Data type for Haskell module names.
Synopsis

data ModuleName
fromString :: String -> ModuleName
components :: ModuleName -> [String]
toFilePath :: ModuleName -> FilePath
main :: ModuleName
simple :: String -> ModuleName

Documentation
data ModuleName

A valid Haskell module name.
Instances

Eq ModuleName
Ord ModuleName
Read ModuleName
Show ModuleName
Text ModuleName

fromString :: String -> ModuleName
Construct a `ModuleName` from a valid module name `String`. This is just a convenience function intended for valid module strings. It is an error if it is used with a string that is not a valid module name. If you are parsing user input then use Distribution.Text.simpleParse instead.
components :: ModuleName -> [String]

The individual components of a hierarchical module name. For example

     components (fromString "A.B.C") = ["A", "B", "C"]

toFilePath :: ModuleName -> FilePath

Convert a module name to a file path, but without any file extension. For example:

     toFilePath (fromString "A.B.C") = "A/B/C"

main :: ModuleName
The module name `Main`.
simple :: String -> ModuleName
Produced by Haddock version 2.6.1