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


-- | To make a type corresponding to an enum of C language
--   
--   Please see the README on GitHub at
--   <a>https://github.com/YoshikuniJujo/c-enum#readme</a>
@package c-enum
@version 0.1.1.3

module Foreign.C.Enum

-- | Write like the following.
--   
--   <pre>
--   enum "Foo" ''Int [''Show, ''Read, ''Eq] [
--   	("FooError", - 1),
--   	("FooZero", 0),
--   	("FooOne", 1),
--   	("FooTwo", 2) ]
--   </pre>
--   
--   Then you get like the following.
--   
--   <pre>
--   newtype Foo = Foo Int deriving Eq
--   
--   pattern FooError :: Int -&gt; Foo
--   pattern FooError &lt;- Foo (- 1) where
--   	FooError = Foo (- 1)
--   
--   pattern FooZero :: Int -&gt; Foo
--   ...
--   
--   
--   instance Show Foo where
--   	showsPrec = ...
--   
--   instance Read Foo where
--   	readPrec = ...
--   </pre>
--   
--   And you can read and show like the following.
--   
--   <pre>
--   &gt; Foo $ - 1
--   FooError
--   &gt; FooTwo
--   FooTwo
--   &gt; Foo 3
--   Foo 3
--   &gt; read "Foo (- 1)" :: Foo
--   FooError
--   &gt; read "FooOne" :: Foo
--   FooOne
--   </pre>
enum :: String -> Name -> [Name] -> [(String, Integer)] -> DecsQ

-- | You can define enum members separately.
--   
--   <pre>
--   enumMems "Foo" [
--   	("FooThree", 3),
--   	("FooFour", 4) ]
--   </pre>
enumMems :: String -> [(String, Integer)] -> DecsQ
instance GHC.Show.Show Foreign.C.Enum.ShowReadClasses