{-# LANGUAGE DeriveDataTypeable #-}
module AsyncRattus.Plugin.Annotation (AsyncRattus(..), InternalAnn (..)) where

import Data.Data

-- | Use this type to mark a Haskell function definition as an
-- Asynchronous Rattus function:
--
-- > {-# ANN myFunction AsyncRattus #-}
-- 
-- Or mark a whole module as consisting of Asynchronous Rattus functions only:
--
-- > {-# ANN module AsyncRattus #-}
--
-- If you use the latter option, you can mark exceptions
-- (i.e. functions that should be treated as ordinary Haskell function
-- definitions) as follows:
--
-- > {-# ANN myFunction NotAsyncRattus #-}
--
-- By default all Asynchronous Rattus functions are checked for use of lazy data
-- types, since these may cause memory leaks. If any lazy data types
-- are used, a warning is issued. These warnings can be disabled by
-- annotating the module or the function with 'AllowLazyData'
--
-- > {-# ANN myFunction AllowLazyData #-}
-- >
-- > {-# ANN module AllowLazyData #-}
--
-- Asynchronous Rattus only allows guarded recursion, i.e. recursive calls must
-- occur in the scope of a tick. Structural recursion over strict data
-- types is safe as well, but is currently not checked. To disable the
-- guarded recursion check, annotate the module or function with
-- 'AllowRecursion'.

data AsyncRattus = AsyncRattus | NotAsyncRattus | AllowLazyData | AllowRecursion deriving (Typeable, Typeable AsyncRattus
AsyncRattus -> DataType
AsyncRattus -> Constr
(forall b. Data b => b -> b) -> AsyncRattus -> AsyncRattus
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> AsyncRattus -> u
forall u. (forall d. Data d => d -> u) -> AsyncRattus -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> AsyncRattus -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> AsyncRattus -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c AsyncRattus
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> AsyncRattus -> c AsyncRattus
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c AsyncRattus)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c AsyncRattus)
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> AsyncRattus -> m AsyncRattus
gmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> AsyncRattus -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> AsyncRattus -> u
gmapQ :: forall u. (forall d. Data d => d -> u) -> AsyncRattus -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> AsyncRattus -> [u]
gmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> AsyncRattus -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> AsyncRattus -> r
gmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> AsyncRattus -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> AsyncRattus -> r
gmapT :: (forall b. Data b => b -> b) -> AsyncRattus -> AsyncRattus
$cgmapT :: (forall b. Data b => b -> b) -> AsyncRattus -> AsyncRattus
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c AsyncRattus)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c AsyncRattus)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c AsyncRattus)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c AsyncRattus)
dataTypeOf :: AsyncRattus -> DataType
$cdataTypeOf :: AsyncRattus -> DataType
toConstr :: AsyncRattus -> Constr
$ctoConstr :: AsyncRattus -> Constr
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c AsyncRattus
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c AsyncRattus
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> AsyncRattus -> c AsyncRattus
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> AsyncRattus -> c AsyncRattus
Data, Int -> AsyncRattus -> ShowS
[AsyncRattus] -> ShowS
AsyncRattus -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [AsyncRattus] -> ShowS
$cshowList :: [AsyncRattus] -> ShowS
show :: AsyncRattus -> String
$cshow :: AsyncRattus -> String
showsPrec :: Int -> AsyncRattus -> ShowS
$cshowsPrec :: Int -> AsyncRattus -> ShowS
Show, Eq AsyncRattus
AsyncRattus -> AsyncRattus -> Bool
AsyncRattus -> AsyncRattus -> Ordering
AsyncRattus -> AsyncRattus -> AsyncRattus
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: AsyncRattus -> AsyncRattus -> AsyncRattus
$cmin :: AsyncRattus -> AsyncRattus -> AsyncRattus
max :: AsyncRattus -> AsyncRattus -> AsyncRattus
$cmax :: AsyncRattus -> AsyncRattus -> AsyncRattus
>= :: AsyncRattus -> AsyncRattus -> Bool
$c>= :: AsyncRattus -> AsyncRattus -> Bool
> :: AsyncRattus -> AsyncRattus -> Bool
$c> :: AsyncRattus -> AsyncRattus -> Bool
<= :: AsyncRattus -> AsyncRattus -> Bool
$c<= :: AsyncRattus -> AsyncRattus -> Bool
< :: AsyncRattus -> AsyncRattus -> Bool
$c< :: AsyncRattus -> AsyncRattus -> Bool
compare :: AsyncRattus -> AsyncRattus -> Ordering
$ccompare :: AsyncRattus -> AsyncRattus -> Ordering
Ord, AsyncRattus -> AsyncRattus -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: AsyncRattus -> AsyncRattus -> Bool
$c/= :: AsyncRattus -> AsyncRattus -> Bool
== :: AsyncRattus -> AsyncRattus -> Bool
$c== :: AsyncRattus -> AsyncRattus -> Bool
Eq)


-- | This annotation type is for internal use only.
data InternalAnn = ExpectError | ExpectWarning deriving (Typeable, Typeable InternalAnn
InternalAnn -> DataType
InternalAnn -> Constr
(forall b. Data b => b -> b) -> InternalAnn -> InternalAnn
forall a.
Typeable a
-> (forall (c :: * -> *).
    (forall d b. Data d => c (d -> b) -> d -> c b)
    -> (forall g. g -> c g) -> a -> c a)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c a)
-> (a -> Constr)
-> (a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c a))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c a))
-> ((forall b. Data b => b -> b) -> a -> a)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> a -> r)
-> (forall u. (forall d. Data d => d -> u) -> a -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> a -> m a)
-> Data a
forall u. Int -> (forall d. Data d => d -> u) -> InternalAnn -> u
forall u. (forall d. Data d => d -> u) -> InternalAnn -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> InternalAnn -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> InternalAnn -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c InternalAnn
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> InternalAnn -> c InternalAnn
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c InternalAnn)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c InternalAnn)
gmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
gmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
gmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> InternalAnn -> m InternalAnn
gmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> InternalAnn -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> InternalAnn -> u
gmapQ :: forall u. (forall d. Data d => d -> u) -> InternalAnn -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> InternalAnn -> [u]
gmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> InternalAnn -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> InternalAnn -> r
gmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> InternalAnn -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> InternalAnn -> r
gmapT :: (forall b. Data b => b -> b) -> InternalAnn -> InternalAnn
$cgmapT :: (forall b. Data b => b -> b) -> InternalAnn -> InternalAnn
dataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c InternalAnn)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c InternalAnn)
dataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c InternalAnn)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c InternalAnn)
dataTypeOf :: InternalAnn -> DataType
$cdataTypeOf :: InternalAnn -> DataType
toConstr :: InternalAnn -> Constr
$ctoConstr :: InternalAnn -> Constr
gunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c InternalAnn
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c InternalAnn
gfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> InternalAnn -> c InternalAnn
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> InternalAnn -> c InternalAnn
Data, Int -> InternalAnn -> ShowS
[InternalAnn] -> ShowS
InternalAnn -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [InternalAnn] -> ShowS
$cshowList :: [InternalAnn] -> ShowS
show :: InternalAnn -> String
$cshow :: InternalAnn -> String
showsPrec :: Int -> InternalAnn -> ShowS
$cshowsPrec :: Int -> InternalAnn -> ShowS
Show, InternalAnn -> InternalAnn -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: InternalAnn -> InternalAnn -> Bool
$c/= :: InternalAnn -> InternalAnn -> Bool
== :: InternalAnn -> InternalAnn -> Bool
$c== :: InternalAnn -> InternalAnn -> Bool
Eq, Eq InternalAnn
InternalAnn -> InternalAnn -> Bool
InternalAnn -> InternalAnn -> Ordering
InternalAnn -> InternalAnn -> InternalAnn
forall a.
Eq a
-> (a -> a -> Ordering)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> Bool)
-> (a -> a -> a)
-> (a -> a -> a)
-> Ord a
min :: InternalAnn -> InternalAnn -> InternalAnn
$cmin :: InternalAnn -> InternalAnn -> InternalAnn
max :: InternalAnn -> InternalAnn -> InternalAnn
$cmax :: InternalAnn -> InternalAnn -> InternalAnn
>= :: InternalAnn -> InternalAnn -> Bool
$c>= :: InternalAnn -> InternalAnn -> Bool
> :: InternalAnn -> InternalAnn -> Bool
$c> :: InternalAnn -> InternalAnn -> Bool
<= :: InternalAnn -> InternalAnn -> Bool
$c<= :: InternalAnn -> InternalAnn -> Bool
< :: InternalAnn -> InternalAnn -> Bool
$c< :: InternalAnn -> InternalAnn -> Bool
compare :: InternalAnn -> InternalAnn -> Ordering
$ccompare :: InternalAnn -> InternalAnn -> Ordering
Ord)