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


-- | a tiny gemtext parser
--   
--   gemmula is a tiny gemtext (unofficially <tt>text/gemini</tt>) parser
--   from and back into <a>Text</a>, attempting to be <i>mostly</i>
--   compliant with the <a>Gemini hypertext format specification</a> while
--   being somewhat practical.
@package gemmula
@version 1.2.0


-- | Parse gemtext (<tt>text/gemini</tt>) documents from and back into
--   <a>Text</a>.
--   
--   See the Gemini hypertext format specification at
--   <a>https://geminiprotocol.net/docs/gemtext-specification.gmi</a>.
module Text.Gemini

-- | A gemtext document, in the form of a list of <a>GemItem</a>s
type GemDocument = [GemItem]

-- | A gemtext item
data GemItem

-- | A regular gemtext line -- <tt><a>GemText</a> &lt;Text&gt;</tt>
GemText :: !Text -> GemItem

-- | A gemtext link -- <tt><a>GemLink</a> &lt;Link&gt; [Optional
--   Description]</tt>
GemLink :: !Text -> !Maybe Text -> GemItem

-- | A gemtext heading of 3 levels max -- <tt><a>GemHeading</a>
--   &lt;Level&gt; &lt;Text&gt;</tt>
GemHeading :: !Int -> !Text -> GemItem

-- | An unordered gemtext list -- <tt><a>GemList</a> &lt;Lines&gt;</tt>
--   
--   Gemtext specification does <i>not</i> endorse grouping list items this
--   way. This approach is purely for practical reasons, such as ease of
--   conversion to unordered HTML lists.
GemList :: ![Text] -> GemItem

-- | A gemtext quote -- <tt><a>GemQuote</a> &lt;Text&gt;</tt>
GemQuote :: !Text -> GemItem

-- | A preformatted gemtext block -- <tt><a>GemPre</a> &lt;Lines&gt;
--   [Optional Alt Text]</tt>
GemPre :: ![Text] -> !Maybe Text -> GemItem

-- | Parse a gemtext block as a <a>GemDocument</a>.
--   
--   The input <a>Text</a> must use either CRLF or LF.
decode :: Text -> GemDocument

-- | Parse a <i>single</i> gemtext line as <a>GemItem</a>.
--   
--   There <i>should not</i> be any line breaks in the input; if present,
--   they are treated as spaces. Preformatted text blocks are regarded as
--   <a>GemText</a>s as they are strictly multiline.
decodeLine :: Text -> GemItem

-- | Encode a parsed <a>GemDocument</a> into a gemtext block.
--   
--   The output <a>Text</a> uses CRLF line breaks and ends with a newline.
--   
--   Empty lists are ignored completely if present. See the
--   <a>encodeItem</a> function for additional quirks.
encode :: GemDocument -> Text

-- | Encode a <i>single</i> parsed <a>GemItem</a> into gemtext.
--   
--   The output <a>Text</a> does <i>not</i> end with an additional newline,
--   and might be multiple lines, in which case it uses CRLF line breaks.
--   
--   Prefixes are escaped as necessary before encoding and the spaces in
--   <a>GemLink</a>s are replaced with <tt>%20</tt> to normalize them. Line
--   breaks inside the body of an item are also replaced with a space.
encodeItem :: GemItem -> Text

-- | Get the title of the <a>GemDocument</a>, which is the very first
--   <a>GemHeading</a> in the document, regardless of the level of the
--   heading.
documentTitle :: GemDocument -> Maybe Text
instance GHC.Classes.Eq Text.Gemini.GemItem
instance GHC.Show.Show Text.Gemini.GemItem