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


-- | Make writing in unicode easy.
--   
--   Unicoder is a command-line tool transforms text documents, replacing
--   simple patterns with unicode equivalents. The patterns can be easily
--   configured by the user. This package is especially meant to open the
--   vast and expressive array of unicode identifiers to programmers and
--   language designers, but there's nothing wrong with a technically savvy
--   user putting unicoder to work on documents for human consumption. Any
--   system of special characters can be made easy to type on any keyboard
--   and in any context as long as unicode supports it.
--   
--   Cabal wants to fight me over typesetting some examples, so check out
--   <a>the real docs</a> for a decent look at the features.
--   
--   In the interests of giving readers <i>some</i> idea whats going on,
--   with the default settings,
--   
--   <pre>
--   \E.x. \A.y. x \-&gt; y
--   \l.x,y. x \of x \of y
--   </pre>
--   
--   becomes
--   
--   <pre>
--   ∃x ∀y x → y
--   λx,y. x ∘ x ∘ y
--   </pre>
--   
--   except that the newline isn't removed (thanks, cabal!). Also, there
--   are a couple important features that I can't seem to get cabal to even
--   parse (thanks again!).
@package unicoder
@version 0.5.0


-- | Load unicoder configurations and oerform unicoder transformations on
--   text and strings.
--   
--   Unicoder replaces simple macros with configured strings, e.g.
--   
--   <pre>
--   \E.x. \A.y. x \-&gt; y
--   \l.x,y. x \of x \of y
--   </pre>
--   
--   becomes
--   
--   <pre>
--   ∃x ∀y x → y
--   λx,y. x ∘ x ∘ y
--   </pre>
--   
--   For more information, see <a>the documentation</a>.
module Text.Unicoder

-- | Perform the unicoder transformation on a <a>Text</a> value.
unicodize :: Config -> Text -> Text

-- | Perform the unicoder transformation on a lazy <a>Text</a> value.
unicodizeLazy :: Config -> Text -> Text

-- | Perform the unicoder transformation on a <a>String</a> value.
unicodizeStr :: Config -> String -> String

-- | Aggregate all settings needed to unicodize.
data Config

-- | Parse the contents of the passed file as unicoder <a>Config</a>
loadConfig :: FilePath -> IO (Maybe Config)

-- | Parse a config file, possibly failing.
parseConfig :: FilePath -> Text -> Maybe Config