{-|
Copyright  :  (C) 2017-2019, Myrtle Software, QBayLogic
License    :  BSD2 (see the file LICENSE)
Maintainer :  Christiaan Baaij <christiaan.baaij@gmail.com>

Instruct the clash compiler to look for primitive HDL templates in the
indicated directory. For distribution of new packages with primitive HDL
templates.
-}

{-# LANGUAGE DeriveAnyClass        #-}
{-# LANGUAGE DeriveDataTypeable    #-}
{-# LANGUAGE DeriveFunctor         #-}
{-# LANGUAGE DeriveTraversable     #-}
{-# LANGUAGE DeriveGeneric         #-}
{-# LANGUAGE LambdaCase            #-}
{-# LANGUAGE TemplateHaskellQuotes #-}

{-# LANGUAGE Safe #-}

{-# OPTIONS_HADDOCK show-extensions #-}

module Clash.Annotations.Primitive
  ( dontTranslate
  , hasBlackBox
  , warnNonSynthesizable
  , warnAlways
  , Primitive(..)
  , PrimitiveGuard(..)
  , HDL(..)
  , extractPrim
  ) where

import           Control.DeepSeq                          (NFData)
import           Data.Binary                              (Binary)
import           Data.Data
import           Data.Hashable                            (Hashable)
import           GHC.Generics                             (Generic)


-- The commented code directly below this comment is affected by an old
-- GHC bug: https://ghc.haskell.org/trac/ghc/ticket/5463. In short, NOINLINE
-- pragmas generated by Template Haskell, get ignored. We'd still like a better
-- API than manually having to write all the guard/inline pragmas some day,
-- so I'm leaving the code in for now.

{-

guard :: TH.Exp -> TH.Name -> TH.Q [TH.Dec]
guard guardExpr fName =
  pure
    [ TH.PragmaD (TH.InlineP fName TH.NoInline TH.FunLike TH.AllPhases)
    , TH.PragmaD (TH.AnnP (TH.ValueAnnotation fName) (TH.SigE guardExpr typ))
    ]
  where
    typ = TH.AppT (TH.ConT ''PrimitiveGuard) (TH.TupleT 0)

applyUnit :: TH.Exp -> TH.Exp
applyUnit e = TH.AppE e (TH.TupE [])

-- | Mark a function as having a primitive. Clash will yield an error if it
-- needs to translate this function, but no blackbox was loaded. Usage:
--
-- @
-- $(hasBlackBox 'f)
-- @
--
-- If you don't want to use TemplateHaskell, add these annotations:
--
-- @
-- {-# NOINLINE f #-}
-- {-# ANN f (HasBlackBox ()) #-}
-- @
--
hasBlackBox :: TH.Name -> TH.Q [TH.Dec]
hasBlackBox = guard (applyUnit (TH.ConE 'HasBlackBox))

-- | Mark a function as non translatable. Clash will yield an error if
-- it needs to translate this function. Usage:
--
-- @
-- $(dontTranslate 'f)
-- @
--
-- If you don't want to use TemplateHaskell, add these annotations:
--
-- @
-- {-# NOINLINE f #-}
-- {-# ANN f DontTranslate #-}
-- @
--
dontTranslate :: TH.Name -> TH.Q [TH.Dec]
dontTranslate = guard (TH.ConE 'DontTranslate)

-- | Mark a function as non synthesizable. Clash will emit the given warning
-- if instantiated outside of a testbench context. Usage:
--
-- @
-- $(warnNonSynthesizable 'f "Tread carefully, user!")
-- @
--
-- If you don't want to use TemplateHaskell, add these annotations:
--
-- @
-- {-# NOINLINE f #-}
-- {-# ANN f (WarnNonSynthesizable "Tread carefully, user!" ()) #-}
-- @
--
warnNotSynthesizable :: TH.Name -> String -> TH.Q [TH.Dec]
warnNotSynthesizable nm warning =
  guard
    (applyUnit
      (TH.AppE
        (TH.ConE 'WarnNonSynthesizable)
        (TH.LitE (TH.StringL warning))))
    nm

-- | Emit warning when translating this value.
--
-- @
-- $(warnAlways 'f "Tread carefully, user!")
-- @
--
-- If you don't want to use TemplateHaskell, add these annotations:
--
-- @
-- {-# NOINLINE f #-}
-- {-# ANN f (WarnAlways "Tread carefully, user!" ()) #-}
-- @
--
warnAlways :: TH.Name -> String -> TH.Q [TH.Dec]
warnAlways nm warning =
  guard
    (applyUnit
      (TH.AppE
        (TH.ConE 'WarnAlways)
        (TH.LitE (TH.StringL warning))))
    nm
-}

dontTranslate :: PrimitiveGuard ()
dontTranslate :: PrimitiveGuard ()
dontTranslate = PrimitiveGuard ()
forall a. PrimitiveGuard a
DontTranslate

hasBlackBox :: PrimitiveGuard ()
hasBlackBox :: PrimitiveGuard ()
hasBlackBox = () -> PrimitiveGuard ()
forall a. a -> PrimitiveGuard a
HasBlackBox ()

warnNonSynthesizable :: String -> PrimitiveGuard ()
warnNonSynthesizable :: String -> PrimitiveGuard ()
warnNonSynthesizable s :: String
s = String -> () -> PrimitiveGuard ()
forall a. String -> a -> PrimitiveGuard a
WarnNonSynthesizable String
s ()

warnAlways :: String -> PrimitiveGuard ()
warnAlways :: String -> PrimitiveGuard ()
warnAlways s :: String
s = String -> () -> PrimitiveGuard ()
forall a. String -> a -> PrimitiveGuard a
WarnAlways String
s ()

data HDL
  = SystemVerilog
  | Verilog
  | VHDL
  deriving (HDL -> HDL -> Bool
(HDL -> HDL -> Bool) -> (HDL -> HDL -> Bool) -> Eq HDL
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
/= :: HDL -> HDL -> Bool
$c/= :: HDL -> HDL -> Bool
== :: HDL -> HDL -> Bool
$c== :: HDL -> HDL -> Bool
Eq, Int -> HDL -> ShowS
[HDL] -> ShowS
HDL -> String
(Int -> HDL -> ShowS)
-> (HDL -> String) -> ([HDL] -> ShowS) -> Show HDL
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [HDL] -> ShowS
$cshowList :: [HDL] -> ShowS
show :: HDL -> String
$cshow :: HDL -> String
showsPrec :: Int -> HDL -> ShowS
$cshowsPrec :: Int -> HDL -> ShowS
Show, ReadPrec [HDL]
ReadPrec HDL
Int -> ReadS HDL
ReadS [HDL]
(Int -> ReadS HDL)
-> ReadS [HDL] -> ReadPrec HDL -> ReadPrec [HDL] -> Read HDL
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [HDL]
$creadListPrec :: ReadPrec [HDL]
readPrec :: ReadPrec HDL
$creadPrec :: ReadPrec HDL
readList :: ReadS [HDL]
$creadList :: ReadS [HDL]
readsPrec :: Int -> ReadS HDL
$creadsPrec :: Int -> ReadS HDL
Read, Typeable HDL
DataType
Constr
Typeable HDL =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g) -> HDL -> c HDL)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c HDL)
-> (HDL -> Constr)
-> (HDL -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c HDL))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HDL))
-> ((forall b. Data b => b -> b) -> HDL -> HDL)
-> (forall r r'.
    (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r)
-> (forall r r'.
    (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r)
-> (forall u. (forall d. Data d => d -> u) -> HDL -> [u])
-> (forall u. Int -> (forall d. Data d => d -> u) -> HDL -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> HDL -> m HDL)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> HDL -> m HDL)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> HDL -> m HDL)
-> Data HDL
HDL -> DataType
HDL -> Constr
(forall b. Data b => b -> b) -> HDL -> HDL
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HDL -> c HDL
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HDL
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) -> HDL -> u
forall u. (forall d. Data d => d -> u) -> HDL -> [u]
forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r
forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> HDL -> m HDL
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> HDL -> m HDL
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HDL
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HDL -> c HDL
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c HDL)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HDL)
$cVHDL :: Constr
$cVerilog :: Constr
$cSystemVerilog :: Constr
$tHDL :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> HDL -> m HDL
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> HDL -> m HDL
gmapMp :: (forall d. Data d => d -> m d) -> HDL -> m HDL
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> HDL -> m HDL
gmapM :: (forall d. Data d => d -> m d) -> HDL -> m HDL
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> HDL -> m HDL
gmapQi :: Int -> (forall d. Data d => d -> u) -> HDL -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> HDL -> u
gmapQ :: (forall d. Data d => d -> u) -> HDL -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> HDL -> [u]
gmapQr :: (r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r
$cgmapQr :: forall r r'.
(r' -> r -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r
gmapQl :: (r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r
$cgmapQl :: forall r r'.
(r -> r' -> r) -> r -> (forall d. Data d => d -> r') -> HDL -> r
gmapT :: (forall b. Data b => b -> b) -> HDL -> HDL
$cgmapT :: (forall b. Data b => b -> b) -> HDL -> HDL
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HDL)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c HDL)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c HDL)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c HDL)
dataTypeOf :: HDL -> DataType
$cdataTypeOf :: HDL -> DataType
toConstr :: HDL -> Constr
$ctoConstr :: HDL -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HDL
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c HDL
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HDL -> c HDL
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> HDL -> c HDL
$cp1Data :: Typeable HDL
Data, (forall x. HDL -> Rep HDL x)
-> (forall x. Rep HDL x -> HDL) -> Generic HDL
forall x. Rep HDL x -> HDL
forall x. HDL -> Rep HDL x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep HDL x -> HDL
$cfrom :: forall x. HDL -> Rep HDL x
Generic, HDL -> ()
(HDL -> ()) -> NFData HDL
forall a. (a -> ()) -> NFData a
rnf :: HDL -> ()
$crnf :: HDL -> ()
NFData, Int -> HDL -> Int
HDL -> Int
(Int -> HDL -> Int) -> (HDL -> Int) -> Hashable HDL
forall a. (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: HDL -> Int
$chash :: HDL -> Int
hashWithSalt :: Int -> HDL -> Int
$chashWithSalt :: Int -> HDL -> Int
Hashable)

-- | The 'Primitive' constructor instructs the clash compiler to look for primitive
-- HDL templates in the indicated directory. 'InlinePrimitive' is equivalent but
-- provides the HDL template inline. They are intended for the distribution of
-- new packages with primitive HDL templates.
--
-- === Example of 'Primitive'
--
-- You have some existing IP written in one of HDLs supported by Clash, and
-- you want to distribute some bindings so that the IP can be easily instantiated
-- from Clash.
--
-- You create a package which has a @myfancyip.cabal@ file with the following stanza:
--
-- @
-- data-files: path\/to\/MyFancyIP.json
-- cpp-options: -DCABAL
-- @
--
-- and a @MyFancyIP.hs@ module with the simulation definition and primitive.
--
-- @
-- module MyFancyIP where
--
-- import Clash.Prelude
--
-- myFancyIP :: ...
-- myFancyIP = ...
-- {\-\# NOINLINE myFancyIP \#-\}
-- @
--
-- The @NOINLINE@ pragma is needed so that GHC will never inline the definition.
--
-- Now you need to add the following imports and @ANN@ pragma:
--
-- @
-- \#ifdef CABAL
-- import           Clash.Annotations.Primitive
-- import           System.FilePath
-- import qualified Paths_myfancyip
-- import           System.IO.Unsafe
--
-- {\-\# ANN module (Primitive VHDL (unsafePerformIO Paths_myfancyip.getDataDir \<\/\> "path" \<\/\> "to")) \#-\}
-- \#endif
-- @
--
-- Add more files to the @data-files@ stanza in your @.cabal@ files and more
-- @ANN@ pragma's if you want to add more primitive templates for other HDLs
--
-- === Example of 'InlinePrimitive'
--
-- The following example shows off an inline HDL primitive template. It uses the
-- [interpolate](https://hackage.haskell.org/package/interpolate) package for
-- nicer multiline strings.
--
-- @
-- module InlinePrimitive where
--
-- import           Clash.Annotations.Primitive
-- import           Clash.Prelude
-- import           Data.String.Interpolate      (i)
-- import           Data.String.Interpolate.Util (unindent)
--
-- {\-\# ANN example (InlinePrimitive VHDL $ unindent [i|
--   [ { \"BlackBox\" :
--       { "name" : "InlinePrimitive.example"
--       , "kind": \"Declaration\"
--       , "template" :
--   "-- begin InlinePrimitive example:
--   ~GENSYM[example][0] : block
--   ~RESULT <= 1 + ~ARG[0];
--   end block;
--   -- end InlinePrimitive example"
--       }
--     }
--   ]
--   |]) \#-\}
-- {\-\# NOINLINE example \#-\}
-- example :: Signal System (BitVector 2) -> Signal System (BitVector 2)
-- example = fmap succ
-- @
data Primitive
  = Primitive HDL FilePath
  -- ^ Description of a primitive for a given 'HDL' in a file at 'FilePath'
  | InlinePrimitive HDL String
  -- ^ Description of a primitive for a given 'HDL' as an inline 'String'
  deriving (Int -> Primitive -> ShowS
[Primitive] -> ShowS
Primitive -> String
(Int -> Primitive -> ShowS)
-> (Primitive -> String)
-> ([Primitive] -> ShowS)
-> Show Primitive
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [Primitive] -> ShowS
$cshowList :: [Primitive] -> ShowS
show :: Primitive -> String
$cshow :: Primitive -> String
showsPrec :: Int -> Primitive -> ShowS
$cshowsPrec :: Int -> Primitive -> ShowS
Show, ReadPrec [Primitive]
ReadPrec Primitive
Int -> ReadS Primitive
ReadS [Primitive]
(Int -> ReadS Primitive)
-> ReadS [Primitive]
-> ReadPrec Primitive
-> ReadPrec [Primitive]
-> Read Primitive
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [Primitive]
$creadListPrec :: ReadPrec [Primitive]
readPrec :: ReadPrec Primitive
$creadPrec :: ReadPrec Primitive
readList :: ReadS [Primitive]
$creadList :: ReadS [Primitive]
readsPrec :: Int -> ReadS Primitive
$creadsPrec :: Int -> ReadS Primitive
Read, Typeable Primitive
DataType
Constr
Typeable Primitive =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g) -> Primitive -> c Primitive)
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c Primitive)
-> (Primitive -> Constr)
-> (Primitive -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c Primitive))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Primitive))
-> ((forall b. Data b => b -> b) -> Primitive -> Primitive)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> Primitive -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> Primitive -> r)
-> (forall u. (forall d. Data d => d -> u) -> Primitive -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> Primitive -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d) -> Primitive -> m Primitive)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> Primitive -> m Primitive)
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d) -> Primitive -> m Primitive)
-> Data Primitive
Primitive -> DataType
Primitive -> Constr
(forall b. Data b => b -> b) -> Primitive -> Primitive
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Primitive -> c Primitive
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Primitive
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) -> Primitive -> u
forall u. (forall d. Data d => d -> u) -> Primitive -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> Primitive -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> Primitive -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Primitive -> m Primitive
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Primitive -> m Primitive
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Primitive
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Primitive -> c Primitive
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Primitive)
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Primitive)
$cInlinePrimitive :: Constr
$cPrimitive :: Constr
$tPrimitive :: DataType
gmapMo :: (forall d. Data d => d -> m d) -> Primitive -> m Primitive
$cgmapMo :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Primitive -> m Primitive
gmapMp :: (forall d. Data d => d -> m d) -> Primitive -> m Primitive
$cgmapMp :: forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d) -> Primitive -> m Primitive
gmapM :: (forall d. Data d => d -> m d) -> Primitive -> m Primitive
$cgmapM :: forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d) -> Primitive -> m Primitive
gmapQi :: Int -> (forall d. Data d => d -> u) -> Primitive -> u
$cgmapQi :: forall u. Int -> (forall d. Data d => d -> u) -> Primitive -> u
gmapQ :: (forall d. Data d => d -> u) -> Primitive -> [u]
$cgmapQ :: forall u. (forall d. Data d => d -> u) -> Primitive -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> Primitive -> r
$cgmapQr :: forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> Primitive -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> Primitive -> r
$cgmapQl :: forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> Primitive -> r
gmapT :: (forall b. Data b => b -> b) -> Primitive -> Primitive
$cgmapT :: (forall b. Data b => b -> b) -> Primitive -> Primitive
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Primitive)
$cdataCast2 :: forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e)) -> Maybe (c Primitive)
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c Primitive)
$cdataCast1 :: forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c Primitive)
dataTypeOf :: Primitive -> DataType
$cdataTypeOf :: Primitive -> DataType
toConstr :: Primitive -> Constr
$ctoConstr :: Primitive -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Primitive
$cgunfold :: forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c Primitive
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Primitive -> c Primitive
$cgfoldl :: forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> Primitive -> c Primitive
$cp1Data :: Typeable Primitive
Data, (forall x. Primitive -> Rep Primitive x)
-> (forall x. Rep Primitive x -> Primitive) -> Generic Primitive
forall x. Rep Primitive x -> Primitive
forall x. Primitive -> Rep Primitive x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cto :: forall x. Rep Primitive x -> Primitive
$cfrom :: forall x. Primitive -> Rep Primitive x
Generic, Primitive -> ()
(Primitive -> ()) -> NFData Primitive
forall a. (a -> ()) -> NFData a
rnf :: Primitive -> ()
$crnf :: Primitive -> ()
NFData, Int -> Primitive -> Int
Primitive -> Int
(Int -> Primitive -> Int)
-> (Primitive -> Int) -> Hashable Primitive
forall a. (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: Primitive -> Int
$chash :: Primitive -> Int
hashWithSalt :: Int -> Primitive -> Int
$chashWithSalt :: Int -> Primitive -> Int
Hashable)

-- | Guard primitive functions. This will help Clash generate better error
-- messages. You can annotate a function like:

-- @
-- {-# ANN f dontTranslate #-}
-- @
--
-- or
--
-- @
-- {-# ANN f hasBlackBox #-}
-- @
--
-- or
--
-- @
-- {-# ANN f (warnNonSynthesizable "Tread carefully, user!") #-}
-- @
--
-- or
--
-- @
-- {-# ANN f (warnAlways "Tread carefully, user!") #-}
-- @
data PrimitiveGuard a
  = DontTranslate
  -- ^ Marks value as not translatable. Clash will error if it finds a blackbox
  -- definition for it, or when it is forced to translate it.
  | HasBlackBox a
  -- ^ Marks a value as having a blackbox. Clash will err if it hasn't found
  -- a blackbox
  | WarnNonSynthesizable String a
  -- ^ Marks value as non-synthesizable. This will trigger a warning if
  -- instantiated in a non-testbench context. Implies @HasBlackBox@.
  | WarnAlways String a
  -- ^ Always emit warning upon instantiation. Implies @HasBlackBox@.
    deriving (Int -> PrimitiveGuard a -> ShowS
[PrimitiveGuard a] -> ShowS
PrimitiveGuard a -> String
(Int -> PrimitiveGuard a -> ShowS)
-> (PrimitiveGuard a -> String)
-> ([PrimitiveGuard a] -> ShowS)
-> Show (PrimitiveGuard a)
forall a. Show a => Int -> PrimitiveGuard a -> ShowS
forall a. Show a => [PrimitiveGuard a] -> ShowS
forall a. Show a => PrimitiveGuard a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
showList :: [PrimitiveGuard a] -> ShowS
$cshowList :: forall a. Show a => [PrimitiveGuard a] -> ShowS
show :: PrimitiveGuard a -> String
$cshow :: forall a. Show a => PrimitiveGuard a -> String
showsPrec :: Int -> PrimitiveGuard a -> ShowS
$cshowsPrec :: forall a. Show a => Int -> PrimitiveGuard a -> ShowS
Show, ReadPrec [PrimitiveGuard a]
ReadPrec (PrimitiveGuard a)
Int -> ReadS (PrimitiveGuard a)
ReadS [PrimitiveGuard a]
(Int -> ReadS (PrimitiveGuard a))
-> ReadS [PrimitiveGuard a]
-> ReadPrec (PrimitiveGuard a)
-> ReadPrec [PrimitiveGuard a]
-> Read (PrimitiveGuard a)
forall a. Read a => ReadPrec [PrimitiveGuard a]
forall a. Read a => ReadPrec (PrimitiveGuard a)
forall a. Read a => Int -> ReadS (PrimitiveGuard a)
forall a. Read a => ReadS [PrimitiveGuard a]
forall a.
(Int -> ReadS a)
-> ReadS [a] -> ReadPrec a -> ReadPrec [a] -> Read a
readListPrec :: ReadPrec [PrimitiveGuard a]
$creadListPrec :: forall a. Read a => ReadPrec [PrimitiveGuard a]
readPrec :: ReadPrec (PrimitiveGuard a)
$creadPrec :: forall a. Read a => ReadPrec (PrimitiveGuard a)
readList :: ReadS [PrimitiveGuard a]
$creadList :: forall a. Read a => ReadS [PrimitiveGuard a]
readsPrec :: Int -> ReadS (PrimitiveGuard a)
$creadsPrec :: forall a. Read a => Int -> ReadS (PrimitiveGuard a)
Read, Typeable (PrimitiveGuard a)
DataType
Constr
Typeable (PrimitiveGuard a) =>
(forall (c :: * -> *).
 (forall d b. Data d => c (d -> b) -> d -> c b)
 -> (forall g. g -> c g)
 -> PrimitiveGuard a
 -> c (PrimitiveGuard a))
-> (forall (c :: * -> *).
    (forall b r. Data b => c (b -> r) -> c r)
    -> (forall r. r -> c r) -> Constr -> c (PrimitiveGuard a))
-> (PrimitiveGuard a -> Constr)
-> (PrimitiveGuard a -> DataType)
-> (forall (t :: * -> *) (c :: * -> *).
    Typeable t =>
    (forall d. Data d => c (t d)) -> Maybe (c (PrimitiveGuard a)))
-> (forall (t :: * -> * -> *) (c :: * -> *).
    Typeable t =>
    (forall d e. (Data d, Data e) => c (t d e))
    -> Maybe (c (PrimitiveGuard a)))
-> ((forall b. Data b => b -> b)
    -> PrimitiveGuard a -> PrimitiveGuard a)
-> (forall r r'.
    (r -> r' -> r)
    -> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r)
-> (forall r r'.
    (r' -> r -> r)
    -> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r)
-> (forall u.
    (forall d. Data d => d -> u) -> PrimitiveGuard a -> [u])
-> (forall u.
    Int -> (forall d. Data d => d -> u) -> PrimitiveGuard a -> u)
-> (forall (m :: * -> *).
    Monad m =>
    (forall d. Data d => d -> m d)
    -> PrimitiveGuard a -> m (PrimitiveGuard a))
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> PrimitiveGuard a -> m (PrimitiveGuard a))
-> (forall (m :: * -> *).
    MonadPlus m =>
    (forall d. Data d => d -> m d)
    -> PrimitiveGuard a -> m (PrimitiveGuard a))
-> Data (PrimitiveGuard a)
PrimitiveGuard a -> DataType
PrimitiveGuard a -> Constr
(forall d. Data d => c (t d)) -> Maybe (c (PrimitiveGuard a))
(forall b. Data b => b -> b)
-> PrimitiveGuard a -> PrimitiveGuard a
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> PrimitiveGuard a -> c (PrimitiveGuard a)
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c (PrimitiveGuard a)
forall a. Data a => Typeable (PrimitiveGuard a)
forall a. Data a => PrimitiveGuard a -> DataType
forall a. Data a => PrimitiveGuard a -> Constr
forall a.
Data a =>
(forall b. Data b => b -> b)
-> PrimitiveGuard a -> PrimitiveGuard a
forall a u.
Data a =>
Int -> (forall d. Data d => d -> u) -> PrimitiveGuard a -> u
forall a u.
Data a =>
(forall d. Data d => d -> u) -> PrimitiveGuard a -> [u]
forall a r r'.
Data a =>
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
forall a r r'.
Data a =>
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
forall a (m :: * -> *).
(Data a, Monad m) =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
forall a (m :: * -> *).
(Data a, MonadPlus m) =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
forall a (c :: * -> *).
Data a =>
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c (PrimitiveGuard a)
forall a (c :: * -> *).
Data a =>
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> PrimitiveGuard a -> c (PrimitiveGuard a)
forall a (t :: * -> *) (c :: * -> *).
(Data a, Typeable t) =>
(forall d. Data d => c (t d)) -> Maybe (c (PrimitiveGuard a))
forall a (t :: * -> * -> *) (c :: * -> *).
(Data a, Typeable t) =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c (PrimitiveGuard a))
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) -> PrimitiveGuard a -> u
forall u. (forall d. Data d => d -> u) -> PrimitiveGuard a -> [u]
forall r r'.
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
forall r r'.
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
forall (m :: * -> *).
Monad m =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
forall (m :: * -> *).
MonadPlus m =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
forall (c :: * -> *).
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c (PrimitiveGuard a)
forall (c :: * -> *).
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> PrimitiveGuard a -> c (PrimitiveGuard a)
forall (t :: * -> *) (c :: * -> *).
Typeable t =>
(forall d. Data d => c (t d)) -> Maybe (c (PrimitiveGuard a))
forall (t :: * -> * -> *) (c :: * -> *).
Typeable t =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c (PrimitiveGuard a))
$cWarnAlways :: Constr
$cWarnNonSynthesizable :: Constr
$cHasBlackBox :: Constr
$cDontTranslate :: Constr
$tPrimitiveGuard :: DataType
gmapMo :: (forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
$cgmapMo :: forall a (m :: * -> *).
(Data a, MonadPlus m) =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
gmapMp :: (forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
$cgmapMp :: forall a (m :: * -> *).
(Data a, MonadPlus m) =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
gmapM :: (forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
$cgmapM :: forall a (m :: * -> *).
(Data a, Monad m) =>
(forall d. Data d => d -> m d)
-> PrimitiveGuard a -> m (PrimitiveGuard a)
gmapQi :: Int -> (forall d. Data d => d -> u) -> PrimitiveGuard a -> u
$cgmapQi :: forall a u.
Data a =>
Int -> (forall d. Data d => d -> u) -> PrimitiveGuard a -> u
gmapQ :: (forall d. Data d => d -> u) -> PrimitiveGuard a -> [u]
$cgmapQ :: forall a u.
Data a =>
(forall d. Data d => d -> u) -> PrimitiveGuard a -> [u]
gmapQr :: (r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
$cgmapQr :: forall a r r'.
Data a =>
(r' -> r -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
gmapQl :: (r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
$cgmapQl :: forall a r r'.
Data a =>
(r -> r' -> r)
-> r -> (forall d. Data d => d -> r') -> PrimitiveGuard a -> r
gmapT :: (forall b. Data b => b -> b)
-> PrimitiveGuard a -> PrimitiveGuard a
$cgmapT :: forall a.
Data a =>
(forall b. Data b => b -> b)
-> PrimitiveGuard a -> PrimitiveGuard a
dataCast2 :: (forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c (PrimitiveGuard a))
$cdataCast2 :: forall a (t :: * -> * -> *) (c :: * -> *).
(Data a, Typeable t) =>
(forall d e. (Data d, Data e) => c (t d e))
-> Maybe (c (PrimitiveGuard a))
dataCast1 :: (forall d. Data d => c (t d)) -> Maybe (c (PrimitiveGuard a))
$cdataCast1 :: forall a (t :: * -> *) (c :: * -> *).
(Data a, Typeable t) =>
(forall d. Data d => c (t d)) -> Maybe (c (PrimitiveGuard a))
dataTypeOf :: PrimitiveGuard a -> DataType
$cdataTypeOf :: forall a. Data a => PrimitiveGuard a -> DataType
toConstr :: PrimitiveGuard a -> Constr
$ctoConstr :: forall a. Data a => PrimitiveGuard a -> Constr
gunfold :: (forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c (PrimitiveGuard a)
$cgunfold :: forall a (c :: * -> *).
Data a =>
(forall b r. Data b => c (b -> r) -> c r)
-> (forall r. r -> c r) -> Constr -> c (PrimitiveGuard a)
gfoldl :: (forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> PrimitiveGuard a -> c (PrimitiveGuard a)
$cgfoldl :: forall a (c :: * -> *).
Data a =>
(forall d b. Data d => c (d -> b) -> d -> c b)
-> (forall g. g -> c g) -> PrimitiveGuard a -> c (PrimitiveGuard a)
$cp1Data :: forall a. Data a => Typeable (PrimitiveGuard a)
Data, (forall x. PrimitiveGuard a -> Rep (PrimitiveGuard a) x)
-> (forall x. Rep (PrimitiveGuard a) x -> PrimitiveGuard a)
-> Generic (PrimitiveGuard a)
forall x. Rep (PrimitiveGuard a) x -> PrimitiveGuard a
forall x. PrimitiveGuard a -> Rep (PrimitiveGuard a) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall a x. Rep (PrimitiveGuard a) x -> PrimitiveGuard a
forall a x. PrimitiveGuard a -> Rep (PrimitiveGuard a) x
$cto :: forall a x. Rep (PrimitiveGuard a) x -> PrimitiveGuard a
$cfrom :: forall a x. PrimitiveGuard a -> Rep (PrimitiveGuard a) x
Generic, PrimitiveGuard a -> ()
(PrimitiveGuard a -> ()) -> NFData (PrimitiveGuard a)
forall a. NFData a => PrimitiveGuard a -> ()
forall a. (a -> ()) -> NFData a
rnf :: PrimitiveGuard a -> ()
$crnf :: forall a. NFData a => PrimitiveGuard a -> ()
NFData, Int -> PrimitiveGuard a -> Int
PrimitiveGuard a -> Int
(Int -> PrimitiveGuard a -> Int)
-> (PrimitiveGuard a -> Int) -> Hashable (PrimitiveGuard a)
forall a. Hashable a => Int -> PrimitiveGuard a -> Int
forall a. Hashable a => PrimitiveGuard a -> Int
forall a. (Int -> a -> Int) -> (a -> Int) -> Hashable a
hash :: PrimitiveGuard a -> Int
$chash :: forall a. Hashable a => PrimitiveGuard a -> Int
hashWithSalt :: Int -> PrimitiveGuard a -> Int
$chashWithSalt :: forall a. Hashable a => Int -> PrimitiveGuard a -> Int
Hashable, a -> PrimitiveGuard b -> PrimitiveGuard a
(a -> b) -> PrimitiveGuard a -> PrimitiveGuard b
(forall a b. (a -> b) -> PrimitiveGuard a -> PrimitiveGuard b)
-> (forall a b. a -> PrimitiveGuard b -> PrimitiveGuard a)
-> Functor PrimitiveGuard
forall a b. a -> PrimitiveGuard b -> PrimitiveGuard a
forall a b. (a -> b) -> PrimitiveGuard a -> PrimitiveGuard b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
<$ :: a -> PrimitiveGuard b -> PrimitiveGuard a
$c<$ :: forall a b. a -> PrimitiveGuard b -> PrimitiveGuard a
fmap :: (a -> b) -> PrimitiveGuard a -> PrimitiveGuard b
$cfmap :: forall a b. (a -> b) -> PrimitiveGuard a -> PrimitiveGuard b
Functor, PrimitiveGuard a -> Bool
(a -> m) -> PrimitiveGuard a -> m
(a -> b -> b) -> b -> PrimitiveGuard a -> b
(forall m. Monoid m => PrimitiveGuard m -> m)
-> (forall m a. Monoid m => (a -> m) -> PrimitiveGuard a -> m)
-> (forall m a. Monoid m => (a -> m) -> PrimitiveGuard a -> m)
-> (forall a b. (a -> b -> b) -> b -> PrimitiveGuard a -> b)
-> (forall a b. (a -> b -> b) -> b -> PrimitiveGuard a -> b)
-> (forall b a. (b -> a -> b) -> b -> PrimitiveGuard a -> b)
-> (forall b a. (b -> a -> b) -> b -> PrimitiveGuard a -> b)
-> (forall a. (a -> a -> a) -> PrimitiveGuard a -> a)
-> (forall a. (a -> a -> a) -> PrimitiveGuard a -> a)
-> (forall a. PrimitiveGuard a -> [a])
-> (forall a. PrimitiveGuard a -> Bool)
-> (forall a. PrimitiveGuard a -> Int)
-> (forall a. Eq a => a -> PrimitiveGuard a -> Bool)
-> (forall a. Ord a => PrimitiveGuard a -> a)
-> (forall a. Ord a => PrimitiveGuard a -> a)
-> (forall a. Num a => PrimitiveGuard a -> a)
-> (forall a. Num a => PrimitiveGuard a -> a)
-> Foldable PrimitiveGuard
forall a. Eq a => a -> PrimitiveGuard a -> Bool
forall a. Num a => PrimitiveGuard a -> a
forall a. Ord a => PrimitiveGuard a -> a
forall m. Monoid m => PrimitiveGuard m -> m
forall a. PrimitiveGuard a -> Bool
forall a. PrimitiveGuard a -> Int
forall a. PrimitiveGuard a -> [a]
forall a. (a -> a -> a) -> PrimitiveGuard a -> a
forall m a. Monoid m => (a -> m) -> PrimitiveGuard a -> m
forall b a. (b -> a -> b) -> b -> PrimitiveGuard a -> b
forall a b. (a -> b -> b) -> b -> PrimitiveGuard a -> b
forall (t :: * -> *).
(forall m. Monoid m => t m -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall m a. Monoid m => (a -> m) -> t a -> m)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall a b. (a -> b -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall b a. (b -> a -> b) -> b -> t a -> b)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. (a -> a -> a) -> t a -> a)
-> (forall a. t a -> [a])
-> (forall a. t a -> Bool)
-> (forall a. t a -> Int)
-> (forall a. Eq a => a -> t a -> Bool)
-> (forall a. Ord a => t a -> a)
-> (forall a. Ord a => t a -> a)
-> (forall a. Num a => t a -> a)
-> (forall a. Num a => t a -> a)
-> Foldable t
product :: PrimitiveGuard a -> a
$cproduct :: forall a. Num a => PrimitiveGuard a -> a
sum :: PrimitiveGuard a -> a
$csum :: forall a. Num a => PrimitiveGuard a -> a
minimum :: PrimitiveGuard a -> a
$cminimum :: forall a. Ord a => PrimitiveGuard a -> a
maximum :: PrimitiveGuard a -> a
$cmaximum :: forall a. Ord a => PrimitiveGuard a -> a
elem :: a -> PrimitiveGuard a -> Bool
$celem :: forall a. Eq a => a -> PrimitiveGuard a -> Bool
length :: PrimitiveGuard a -> Int
$clength :: forall a. PrimitiveGuard a -> Int
null :: PrimitiveGuard a -> Bool
$cnull :: forall a. PrimitiveGuard a -> Bool
toList :: PrimitiveGuard a -> [a]
$ctoList :: forall a. PrimitiveGuard a -> [a]
foldl1 :: (a -> a -> a) -> PrimitiveGuard a -> a
$cfoldl1 :: forall a. (a -> a -> a) -> PrimitiveGuard a -> a
foldr1 :: (a -> a -> a) -> PrimitiveGuard a -> a
$cfoldr1 :: forall a. (a -> a -> a) -> PrimitiveGuard a -> a
foldl' :: (b -> a -> b) -> b -> PrimitiveGuard a -> b
$cfoldl' :: forall b a. (b -> a -> b) -> b -> PrimitiveGuard a -> b
foldl :: (b -> a -> b) -> b -> PrimitiveGuard a -> b
$cfoldl :: forall b a. (b -> a -> b) -> b -> PrimitiveGuard a -> b
foldr' :: (a -> b -> b) -> b -> PrimitiveGuard a -> b
$cfoldr' :: forall a b. (a -> b -> b) -> b -> PrimitiveGuard a -> b
foldr :: (a -> b -> b) -> b -> PrimitiveGuard a -> b
$cfoldr :: forall a b. (a -> b -> b) -> b -> PrimitiveGuard a -> b
foldMap' :: (a -> m) -> PrimitiveGuard a -> m
$cfoldMap' :: forall m a. Monoid m => (a -> m) -> PrimitiveGuard a -> m
foldMap :: (a -> m) -> PrimitiveGuard a -> m
$cfoldMap :: forall m a. Monoid m => (a -> m) -> PrimitiveGuard a -> m
fold :: PrimitiveGuard m -> m
$cfold :: forall m. Monoid m => PrimitiveGuard m -> m
Foldable, Functor PrimitiveGuard
Foldable PrimitiveGuard
(Functor PrimitiveGuard, Foldable PrimitiveGuard) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> PrimitiveGuard a -> f (PrimitiveGuard b))
-> (forall (f :: * -> *) a.
    Applicative f =>
    PrimitiveGuard (f a) -> f (PrimitiveGuard a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> PrimitiveGuard a -> m (PrimitiveGuard b))
-> (forall (m :: * -> *) a.
    Monad m =>
    PrimitiveGuard (m a) -> m (PrimitiveGuard a))
-> Traversable PrimitiveGuard
(a -> f b) -> PrimitiveGuard a -> f (PrimitiveGuard b)
forall (t :: * -> *).
(Functor t, Foldable t) =>
(forall (f :: * -> *) a b.
 Applicative f =>
 (a -> f b) -> t a -> f (t b))
-> (forall (f :: * -> *) a. Applicative f => t (f a) -> f (t a))
-> (forall (m :: * -> *) a b.
    Monad m =>
    (a -> m b) -> t a -> m (t b))
-> (forall (m :: * -> *) a. Monad m => t (m a) -> m (t a))
-> Traversable t
forall (m :: * -> *) a.
Monad m =>
PrimitiveGuard (m a) -> m (PrimitiveGuard a)
forall (f :: * -> *) a.
Applicative f =>
PrimitiveGuard (f a) -> f (PrimitiveGuard a)
forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> PrimitiveGuard a -> m (PrimitiveGuard b)
forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> PrimitiveGuard a -> f (PrimitiveGuard b)
sequence :: PrimitiveGuard (m a) -> m (PrimitiveGuard a)
$csequence :: forall (m :: * -> *) a.
Monad m =>
PrimitiveGuard (m a) -> m (PrimitiveGuard a)
mapM :: (a -> m b) -> PrimitiveGuard a -> m (PrimitiveGuard b)
$cmapM :: forall (m :: * -> *) a b.
Monad m =>
(a -> m b) -> PrimitiveGuard a -> m (PrimitiveGuard b)
sequenceA :: PrimitiveGuard (f a) -> f (PrimitiveGuard a)
$csequenceA :: forall (f :: * -> *) a.
Applicative f =>
PrimitiveGuard (f a) -> f (PrimitiveGuard a)
traverse :: (a -> f b) -> PrimitiveGuard a -> f (PrimitiveGuard b)
$ctraverse :: forall (f :: * -> *) a b.
Applicative f =>
(a -> f b) -> PrimitiveGuard a -> f (PrimitiveGuard b)
$cp2Traversable :: Foldable PrimitiveGuard
$cp1Traversable :: Functor PrimitiveGuard
Traversable, Get (PrimitiveGuard a)
[PrimitiveGuard a] -> Put
PrimitiveGuard a -> Put
(PrimitiveGuard a -> Put)
-> Get (PrimitiveGuard a)
-> ([PrimitiveGuard a] -> Put)
-> Binary (PrimitiveGuard a)
forall a. Binary a => Get (PrimitiveGuard a)
forall a. Binary a => [PrimitiveGuard a] -> Put
forall a. Binary a => PrimitiveGuard a -> Put
forall t. (t -> Put) -> Get t -> ([t] -> Put) -> Binary t
putList :: [PrimitiveGuard a] -> Put
$cputList :: forall a. Binary a => [PrimitiveGuard a] -> Put
get :: Get (PrimitiveGuard a)
$cget :: forall a. Binary a => Get (PrimitiveGuard a)
put :: PrimitiveGuard a -> Put
$cput :: forall a. Binary a => PrimitiveGuard a -> Put
Binary)

-- | Extract primitive definition from a PrimitiveGuard. Will yield Nothing
-- for guards of value 'DontTranslate'.
extractPrim
  :: PrimitiveGuard a
  -> Maybe a
extractPrim :: PrimitiveGuard a -> Maybe a
extractPrim =
  \case
    HasBlackBox a :: a
a            -> a -> Maybe a
forall a. a -> Maybe a
Just a
a
    WarnNonSynthesizable _ a :: a
a -> a -> Maybe a
forall a. a -> Maybe a
Just a
a
    WarnAlways _ a :: a
a           -> a -> Maybe a
forall a. a -> Maybe a
Just a
a
    DontTranslate            -> Maybe a
forall a. Maybe a
Nothing