Safe Haskell | None |
---|---|
Language | Haskell2010 |
Hpack.Config
Synopsis
- data DecodeOptions = DecodeOptions {}
- newtype ProgramName = ProgramName String
- defaultDecodeOptions :: DecodeOptions
- packageConfig :: FilePath
- data DecodeResult = DecodeResult {}
- readPackageConfig :: DecodeOptions -> IO (Either String DecodeResult)
- renamePackage :: String -> Package -> Package
- packageDependencies :: Package -> [(String, DependencyInfo)]
- 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 :: [Path]
- packageExtraDocFiles :: [Path]
- packageDataFiles :: [Path]
- 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 {}
- data DependencyInfo = DependencyInfo {}
- data VersionConstraint
- data DependencyVersion = DependencyVersion (Maybe SourceDependency) VersionConstraint
- data SourceDependency
- type GitRef = String
- type GitUrl = String
- data BuildTool
- newtype SystemBuildTools = SystemBuildTools {}
- type GhcOption = String
- data Verbatim
- data VerbatimValue
- verbatimValueToString :: VerbatimValue -> String
- data CustomSetup = CustomSetup {}
- 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 :: [Path]
- sectionCxxOptions :: [CxxOption]
- sectionCxxSources :: [Path]
- sectionJsSources :: [Path]
- 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]
- data Library = Library {}
- data Executable = Executable {}
- data Conditional a = Conditional {}
- data Flag = Flag {}
- data SourceRepository = SourceRepository {}
- data BuildType
- type GhcProfOption = String
- type GhcjsOption = String
- type CppOption = String
- type CcOption = String
- type LdOption = String
- newtype Path = Path {}
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 |
newtype ProgramName Source #
Constructors
ProgramName String |
Instances
Eq ProgramName Source # | |
Defined in Hpack.Config Methods (==) :: ProgramName -> ProgramName -> Bool Source # (/=) :: ProgramName -> ProgramName -> Bool Source # | |
Show ProgramName Source # | |
Defined in Hpack.Config | |
IsString ProgramName Source # | |
Defined in Hpack.Config Methods fromString :: String -> ProgramName Source # |
data DecodeResult Source #
Constructors
DecodeResult | |
Instances
Eq DecodeResult Source # | |
Defined in Hpack.Config Methods (==) :: DecodeResult -> DecodeResult -> Bool Source # (/=) :: DecodeResult -> DecodeResult -> Bool Source # | |
Show DecodeResult Source # | |
Defined in Hpack.Config |
packageDependencies :: Package -> [(String, DependencyInfo)] Source #
Constructors
Package | |
Fields
|
newtype Dependencies Source #
Constructors
Dependencies | |
Fields |
Instances
data DependencyInfo Source #
Constructors
DependencyInfo | |
Fields |
Instances
Eq DependencyInfo Source # | |
Defined in Hpack.Syntax.Dependencies Methods (==) :: DependencyInfo -> DependencyInfo -> Bool Source # (/=) :: DependencyInfo -> DependencyInfo -> Bool Source # | |
Show DependencyInfo Source # | |
Defined in Hpack.Syntax.Dependencies |
data VersionConstraint Source #
Constructors
AnyVersion | |
VersionRange String |
Instances
Eq VersionConstraint Source # | |
Defined in Hpack.Syntax.DependencyVersion Methods (==) :: VersionConstraint -> VersionConstraint -> Bool Source # (/=) :: VersionConstraint -> VersionConstraint -> Bool Source # | |
Show VersionConstraint Source # | |
Defined in Hpack.Syntax.DependencyVersion | |
FromValue VersionConstraint Source # | |
Defined in Hpack.Syntax.DependencyVersion |
data DependencyVersion Source #
Constructors
DependencyVersion (Maybe SourceDependency) VersionConstraint |
Instances
Eq DependencyVersion Source # | |
Defined in Hpack.Syntax.DependencyVersion Methods (==) :: DependencyVersion -> DependencyVersion -> Bool Source # (/=) :: DependencyVersion -> DependencyVersion -> Bool Source # | |
Show DependencyVersion Source # | |
Defined in Hpack.Syntax.DependencyVersion |
data SourceDependency Source #
Instances
Eq SourceDependency Source # | |
Defined in Hpack.Syntax.DependencyVersion Methods (==) :: SourceDependency -> SourceDependency -> Bool Source # (/=) :: SourceDependency -> SourceDependency -> Bool Source # | |
Show SourceDependency Source # | |
Defined in Hpack.Syntax.DependencyVersion |
Constructors
BuildTool String String | |
LocalBuildTool String |
Instances
Eq BuildTool Source # | |
Ord BuildTool Source # | |
Defined in Hpack.Config | |
Show BuildTool Source # | |
newtype SystemBuildTools Source #
Constructors
SystemBuildTools | |
Fields |
Instances
Eq SystemBuildTools Source # | |
Defined in Hpack.Syntax.BuildTools Methods (==) :: SystemBuildTools -> SystemBuildTools -> Bool Source # (/=) :: SystemBuildTools -> SystemBuildTools -> Bool Source # | |
Show SystemBuildTools Source # | |
Defined in Hpack.Syntax.BuildTools | |
Semigroup SystemBuildTools Source # | |
Defined in Hpack.Syntax.BuildTools Methods (<>) :: SystemBuildTools -> SystemBuildTools -> SystemBuildTools Source # sconcat :: NonEmpty SystemBuildTools -> SystemBuildTools Source # stimes :: Integral b => b -> SystemBuildTools -> SystemBuildTools Source # | |
Monoid SystemBuildTools Source # | |
Defined in Hpack.Syntax.BuildTools Methods mempty :: SystemBuildTools Source # mappend :: SystemBuildTools -> SystemBuildTools -> SystemBuildTools Source # mconcat :: [SystemBuildTools] -> SystemBuildTools Source # | |
FromValue SystemBuildTools Source # | |
Defined in Hpack.Syntax.BuildTools |
Constructors
VerbatimLiteral String | |
VerbatimObject (Map String VerbatimValue) |
data VerbatimValue Source #
Constructors
VerbatimString String | |
VerbatimNumber Scientific | |
VerbatimBool Bool | |
VerbatimNull |
Instances
Eq VerbatimValue Source # | |
Defined in Hpack.Config Methods (==) :: VerbatimValue -> VerbatimValue -> Bool Source # (/=) :: VerbatimValue -> VerbatimValue -> Bool Source # | |
Show VerbatimValue Source # | |
Defined in Hpack.Config | |
FromValue VerbatimValue Source # | |
Defined in Hpack.Config |
data CustomSetup Source #
Constructors
CustomSetup | |
Fields |
Instances
Eq CustomSetup Source # | |
Defined in Hpack.Config Methods (==) :: CustomSetup -> CustomSetup -> Bool Source # (/=) :: CustomSetup -> CustomSetup -> Bool Source # | |
Show CustomSetup Source # | |
Defined in Hpack.Config |
Constructors
Section | |
Fields
|
Instances
Functor Section Source # | |
Foldable Section Source # | |
Defined in Hpack.Config Methods fold :: Monoid m => Section m -> m Source # foldMap :: Monoid m => (a -> m) -> Section a -> m Source # foldMap' :: Monoid m => (a -> m) -> Section a -> m Source # foldr :: (a -> b -> b) -> b -> Section a -> b Source # foldr' :: (a -> b -> b) -> b -> Section a -> b Source # foldl :: (b -> a -> b) -> b -> Section a -> b Source # foldl' :: (b -> a -> b) -> b -> Section a -> b Source # foldr1 :: (a -> a -> a) -> Section a -> a Source # foldl1 :: (a -> a -> a) -> Section a -> a Source # toList :: Section a -> [a] Source # null :: Section a -> Bool Source # length :: Section a -> Int Source # elem :: Eq a => a -> Section a -> Bool Source # maximum :: Ord a => Section a -> a Source # minimum :: Ord a => Section a -> a Source # | |
Traversable Section Source # | |
Defined in Hpack.Config | |
Eq a => Eq (Section a) Source # | |
Show a => Show (Section a) Source # | |
data Executable Source #
Constructors
Executable | |
Fields |
Instances
Eq Executable Source # | |
Defined in Hpack.Config Methods (==) :: Executable -> Executable -> Bool Source # (/=) :: Executable -> Executable -> Bool Source # | |
Show Executable Source # | |
Defined in Hpack.Config |
data Conditional a Source #
Constructors
Conditional | |
Fields
|
Instances
Constructors
Flag | |
Fields
|
data SourceRepository Source #
Constructors
SourceRepository | |
Fields |
Instances
Eq SourceRepository Source # | |
Defined in Hpack.Config Methods (==) :: SourceRepository -> SourceRepository -> Bool Source # (/=) :: SourceRepository -> SourceRepository -> Bool Source # | |
Show SourceRepository Source # | |
Defined in Hpack.Config |
Instances
type GhcProfOption = String Source #
type GhcjsOption = String Source #