Distribution.Types.ForeignLib

Documentation

data 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

Fields

• 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)

Instances

Eq ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

(==) :: ForeignLib -> ForeignLib -> Bool

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

Data ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

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

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

toConstr :: ForeignLib -> Constr

dataTypeOf :: ForeignLib -> DataType

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

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

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

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

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

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

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

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

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

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

Read ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

readsPrec :: Int -> ReadS ForeignLib

readList :: ReadS [ForeignLib]

readPrec :: ReadPrec ForeignLib

readListPrec :: ReadPrec [ForeignLib]

Show ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

showsPrec :: Int -> ForeignLib -> ShowS

show :: ForeignLib -> String

showList :: [ForeignLib] -> ShowS

Generic ForeignLib

Defined in Distribution.Types.ForeignLib

Associated Types

type Rep ForeignLib :: Type -> Type

Methods

from :: ForeignLib -> Rep ForeignLib x

to :: Rep ForeignLib x -> ForeignLib

Semigroup ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

(<>) :: ForeignLib -> ForeignLib -> ForeignLib

sconcat :: NonEmpty ForeignLib -> ForeignLib

stimes :: Integral b => b -> ForeignLib -> ForeignLib

Monoid ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

mempty :: ForeignLib

mappend :: ForeignLib -> ForeignLib -> ForeignLib

mconcat :: [ForeignLib] -> ForeignLib

Binary ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

put :: ForeignLib -> Put

get :: Get ForeignLib

putList :: [ForeignLib] -> Put

NFData ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

rnf :: ForeignLib -> ()

HasBuildInfo ForeignLib

Defined in Distribution.Types.ForeignLib

Methods

buildInfo :: Lens' ForeignLib BuildInfo

buildable :: Lens' ForeignLib Bool

buildTools :: Lens' ForeignLib [LegacyExeDependency]

buildToolDepends :: Lens' ForeignLib [ExeDependency]

cppOptions :: Lens' ForeignLib [String]

asmOptions :: Lens' ForeignLib [String]

cmmOptions :: Lens' ForeignLib [String]

ccOptions :: Lens' ForeignLib [String]

cxxOptions :: Lens' ForeignLib [String]

ldOptions :: Lens' ForeignLib [String]

pkgconfigDepends :: Lens' ForeignLib [PkgconfigDependency]

frameworks :: Lens' ForeignLib [String]

extraFrameworkDirs :: Lens' ForeignLib [String]

asmSources :: Lens' ForeignLib [FilePath]

cmmSources :: Lens' ForeignLib [FilePath]

cSources :: Lens' ForeignLib [FilePath]

cxxSources :: Lens' ForeignLib [FilePath]

jsSources :: Lens' ForeignLib [FilePath]

hsSourceDirs :: Lens' ForeignLib [FilePath]

otherModules :: Lens' ForeignLib [ModuleName]

virtualModules :: Lens' ForeignLib [ModuleName]

autogenModules :: Lens' ForeignLib [ModuleName]

defaultLanguage :: Lens' ForeignLib (Maybe Language)

otherLanguages :: Lens' ForeignLib [Language]

defaultExtensions :: Lens' ForeignLib [Extension]

otherExtensions :: Lens' ForeignLib [Extension]

oldExtensions :: Lens' ForeignLib [Extension]

extraLibs :: Lens' ForeignLib [String]

extraGHCiLibs :: Lens' ForeignLib [String]

extraBundledLibs :: Lens' ForeignLib [String]

extraLibFlavours :: Lens' ForeignLib [String]

extraLibDirs :: Lens' ForeignLib [String]

includeDirs :: Lens' ForeignLib [FilePath]

includes :: Lens' ForeignLib [FilePath]

installIncludes :: Lens' ForeignLib [FilePath]

options :: Lens' ForeignLib [(CompilerFlavor, [String])]

profOptions :: Lens' ForeignLib [(CompilerFlavor, [String])]

sharedOptions :: Lens' ForeignLib [(CompilerFlavor, [String])]

staticOptions :: Lens' ForeignLib [(CompilerFlavor, [String])]

customFieldsBI :: Lens' ForeignLib [(String, String)]

targetBuildDepends :: Lens' ForeignLib [Dependency]

mixins :: Lens' ForeignLib [Mixin]

type Rep ForeignLib

Defined in Distribution.Types.ForeignLib

type Rep ForeignLib = D1 (MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-2.4.1.0-B0ZPupqxKZe72LoceK3cGA" 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])))))

emptyForeignLib :: ForeignLib

An empty foreign library.

foreignLibModules :: ForeignLib -> [ModuleName]

Modules defined by a foreign library.

foreignLibIsShared :: ForeignLib -> Bool

Is the foreign library shared?

foreignLibVersion :: 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.

data LibVersionInfo

Instances

Eq LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

(==) :: LibVersionInfo -> LibVersionInfo -> Bool

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

Data LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

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

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

toConstr :: LibVersionInfo -> Constr

dataTypeOf :: LibVersionInfo -> DataType

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

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

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

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

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

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

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

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

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

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

Ord LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

compare :: LibVersionInfo -> LibVersionInfo -> Ordering

(<) :: LibVersionInfo -> LibVersionInfo -> Bool

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

(>) :: LibVersionInfo -> LibVersionInfo -> Bool

(>=) :: LibVersionInfo -> LibVersionInfo -> Bool

max :: LibVersionInfo -> LibVersionInfo -> LibVersionInfo

min :: LibVersionInfo -> LibVersionInfo -> LibVersionInfo

Read LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

readsPrec :: Int -> ReadS LibVersionInfo

readList :: ReadS [LibVersionInfo]

readPrec :: ReadPrec LibVersionInfo

readListPrec :: ReadPrec [LibVersionInfo]

Show LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

showsPrec :: Int -> LibVersionInfo -> ShowS

show :: LibVersionInfo -> String

showList :: [LibVersionInfo] -> ShowS

Generic LibVersionInfo

Defined in Distribution.Types.ForeignLib

Associated Types

type Rep LibVersionInfo :: Type -> Type

Methods

from :: LibVersionInfo -> Rep LibVersionInfo x

to :: Rep LibVersionInfo x -> LibVersionInfo

Binary LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

put :: LibVersionInfo -> Put

get :: Get LibVersionInfo

putList :: [LibVersionInfo] -> Put

NFData LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

rnf :: LibVersionInfo -> ()

Pretty LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

pretty :: LibVersionInfo -> Doc

Parsec LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

parsec :: CabalParsing m => m LibVersionInfo

Text LibVersionInfo

Defined in Distribution.Types.ForeignLib

Methods

disp :: LibVersionInfo -> Doc

parse :: ReadP r LibVersionInfo

type Rep LibVersionInfo

Defined in Distribution.Types.ForeignLib

type Rep LibVersionInfo = D1 (MetaData "LibVersionInfo" "Distribution.Types.ForeignLib" "Cabal-2.4.1.0-B0ZPupqxKZe72LoceK3cGA" False) (C1 (MetaCons "LibVersionInfo" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int) :*: S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 Int))))

mkLibVersionInfo :: (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.

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

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

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

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

libVersionNumberShow :: LibVersionInfo -> String

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

libVersionMajor :: LibVersionInfo -> Int

Return the major version of a version-info field.