Safe Haskell	None
Language	Haskell2010

Distribution.Types.ForeignLib

Synopsis

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 #
Methods (==) :: ForeignLib -> ForeignLib -> Bool # (/=) :: ForeignLib -> ForeignLib -> Bool #
Data 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 #
Methods readsPrec :: Int -> ReadS ForeignLib # readList :: ReadS [ForeignLib] # readPrec :: ReadPrec ForeignLib # readListPrec :: ReadPrec [ForeignLib] #
Show ForeignLib #
Methods showsPrec :: Int -> ForeignLib -> ShowS # show :: ForeignLib -> String # showList :: [ForeignLib] -> ShowS #
Generic ForeignLib #
Associated Types type Rep ForeignLib :: * -> * # Methods from :: ForeignLib -> Rep ForeignLib x # to :: Rep ForeignLib x -> ForeignLib #
Semigroup ForeignLib #
Methods (<>) :: ForeignLib -> ForeignLib -> ForeignLib # sconcat :: NonEmpty ForeignLib -> ForeignLib # stimes :: Integral b => b -> ForeignLib -> ForeignLib #
Monoid ForeignLib #
Methods mempty :: ForeignLib # mappend :: ForeignLib -> ForeignLib -> ForeignLib # mconcat :: [ForeignLib] -> ForeignLib #
Binary ForeignLib #
Methods put :: ForeignLib -> Put # get :: Get ForeignLib # putList :: [ForeignLib] -> Put #
type Rep ForeignLib #
type Rep ForeignLib = D1 * (MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-2.0.1.1-ARIl7MGNKZFBAH1HVzpC6s" False) (C1 * (MetaCons "ForeignLib" PrefixI True) ((::) ((::) (S1 * (MetaSel (Just Symbol "foreignLibName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * UnqualComponentName)) ((::) (S1 * (MetaSel (Just Symbol "foreignLibType") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * ForeignLibType)) (S1 * (MetaSel (Just Symbol "foreignLibOptions") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * [ForeignLibOption])))) ((::) ((::) (S1 * (MetaSel (Just Symbol "foreignLibBuildInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * BuildInfo)) (S1 * (MetaSel (Just Symbol "foreignLibVersionInfo") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe LibVersionInfo)))) ((::) (S1 * (MetaSel (Just Symbol "foreignLibVersionLinux") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * (Maybe Version))) (S1 * (MetaSel (Just Symbol "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 #
Methods (==) :: LibVersionInfo -> LibVersionInfo -> Bool # (/=) :: LibVersionInfo -> LibVersionInfo -> Bool #
Data LibVersionInfo #
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 #
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 #
Methods readsPrec :: Int -> ReadS LibVersionInfo # readList :: ReadS [LibVersionInfo] # readPrec :: ReadPrec LibVersionInfo # readListPrec :: ReadPrec [LibVersionInfo] #
Show LibVersionInfo #
Methods showsPrec :: Int -> LibVersionInfo -> ShowS # show :: LibVersionInfo -> String # showList :: [LibVersionInfo] -> ShowS #
Generic LibVersionInfo #
Associated Types type Rep LibVersionInfo :: * -> * # Methods from :: LibVersionInfo -> Rep LibVersionInfo x # to :: Rep LibVersionInfo x -> LibVersionInfo #
Binary LibVersionInfo #
Methods put :: LibVersionInfo -> Put # get :: Get LibVersionInfo # putList :: [LibVersionInfo] -> Put #
Text LibVersionInfo #
Methods disp :: LibVersionInfo -> Doc # parse :: ReadP r LibVersionInfo #
type Rep LibVersionInfo #
type Rep LibVersionInfo = D1 * (MetaData "LibVersionInfo" "Distribution.Types.ForeignLib" "Cabal-2.0.1.1-ARIl7MGNKZFBAH1HVzpC6s" False) (C1 * (MetaCons "LibVersionInfo" PrefixI False) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) ((::) (S1 * (MetaSel (Nothing Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 * Int)) (S1 * (MetaSel (Nothing 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.