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
validModuleComponent :: String -> Bool

Documentation

newtype ModuleName Source #

A valid Haskell module name.

Constructors

ModuleName ShortTextLst

Instances

Instances details

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

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

fromComponents :: [ String ] -> ModuleName Source #

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

components :: ModuleName -> [ String ] Source #

The individual components of a hierarchical module name. For example

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

toFilePath :: ModuleName -> FilePath Source #

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 Source #

The module name Main .

Internal

validModuleComponent :: String -> Bool Source #