Class designating that some type has an SDoc representation

When we print a binder, we often want to print its type too. The OutputableBndr class encapsulates this idea.

Returns the separated concatenation of the pretty printed things.

Returns the comma-separated concatenation of the pretty printed things.

Returns the comma-separated concatenation of the quoted pretty printed things.

[x,y,z]  ==>  `x', `y', `z'

Indent SDoc some specified amount

Join two SDoc together horizontally without a gap

Join two SDoc together horizontally with a gap between them

Concatenate SDoc horizontally

Concatenate SDoc horizontally with a space between each one

Join two SDoc together vertically; if there is no vertical overlap it "dovetails" the two onto one line

Join two SDoc together vertically

Concatenate SDoc vertically with dovetailing

Separate: is either like hsep or like vcat, depending on what fits

Catenate: is either like hcat or like vcat, depending on what fits

A paragraph-fill combinator. It's much like sep, only it keeps fitting things on one line until it can't fit any more.

This behaves like fsep, but it uses <> for horizontal conposition rather than <+>

Converts an integer to a verbal index:

speakNth 1 = text "first"
speakNth 5 = text "fifth"
speakNth 21 = text "21st"

Converts a strictly positive integer into a number of times:

speakNTimes 1 = text "once"
speakNTimes 2 = text "twice"
speakNTimes 4 = text "4 times"

Converts an integer to a verbal multiplicity:

speakN 0 = text "none"
speakN 5 = text "five"
speakN 10 = text "10"

Converts an integer and object description to a statement about the multiplicity of those objects:

speakNOf 0 (text "melon") = text "no melons"
speakNOf 1 (text "melon") = text "one melon"
speakNOf 3 (text "melon") = text "three melons"

Determines the pluralisation suffix appropriate for the length of a list:

plural [] = char 's'
plural ["Hello"] = empty
plural ["Hello", "World"] = char 's'

Determines the form of to be appropriate for the length of a list:

isOrAre [] = ptext (sLit "are")
isOrAre ["Hello"] = ptext (sLit "is")
isOrAre ["Hello", "World"] = ptext (sLit "are")

Apply the given colour/style for the argument.

Only takes effect if colours are enabled.

A colour/style for use with coloured.

Special combinator for showing character literals.

Special combinator for showing string literals.

Special combinator for showing string literals.

BindingSite is used to tell the thing that prints binder what language construct is binding the identifier. This can be used to decide how much info to print.

When printing code that contains original names, we need to map the original names back to something the user understands. This is the purpose of the triple of functions that gets passed around when rendering SDoc.

given an original name, this function tells you which module name it should be qualified with when printing for the user, if any. For example, given Control.Exception.catch, which is in scope as Exception.catch, this fuction will return Just Exception. Note that the return value is a ModuleName, not a Module, because in source code, names are qualified by ModuleNames.

For a given module, we need to know whether to print it with a package name to disambiguate it.

For a given package, we need to know whether to print it with the package key to disambiguate it.

NB: This won't ever show package IDs

Style for printing error messages

Throw an exception saying "bug in GHC"

Throw an exception saying "this isn't finished yet"

Panic with an assertation failure, recording the given file and line number. Should typically be accessed with the ASSERT family of macros

Specialization of pprPanic that can be safely used with FastInt

Throw an exception saying "bug in pgm being compiled" (used for unusual program errors)

If debug output is on, show some SDoc on the screen

Just warn about an assertion failure, recording the given file and line number. Should typically be accessed with the WARN macros

The trace function outputs the trace message given as its first argument, before returning the second argument as its result.

For example, this returns the value of f x but first outputs the message.

trace ("calling f with x = " ++ show x) (f x)

The trace function should only be used for debugging, or for monitoring execution. The function is not referentially transparent: its type indicates that it is a pure function but it has the side effect of outputting the trace message.

Panics and asserts.

Panics and asserts.

Panics and asserts.

Panic while pretending to return an unboxed int. You can't use the regular panic functions in expressions producing unboxed ints because they have the wrong kind.

Throw an failed assertion exception for a given filename and line number.