Distribution.Pretty

Cabal-2.1.0.0: A framework for packaging Haskell software

Safe Haskell | None
Language | Haskell2010

Distribution.Pretty

Contents

- Utilities
- Deprecated

Synopsis

- class Pretty a where
- 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 #

Minimal complete definition

pretty

Methods

pretty :: a -> Doc Source #

Instances

Pretty Bool # |
Instance details Methods pretty :: Bool -> Doc Source #
Pretty Int # |
Instance details Methods pretty :: Int -> Doc Source #
Pretty BuildType # |
Instance details Methods pretty :: BuildType -> Doc Source #
Pretty ExecutableScope # |
Instance details Methods pretty :: ExecutableScope -> Doc Source #
Pretty ForeignLibOption # |
Instance details Methods pretty :: ForeignLibOption -> Doc Source #
Pretty ForeignLibType # |
Instance details Methods pretty :: ForeignLibType -> Doc Source #
Pretty Version # |
Instance details Methods pretty :: Version -> Doc Source #
Pretty VersionRange # |
Instance details Methods pretty :: VersionRange -> Doc Source #
Pretty PkgconfigName # |
Instance details Methods pretty :: PkgconfigName -> Doc Source #
Pretty ComponentId # |
Instance details Methods pretty :: ComponentId -> Doc Source #
Pretty AbiHash # |
Instance details Methods pretty :: AbiHash -> Doc Source #
Pretty ModuleName # |
Instance details Methods pretty :: ModuleName -> Doc Source #
Pretty ModuleRenaming # |
Instance details Methods pretty :: ModuleRenaming -> Doc Source #
Pretty IncludeRenaming # |
Instance details Methods pretty :: IncludeRenaming -> Doc Source #
Pretty RepoType # |
Instance details Methods pretty :: RepoType -> Doc Source #
Pretty RepoKind # |
Instance details Methods pretty :: RepoKind -> Doc Source #
Pretty Platform # |
Instance details Methods pretty :: Platform -> Doc Source #
Pretty Arch # |
Instance details Methods pretty :: Arch -> Doc Source #
Pretty OS # |
Instance details Methods pretty :: OS -> Doc Source #
Pretty LicenseRef # |
Instance details Methods pretty :: LicenseRef -> Doc Source #
Pretty LicenseId # |
Instance details Methods pretty :: LicenseId -> Doc Source #
Pretty LicenseExceptionId # |
Instance details Methods pretty :: LicenseExceptionId -> Doc Source #
Pretty SimpleLicenseExpression # |
Instance details Methods pretty :: SimpleLicenseExpression -> Doc Source #
Pretty LicenseExpression # |
Instance details Methods pretty :: LicenseExpression -> Doc Source #
Pretty License # |
Instance details Methods pretty :: License -> Doc Source #
Pretty TestType # |
Instance details Methods pretty :: TestType -> Doc Source #
Pretty PkgconfigDependency # |
Instance details Methods pretty :: PkgconfigDependency -> Doc Source #
Pretty BenchmarkType # |
Instance details Methods pretty :: BenchmarkType -> Doc Source #
Pretty License # |
Instance details Methods pretty :: License -> Doc Source #
Pretty KnownExtension # |
Instance details Methods pretty :: KnownExtension -> Doc Source #
Pretty Extension # |
Instance details Methods pretty :: Extension -> Doc Source #
Pretty Language # |
Instance details Methods pretty :: Language -> Doc Source #
Pretty CompilerFlavor # |
Instance details Methods pretty :: CompilerFlavor -> Doc Source #
Pretty FilePathNT # |
Instance details Methods pretty :: FilePathNT -> Doc Source #
Pretty FreeText # |
Instance details Methods pretty :: FreeText -> Doc Source #
Pretty TestedWith # |
Instance details Methods pretty :: TestedWith -> Doc Source #
Pretty SpecLicense # |
Instance details Methods pretty :: SpecLicense -> Doc Source #
Pretty SpecVersion # |
Instance details Methods pretty :: SpecVersion -> Doc Source #
Pretty Token' # |
Instance details Methods pretty :: Token' -> Doc Source #
Pretty Token # |
Instance details Methods pretty :: Token -> Doc Source #
Pretty PackageName # |
Instance details Methods pretty :: PackageName -> Doc Source #
Pretty UnqualComponentName # |
Instance details Methods pretty :: UnqualComponentName -> Doc Source #
Pretty ComponentName # |
Instance details Methods pretty :: ComponentName -> Doc Source #
Pretty PackageIdentifier # |
Instance details Methods pretty :: PackageIdentifier -> Doc Source #
Pretty DefUnitId # |
Instance details Methods pretty :: DefUnitId -> Doc Source #
Pretty UnitId # | The textual format for `UnitId` coincides with the format GHC accepts for `-package-id`.
Instance details Methods pretty :: UnitId -> Doc Source #
Pretty Module # |
Instance details Methods pretty :: Module -> Doc Source #
Pretty OpenModule # |
Instance details Methods pretty :: OpenModule -> Doc Source #
Pretty OpenUnitId # |
Instance details Methods pretty :: OpenUnitId -> Doc Source #
Pretty ModuleReexport # |
Instance details Methods pretty :: ModuleReexport -> Doc Source #
Pretty Mixin # |
Instance details Methods pretty :: Mixin -> Doc Source #
Pretty ExeDependency # |
Instance details Methods pretty :: ExeDependency -> Doc Source #
Pretty Dependency # |
Instance details Methods pretty :: Dependency -> Doc Source #
Pretty MungedPackageName # |
Instance details Methods pretty :: MungedPackageName -> Doc Source #
Pretty AbiDependency # |
Instance details Methods pretty :: AbiDependency -> Doc Source #
Pretty LegacyExeDependency # |
Instance details Methods pretty :: LegacyExeDependency -> Doc Source #
Pretty LibVersionInfo # |
Instance details Methods pretty :: LibVersionInfo -> Doc Source #
Pretty FlagName # |
Instance details Methods pretty :: FlagName -> Doc Source #
Pretty ExposedModule # |
Instance details Methods pretty :: ExposedModule -> Doc Source #
Pretty TestShowDetails # |
Instance details Methods pretty :: TestShowDetails -> Doc Source #
Pretty a => Pretty (Identity a) # |
Instance details Methods pretty :: Identity a -> Doc Source #
Pretty a => Pretty (MQuoted a) # |
Instance details Methods pretty :: MQuoted a -> Doc Source #
(Newtype b a, Sep sep, Pretty b) => Pretty (List sep b a) # |
Instance details 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 #