Distribution.Pretty

Cabal-2.4.0.1: A framework for packaging Haskell software

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 #

Methods

pretty :: a -> Doc #

Instances

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

prettyShow :: Pretty a => a -> String #

defaultStyle :: Style #

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

flatStyle :: Style #

A style for rendering all on one line.

# Utilities

showFilePath :: FilePath -> Doc #

showToken :: String -> Doc #

showFreeText :: String -> Doc #

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

indentWith :: Int #

the indentation used for pretty printing

# Deprecated

type Separator = [Doc] -> Doc #