grisette-0.7.0.0: src/Grisette/Internal/Core/Data/Class/ToCon.hs
{-# LANGUAGE CPP #-}
{-# LANGUAGE DataKinds #-}
{-# LANGUAGE DerivingVia #-}
{-# LANGUAGE FlexibleContexts #-}
{-# LANGUAGE FlexibleInstances #-}
{-# LANGUAGE GADTs #-}
{-# LANGUAGE InstanceSigs #-}
{-# LANGUAGE MultiParamTypeClasses #-}
{-# LANGUAGE PatternSynonyms #-}
{-# LANGUAGE QuantifiedConstraints #-}
{-# LANGUAGE ScopedTypeVariables #-}
{-# LANGUAGE StandaloneDeriving #-}
{-# LANGUAGE TemplateHaskell #-}
{-# LANGUAGE Trustworthy #-}
{-# LANGUAGE TypeFamilies #-}
{-# LANGUAGE TypeOperators #-}
{-# LANGUAGE UndecidableInstances #-}
-- |
-- Module : Grisette.Internal.Core.Data.Class.ToCon
-- Copyright : (c) Sirui Lu 2021-2023
-- License : BSD-3-Clause (see the LICENSE file)
--
-- Maintainer : siruilu@cs.washington.edu
-- Stability : Experimental
-- Portability : GHC only
module Grisette.Internal.Core.Data.Class.ToCon
( -- * Converting to concrete values
ToCon (..),
ToCon1 (..),
toCon1,
ToCon2 (..),
toCon2,
-- * Generic 'ToCon'
ToConArgs (..),
GToCon (..),
genericToCon,
genericLiftToCon,
)
where
import Control.Monad.Except (ExceptT (ExceptT))
import Control.Monad.Identity
( Identity (Identity, runIdentity),
IdentityT (IdentityT),
)
import Control.Monad.Trans.Maybe (MaybeT (MaybeT))
import qualified Control.Monad.Writer.Lazy as WriterLazy
import qualified Control.Monad.Writer.Strict as WriterStrict
import qualified Data.ByteString as B
import Data.Functor.Compose (Compose (Compose))
import Data.Functor.Const (Const)
import Data.Functor.Product (Product)
import Data.Functor.Sum (Sum)
import Data.Int (Int16, Int32, Int64, Int8)
import Data.Kind (Type)
import Data.Monoid (Alt, Ap)
import qualified Data.Monoid as Monoid
import Data.Ord (Down)
import qualified Data.Text as T
import Data.Word (Word16, Word32, Word64, Word8)
import GHC.Generics
( Generic (Rep, from, to),
Generic1 (Rep1, from1, to1),
K1 (K1),
M1 (M1),
Par1 (Par1),
Rec1 (Rec1),
U1 (U1),
V1,
(:.:) (Comp1),
type (:*:) ((:*:)),
type (:+:) (L1, R1),
)
import GHC.TypeNats (KnownNat, type (<=))
import Generics.Deriving (Default (Default), Default1 (Default1))
import Generics.Deriving.Instances ()
import Grisette.Internal.Core.Control.Exception
( AssertionError,
VerificationConditions,
)
import Grisette.Internal.Core.Data.Class.BitCast (BitCast (bitCast))
import Grisette.Internal.Core.Data.Class.Solvable
( Solvable (conView),
pattern Con,
)
import Grisette.Internal.SymPrim.BV
( IntN (IntN),
WordN (WordN),
)
import Grisette.Internal.SymPrim.FP (FP, FP32, FP64, FPRoundingMode, ValidFP)
import Grisette.Internal.SymPrim.GeneralFun (type (-->))
import Grisette.Internal.SymPrim.IntBitwidth (intBitwidthQ)
import Grisette.Internal.SymPrim.Prim.Term
( LinkedRep,
SupportedPrim,
)
import Grisette.Internal.SymPrim.SymBV
( SymIntN,
SymWordN,
)
import Grisette.Internal.SymPrim.SymBool (SymBool)
import Grisette.Internal.SymPrim.SymFP
( SymFP,
SymFP32,
SymFP64,
SymFPRoundingMode,
)
import Grisette.Internal.SymPrim.SymGeneralFun (type (-~>))
import Grisette.Internal.SymPrim.SymInteger (SymInteger)
import Grisette.Internal.SymPrim.SymTabularFun (type (=~>))
import Grisette.Internal.SymPrim.TabularFun (type (=->))
import Grisette.Internal.TH.DeriveBuiltin (deriveBuiltins)
import Grisette.Internal.TH.DeriveInstanceProvider
( Strategy (ViaDefault, ViaDefault1),
)
import Grisette.Internal.Utils.Derive (Arity0, Arity1)
-- $setup
-- >>> import Grisette.Core
-- >>> import Grisette.SymPrim
-- | Convert a symbolic value to concrete value if possible.
class ToCon a b where
-- | Convert a symbolic value to concrete value if possible.
-- If the symbolic value cannot be converted to concrete, the result will be 'Nothing'.
--
-- >>> toCon (ssym "a" :: SymInteger) :: Maybe Integer
-- Nothing
--
-- >>> toCon (con 1 :: SymInteger) :: Maybe Integer
-- Just 1
--
-- 'toCon' works on complex types too.
--
-- >>> toCon ([con 1, con 2] :: [SymInteger]) :: Maybe [Integer]
-- Just [1,2]
--
-- >>> toCon ([con 1, ssym "a"] :: [SymInteger]) :: Maybe [Integer]
-- Nothing
toCon :: a -> Maybe b
instance {-# INCOHERENT #-} ToCon v v where
toCon = Just
-- | Lifting of 'ToCon' to unary type constructors.
class (forall a b. (ToCon a b) => ToCon (f1 a) (f2 b)) => ToCon1 f1 f2 where
-- | Lift a conversion to concrete function to unary type constructors.
liftToCon :: (a -> Maybe b) -> f1 a -> Maybe (f2 b)
-- | Lift the standard 'toCon' to unary type constructors.
toCon1 :: (ToCon1 f1 f2, ToCon a b) => f1 a -> Maybe (f2 b)
toCon1 = liftToCon toCon
{-# INLINE toCon1 #-}
-- | Lifting of 'ToCon' to binary type constructors.
class (forall a b. (ToCon a b) => ToCon1 (f1 a) (f2 b)) => ToCon2 f1 f2 where
-- | Lift conversion to concrete functions to binary type constructors.
liftToCon2 :: (a -> Maybe b) -> (c -> Maybe d) -> f1 a c -> Maybe (f2 b d)
-- | Lift the standard 'toCon' to binary type constructors.
toCon2 :: (ToCon2 f1 f2, ToCon a b, ToCon c d) => f1 a c -> Maybe (f2 b d)
toCon2 = liftToCon2 toCon toCon
{-# INLINE toCon2 #-}
-- Derivations
-- | The arguments to the generic 'toCon' function.
data family ToConArgs arity a b :: Type
data instance ToConArgs Arity0 _ _ = ToConArgs0
newtype instance ToConArgs Arity1 a b
= ToConArgs1 (a -> Maybe b)
-- | The class of types that can be generically converted to concrete values.
class GToCon arity f1 f2 where
gtoCon :: ToConArgs arity a b -> f1 a -> Maybe (f2 b)
instance GToCon arity V1 V1 where
gtoCon _ _ = error "Impossible"
{-# INLINE gtoCon #-}
instance GToCon arity U1 U1 where
gtoCon _ _ = Just U1
{-# INLINE gtoCon #-}
instance
(GToCon arity a b, GToCon arity c d) =>
GToCon arity (a :*: c) (b :*: d)
where
gtoCon args (a :*: c) = do
a' <- gtoCon args a
c' <- gtoCon args c
return $ a' :*: c'
{-# INLINE gtoCon #-}
instance
(GToCon arity a b, GToCon arity c d) =>
GToCon arity (a :+: c) (b :+: d)
where
gtoCon args (L1 a) = L1 <$> gtoCon args a
gtoCon args (R1 a) = R1 <$> gtoCon args a
{-# INLINE gtoCon #-}
instance (GToCon arity a b) => GToCon arity (M1 i c1 a) (M1 i c2 b) where
gtoCon args (M1 a) = M1 <$> gtoCon args a
{-# INLINE gtoCon #-}
instance (ToCon a b) => GToCon arity (K1 i a) (K1 i b) where
gtoCon _ (K1 a) = K1 <$> toCon a
{-# INLINE gtoCon #-}
instance GToCon Arity1 Par1 Par1 where
gtoCon (ToConArgs1 f) (Par1 a) = Par1 <$> f a
{-# INLINE gtoCon #-}
instance (ToCon1 f1 f2) => GToCon Arity1 (Rec1 f1) (Rec1 f2) where
gtoCon (ToConArgs1 f) (Rec1 a) = Rec1 <$> liftToCon f a
{-# INLINE gtoCon #-}
instance
(ToCon1 f1 f2, GToCon Arity1 g1 g2) =>
GToCon Arity1 (f1 :.: g1) (f2 :.: g2)
where
gtoCon targs (Comp1 a) = Comp1 <$> liftToCon (gtoCon targs) a
{-# INLINE gtoCon #-}
-- | Generic 'toCon' function.
genericToCon ::
(Generic a, Generic b, GToCon Arity0 (Rep a) (Rep b)) =>
a ->
Maybe b
genericToCon = fmap to . gtoCon ToConArgs0 . from
{-# INLINE genericToCon #-}
-- | Generic 'liftToCon' function.
genericLiftToCon ::
(Generic1 f1, Generic1 f2, GToCon Arity1 (Rep1 f1) (Rep1 f2)) =>
(a -> Maybe b) ->
f1 a ->
Maybe (f2 b)
genericLiftToCon f = fmap to1 . gtoCon (ToConArgs1 f) . from1
{-# INLINE genericLiftToCon #-}
instance
(Generic a, Generic b, GToCon Arity0 (Rep a) (Rep b)) =>
ToCon a (Default b)
where
toCon = fmap Default . genericToCon
{-# INLINE toCon #-}
instance
(Generic1 f1, Generic1 f2, GToCon Arity1 (Rep1 f1) (Rep1 f2), ToCon a b) =>
ToCon (f1 a) (Default1 f2 b)
where
toCon = toCon1
instance
(Generic1 f1, Generic1 f2, GToCon Arity1 (Rep1 f1) (Rep1 f2)) =>
ToCon1 f1 (Default1 f2)
where
liftToCon f = fmap Default1 . genericLiftToCon f
{-# INLINE liftToCon #-}
#define CONCRETE_TOCON(type) \
instance ToCon type type where \
toCon = Just
#define CONCRETE_TOCON_BV(type) \
instance (KnownNat n, 1 <= n) => ToCon (type n) (type n) where \
toCon = Just
#if 1
CONCRETE_TOCON(Bool)
CONCRETE_TOCON(Integer)
CONCRETE_TOCON(Char)
CONCRETE_TOCON(Int)
CONCRETE_TOCON(Int8)
CONCRETE_TOCON(Int16)
CONCRETE_TOCON(Int32)
CONCRETE_TOCON(Int64)
CONCRETE_TOCON(Word)
CONCRETE_TOCON(Word8)
CONCRETE_TOCON(Word16)
CONCRETE_TOCON(Word32)
CONCRETE_TOCON(Word64)
CONCRETE_TOCON(Float)
CONCRETE_TOCON(Double)
CONCRETE_TOCON(B.ByteString)
CONCRETE_TOCON(T.Text)
CONCRETE_TOCON_BV(WordN)
CONCRETE_TOCON_BV(IntN)
CONCRETE_TOCON(FPRoundingMode)
CONCRETE_TOCON(Monoid.All)
CONCRETE_TOCON(Monoid.Any)
CONCRETE_TOCON(Ordering)
#endif
instance (ValidFP eb sb) => ToCon (FP eb sb) (FP eb sb) where
toCon = Just
#define TO_CON_SYMID_SIMPLE(symtype) \
instance ToCon symtype symtype where \
toCon = Just
#define TO_CON_SYMID_BV(symtype) \
instance (KnownNat n, 1 <= n) => ToCon (symtype n) (symtype n) where \
toCon = Just
#define TO_CON_SYMID_FUN(op) \
instance (SupportedPrim a, SupportedPrim b) => ToCon (a op b) (a op b) where \
toCon = Just
#if 1
TO_CON_SYMID_SIMPLE(SymBool)
TO_CON_SYMID_SIMPLE(SymInteger)
TO_CON_SYMID_BV(SymIntN)
TO_CON_SYMID_BV(SymWordN)
TO_CON_SYMID_FUN(=~>)
TO_CON_SYMID_FUN(-~>)
TO_CON_SYMID_SIMPLE(SymFPRoundingMode)
#endif
instance (ValidFP eb sb) => ToCon (SymFP eb sb) (SymFP eb sb) where
toCon = Just
#define TO_CON_FROMSYM_SIMPLE(contype, symtype) \
instance ToCon symtype contype where \
toCon = conView
#define TO_CON_FROMSYM_BV(contype, symtype) \
instance (KnownNat n, 1 <= n) => ToCon (symtype n) (contype n) where \
toCon = conView
#define TO_CON_FROMSYM_FUN(conop, symop) \
instance (SupportedPrim (conop ca cb), LinkedRep ca sa, LinkedRep cb sb) => \
ToCon (symop sa sb) (conop ca cb) where \
toCon = conView
#if 1
TO_CON_FROMSYM_SIMPLE(Bool, SymBool)
TO_CON_FROMSYM_SIMPLE(Integer, SymInteger)
TO_CON_FROMSYM_BV(IntN, SymIntN)
TO_CON_FROMSYM_BV(WordN, SymWordN)
TO_CON_FROMSYM_FUN((=->), (=~>))
TO_CON_FROMSYM_FUN((-->), (-~>))
TO_CON_FROMSYM_SIMPLE(FPRoundingMode, SymFPRoundingMode)
#endif
instance (ValidFP eb sb) => ToCon (SymFP eb sb) (FP eb sb) where
toCon = conView
#define TOCON_MACHINE_INTEGER(sbvw, bvw, n, int) \
instance ToCon (sbvw n) int where \
toCon (Con (bvw v :: bvw n)) = Just $ fromIntegral v; \
toCon _ = Nothing
#if 1
TOCON_MACHINE_INTEGER(SymIntN, IntN, 8, Int8)
TOCON_MACHINE_INTEGER(SymIntN, IntN, 16, Int16)
TOCON_MACHINE_INTEGER(SymIntN, IntN, 32, Int32)
TOCON_MACHINE_INTEGER(SymIntN, IntN, 64, Int64)
TOCON_MACHINE_INTEGER(SymWordN, WordN, 8, Word8)
TOCON_MACHINE_INTEGER(SymWordN, WordN, 16, Word16)
TOCON_MACHINE_INTEGER(SymWordN, WordN, 32, Word32)
TOCON_MACHINE_INTEGER(SymWordN, WordN, 64, Word64)
TOCON_MACHINE_INTEGER(SymIntN, IntN, $intBitwidthQ, Int)
TOCON_MACHINE_INTEGER(SymWordN, WordN, $intBitwidthQ, Word)
#endif
instance ToCon SymFP32 Float where
toCon (Con (fp :: FP32)) = Just $ bitCast fp
toCon _ = Nothing
instance ToCon SymFP64 Double where
toCon (Con (fp :: FP64)) = Just $ bitCast fp
toCon _ = Nothing
deriveBuiltins
(ViaDefault ''ToCon)
[''ToCon]
[ ''[],
''Maybe,
''Either,
''(),
''(,),
''(,,),
''(,,,),
''(,,,,),
''(,,,,,),
''(,,,,,,),
''(,,,,,,,),
''(,,,,,,,,),
''(,,,,,,,,,),
''(,,,,,,,,,,),
''(,,,,,,,,,,,),
''(,,,,,,,,,,,,),
''(,,,,,,,,,,,,,),
''(,,,,,,,,,,,,,,),
''AssertionError,
''VerificationConditions,
''Monoid.Dual,
''Monoid.Sum,
''Monoid.Product,
''Monoid.First,
''Monoid.Last,
''Down
]
deriveBuiltins
(ViaDefault1 ''ToCon1)
[''ToCon, ''ToCon1]
[ ''[],
''Maybe,
''Either,
''(,),
''(,,),
''(,,,),
''(,,,,),
''(,,,,,),
''(,,,,,,),
''(,,,,,,,),
''(,,,,,,,,),
''(,,,,,,,,,),
''(,,,,,,,,,,),
''(,,,,,,,,,,,),
''(,,,,,,,,,,,,),
''(,,,,,,,,,,,,,),
''(,,,,,,,,,,,,,,),
''Monoid.Dual,
''Monoid.Sum,
''Monoid.Product,
''Monoid.First,
''Monoid.Last,
''Down
]
-- ExceptT
instance
(ToCon1 m1 m2, ToCon e1 e2, ToCon a b) =>
ToCon (ExceptT e1 m1 a) (ExceptT e2 m2 b)
where
toCon = toCon1
{-# INLINE toCon #-}
instance
(ToCon1 m1 m2, ToCon e1 e2) =>
ToCon1 (ExceptT e1 m1) (ExceptT e2 m2)
where
liftToCon f (ExceptT v) = ExceptT <$> liftToCon (liftToCon f) v
{-# INLINE liftToCon #-}
-- MaybeT
instance
(ToCon1 m1 m2, ToCon a b) =>
ToCon (MaybeT m1 a) (MaybeT m2 b)
where
toCon = toCon1
{-# INLINE toCon #-}
instance
(ToCon1 m1 m2) =>
ToCon1 (MaybeT m1) (MaybeT m2)
where
liftToCon f (MaybeT v) = MaybeT <$> liftToCon (liftToCon f) v
{-# INLINE liftToCon #-}
-- WriterT
instance
(ToCon1 m1 m2, ToCon a b, ToCon s1 s2) =>
ToCon (WriterLazy.WriterT s1 m1 a) (WriterLazy.WriterT s2 m2 b)
where
toCon (WriterLazy.WriterT v) = WriterLazy.WriterT <$> toCon v
instance
(ToCon1 m1 m2, ToCon s1 s2) =>
ToCon1 (WriterLazy.WriterT s1 m1) (WriterLazy.WriterT s2 m2)
where
liftToCon f (WriterLazy.WriterT v) =
WriterLazy.WriterT <$> liftToCon (liftToCon2 f toCon) v
instance
(ToCon1 m1 m2, ToCon a b, ToCon s1 s2) =>
ToCon (WriterStrict.WriterT s1 m1 a) (WriterStrict.WriterT s2 m2 b)
where
toCon (WriterStrict.WriterT v) = WriterStrict.WriterT <$> toCon v
instance
(ToCon1 m1 m2, ToCon s1 s2) =>
ToCon1 (WriterStrict.WriterT s1 m1) (WriterStrict.WriterT s2 m2)
where
liftToCon f (WriterStrict.WriterT v) =
WriterStrict.WriterT <$> liftToCon (liftToCon2 f toCon) v
-- IdentityT
instance
(ToCon1 m m1, ToCon a b) =>
ToCon (IdentityT m a) (IdentityT m1 b)
where
toCon = toCon1
{-# INLINE toCon #-}
instance
(ToCon1 m m1) =>
ToCon1 (IdentityT m) (IdentityT m1)
where
liftToCon f (IdentityT a) = IdentityT <$> liftToCon f a
{-# INLINE liftToCon #-}
-- Identity
instance {-# INCOHERENT #-} (ToCon a b) => ToCon (Identity a) (Identity b) where
toCon = toCon1
instance {-# INCOHERENT #-} (ToCon a b) => ToCon (Identity a) b where
toCon = toCon . runIdentity
instance {-# INCOHERENT #-} (ToCon a b) => ToCon a (Identity b) where
toCon = fmap Identity . toCon
instance ToCon1 Identity Identity where
liftToCon f (Identity a) = Identity <$> f a
-- Special
instance
(ToCon (m1 (Either e1 a)) (Either e2 b)) =>
ToCon (ExceptT e1 m1 a) (Either e2 b)
where
toCon (ExceptT v) = toCon v
-- Product
deriving via
(Default (Product l r a))
instance
(ToCon (l0 a0) (l a), ToCon (r0 a0) (r a)) =>
ToCon (Product l0 r0 a0) (Product l r a)
deriving via
(Default1 (Product l r))
instance
(ToCon1 l0 l, ToCon1 r0 r) => ToCon1 (Product l0 r0) (Product l r)
-- Sum
deriving via
(Default (Sum l r a))
instance
(ToCon (l0 a0) (l a), ToCon (r0 a0) (r a)) =>
ToCon (Sum l0 r0 a0) (Sum l r a)
deriving via
(Default1 (Sum l r))
instance
(ToCon1 l0 l, ToCon1 r0 r) => ToCon1 (Sum l0 r0) (Sum l r)
-- Compose
deriving via
(Default (Compose f g a))
instance
(ToCon (f0 (g0 a0)) (f (g a))) => ToCon (Compose f0 g0 a0) (Compose f g a)
instance
(ToCon1 f0 f, ToCon1 g0 g) =>
ToCon1 (Compose f0 g0) (Compose f g)
where
liftToCon f (Compose a) = Compose <$> liftToCon (liftToCon f) a
{-# INLINE liftToCon #-}
-- Const
deriving via
(Default (Const a b))
instance
(ToCon a0 a) => ToCon (Const a0 b0) (Const a b)
deriving via
(Default1 (Const a))
instance
(ToCon a0 a) => ToCon1 (Const a0) (Const a)
-- Alt
deriving via
(Default (Alt f a))
instance
(ToCon (f0 a0) (f a)) => ToCon (Alt f0 a0) (Alt f a)
deriving via
(Default1 (Alt f))
instance
(ToCon1 f0 f) => ToCon1 (Alt f0) (Alt f)
-- Ap
deriving via
(Default (Ap f a))
instance
(ToCon (f0 a0) (f a)) => ToCon (Ap f0 a0) (Ap f a)
deriving via
(Default1 (Ap f))
instance
(ToCon1 f0 f) => ToCon1 (Ap f0) (Ap f)
-- Generic
deriving via (Default (U1 p)) instance ToCon (U1 p0) (U1 p)
deriving via (Default (V1 p)) instance ToCon (V1 p0) (V1 p)
deriving via
(Default (K1 i c p))
instance
(ToCon c0 c) => ToCon (K1 i0 c0 p0) (K1 i c p)
deriving via
(Default (M1 i c f p))
instance
(ToCon (f0 p0) (f p)) => ToCon (M1 i0 c0 f0 p0) (M1 i c f p)
deriving via
(Default ((f :+: g) p))
instance
(ToCon (f0 p0) (f p), ToCon (g0 p0) (g p)) =>
ToCon ((f0 :+: g0) p0) ((f :+: g) p)
deriving via
(Default ((f :*: g) p))
instance
(ToCon (f0 p0) (f p), ToCon (g0 p0) (g p)) =>
ToCon ((f0 :*: g0) p0) ((f :*: g) p)
deriving via
(Default (Par1 p))
instance
(ToCon p0 p) => ToCon (Par1 p0) (Par1 p)
deriving via
(Default (Rec1 f p))
instance
(ToCon (f0 p0) (f p)) => ToCon (Rec1 f0 p0) (Rec1 f p)
deriving via
(Default ((f :.: g) p))
instance
(ToCon (f0 (g0 p0)) (f (g p))) => ToCon ((f0 :.: g0) p0) ((f :.: g) p)
-- ToCon2
instance ToCon2 Either Either where
liftToCon2 f _ (Left a) = Left <$> f a
liftToCon2 _ g (Right b) = Right <$> g b
{-# INLINE liftToCon2 #-}
instance ToCon2 (,) (,) where
liftToCon2 f g (a, b) = (,) <$> f a <*> g b
{-# INLINE liftToCon2 #-}
instance (ToCon a b) => ToCon2 ((,,) a) ((,,) b) where
liftToCon2 f g (a, b, c) = (,,) <$> toCon a <*> f b <*> g c
{-# INLINE liftToCon2 #-}
instance (ToCon a c, ToCon b d) => ToCon2 ((,,,) a b) ((,,,) c d) where
liftToCon2 f g (a, b, c, d) = (,,,) <$> toCon a <*> toCon b <*> f c <*> g d
{-# INLINE liftToCon2 #-}