-- Hoogle documentation, generated by Haddock
-- See Hoogle, http://www.haskell.org/hoogle/

-- | Lua module wrapping Text.DocLayout.
--   
--   Lua module wrapping Text.DocLayout.
@package hslua-module-doclayout
@version 1.2.1.1

-- | Provides a Lua module which wraps DocLayout. The
--   Doc type is specialized to Text.
--   
--   This module defines orphan instances for Doc Text.
module HsLua.Module.DocLayout

-- | Self-documenting module.
documentedModule :: LuaError e => Module e
pushModule :: LuaError e => Module e -> LuaE e ()
preloadModule :: LuaError e => Module e -> LuaE e ()

-- | Textual description of the "doclayout" module.
description :: Text

-- | Exposed fields.
fields :: LuaError e => [Field e]

-- | Exposed module functions.
functions :: LuaError e => [DocumentedFunction e]

-- | Creates a Doc which is conditionally included only if
--   it comes at the beginning of a line.
after_break :: LuaError e => DocumentedFunction e

-- | Conditionally includes the given Doc unless it is
--   followed by a blank space.
before_non_blank :: LuaError e => DocumentedFunction e

-- | Wrapped and documented blankline value.
blankline :: LuaError e => Field e

-- | Insert blank lines unless they exist already.
blanklines :: LuaError e => DocumentedFunction e

-- | Puts a Doc in curly braces.
braces :: LuaError e => DocumentedFunction e

-- | Puts a Doc in square brackets.
brackets :: LuaError e => DocumentedFunction e

-- | Like lblock but aligned centered.
cblock :: LuaError e => DocumentedFunction e

-- | Chomps trailing blank space off of a Doc.
chomp :: LuaError e => DocumentedFunction e

-- | Concatenates a list of Docs.
concat :: LuaError e => DocumentedFunction e

-- | Wrapped and documented cr value.
cr :: LuaError e => Field e

-- | Wraps a Doc in double quotes
double_quotes :: LuaError e => DocumentedFunction e

-- | Wrapped and documented empty value.
empty :: LuaError e => Field e

-- | Makes a Doc flush against the left margin.
flush :: LuaError e => DocumentedFunction e

-- | Creates a hanging indent.
hang :: LuaError e => DocumentedFunction e

-- | Encloses a Doc inside a start and end
--   Doc.
inside :: LuaError e => DocumentedFunction e

-- | Creates a block with the given width and content, aligned to the left.
lblock :: LuaError e => DocumentedFunction e

-- | Creates a Doc from a string.
literal :: LuaError e => DocumentedFunction e

-- | Indents a Doc by the specified number of spaces.
nest :: LuaError e => DocumentedFunction e

-- | Removes leading blank lines from a Doc.
nestle :: LuaError e => DocumentedFunction e

-- | Makes a Doc non-reflowable.
nowrap :: LuaError e => DocumentedFunction e

-- | Puts a Doc in parentheses.
parens :: LuaError e => DocumentedFunction e

-- | 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).
prefixed :: LuaError e => DocumentedFunction e

-- | Wraps a Doc in single quotes.
quotes :: LuaError e => DocumentedFunction e

-- | Like rblock but aligned to the right.
rblock :: LuaError e => DocumentedFunction e

-- | Wrapped and documented space value.
space :: LuaError e => Field e

-- | An expandable border that, when placed next to a box, expands to the
--   height of the box. Strings cycle through the list provided.
vfill :: LuaError e => DocumentedFunction e

-- | 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.
render :: LuaError e => DocumentedFunction e

-- | True iff the document is empty.
is_empty :: LuaError e => DocumentedFunction e

-- | Returns the height of a block or other Doc.
height :: LuaError e => DocumentedFunction e

-- | Returns the minimal width of a Doc when reflowed at
--   breakable spaces.
min_offset :: LuaError e => DocumentedFunction e

-- | Returns the width of a Doc.
offset :: LuaError e => DocumentedFunction e

-- | 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.
real_length :: DocumentedFunction e

-- | Returns the column that would be occupied by the last laid out
--   character.
update_column :: LuaError e => DocumentedFunction e
bold :: LuaError e => DocumentedFunction e
italic :: LuaError e => DocumentedFunction e
underlined :: LuaError e => DocumentedFunction e
strikeout :: LuaError e => DocumentedFunction e
fg :: LuaError e => DocumentedFunction e
bg :: LuaError e => DocumentedFunction e

-- | Retrieve a Doc Text value from the Lua stack. Strings are
--   converted to plain Doc values.
peekDoc :: LuaError e => Peeker e (Doc Text)

-- | Push a Doc Text value to the Lua stack.
pushDoc :: LuaError e => Pusher e (Doc Text)
instance HsLua.Class.Peekable.Peekable (Text.DocLayout.Doc Data.Text.Internal.Text)
instance HsLua.Class.Pushable.Pushable (Text.DocLayout.Doc Data.Text.Internal.Text)
