Hpack.Config

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

Constructors

DecodeOptions

Fields

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

defaultDecodeOptions :: DecodeOptions

packageConfig :: FilePath

data DecodeResult

Constructors

DecodeResult

Fields

• decodeResultPackage :: Package
• decodeResultCabalFile :: FilePath
• decodeResultWarnings :: [String]

Instances

Eq DecodeResult

Methods

(==) :: DecodeResult -> DecodeResult -> Bool

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

Show DecodeResult

Methods

showsPrec :: Int -> DecodeResult -> ShowS

show :: DecodeResult -> String

showList :: [DecodeResult] -> ShowS

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

renamePackage :: String -> Package -> Package

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

package :: String -> String -> Package

section :: a -> Section a

data Package

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

Methods

(==) :: Package -> Package -> Bool

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

Show Package

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

newtype Dependencies

Constructors

Dependencies

Fields

• unDependencies :: Map String DependencyVersion

Instances

IsList Dependencies

Associated Types

type Item Dependencies :: *

Methods

fromList :: [Item Dependencies] -> Dependencies

fromListN :: Int -> [Item Dependencies] -> Dependencies

toList :: Dependencies -> [Item Dependencies]

Eq Dependencies

Methods

(==) :: Dependencies -> Dependencies -> Bool

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

Show Dependencies

Methods

showsPrec :: Int -> Dependencies -> ShowS

show :: Dependencies -> String

showList :: [Dependencies] -> ShowS

Semigroup Dependencies

Methods

(<>) :: Dependencies -> Dependencies -> Dependencies

sconcat :: NonEmpty Dependencies -> Dependencies

stimes :: Integral b => b -> Dependencies -> Dependencies

Monoid Dependencies

Methods

mempty :: Dependencies

mappend :: Dependencies -> Dependencies -> Dependencies

mconcat :: [Dependencies] -> Dependencies

type Item Dependencies

type Item Dependencies = (String, DependencyVersion)

data DependencyVersion

Constructors

AnyVersion

VersionRange String

SourceDependency SourceDependency

Instances

Eq DependencyVersion

Methods

(==) :: DependencyVersion -> DependencyVersion -> Bool

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

Show DependencyVersion

Methods

showsPrec :: Int -> DependencyVersion -> ShowS

show :: DependencyVersion -> String

showList :: [DependencyVersion] -> ShowS

data SourceDependency

Constructors

GitRef GitUrl GitRef (Maybe FilePath)

Local FilePath

Instances

Eq SourceDependency

Methods

(==) :: SourceDependency -> SourceDependency -> Bool

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

Show SourceDependency

Methods

showsPrec :: Int -> SourceDependency -> ShowS

show :: SourceDependency -> String

showList :: [SourceDependency] -> ShowS

type GitRef = String

type GitUrl = String

type GhcOption = String

data Verbatim

Constructors

VerbatimLiteral String

VerbatimObject (Map String VerbatimValue)

Instances

Eq Verbatim

Methods

(==) :: Verbatim -> Verbatim -> Bool

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

Show Verbatim

Methods

showsPrec :: Int -> Verbatim -> ShowS

show :: Verbatim -> String

showList :: [Verbatim] -> ShowS

data VerbatimValue

Constructors

VerbatimString String

VerbatimNumber Scientific

VerbatimBool Bool

VerbatimNull

Instances

Eq VerbatimValue

Methods

(==) :: VerbatimValue -> VerbatimValue -> Bool

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

Show VerbatimValue

Methods

showsPrec :: Int -> VerbatimValue -> ShowS

show :: VerbatimValue -> String

showList :: [VerbatimValue] -> ShowS

data CustomSetup

Constructors

CustomSetup

Fields

• customSetupDependencies :: Dependencies

Instances

Eq CustomSetup

Methods

(==) :: CustomSetup -> CustomSetup -> Bool

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

Show CustomSetup

Methods

showsPrec :: Int -> CustomSetup -> ShowS

show :: CustomSetup -> String

showList :: [CustomSetup] -> ShowS

data Section a

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

Methods

fmap :: (a -> b) -> Section a -> Section b

(<$) :: a -> Section b -> Section a

Foldable Section

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

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)

Methods

(==) :: Section a -> Section a -> Bool

(/=) :: Section a -> Section a -> Bool

Show a => Show (Section a)

Methods

showsPrec :: Int -> Section a -> ShowS

show :: Section a -> String

showList :: [Section a] -> ShowS

data Library

Constructors

Library

Fields

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

Instances

Eq Library

Methods

(==) :: Library -> Library -> Bool

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

Show Library

Methods

showsPrec :: Int -> Library -> ShowS

show :: Library -> String

showList :: [Library] -> ShowS

data Executable

Constructors

Executable

Fields

• executableMain :: Maybe FilePath
• executableOtherModules :: [String]
• executableGeneratedModules :: [String]

Instances

Eq Executable

Methods

(==) :: Executable -> Executable -> Bool

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

Show Executable

Methods

showsPrec :: Int -> Executable -> ShowS

show :: Executable -> String

showList :: [Executable] -> ShowS

data Conditional a

Constructors

Conditional

Fields

• conditionalCondition :: String
• conditionalThen :: a
• conditionalElse :: Maybe a

Instances

Functor Conditional

Methods

fmap :: (a -> b) -> Conditional a -> Conditional b

(<$) :: a -> Conditional b -> Conditional a

Foldable Conditional

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

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)

Methods

(==) :: Conditional a -> Conditional a -> Bool

(/=) :: Conditional a -> Conditional a -> Bool

Show a => Show (Conditional a)

Methods

showsPrec :: Int -> Conditional a -> ShowS

show :: Conditional a -> String

showList :: [Conditional a] -> ShowS

data Flag

Constructors

Flag

Fields

• flagName :: String
• flagDescription :: Maybe String
• flagManual :: Bool
• flagDefault :: Bool

Instances

Eq Flag

Methods

(==) :: Flag -> Flag -> Bool

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

Show Flag

Methods

showsPrec :: Int -> Flag -> ShowS

show :: Flag -> String

showList :: [Flag] -> ShowS

data SourceRepository

Constructors

SourceRepository

Fields

• sourceRepositoryUrl :: String
• sourceRepositorySubdir :: Maybe String

Instances

Eq SourceRepository

Methods

(==) :: SourceRepository -> SourceRepository -> Bool

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

Show SourceRepository

Methods

showsPrec :: Int -> SourceRepository -> ShowS

show :: SourceRepository -> String

showList :: [SourceRepository] -> ShowS

data BuildType

Constructors

Simple

Configure

Make

Custom

Instances

Bounded BuildType

Methods

minBound :: BuildType

maxBound :: BuildType

Enum BuildType

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

Methods

(==) :: BuildType -> BuildType -> Bool

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

Show BuildType

Methods

showsPrec :: Int -> BuildType -> ShowS

show :: BuildType -> String

showList :: [BuildType] -> ShowS

Generic BuildType

Associated Types

type Rep BuildType :: * -> *

Methods

from :: BuildType -> Rep BuildType x

to :: Rep BuildType x -> BuildType

type Rep BuildType

type Rep BuildType = D1 * (MetaData "BuildType" "Hpack.Config" "hpack-0.28.2-Lr8GXjNdcJIGcszWHsTbHo" 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

type GhcjsOption = String

type CppOption = String

type CcOption = String

type LdOption = String