Cabal-syntax-3.11.0.0: A library for working with .cabal files
Safe HaskellNone
LanguageHaskell2010

Distribution.Types.UnqualComponentName

Synopsis

Documentation

data UnqualComponentName Source #

An unqualified component name, for any kind of component.

This is distinguished from a ComponentName and ComponentId. The former also states which of a library, executable, etc the name refers too. The later uniquely identifiers a component and its closure.

Since: Cabal-syntax-2.0.0.2

Instances

Instances details
Parsec UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

parsec :: CabalParsing m => m UnqualComponentName Source #

Pretty UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

pretty :: UnqualComponentName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> UnqualComponentName -> Doc Source #

Structured UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

structure :: Proxy UnqualComponentName -> Structure Source #

structureHash' :: Tagged UnqualComponentName MD5

Binary UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

put :: UnqualComponentName -> Put Source #

get :: Get UnqualComponentName Source #

putList :: [UnqualComponentName] -> Put Source #

NFData UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

rnf :: UnqualComponentName -> () Source #

Monoid UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

mempty :: UnqualComponentName #

mappend :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

mconcat :: [UnqualComponentName] -> UnqualComponentName #

Semigroup UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

(<>) :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

sconcat :: NonEmpty UnqualComponentName -> UnqualComponentName #

stimes :: Integral b => b -> UnqualComponentName -> UnqualComponentName #

Data UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b) -> (forall g. g -> c g) -> UnqualComponentName -> c UnqualComponentName #

gunfold :: (forall b r. Data b => c (b -> r) -> c r) -> (forall r. r -> c r) -> Constr -> c UnqualComponentName #

toConstr :: UnqualComponentName -> Constr #

dataTypeOf :: UnqualComponentName -> DataType #

dataCast1 :: Typeable t => (forall d. Data d => c (t d)) -> Maybe (c UnqualComponentName) #

dataCast2 :: Typeable t => (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c UnqualComponentName) #

gmapT :: (forall b. Data b => b -> b) -> UnqualComponentName -> UnqualComponentName #

gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> UnqualComponentName -> r #

gmapQr :: forall r r'. (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> UnqualComponentName -> r #

gmapQ :: (forall d. Data d => d -> u) -> UnqualComponentName -> [u] #

gmapQi :: Int -> (forall d. Data d => d -> u) -> UnqualComponentName -> u #

gmapM :: Monad m => (forall d. Data d => d -> m d) -> UnqualComponentName -> m UnqualComponentName #

gmapMp :: MonadPlus m => (forall d. Data d => d -> m d) -> UnqualComponentName -> m UnqualComponentName #

gmapMo :: MonadPlus m => (forall d. Data d => d -> m d) -> UnqualComponentName -> m UnqualComponentName #

IsString UnqualComponentName Source #

mkUnqualComponentName

Since: Cabal-syntax-2.0.0.2

Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

fromString :: String -> UnqualComponentName #

Generic UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Associated Types

type Rep UnqualComponentName 
Instance details

Defined in Distribution.Types.UnqualComponentName

type Rep UnqualComponentName = D1 ('MetaData "UnqualComponentName" "Distribution.Types.UnqualComponentName" "Cabal-syntax-3.11.0.0-f9cc" 'True) (C1 ('MetaCons "UnqualComponentName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

Methods

from :: UnqualComponentName -> Rep UnqualComponentName x #

to :: Rep UnqualComponentName x -> UnqualComponentName #

Read UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

readsPrec :: Int -> ReadS UnqualComponentName #

readList :: ReadS [UnqualComponentName] #

readPrec :: ReadPrec UnqualComponentName #

readListPrec :: ReadPrec [UnqualComponentName] #

Show UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

showsPrec :: Int -> UnqualComponentName -> ShowS #

show :: UnqualComponentName -> String #

showList :: [UnqualComponentName] -> ShowS #

Eq UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

(==) :: UnqualComponentName -> UnqualComponentName -> Bool #

(/=) :: UnqualComponentName -> UnqualComponentName -> Bool #

Ord UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

compare :: UnqualComponentName -> UnqualComponentName -> Ordering #

(<) :: UnqualComponentName -> UnqualComponentName -> Bool #

(<=) :: UnqualComponentName -> UnqualComponentName -> Bool #

(>) :: UnqualComponentName -> UnqualComponentName -> Bool #

(>=) :: UnqualComponentName -> UnqualComponentName -> Bool #

max :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

min :: UnqualComponentName -> UnqualComponentName -> UnqualComponentName #

type Rep UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

type Rep UnqualComponentName = D1 ('MetaData "UnqualComponentName" "Distribution.Types.UnqualComponentName" "Cabal-syntax-3.11.0.0-f9cc" 'True) (C1 ('MetaCons "UnqualComponentName" 'PrefixI 'False) (S1 ('MetaSel ('Nothing :: Maybe Symbol) 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ShortText)))

unUnqualComponentName :: UnqualComponentName -> String Source #

Convert UnqualComponentName to String

Since: Cabal-syntax-2.0.0.2

unUnqualComponentNameST :: UnqualComponentName -> ShortText Source #

Since: Cabal-syntax-3.4.0.0

mkUnqualComponentName :: String -> UnqualComponentName Source #

Construct a UnqualComponentName from a String

mkUnqualComponentName is the inverse to unUnqualComponentName

Note: No validations are performed to ensure that the resulting UnqualComponentName is valid

Since: Cabal-syntax-2.0.0.2

packageNameToUnqualComponentName :: PackageName -> UnqualComponentName Source #

Converts a package name to an unqualified component name

Useful in legacy situations where a package name may refer to an internal component, if one is defined with that name.

2018-12-21: These "legacy" situations are not legacy. We can build-depends on the internal library. However Now dependency contains Set LibraryName, and we should use that.

Since: Cabal-syntax-2.0.0.2

unqualComponentNameToPackageName :: UnqualComponentName -> PackageName Source #

Converts an unqualified component name to a package name

packageNameToUnqualComponentName is the inverse of unqualComponentNameToPackageName.

Useful in legacy situations where a package name may refer to an internal component, if one is defined with that name.

Since: Cabal-syntax-2.0.0.2

combineNames :: (Monoid b, Eq b, Show b) => a -> a -> (a -> b) -> String -> b Source #

Combine names in targets if one name is empty or both names are equal (partial function). Useful in Semigroup and similar instances.