License	Apache-2.0
Safe Haskell	Safe
Language	Haskell2010

CabalHelper.Shared.InterfaceTypes

Description

These types are used to communicate between the cabal-helper library and helper executable, using Show/Read. If any types in this module change the major version must be bumped since this will be exposed in the Distribution.Helper module.

The cached executables in $XDG_CACHE_HOME/cabal-helper use the cabal-helper version (among other things) as a cache key so we don't need to worry about talking to an old executable.

Documentation

data ChResponse Source #

Constructors

ChResponseComponentsInfo (Map ChComponentName ChComponentInfo)
ChResponseList [String]
ChResponseLbi String
ChResponseVersion (String, Version)
ChResponseFlags [(String, Bool)]

Instances

Eq ChResponse Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChResponse -> ChResponse -> Bool # (/=) :: ChResponse -> ChResponse -> Bool #
Ord ChResponse Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChResponse -> ChResponse -> Ordering # (<) :: ChResponse -> ChResponse -> Bool # (<=) :: ChResponse -> ChResponse -> Bool # (>) :: ChResponse -> ChResponse -> Bool # (>=) :: ChResponse -> ChResponse -> Bool # max :: ChResponse -> ChResponse -> ChResponse # min :: ChResponse -> ChResponse -> ChResponse #
Read ChResponse Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChResponse # readList :: ReadS [ChResponse] # readPrec :: ReadPrec ChResponse # readListPrec :: ReadPrec [ChResponse] #
Show ChResponse Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChResponse -> ShowS # show :: ChResponse -> String # showList :: [ChResponse] -> ShowS #
Generic ChResponse Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Associated Types type Rep ChResponse :: Type -> Type # Methods from :: ChResponse -> Rep ChResponse x # to :: Rep ChResponse x -> ChResponse #
type Rep ChResponse Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes type Rep ChResponse = D1 (MetaData "ChResponse" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-1.0.0.0-3RovMtTNraDHCRO0uwfQKJ-c-h-internal" False) ((C1 (MetaCons "ChResponseComponentsInfo" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (Map ChComponentName ChComponentInfo))) :+: C1 (MetaCons "ChResponseList" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [String]))) :+: (C1 (MetaCons "ChResponseLbi" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: (C1 (MetaCons "ChResponseVersion" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 (String, Version))) :+: C1 (MetaCons "ChResponseFlags" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [(String, Bool)])))))

data ChComponentName Source #

Constructors

ChSetupHsName
ChLibName ChLibraryName
ChFLibName String
ChExeName String
ChTestName String
ChBenchName String

Instances

Eq ChComponentName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChComponentName -> ChComponentName -> Bool # (/=) :: ChComponentName -> ChComponentName -> Bool #
Ord ChComponentName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChComponentName -> ChComponentName -> Ordering # (<) :: ChComponentName -> ChComponentName -> Bool # (<=) :: ChComponentName -> ChComponentName -> Bool # (>) :: ChComponentName -> ChComponentName -> Bool # (>=) :: ChComponentName -> ChComponentName -> Bool # max :: ChComponentName -> ChComponentName -> ChComponentName # min :: ChComponentName -> ChComponentName -> ChComponentName #
Read ChComponentName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChComponentName # readList :: ReadS [ChComponentName] # readPrec :: ReadPrec ChComponentName # readListPrec :: ReadPrec [ChComponentName] #
Show ChComponentName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChComponentName -> ShowS # show :: ChComponentName -> String # showList :: [ChComponentName] -> ShowS #
Generic ChComponentName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Associated Types type Rep ChComponentName :: Type -> Type # Methods from :: ChComponentName -> Rep ChComponentName x # to :: Rep ChComponentName x -> ChComponentName #
type Rep ChComponentName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes type Rep ChComponentName = D1 (MetaData "ChComponentName" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-1.0.0.0-3RovMtTNraDHCRO0uwfQKJ-c-h-internal" False) ((C1 (MetaCons "ChSetupHsName" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ChLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 ChLibraryName)) :+: C1 (MetaCons "ChFLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))) :+: (C1 (MetaCons "ChExeName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: (C1 (MetaCons "ChTestName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)) :+: C1 (MetaCons "ChBenchName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))))

data ChLibraryName Source #

Constructors

ChMainLibName
ChSubLibName String

Instances

Eq ChLibraryName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChLibraryName -> ChLibraryName -> Bool # (/=) :: ChLibraryName -> ChLibraryName -> Bool #
Ord ChLibraryName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChLibraryName -> ChLibraryName -> Ordering # (<) :: ChLibraryName -> ChLibraryName -> Bool # (<=) :: ChLibraryName -> ChLibraryName -> Bool # (>) :: ChLibraryName -> ChLibraryName -> Bool # (>=) :: ChLibraryName -> ChLibraryName -> Bool # max :: ChLibraryName -> ChLibraryName -> ChLibraryName # min :: ChLibraryName -> ChLibraryName -> ChLibraryName #
Read ChLibraryName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChLibraryName # readList :: ReadS [ChLibraryName] # readPrec :: ReadPrec ChLibraryName # readListPrec :: ReadPrec [ChLibraryName] #
Show ChLibraryName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChLibraryName -> ShowS # show :: ChLibraryName -> String # showList :: [ChLibraryName] -> ShowS #
Generic ChLibraryName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Associated Types type Rep ChLibraryName :: Type -> Type # Methods from :: ChLibraryName -> Rep ChLibraryName x # to :: Rep ChLibraryName x -> ChLibraryName #
type Rep ChLibraryName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes type Rep ChLibraryName = D1 (MetaData "ChLibraryName" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-1.0.0.0-3RovMtTNraDHCRO0uwfQKJ-c-h-internal" False) (C1 (MetaCons "ChMainLibName" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ChSubLibName" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

newtype ChModuleName Source #

Constructors

ChModuleName
Fields unChModuleName :: String

Instances

Eq ChModuleName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChModuleName -> ChModuleName -> Bool # (/=) :: ChModuleName -> ChModuleName -> Bool #
Ord ChModuleName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChModuleName -> ChModuleName -> Ordering # (<) :: ChModuleName -> ChModuleName -> Bool # (<=) :: ChModuleName -> ChModuleName -> Bool # (>) :: ChModuleName -> ChModuleName -> Bool # (>=) :: ChModuleName -> ChModuleName -> Bool # max :: ChModuleName -> ChModuleName -> ChModuleName # min :: ChModuleName -> ChModuleName -> ChModuleName #
Read ChModuleName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChModuleName # readList :: ReadS [ChModuleName] # readPrec :: ReadPrec ChModuleName # readListPrec :: ReadPrec [ChModuleName] #
Show ChModuleName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChModuleName -> ShowS # show :: ChModuleName -> String # showList :: [ChModuleName] -> ShowS #
Generic ChModuleName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Associated Types type Rep ChModuleName :: Type -> Type # Methods from :: ChModuleName -> Rep ChModuleName x # to :: Rep ChModuleName x -> ChModuleName #
type Rep ChModuleName Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes type Rep ChModuleName = D1 (MetaData "ChModuleName" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-1.0.0.0-3RovMtTNraDHCRO0uwfQKJ-c-h-internal" True) (C1 (MetaCons "ChModuleName" PrefixI True) (S1 (MetaSel (Just "unChModuleName") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 String)))

data ChComponentInfo Source #

Constructors

ChComponentInfo

Fields

ciComponentName :: ChComponentName
The component's type and name
ciGhcOptions :: [String]
Full set of GHC options, ready for loading this component into GHCi.
ciSourceDirs :: [String]
A component's hs-source-dirs field, note that this only contains the directories specified by the cabal file, however cabal also adds the output directory of preprocessors to GHC's search path when building. TODO: make this easier to use.
ciEntrypoints :: ChEntrypoint
Modules or files Cabal would have the compiler build directly. Can be used to compute the home module closure for a component.

Instances

Eq ChComponentInfo Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChComponentInfo -> ChComponentInfo -> Bool # (/=) :: ChComponentInfo -> ChComponentInfo -> Bool #
Ord ChComponentInfo Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChComponentInfo -> ChComponentInfo -> Ordering # (<) :: ChComponentInfo -> ChComponentInfo -> Bool # (<=) :: ChComponentInfo -> ChComponentInfo -> Bool # (>) :: ChComponentInfo -> ChComponentInfo -> Bool # (>=) :: ChComponentInfo -> ChComponentInfo -> Bool # max :: ChComponentInfo -> ChComponentInfo -> ChComponentInfo # min :: ChComponentInfo -> ChComponentInfo -> ChComponentInfo #
Read ChComponentInfo Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChComponentInfo # readList :: ReadS [ChComponentInfo] # readPrec :: ReadPrec ChComponentInfo # readListPrec :: ReadPrec [ChComponentInfo] #
Show ChComponentInfo Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChComponentInfo -> ShowS # show :: ChComponentInfo -> String # showList :: [ChComponentInfo] -> ShowS #

data ChEntrypoint Source #

Constructors

ChSetupEntrypoint
Fields chMainIs :: FilePath
ChLibEntrypoint
Fields chExposedModules :: [ChModuleName] chOtherModules :: [ChModuleName] chSignatures :: [ChModuleName]
ChExeEntrypoint
Fields chMainIs :: FilePath chOtherModules :: [ChModuleName]

Instances

Eq ChEntrypoint Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChEntrypoint -> ChEntrypoint -> Bool # (/=) :: ChEntrypoint -> ChEntrypoint -> Bool #
Ord ChEntrypoint Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChEntrypoint -> ChEntrypoint -> Ordering # (<) :: ChEntrypoint -> ChEntrypoint -> Bool # (<=) :: ChEntrypoint -> ChEntrypoint -> Bool # (>) :: ChEntrypoint -> ChEntrypoint -> Bool # (>=) :: ChEntrypoint -> ChEntrypoint -> Bool # max :: ChEntrypoint -> ChEntrypoint -> ChEntrypoint # min :: ChEntrypoint -> ChEntrypoint -> ChEntrypoint #
Read ChEntrypoint Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChEntrypoint # readList :: ReadS [ChEntrypoint] # readPrec :: ReadPrec ChEntrypoint # readListPrec :: ReadPrec [ChEntrypoint] #
Show ChEntrypoint Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChEntrypoint -> ShowS # show :: ChEntrypoint -> String # showList :: [ChEntrypoint] -> ShowS #
Generic ChEntrypoint Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Associated Types type Rep ChEntrypoint :: Type -> Type # Methods from :: ChEntrypoint -> Rep ChEntrypoint x # to :: Rep ChEntrypoint x -> ChEntrypoint #
type Rep ChEntrypoint Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes type Rep ChEntrypoint = D1 (MetaData "ChEntrypoint" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-1.0.0.0-3RovMtTNraDHCRO0uwfQKJ-c-h-internal" False) (C1 (MetaCons "ChSetupEntrypoint" PrefixI True) (S1 (MetaSel (Just "chMainIs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath)) :+: (C1 (MetaCons "ChLibEntrypoint" PrefixI True) (S1 (MetaSel (Just "chExposedModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]) :: (S1 (MetaSel (Just "chOtherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]) :: S1 (MetaSel (Just "chSignatures") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]))) :+: C1 (MetaCons "ChExeEntrypoint" PrefixI True) (S1 (MetaSel (Just "chMainIs") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath) :*: S1 (MetaSel (Just "chOtherModules") NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 [ChModuleName]))))

data ChPkgDb Source #

Constructors

ChPkgGlobal
ChPkgUser
ChPkgSpecific FilePath

Instances

Eq ChPkgDb Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods (==) :: ChPkgDb -> ChPkgDb -> Bool # (/=) :: ChPkgDb -> ChPkgDb -> Bool #
Ord ChPkgDb Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods compare :: ChPkgDb -> ChPkgDb -> Ordering # (<) :: ChPkgDb -> ChPkgDb -> Bool # (<=) :: ChPkgDb -> ChPkgDb -> Bool # (>) :: ChPkgDb -> ChPkgDb -> Bool # (>=) :: ChPkgDb -> ChPkgDb -> Bool # max :: ChPkgDb -> ChPkgDb -> ChPkgDb # min :: ChPkgDb -> ChPkgDb -> ChPkgDb #
Read ChPkgDb Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods readsPrec :: Int -> ReadS ChPkgDb # readList :: ReadS [ChPkgDb] # readPrec :: ReadPrec ChPkgDb # readListPrec :: ReadPrec [ChPkgDb] #
Show ChPkgDb Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Methods showsPrec :: Int -> ChPkgDb -> ShowS # show :: ChPkgDb -> String # showList :: [ChPkgDb] -> ShowS #
Generic ChPkgDb Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes Associated Types type Rep ChPkgDb :: Type -> Type # Methods from :: ChPkgDb -> Rep ChPkgDb x # to :: Rep ChPkgDb x -> ChPkgDb #
type Rep ChPkgDb Source #
Instance details Defined in CabalHelper.Shared.InterfaceTypes type Rep ChPkgDb = D1 (MetaData "ChPkgDb" "CabalHelper.Shared.InterfaceTypes" "cabal-helper-1.0.0.0-3RovMtTNraDHCRO0uwfQKJ-c-h-internal" False) (C1 (MetaCons "ChPkgGlobal" PrefixI False) (U1 :: Type -> Type) :+: (C1 (MetaCons "ChPkgUser" PrefixI False) (U1 :: Type -> Type) :+: C1 (MetaCons "ChPkgSpecific" PrefixI False) (S1 (MetaSel (Nothing :: Maybe Symbol) NoSourceUnpackedness NoSourceStrictness DecidedLazy) (Rec0 FilePath))))