Safe Haskell	None
Language	Haskell2010

Hpack.Config

Synopsis

data DecodeOptions = DecodeOptions {
- decodeOptionsTarget :: FilePath
- decodeOptionsUserDataDir :: Maybe FilePath
- decodeOptionsDecode :: FilePath -> IO (Either String Value)
}
defaultDecodeOptions :: DecodeOptions
packageConfig :: FilePath
data DecodeResult = DecodeResult {
- decodeResultPackage :: Package
- decodeResultCabalFile :: FilePath
- decodeResultWarnings :: [String]
}
readPackageConfig :: DecodeOptions -> IO (Either String DecodeResult)
renamePackage :: String -> Package -> Package
packageDependencies :: Package -> [(String, DependencyVersion)]
package :: String -> String -> Package
section :: a -> Section a
data Package = Package {
- packageName :: String
- packageVersion :: String
- packageSynopsis :: Maybe String
- packageDescription :: Maybe String
- packageHomepage :: Maybe String
- packageBugReports :: Maybe String
- packageCategory :: Maybe String
- packageStability :: Maybe String
- packageAuthor :: [String]
- packageMaintainer :: [String]
- packageCopyright :: [String]
- packageBuildType :: BuildType
- packageLicense :: Maybe String
- packageLicenseFile :: [FilePath]
- packageTestedWith :: Maybe String
- packageFlags :: [Flag]
- packageExtraSourceFiles :: [FilePath]
- packageExtraDocFiles :: [FilePath]
- packageDataFiles :: [FilePath]
- packageDataDir :: Maybe FilePath
- packageSourceRepository :: Maybe SourceRepository
- packageCustomSetup :: Maybe CustomSetup
- packageLibrary :: Maybe (Section Library)
- packageInternalLibraries :: Map String (Section Library)
- packageExecutables :: Map String (Section Executable)
- packageTests :: Map String (Section Executable)
- packageBenchmarks :: Map String (Section Executable)
- packageVerbatim :: [Verbatim]
}
newtype Dependencies = Dependencies {
- unDependencies :: Map String DependencyVersion
}
data DependencyVersion
- = AnyVersion
- | VersionRange String
- | SourceDependency SourceDependency
data SourceDependency
- = GitRef GitUrl GitRef (Maybe FilePath)
- | Local FilePath
type GitRef = String
type GitUrl = String
type GhcOption = String
data Verbatim
- = VerbatimLiteral String
- | VerbatimObject (Map String VerbatimValue)
data VerbatimValue
- = VerbatimString String
- | VerbatimNumber Scientific
- | VerbatimBool Bool
- | VerbatimNull
data CustomSetup = CustomSetup {
- customSetupDependencies :: Dependencies
}
data Section a = Section {
- sectionData :: a
- sectionSourceDirs :: [FilePath]
- sectionDependencies :: Dependencies
- sectionPkgConfigDependencies :: [String]
- sectionDefaultExtensions :: [String]
- sectionOtherExtensions :: [String]
- sectionGhcOptions :: [GhcOption]
- sectionGhcProfOptions :: [GhcProfOption]
- sectionGhcjsOptions :: [GhcjsOption]
- sectionCppOptions :: [CppOption]
- sectionCcOptions :: [CcOption]
- sectionCSources :: [FilePath]
- sectionCxxOptions :: [CxxOption]
- sectionCxxSources :: [FilePath]
- sectionJsSources :: [FilePath]
- sectionExtraLibDirs :: [FilePath]
- sectionExtraLibraries :: [FilePath]
- sectionExtraFrameworksDirs :: [FilePath]
- sectionFrameworks :: [FilePath]
- sectionIncludeDirs :: [FilePath]
- sectionInstallIncludes :: [FilePath]
- sectionLdOptions :: [LdOption]
- sectionBuildable :: Maybe Bool
- sectionConditionals :: [Conditional (Section a)]
- sectionBuildTools :: Dependencies
- sectionVerbatim :: [Verbatim]
}
data Library = Library {
- libraryExposed :: Maybe Bool
- libraryExposedModules :: [String]
- libraryOtherModules :: [String]
- libraryGeneratedModules :: [String]
- libraryReexportedModules :: [String]
- librarySignatures :: [String]
}
data Executable = Executable {
- executableMain :: Maybe FilePath
- executableOtherModules :: [String]
- executableGeneratedModules :: [String]
}
data Conditional a = Conditional {
- conditionalCondition :: String
- conditionalThen :: a
- conditionalElse :: Maybe a
}
data Flag = Flag {
- flagName :: String
- flagDescription :: Maybe String
- flagManual :: Bool
- flagDefault :: Bool
}
data SourceRepository = SourceRepository {
- sourceRepositoryUrl :: String
- sourceRepositorySubdir :: Maybe String
}
data BuildType
- = Simple
- | Configure
- | Make
- | Custom
type GhcProfOption = String
type GhcjsOption = String
type CppOption = String
type CcOption = String
type LdOption = String

Documentation

NOTE: This module is exposed to allow integration of Hpack into other tools. It is not meant for general use by end users. The following caveats apply:

The API is undocumented, consult the source instead.
The exposed types and functions primarily serve Hpack's own needs, not that of a public API. Breaking changes can happen as Hpack evolves.

As an Hpack user you either want to use the hpack executable or a build tool that supports Hpack (e.g. stack or cabal2nix).

data DecodeOptions Source #

Constructors

DecodeOptions
Fields decodeOptionsTarget :: FilePath decodeOptionsUserDataDir :: Maybe FilePath decodeOptionsDecode :: FilePath -> IO (Either String Value)

defaultDecodeOptions :: DecodeOptions Source #

packageConfig :: FilePath Source #

data DecodeResult Source #

Constructors

DecodeResult
Fields decodeResultPackage :: Package decodeResultCabalFile :: FilePath decodeResultWarnings :: [String]

Instances

Eq DecodeResult Source #
Instance details Defined in Hpack.Config Methods (==) :: DecodeResult -> DecodeResult -> Bool # (/=) :: DecodeResult -> DecodeResult -> Bool #
Show DecodeResult Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> DecodeResult -> ShowS # show :: DecodeResult -> String # showList :: [DecodeResult] -> ShowS #

readPackageConfig :: DecodeOptions -> IO (Either String DecodeResult) Source #

renamePackage :: String -> Package -> Package Source #

packageDependencies :: Package -> [(String, DependencyVersion)] Source #

package :: String -> String -> Package Source #

section :: a -> Section a Source #

data Package Source #

Constructors

Package

Fields

packageName :: String
packageVersion :: String
packageSynopsis :: Maybe String
packageDescription :: Maybe String
packageHomepage :: Maybe String
packageBugReports :: Maybe String
packageCategory :: Maybe String
packageStability :: Maybe String
packageAuthor :: [String]
packageMaintainer :: [String]
packageCopyright :: [String]
packageBuildType :: BuildType
packageLicense :: Maybe String
packageLicenseFile :: [FilePath]
packageTestedWith :: Maybe String
packageFlags :: [Flag]
packageExtraSourceFiles :: [FilePath]
packageExtraDocFiles :: [FilePath]
packageDataFiles :: [FilePath]
packageDataDir :: Maybe FilePath
packageSourceRepository :: Maybe SourceRepository
packageCustomSetup :: Maybe CustomSetup
packageLibrary :: Maybe (Section Library)
packageInternalLibraries :: Map String (Section Library)
packageExecutables :: Map String (Section Executable)
packageTests :: Map String (Section Executable)
packageBenchmarks :: Map String (Section Executable)
packageVerbatim :: [Verbatim]

Instances

Eq Package Source #
Instance details Defined in Hpack.Config Methods (==) :: Package -> Package -> Bool # (/=) :: Package -> Package -> Bool #
Show Package Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Package -> ShowS # show :: Package -> String # showList :: [Package] -> ShowS #

newtype Dependencies Source #

Constructors

Dependencies
Fields unDependencies :: Map String DependencyVersion

Instances

IsList Dependencies Source #
Instance details Defined in Hpack.Syntax.Dependency Associated Types type Item Dependencies :: * # Methods fromList :: [Item Dependencies] -> Dependencies # fromListN :: Int -> [Item Dependencies] -> Dependencies # toList :: Dependencies -> [Item Dependencies] #
Eq Dependencies Source #
Instance details Defined in Hpack.Syntax.Dependency Methods (==) :: Dependencies -> Dependencies -> Bool # (/=) :: Dependencies -> Dependencies -> Bool #
Show Dependencies Source #
Instance details Defined in Hpack.Syntax.Dependency Methods showsPrec :: Int -> Dependencies -> ShowS # show :: Dependencies -> String # showList :: [Dependencies] -> ShowS #
Semigroup Dependencies Source #
Instance details Defined in Hpack.Syntax.Dependency Methods (<>) :: Dependencies -> Dependencies -> Dependencies # sconcat :: NonEmpty Dependencies -> Dependencies # stimes :: Integral b => b -> Dependencies -> Dependencies #
Monoid Dependencies Source #
Instance details Defined in Hpack.Syntax.Dependency Methods mempty :: Dependencies # mappend :: Dependencies -> Dependencies -> Dependencies # mconcat :: [Dependencies] -> Dependencies #
type Item Dependencies Source #
Instance details Defined in Hpack.Syntax.Dependency type Item Dependencies = (String, DependencyVersion)

data DependencyVersion Source #

Constructors

AnyVersion
VersionRange String
SourceDependency SourceDependency

Instances

Eq DependencyVersion Source #
Instance details Defined in Hpack.Syntax.Dependency Methods (==) :: DependencyVersion -> DependencyVersion -> Bool # (/=) :: DependencyVersion -> DependencyVersion -> Bool #
Show DependencyVersion Source #
Instance details Defined in Hpack.Syntax.Dependency Methods showsPrec :: Int -> DependencyVersion -> ShowS # show :: DependencyVersion -> String # showList :: [DependencyVersion] -> ShowS #

data SourceDependency Source #

Constructors

GitRef GitUrl GitRef (Maybe FilePath)
Local FilePath

Instances

Eq SourceDependency Source #
Instance details Defined in Hpack.Syntax.Dependency Methods (==) :: SourceDependency -> SourceDependency -> Bool # (/=) :: SourceDependency -> SourceDependency -> Bool #
Show SourceDependency Source #
Instance details Defined in Hpack.Syntax.Dependency Methods showsPrec :: Int -> SourceDependency -> ShowS # show :: SourceDependency -> String # showList :: [SourceDependency] -> ShowS #

type GitRef = String Source #

type GitUrl = String Source #

type GhcOption = String Source #

data Verbatim Source #

Constructors

VerbatimLiteral String
VerbatimObject (Map String VerbatimValue)

Instances

Eq Verbatim Source #
Instance details Defined in Hpack.Config Methods (==) :: Verbatim -> Verbatim -> Bool # (/=) :: Verbatim -> Verbatim -> Bool #
Show Verbatim Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Verbatim -> ShowS # show :: Verbatim -> String # showList :: [Verbatim] -> ShowS #

data VerbatimValue Source #

Constructors

VerbatimString String
VerbatimNumber Scientific
VerbatimBool Bool
VerbatimNull

Instances

Eq VerbatimValue Source #
Instance details Defined in Hpack.Config Methods (==) :: VerbatimValue -> VerbatimValue -> Bool # (/=) :: VerbatimValue -> VerbatimValue -> Bool #
Show VerbatimValue Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> VerbatimValue -> ShowS # show :: VerbatimValue -> String # showList :: [VerbatimValue] -> ShowS #

data CustomSetup Source #

Constructors

CustomSetup
Fields customSetupDependencies :: Dependencies

Instances

Eq CustomSetup Source #
Instance details Defined in Hpack.Config Methods (==) :: CustomSetup -> CustomSetup -> Bool # (/=) :: CustomSetup -> CustomSetup -> Bool #
Show CustomSetup Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> CustomSetup -> ShowS # show :: CustomSetup -> String # showList :: [CustomSetup] -> ShowS #

data Section a Source #

Constructors

Section

Fields

sectionData :: a
sectionSourceDirs :: [FilePath]
sectionDependencies :: Dependencies
sectionPkgConfigDependencies :: [String]
sectionDefaultExtensions :: [String]
sectionOtherExtensions :: [String]
sectionGhcOptions :: [GhcOption]
sectionGhcProfOptions :: [GhcProfOption]
sectionGhcjsOptions :: [GhcjsOption]
sectionCppOptions :: [CppOption]
sectionCcOptions :: [CcOption]
sectionCSources :: [FilePath]
sectionCxxOptions :: [CxxOption]
sectionCxxSources :: [FilePath]
sectionJsSources :: [FilePath]
sectionExtraLibDirs :: [FilePath]
sectionExtraLibraries :: [FilePath]
sectionExtraFrameworksDirs :: [FilePath]
sectionFrameworks :: [FilePath]
sectionIncludeDirs :: [FilePath]
sectionInstallIncludes :: [FilePath]
sectionLdOptions :: [LdOption]
sectionBuildable :: Maybe Bool
sectionConditionals :: [Conditional (Section a)]
sectionBuildTools :: Dependencies
sectionVerbatim :: [Verbatim]

Instances

Functor Section Source #
Instance details Defined in Hpack.Config Methods fmap :: (a -> b) -> Section a -> Section b # (<$) :: a -> Section b -> Section a #
Foldable Section Source #
Instance details Defined in Hpack.Config Methods fold :: Monoid m => Section m -> m # foldMap :: Monoid m => (a -> m) -> Section a -> m # foldr :: (a -> b -> b) -> b -> Section a -> b # foldr' :: (a -> b -> b) -> b -> Section a -> b # foldl :: (b -> a -> b) -> b -> Section a -> b # foldl' :: (b -> a -> b) -> b -> Section a -> b # foldr1 :: (a -> a -> a) -> Section a -> a # foldl1 :: (a -> a -> a) -> Section a -> a # toList :: Section a -> [a] # null :: Section a -> Bool # length :: Section a -> Int # elem :: Eq a => a -> Section a -> Bool # maximum :: Ord a => Section a -> a # minimum :: Ord a => Section a -> a # sum :: Num a => Section a -> a # product :: Num a => Section a -> a #
Traversable Section Source #
Instance details Defined in Hpack.Config Methods traverse :: Applicative f => (a -> f b) -> Section a -> f (Section b) # sequenceA :: Applicative f => Section (f a) -> f (Section a) # mapM :: Monad m => (a -> m b) -> Section a -> m (Section b) # sequence :: Monad m => Section (m a) -> m (Section a) #
Eq a => Eq (Section a) Source #
Instance details Defined in Hpack.Config Methods (==) :: Section a -> Section a -> Bool # (/=) :: Section a -> Section a -> Bool #
Show a => Show (Section a) Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Section a -> ShowS # show :: Section a -> String # showList :: [Section a] -> ShowS #

data Library Source #

Constructors

Library
Fields libraryExposed :: Maybe Bool libraryExposedModules :: [String] libraryOtherModules :: [String] libraryGeneratedModules :: [String] libraryReexportedModules :: [String] librarySignatures :: [String]

Instances

Eq Library Source #
Instance details Defined in Hpack.Config Methods (==) :: Library -> Library -> Bool # (/=) :: Library -> Library -> Bool #
Show Library Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Library -> ShowS # show :: Library -> String # showList :: [Library] -> ShowS #

data Executable Source #

Constructors

Executable
Fields executableMain :: Maybe FilePath executableOtherModules :: [String] executableGeneratedModules :: [String]

Instances

Eq Executable Source #
Instance details Defined in Hpack.Config Methods (==) :: Executable -> Executable -> Bool # (/=) :: Executable -> Executable -> Bool #
Show Executable Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Executable -> ShowS # show :: Executable -> String # showList :: [Executable] -> ShowS #

data Conditional a Source #

Constructors

Conditional
Fields conditionalCondition :: String conditionalThen :: a conditionalElse :: Maybe a

Instances

Functor Conditional Source #
Instance details Defined in Hpack.Config Methods fmap :: (a -> b) -> Conditional a -> Conditional b # (<$) :: a -> Conditional b -> Conditional a #
Foldable Conditional Source #
Instance details Defined in Hpack.Config Methods fold :: Monoid m => Conditional m -> m # foldMap :: Monoid m => (a -> m) -> Conditional a -> m # foldr :: (a -> b -> b) -> b -> Conditional a -> b # foldr' :: (a -> b -> b) -> b -> Conditional a -> b # foldl :: (b -> a -> b) -> b -> Conditional a -> b # foldl' :: (b -> a -> b) -> b -> Conditional a -> b # foldr1 :: (a -> a -> a) -> Conditional a -> a # foldl1 :: (a -> a -> a) -> Conditional a -> a # toList :: Conditional a -> [a] # null :: Conditional a -> Bool # length :: Conditional a -> Int # elem :: Eq a => a -> Conditional a -> Bool # maximum :: Ord a => Conditional a -> a # minimum :: Ord a => Conditional a -> a # sum :: Num a => Conditional a -> a # product :: Num a => Conditional a -> a #
Traversable Conditional Source #
Instance details Defined in Hpack.Config Methods traverse :: Applicative f => (a -> f b) -> Conditional a -> f (Conditional b) # sequenceA :: Applicative f => Conditional (f a) -> f (Conditional a) # mapM :: Monad m => (a -> m b) -> Conditional a -> m (Conditional b) # sequence :: Monad m => Conditional (m a) -> m (Conditional a) #
Eq a => Eq (Conditional a) Source #
Instance details Defined in Hpack.Config Methods (==) :: Conditional a -> Conditional a -> Bool # (/=) :: Conditional a -> Conditional a -> Bool #
Show a => Show (Conditional a) Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Conditional a -> ShowS # show :: Conditional a -> String # showList :: [Conditional a] -> ShowS #

data Flag Source #

Constructors

Flag
Fields flagName :: String flagDescription :: Maybe String flagManual :: Bool flagDefault :: Bool

Instances

Eq Flag Source #
Instance details Defined in Hpack.Config Methods (==) :: Flag -> Flag -> Bool # (/=) :: Flag -> Flag -> Bool #
Show Flag Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> Flag -> ShowS # show :: Flag -> String # showList :: [Flag] -> ShowS #

data SourceRepository Source #

Constructors

SourceRepository
Fields sourceRepositoryUrl :: String sourceRepositorySubdir :: Maybe String

Instances

Eq SourceRepository Source #
Instance details Defined in Hpack.Config Methods (==) :: SourceRepository -> SourceRepository -> Bool # (/=) :: SourceRepository -> SourceRepository -> Bool #
Show SourceRepository Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> SourceRepository -> ShowS # show :: SourceRepository -> String # showList :: [SourceRepository] -> ShowS #

data BuildType Source #

Constructors

Simple
Configure
Make
Custom

Instances

Bounded BuildType Source #
Instance details Defined in Hpack.Config Methods minBound :: BuildType # maxBound :: BuildType #
Enum BuildType Source #
Instance details Defined in Hpack.Config Methods succ :: BuildType -> BuildType # pred :: BuildType -> BuildType # toEnum :: Int -> BuildType # fromEnum :: BuildType -> Int # enumFrom :: BuildType -> [BuildType] # enumFromThen :: BuildType -> BuildType -> [BuildType] # enumFromTo :: BuildType -> BuildType -> [BuildType] # enumFromThenTo :: BuildType -> BuildType -> BuildType -> [BuildType] #
Eq BuildType Source #
Instance details Defined in Hpack.Config Methods (==) :: BuildType -> BuildType -> Bool # (/=) :: BuildType -> BuildType -> Bool #
Show BuildType Source #
Instance details Defined in Hpack.Config Methods showsPrec :: Int -> BuildType -> ShowS # show :: BuildType -> String # showList :: [BuildType] -> ShowS #
Generic BuildType Source #
Instance details Defined in Hpack.Config Associated Types type Rep BuildType :: * -> * # Methods from :: BuildType -> Rep BuildType x # to :: Rep BuildType x -> BuildType #
type Rep BuildType Source #
Instance details Defined in Hpack.Config type Rep BuildType = D1 (MetaData "BuildType" "Hpack.Config" "hpack-0.28.2-A5p9VUoOPNHIiAVaLxy16O" False) ((C1 (MetaCons "Simple" PrefixI False) (U1 :: * -> ) :+: C1 (MetaCons "Configure" PrefixI False) (U1 :: -> )) :+: (C1 (MetaCons "Make" PrefixI False) (U1 :: -> ) :+: C1 (MetaCons "Custom" PrefixI False) (U1 :: -> *)))

type GhcProfOption = String Source #

type GhcjsOption = String Source #

type CppOption = String Source #

type CcOption = String Source #

type LdOption = String Source #