Foreign.Lua.Module.DocLayout

Provides a Lua module which wraps DocLayout. The Doc' type is specialized to Text@.

This module defines orphan instances for Doc Text.

Module

pushModule :: Lua NumResults

Pushes the doclayout module to the Lua stack.

preloadModule :: String -> Lua ()

Add the doclayout module under the given name to the table of preloaded packages.

description :: Text

Textual description of the "doclayout" module.

fields :: [Field]

Exposed fields.

functions :: [(Text, HaskellFunction)]

Exposed module functions.

Doc constructors and combinators

after_break :: HaskellFunction

Creates a Doc which is conditionally included only if it comes at the beginning of a line.

before_non_blank :: HaskellFunction

Conditionally includes the given Doc unless it is followed by a blank space.

blankline :: Field

Wrapped and documented blankline value.

blanklines :: HaskellFunction

Insert blank lines unless they exist already.

braces :: HaskellFunction

Puts a Doc in curly braces.

brackets :: HaskellFunction

Puts a Doc in square brackets.

cblock :: HaskellFunction

Like lblock but aligned centered.

chomp :: HaskellFunction

Chomps trailing blank space off of a Doc.

concat :: HaskellFunction

Concatenates a list of Docs.

cr :: Field

Wrapped and documented cr value.

double_quotes :: HaskellFunction

Wraps a Doc in double quotes

empty :: Field

Wrapped and documented empty value.

flush :: HaskellFunction

Makes a Doc flush against the left margin.

hang :: HaskellFunction

Creates a hanging indent.

inside :: HaskellFunction

Encloses a Doc inside a start and end Doc.

lblock :: HaskellFunction

Creates a block with the given width and content, aligned to the left.

literal :: HaskellFunction

Creates a Doc from a string.

nest :: HaskellFunction

Indents a Doc by the specified number of spaces.

nestle :: HaskellFunction

Removes leading blank lines from a Doc.

nowrap :: HaskellFunction

Makes a Doc non-reflowable.

parens :: HaskellFunction

Puts a Doc in parentheses.

prefixed :: HaskellFunction

Uses the specified string as a prefix for every line of the inside document (except the first, if not at the beginning of the line).

quotes :: HaskellFunction

Wraps a Doc in single quotes.

rblock :: HaskellFunction

Like rblock but aligned to the right.

space :: Field

Wrapped and documented space value.

vfill :: HaskellFunction

An expandable border that, when placed next to a box, expands to the height of the box. Strings cycle through the list provided.

Rendering

render :: HaskellFunction

Render a Doc. The text is reflowed on breakable spaces to match the given line length. Text is not reflowed if the line length parameter is omitted or nil.

Document Querying

is_empty :: HaskellFunction

True iff the document is empty.

height :: HaskellFunction

Returns the height of a block or other Doc.

min_offset :: HaskellFunction

Returns the minimal width of a Doc when reflowed at breakable spaces.

offset :: HaskellFunction

Returns the width of a Doc.

real_length :: HaskellFunction

Returns the real length of a string in a monospace font: 0 for a combining character, 1, for a regular character, 2 for an East Asian wide character.

update_column :: HaskellFunction

Returns the column that would be occupied by the last laid out character.

Marshaling

peekDoc :: Peeker (Doc Text)

pushDoc :: Pusher (Doc Text)

Push a Doc Text value to the Lua stack.

Orphan instances

Peekable (Doc Text)

Methods

peek :: StackIndex -> Lua (Doc Text)

Pushable (Doc Text)

Methods

push :: Doc Text -> Lua ()