| 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 :: [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 {
- conditionalCondition :: Cond
- conditionalThen :: a
- conditionalElse :: Maybe a
- data Cond
- 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 {}
- newtype Module = Module {}
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 | |
newtype ProgramName #
Constructors
| ProgramName String |
Instances
| Eq ProgramName # | |
Defined in Hpack.Config | |
| 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 # | |
data DecodeResult #
Constructors
| DecodeResult | |
Instances
| Eq DecodeResult # | |
Defined in Hpack.Config | |
| Show DecodeResult # | |
Defined in Hpack.Config Methods showsPrec :: Int -> DecodeResult -> ShowS # show :: DecodeResult -> String # showList :: [DecodeResult] -> ShowS # | |
renamePackage :: String -> Package -> Package #
packageDependencies :: Package -> [(String, DependencyInfo)] #
Constructors
| Package | |
Fields
| |
newtype Dependencies #
Constructors
| Dependencies | |
Fields | |
Instances
data DependencyInfo #
Constructors
| DependencyInfo | |
Fields | |
Instances
| Eq DependencyInfo # | |
Defined in Hpack.Syntax.Dependencies Methods (==) :: DependencyInfo -> DependencyInfo -> Bool # (/=) :: DependencyInfo -> DependencyInfo -> Bool # | |
| Ord DependencyInfo # | |
Defined in Hpack.Syntax.Dependencies Methods compare :: DependencyInfo -> DependencyInfo -> Ordering # (<) :: DependencyInfo -> DependencyInfo -> Bool # (<=) :: DependencyInfo -> DependencyInfo -> Bool # (>) :: DependencyInfo -> DependencyInfo -> Bool # (>=) :: DependencyInfo -> DependencyInfo -> Bool # max :: DependencyInfo -> DependencyInfo -> DependencyInfo # min :: DependencyInfo -> DependencyInfo -> DependencyInfo # | |
| Show DependencyInfo # | |
Defined in Hpack.Syntax.Dependencies Methods showsPrec :: Int -> DependencyInfo -> ShowS # show :: DependencyInfo -> String # showList :: [DependencyInfo] -> ShowS # | |
data VersionConstraint #
Constructors
| AnyVersion | |
| VersionRange String |
Instances
data DependencyVersion #
Constructors
| DependencyVersion (Maybe SourceDependency) VersionConstraint |
Instances
| Eq DependencyVersion # | |
Defined in Hpack.Syntax.DependencyVersion Methods (==) :: DependencyVersion -> DependencyVersion -> Bool # (/=) :: DependencyVersion -> DependencyVersion -> Bool # | |
| Ord DependencyVersion # | |
Defined in Hpack.Syntax.DependencyVersion Methods compare :: DependencyVersion -> DependencyVersion -> Ordering # (<) :: DependencyVersion -> DependencyVersion -> Bool # (<=) :: DependencyVersion -> DependencyVersion -> Bool # (>) :: DependencyVersion -> DependencyVersion -> Bool # (>=) :: DependencyVersion -> DependencyVersion -> Bool # max :: DependencyVersion -> DependencyVersion -> DependencyVersion # min :: DependencyVersion -> DependencyVersion -> DependencyVersion # | |
| Show DependencyVersion # | |
Defined in Hpack.Syntax.DependencyVersion Methods showsPrec :: Int -> DependencyVersion -> ShowS # show :: DependencyVersion -> String # showList :: [DependencyVersion] -> ShowS # | |
data SourceDependency #
Instances
| Eq SourceDependency # | |
Defined in Hpack.Syntax.DependencyVersion Methods (==) :: SourceDependency -> SourceDependency -> Bool # (/=) :: SourceDependency -> SourceDependency -> Bool # | |
| Ord SourceDependency # | |
Defined in Hpack.Syntax.DependencyVersion Methods compare :: SourceDependency -> SourceDependency -> Ordering # (<) :: SourceDependency -> SourceDependency -> Bool # (<=) :: SourceDependency -> SourceDependency -> Bool # (>) :: SourceDependency -> SourceDependency -> Bool # (>=) :: SourceDependency -> SourceDependency -> Bool # max :: SourceDependency -> SourceDependency -> SourceDependency # min :: SourceDependency -> SourceDependency -> SourceDependency # | |
| Show SourceDependency # | |
Defined in Hpack.Syntax.DependencyVersion Methods showsPrec :: Int -> SourceDependency -> ShowS # show :: SourceDependency -> String # showList :: [SourceDependency] -> ShowS # | |
Constructors
| BuildTool String String | |
| LocalBuildTool String |
Instances
| Eq BuildTool # | |
| Ord BuildTool # | |
| Show BuildTool # | |
newtype SystemBuildTools #
Constructors
| SystemBuildTools | |
Fields | |
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 mappend :: SystemBuildTools -> SystemBuildTools -> SystemBuildTools # mconcat :: [SystemBuildTools] -> SystemBuildTools # | |
| FromValue SystemBuildTools # | |
Defined in Hpack.Syntax.BuildTools Methods fromValue :: Value -> Parser SystemBuildTools # | |
Constructors
| VerbatimLiteral String | |
| VerbatimObject (Map String VerbatimValue) |
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 # | |
data CustomSetup #
Constructors
| CustomSetup | |
Fields | |
Instances
| Eq CustomSetup # | |
Defined in Hpack.Config | |
| Show CustomSetup # | |
Defined in Hpack.Config Methods showsPrec :: Int -> CustomSetup -> ShowS # show :: CustomSetup -> String # showList :: [CustomSetup] -> ShowS # | |
Constructors
| Section | |
Fields
| |
Instances
| Functor Section # | |
| Foldable Section # | |
Defined in Hpack.Config Methods fold :: Monoid m => Section m -> m # foldMap :: Monoid m => (a -> m) -> Section a -> 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 # elem :: Eq a => a -> Section a -> Bool # maximum :: Ord a => Section a -> a # minimum :: Ord a => Section a -> a # | |
| Traversable Section # | |
| Eq a => Eq (Section a) # | |
| Show a => Show (Section a) # | |
Constructors
| Library | |
Fields | |
data Executable #
Constructors
| Executable | |
Fields | |
Instances
| Eq Executable # | |
Defined in Hpack.Config | |
| Show Executable # | |
Defined in Hpack.Config Methods showsPrec :: Int -> Executable -> ShowS # show :: Executable -> String # showList :: [Executable] -> ShowS # | |
data Conditional a #
Constructors
| Conditional | |
Fields
| |
Instances
Constructors
| Flag | |
Fields
| |
data SourceRepository #
Constructors
| SourceRepository | |
Fields | |
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 # | |
Instances
| Bounded BuildType # | |
| Enum BuildType # | |
Defined in Hpack.Config Methods succ :: BuildType -> BuildType # pred :: BuildType -> BuildType # fromEnum :: BuildType -> Int # enumFrom :: BuildType -> [BuildType] # enumFromThen :: BuildType -> BuildType -> [BuildType] # enumFromTo :: BuildType -> BuildType -> [BuildType] # enumFromThenTo :: BuildType -> BuildType -> BuildType -> [BuildType] # | |
| Eq BuildType # | |
| Show BuildType # | |
| Generic BuildType # | |
| FromValue BuildType # | |
| type Rep BuildType # | |
Defined in Hpack.Config type Rep BuildType = D1 ('MetaData "BuildType" "Hpack.Config" "hpack-0.34.6-CrxWq5uQbsj8cfiS2YWbzv" '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 #