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

import Data.Data

-- | By default all Async 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 #-}
--
-- Async 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'.
-- 
-- > {-# ANN myFunction AllowRecursion #-}
-- >
-- > {-# ANN module AllowRecursion #-}


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


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