hackport-0.7.2.1: Hackage and Portage integration tool
Safe HaskellSafe-Inferred
LanguageHaskell2010

Distribution.Pretty

Synopsis

Documentation

class Pretty a where Source #

Minimal complete definition

pretty

Methods

pretty :: a -> Doc Source #

prettyVersioned :: CabalSpecVersion -> a -> Doc Source #

Instances

Instances details
Pretty Bool Source # 
Instance details

Defined in Distribution.Pretty

Methods

pretty :: Bool -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Bool -> Doc Source #

Pretty Int Source # 
Instance details

Defined in Distribution.Pretty

Methods

pretty :: Int -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Int -> Doc Source #

Pretty Doc Source #

Since: 3.4.0.0

Instance details

Defined in Distribution.Pretty

Methods

pretty :: Doc -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Doc -> Doc Source #

Pretty Version Source # 
Instance details

Defined in Distribution.Types.Version

Methods

pretty :: Version -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Version -> Doc Source #

Pretty VersionRange Source #
>>> fmap pretty (simpleParsec' CabalSpecV1_6 "== 3.2.*" :: Maybe VersionRange)
Just >=3.2 && <3.3

>>> fmap (prettyVersioned CabalSpecV1_6) (simpleParsec' CabalSpecV1_6 "== 3.2.*" :: Maybe VersionRange)
Just ==3.2.*

>>> fmap pretty (simpleParsec' CabalSpecV1_6 "-any" :: Maybe VersionRange)
Just >=0

>>> fmap (prettyVersioned CabalSpecV1_6) (simpleParsec' CabalSpecV1_6 "-any" :: Maybe VersionRange)
Just >=0
Instance details

Defined in Distribution.Types.VersionRange.Internal

Methods

pretty :: VersionRange -> Doc Source #

prettyVersioned :: CabalSpecVersion -> VersionRange -> Doc Source #

Pretty RepoType Source # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoType -> Doc Source #

prettyVersioned :: CabalSpecVersion -> RepoType -> Doc Source #

Pretty KnownRepoType Source # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: KnownRepoType -> Doc Source #

prettyVersioned :: CabalSpecVersion -> KnownRepoType -> Doc Source #

Pretty RepoKind Source # 
Instance details

Defined in Distribution.Types.SourceRepo

Methods

pretty :: RepoKind -> Doc Source #

prettyVersioned :: CabalSpecVersion -> RepoKind -> Doc Source #

Pretty PkgconfigName Source # 
Instance details

Defined in Distribution.Types.PkgconfigName

Methods

pretty :: PkgconfigName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> PkgconfigName -> Doc Source #

Pretty PkgconfigDependency Source # 
Instance details

Defined in Distribution.Types.PkgconfigDependency

Methods

pretty :: PkgconfigDependency -> Doc Source #

prettyVersioned :: CabalSpecVersion -> PkgconfigDependency -> Doc Source #

Pretty PackageName Source # 
Instance details

Defined in Distribution.Types.PackageName

Methods

pretty :: PackageName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> PackageName -> Doc Source #

Pretty UnqualComponentName Source # 
Instance details

Defined in Distribution.Types.UnqualComponentName

Methods

pretty :: UnqualComponentName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> UnqualComponentName -> Doc Source #

Pretty LibraryVisibility Source # 
Instance details

Defined in Distribution.Types.LibraryVisibility

Methods

pretty :: LibraryVisibility -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LibraryVisibility -> Doc Source #

Pretty ForeignLibType Source # 
Instance details

Defined in Distribution.Types.ForeignLibType

Methods

pretty :: ForeignLibType -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ForeignLibType -> Doc Source #

Pretty ForeignLibOption Source # 
Instance details

Defined in Distribution.Types.ForeignLibOption

Methods

pretty :: ForeignLibOption -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ForeignLibOption -> Doc Source #

Pretty FlagAssignment Source #

Since: 3.4.0.0

Instance details

Defined in Distribution.Types.Flag

Methods

pretty :: FlagAssignment -> Doc Source #

prettyVersioned :: CabalSpecVersion -> FlagAssignment -> Doc Source #

Pretty FlagName Source # 
Instance details

Defined in Distribution.Types.Flag

Methods

pretty :: FlagName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> FlagName -> Doc Source #

Pretty ExecutableScope Source # 
Instance details

Defined in Distribution.Types.ExecutableScope

Methods

pretty :: ExecutableScope -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ExecutableScope -> Doc Source #

Pretty ComponentName Source # 
Instance details

Defined in Distribution.Types.ComponentName

Methods

pretty :: ComponentName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ComponentName -> Doc Source #

Pretty ComponentId Source # 
Instance details

Defined in Distribution.Types.ComponentId

Methods

pretty :: ComponentId -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ComponentId -> Doc Source #

Pretty BuildType Source # 
Instance details

Defined in Distribution.Types.BuildType

Methods

pretty :: BuildType -> Doc Source #

prettyVersioned :: CabalSpecVersion -> BuildType -> Doc Source #

Pretty AbiHash Source # 
Instance details

Defined in Distribution.Types.AbiHash

Methods

pretty :: AbiHash -> Doc Source #

prettyVersioned :: CabalSpecVersion -> AbiHash -> Doc Source #

Pretty Platform Source # 
Instance details

Defined in Distribution.System

Methods

pretty :: Platform -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Platform -> Doc Source #

Pretty Arch Source # 
Instance details

Defined in Distribution.System

Methods

pretty :: Arch -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Arch -> Doc Source #

Pretty OS Source # 
Instance details

Defined in Distribution.System

Methods

pretty :: OS -> Doc Source #

prettyVersioned :: CabalSpecVersion -> OS -> Doc Source #

Pretty LicenseRef Source # 
Instance details

Defined in Distribution.SPDX.LicenseReference

Methods

pretty :: LicenseRef -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LicenseRef -> Doc Source #

Pretty LicenseId Source # 
Instance details

Defined in Distribution.SPDX.LicenseId

Methods

pretty :: LicenseId -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LicenseId -> Doc Source #

Pretty LicenseExceptionId Source # 
Instance details

Defined in Distribution.SPDX.LicenseExceptionId

Methods

pretty :: LicenseExceptionId -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LicenseExceptionId -> Doc Source #

Pretty SimpleLicenseExpression Source # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: SimpleLicenseExpression -> Doc Source #

prettyVersioned :: CabalSpecVersion -> SimpleLicenseExpression -> Doc Source #

Pretty LicenseExpression Source # 
Instance details

Defined in Distribution.SPDX.LicenseExpression

Methods

pretty :: LicenseExpression -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LicenseExpression -> Doc Source #

Pretty License Source # 
Instance details

Defined in Distribution.SPDX.License

Methods

pretty :: License -> Doc Source #

prettyVersioned :: CabalSpecVersion -> License -> Doc Source #

Pretty ModuleName Source # 
Instance details

Defined in Distribution.ModuleName

Methods

pretty :: ModuleName -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ModuleName -> Doc Source #

Pretty Verbosity Source # 
Instance details

Defined in Distribution.Verbosity

Methods

pretty :: Verbosity -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Verbosity -> Doc Source #

Pretty TestType Source # 
Instance details

Defined in Distribution.Types.TestType

Methods

pretty :: TestType -> Doc Source #

prettyVersioned :: CabalSpecVersion -> TestType -> Doc Source #

Pretty PackageIdentifier Source # 
Instance details

Defined in Distribution.Types.PackageId

Methods

pretty :: PackageIdentifier -> Doc Source #

prettyVersioned :: CabalSpecVersion -> PackageIdentifier -> Doc Source #

Pretty DefUnitId Source # 
Instance details

Defined in Distribution.Types.UnitId

Methods

pretty :: DefUnitId -> Doc Source #

prettyVersioned :: CabalSpecVersion -> 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 #

prettyVersioned :: CabalSpecVersion -> UnitId -> Doc Source #

Pretty Module Source # 
Instance details

Defined in Distribution.Types.Module

Methods

pretty :: Module -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Module -> Doc Source #

Pretty ExposedModule Source # 
Instance details

Defined in Distribution.Types.ExposedModule

Methods

pretty :: ExposedModule -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ExposedModule -> Doc Source #

Pretty PackageVersionConstraint Source # 
Instance details

Defined in Distribution.Types.PackageVersionConstraint

Methods

pretty :: PackageVersionConstraint -> Doc Source #

prettyVersioned :: CabalSpecVersion -> PackageVersionConstraint -> Doc Source #

Pretty MungedPackageId Source #
>>> prettyShow $ MungedPackageId (MungedPackageName "servant" LMainLibName) (mkVersion [1,2,3])
"servant-1.2.3"

>>> prettyShow $ MungedPackageId (MungedPackageName "servant" (LSubLibName "lackey")) (mkVersion [0,1,2])
"z-servant-z-lackey-0.1.2"
Instance details

Defined in Distribution.Types.MungedPackageId

Methods

pretty :: MungedPackageId -> Doc Source #

prettyVersioned :: CabalSpecVersion -> MungedPackageId -> Doc Source #

Pretty LegacyExeDependency Source # 
Instance details

Defined in Distribution.Types.LegacyExeDependency

Methods

pretty :: LegacyExeDependency -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LegacyExeDependency -> Doc Source #

Pretty ExeDependency Source # 
Instance details

Defined in Distribution.Types.ExeDependency

Methods

pretty :: ExeDependency -> Doc Source #

prettyVersioned :: CabalSpecVersion -> ExeDependency -> Doc Source #

Pretty Dependency Source #
>>> prettyShow $ Dependency "pkg" anyVersion mainLibSet
"pkg"

>>> prettyShow $ Dependency "pkg" anyVersion $ NES.insert (LSubLibName "sublib") mainLibSet
"pkg:{pkg, sublib}"

>>> prettyShow $ Dependency "pkg" anyVersion $ NES.singleton (LSubLibName "sublib")
"pkg:sublib"

>>> prettyShow $ Dependency "pkg" anyVersion $ NES.insert (LSubLibName "sublib-b") $ NES.singleton (LSubLibName "sublib-a")
"pkg:{sublib-a, sublib-b}"
Instance details

Defined in Distribution.Types.Dependency

Methods

pretty :: Dependency -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Dependency -> Doc Source #

Pretty BenchmarkType Source # 
Instance details

Defined in Distribution.Types.BenchmarkType

Methods

pretty :: BenchmarkType -> Doc Source #

prettyVersioned :: CabalSpecVersion -> BenchmarkType -> Doc Source #

Pretty AbiDependency Source # 
Instance details

Defined in Distribution.Types.AbiDependency

Methods

pretty :: AbiDependency -> Doc Source #

prettyVersioned :: CabalSpecVersion -> AbiDependency -> Doc Source #

Pretty License Source # 
Instance details

Defined in Distribution.License

Methods

pretty :: License -> Doc Source #

prettyVersioned :: CabalSpecVersion -> License -> Doc Source #

Pretty KnownExtension Source # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: KnownExtension -> Doc Source #

prettyVersioned :: CabalSpecVersion -> KnownExtension -> Doc Source #

Pretty Extension Source # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: Extension -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Extension -> Doc Source #

Pretty Language Source # 
Instance details

Defined in Language.Haskell.Extension

Methods

pretty :: Language -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Language -> Doc Source #

Pretty AbiTag Source # 
Instance details

Defined in Distribution.Compiler

Methods

pretty :: AbiTag -> Doc Source #

prettyVersioned :: CabalSpecVersion -> AbiTag -> Doc Source #

Pretty CompilerId Source # 
Instance details

Defined in Distribution.Compiler

Methods

pretty :: CompilerId -> Doc Source #

prettyVersioned :: CabalSpecVersion -> CompilerId -> Doc Source #

Pretty CompilerFlavor Source # 
Instance details

Defined in Distribution.Compiler

Methods

pretty :: CompilerFlavor -> Doc Source #

prettyVersioned :: CabalSpecVersion -> CompilerFlavor -> Doc Source #

Pretty LibVersionInfo Source # 
Instance details

Defined in Distribution.Types.ForeignLib

Methods

pretty :: LibVersionInfo -> Doc Source #

prettyVersioned :: CabalSpecVersion -> LibVersionInfo -> Doc Source #

Pretty TestedWith Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: TestedWith -> Doc Source #

prettyVersioned :: CabalSpecVersion -> TestedWith -> Doc Source #

Pretty SpecLicense Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: SpecLicense -> Doc Source #

prettyVersioned :: CabalSpecVersion -> SpecLicense -> Doc Source #

Pretty SpecVersion Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: SpecVersion -> Doc Source #

prettyVersioned :: CabalSpecVersion -> SpecVersion -> Doc Source #

Pretty FilePathNT Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: FilePathNT -> Doc Source #

prettyVersioned :: CabalSpecVersion -> FilePathNT -> Doc Source #

Pretty Token' Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Token' -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Token' -> Doc Source #

Pretty Token Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Token -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Token -> Doc Source #

Pretty TestShowDetails Source # 
Instance details

Defined in Distribution.Simple.Setup

Methods

pretty :: TestShowDetails -> Doc Source #

prettyVersioned :: CabalSpecVersion -> TestShowDetails -> Doc Source #

Pretty HaddockTarget Source # 
Instance details

Defined in Distribution.Simple.Setup

Methods

pretty :: HaddockTarget -> Doc Source #

prettyVersioned :: CabalSpecVersion -> HaddockTarget -> Doc Source #

FieldGrammar Pretty PrettyFieldGrammar Source # 
Instance details

Defined in Distribution.FieldGrammar.Pretty

Methods

blurFieldGrammar :: ALens' a b -> PrettyFieldGrammar b d -> PrettyFieldGrammar a d Source #

uniqueFieldAla :: (Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a Source #

booleanFieldDef :: FieldName -> ALens' s Bool -> Bool -> PrettyFieldGrammar s Bool Source #

optionalFieldAla :: (Pretty b, Newtype a b) => FieldName -> (a -> b) -> ALens' s (Maybe a) -> PrettyFieldGrammar s (Maybe a) Source #

optionalFieldDefAla :: (Pretty b, Newtype a b, Eq a) => FieldName -> (a -> b) -> ALens' s a -> a -> PrettyFieldGrammar s a Source #

freeTextField :: FieldName -> ALens' s (Maybe String) -> PrettyFieldGrammar s (Maybe String) Source #

freeTextFieldDef :: FieldName -> ALens' s String -> PrettyFieldGrammar s String Source #

freeTextFieldDefST :: FieldName -> ALens' s ShortText -> PrettyFieldGrammar s ShortText Source #

monoidalFieldAla :: (Pretty b, Monoid a, Newtype a b) => FieldName -> (a -> b) -> ALens' s a -> PrettyFieldGrammar s a Source #

prefixedFields :: FieldName -> ALens' s [(String, String)] -> PrettyFieldGrammar s [(String, String)] Source #

knownField :: FieldName -> PrettyFieldGrammar s () Source #

hiddenField :: PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source #

deprecatedSince :: CabalSpecVersion -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source #

removedIn :: CabalSpecVersion -> String -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source #

availableSince :: CabalSpecVersion -> a -> PrettyFieldGrammar s a -> PrettyFieldGrammar s a Source #

Pretty a => Pretty (Identity a) Source # 
Instance details

Defined in Distribution.Pretty

Methods

pretty :: Identity a -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Identity a -> Doc Source #

Pretty a => Pretty (MQuoted a) Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: MQuoted a -> Doc Source #

prettyVersioned :: CabalSpecVersion -> MQuoted a -> Doc Source #

(Newtype a b, Sep sep, Pretty b) => Pretty (Set' sep b a) Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: Set' sep b a -> Doc Source #

prettyVersioned :: CabalSpecVersion -> Set' sep b a -> Doc Source #

(Newtype a b, Sep sep, Pretty b) => Pretty (List sep b a) Source # 
Instance details

Defined in Distribution.FieldGrammar.Newtypes

Methods

pretty :: List sep b a -> Doc Source #

prettyVersioned :: CabalSpecVersion -> 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.

showFreeTextV3 :: String -> Doc Source #

Pretty-print free-format text. Since cabal-version: 3.0 we don't replace blank lines with dots.

Since: 3.0.0.0

Deprecated

type Separator = [Doc] -> Doc Source #