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


-- | Automagically generate the HUnit- and Quickcheck-bulk-code using Template Haskell.
--   
--   <tt>test-framework-th</tt> contains two interesting functions:
--   <tt>defaultMainGenerator</tt> and <tt>testGroupGenerator</tt>.
--   
--   <tt>defaultMainGenerator</tt> will extract all functions beginning
--   with case_ or prop_ in the module and put them in a testGroup.
--   
--   <pre>
--   -- file SomeModule.hs
--   ( -# LANGUAGE TemplateHaskell #- )
--   module SomeModule where
--   import Test.Framework.TH
--   import Test.Framework
--   import Test.HUnit
--   import Test.Framework.Providers.HUnit
--   import Test.Framework.Providers.QuickCheck2
--   
--   -- observe this line!
--   main = $(defaultMainGenerator)
--   case_1 = do 1 @=? 1
--   case_2 = do 2 @=? 2
--   prop_reverse xs = reverse (reverse xs) == xs
--      where types = xs::[Int]
--   </pre>
--   
--   is the same as
--   
--   <pre>
--   -- file SomeModule.hs
--   ( -# LANGUAGE TemplateHaskell #- )
--   module SomeModule where
--   import Test.Framework.TH
--   import Test.Framework
--   import Test.HUnit
--   import Test.Framework.Providers.HUnit
--   import Test.Framework.Providers.QuickCheck2
--   
--   -- observe this line!
--   main =
--     defaultMain [
--       testGroup "SomeModule" [ testCase "1" case_1, testCase "2" case_2, testProperty "reverse" prop_reverse]
--       ]
--   
--   case_1 = do 1 @=? 1
--   case_2 = do 2 @=? 2
--   prop_reverse xs = reverse (reverse xs) == xs
--      where types = xs::[Int]
--   </pre>
--   
--   <tt>testGroupGenerator</tt> is like <tt>defaultMainGenerator</tt> but
--   without <tt>defaultMain</tt>. It is useful if you need a function for
--   the testgroup (e.g. if you want to be able to call the testgroup from
--   another module).
@package test-framework-th
@version 0.2.2

module Test.Framework.TH

-- | Generate the usual code and extract the usual functions needed in
--   order to run HUnit<i>Quickcheck</i>Quickcheck2. All functions
--   beginning with case_ or prop_ will be extracted.
--   
--   <pre>
--   {-# OPTIONS_GHC -fglasgow-exts -XTemplateHaskell #-}
--   module MyModuleTest where
--   import Test.HUnit
--   import MainTestGenerator
--   
--   main = $(defaultMainGenerator)
--   
--   case_Foo = do 4 @=? 4
--   
--   case_Bar = do "hej" @=? "hej"
--   
--   prop_Reverse xs = reverse (reverse xs) == xs
--     where types = xs :: [Int]
--   </pre>
--   
--   will automagically extract prop_Reverse, case_Foo and case_Bar and run
--   them as well as present them as belonging to the testGroup
--   <tt>MyModuleTest</tt> such as
--   
--   <pre>
--   me: runghc MyModuleTest.hs 
--   MyModuleTest:
--     Reverse: [OK, passed 100 tests]
--     Foo: [OK]
--     Bar: [OK]
--   
--            Properties  Test Cases   Total       
--    Passed  1           2            3          
--    Failed  0           0            0           
--    Total   1           1            3
--   </pre>
defaultMainGenerator :: ExpQ

-- | Generate the usual code and extract the usual functions needed for a
--   testGroup in HUnit<i>Quickcheck</i>Quickcheck2. All functions
--   beginning with case_ or prop_ will be extracted.
--   
--   <pre>
--   -- file SomeModule.hs
--   fooTestGroup = $(testGroupGenerator)
--   main = defaultMain [fooTestGroup]
--   case_1 = do 1 @=? 1
--   case_2 = do 2 @=? 2
--   prop_p xs = reverse (reverse xs) == xs
--    where types = xs :: [Int]
--   </pre>
--   
--   is the same as
--   
--   <pre>
--   -- file SoomeModule.hs
--   fooTestGroup = testGroup "SomeModule" [testProperty "p" prop_1, testCase "1" case_1, testCase "2" case_2]
--   main = defaultMain [fooTestGroup]
--   case_1 = do 1 @=? 1
--   case_2 = do 2 @=? 2
--   prop_1 xs = reverse (reverse xs) == xs
--    where types = xs :: [Int]
--   </pre>
testGroupGenerator :: ExpQ