| Safe Haskell | Safe-Inferred |
|---|---|
| Language | Haskell2010 |
Twee.Pretty
Contents
Description
Pretty-printing of terms and assorted other values.
Synopsis
- newtype TermStyle = TermStyle {
- pPrintTerm :: forall a. Pretty a => PrettyLevel -> Rational -> Doc -> [a] -> Doc
- class Pretty f => PrettyTerm f where
- type ANSICode = String
- data HighlightedTerm f = HighlightedTerm [ANSICode] (Maybe [Int]) (Term f)
- prettyPrint :: Pretty a => a -> IO ()
- (<#>) :: Doc -> Doc -> Doc
- pPrintEmpty :: Doc
- pPrintTuple :: [Doc] -> Doc
- pPrintSet :: [Doc] -> Doc
- supply :: [String] -> [String]
- green :: ANSICode
- bold :: ANSICode
- highlight :: [ANSICode] -> Doc -> Doc
- maybeHighlight :: [ANSICode] -> Maybe [Int] -> Doc -> Doc
- invisible :: TermStyle
- curried :: TermStyle
- uncurried :: TermStyle
- fixedArity :: Int -> TermStyle -> TermStyle
- implicitArguments :: Int -> TermStyle -> TermStyle
- prefix :: TermStyle
- postfix :: TermStyle
- infixStyle :: Int -> TermStyle
- tupleStyle :: TermStyle
- newtype PrettyLevel = PrettyLevel Int
- class Pretty a where
- pPrintPrec :: PrettyLevel -> Rational -> a -> Doc
- pPrint :: a -> Doc
- pPrintList :: PrettyLevel -> [a] -> Doc
- prettyShow :: Pretty a => a -> String
- prettyParen :: Bool -> Doc -> Doc
- prettyNormal :: PrettyLevel
- data Doc
- zeroWidthText :: String -> Doc
- vcat :: [Doc] -> Doc
- text :: String -> Doc
- space :: Doc
- sizedText :: Int -> String -> Doc
- sep :: [Doc] -> Doc
- semi :: Doc
- rparen :: Doc
- renderStyle :: Style -> Doc -> String
- render :: Doc -> String
- reduceDoc :: Doc -> RDoc
- rbrack :: Doc
- rbrace :: Doc
- rational :: Rational -> Doc
- quotes :: Doc -> Doc
- punctuate :: Doc -> [Doc] -> [Doc]
- ptext :: String -> Doc
- parens :: Doc -> Doc
- nest :: Int -> Doc -> Doc
- maybeQuotes :: Bool -> Doc -> Doc
- maybeParens :: Bool -> Doc -> Doc
- maybeDoubleQuotes :: Bool -> Doc -> Doc
- maybeBrackets :: Bool -> Doc -> Doc
- maybeBraces :: Bool -> Doc -> Doc
- lparen :: Doc
- lbrack :: Doc
- lbrace :: Doc
- isEmpty :: Doc -> Bool
- integer :: Integer -> Doc
- int :: Int -> Doc
- hsep :: [Doc] -> Doc
- hcat :: [Doc] -> Doc
- hang :: Doc -> Int -> Doc -> Doc
- fullRender :: Mode -> Int -> Float -> (TextDetails -> a -> a) -> a -> Doc -> a
- fsep :: [Doc] -> Doc
- float :: Float -> Doc
- first :: Doc -> Doc -> Doc
- fcat :: [Doc] -> Doc
- equals :: Doc
- doubleQuotes :: Doc -> Doc
- double :: Double -> Doc
- comma :: Doc
- colon :: Doc
- char :: Char -> Doc
- cat :: [Doc] -> Doc
- brackets :: Doc -> Doc
- braces :: Doc -> Doc
- (<+>) :: Doc -> Doc -> Doc
- ($+$) :: Doc -> Doc -> Doc
- ($$) :: Doc -> Doc -> Doc
- data TextDetails
- data Style = Style {
- mode :: Mode
- lineLength :: Int
- ribbonsPerLine :: Float
- data Mode
- style :: Style
- class Pretty a where
- pPrintPrec :: PrettyLevel -> Rational -> a -> Doc
- pPrint :: a -> Doc
- pPrintList :: PrettyLevel -> [a] -> Doc
Documentation
Defines how to print out a function symbol.
Constructors
| TermStyle | |
Fields
| |
class Pretty f => PrettyTerm f where Source #
A class for customising the printing of function symbols.
Minimal complete definition
Nothing
data HighlightedTerm f Source #
Constructors
| HighlightedTerm [ANSICode] (Maybe [Int]) (Term f) |
Instances
| (Labelled f, PrettyTerm f) => Pretty (HighlightedTerm f) Source # | |
Defined in Twee.Pretty Methods pPrintPrec :: PrettyLevel -> Rational -> HighlightedTerm f -> Doc # pPrint :: HighlightedTerm f -> Doc # pPrintList :: PrettyLevel -> [HighlightedTerm f] -> Doc # | |
prettyPrint :: Pretty a => a -> IO () Source #
Print a value to the console.
pPrintEmpty :: Doc Source #
The empty document. Used to avoid name clashes with empty.
pPrintTuple :: [Doc] -> Doc Source #
Print a tuple of values.
fixedArity :: Int -> TermStyle -> TermStyle Source #
A helper function that deals with under- and oversaturated applications.
implicitArguments :: Int -> TermStyle -> TermStyle Source #
A helper function that drops a certain number of arguments.
infixStyle :: Int -> TermStyle Source #
For infix operators.
tupleStyle :: TermStyle Source #
For tuples.
newtype PrettyLevel #
Level of detail in the pretty printed output. Level 0 is the least detail.
Constructors
| PrettyLevel Int |
Instances
| Show PrettyLevel | |
Defined in Text.PrettyPrint.HughesPJClass Methods showsPrec :: Int -> PrettyLevel -> ShowS # show :: PrettyLevel -> String # showList :: [PrettyLevel] -> ShowS # | |
| Eq PrettyLevel | |
Defined in Text.PrettyPrint.HughesPJClass | |
| Ord PrettyLevel | |
Defined in Text.PrettyPrint.HughesPJClass Methods compare :: PrettyLevel -> PrettyLevel -> Ordering # (<) :: PrettyLevel -> PrettyLevel -> Bool # (<=) :: PrettyLevel -> PrettyLevel -> Bool # (>) :: PrettyLevel -> PrettyLevel -> Bool # (>=) :: PrettyLevel -> PrettyLevel -> Bool # max :: PrettyLevel -> PrettyLevel -> PrettyLevel # min :: PrettyLevel -> PrettyLevel -> PrettyLevel # | |
Pretty printing class. The precedence level is used in a similar way as in
the Show class. Minimal complete definition is either pPrintPrec or
pPrint.
Minimal complete definition
Instances
prettyShow :: Pretty a => a -> String #
Pretty print a value with the prettyNormal level.
prettyParen :: Bool -> Doc -> Doc #
Parenthesize an value if the boolean is true.
The "normal" (Level 0) of detail.
The abstract type of documents. A Doc represents a set of layouts. A Doc with no occurrences of Union or NoDoc represents just one layout.
Instances
| IsString Doc | |
Defined in Text.PrettyPrint.HughesPJ Methods fromString :: String -> Doc # | |
| Monoid Doc | |
| Semigroup Doc | |
| Generic Doc | |
| Show Doc | |
| NFData Doc | |
Defined in Text.PrettyPrint.HughesPJ | |
| Eq Doc | |
| Pretty Doc Source # | |
Defined in Twee.Pretty Methods pPrintPrec :: PrettyLevel -> Rational -> Doc -> Doc # pPrintList :: PrettyLevel -> [Doc] -> Doc # | |
| type Rep Doc | |
Defined in Text.PrettyPrint.HughesPJ | |
zeroWidthText :: String -> Doc #
Some text, but without any width. Use for non-printing text such as a HTML or Latex tags
renderStyle :: Style -> Doc -> String #
Render the Doc to a String using the given Style.
punctuate :: Doc -> [Doc] -> [Doc] #
punctuate p [d1, ... dn] = [d1 <> p, d2 <> p, ... dn-1 <> p, dn]
Nest (or indent) a document by a given number of positions
(which may also be negative). nest satisfies the laws:
nest0 x = xnestk (nestk' x) =nest(k+k') xnestk (x<>y) =nestk x<>nestk ynestk (x$$y) =nestk x$$nestk ynestkempty=emptyx, if<>nestk y = x<>yxnon-empty
The side condition on the last law is needed because
empty is a left identity for <>.
maybeDoubleQuotes :: Bool -> Doc -> Doc #
Apply doubleQuotes to Doc if boolean is true.
Arguments
| :: Mode | Rendering mode. |
| -> Int | Line length. |
| -> Float | Ribbons per line. |
| -> (TextDetails -> a -> a) | What to do with text. |
| -> a | What to do at the end. |
| -> Doc | The document. |
| -> a | Result. |
The general rendering interface. Please refer to the Style and Mode
types for a description of rendering mode, line length and ribbons.
first returns its first argument if it is non-empty, otherwise its second.
($$) :: Doc -> Doc -> Doc infixl 5 #
Above, except that if the last line of the first argument stops at least one position before the first line of the second begins, these two lines are overlapped. For example:
text "hi" $$ nest 5 (text "there")
lays out as
hi there
rather than
hi
theredata TextDetails #
A TextDetails represents a fragment of text that will be output at some
point in a Doc.
Constructors
| Chr !Char | A single Char fragment |
| Str String | A whole String fragment |
| PStr String | Used to represent a Fast String fragment but now deprecated and identical to the Str constructor. |
Instances
A rendering style. Allows us to specify constraints to choose among the many different rendering options.
Constructors
| Style | |
Fields
| |
Instances
| Generic Style | |
| Show Style | |
| Eq Style | |
| type Rep Style | |
Defined in Text.PrettyPrint.Annotated.HughesPJ type Rep Style = D1 ('MetaData "Style" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" 'False) (C1 ('MetaCons "Style" 'PrefixI 'True) (S1 ('MetaSel ('Just "mode") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Mode) :*: (S1 ('MetaSel ('Just "lineLength") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Int) :*: S1 ('MetaSel ('Just "ribbonsPerLine") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedLazy) (Rec0 Float)))) | |
Rendering mode.
Constructors
| PageMode | Normal rendering ( |
| ZigZagMode | With zig-zag cuts. |
| LeftMode | No indentation, infinitely long lines ( |
| OneLineMode | All on one line, |
Instances
| Generic Mode | |
| Show Mode | |
| Eq Mode | |
| type Rep Mode | |
Defined in Text.PrettyPrint.Annotated.HughesPJ type Rep Mode = D1 ('MetaData "Mode" "Text.PrettyPrint.Annotated.HughesPJ" "pretty-1.1.3.6" 'False) ((C1 ('MetaCons "PageMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "ZigZagMode" 'PrefixI 'False) (U1 :: Type -> Type)) :+: (C1 ('MetaCons "LeftMode" 'PrefixI 'False) (U1 :: Type -> Type) :+: C1 ('MetaCons "OneLineMode" 'PrefixI 'False) (U1 :: Type -> Type))) | |
Pretty printing class. The precedence level is used in a similar way as in
the Show class. Minimal complete definition is either pPrintPrec or
pPrint.
Minimal complete definition