diff --git a/CHANGELOG b/CHANGELOG new file mode 100644 --- /dev/null +++ b/CHANGELOG @@ -0,0 +1,86 @@ +# Changelog + +- 0.9.2.0 (2024-03-06) + * Make XHTML5 doctype lowercase + * Add new attributes to (X)HTML5: + - `download` + - `minlength` + - `muted` + - `onkeypress` + - `poster` + - `property` + * Add new elements to (X)HTML5: + - `bdi` + - `data` + - `dialog` + - `picture` + - `s` + - `search` + - `slot` + - `template` + +- 0.9.1.2 (2019-10-02) + * Bump QuickCheck dependency to 2.13 + * Bump containers dependency to 0.6 + * Check in generated code + * Regenerate .travis.yml using haskell-ci + +- 0.9.1.1 (2018-06-12) + * Fix generated source code on Hackage + +- 0.9.1.0 + * Add `u` element to HTML5 + * Add `role` attribute to HTML5 + * Bump HUnit dependency to 1.6 + * Bump QuickCheck dependency to 2.11 + +- 0.9.0.1 + * Fix CHANGELOG + +- 0.9.0.0 + * Bump blaze-html dependency to 0.8. This has a few consequences: + - Make `MarkupM` finally adhere to the Monad laws + - Stricten the `IsString` instance to only work with `MarkupM ()` and + not `MarkupM a` + - Change the type of `contents` to `MarkupM a -> MarkupM a` + - Add a `Semigroup` instance for `MarkupM` + +- 0.7.1.1 + +- 0.8.1.3 + * Bump HUnit dependency to 1.5 + +- 0.8.1.2 + * Bump QuickCheck dependency to 2.9 + +- 0.8.1.1 + * Bump HUnit dependency to 1.3 + +- 0.8.1.0 + * Add `
` element to HTML5 + +- 0.8.0.2 + * Relax blaze-builder dependency to include 0.3 again + +- 0.8.0.1 + * Bump QuickCheck dependency to 2.8 + +- 0.8.0.0 + * Bump blaze-builder dependency to 0.4 + +- 0.7.1.0 + * Add `itemscope` and `itemprop` attributes + * Constraint `blaze-markup` dependency + +- 0.7.0.3 + * Dependency bump to allow `text-1.2` + +- 0.7.0.2 + * Bump QuickCheck dependency to 2.7 + +- 0.7.0.1 + * Fix incorrect blaze-markup dependency in tests + +- 0.7.0.0 + * Bump blaze-markup so we get the (!?) operator for conditionally setting + attributes diff --git a/blaze-html.cabal b/blaze-html.cabal --- a/blaze-html.cabal +++ b/blaze-html.cabal @@ -1,14 +1,15 @@ -Name: blaze-html -Version: 0.4.3.4 -Homepage: http://jaspervdj.be/blaze -Bug-Reports: http://github.com/jaspervdj/blaze-html/issues -License: BSD3 -License-file: LICENSE -Author: Jasper Van der Jeugt, Simon Meier -Maintainer: Jasper Van der Jeugt -Stability: Experimental -Category: Text -Synopsis: A blazingly fast HTML combinator library for Haskell +Cabal-version: >= 1.10 +Name: blaze-html +Version: 0.9.2.0 +Homepage: http://jaspervdj.be/blaze +Bug-Reports: http://github.com/jaspervdj/blaze-html/issues +License: BSD3 +License-file: LICENSE +Author: Jasper Van der Jeugt, Simon Meier +Maintainer: Jasper Van der Jeugt +Stability: Experimental +Category: Text +Synopsis: A blazingly fast HTML combinator library for Haskell Description: A blazingly fast HTML combinator library for the Haskell programming language. The Text.Blaze module is a good @@ -16,18 +17,36 @@ . Build-type: Simple -Cabal-version: >= 1.8 -Extra-source-files: +Tested-with: + GHC == 9.8.2 + GHC == 9.6.4 + GHC == 9.4.8 + GHC == 9.2.8 + GHC == 9.0.2 + GHC == 8.10.7 + GHC == 8.8.4 + GHC == 8.6.5 + GHC == 8.4.4 + GHC == 8.2.2 + GHC == 8.0.2 + +Extra-source-files: + CHANGELOG src/Util/Sanitize.hs src/Util/GenerateHtmlCombinators.hs Library - Hs-source-dirs: src - Ghc-Options: -Wall + Hs-source-dirs: src + Ghc-Options: -Wall + Default-language: Haskell98 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,48 +55,54 @@ 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 Text.Blaze.XHtml1.Strict.Attributes Text.Blaze.XHtml1.Transitional Text.Blaze.XHtml1.Transitional.Attributes - + Text.Blaze.XHtml5 + Text.Blaze.XHtml5.Attributes + Build-depends: base >= 4 && < 5, - blaze-builder >= 0.2 && < 0.4, - text >= 0.10 && < 0.12, - bytestring >= 0.9 && < 0.10 + blaze-builder >= 0.3 && < 0.5, + blaze-markup >= 0.8 && < 0.9, + bytestring >= 0.9 && < 0.13, + text >= 0.10 && < 2.2 Test-suite blaze-html-tests - Type: exitcode-stdio-1.0 - Hs-source-dirs: src tests - Main-is: TestSuite.hs - Ghc-options: -Wall + Type: exitcode-stdio-1.0 + Hs-source-dirs: src tests + Main-is: TestSuite.hs + Ghc-options: -Wall + Default-language: Haskell98 Other-modules: - Text.Blaze.Tests - Text.Blaze.Tests.Cases - Text.Blaze.Tests.Util + Text.Blaze.Html + Text.Blaze.Html.Renderer.String + Text.Blaze.Html.Renderer.Text + Text.Blaze.Html.Renderer.Utf8 + Text.Blaze.Html.Tests + Text.Blaze.Html.Tests.Util + Text.Blaze.Html5 + Text.Blaze.Html5.Attributes + Util.Sanitize Util.Tests Build-depends: - HUnit >= 1.2 && < 1.3, - QuickCheck >= 2.4 && < 2.5, - containers >= 0.3 && < 0.5, - test-framework >= 0.4 && < 0.7, - test-framework-hunit >= 0.2 && < 0.3, - test-framework-quickcheck2 >= 0.2 && < 0.3, + HUnit >= 1.2 && < 1.7, + QuickCheck >= 2.4 && < 2.15, + containers >= 0.3 && < 0.7, + test-framework >= 0.4 && < 0.9, + test-framework-hunit >= 0.3 && < 0.4, + test-framework-quickcheck2 >= 0.3 && < 0.4, -- Copied from regular dependencies... base >= 4 && < 5, - blaze-builder >= 0.2 && < 0.4, - text >= 0.10 && < 0.12, - bytestring >= 0.9 && < 0.10 + blaze-builder >= 0.3 && < 0.5, + blaze-markup >= 0.8 && < 0.9, + bytestring >= 0.9 && < 0.13, + text >= 0.10 && < 2.2 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,16 @@ +module Text.Blaze.Html + ( module Text.Blaze + , Html + , toHtml + , preEscapedToHtml + ) where + +import Text.Blaze + +type Html = Markup + +toHtml :: ToMarkup a => a -> Html +toHtml = toMarkup + +preEscapedToHtml :: ToMarkup a => a -> Html +preEscapedToHtml = preEscapedToMarkup 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 @@ -1,11 +1,11 @@ -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:69 +-- src/Util/GenerateHtmlCombinators.hs:70 -- {-# LANGUAGE OverloadedStrings #-} -- | This module exports HTML combinators used to create documents. -- module Text.Blaze.Html4.FrameSet - ( module Text.Blaze + ( module Text.Blaze.Html , docType , docTypeHtml , a @@ -100,15 +100,16 @@ ) where -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:77 +-- src/Util/GenerateHtmlCombinators.hs:78 -- import Prelude ((>>), (.)) 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:157 -- -- | Combinator for the document type. This should be placed at the top -- of every HTML page. @@ -127,14 +128,14 @@ {-# INLINE docType #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:176 +-- src/Util/GenerateHtmlCombinators.hs:178 -- -- | Combinator for the @\@ element. This combinator will also -- insert the correct doctype. -- -- Example: -- --- > docTypeHtml $ span $ text "foo" +-- > docTypeHtml $ span $ toHtml "foo" -- -- Result: -- @@ -148,13 +149,13 @@ {-# INLINE docTypeHtml #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > a $ span $ text "foo" +-- > a $ span $ toHtml "foo" -- -- Result: -- @@ -166,13 +167,13 @@ {-# INLINE a #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > abbr $ span $ text "foo" +-- > abbr $ span $ toHtml "foo" -- -- Result: -- @@ -184,13 +185,13 @@ {-# INLINE abbr #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > acronym $ span $ text "foo" +-- > acronym $ span $ toHtml "foo" -- -- Result: -- @@ -202,13 +203,13 @@ {-# INLINE acronym #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\
@ element. -- -- Example: -- --- > address $ span $ text "foo" +-- > address $ span $ toHtml "foo" -- -- Result: -- @@ -220,13 +221,13 @@ {-# INLINE address #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > applet $ span $ text "foo" +-- > applet $ span $ toHtml "foo" -- -- Result: -- @@ -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:227 -- -- | Combinator for the @\@ element. -- @@ -251,17 +252,17 @@ -- > -- area :: Html -- ^ Resulting HTML. -area = Leaf "area" "" +area = Leaf "area" "" () {-# INLINE area #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > b $ span $ text "foo" +-- > b $ span $ toHtml "foo" -- -- Result: -- @@ -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:227 -- -- | Combinator for the @\@ element. -- @@ -286,17 +287,17 @@ -- > -- basefont :: Html -- ^ Resulting HTML. -basefont = Leaf "basefont" "" +basefont = Leaf "basefont" "" () {-# INLINE basefont #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > bdo $ span $ text "foo" +-- > bdo $ span $ toHtml "foo" -- -- Result: -- @@ -308,13 +309,13 @@ {-# INLINE bdo #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > big $ span $ text "foo" +-- > big $ span $ toHtml "foo" -- -- Result: -- @@ -326,13 +327,13 @@ {-# INLINE big #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\
@ element. -- -- Example: -- --- > blockquote $ span $ text "foo" +-- > blockquote $ span $ toHtml "foo" -- -- Result: -- @@ -344,13 +345,13 @@ {-# INLINE blockquote #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\@ element. -- -- Example: -- --- > body $ span $ text "foo" +-- > body $ span $ toHtml "foo" -- -- Result: -- @@ -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:227 -- -- | Combinator for the @\
@ element. -- @@ -375,17 +376,17 @@ -- >
-- br :: Html -- ^ Resulting HTML. -br = Leaf "br" "" +br = Leaf "br" "" () {-# INLINE br #-} -- WARNING: The next block of code was automatically generated by --- src/Util/GenerateHtmlCombinators.hs:198 +-- src/Util/GenerateHtmlCombinators.hs:200 -- -- | Combinator for the @\