Safe Haskell	None
Language	GHC2021

Stack.Types.NamedComponent

Description

Module exporting the NamedComponent type and related functions.

Synopsis

data NamedComponent
- = CLib
- | CSubLib !StackUnqualCompName
- | CFlib !StackUnqualCompName
- | CExe !StackUnqualCompName
- | CTest !StackUnqualCompName
- | CBench !StackUnqualCompName
componentCachePath :: NamedComponent -> String
renderComponent :: NamedComponent -> Text
renderComponentTo :: IsString a => NamedComponent -> a
renderPkgComponents :: [(PackageName, NamedComponent)] -> Text
renderPkgComponent :: (PackageName, NamedComponent) -> Text
exeComponents :: Set NamedComponent -> Set StackUnqualCompName
testComponents :: Set NamedComponent -> Set StackUnqualCompName
benchComponents :: Set NamedComponent -> Set StackUnqualCompName
subLibComponents :: Set NamedComponent -> Set StackUnqualCompName
isCLib :: NamedComponent -> Bool
isCSubLib :: NamedComponent -> Bool
isCExe :: NamedComponent -> Bool
isCTest :: NamedComponent -> Bool
isCBench :: NamedComponent -> Bool
isPotentialDependency :: NamedComponent -> Bool
splitComponents :: [NamedComponent] -> (Set StackUnqualCompName, Set StackUnqualCompName, Set StackUnqualCompName, Set StackUnqualCompName)

Documentation

data NamedComponent Source #

Type representing components of a fully-resolved Cabal package.

Constructors

CLib
CSubLib !StackUnqualCompName
CFlib !StackUnqualCompName
CExe !StackUnqualCompName
CTest !StackUnqualCompName
CBench !StackUnqualCompName

Instances

Instances details

Show NamedComponent Source #
Instance details Defined in Stack.Types.NamedComponent Methods showsPrec :: Int -> NamedComponent -> ShowS # show :: NamedComponent -> String # showList :: [NamedComponent] -> ShowS #
Eq NamedComponent Source #
Instance details Defined in Stack.Types.NamedComponent Methods (==) :: NamedComponent -> NamedComponent -> Bool # (/=) :: NamedComponent -> NamedComponent -> Bool #
Ord NamedComponent Source #
Instance details Defined in Stack.Types.NamedComponent Methods compare :: NamedComponent -> NamedComponent -> Ordering # (<) :: NamedComponent -> NamedComponent -> Bool # (<=) :: NamedComponent -> NamedComponent -> Bool # (>) :: NamedComponent -> NamedComponent -> Bool # (>=) :: NamedComponent -> NamedComponent -> Bool # max :: NamedComponent -> NamedComponent -> NamedComponent # min :: NamedComponent -> NamedComponent -> NamedComponent #
HasField "qualifiedName" StackBenchmark NamedComponent Source #
Instance details Defined in Stack.Types.Component Methods getField :: StackBenchmark -> NamedComponent #
HasField "qualifiedName" StackExecutable NamedComponent Source #
Instance details Defined in Stack.Types.Component Methods getField :: StackExecutable -> NamedComponent #
HasField "qualifiedName" StackForeignLibrary NamedComponent Source #
Instance details Defined in Stack.Types.Component Methods getField :: StackForeignLibrary -> NamedComponent #
HasField "qualifiedName" StackLibrary NamedComponent Source #
Instance details Defined in Stack.Types.Component Methods getField :: StackLibrary -> NamedComponent #
HasField "qualifiedName" StackTestSuite NamedComponent Source #
Instance details Defined in Stack.Types.Component Methods getField :: StackTestSuite -> NamedComponent #

componentCachePath :: NamedComponent -> String Source #

renderComponent :: NamedComponent -> Text Source #

renderComponentTo :: IsString a => NamedComponent -> a Source #

Render a component to anything with an IsString instance. For Text prefer renderComponent.

renderPkgComponents :: [(PackageName, NamedComponent)] -> Text Source #

renderPkgComponent :: (PackageName, NamedComponent) -> Text Source #

exeComponents :: Set NamedComponent -> Set StackUnqualCompName Source #

testComponents :: Set NamedComponent -> Set StackUnqualCompName Source #

benchComponents :: Set NamedComponent -> Set StackUnqualCompName Source #

subLibComponents :: Set NamedComponent -> Set StackUnqualCompName Source #

isCLib :: NamedComponent -> Bool Source #

isCSubLib :: NamedComponent -> Bool Source #

isCExe :: NamedComponent -> Bool Source #

isCTest :: NamedComponent -> Bool Source #

isCBench :: NamedComponent -> Bool Source #

isPotentialDependency :: NamedComponent -> Bool Source #

splitComponents :: [NamedComponent] -> (Set StackUnqualCompName, Set StackUnqualCompName, Set StackUnqualCompName, Set StackUnqualCompName) Source #

A function to split the given list of components into sets of the names of the named components by the type of component (sub-libraries, executables, test-suites, benchmarks), ignoring any main unnamed library component or foreign library component. This function should be used very sparingly; more often than not, you can keep/parse the components split from the start.