Safe Haskell	None
Language	Haskell2010

Distribution.Types.ForeignLib

Synopsis

data ForeignLib = ForeignLib {
- foreignLibName :: UnqualComponentName
- foreignLibType :: ForeignLibType
- foreignLibOptions :: [ForeignLibOption]
- foreignLibBuildInfo :: BuildInfo
- foreignLibVersionInfo :: Maybe LibVersionInfo
- foreignLibVersionLinux :: Maybe Version
- foreignLibModDefFile :: [RelativePath Source 'File]
}
emptyForeignLib :: ForeignLib
foreignLibModules :: ForeignLib -> [ModuleName]
foreignLibIsShared :: ForeignLib -> Bool
foreignLibVersion :: ForeignLib -> OS -> [Int]
data LibVersionInfo
mkLibVersionInfo :: (Int, Int, Int) -> LibVersionInfo
libVersionInfoCRA :: LibVersionInfo -> (Int, Int, Int)
libVersionNumber :: LibVersionInfo -> (Int, Int, Int)
libVersionNumberShow :: LibVersionInfo -> String
libVersionMajor :: LibVersionInfo -> Int

Documentation

data ForeignLib Source #

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 :: [RelativePath Source 'File]
(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

Instances details

HasBuildInfo ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

buildInfo :: Lens' ForeignLib BuildInfo Source #

buildable :: Lens' ForeignLib Bool Source #

buildTools :: Lens' ForeignLib [LegacyExeDependency] Source #

buildToolDepends :: Lens' ForeignLib [ExeDependency] Source #

cppOptions :: Lens' ForeignLib [String] Source #

asmOptions :: Lens' ForeignLib [String] Source #

cmmOptions :: Lens' ForeignLib [String] Source #

ccOptions :: Lens' ForeignLib [String] Source #

cxxOptions :: Lens' ForeignLib [String] Source #

ldOptions :: Lens' ForeignLib [String] Source #

hsc2hsOptions :: Lens' ForeignLib [String] Source #

pkgconfigDepends :: Lens' ForeignLib [PkgconfigDependency] Source #

frameworks :: Lens' ForeignLib [RelativePath Framework 'File] Source #

extraFrameworkDirs :: Lens' ForeignLib [SymbolicPath Pkg ('Dir Framework)] Source #

asmSources :: Lens' ForeignLib [SymbolicPath Pkg 'File] Source #

cmmSources :: Lens' ForeignLib [SymbolicPath Pkg 'File] Source #

cSources :: Lens' ForeignLib [SymbolicPath Pkg 'File] Source #

cxxSources :: Lens' ForeignLib [SymbolicPath Pkg 'File] Source #

jsSources :: Lens' ForeignLib [SymbolicPath Pkg 'File] Source #

hsSourceDirs :: Lens' ForeignLib [SymbolicPath Pkg ('Dir Source)] Source #

otherModules :: Lens' ForeignLib [ModuleName] Source #

virtualModules :: Lens' ForeignLib [ModuleName] Source #

autogenModules :: Lens' ForeignLib [ModuleName] Source #

defaultLanguage :: Lens' ForeignLib (Maybe Language) Source #

otherLanguages :: Lens' ForeignLib [Language] Source #

defaultExtensions :: Lens' ForeignLib [Extension] Source #

otherExtensions :: Lens' ForeignLib [Extension] Source #

oldExtensions :: Lens' ForeignLib [Extension] Source #

extraLibs :: Lens' ForeignLib [String] Source #

extraLibsStatic :: Lens' ForeignLib [String] Source #

extraGHCiLibs :: Lens' ForeignLib [String] Source #

extraBundledLibs :: Lens' ForeignLib [String] Source #

extraLibFlavours :: Lens' ForeignLib [String] Source #

extraDynLibFlavours :: Lens' ForeignLib [String] Source #

extraLibDirs :: Lens' ForeignLib [SymbolicPath Pkg ('Dir Lib)] Source #

extraLibDirsStatic :: Lens' ForeignLib [SymbolicPath Pkg ('Dir Lib)] Source #

includeDirs :: Lens' ForeignLib [SymbolicPath Pkg ('Dir Include)] Source #

includes :: Lens' ForeignLib [SymbolicPath Include 'File] Source #

autogenIncludes :: Lens' ForeignLib [RelativePath Include 'File] Source #

installIncludes :: Lens' ForeignLib [RelativePath Include 'File] Source #

options :: Lens' ForeignLib (PerCompilerFlavor [String]) Source #

profOptions :: Lens' ForeignLib (PerCompilerFlavor [String]) Source #

sharedOptions :: Lens' ForeignLib (PerCompilerFlavor [String]) Source #

profSharedOptions :: Lens' ForeignLib (PerCompilerFlavor [String]) Source #

staticOptions :: Lens' ForeignLib (PerCompilerFlavor [String]) Source #

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

targetBuildDepends :: Lens' ForeignLib [Dependency] Source #

mixins :: Lens' ForeignLib [Mixin] Source #

Structured ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

structure :: Proxy ForeignLib -> Structure Source #

structureHash' :: Tagged ForeignLib MD5

Binary ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

put :: ForeignLib -> Put Source #

get :: Get ForeignLib Source #

putList :: [ForeignLib] -> Put Source #

NFData ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

rnf :: ForeignLib -> () Source #

Monoid ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

mempty :: ForeignLib #

mappend :: ForeignLib -> ForeignLib -> ForeignLib #

mconcat :: [ForeignLib] -> ForeignLib #

Semigroup ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

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

sconcat :: NonEmpty ForeignLib -> ForeignLib #

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

Data ForeignLib Source #

Instance details

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 :: forall r r'. (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 #

Generic ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Associated Types

type Rep ForeignLib

Instance details

Defined in Distribution.Types.ForeignLib

type Rep ForeignLib = D1 ('MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-syntax-3.14.0.0-395c" '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 [RelativePath Source 'File])))))

Methods

from :: ForeignLib -> Rep ForeignLib x #

to :: Rep ForeignLib x -> ForeignLib #

Read ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

readsPrec :: Int -> ReadS ForeignLib #

readList :: ReadS [ForeignLib] #

readPrec :: ReadPrec ForeignLib #

readListPrec :: ReadPrec [ForeignLib] #

Show ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

showsPrec :: Int -> ForeignLib -> ShowS #

show :: ForeignLib -> String #

showList :: [ForeignLib] -> ShowS #

Eq ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

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

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

Ord ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

Methods

compare :: ForeignLib -> ForeignLib -> Ordering #

(<) :: ForeignLib -> ForeignLib -> Bool #

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

(>) :: ForeignLib -> ForeignLib -> Bool #

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

max :: ForeignLib -> ForeignLib -> ForeignLib #

min :: ForeignLib -> ForeignLib -> ForeignLib #

type Rep ForeignLib Source #

Instance details

Defined in Distribution.Types.ForeignLib

type Rep ForeignLib = D1 ('MetaData "ForeignLib" "Distribution.Types.ForeignLib" "Cabal-syntax-3.14.0.0-395c" '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 [RelativePath Source 'File])))))

emptyForeignLib :: ForeignLib Source #

An empty foreign library.

foreignLibModules :: ForeignLib -> [ModuleName] Source #

Modules defined by a foreign library.

foreignLibIsShared :: ForeignLib -> Bool Source #

Is the foreign library shared?

foreignLibVersion :: ForeignLib -> OS -> [Int] Source #

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 Source #