ModuleCabal-syntax-3.12.1.0Haskell2010

Distribution.Types.ForeignLib

2 types
9 values

PackageCabal-syntax-3.12.1.0
Exports11
LanguageHaskell2010
LicenceBSD-3-Clause
SourceForeignLib.hs

datadata ForeignLib

A foreign library stanza is like a library stanza, except that the built code is intended for consumption by a non-Haskell client.

Constructors

ForeignLib
- foreignLibName :: UnqualComponentName
  Name of the foreign library
- foreignLibType :: ForeignLibType
  What kind of foreign library is this (static or dynamic).
- foreignLibOptions :: [ForeignLibOption]
  What options apply to this foreign library (e.g., are we merging in all foreign dependencies.)
- foreignLibBuildInfo :: BuildInfo
  Build information for this foreign library.
- foreignLibVersionInfo :: Maybe LibVersionInfo
  Libtool-style version-info data to compute library version. Refer to the libtool documentation on the current:revision:age versioning scheme.
- foreignLibVersionLinux :: Maybe Version
  Linux library version
- foreignLibModDefFile :: [FilePath]
  (Windows-specific) module definition files
  This is a list rather than a maybe field so that we can flatten the condition trees (for instance, when creating an sdist)

Instances14Eq, Data, Ord, Read, Show, Generic, …

Eq ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Data ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Ord ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Read ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Show ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Generic ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Semigroup ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Monoid ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
NFData ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Binary ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Structured ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
HasBuildInfo ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
FromBuildInfo ForeignLibDefined in Cabal-syntax-3.12.1.0 · Distribution.PackageDescription.Parsec
type Rep ForeignLib = D1 ('MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "ForeignLib" 'PrefixI 'True) ((S1 ('MetaSel ('Just "foreignLibName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 UnqualComponentName) :*: (S1 ('MetaSel ('Just "foreignLibType") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 ForeignLibType) :*: S1 ('MetaSel ('Just "foreignLibOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [ForeignLibOption]))) :*: ((S1 ('MetaSel ('Just "foreignLibBuildInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 BuildInfo) :*: S1 ('MetaSel ('Just "foreignLibVersionInfo") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe LibVersionInfo))) :*: (S1 ('MetaSel ('Just "foreignLibVersionLinux") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 (Maybe Version)) :*: S1 ('MetaSel ('Just "foreignLibModDefFile") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 [FilePath])))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib

valueemptyForeignLib :: ForeignLib

An empty foreign library.

valueforeignLibModules :: ForeignLib -> [ModuleName]

Modules defined by a foreign library.

valueforeignLibIsShared :: ForeignLib -> Bool

Is the foreign library shared?

valueforeignLibVersion :: ForeignLib -> OS -> [Int]

Get a version number for a foreign library. If we're on Linux, and a Linux version is specified, use that. If we're on Linux, and libtool-style version-info is specified, translate that field into appropriate version numbers. Otherwise, this feature is unsupported so we don't return any version data.

datadata LibVersionInfo

Instances12Eq, Data, Ord, Read, Show, Generic, …

Eq LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Data LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Ord LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Read LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Show LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Generic LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
NFData LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Binary LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Parsec LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Pretty LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
Structured LibVersionInfoDefined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib
type Rep LibVersionInfo = D1 ('MetaData "LibVersionInfo" "Distribution.Types.ForeignLib" "Cabal-syntax-3.12.1.0-3adc" 'False) (C1 ('MetaCons "LibVersionInfo" 'PrefixI 'False) (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: (S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel 'Nothing 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int))))Defined in Cabal-syntax-3.12.1.0 · Distribution.Types.ForeignLib

valuemkLibVersionInfo :: (Int, Int, Int) -> LibVersionInfo

Construct LibVersionInfo from (current, revision, age) numbers.

For instance, mkLibVersionInfo (3,0,0) constructs a LibVersionInfo representing the version-info 3:0:0.

All version components must be non-negative.

valuelibVersionInfoCRA :: LibVersionInfo -> (Int, Int, Int)

From a given LibVersionInfo, extract the (current, revision, age) numbers.

valuelibVersionNumber :: LibVersionInfo -> (Int, Int, Int)

Given a version-info field, produce a major.minor.build version

valuelibVersionNumberShow :: LibVersionInfo -> String

Given a version-info field, return "major.minor.build" as a String

valuelibVersionMajor :: LibVersionInfo -> Int

Return the major version of a version-info field.