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


-- | QuasiQuoter for multi-line interpolated strings
--   
--   Please see the README on GitHub at
--   <a>https://github.com/isovector/interpolatedstring-qq2#readme</a>
@package interpolatedstring-qq2
@version 0.1.0.0


-- | QuasiQuoter for interpolated strings using Perl 6 syntax.
--   
--   The <a>q</a> form does one thing and does it well: It contains a
--   multi-line string with no interpolation at all:
--   
--   <pre>
--   {-# LANGUAGE QuasiQuotes, ExtendedDefaultRules #-}
--   import Text.InterpolatedString.QQ2 (q)
--   foo :: String -- <a>Text</a>, <a>ByteString</a> etc also works
--   foo = [q|
--   
--   Well here is a
--       multi-line string!
--   
--   |]
--   </pre>
--   
--   Any instance of the <a>IsString</a> class is permitted.
--   
--   The <a>qc</a> form interpolates curly braces: expressions inside #{}
--   will be directly interpolated if it's a <a>Char</a>, <a>String</a>,
--   <a>Text</a> or <a>ByteString</a>, or it will have <a>show</a> called
--   if it is not.
--   
--   Escaping of '{' is done with backslash.
--   
--   For interpolating numeric expressions without an explicit type
--   signature, use the ExtendedDefaultRules lanuage pragma, as shown
--   below:
--   
--   <pre>
--   {-# LANGUAGE QuasiQuotes, ExtendedDefaultRules #-}
--   import Text.InterpolatedString.QQ2 (qc)
--   bar :: String
--   bar = [qc| Well {6 * 7} |]
--   </pre>
--   
--   bar will have the value " Well hello there 42 ".
--   
--   If you want control over how <a>show</a> works on your types, define a
--   custom <a>ShowQ</a> instance:
--   
--   For example, this instance allows you to display interpolated lists of
--   strings as a sequence of words, removing those pesky brackets, quotes,
--   and escape sequences.
--   
--   <pre>
--   {-# LANGUAGE FlexibleInstances #-}
--   import Text.InterpolatedString.QQ2 (qc, ShowQ(..))
--   instance ShowQ [String] where
--       showQ = unwords
--   </pre>
--   
--   <a>qc</a> permits output to any types with both <a>IsString</a> and
--   <a>Monoid</a> instances.
--   
--   <pre>
--   {--}
--   import Text.InterpolatedString.QQ2 (qc)
--   import Data.Text (Text)
--   import Data.ByteString.Char8 (ByteString)
--   qux :: ByteString
--   qux = [qc| This will convert {"ByteString" :: ByteString} |]
--   </pre>
module Text.InterpolatedString.QQ2

-- | QuasiQuoter for interpolating '{expr}' into a string literal. The
--   pattern portion is undefined.
qc :: QuasiQuoter

-- | QuasiQuoter for a non-interpolating string literal. The pattern
--   portion is undefined.
q :: QuasiQuoter

-- | A class for types that use special interpolation rules. Instances of
--   <a>ShowQ</a> that are also instances of <a>IsString</a> should obey
--   the following law:
--   
--   <pre>
--   fromString (showQ s) == s
--   </pre>
--   
--   because this library relies on this fact to optimize away needless
--   string conversions.
class ShowQ a
showQ :: ShowQ a => a -> String
instance GHC.Show.Show Text.InterpolatedString.QQ2.StringPart
instance Data.String.IsString s => Text.InterpolatedString.QQ2.QQ s s
instance (Text.InterpolatedString.QQ2.ShowQ a, Data.String.IsString s) => Text.InterpolatedString.QQ2.QQ a s
instance Text.InterpolatedString.QQ2.ShowQ GHC.Types.Char
instance Text.InterpolatedString.QQ2.ShowQ GHC.Base.String
instance Text.InterpolatedString.QQ2.ShowQ Data.ByteString.Internal.ByteString
instance Text.InterpolatedString.QQ2.ShowQ Data.ByteString.Lazy.Internal.ByteString
instance Text.InterpolatedString.QQ2.ShowQ Data.Text.Internal.Text
instance Text.InterpolatedString.QQ2.ShowQ Data.Text.Internal.Lazy.Text
instance GHC.Show.Show a => Text.InterpolatedString.QQ2.ShowQ a