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


-- | The Elm language module.
--   
--   Elm aims to make client-side web-development more pleasant. It is a
--   statically/strongly typed, functional reactive language to HTML, CSS,
--   and JS. This package provides a library for Elm compilation in Haskell
--   and a compiler executable.
@package Elm
@version 0.8


-- | This module contains Shakespearean (see <a>Text.Shakespeare</a>)
--   templates for Elm. It introduces type-safe compile-time variable and
--   URL interpolation. A typeclass <tt><a>ToElm</a></tt> is provided for
--   interpolated variables.
--   
--   Further reading on Shakespearean templates:
--   <a>http://www.yesodweb.com/book/templates</a>
--   
--   Further reading on Elm: <a>http://elm-lang.org</a>
module Language.Elm.Quasi

-- | QuasiQuoter for embedding Elm code inside of Haskell code.
--   
--   Usage: <tt>[elm|main = plaintext "Some elm code"|]</tt>
elm :: QuasiQuoter

-- | A Template Haskell function for embedding Elm code from external .elm
--   files.
--   
--   Usage: <tt>$(elmFile "elm_source/index.elm")</tt>
elmFile :: FilePath -> Q Exp
elmFileReload :: FilePath -> Q Exp

-- | Newtype wrapper of <a>Builder</a>.
newtype Elm
Elm :: Builder -> Elm
unElm :: Elm -> Builder

-- | A typeclass for types that can be interpolated in Elm templates.
class ToElm a
toElm :: ToElm a => a -> Builder

-- | Render Elm to lazy Text.
renderElm :: Elm -> Text
instance Monoid Elm
instance ToElm Text
instance ToElm Text
instance ToElm [Char]


-- | This module exports the functions necessary for compiling Elm code
--   into the respective HTML, JS and CSS code.
--   
--   The type class <tt><tt>ElmSource</tt></tt> requires an instance for
--   all types that the Elm compiler understands. The provided instances
--   for String, Text and QuasiQuoted Elm source code should be sufficient.
--   
--   The documentation for the Elm language is available at
--   <a>http://elm-lang.org/Documentation.elm</a>, and many interactive
--   examples are available at <a>http://elm-lang.org/Examples.elm</a>
--   
--   Example implementations using Yesod and Happstack are available at
--   <a>https://github.com/tazjin/Elm/tree/master/Examples</a>
module Language.Elm

-- | This function compiles Elm code to JavaScript.
compile :: String -> String

-- | This function compiles Elm code into a full HTML page.
toHtml :: String -> String -> String -> Html

-- | This function extracts the module name of a given source program.
moduleName :: String -> String

-- | The absolute path to Elm's runtime system.
runtime :: IO FilePath

-- | The absolute path to Elm's core library documentation.
docs :: IO FilePath