| Copyright | © 2020-2024 Albert Krewinkel |
|---|---|
| License | MIT |
| Maintainer | Albert Krewinkel <albert+hslua@zeitkraut.de> |
| Safe Haskell | Safe-Inferred |
| Language | Haskell2010 |
HsLua.Module.DocLayout
Description
Provides a Lua module which wraps DocLayoutDocText
This module defines orphan instances for Doc Text.
Synopsis
- documentedModule :: LuaError e => Module e
- pushModule :: LuaError e => Module e -> LuaE e ()
- preloadModule :: LuaError e => Module e -> LuaE e ()
- description :: Text
- fields :: forall e. LuaError e => [Field e]
- functions :: LuaError e => [DocumentedFunction e]
- after_break :: LuaError e => DocumentedFunction e
- before_non_blank :: LuaError e => DocumentedFunction e
- blankline :: forall e. LuaError e => Field e
- blanklines :: LuaError e => DocumentedFunction e
- braces :: LuaError e => DocumentedFunction e
- brackets :: LuaError e => DocumentedFunction e
- cblock :: LuaError e => DocumentedFunction e
- chomp :: LuaError e => DocumentedFunction e
- concat :: LuaError e => DocumentedFunction e
- cr :: forall e. LuaError e => Field e
- double_quotes :: LuaError e => DocumentedFunction e
- empty :: forall e. LuaError e => Field e
- flush :: LuaError e => DocumentedFunction e
- hang :: LuaError e => DocumentedFunction e
- inside :: LuaError e => DocumentedFunction e
- lblock :: LuaError e => DocumentedFunction e
- literal :: LuaError e => DocumentedFunction e
- nest :: LuaError e => DocumentedFunction e
- nestle :: LuaError e => DocumentedFunction e
- nowrap :: LuaError e => DocumentedFunction e
- parens :: LuaError e => DocumentedFunction e
- prefixed :: LuaError e => DocumentedFunction e
- quotes :: LuaError e => DocumentedFunction e
- rblock :: LuaError e => DocumentedFunction e
- space :: forall e. LuaError e => Field e
- vfill :: LuaError e => DocumentedFunction e
- render :: LuaError e => DocumentedFunction e
- is_empty :: LuaError e => DocumentedFunction e
- height :: LuaError e => DocumentedFunction e
- min_offset :: LuaError e => DocumentedFunction e
- offset :: LuaError e => DocumentedFunction e
- real_length :: DocumentedFunction e
- update_column :: LuaError e => DocumentedFunction e
- peekDoc :: LuaError e => Peeker e (Doc Text)
- pushDoc :: LuaError e => Pusher e (Doc Text)
Module
documentedModule :: LuaError e => Module e Source #
Self-documenting module.
pushModule :: LuaError e => Module e -> LuaE e () #
preloadModule :: LuaError e => Module e -> LuaE e () #
description :: Text Source #
Textual description of the "doclayout" module.
Doc constructors and combinators
after_break :: LuaError e => DocumentedFunction e Source #
Creates a Doc
before_non_blank :: LuaError e => DocumentedFunction e Source #
Conditionally includes the given Doc
blanklines :: LuaError e => DocumentedFunction e Source #
Insert blank lines unless they exist already.
double_quotes :: LuaError e => DocumentedFunction e Source #
Wraps a Doc
lblock :: LuaError e => DocumentedFunction e Source #
Creates a block with the given width and content, aligned to the left.
prefixed :: LuaError e => DocumentedFunction e Source #
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).
vfill :: LuaError e => DocumentedFunction e Source #
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 :: LuaError e => DocumentedFunction e Source #
Render a Doc
Document Querying
min_offset :: LuaError e => DocumentedFunction e Source #
Returns the minimal width of a Doc
real_length :: DocumentedFunction e Source #
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 :: LuaError e => DocumentedFunction e Source #
Returns the column that would be occupied by the last laid out character.
Marshaling
peekDoc :: LuaError e => Peeker e (Doc Text) Source #
Retrieve a Doc Text value from the Lua stack. Strings are
converted to plain Doc