Copyright	Duncan Coutts 2007
Maintainer	cabal-devel@haskell.org
Portability	portable
Safe Haskell	None
Language	Haskell2010

Distribution.Text

Description

This defines a Text class which is a bit like the Read and Show classes. The difference is that it uses a modern pretty printer and parser system and the format is not expected to be Haskell concrete syntax but rather the external human readable representation used by Cabal.

Synopsis

class Text a where
defaultStyle :: Style
display :: Text a => a -> String
flatStyle :: Style
simpleParse :: Text a => String -> Maybe a
stdParse :: Text ver => (ver -> String -> res) -> ReadP r res

Documentation

class Text a where Source #

Note: this class will soon be deprecated. It's not yet, so that we are -Wall clean.

Methods

disp :: a -> Doc Source #

disp :: Pretty a => a -> Doc Source #

parse :: ReadP r a Source #

parse :: Parsec a => ReadP r a Source #

Instances

Text Bool #
Instance details Methods disp :: Bool -> Doc Source # parse :: ReadP r Bool Source #
Text Int #
Instance details Methods disp :: Int -> Doc Source # parse :: ReadP r Int Source #
Text Version #
Instance details Methods disp :: Version -> Doc Source # parse :: ReadP r Version Source #
Text BuildType #
Instance details Methods disp :: BuildType -> Doc Source # parse :: ReadP r BuildType Source #
Text ExecutableScope #
Instance details Methods disp :: ExecutableScope -> Doc Source # parse :: ReadP r ExecutableScope Source #
Text ForeignLibOption #
Instance details Methods disp :: ForeignLibOption -> Doc Source # parse :: ReadP r ForeignLibOption Source #
Text ForeignLibType #
Instance details Methods disp :: ForeignLibType -> Doc Source # parse :: ReadP r ForeignLibType Source #
Text Version #
Instance details Methods disp :: Version -> Doc Source # parse :: ReadP r Version Source #
Text VersionRange #
Instance details Methods disp :: VersionRange -> Doc Source # parse :: ReadP r VersionRange Source #
Text PkgconfigName #
Instance details Methods disp :: PkgconfigName -> Doc Source # parse :: ReadP r PkgconfigName Source #
Text ComponentId #
Instance details Methods disp :: ComponentId -> Doc Source # parse :: ReadP r ComponentId Source #
Text AbiHash #
Instance details Methods disp :: AbiHash -> Doc Source # parse :: ReadP r AbiHash Source #
Text ModuleName #
Instance details Methods disp :: ModuleName -> Doc Source # parse :: ReadP r ModuleName Source #
Text ModuleRenaming #
Instance details Methods disp :: ModuleRenaming -> Doc Source # parse :: ReadP r ModuleRenaming Source #
Text IncludeRenaming #
Instance details Methods disp :: IncludeRenaming -> Doc Source # parse :: ReadP r IncludeRenaming Source #
Text RepoType #
Instance details Methods disp :: RepoType -> Doc Source # parse :: ReadP r RepoType Source #
Text RepoKind #
Instance details Methods disp :: RepoKind -> Doc Source # parse :: ReadP r RepoKind Source #
Text Platform #
Instance details Methods disp :: Platform -> Doc Source # parse :: ReadP r Platform Source #
Text Arch #
Instance details Methods disp :: Arch -> Doc Source # parse :: ReadP r Arch Source #
Text OS #
Instance details Methods disp :: OS -> Doc Source # parse :: ReadP r OS Source #
Text TestType #
Instance details Methods disp :: TestType -> Doc Source # parse :: ReadP r TestType Source #
Text PkgconfigDependency #
Instance details Methods disp :: PkgconfigDependency -> Doc Source # parse :: ReadP r PkgconfigDependency Source #
Text BenchmarkType #
Instance details Methods disp :: BenchmarkType -> Doc Source # parse :: ReadP r BenchmarkType Source #
Text License #
Instance details Methods disp :: License -> Doc Source # parse :: ReadP r License Source #
Text KnownExtension #
Instance details Methods disp :: KnownExtension -> Doc Source # parse :: ReadP r KnownExtension Source #
Text Extension #
Instance details Methods disp :: Extension -> Doc Source # parse :: ReadP r Extension Source #
Text Language #
Instance details Methods disp :: Language -> Doc Source # parse :: ReadP r Language Source #
Text AbiTag #
Instance details Methods disp :: AbiTag -> Doc Source # parse :: ReadP r AbiTag Source #
Text CompilerId #
Instance details Methods disp :: CompilerId -> Doc Source # parse :: ReadP r CompilerId Source #
Text CompilerFlavor #
Instance details Methods disp :: CompilerFlavor -> Doc Source # parse :: ReadP r CompilerFlavor Source #
Text PackageName #
Instance details Methods disp :: PackageName -> Doc Source # parse :: ReadP r PackageName Source #
Text UnqualComponentName #
Instance details Methods disp :: UnqualComponentName -> Doc Source # parse :: ReadP r UnqualComponentName Source #
Text ComponentName #
Instance details Methods disp :: ComponentName -> Doc Source # parse :: ReadP r ComponentName Source #
Text PackageIdentifier #
Instance details Methods disp :: PackageIdentifier -> Doc Source # parse :: ReadP r PackageIdentifier Source #
Text DefUnitId #
Instance details Methods disp :: DefUnitId -> Doc Source # parse :: ReadP r DefUnitId Source #
Text UnitId #
Instance details Methods disp :: UnitId -> Doc Source # parse :: ReadP r UnitId Source #
Text Module #
Instance details Methods disp :: Module -> Doc Source # parse :: ReadP r Module Source #
Text OpenModule #
Instance details Methods disp :: OpenModule -> Doc Source # parse :: ReadP r OpenModule Source #
Text OpenUnitId #
Instance details Methods disp :: OpenUnitId -> Doc Source # parse :: ReadP r OpenUnitId Source #
Text ModuleReexport #
Instance details Methods disp :: ModuleReexport -> Doc Source # parse :: ReadP r ModuleReexport Source #
Text Mixin #
Instance details Methods disp :: Mixin -> Doc Source # parse :: ReadP r Mixin Source #
Text ExeDependency #
Instance details Methods disp :: ExeDependency -> Doc Source # parse :: ReadP r ExeDependency Source #
Text Dependency #
Instance details Methods disp :: Dependency -> Doc Source # parse :: ReadP r Dependency Source #
Text MungedPackageName #
Instance details Methods disp :: MungedPackageName -> Doc Source # parse :: ReadP r MungedPackageName Source #
Text MungedPackageId #
Instance details Methods disp :: MungedPackageId -> Doc Source # parse :: ReadP r MungedPackageId Source #
Text LegacyExeDependency #
Instance details Methods disp :: LegacyExeDependency -> Doc Source # parse :: ReadP r LegacyExeDependency Source #
Text LibVersionInfo #
Instance details Methods disp :: LibVersionInfo -> Doc Source # parse :: ReadP r LibVersionInfo Source #
Text FlagName #
Instance details Methods disp :: FlagName -> Doc Source # parse :: ReadP r FlagName Source #
Text AbiDependency #
Instance details Methods disp :: AbiDependency -> Doc Source # parse :: ReadP r AbiDependency Source #
Text ExposedModule #
Instance details Methods disp :: ExposedModule -> Doc Source # parse :: ReadP r ExposedModule Source #
Text TestShowDetails #
Instance details Methods disp :: TestShowDetails -> Doc Source # parse :: ReadP r TestShowDetails Source #
Text HaddockTarget #
Instance details Methods disp :: HaddockTarget -> Doc Source # parse :: ReadP r HaddockTarget Source #
Text a => Text (Identity a) #
Instance details Methods disp :: Identity a -> Doc Source # parse :: ReadP r (Identity a) Source #

defaultStyle :: Style Source #

The default rendering style used in Cabal for console output. It has a fixed page width and adds line breaks automatically.

display :: Text a => a -> String Source #

Pretty-prints with the default style.

flatStyle :: Style Source #

A style for rendering all on one line.

simpleParse :: Text a => String -> Maybe a Source #

stdParse :: Text ver => (ver -> String -> res) -> ReadP r res Source #