Copyright	Duncan Coutts 2008
License	BSD3
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	None
Language	Haskell2010

Distribution.ModuleName

Contents

Internal

Description

Data type for Haskell module names.

Synopsis

newtype ModuleName = ModuleName ShortTextLst
fromString :: IsString a => String -> a
fromComponents :: [String] -> ModuleName
components :: ModuleName -> [String]
toFilePath :: ModuleName -> FilePath
main :: ModuleName
simple :: String -> ModuleName
validModuleComponent :: String -> Bool

Documentation

newtype ModuleName #

A valid Haskell module name.

Constructors

ModuleName ShortTextLst

Instances

Eq ModuleName #
Instance details Defined in Distribution.ModuleName Methods (==) :: ModuleName -> ModuleName -> Bool # (/=) :: ModuleName -> ModuleName -> Bool #
Data ModuleName #
Instance details Defined in Distribution.ModuleName Methods gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> ModuleName -> c ModuleName # gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c ModuleName # toConstr :: ModuleName -> Constr # dataTypeOf :: ModuleName -> DataType # dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c ModuleName) # dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c ModuleName) # gmapT :: (forall b. Data b => b -> b) -> ModuleName -> ModuleName # gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> ModuleName -> r # gmapQ :: (forall d. Data d => d -> u) -> ModuleName -> [u] # gmapQi :: Int -> (forall d. Data d => d -> u) -> ModuleName -> u # gmapM :: Monad m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName # gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> ModuleName -> m ModuleName #
Ord ModuleName #
Instance details Defined in Distribution.ModuleName Methods compare :: ModuleName -> ModuleName -> Ordering # (<) :: ModuleName -> ModuleName -> Bool # (<=) :: ModuleName -> ModuleName -> Bool # (>) :: ModuleName -> ModuleName -> Bool # (>=) :: ModuleName -> ModuleName -> Bool # max :: ModuleName -> ModuleName -> ModuleName # min :: ModuleName -> ModuleName -> ModuleName #
Read ModuleName #
Instance details Defined in Distribution.ModuleName Methods readsPrec :: Int -> ReadS ModuleName # readList :: ReadS [ModuleName] # readPrec :: ReadPrec ModuleName # readListPrec :: ReadPrec [ModuleName] #
Show ModuleName #
Instance details Defined in Distribution.ModuleName Methods showsPrec :: Int -> ModuleName -> ShowS # show :: ModuleName -> String # showList :: [ModuleName] -> ShowS #
IsString 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 `simpleParse` instead.
Instance details Defined in Distribution.ModuleName Methods fromString :: String -> ModuleName #
Generic ModuleName #
Instance details Defined in Distribution.ModuleName Associated Types type Rep ModuleName :: * -> * # Methods from :: ModuleName -> Rep ModuleName x # to :: Rep ModuleName x -> ModuleName #
Binary ModuleName #
Instance details Defined in Distribution.ModuleName Methods put :: ModuleName -> Put # get :: Get ModuleName # putList :: [ModuleName] -> Put #
NFData ModuleName #
Instance details Defined in Distribution.ModuleName Methods rnf :: ModuleName -> () #
Pretty ModuleName #
Instance details Defined in Distribution.ModuleName Methods pretty :: ModuleName -> Doc #
Parsec ModuleName #
Instance details Defined in Distribution.ModuleName Methods parsec :: CabalParsing m => m ModuleName #
Text ModuleName #
Instance details Defined in Distribution.ModuleName Methods disp :: ModuleName -> Doc # parse :: ReadP r ModuleName #
ModSubst (Set ModuleName) #
Instance details Defined in Distribution.Backpack.ModSubst Methods modSubst :: OpenModuleSubst -> Set ModuleName -> Set ModuleName #
type Rep ModuleName #
Instance details Defined in Distribution.ModuleName type Rep ModuleName

fromString :: IsString a => String -> a #

fromComponents :: [String] -> ModuleName #

Construct a ModuleName from valid module components, i.e. parts separated by dots.

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 #

Deprecated: use ModuleName.fromString instead. This symbol will be removed in Cabal-3.0 (est. Oct 2018).

Internal

validModuleComponent :: String -> Bool #