module Covenant.Internal.Strategy
  ( DataEncoding (..),
    PlutusDataStrategy (..),
    InternalStrategy (..),
    PlutusDataConstructor (..),
  )
where

-- | Describes how a datatype is represented onchain.
--
-- @since 1.1.0
data DataEncoding
  = -- | The datatype is represented using the SOP primitives.
    --
    -- @since 1.1.0
    SOP
  | -- | The datatype is represented as @Data@, using the
    -- specified strategy to determine specifics.
    --
    -- @since 1.1.0
    PlutusData PlutusDataStrategy
  | -- | The type uses one of the builtin \'special\' strategies. This
    -- is used only for specific types and isn't generally available
    -- for use.
    --
    -- @since 1.1.0
    BuiltinStrategy InternalStrategy
  deriving stock
    ( -- | @since 1.1.0
      Int -> DataEncoding -> ShowS
[DataEncoding] -> ShowS
DataEncoding -> String
(Int -> DataEncoding -> ShowS)
-> (DataEncoding -> String)
-> ([DataEncoding] -> ShowS)
-> Show DataEncoding
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> DataEncoding -> ShowS
showsPrec :: Int -> DataEncoding -> ShowS
$cshow :: DataEncoding -> String
show :: DataEncoding -> String
$cshowList :: [DataEncoding] -> ShowS
showList :: [DataEncoding] -> ShowS
Show,
      -- | @since 1.1.0
      DataEncoding -> DataEncoding -> Bool
(DataEncoding -> DataEncoding -> Bool)
-> (DataEncoding -> DataEncoding -> Bool) -> Eq DataEncoding
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: DataEncoding -> DataEncoding -> Bool
== :: DataEncoding -> DataEncoding -> Bool
$c/= :: DataEncoding -> DataEncoding -> Bool
/= :: DataEncoding -> DataEncoding -> Bool
Eq,
      -- | @since 1.1.0
      Eq DataEncoding
Eq DataEncoding =>
(DataEncoding -> DataEncoding -> Ordering)
-> (DataEncoding -> DataEncoding -> Bool)
-> (DataEncoding -> DataEncoding -> Bool)
-> (DataEncoding -> DataEncoding -> Bool)
-> (DataEncoding -> DataEncoding -> Bool)
-> (DataEncoding -> DataEncoding -> DataEncoding)
-> (DataEncoding -> DataEncoding -> DataEncoding)
-> Ord DataEncoding
DataEncoding -> DataEncoding -> Bool
DataEncoding -> DataEncoding -> Ordering
DataEncoding -> DataEncoding -> DataEncoding
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 :: DataEncoding -> DataEncoding -> Ordering
compare :: DataEncoding -> DataEncoding -> Ordering
$c< :: DataEncoding -> DataEncoding -> Bool
< :: DataEncoding -> DataEncoding -> Bool
$c<= :: DataEncoding -> DataEncoding -> Bool
<= :: DataEncoding -> DataEncoding -> Bool
$c> :: DataEncoding -> DataEncoding -> Bool
> :: DataEncoding -> DataEncoding -> Bool
$c>= :: DataEncoding -> DataEncoding -> Bool
>= :: DataEncoding -> DataEncoding -> Bool
$cmax :: DataEncoding -> DataEncoding -> DataEncoding
max :: DataEncoding -> DataEncoding -> DataEncoding
$cmin :: DataEncoding -> DataEncoding -> DataEncoding
min :: DataEncoding -> DataEncoding -> DataEncoding
Ord
    )

-- NOTE: Wrapped data-primitive (Integer + ByteString) require a special case for their encoders, which was originally
--       part of a "WrapperData" strategy here which we generalized to the NewtypeData strategy.

-- | Specifics of how a @Data@-encoded datatype is represented.
--
-- @since 1.1.0
data PlutusDataStrategy
  = -- | The type is encoded as an @Integer@, corresponding to which \'arm\'
    -- of the datatype we want.
    --
    -- @since 1.1.0
    EnumData
  | -- | The type is encoded as a list of its fields.
    --
    -- @since 1.1.0
    ProductListData
  | -- | The type is encoded using @Constr@.
    --
    -- @since 1.1.0
    ConstrData
  | -- | The type \'borrows\' the encoding of whatever it wraps.
    --
    -- @since 1.1.0
    NewtypeData
  deriving stock
    ( -- | @since 1.1.0
      Int -> PlutusDataStrategy -> ShowS
[PlutusDataStrategy] -> ShowS
PlutusDataStrategy -> String
(Int -> PlutusDataStrategy -> ShowS)
-> (PlutusDataStrategy -> String)
-> ([PlutusDataStrategy] -> ShowS)
-> Show PlutusDataStrategy
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> PlutusDataStrategy -> ShowS
showsPrec :: Int -> PlutusDataStrategy -> ShowS
$cshow :: PlutusDataStrategy -> String
show :: PlutusDataStrategy -> String
$cshowList :: [PlutusDataStrategy] -> ShowS
showList :: [PlutusDataStrategy] -> ShowS
Show,
      -- | @since 1.1.0
      PlutusDataStrategy -> PlutusDataStrategy -> Bool
(PlutusDataStrategy -> PlutusDataStrategy -> Bool)
-> (PlutusDataStrategy -> PlutusDataStrategy -> Bool)
-> Eq PlutusDataStrategy
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
== :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
$c/= :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
/= :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
Eq,
      -- | @since 1.1.0
      Eq PlutusDataStrategy
Eq PlutusDataStrategy =>
(PlutusDataStrategy -> PlutusDataStrategy -> Ordering)
-> (PlutusDataStrategy -> PlutusDataStrategy -> Bool)
-> (PlutusDataStrategy -> PlutusDataStrategy -> Bool)
-> (PlutusDataStrategy -> PlutusDataStrategy -> Bool)
-> (PlutusDataStrategy -> PlutusDataStrategy -> Bool)
-> (PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy)
-> (PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy)
-> Ord PlutusDataStrategy
PlutusDataStrategy -> PlutusDataStrategy -> Bool
PlutusDataStrategy -> PlutusDataStrategy -> Ordering
PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy
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 :: PlutusDataStrategy -> PlutusDataStrategy -> Ordering
compare :: PlutusDataStrategy -> PlutusDataStrategy -> Ordering
$c< :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
< :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
$c<= :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
<= :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
$c> :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
> :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
$c>= :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
>= :: PlutusDataStrategy -> PlutusDataStrategy -> Bool
$cmax :: PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy
max :: PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy
$cmin :: PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy
min :: PlutusDataStrategy -> PlutusDataStrategy -> PlutusDataStrategy
Ord
    )

-- | The constructors of the onchain @Data@ type. Needed for other definitions
-- here.
--
-- @since 1.1.0
data PlutusDataConstructor
  = PlutusI
  | PlutusB
  | PlutusConstr
  | PlutusList
  | PlutusMap
  deriving stock
    ( -- | @since 1.1.0
      Int -> PlutusDataConstructor -> ShowS
[PlutusDataConstructor] -> ShowS
PlutusDataConstructor -> String
(Int -> PlutusDataConstructor -> ShowS)
-> (PlutusDataConstructor -> String)
-> ([PlutusDataConstructor] -> ShowS)
-> Show PlutusDataConstructor
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> PlutusDataConstructor -> ShowS
showsPrec :: Int -> PlutusDataConstructor -> ShowS
$cshow :: PlutusDataConstructor -> String
show :: PlutusDataConstructor -> String
$cshowList :: [PlutusDataConstructor] -> ShowS
showList :: [PlutusDataConstructor] -> ShowS
Show,
      -- | @since 1.1.0
      PlutusDataConstructor -> PlutusDataConstructor -> Bool
(PlutusDataConstructor -> PlutusDataConstructor -> Bool)
-> (PlutusDataConstructor -> PlutusDataConstructor -> Bool)
-> Eq PlutusDataConstructor
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
== :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
$c/= :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
/= :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
Eq,
      -- | @since 1.1.0
      Eq PlutusDataConstructor
Eq PlutusDataConstructor =>
(PlutusDataConstructor -> PlutusDataConstructor -> Ordering)
-> (PlutusDataConstructor -> PlutusDataConstructor -> Bool)
-> (PlutusDataConstructor -> PlutusDataConstructor -> Bool)
-> (PlutusDataConstructor -> PlutusDataConstructor -> Bool)
-> (PlutusDataConstructor -> PlutusDataConstructor -> Bool)
-> (PlutusDataConstructor
    -> PlutusDataConstructor -> PlutusDataConstructor)
-> (PlutusDataConstructor
    -> PlutusDataConstructor -> PlutusDataConstructor)
-> Ord PlutusDataConstructor
PlutusDataConstructor -> PlutusDataConstructor -> Bool
PlutusDataConstructor -> PlutusDataConstructor -> Ordering
PlutusDataConstructor
-> PlutusDataConstructor -> PlutusDataConstructor
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 :: PlutusDataConstructor -> PlutusDataConstructor -> Ordering
compare :: PlutusDataConstructor -> PlutusDataConstructor -> Ordering
$c< :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
< :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
$c<= :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
<= :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
$c> :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
> :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
$c>= :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
>= :: PlutusDataConstructor -> PlutusDataConstructor -> Bool
$cmax :: PlutusDataConstructor
-> PlutusDataConstructor -> PlutusDataConstructor
max :: PlutusDataConstructor
-> PlutusDataConstructor -> PlutusDataConstructor
$cmin :: PlutusDataConstructor
-> PlutusDataConstructor -> PlutusDataConstructor
min :: PlutusDataConstructor
-> PlutusDataConstructor -> PlutusDataConstructor
Ord
    )

data InternalStrategy
  = InternalListStrat
  | InternalPairStrat
  | InternalDataStrat
  | InternalAssocMapStrat
  | -- This exists solely so I can get a 'DataEncoding' out of an opaque, it's not really used
    InternalOpaqueStrat
  deriving stock
    ( Int -> InternalStrategy -> ShowS
[InternalStrategy] -> ShowS
InternalStrategy -> String
(Int -> InternalStrategy -> ShowS)
-> (InternalStrategy -> String)
-> ([InternalStrategy] -> ShowS)
-> Show InternalStrategy
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> InternalStrategy -> ShowS
showsPrec :: Int -> InternalStrategy -> ShowS
$cshow :: InternalStrategy -> String
show :: InternalStrategy -> String
$cshowList :: [InternalStrategy] -> ShowS
showList :: [InternalStrategy] -> ShowS
Show,
      InternalStrategy -> InternalStrategy -> Bool
(InternalStrategy -> InternalStrategy -> Bool)
-> (InternalStrategy -> InternalStrategy -> Bool)
-> Eq InternalStrategy
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: InternalStrategy -> InternalStrategy -> Bool
== :: InternalStrategy -> InternalStrategy -> Bool
$c/= :: InternalStrategy -> InternalStrategy -> Bool
/= :: InternalStrategy -> InternalStrategy -> Bool
Eq,
      Eq InternalStrategy
Eq InternalStrategy =>
(InternalStrategy -> InternalStrategy -> Ordering)
-> (InternalStrategy -> InternalStrategy -> Bool)
-> (InternalStrategy -> InternalStrategy -> Bool)
-> (InternalStrategy -> InternalStrategy -> Bool)
-> (InternalStrategy -> InternalStrategy -> Bool)
-> (InternalStrategy -> InternalStrategy -> InternalStrategy)
-> (InternalStrategy -> InternalStrategy -> InternalStrategy)
-> Ord InternalStrategy
InternalStrategy -> InternalStrategy -> Bool
InternalStrategy -> InternalStrategy -> Ordering
InternalStrategy -> InternalStrategy -> InternalStrategy
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 :: InternalStrategy -> InternalStrategy -> Ordering
compare :: InternalStrategy -> InternalStrategy -> Ordering
$c< :: InternalStrategy -> InternalStrategy -> Bool
< :: InternalStrategy -> InternalStrategy -> Bool
$c<= :: InternalStrategy -> InternalStrategy -> Bool
<= :: InternalStrategy -> InternalStrategy -> Bool
$c> :: InternalStrategy -> InternalStrategy -> Bool
> :: InternalStrategy -> InternalStrategy -> Bool
$c>= :: InternalStrategy -> InternalStrategy -> Bool
>= :: InternalStrategy -> InternalStrategy -> Bool
$cmax :: InternalStrategy -> InternalStrategy -> InternalStrategy
max :: InternalStrategy -> InternalStrategy -> InternalStrategy
$cmin :: InternalStrategy -> InternalStrategy -> InternalStrategy
min :: InternalStrategy -> InternalStrategy -> InternalStrategy
Ord
    )