diff --git a/blaze-html.cabal b/blaze-html.cabal --- a/blaze-html.cabal +++ b/blaze-html.cabal @@ -1,5 +1,5 @@ Name: blaze-html -Version: 0.4.3.4 +Version: 0.5.0.0 Homepage: http://jaspervdj.be/blaze Bug-Reports: http://github.com/jaspervdj/blaze-html/issues License: BSD3 @@ -27,7 +27,11 @@ Ghc-Options: -Wall Exposed-modules: - Text.Blaze + Text.Blaze.Html + Text.Blaze.Html.Renderer.Pretty + Text.Blaze.Html.Renderer.String + Text.Blaze.Html.Renderer.Text + Text.Blaze.Html.Renderer.Utf8 Text.Blaze.Html4.FrameSet Text.Blaze.Html4.FrameSet.Attributes Text.Blaze.Html4.Strict @@ -36,11 +40,6 @@ Text.Blaze.Html4.Transitional.Attributes Text.Blaze.Html5 Text.Blaze.Html5.Attributes - Text.Blaze.Internal - Text.Blaze.Renderer.Pretty - Text.Blaze.Renderer.String - Text.Blaze.Renderer.Text - Text.Blaze.Renderer.Utf8 Text.Blaze.XHtml1.FrameSet Text.Blaze.XHtml1.FrameSet.Attributes Text.Blaze.XHtml1.Strict @@ -49,10 +48,11 @@ Text.Blaze.XHtml1.Transitional.Attributes Build-depends: - base >= 4 && < 5, - blaze-builder >= 0.2 && < 0.4, - text >= 0.10 && < 0.12, - bytestring >= 0.9 && < 0.10 + base >= 4 && < 5, + blaze-builder >= 0.2 && < 0.4, + blaze-markup >= 0.5.1 && < 0.6, + bytestring >= 0.9 && < 0.10, + text >= 0.10 && < 0.12 Test-suite blaze-html-tests Type: exitcode-stdio-1.0 @@ -61,9 +61,8 @@ Ghc-options: -Wall Other-modules: - Text.Blaze.Tests - Text.Blaze.Tests.Cases - Text.Blaze.Tests.Util + Text.Blaze.Html.Tests + Text.Blaze.Html.Tests.Util Util.Tests Build-depends: @@ -74,10 +73,11 @@ test-framework-hunit >= 0.2 && < 0.3, test-framework-quickcheck2 >= 0.2 && < 0.3, -- Copied from regular dependencies... - base >= 4 && < 5, - blaze-builder >= 0.2 && < 0.4, - text >= 0.10 && < 0.12, - bytestring >= 0.9 && < 0.10 + base >= 4 && < 5, + blaze-builder >= 0.2 && < 0.4, + blaze-markup >= 0.5.1 && < 0.6, + bytestring >= 0.9 && < 0.10, + text >= 0.10 && < 0.12 Source-repository head Type: git diff --git a/src/Text/Blaze.hs b/src/Text/Blaze.hs deleted file mode 100644 --- a/src/Text/Blaze.hs +++ /dev/null @@ -1,179 +0,0 @@ -{-# LANGUAGE FlexibleInstances, TypeSynonymInstances #-} --- | BlazeHtml is an HTML combinator library. It provides a way to embed HTML in --- Haskell in an efficient and convenient way, with a light-weight syntax. --- --- To use the library, one needs to import a set of HTML combinators. For --- example, you can use HTML 4 Strict. --- --- > {-# LANGUAGE OverloadedStrings #-} --- > import Prelude hiding (head, id, div) --- > import Text.Blaze.Html4.Strict hiding (map) --- > import Text.Blaze.Html4.Strict.Attributes hiding (title) --- --- To render the page later on, you need a so called Renderer. The recommended --- renderer is an UTF-8 renderer which produces a lazy bytestring. --- --- > import Text.Blaze.Renderer.Utf8 (renderHtml) --- --- Now, you can describe pages using the imported combinators. --- --- > page1 :: Html --- > page1 = html $ do --- > head $ do --- > title "Introduction page." --- > link ! rel "stylesheet" ! type_ "text/css" ! href "screen.css" --- > body $ do --- > div ! id "header" $ "Syntax" --- > p "This is an example of BlazeHtml syntax." --- > ul $ mapM_ (li . toHtml . show) [1, 2, 3] --- --- The resulting HTML can now be extracted using: --- --- > renderHtml page1 --- -module Text.Blaze - ( - -- * Important types. - Html - , Tag - , Attribute - , AttributeValue - - -- * Creating attributes. - , dataAttribute - , customAttribute - - -- * Converting values to HTML. - , ToHtml (..) - , text - , preEscapedText - , lazyText - , preEscapedLazyText - , string - , preEscapedString - , unsafeByteString - , unsafeLazyByteString - - -- * Creating tags. - , textTag - , stringTag - - -- * Converting values to attribute values. - , ToValue (..) - , textValue - , preEscapedTextValue - , lazyTextValue - , preEscapedLazyTextValue - , stringValue - , preEscapedStringValue - , unsafeByteStringValue - , unsafeLazyByteStringValue - - -- * Setting attributes - , (!) - ) where - -import Data.Monoid (mconcat) - -import Data.Text (Text) -import qualified Data.Text.Lazy as LT - -import Text.Blaze.Internal - --- | Class allowing us to use a single function for HTML values --- -class ToHtml a where - -- | Convert a value to HTML. - -- - toHtml :: a -> Html - -instance ToHtml Html where - toHtml = id - {-# INLINE toHtml #-} - -instance ToHtml [Html] where - toHtml = mconcat - {-# INLINE toHtml #-} - -instance ToHtml Text where - toHtml = text - {-# INLINE toHtml #-} - -instance ToHtml LT.Text where - toHtml = lazyText - {-# INLINE toHtml #-} - -instance ToHtml String where - toHtml = string - {-# INLINE toHtml #-} - -instance ToHtml Int where - toHtml = string . show - {-# INLINE toHtml #-} - -instance ToHtml Char where - toHtml = string . return - {-# INLINE toHtml #-} - -instance ToHtml Bool where - toHtml = string . show - {-# INLINE toHtml #-} - -instance ToHtml Integer where - toHtml = string . show - {-# INLINE toHtml #-} - -instance ToHtml Float where - toHtml = string . show - {-# INLINE toHtml #-} - -instance ToHtml Double where - toHtml = string . show - {-# INLINE toHtml #-} - --- | Class allowing us to use a single function for attribute values --- -class ToValue a where - -- | Convert a value to an HTML attribute value - -- - toValue :: a -> AttributeValue - -instance ToValue AttributeValue where - toValue = id - {-# INLINE toValue #-} - -instance ToValue Text where - toValue = textValue - {-# INLINE toValue #-} - -instance ToValue LT.Text where - toValue = lazyTextValue - {-# INLINE toValue #-} - -instance ToValue String where - toValue = stringValue - {-# INLINE toValue #-} - -instance ToValue Int where - toValue = stringValue . show - {-# INLINE toValue #-} - -instance ToValue Char where - toValue = stringValue . return - {-# INLINE toValue #-} - -instance ToValue Bool where - toValue = stringValue . show - {-# INLINE toValue #-} - -instance ToValue Integer where - toValue = stringValue . show - {-# INLINE toValue #-} - -instance ToValue Float where - toValue = stringValue . show - {-# INLINE toValue #-} - -instance ToValue Double where - toValue = stringValue . show - {-# INLINE toValue #-} diff --git a/src/Text/Blaze/Html.hs b/src/Text/Blaze/Html.hs new file mode 100644 --- /dev/null +++ b/src/Text/Blaze/Html.hs @@ -0,0 +1,12 @@ +module Text.Blaze.Html + ( module Text.Blaze + , Html + , toHtml + ) where + +import Text.Blaze + +type Html = Markup + +toHtml :: ToMarkup a => a -> Markup +toHtml = toMarkup diff --git a/src/Text/Blaze/Html/Renderer/Pretty.hs b/src/Text/Blaze/Html/Renderer/Pretty.hs new file mode 100644 --- /dev/null +++ b/src/Text/Blaze/Html/Renderer/Pretty.hs @@ -0,0 +1,9 @@ +module Text.Blaze.Html.Renderer.Pretty + ( renderHtml + ) where + +import Text.Blaze.Html (Html) +import Text.Blaze.Renderer.Pretty (renderMarkup) + +renderHtml :: Html -> String +renderHtml = renderMarkup diff --git a/src/Text/Blaze/Html/Renderer/String.hs b/src/Text/Blaze/Html/Renderer/String.hs new file mode 100644 --- /dev/null +++ b/src/Text/Blaze/Html/Renderer/String.hs @@ -0,0 +1,9 @@ +module Text.Blaze.Html.Renderer.String + ( renderHtml + ) where + +import Text.Blaze.Html (Html) +import Text.Blaze.Renderer.String (renderMarkup) + +renderHtml :: Html -> String +renderHtml = renderMarkup diff --git a/src/Text/Blaze/Html/Renderer/Text.hs b/src/Text/Blaze/Html/Renderer/Text.hs new file mode 100644 --- /dev/null +++ b/src/Text/Blaze/Html/Renderer/Text.hs @@ -0,0 +1,25 @@ +module Text.Blaze.Html.Renderer.Text + ( renderHtmlBuilder + , renderHtmlBuilderWith + , renderHtml + , renderHtmlWith + ) where + +import Data.ByteString (ByteString) +import Data.Text (Text) +import Data.Text.Lazy.Builder (Builder) +import Text.Blaze.Html (Html) +import qualified Data.Text.Lazy as TL +import qualified Text.Blaze.Renderer.Text as R + +renderHtmlBuilder :: Html -> Builder +renderHtmlBuilder = R.renderMarkupBuilder + +renderHtmlBuilderWith :: (ByteString -> Text) -> Html -> Builder +renderHtmlBuilderWith = R.renderMarkupBuilderWith + +renderHtml :: Html -> TL.Text +renderHtml = R.renderMarkup + +renderHtmlWith :: (ByteString -> Text) -> Html -> TL.Text +renderHtmlWith = R.renderMarkupWith diff --git a/src/Text/Blaze/Html/Renderer/Utf8.hs b/src/Text/Blaze/Html/Renderer/Utf8.hs new file mode 100644 --- /dev/null +++ b/src/Text/Blaze/Html/Renderer/Utf8.hs @@ -0,0 +1,20 @@ +module Text.Blaze.Html.Renderer.Utf8 + ( renderHtmlBuilder + , renderHtml + , renderHtmlToByteStringIO + ) where + +import Blaze.ByteString.Builder (Builder) +import Data.ByteString (ByteString) +import Text.Blaze.Html (Html) +import qualified Data.ByteString.Lazy as BL +import qualified Text.Blaze.Renderer.Utf8 as R + +renderHtmlBuilder :: Html -> Builder +renderHtmlBuilder = R.renderMarkupBuilder + +renderHtml :: Html -> BL.ByteString +renderHtml = R.renderMarkup + +renderHtmlToByteStringIO :: (ByteString -> IO ()) -> Html -> IO () +renderHtmlToByteStringIO = R.renderMarkupToByteStringIO diff --git a/src/Text/Blaze/Html4/FrameSet.hs b/src/Text/Blaze/Html4/FrameSet.hs --- a/src/Text/Blaze/Html4/FrameSet.hs +++ b/src/Text/Blaze/Html4/FrameSet.hs @@ -5,7 +5,7 @@ -- | This module exports HTML combinators used to create documents. -- module Text.Blaze.Html4.FrameSet - ( module Text.Blaze + ( module Text.Blaze.Html , docType , docTypeHtml , a @@ -106,9 +106,10 @@ import Text.Blaze import Text.Blaze.Internal +import Text.Blaze.Html -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:155 +-- src/Util/GenerateHtmlCombinators.hs:156 -- -- | Combinator for the document type. This should be placed at the top -- of every HTML page. @@ -127,7 +128,7 @@ {-# INLINE docType #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:176 +-- src/Util/GenerateHtmlCombinators.hs:177 -- -- | Combinator for the @\@ element. This combinator will also -- insert the correct doctype. @@ -148,7 +149,7 @@ {-# INLINE docTypeHtml #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -166,7 +167,7 @@ {-# INLINE a #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -184,7 +185,7 @@ {-# INLINE abbr #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -202,7 +203,7 @@ {-# INLINE acronym #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\
@ element. -- @@ -220,7 +221,7 @@ {-# INLINE address #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -238,7 +239,7 @@ {-# INLINE applet #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:225 +-- src/Util/GenerateHtmlCombinators.hs:226 -- -- | Combinator for the @\@ element. -- @@ -255,7 +256,7 @@ {-# INLINE area #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -273,7 +274,7 @@ {-# INLINE b #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:225 +-- src/Util/GenerateHtmlCombinators.hs:226 -- -- | Combinator for the @\@ element. -- @@ -290,7 +291,7 @@ {-# INLINE basefont #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -308,7 +309,7 @@ {-# INLINE bdo #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -326,7 +327,7 @@ {-# INLINE big #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\
@ element. -- @@ -344,7 +345,7 @@ {-# INLINE blockquote #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\@ element. -- @@ -362,7 +363,7 @@ {-# INLINE body #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:225 +-- src/Util/GenerateHtmlCombinators.hs:226 -- -- | Combinator for the @\
@ element. -- @@ -379,7 +380,7 @@ {-# INLINE br #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:199 -- -- | Combinator for the @\