-- SPDX-FileCopyrightText: 2020 Tocqueville Group
--
-- SPDX-License-Identifier: LicenseRef-MIT-TQ

{-# LANGUAGE QuantifiedConstraints #-}

-- | Type families from 'Michelson.Typed.Polymorphic' lifted to Haskell types.
module Lorentz.Polymorphic
  ( MemOpHs (..)
  , MapOpHs (..)
  , IterOpHs (..)
  , SizeOpHs
  , UpdOpHs (..)
  , GetOpHs (..)
  , ConcatOpHs
  , SliceOpHs
  , EDivOpHs (..)

  , IsoMapOpRes
  ) where

import Lorentz.Constraints.Scopes (NiceComparable)
import Michelson.Text
import Michelson.Typed
import Tezos.Core (Mutez)

----------------------------------------------------------------------------
-- Mirrored from Michelson
----------------------------------------------------------------------------

-- | Lifted 'MemOpKey'.
class ( MemOp (ToT c)
      , ToT (MemOpKeyHs c) ~ MemOpKey (ToT c)
      ) => MemOpHs c where
  type MemOpKeyHs c :: Type

instance NiceComparable e => MemOpHs (Set e) where
  type MemOpKeyHs (Set e) = e

instance NiceComparable k => MemOpHs (Map k v) where
  type MemOpKeyHs (Map k v) = k

instance NiceComparable k => MemOpHs (BigMap k v) where
  type MemOpKeyHs (BigMap k v) = k

-- | A useful property which holds for reasonable 'MapOp' instances.
--
-- It's a separate thing from 'MapOpHs' because it mentions @b@ type parameter.
type family IsoMapOpRes c b where
  IsoMapOpRes c b = ToT (MapOpResHs c b) ~ MapOpRes (ToT c) (ToT b)

-- | Lifted 'MapOp'.
class ( MapOp (ToT c)
      , ToT (MapOpInpHs c) ~ MapOpInp (ToT c)
      , ToT (MapOpResHs c ()) ~ MapOpRes (ToT c) (ToT ())
      ) => MapOpHs c where
  type MapOpInpHs c :: Type
  type MapOpResHs c :: Type -> Type

instance NiceComparable k => MapOpHs (Map k v) where
  type MapOpInpHs (Map k v) = (k, v)
  type MapOpResHs (Map k v) = Map k

instance MapOpHs [e] where
  type MapOpInpHs [e] = e
  type MapOpResHs [e] = []

-- | Lifted 'IterOp'.
class ( IterOp (ToT c)
      , ToT (IterOpElHs c) ~ IterOpEl (ToT c)
      ) => IterOpHs c where
  type IterOpElHs c :: Type

instance NiceComparable k => IterOpHs (Map k v) where
  type IterOpElHs (Map k v) = (k, v)

instance IterOpHs [e] where
  type IterOpElHs [e] = e

instance NiceComparable e => IterOpHs (Set e) where
  type IterOpElHs (Set e) = e

-- | Lifted 'SizeOp'.
--
-- This could be just a constraint alias, but to avoid 'T' types appearance in
-- error messages we make a full type class with concrete instances.
class SizeOp (ToT c) => SizeOpHs c

instance SizeOpHs MText
instance SizeOpHs ByteString
instance SizeOpHs (Set a)
instance SizeOpHs [a]
instance SizeOpHs (Map k v)

-- | Lifted 'UpdOp'.
class ( UpdOp (ToT c)
      , ToT (UpdOpKeyHs c) ~ (UpdOpKey (ToT c))
      , ToT (UpdOpParamsHs c) ~ UpdOpParams (ToT c)
      ) => UpdOpHs c where
  type UpdOpKeyHs c :: Type
  type UpdOpParamsHs c :: Type

instance NiceComparable k => UpdOpHs (Map k v) where
  type UpdOpKeyHs (Map k v) = k
  type UpdOpParamsHs (Map k v) = Maybe v

instance NiceComparable k => UpdOpHs (BigMap k v) where
  type UpdOpKeyHs (BigMap k v) = k
  type UpdOpParamsHs (BigMap k v) = Maybe v

instance NiceComparable a => UpdOpHs (Set a) where
  type UpdOpKeyHs (Set a) = a
  type UpdOpParamsHs (Set a) = Bool

-- | Lifted 'GetOp'.
class ( GetOp (ToT c)
      , ToT (GetOpKeyHs c) ~ (GetOpKey (ToT c))
      , ToT (GetOpValHs c) ~ GetOpVal (ToT c)
      ) => GetOpHs c where
  type GetOpKeyHs c :: Type
  type GetOpValHs c :: Type

instance NiceComparable k => GetOpHs (Map k v) where
  type GetOpKeyHs (Map k v) = k
  type GetOpValHs (Map k v) = v

instance NiceComparable k => GetOpHs (BigMap k v) where
  type GetOpKeyHs (BigMap k v) = k
  type GetOpValHs (BigMap k v) = v

-- | Lifted 'ConcatOp'.
class ConcatOp (ToT c) => ConcatOpHs c

instance ConcatOpHs MText
instance ConcatOpHs ByteString

-- | Lifted 'SliceOp'.
class SliceOp (ToT c) => SliceOpHs c

instance SliceOpHs MText
instance SliceOpHs ByteString

-- | Lifted 'EDivOp'.
class ( EDivOp (ToT n) (ToT m)
      , NiceComparable n, NiceComparable m
      , ToT (EDivOpResHs n m) ~ EDivOpRes (ToT n) (ToT m)
      , ToT (EModOpResHs n m) ~ EModOpRes (ToT n) (ToT m)
      ) => EDivOpHs n m where
  type EDivOpResHs n m :: Type
  type EModOpResHs n m :: Type

instance EDivOpHs Integer Integer where
  type EDivOpResHs Integer Integer = Integer
  type EModOpResHs Integer Integer = Natural

instance EDivOpHs Integer Natural where
  type EDivOpResHs Integer Natural = Integer
  type EModOpResHs Integer Natural = Natural

instance EDivOpHs Natural Integer where
  type EDivOpResHs Natural Integer = Integer
  type EModOpResHs Natural Integer = Natural

instance EDivOpHs Natural Natural where
  type EDivOpResHs Natural Natural = Natural
  type EModOpResHs Natural Natural = Natural

instance EDivOpHs Mutez Mutez where
  type EDivOpResHs Mutez Mutez = Natural
  type EModOpResHs Mutez Mutez = Mutez

instance EDivOpHs Mutez Natural where
  type EDivOpResHs Mutez Natural = Mutez
  type EModOpResHs Mutez Natural = Mutez