{-# LANGUAGE BangPatterns               #-}
{-# LANGUAGE CPP                        #-}
{-# LANGUAGE DerivingStrategies         #-}
{-# LANGUAGE FlexibleInstances          #-}
{-# LANGUAGE GeneralizedNewtypeDeriving #-}
{-# LANGUAGE KindSignatures             #-}
{-# LANGUAGE NamedFieldPuns             #-}
{-# LANGUAGE PolyKinds                  #-}
{-# LANGUAGE RankNTypes                 #-}
{-# LANGUAGE RecordWildCards            #-}
{-# LANGUAGE ScopedTypeVariables        #-}
{-# LANGUAGE StandaloneDeriving         #-}
{-# LANGUAGE TypeOperators              #-}
{-# LANGUAGE RoleAnnotations            #-}

-- | Canonical gecord (i.e., no diff)
--
-- Intended for qualified import.
--
-- > import Data.Record.Anonymous.Internal.Canonical (Canonical)
-- > import qualified Data.Record.Anonymous.Internal.Canonical as Canon
module Data.Record.Anon.Internal.Core.Canonical (
    Canonical(..)
    -- * Indexed access
  , getAtIndex
  , setAtIndex
    -- * Conversion
  , toList
  , fromList
  , toVector
  , fromVector
    -- * Basic API
  , insert
  , lens
    -- * Simple (non-constrained) combinators
  , map
  , mapM
  , zipWith
  , zipWithM
  , collapse
  , sequenceA
  , ap
    -- * Debugging support
#if DEBUG
  , toString
#endif
  ) where

import Prelude hiding (map, mapM, zip, zipWith, sequenceA, pure)

import Data.Coerce (coerce)
import Data.Kind
import Data.SOP.BasicFunctors
import Data.SOP.Classes (type (-.->)(apFn))
import GHC.Exts (Any)

#if DEBUG
import Debug.RecoverRTTI (AnythingToString(..))
#endif

import qualified Data.Foldable as Foldable

import Data.Record.Anon.Internal.Util.StrictArray (StrictArray)

import qualified Data.Record.Anon.Internal.Util.StrictArray as Strict

{-------------------------------------------------------------------------------
  Definition
-------------------------------------------------------------------------------}

-- | Canonical record representation
--
-- Canonicity here refers to the fact that we have no @Diff@ to apply (see
-- "Data.Record.Anonymous.Internal.Diff"). In this case, the record is
-- represented as a strict vector in row order (@large-anon@ is strict by
-- default; lazy records can be achieved using boxing). This order is important:
-- it makes it possible to define functions such as @mapM@ (for which ordering
-- must be well-defined).
--
-- Type level shadowing is reflected at the term level: if a record has
-- duplicate fields in its type, it will have multiple entries for that field
-- in the vector.
--
-- TODO: Currently we have no way of recovering the value of shadowed fields,
-- adding an API for that is future work. The work by Daan Leijen on scoped
-- labels might offer some inspiration there.
--
-- NOTE: When we cite the algorithmic complexity of operations on 'Canonical',
-- we assume that 'HashMap' inserts and lookups are @O(1)@, which they are in
-- practice (especially given the relatively small size of typical records),
-- even if theoretically they are @O(log n)@. See also the documentation of
-- "Data.HashMap.Strict".
newtype Canonical (f :: k -> Type) = Canonical (StrictArray (f Any))
  deriving newtype (b -> Canonical f -> Canonical f
NonEmpty (Canonical f) -> Canonical f
Canonical f -> Canonical f -> Canonical f
(Canonical f -> Canonical f -> Canonical f)
-> (NonEmpty (Canonical f) -> Canonical f)
-> (forall b. Integral b => b -> Canonical f -> Canonical f)
-> Semigroup (Canonical f)
forall b. Integral b => b -> Canonical f -> Canonical f
forall a.
(a -> a -> a)
-> (NonEmpty a -> a)
-> (forall b. Integral b => b -> a -> a)
-> Semigroup a
forall k (f :: k -> *). NonEmpty (Canonical f) -> Canonical f
forall k (f :: k -> *). Canonical f -> Canonical f -> Canonical f
forall k (f :: k -> *) b.
Integral b =>
b -> Canonical f -> Canonical f
stimes :: b -> Canonical f -> Canonical f
$cstimes :: forall k (f :: k -> *) b.
Integral b =>
b -> Canonical f -> Canonical f
sconcat :: NonEmpty (Canonical f) -> Canonical f
$csconcat :: forall k (f :: k -> *). NonEmpty (Canonical f) -> Canonical f
<> :: Canonical f -> Canonical f -> Canonical f
$c<> :: forall k (f :: k -> *). Canonical f -> Canonical f -> Canonical f
Semigroup, Semigroup (Canonical f)
Canonical f
Semigroup (Canonical f)
-> Canonical f
-> (Canonical f -> Canonical f -> Canonical f)
-> ([Canonical f] -> Canonical f)
-> Monoid (Canonical f)
[Canonical f] -> Canonical f
Canonical f -> Canonical f -> Canonical f
forall a.
Semigroup a -> a -> (a -> a -> a) -> ([a] -> a) -> Monoid a
forall k (f :: k -> *). Semigroup (Canonical f)
forall k (f :: k -> *). Canonical f
forall k (f :: k -> *). [Canonical f] -> Canonical f
forall k (f :: k -> *). Canonical f -> Canonical f -> Canonical f
mconcat :: [Canonical f] -> Canonical f
$cmconcat :: forall k (f :: k -> *). [Canonical f] -> Canonical f
mappend :: Canonical f -> Canonical f -> Canonical f
$cmappend :: forall k (f :: k -> *). Canonical f -> Canonical f -> Canonical f
mempty :: Canonical f
$cmempty :: forall k (f :: k -> *). Canonical f
$cp1Monoid :: forall k (f :: k -> *). Semigroup (Canonical f)
Monoid)

type role Canonical representational

deriving instance Show a => Show (Canonical (K a))

{-------------------------------------------------------------------------------
  Indexed access
-------------------------------------------------------------------------------}

-- | Get field at the specified index
--
-- @O(1)@.
getAtIndex :: Canonical f -> Int -> f Any
getAtIndex :: Canonical f -> Int -> f Any
getAtIndex (Canonical StrictArray (f Any)
c) Int
ix = StrictArray (f Any)
c StrictArray (f Any) -> Int -> f Any
forall a. StrictArray a -> Int -> a
Strict.! Int
ix

-- | Set fields at the specified indices
--
-- @O(n)@ in the size of the record (independent of the number of field updates)
-- @O(1)@ if the list of updates is empty.
setAtIndex :: [(Int, f Any)] -> Canonical f -> Canonical f
setAtIndex :: [(Int, f Any)] -> Canonical f -> Canonical f
setAtIndex [] Canonical f
c             = Canonical f
c
setAtIndex [(Int, f Any)]
fs (Canonical StrictArray (f Any)
v) = StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (f Any)
v StrictArray (f Any) -> [(Int, f Any)] -> StrictArray (f Any)
forall a. StrictArray a -> [(Int, a)] -> StrictArray a
Strict.// [(Int, f Any)]
fs)

{-------------------------------------------------------------------------------
  Conversion
-------------------------------------------------------------------------------}

-- | To strict vector
toVector :: Canonical f -> StrictArray (f Any)
toVector :: Canonical f -> StrictArray (f Any)
toVector (Canonical StrictArray (f Any)
v) = StrictArray (f Any)
v

-- | From strict vector
fromVector :: StrictArray (f Any) -> Canonical f
fromVector :: StrictArray (f Any) -> Canonical f
fromVector = StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical

-- | All fields in row order
--
-- @O(n)@
toList :: Canonical f -> [f Any]
toList :: Canonical f -> [f Any]
toList = StrictArray (f Any) -> [f Any]
forall (t :: * -> *) a. Foldable t => t a -> [a]
Foldable.toList (StrictArray (f Any) -> [f Any])
-> (Canonical f -> StrictArray (f Any)) -> Canonical f -> [f Any]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. Canonical f -> StrictArray (f Any)
forall k (f :: k -> *). Canonical f -> StrictArray (f Any)
toVector

-- | From list of fields in row order
--
-- @O(n)@.
fromList :: [f Any] -> Canonical f
fromList :: [f Any] -> Canonical f
fromList = StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
fromVector (StrictArray (f Any) -> Canonical f)
-> ([f Any] -> StrictArray (f Any)) -> [f Any] -> Canonical f
forall b c a. (b -> c) -> (a -> b) -> a -> c
. [f Any] -> StrictArray (f Any)
forall a. [a] -> StrictArray a
Strict.fromList

{-------------------------------------------------------------------------------
  Basic API
-------------------------------------------------------------------------------}

-- | Insert fields into the record
--
-- It is the responsibility of the caller to make sure that the linear
-- concatenation of the new fields to the existing record matches the row order
-- of the new record.
--
-- @O(n)@ in the number of inserts and the size of the record.
-- @O(1)@ if the list of inserts is empty.
insert :: forall f. [f Any] -> Canonical f -> Canonical f
insert :: [f Any] -> Canonical f -> Canonical f
insert []  = Canonical f -> Canonical f
forall a. a -> a
id
insert [f Any]
new = Canonical f -> Canonical f
prepend
  where
     prepend :: Canonical f -> Canonical f
     prepend :: Canonical f -> Canonical f
prepend (Canonical StrictArray (f Any)
v) = StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical ([f Any] -> StrictArray (f Any)
forall a. [a] -> StrictArray a
Strict.fromList [f Any]
new StrictArray (f Any) -> StrictArray (f Any) -> StrictArray (f Any)
forall a. Semigroup a => a -> a -> a
<> StrictArray (f Any)
v)

-- | Project out some fields in the selected order
--
-- It is the responsibility of the caller that the list of indices is in row
-- order of the new record.
--
-- @O(n)@ (in both directions)
lens :: StrictArray Int -> Canonical f -> (Canonical f, Canonical f -> Canonical f)
lens :: StrictArray Int
-> Canonical f -> (Canonical f, Canonical f -> Canonical f)
lens StrictArray Int
is (Canonical StrictArray (f Any)
v) = (
      StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (f Any) -> Canonical f)
-> StrictArray (f Any) -> Canonical f
forall a b. (a -> b) -> a -> b
$
        StrictArray (f Any) -> StrictArray Int -> StrictArray (f Any)
forall a. StrictArray a -> StrictArray Int -> StrictArray a
Strict.backpermute StrictArray (f Any)
v StrictArray Int
is
    , \(Canonical StrictArray (f Any)
v') -> StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (f Any) -> Canonical f)
-> StrictArray (f Any) -> Canonical f
forall a b. (a -> b) -> a -> b
$
         StrictArray (f Any)
-> StrictArray (Int, f Any) -> StrictArray (f Any)
forall a. StrictArray a -> StrictArray (Int, a) -> StrictArray a
Strict.update StrictArray (f Any)
v ((Int -> f Any -> (Int, f Any))
-> StrictArray Int
-> StrictArray (f Any)
-> StrictArray (Int, f Any)
forall a b c.
(a -> b -> c) -> StrictArray a -> StrictArray b -> StrictArray c
Strict.zipWith (,) StrictArray Int
is StrictArray (f Any)
v')
    )

{-------------------------------------------------------------------------------
  Simple (non-constrained) combinators
-------------------------------------------------------------------------------}

map :: (forall x. f x -> g x) -> Canonical f -> Canonical g
map :: (forall (x :: k). f x -> g x) -> Canonical f -> Canonical g
map forall (x :: k). f x -> g x
f (Canonical StrictArray (f Any)
v) = StrictArray (g Any) -> Canonical g
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (g Any) -> Canonical g)
-> StrictArray (g Any) -> Canonical g
forall a b. (a -> b) -> a -> b
$ (f Any -> g Any) -> StrictArray (f Any) -> StrictArray (g Any)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
fmap f Any -> g Any
forall (x :: k). f x -> g x
f StrictArray (f Any)
v

mapM ::
     Applicative m
  => (forall x. f x -> m (g x))
  -> Canonical f -> m (Canonical g)
mapM :: (forall (x :: k). f x -> m (g x)) -> Canonical f -> m (Canonical g)
mapM forall (x :: k). f x -> m (g x)
f (Canonical StrictArray (f Any)
v) = StrictArray (g Any) -> Canonical g
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (g Any) -> Canonical g)
-> m (StrictArray (g Any)) -> m (Canonical g)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (f Any -> m (g Any))
-> StrictArray (f Any) -> m (StrictArray (g Any))
forall (m :: * -> *) a b.
Applicative m =>
(a -> m b) -> StrictArray a -> m (StrictArray b)
Strict.mapM f Any -> m (g Any)
forall (x :: k). f x -> m (g x)
f StrictArray (f Any)
v

-- | Zip two records
--
-- Precondition: the two records must have the same shape.
zipWith ::
     (forall x. f x -> g x -> h x)
  -> Canonical f -> Canonical g -> Canonical h
zipWith :: (forall (x :: k). f x -> g x -> h x)
-> Canonical f -> Canonical g -> Canonical h
zipWith forall (x :: k). f x -> g x -> h x
f (Canonical StrictArray (f Any)
v) (Canonical StrictArray (g Any)
v') = StrictArray (h Any) -> Canonical h
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (h Any) -> Canonical h)
-> StrictArray (h Any) -> Canonical h
forall a b. (a -> b) -> a -> b
$ (f Any -> g Any -> h Any)
-> StrictArray (f Any)
-> StrictArray (g Any)
-> StrictArray (h Any)
forall a b c.
(a -> b -> c) -> StrictArray a -> StrictArray b -> StrictArray c
Strict.zipWith f Any -> g Any -> h Any
forall (x :: k). f x -> g x -> h x
f StrictArray (f Any)
v StrictArray (g Any)
v'

-- | Applicative zip of two records
--
-- Precondition: the two records must have the same shape.
zipWithM ::
     Applicative m
  => (forall x. f x -> g x -> m (h x))
  -> Canonical f -> Canonical g -> m (Canonical h)
zipWithM :: (forall (x :: k). f x -> g x -> m (h x))
-> Canonical f -> Canonical g -> m (Canonical h)
zipWithM forall (x :: k). f x -> g x -> m (h x)
f (Canonical StrictArray (f Any)
v) (Canonical StrictArray (g Any)
v') = StrictArray (h Any) -> Canonical h
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (h Any) -> Canonical h)
-> m (StrictArray (h Any)) -> m (Canonical h)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> (f Any -> g Any -> m (h Any))
-> StrictArray (f Any)
-> StrictArray (g Any)
-> m (StrictArray (h Any))
forall (m :: * -> *) a b c.
Applicative m =>
(a -> b -> m c)
-> StrictArray a -> StrictArray b -> m (StrictArray c)
Strict.zipWithM f Any -> g Any -> m (h Any)
forall (x :: k). f x -> g x -> m (h x)
f StrictArray (f Any)
v StrictArray (g Any)
v'

collapse :: Canonical (K a) -> [a]
collapse :: Canonical (K a) -> [a]
collapse (Canonical StrictArray (K a Any)
v) = [K a Any] -> [a]
forall k a. [K a Any] -> [a]
co ([K a Any] -> [a]) -> [K a Any] -> [a]
forall a b. (a -> b) -> a -> b
$ StrictArray (K a Any) -> [K a Any]
forall (t :: * -> *) a. Foldable t => t a -> [a]
Foldable.toList StrictArray (K a Any)
v
  where
    co :: [K a Any] -> [a]
    co :: [K a Any] -> [a]
co = [K a Any] -> [a]
coerce

sequenceA :: Applicative m => Canonical (m :.: f) -> m (Canonical f)
sequenceA :: Canonical (m :.: f) -> m (Canonical f)
sequenceA (Canonical StrictArray ((:.:) m f Any)
v) = StrictArray (f Any) -> Canonical f
forall k (f :: k -> *). StrictArray (f Any) -> Canonical f
Canonical (StrictArray (f Any) -> Canonical f)
-> m (StrictArray (f Any)) -> m (Canonical f)
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> ((:.:) m f Any -> m (f Any))
-> StrictArray ((:.:) m f Any) -> m (StrictArray (f Any))
forall (m :: * -> *) a b.
Applicative m =>
(a -> m b) -> StrictArray a -> m (StrictArray b)
Strict.mapM (:.:) m f Any -> m (f Any)
forall l k (f :: l -> *) (g :: k -> l) (p :: k).
(:.:) f g p -> f (g p)
unComp StrictArray ((:.:) m f Any)
v

ap :: Canonical (f -.-> g) -> Canonical f -> Canonical g
ap :: Canonical (f -.-> g) -> Canonical f -> Canonical g
ap = (forall (x :: k). (-.->) f g x -> f x -> g x)
-> Canonical (f -.-> g) -> Canonical f -> Canonical g
forall k (f :: k -> *) (g :: k -> *) (h :: k -> *).
(forall (x :: k). f x -> g x -> h x)
-> Canonical f -> Canonical g -> Canonical h
zipWith forall (x :: k). (-.->) f g x -> f x -> g x
forall k (f :: k -> *) (g :: k -> *) (a :: k).
(-.->) f g a -> f a -> g a
apFn

{-------------------------------------------------------------------------------
  Debugging support
-------------------------------------------------------------------------------}

#if DEBUG
toString :: forall k (f :: k -> Type). Canonical f -> String
toString = show . aux
  where
    aux :: Canonical f -> Canonical (K (AnythingToString (f Any)))
    aux = coerce
#endif