| Copyright | (c) Brent Yorgey Benedikt Huber 2009 |
|---|---|
| License | BSD-like |
| Maintainer | [email protected] |
| Stability | provisional |
| Portability | portable |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
Distribution.Client.Init.Types
Description
Some types used by the 'cabal init' command.
Synopsis
- data InitFlags = InitFlags {
- interactive :: Flag Bool
- quiet :: Flag Bool
- packageDir :: Flag FilePath
- noComments :: Flag Bool
- minimal :: Flag Bool
- simpleProject :: Flag Bool
- packageName :: Flag PackageName
- version :: Flag Version
- cabalVersion :: Flag CabalSpecVersion
- license :: Flag SpecLicense
- author :: Flag String
- email :: Flag String
- homepage :: Flag String
- synopsis :: Flag String
- category :: Flag String
- extraSrc :: Flag [String]
- extraDoc :: Flag [String]
- packageType :: Flag PackageType
- mainIs :: Flag FilePath
- language :: Flag Language
- exposedModules :: Flag [ModuleName]
- otherModules :: Flag [ModuleName]
- otherExts :: Flag [Extension]
- dependencies :: Flag [Dependency]
- applicationDirs :: Flag [String]
- sourceDirs :: Flag [String]
- buildTools :: Flag [String]
- initializeTestSuite :: Flag Bool
- testDirs :: Flag [String]
- initHcPath :: Flag FilePath
- initVerbosity :: Flag Verbosity
- overwrite :: Flag Bool
- data PkgDescription = PkgDescription {}
- data LibTarget = LibTarget {}
- data ExeTarget = ExeTarget {}
- data TestTarget = TestTarget {}
- data PackageType
- data HsFilePath = HsFilePath {}
- data HsFileType
- fromHsFilePath :: HsFilePath -> Maybe FilePath
- toHsFilePath :: FilePath -> HsFilePath
- toLiterateHs :: HsFilePath -> HsFilePath
- toStandardHs :: HsFilePath -> HsFilePath
- mkLiterate :: HsFilePath -> [String] -> [String]
- isHsFilePath :: FilePath -> Bool
- class Monad m => Interactive m where
- getLine :: m String
- readFile :: FilePath -> m String
- getCurrentDirectory :: m FilePath
- getHomeDirectory :: m FilePath
- getDirectoryContents :: FilePath -> m [FilePath]
- listDirectory :: FilePath -> m [FilePath]
- doesDirectoryExist :: FilePath -> m Bool
- doesFileExist :: FilePath -> m Bool
- canonicalizePathNoThrow :: FilePath -> m FilePath
- readProcessWithExitCode :: FilePath -> [String] -> String -> m (ExitCode, String, String)
- maybeReadProcessWithExitCode :: FilePath -> [String] -> String -> m (Maybe (ExitCode, String, String))
- getEnvironment :: m [(String, String)]
- getCurrentYear :: m Integer
- listFilesInside :: (FilePath -> m Bool) -> FilePath -> m [FilePath]
- listFilesRecursive :: FilePath -> m [FilePath]
- putStr :: String -> m ()
- putStrLn :: String -> m ()
- createDirectory :: FilePath -> m ()
- removeDirectory :: FilePath -> m ()
- writeFile :: FilePath -> String -> m ()
- removeExistingFile :: FilePath -> m ()
- copyFile :: FilePath -> FilePath -> m ()
- renameDirectory :: FilePath -> FilePath -> m ()
- hFlush :: Handle -> m ()
- message :: Verbosity -> Severity -> String -> m ()
- break :: m Bool
- throwPrompt :: BreakException -> m a
- getLastChosenLanguage :: m (Maybe String)
- setLastChosenLanguage :: Maybe String -> m ()
- newtype BreakException = BreakException String
- data PromptIO a
- runPromptIO :: PromptIO a -> IO a
- type Inputs = NonEmpty String
- data PurePrompt a
- runPrompt :: PurePrompt a -> Inputs -> Either BreakException (a, Inputs)
- evalPrompt :: PurePrompt a -> Inputs -> a
- data Severity
- type IsLiterate = Bool
- type IsSimple = Bool
- data WriteOpts = WriteOpts {}
- data ProjectSettings = ProjectSettings {}
- data FieldAnnotation = FieldAnnotation {}
- data DefaultPrompt t
Data
InitFlags is a subset of flags available in the
.cabal file that represent options that are relevant to the
init command process.
Constructors
| InitFlags | |
Fields
| |
Instances
Targets and descriptions
data PkgDescription Source #
PkgDescription represents the relevant options set by the
user when building a package description during the init command
process.
Constructors
| PkgDescription | |
Fields
| |
Instances
| Show PkgDescription Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> PkgDescription -> ShowS # show :: PkgDescription -> String # showList :: [PkgDescription] -> ShowS # | |
| Eq PkgDescription Source # | |
Defined in Distribution.Client.Init.Types Methods (==) :: PkgDescription -> PkgDescription -> Bool # (/=) :: PkgDescription -> PkgDescription -> Bool # | |
LibTarget represents the relevant options set by the
user when building a library package during the init command
process.
Constructors
| LibTarget | |
Fields
| |
ExeTarget represents the relevant options set by the
user when building an executable package.
Constructors
| ExeTarget | |
Fields
| |
data TestTarget Source #
TestTarget represents the relevant options set by the
user when building a library package.
Constructors
| TestTarget | |
Fields
| |
Instances
| Show TestTarget Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> TestTarget -> ShowS # show :: TestTarget -> String # showList :: [TestTarget] -> ShowS # | |
| Eq TestTarget Source # | |
Defined in Distribution.Client.Init.Types | |
package types
data PackageType Source #
Enum to denote whether the user wants to build a library target, executable target, library and executable targets, or a standalone test suite.
Constructors
| Library | |
| Executable | |
| LibraryAndExecutable | |
| TestSuite |
Instances
| Generic PackageType Source # | |
Defined in Distribution.Client.Init.Types Associated Types type Rep PackageType :: Type -> Type # | |
| Show PackageType Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> PackageType -> ShowS # show :: PackageType -> String # showList :: [PackageType] -> ShowS # | |
| Eq PackageType Source # | |
Defined in Distribution.Client.Init.Types | |
| type Rep PackageType Source # | |
Defined in Distribution.Client.Init.Types type Rep PackageType = D1 ('MetaData "PackageType" "Distribution.Client.Init.Types" "cabal-install-3.14.2.0-6uCrb2WuMbe9XikRFfughF" 'False) ((C1 ('MetaCons "Library" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "Executable" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LibraryAndExecutable" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "TestSuite" 'PrefixI 'False) (U1 :: Type -> Type))) | |
Main file
data HsFilePath Source #
Constructors
| HsFilePath | |
Fields | |
Instances
| Show HsFilePath Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> HsFilePath -> ShowS # show :: HsFilePath -> String # showList :: [HsFilePath] -> ShowS # | |
| Eq HsFilePath Source # | |
Defined in Distribution.Client.Init.Types | |
data HsFileType Source #
Constructors
| Literate | |
| Standard | |
| InvalidHsPath |
Instances
| Show HsFileType Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> HsFileType -> ShowS # show :: HsFileType -> String # showList :: [HsFileType] -> ShowS # | |
| Eq HsFileType Source # | |
Defined in Distribution.Client.Init.Types | |
fromHsFilePath :: HsFilePath -> Maybe FilePath Source #
toHsFilePath :: FilePath -> HsFilePath Source #
toLiterateHs :: HsFilePath -> HsFilePath Source #
toStandardHs :: HsFilePath -> HsFilePath Source #
mkLiterate :: HsFilePath -> [String] -> [String] Source #
isHsFilePath :: FilePath -> Bool Source #
Typeclasses
class Monad m => Interactive m where Source #
Methods
readFile :: FilePath -> m String Source #
getCurrentDirectory :: m FilePath Source #
getHomeDirectory :: m FilePath Source #
getDirectoryContents :: FilePath -> m [FilePath] Source #
listDirectory :: FilePath -> m [FilePath] Source #
doesDirectoryExist :: FilePath -> m Bool Source #
doesFileExist :: FilePath -> m Bool Source #
canonicalizePathNoThrow :: FilePath -> m FilePath Source #
readProcessWithExitCode :: FilePath -> [String] -> String -> m (ExitCode, String, String) Source #
maybeReadProcessWithExitCode :: FilePath -> [String] -> String -> m (Maybe (ExitCode, String, String)) Source #
getEnvironment :: m [(String, String)] Source #
getCurrentYear :: m Integer Source #
listFilesInside :: (FilePath -> m Bool) -> FilePath -> m [FilePath] Source #
listFilesRecursive :: FilePath -> m [FilePath] Source #
putStr :: String -> m () Source #
putStrLn :: String -> m () Source #
createDirectory :: FilePath -> m () Source #
removeDirectory :: FilePath -> m () Source #
writeFile :: FilePath -> String -> m () Source #
removeExistingFile :: FilePath -> m () Source #
copyFile :: FilePath -> FilePath -> m () Source #
renameDirectory :: FilePath -> FilePath -> m () Source #
hFlush :: Handle -> m () Source #
message :: Verbosity -> Severity -> String -> m () Source #
throwPrompt :: BreakException -> m a Source #
getLastChosenLanguage :: m (Maybe String) Source #
setLastChosenLanguage :: Maybe String -> m () Source #
Instances
newtype BreakException Source #
A pure exception thrown exclusively by the pure prompter to cancel infinite loops in the prompting process.
For example, in order to break on parse errors, or user-driven continuations that do not make sense to test.
Constructors
| BreakException String |
Instances
| Exception BreakException Source # | |
Defined in Distribution.Client.Init.Types Methods toException :: BreakException -> SomeException # | |
| Show BreakException Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> BreakException -> ShowS # show :: BreakException -> String # showList :: [BreakException] -> ShowS # | |
| Eq BreakException Source # | |
Defined in Distribution.Client.Init.Types Methods (==) :: BreakException -> BreakException -> Bool # (/=) :: BreakException -> BreakException -> Bool # | |
Instances
runPromptIO :: PromptIO a -> IO a Source #
data PurePrompt a Source #
Instances
runPrompt :: PurePrompt a -> Inputs -> Either BreakException (a, Inputs) Source #
evalPrompt :: PurePrompt a -> Inputs -> a Source #
Used to inform the intent of prompted messages.
Aliases
type IsLiterate = Bool Source #
Convenience alias for the literate haskell flag
File creator opts
data ProjectSettings Source #
Constructors
| ProjectSettings | |
Fields | |
Instances
| Show ProjectSettings Source # | |
Defined in Distribution.Client.Init.Types Methods showsPrec :: Int -> ProjectSettings -> ShowS # show :: ProjectSettings -> String # showList :: [ProjectSettings] -> ShowS # | |
| Eq ProjectSettings Source # | |
Defined in Distribution.Client.Init.Types Methods (==) :: ProjectSettings -> ProjectSettings -> Bool # (/=) :: ProjectSettings -> ProjectSettings -> Bool # | |
Formatters
data FieldAnnotation Source #
Annotations for cabal file PrettyField.
Constructors
| FieldAnnotation | |
Fields
| |
Other conveniences
data DefaultPrompt t Source #
Defines whether or not a prompt will have a default value, is optional, or is mandatory.
Constructors
| DefaultPrompt t | |
| OptionalPrompt | |
| MandatoryPrompt |
Instances
| Functor DefaultPrompt Source # | |
Defined in Distribution.Client.Init.Types Methods fmap :: (a -> b) -> DefaultPrompt a -> DefaultPrompt b # (<$) :: a -> DefaultPrompt b -> DefaultPrompt a # | |
| Eq t => Eq (DefaultPrompt t) Source # | |
Defined in Distribution.Client.Init.Types Methods (==) :: DefaultPrompt t -> DefaultPrompt t -> Bool # (/=) :: DefaultPrompt t -> DefaultPrompt t -> Bool # | |