Stack.Types.Component

A module providing the types that represent different sorts of components of a package (library and sub-library, foreign library, executable, test suite and benchmark).

Documentation

data StackLibrary

A type representing (unnamed) main library or sub-library components of a package.

Cabal-syntax uses data constructors LMainLibName and LSubLibName to distinguish main libraries and sub-libraries. We do not do so, as the 'missing' name in the case of a main library can be represented by the empty string.

The corresponding Cabal-syntax type is Library.

Constructors

StackLibrary

Fields

• name :: StackUnqualCompName
• buildInfo :: !StackBuildInfo
• exposedModules :: [ModuleName]

Instances

Show StackLibrary

Defined in Stack.Types.Component

Methods

showsPrec :: Int -> StackLibrary -> ShowS

show :: StackLibrary -> String

showList :: [StackLibrary] -> ShowS

HasField "qualifiedName" StackLibrary NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackLibrary -> NamedComponent

data StackForeignLibrary

A type representing foreign library components of a package.

The corresponding Cabal-syntax type is ForeignLib.

Constructors

StackForeignLibrary

Fields

• name :: StackUnqualCompName
• buildInfo :: !StackBuildInfo

Instances

Show StackForeignLibrary

Defined in Stack.Types.Component

Methods

showsPrec :: Int -> StackForeignLibrary -> ShowS

show :: StackForeignLibrary -> String

showList :: [StackForeignLibrary] -> ShowS

HasField "qualifiedName" StackForeignLibrary NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackForeignLibrary -> NamedComponent

data StackExecutable

A type representing executable components of a package.

The corresponding Cabal-syntax type is Executable.

Constructors

StackExecutable

Fields

• name :: StackUnqualCompName
• buildInfo :: !StackBuildInfo
• modulePath :: FilePath

Instances

Show StackExecutable

Defined in Stack.Types.Component

Methods

showsPrec :: Int -> StackExecutable -> ShowS

show :: StackExecutable -> String

showList :: [StackExecutable] -> ShowS

HasField "qualifiedName" StackExecutable NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackExecutable -> NamedComponent

data StackTestSuite

A type representing test suite components of a package.

The corresponding Cabal-syntax type is TestSuite.

Constructors

StackTestSuite

Fields

• name :: StackUnqualCompName
• buildInfo :: !StackBuildInfo
• interface :: !TestSuiteInterface

Instances

Show StackTestSuite

Defined in Stack.Types.Component

Methods

showsPrec :: Int -> StackTestSuite -> ShowS

show :: StackTestSuite -> String

showList :: [StackTestSuite] -> ShowS

HasField "qualifiedName" StackTestSuite NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackTestSuite -> NamedComponent

data StackBenchmark

A type representing benchmark components of a package.

The corresponding Cabal-syntax type is Benchmark.

Constructors

StackBenchmark

Fields

• name :: StackUnqualCompName
• buildInfo :: StackBuildInfo
• interface :: BenchmarkInterface

  This is only used for gathering the files related to this component.

Instances

Show StackBenchmark

Defined in Stack.Types.Component

Methods

showsPrec :: Int -> StackBenchmark -> ShowS

show :: StackBenchmark -> String

showList :: [StackBenchmark] -> ShowS

HasField "qualifiedName" StackBenchmark NamedComponent

Defined in Stack.Types.Component

Methods

getField :: StackBenchmark -> NamedComponent

newtype StackUnqualCompName

Type representing the name of an 'unqualified' component (that is, the component can be any sort - a (unnamed) main library or sub-library, an executable, etc. ).

The corresponding The Cabal-syntax type is UnqualComponentName.

Constructors

StackUnqualCompName

Fields

• unqualCompToText :: Text

Instances

Data StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

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

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

toConstr :: StackUnqualCompName -> Constr

dataTypeOf :: StackUnqualCompName -> DataType

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

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

gmapT :: (forall b. Data b => b -> b) -> StackUnqualCompName -> StackUnqualCompName

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

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

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

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

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

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

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

IsString StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

fromString :: String -> StackUnqualCompName

Generic StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Associated Types

type Rep StackUnqualCompName :: Type -> Type

Methods

from :: StackUnqualCompName -> Rep StackUnqualCompName x

to :: Rep StackUnqualCompName x -> StackUnqualCompName

Read StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

readsPrec :: Int -> ReadS StackUnqualCompName

readList :: ReadS [StackUnqualCompName]

readPrec :: ReadPrec StackUnqualCompName

readListPrec :: ReadPrec [StackUnqualCompName]

Show StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

showsPrec :: Int -> StackUnqualCompName -> ShowS

show :: StackUnqualCompName -> String

showList :: [StackUnqualCompName] -> ShowS

NFData StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

rnf :: StackUnqualCompName -> ()

Eq StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

(==) :: StackUnqualCompName -> StackUnqualCompName -> Bool

(/=) :: StackUnqualCompName -> StackUnqualCompName -> Bool

Ord StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

compare :: StackUnqualCompName -> StackUnqualCompName -> Ordering

(<) :: StackUnqualCompName -> StackUnqualCompName -> Bool

(<=) :: StackUnqualCompName -> StackUnqualCompName -> Bool

(>) :: StackUnqualCompName -> StackUnqualCompName -> Bool

(>=) :: StackUnqualCompName -> StackUnqualCompName -> Bool

max :: StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName

min :: StackUnqualCompName -> StackUnqualCompName -> StackUnqualCompName

Hashable StackUnqualCompName

Defined in Stack.Types.ComponentUtils

Methods

hashWithSalt :: Int -> StackUnqualCompName -> Int

hash :: StackUnqualCompName -> Int

type Rep StackUnqualCompName

Defined in Stack.Types.ComponentUtils

type Rep StackUnqualCompName = D1 ('MetaData "StackUnqualCompName" "Stack.Types.ComponentUtils" "stack-2.15.1-BDsvBT8AtC4AOYQNYrK19c" 'True) (C1 ('MetaCons "StackUnqualCompName" 'PrefixI 'True) (S1 ('MetaSel ('Just "unqualCompToText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Text)))

data StackBuildInfo

Type representing information needed to build. The file gathering-related fields are lazy because they are not always needed.

The corresponding Cabal-syntax type is BuildInfo.

Constructors

StackBuildInfo

Fields

• buildable :: !Bool

  Corresponding to Cabal-syntax's buildable. The component is buildable here.

• dependency :: !(Map PackageName DepValue)

  Corresponding to Cabal-syntax's targetBuildDepends. Dependencies specific to a library or executable target.

• unknownTools :: Set Text

  From Cabal-syntax's buildTools. We only keep the legacy build tool depends that we know (from a hardcoded list). We only use the deduplication aspect of the Set here, as this field is only used for error reporting in the end. This is lazy because it's an error reporting field only.

• otherModules :: [ModuleName]

  Only used in file gathering. See usage in Stack.ComponentFile module.

• jsSources :: [FilePath]

  Only used in file gathering. See usage in Stack.ComponentFile module.

• hsSourceDirs :: [SymbolicPath PackageDir SourceDir]

  Only used in file & opts gathering. See usage in Stack.ComponentFile module for fle gathering.

• cSources :: [FilePath]

  Only used in file gathering. See usage in Stack.ComponentFile module.

• cppOptions :: [String]

  Only used in opts gathering. See usage in Stack.Package module.

• targetBuildDepends :: [Dependency]

  Only used in opts gathering.

• options :: PerCompilerFlavor [String]

  Only used in opts gathering.

• allLanguages :: [Language]

  Only used in opts gathering.

• usedExtensions :: [Extension]

  Only used in opts gathering.

• includeDirs :: [FilePath]

  Only used in opts gathering.

• extraLibs :: [String]

  Only used in opts gathering.

• extraLibDirs :: [String]

  Only used in opts gathering.

• frameworks :: [String]

  Only used in opts gathering.

Instances

Show StackBuildInfo

Defined in Stack.Types.Component

Methods

showsPrec :: Int -> StackBuildInfo -> ShowS

show :: StackBuildInfo -> String

showList :: [StackBuildInfo] -> ShowS

type HasName component = HasField "name" component StackUnqualCompName

Type synonym for a HasField constraint.

type HasBuildInfo component = HasField "buildInfo" component StackBuildInfo

Type synonym for a HasField constraint.

type HasComponentInfo component = (HasName component, HasBuildInfo component, HasQualiName component)

Type synonym for a HasField constraint for all the common component fields i.e. name, buildInfo and qualifiedName.