-- 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 0.2.0
-- | Provides a Lua module which wraps DocLayout. The
-- Doc' type is specialized to Text@.
--
-- This module defines orphan instances for Doc Text.
module Foreign.Lua.Module.DocLayout
-- | Pushes the doclayout module to the Lua stack.
pushModule :: Lua NumResults
-- | Add the doclayout module under the given name to the table of
-- preloaded packages.
preloadModule :: String -> Lua ()
-- | Textual description of the "doclayout" module.
description :: Text
-- | Exposed fields.
fields :: [Field]
-- | Exposed module functions.
functions :: [(Text, HaskellFunction)]
-- | Creates a Doc which is conditionally included only if
-- it comes at the beginning of a line.
after_break :: HaskellFunction
-- | Conditionally includes the given Doc unless it is
-- followed by a blank space.
before_non_blank :: HaskellFunction
-- | Wrapped and documented blankline value.
blankline :: Field
-- | Insert blank lines unless they exist already.
blanklines :: HaskellFunction
-- | Puts a Doc in curly braces.
braces :: HaskellFunction
-- | Puts a Doc in square brackets.
brackets :: HaskellFunction
-- | Like lblock but aligned centered.
cblock :: HaskellFunction
-- | Chomps trailing blank space off of a Doc.
chomp :: HaskellFunction
-- | Concatenates a list of Docs.
concat :: HaskellFunction
-- | Wrapped and documented cr value.
cr :: Field
-- | Wraps a Doc in double quotes
double_quotes :: HaskellFunction
-- | Wrapped and documented empty value.
empty :: Field
-- | Makes a Doc flush against the left margin.
flush :: HaskellFunction
-- | Creates a hanging indent.
hang :: HaskellFunction
-- | Encloses a Doc inside a start and end
-- Doc.
inside :: HaskellFunction
-- | Creates a block with the given width and content, aligned to the left.
lblock :: HaskellFunction
-- | Creates a Doc from a string.
literal :: HaskellFunction
-- | Indents a Doc by the specified number of spaces.
nest :: HaskellFunction
-- | Removes leading blank lines from a Doc.
nestle :: HaskellFunction
-- | Makes a Doc non-reflowable.
nowrap :: HaskellFunction
-- | Puts a Doc in parentheses.
parens :: 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).
prefixed :: HaskellFunction
-- | Wraps a Doc in single quotes.
quotes :: HaskellFunction
-- | Like rblock but aligned to the right.
rblock :: HaskellFunction
-- | Wrapped and documented space value.
space :: Field
-- | An expandable border that, when placed next to a box, expands to the
-- height of the box. Strings cycle through the list provided.
vfill :: 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.
render :: HaskellFunction
-- | True iff the document is empty.
is_empty :: HaskellFunction
-- | Returns the height of a block or other Doc.
height :: HaskellFunction
-- | Returns the minimal width of a Doc when reflowed at
-- breakable spaces.
min_offset :: HaskellFunction
-- | Returns the width of a Doc.
offset :: 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.
real_length :: HaskellFunction
-- | Returns the column that would be occupied by the last laid out
-- character.
update_column :: HaskellFunction
peekDoc :: Peeker (Doc Text)
-- | Push a Doc Text value to the Lua stack.
pushDoc :: Pusher (Doc Text)
instance Foreign.Lua.Types.Peekable.Peekable (Text.DocLayout.Doc Data.Text.Internal.Text)
instance Foreign.Lua.Types.Pushable.Pushable (Text.DocLayout.Doc Data.Text.Internal.Text)