Safe Haskell	None
Language	Haskell2010

Distribution.Pretty

Contents

Utilities
Deprecated

Synopsis

class Pretty a where
- pretty :: a -> Doc
prettyShow :: Pretty a => a -> String
defaultStyle :: Style
flatStyle :: Style
showFilePath :: FilePath -> Doc
showToken :: String -> Doc
showFreeText :: String -> Doc
indentWith :: Int
type Separator = [Doc] -> Doc

Documentation

class Pretty a where Source #

Methods

pretty :: a -> Doc Source #

Instances

Instances details

Pretty Bool Source #
Instance details Defined in Distribution.Pretty Methods pretty :: Bool -> Doc Source #
Pretty Int Source #
Instance details Defined in Distribution.Pretty Methods pretty :: Int -> Doc Source #
Pretty Version Source #
Instance details Defined in Distribution.Types.Version Methods pretty :: Version -> Doc Source #
Pretty VersionRange Source #
Instance details Defined in Distribution.Types.VersionRange Methods pretty :: VersionRange -> Doc Source #
Pretty RepoType Source #
Instance details Defined in Distribution.Types.SourceRepo Methods pretty :: RepoType -> Doc Source #
Pretty RepoKind Source #
Instance details Defined in Distribution.Types.SourceRepo Methods pretty :: RepoKind -> Doc Source #
Pretty PkgconfigName Source #
Instance details Defined in Distribution.Types.PkgconfigName Methods pretty :: PkgconfigName -> Doc Source #
Pretty ForeignLibType Source #
Instance details Defined in Distribution.Types.ForeignLibType Methods pretty :: ForeignLibType -> Doc Source #
Pretty ForeignLibOption Source #
Instance details Defined in Distribution.Types.ForeignLibOption Methods pretty :: ForeignLibOption -> Doc Source #
Pretty ExecutableScope Source #
Instance details Defined in Distribution.Types.ExecutableScope Methods pretty :: ExecutableScope -> Doc Source #
Pretty ComponentId Source #
Instance details Defined in Distribution.Types.ComponentId Methods pretty :: ComponentId -> Doc Source #
Pretty BuildType Source #
Instance details Defined in Distribution.Types.BuildType Methods pretty :: BuildType -> Doc Source #
Pretty AbiHash Source #
Instance details Defined in Distribution.Types.AbiHash Methods pretty :: AbiHash -> Doc Source #
Pretty Platform Source #
Instance details Defined in Distribution.System Methods pretty :: Platform -> Doc Source #
Pretty Arch Source #
Instance details Defined in Distribution.System Methods pretty :: Arch -> Doc Source #
Pretty OS Source #
Instance details Defined in Distribution.System Methods pretty :: OS -> Doc Source #
Pretty LicenseRef Source #
Instance details Defined in Distribution.SPDX.LicenseReference Methods pretty :: LicenseRef -> Doc Source #
Pretty LicenseId Source #
Instance details Defined in Distribution.SPDX.LicenseId Methods pretty :: LicenseId -> Doc Source #
Pretty LicenseExceptionId Source #
Instance details Defined in Distribution.SPDX.LicenseExceptionId Methods pretty :: LicenseExceptionId -> Doc Source #
Pretty SimpleLicenseExpression Source #
Instance details Defined in Distribution.SPDX.LicenseExpression Methods pretty :: SimpleLicenseExpression -> Doc Source #
Pretty LicenseExpression Source #
Instance details Defined in Distribution.SPDX.LicenseExpression Methods pretty :: LicenseExpression -> Doc Source #
Pretty License Source #
Instance details Defined in Distribution.SPDX.License Methods pretty :: License -> Doc Source #
Pretty ModuleName Source #
Instance details Defined in Distribution.ModuleName Methods pretty :: ModuleName -> Doc Source #
Pretty ModuleRenaming Source #
Instance details Defined in Distribution.Types.ModuleRenaming Methods pretty :: ModuleRenaming -> Doc Source #
Pretty IncludeRenaming Source #
Instance details Defined in Distribution.Types.IncludeRenaming Methods pretty :: IncludeRenaming -> Doc Source #
Pretty TestType Source #
Instance details Defined in Distribution.Types.TestType Methods pretty :: TestType -> Doc Source #
Pretty PkgconfigDependency Source #
Instance details Defined in Distribution.Types.PkgconfigDependency Methods pretty :: PkgconfigDependency -> Doc Source #
Pretty BenchmarkType Source #
Instance details Defined in Distribution.Types.BenchmarkType Methods pretty :: BenchmarkType -> Doc Source #
Pretty License Source #
Instance details Defined in Distribution.License Methods pretty :: License -> Doc Source #
Pretty KnownExtension Source #
Instance details Defined in Language.Haskell.Extension Methods pretty :: KnownExtension -> Doc Source #
Pretty Extension Source #
Instance details Defined in Language.Haskell.Extension Methods pretty :: Extension -> Doc Source #
Pretty Language Source #
Instance details Defined in Language.Haskell.Extension Methods pretty :: Language -> Doc Source #
Pretty CompilerFlavor Source #
Instance details Defined in Distribution.Compiler Methods pretty :: CompilerFlavor -> Doc Source #
Pretty FilePathNT Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: FilePathNT -> Doc Source #
Pretty FreeText Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: FreeText -> Doc Source #
Pretty TestedWith Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: TestedWith -> Doc Source #
Pretty SpecLicense Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: SpecLicense -> Doc Source #
Pretty SpecVersion Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: SpecVersion -> Doc Source #
Pretty Token' Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: Token' -> Doc Source #
Pretty Token Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: Token -> Doc Source #
Pretty PackageName Source #
Instance details Defined in Distribution.Types.PackageName Methods pretty :: PackageName -> Doc Source #
Pretty UnqualComponentName Source #
Instance details Defined in Distribution.Types.UnqualComponentName Methods pretty :: UnqualComponentName -> Doc Source #
Pretty ComponentName Source #
Instance details Defined in Distribution.Types.ComponentName Methods pretty :: ComponentName -> Doc Source #
Pretty PackageIdentifier Source #
Instance details Defined in Distribution.Types.PackageId Methods pretty :: PackageIdentifier -> Doc Source #
Pretty DefUnitId Source #
Instance details Defined in Distribution.Types.UnitId Methods pretty :: DefUnitId -> Doc Source #
Pretty UnitId Source #	The textual format for `UnitId` coincides with the format GHC accepts for `-package-id`.
Instance details Defined in Distribution.Types.UnitId Methods pretty :: UnitId -> Doc Source #
Pretty Module Source #
Instance details Defined in Distribution.Types.Module Methods pretty :: Module -> Doc Source #
Pretty OpenModule Source #
Instance details Defined in Distribution.Backpack Methods pretty :: OpenModule -> Doc Source #
Pretty OpenUnitId Source #
Instance details Defined in Distribution.Backpack Methods pretty :: OpenUnitId -> Doc Source #
Pretty ModuleReexport Source #
Instance details Defined in Distribution.Types.ModuleReexport Methods pretty :: ModuleReexport -> Doc Source #
Pretty Mixin Source #
Instance details Defined in Distribution.Types.Mixin Methods pretty :: Mixin -> Doc Source #
Pretty ExeDependency Source #
Instance details Defined in Distribution.Types.ExeDependency Methods pretty :: ExeDependency -> Doc Source #
Pretty Dependency Source #
Instance details Defined in Distribution.Types.Dependency Methods pretty :: Dependency -> Doc Source #
Pretty MungedPackageName Source #
Instance details Defined in Distribution.Types.MungedPackageName Methods pretty :: MungedPackageName -> Doc Source #
Pretty AbiDependency Source #
Instance details Defined in Distribution.Types.AbiDependency Methods pretty :: AbiDependency -> Doc Source #
Pretty LegacyExeDependency Source #
Instance details Defined in Distribution.Types.LegacyExeDependency Methods pretty :: LegacyExeDependency -> Doc Source #
Pretty LibVersionInfo Source #
Instance details Defined in Distribution.Types.ForeignLib Methods pretty :: LibVersionInfo -> Doc Source #
Pretty FlagName Source #
Instance details Defined in Distribution.Types.GenericPackageDescription Methods pretty :: FlagName -> Doc Source #
Pretty ExposedModule Source #
Instance details Defined in Distribution.Types.ExposedModule Methods pretty :: ExposedModule -> Doc Source #
Pretty TestShowDetails Source #
Instance details Defined in Distribution.Simple.Setup Methods pretty :: TestShowDetails -> Doc Source #
Pretty a => Pretty (Identity a) Source #
Instance details Defined in Distribution.Pretty Methods pretty :: Identity a -> Doc Source #
Pretty a => Pretty (MQuoted a) Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: MQuoted a -> Doc Source #
(Newtype b a, Sep sep, Pretty b) => Pretty (List sep b a) Source #
Instance details Defined in Distribution.Parsec.Newtypes Methods pretty :: List sep b a -> Doc Source #

prettyShow :: Pretty a => a -> String 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.

flatStyle :: Style Source #

A style for rendering all on one line.

Utilities

showFilePath :: FilePath -> Doc Source #

showToken :: String -> Doc Source #

showFreeText :: String -> Doc Source #

Pretty-print free-format text, ensuring that it is vertically aligned, and with blank lines replaced by dots for correct re-parsing.

indentWith :: Int Source #

the indentation used for pretty printing

Deprecated

type Separator = [Doc] -> Doc Source #