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


-- | A tiny Gemtext parser
--   
--   gemmula is a tiny and functional text/gemini (also known as Gemtext)
--   parser that aims to parse a Gemtext document from and to Text,
--   according to the Section 5 of the Gemini Protocol specification at
--   <a>https://geminiprotocol.net/docs/specification.gmi</a>.
@package gemmula
@version 1.0.0


-- | A tiny <tt>text/gemini</tt> parser.
--   
--   Parses Gemtext documents from and to <a>Text</a>. See the Section 5 of
--   the <a>Gemini Protocol specification</a>.
module Text.Gemini

-- | A Gemtext document, in the form of an ordered list.
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

-- | A Gemtext unordered list. -- <tt><a>GemList</a> &lt;Lines&gt;</tt>
GemList :: ![Text] -> GemItem

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

-- | A Gemtext preformat. -- <tt><a>GemPre</a> &lt;Lines&gt; [Optional Alt
--   Text]</tt>
GemPre :: ![Text] -> !Maybe Text -> GemItem

-- | Parse a <tt>text/gemini</tt> file as <a>GemDocument</a>. The text
--   should be supplied as an LF-ending <a>Text</a>.
decode :: Text -> GemDocument

-- | Parse a <i>single</i> <tt>text/gemini</tt> line as <a>GemItem</a>.
--   
--   Notes:
--   
--   <ul>
--   <li>Isn't able to decode preformatted texts as they are strictly
--   multiline.</li>
--   <li><a>GemList</a>s are also obviously singleton.</li>
--   </ul>
decodeLine :: Text -> GemItem

-- | Encode parsed <a>GemDocument</a> to a <tt>text/gemini</tt> file. The
--   output <a>Text</a> uses LF-endings.
encode :: GemDocument -> Text

-- | Encode a <i>single</i> parsed <a>GemItem</a> as <tt>text/gemini</tt>
--   text. The output <a>Text</a> uses LF-endings and might be multiple
--   lines.
--   
--   <i>Beware</i> that the final newline is always stripped, if any.
--   
--   Notes:
--   
--   <ul>
--   <li>The text of the <a>GemText</a> will follow a whitespace to escape
--   the prefix at the beginning if the line starts with a valid one.</li>
--   <li>The link in the <a>GemLink</a> should not have spaces.</li>
--   </ul>
encodeItem :: GemItem -> Text
instance GHC.Classes.Eq Text.Gemini.GemItem
instance GHC.Show.Show Text.Gemini.GemItem