base-4.6.0.1: Basic libraries

Portabilityportable
Stabilityprovisional
Maintainerlibraries@haskell.org
Safe HaskellSafe

Text.Show

Description

Converting values to readable strings: the Show class and associated functions.

Synopsis

Documentation

typeShowS = String -> StringSource

The shows functions return a function that prepends the output String to an existing String. This allows constant-time concatenation of results using function composition.

classShow a whereSource

Conversion of values to readable Strings.

Minimal complete definition: showsPrec or show.

Derived instances of Show have the following properties, which are compatible with derived instances of Read:

  • The result of show is a syntactically correct Haskell expression containing only constants, given the fixity declarations in force at the point where the type is declared. It contains only the constructor names defined in the data type, parentheses, and spaces. When labelled constructor fields are used, braces, commas, field names, and equal signs are also used.
  • If the constructor is defined to be an infix operator, then showsPrec will produce infix applications of the constructor.
  • the representation will be enclosed in parentheses if the precedence of the top-level constructor in x is less than d (associativity is ignored). Thus, if d is 0 then the result is never surrounded in parentheses; if d is 11 it is always surrounded in parentheses, unless it is an atomic expression.
  • If the constructor is defined using record syntax, then show will produce the record-syntax form, with the fields given in the same order as the original declaration.

For example, given the declarations

 infixr 5 :^: data Tree a = Leaf a | Tree a :^: Tree a 

the derived instance of Show is equivalent to

 instance (Show a) => Show (Tree a) where showsPrec d (Leaf m) = showParen (d > app_prec) $ showString "Leaf " . showsPrec (app_prec+1) m where app_prec = 10 showsPrec d (u :^: v) = showParen (d > up_prec) $ showsPrec (up_prec+1) u . showString " :^: " . showsPrec (up_prec+1) v where up_prec = 5 

Note that right-associativity of :^: is ignored. For example,

  • show (Leaf 1 :^: Leaf 2 :^: Leaf 3) produces the string "Leaf 1 :^: (Leaf 2 :^: Leaf 3)".

Methods

showsPrecSource

Arguments

:: Int

the operator precedence of the enclosing context (a number from 0 to 11). Function application has precedence 10.

-> a

the value to be converted to a String

-> ShowS 

Convert a value to a readable String.

showsPrec should satisfy the law

 showsPrec d x r ++ s == showsPrec d x (r ++ s) 

Derived instances of Read and Show satisfy the following:

That is, readsPrec parses the string produced by showsPrec, and delivers the value that showsPrec started with.

show :: a -> StringSource

A specialised variant of showsPrec, using precedence context zero, and returning an ordinary String.

showList :: [a] -> ShowSSource

The method showList is provided to allow the programmer to give a specialised way of showing lists of values. For example, this is used by the predefined Show instance of the Char type, where values of type String should be shown in double quotes, rather than between square brackets.

Instances

ShowBool 
ShowChar 
ShowDouble 
ShowFloat 
ShowInt 
ShowInt8 
ShowInt16 
ShowInt32 
ShowInt64 
ShowInteger 
ShowOrdering 
ShowWord 
ShowWord8 
ShowWord16 
ShowWord32 
ShowWord64 
Show () 
ShowTyCon 
ShowTypeRep 
ShowArithException 
ShowErrorCall 
ShowSomeException 
ShowIOException 
ShowMaskingState 
ShowLexeme 
ShowIOMode 
ShowSeekMode 
ShowCUIntMax 
ShowCIntMax 
ShowCUIntPtr 
ShowCIntPtr 
ShowCSUSeconds 
ShowCUSeconds 
ShowCTime 
ShowCClock 
ShowCSigAtomic 
ShowCWchar 
ShowCSize 
ShowCPtrdiff 
ShowCDouble 
ShowCFloat 
ShowCULLong 
ShowCLLong 
ShowCULong 
ShowCLong 
ShowCUInt 
ShowCInt 
ShowCUShort 
ShowCShort 
ShowCUChar 
ShowCSChar 
ShowCChar 
ShowGeneralCategory 
ShowAssociativity 
ShowFixity 
ShowArity 
ShowDynamic 
ShowIntPtr 
ShowWordPtr 
ShowAny 
ShowAll 
ShowCodingProgress 
ShowTextEncoding 
ShowNewlineMode 
ShowNewline 
ShowBufferMode 
ShowHandle 
ShowIOErrorType 
ShowExitCode 
ShowArrayException 
ShowAsyncException 
ShowAssertionFailed 
ShowDeadlock 
ShowBlockedIndefinitelyOnSTM 
ShowBlockedIndefinitelyOnMVar 
ShowCodingFailureMode 
ShowThreadStatus 
ShowBlockReason 
ShowThreadId 
ShowNestedAtomically 
ShowNonTermination 
ShowNoMethodError 
ShowRecUpdError 
ShowRecConError 
ShowRecSelError 
ShowPatternMatchFail 
ShowFd 
ShowCRLim 
ShowCTcflag 
ShowCSpeed 
ShowCCc 
ShowCUid 
ShowCNlink 
ShowCGid 
ShowCSsize 
ShowCPid 
ShowCOff 
ShowCMode 
ShowCIno 
ShowCDev 
ShowEvent 
ShowFdKey 
ShowHandlePosn 
ShowFixity 
ShowConstrRep 
ShowDataRep 
ShowConstr 
ShowDataType 
ShowGCStats 
ShowVersion 
Show a => Show [a] 
(Integral a, Show a) => Show (Ratio a) 
Show (Ptr a) 
Show (FunPtr a) 
Show a => Show (Maybe a) 
Show (ForeignPtr a) 
Show (IsEven n) 
Show (IsZero n) 
Show a => Show (Last a) 
Show a => Show (First a) 
Show a => Show (Product a) 
Show a => Show (Sum a) 
Show a => Show (Dual a) 
Show a => Show (Complex a) 
HasResolution a => Show (Fixed a) 
Show (a -> b) 
(Show a, Show b) => Show (Either a b) 
(Show a, Show b) => Show (a, b) 
Show (ST s a) 
(SingE k (Kind k) rep, Show rep) => Show (Sing k a) 
(Show a, Show b, Show c) => Show (a, b, c) 
(Show a, Show b, Show c, Show d) => Show (a, b, c, d) 
(Show a, Show b, Show c, Show d, Show e) => Show (a, b, c, d, e) 
(Show a, Show b, Show c, Show d, Show e, Show f) => Show (a, b, c, d, e, f) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g) => Show (a, b, c, d, e, f, g) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h) => Show (a, b, c, d, e, f, g, h) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i) => Show (a, b, c, d, e, f, g, h, i) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j) => Show (a, b, c, d, e, f, g, h, i, j) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k) => Show (a, b, c, d, e, f, g, h, i, j, k) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l) => Show (a, b, c, d, e, f, g, h, i, j, k, l) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l, Show m) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l, Show m, Show n) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m, n) 
(Show a, Show b, Show c, Show d, Show e, Show f, Show g, Show h, Show i, Show j, Show k, Show l, Show m, Show n, Show o) => Show (a, b, c, d, e, f, g, h, i, j, k, l, m, n, o) 

shows :: Show a => a -> ShowSSource

equivalent to showsPrec with a precedence of 0.

showChar :: Char -> ShowSSource

utility function converting a Char to a show function that simply prepends the character unchanged.

showString :: String -> ShowSSource

utility function converting a String to a show function that simply prepends the string unchanged.

showParen :: Bool -> ShowS -> ShowSSource

utility function that surrounds the inner show function with parentheses when the Bool parameter is True.

showListWith :: (a -> ShowS) -> [a] -> ShowSSource

Show a list (using square brackets and commas), given a function for showing elements.

close