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

• decodeOptionsProgramName :: ProgramName
• decodeOptionsTarget :: FilePath
• decodeOptionsUserDataDir :: Maybe FilePath
• decodeOptionsDecode :: FilePath -> IO (Either String ([String], Value))

newtype ProgramName

Constructors

ProgramName String

Instances

Eq ProgramName

Defined in Hpack.Config

Methods

(==) :: ProgramName -> ProgramName -> Bool

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

Show ProgramName

Defined in Hpack.Config

Methods

showsPrec :: Int -> ProgramName -> ShowS

show :: ProgramName -> String

showList :: [ProgramName] -> ShowS

IsString ProgramName

Defined in Hpack.Config

Methods

fromString :: String -> ProgramName

defaultDecodeOptions :: DecodeOptions

packageConfig :: FilePath

data DecodeResult

Constructors

DecodeResult

Fields

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

Instances

Eq DecodeResult

Defined in Hpack.Config

Methods

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

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

Show DecodeResult

Defined in Hpack.Config

Methods

showsPrec :: Int -> DecodeResult -> ShowS

show :: DecodeResult -> String

showList :: [DecodeResult] -> ShowS

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

renamePackage :: String -> Package -> Package

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

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

Defined in Hpack.Config

Methods

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

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

Show Package

Defined in Hpack.Config

Methods

showsPrec :: Int -> Package -> ShowS

show :: Package -> String

showList :: [Package] -> ShowS

newtype Dependencies

Constructors

Dependencies

Fields

• unDependencies :: Map String DependencyInfo

Instances

IsList Dependencies

Defined in Hpack.Syntax.Dependencies

Associated Types

type Item Dependencies :: Type

Methods

fromList :: [Item Dependencies] -> Dependencies

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

toList :: Dependencies -> [Item Dependencies]

Eq Dependencies

Defined in Hpack.Syntax.Dependencies

Methods

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

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

Show Dependencies

Defined in Hpack.Syntax.Dependencies

Methods

showsPrec :: Int -> Dependencies -> ShowS

show :: Dependencies -> String

showList :: [Dependencies] -> ShowS

Semigroup Dependencies

Defined in Hpack.Syntax.Dependencies

Methods

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

sconcat :: NonEmpty Dependencies -> Dependencies

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

Monoid Dependencies

Defined in Hpack.Syntax.Dependencies

Methods

mempty :: Dependencies

mappend :: Dependencies -> Dependencies -> Dependencies

mconcat :: [Dependencies] -> Dependencies

FromValue Dependencies

Defined in Hpack.Syntax.Dependencies

Methods

fromValue :: Value -> Parser Dependencies

type Item Dependencies

Defined in Hpack.Syntax.Dependencies

type Item Dependencies

data VersionConstraint

Constructors

AnyVersion

VersionRange String

Instances

Eq VersionConstraint

Defined in Hpack.Syntax.DependencyVersion

Methods

(==) :: VersionConstraint -> VersionConstraint -> Bool

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

Show VersionConstraint

Defined in Hpack.Syntax.DependencyVersion

Methods

showsPrec :: Int -> VersionConstraint -> ShowS

show :: VersionConstraint -> String

showList :: [VersionConstraint] -> ShowS

FromValue VersionConstraint

Defined in Hpack.Syntax.DependencyVersion

Methods

fromValue :: Value -> Parser VersionConstraint

data DependencyVersion

Constructors

DependencyVersion (Maybe SourceDependency) VersionConstraint

Instances

Eq DependencyVersion

Defined in Hpack.Syntax.DependencyVersion

Methods

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

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

Show DependencyVersion

Defined in Hpack.Syntax.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

Defined in Hpack.Syntax.DependencyVersion

Methods

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

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

Show SourceDependency

Defined in Hpack.Syntax.DependencyVersion

Methods

showsPrec :: Int -> SourceDependency -> ShowS

show :: SourceDependency -> String

showList :: [SourceDependency] -> ShowS

type GitRef = String

type GitUrl = String

data BuildTool

Constructors

BuildTool String String

LocalBuildTool String

Instances

Eq BuildTool

Defined in Hpack.Config

Methods

(==) :: BuildTool -> BuildTool -> Bool

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

Ord BuildTool

Defined in Hpack.Config

Methods

compare :: BuildTool -> BuildTool -> Ordering

(<) :: BuildTool -> BuildTool -> Bool

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

(>) :: BuildTool -> BuildTool -> Bool

(>=) :: BuildTool -> BuildTool -> Bool

max :: BuildTool -> BuildTool -> BuildTool

min :: BuildTool -> BuildTool -> BuildTool

Show BuildTool

Defined in Hpack.Config

Methods

showsPrec :: Int -> BuildTool -> ShowS

show :: BuildTool -> String

showList :: [BuildTool] -> ShowS

newtype SystemBuildTools

Constructors

SystemBuildTools

Fields

• unSystemBuildTools :: Map String VersionConstraint

Instances

Eq SystemBuildTools

Defined in Hpack.Syntax.BuildTools

Methods

(==) :: SystemBuildTools -> SystemBuildTools -> Bool

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

Show SystemBuildTools

Defined in Hpack.Syntax.BuildTools

Methods

showsPrec :: Int -> SystemBuildTools -> ShowS

show :: SystemBuildTools -> String

showList :: [SystemBuildTools] -> ShowS

Semigroup SystemBuildTools

Defined in Hpack.Syntax.BuildTools

Methods

(<>) :: SystemBuildTools -> SystemBuildTools -> SystemBuildTools

sconcat :: NonEmpty SystemBuildTools -> SystemBuildTools

stimes :: Integral b => b -> SystemBuildTools -> SystemBuildTools

Monoid SystemBuildTools

Defined in Hpack.Syntax.BuildTools

Methods

mempty :: SystemBuildTools

mappend :: SystemBuildTools -> SystemBuildTools -> SystemBuildTools

mconcat :: [SystemBuildTools] -> SystemBuildTools

FromValue SystemBuildTools

Defined in Hpack.Syntax.BuildTools

Methods

fromValue :: Value -> Parser SystemBuildTools

type GhcOption = String

data Verbatim

Constructors

VerbatimLiteral String

VerbatimObject (Map String VerbatimValue)

Instances

Eq Verbatim

Defined in Hpack.Config

Methods

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

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

Show Verbatim

Defined in Hpack.Config

Methods

showsPrec :: Int -> Verbatim -> ShowS

show :: Verbatim -> String

showList :: [Verbatim] -> ShowS

FromValue Verbatim

Defined in Hpack.Config

Methods

fromValue :: Value -> Parser Verbatim

data VerbatimValue

Constructors

VerbatimString String

VerbatimNumber Scientific

VerbatimBool Bool

VerbatimNull

Instances

Eq VerbatimValue

Defined in Hpack.Config

Methods

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

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

Show VerbatimValue

Defined in Hpack.Config

Methods

showsPrec :: Int -> VerbatimValue -> ShowS

show :: VerbatimValue -> String

showList :: [VerbatimValue] -> ShowS

FromValue VerbatimValue

Defined in Hpack.Config

Methods

fromValue :: Value -> Parser VerbatimValue

verbatimValueToString :: VerbatimValue -> String

data CustomSetup

Constructors

CustomSetup

Fields

• customSetupDependencies :: Dependencies

Instances

Eq CustomSetup

Defined in Hpack.Config

Methods

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

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

Show CustomSetup

Defined in Hpack.Config

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 :: Map BuildTool DependencyVersion
• sectionSystemBuildTools :: SystemBuildTools
• sectionVerbatim :: [Verbatim]

Instances

Functor Section

Defined in Hpack.Config

Methods

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

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

Foldable Section

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

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)

Defined in Hpack.Config

Methods

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

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

Show a => Show (Section a)

Defined in Hpack.Config

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

Defined in Hpack.Config

Methods

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

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

Show Library

Defined in Hpack.Config

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

Defined in Hpack.Config

Methods

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

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

Show Executable

Defined in Hpack.Config

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

Defined in Hpack.Config

Methods

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

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

Foldable Conditional

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

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)

Defined in Hpack.Config

Methods

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

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

Show a => Show (Conditional a)

Defined in Hpack.Config

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

Defined in Hpack.Config

Methods

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

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

Show Flag

Defined in Hpack.Config

Methods

showsPrec :: Int -> Flag -> ShowS

show :: Flag -> String

showList :: [Flag] -> ShowS

data SourceRepository

Constructors

SourceRepository

Fields

• sourceRepositoryUrl :: String
• sourceRepositorySubdir :: Maybe String

Instances

Eq SourceRepository

Defined in Hpack.Config

Methods

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

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

Show SourceRepository

Defined in Hpack.Config

Methods

showsPrec :: Int -> SourceRepository -> ShowS

show :: SourceRepository -> String

showList :: [SourceRepository] -> ShowS

data BuildType

Constructors

Simple

Configure

Make

Custom

Instances

Bounded BuildType

Defined in Hpack.Config

Methods

minBound :: BuildType

maxBound :: BuildType

Enum BuildType

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

Defined in Hpack.Config

Methods

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

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

Show BuildType

Defined in Hpack.Config

Methods

showsPrec :: Int -> BuildType -> ShowS

show :: BuildType -> String

showList :: [BuildType] -> ShowS

Generic BuildType

Defined in Hpack.Config

Associated Types

type Rep BuildType :: Type -> Type

Methods

from :: BuildType -> Rep BuildType x

to :: Rep BuildType x -> BuildType

FromValue BuildType

Defined in Hpack.Config

Methods

fromValue :: Value -> Parser BuildType

type Rep BuildType

Defined in Hpack.Config

type Rep BuildType = D1 (MetaData "BuildType" "Hpack.Config" "hpack-0.31.1-FaM9UiwyKTmeFWkLWsjE3" False) ((C1 (MetaCons "Simple" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Configure" PrefixI False) (U1 :: Type -> Type)) :+: (C1 (MetaCons "Make" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "Custom" PrefixI False) (U1 :: Type -> Type)))

type GhcProfOption = String

type GhcjsOption = String

type CppOption = String

type CcOption = String

type LdOption = String