{-# LANGUAGE OverloadedStrings #-}

-- |
-- SPDX-License-Identifier: BSD-3-Clause
--
-- Walkability exceptions
module Swarm.Game.Robot.Walk where

import Control.Monad (unless)
import Data.Aeson
import Data.List.NonEmpty qualified as NE
import Data.Set (Set)
import Data.Set qualified as S
import GHC.Generics (Generic)
import Swarm.Game.Entity (EntityName)
import Swarm.Language.Capability (Capability)

-- | A 'Blacklist' that is empty is the typical behavior,
-- in which walkability is
-- fully determined by an entity's 'Unwalkable' or 'Liquid' property.
-- A 'Whitelist' ignores those properties, and even blank terrain
-- is considered unwalkable.
-- Note that a 'Whitelist' that is empty would allow no movement whatsoever.
data Inclusions a
  = Whitelist a
  | Blacklist a
  deriving (Int -> Inclusions a -> ShowS
[Inclusions a] -> ShowS
Inclusions a -> String
(Int -> Inclusions a -> ShowS)
-> (Inclusions a -> String)
-> ([Inclusions a] -> ShowS)
-> Show (Inclusions a)
forall a. Show a => Int -> Inclusions a -> ShowS
forall a. Show a => [Inclusions a] -> ShowS
forall a. Show a => Inclusions a -> String
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: forall a. Show a => Int -> Inclusions a -> ShowS
showsPrec :: Int -> Inclusions a -> ShowS
$cshow :: forall a. Show a => Inclusions a -> String
show :: Inclusions a -> String
$cshowList :: forall a. Show a => [Inclusions a] -> ShowS
showList :: [Inclusions a] -> ShowS
Show, Inclusions a -> Inclusions a -> Bool
(Inclusions a -> Inclusions a -> Bool)
-> (Inclusions a -> Inclusions a -> Bool) -> Eq (Inclusions a)
forall a. Eq a => Inclusions a -> Inclusions a -> Bool
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: forall a. Eq a => Inclusions a -> Inclusions a -> Bool
== :: Inclusions a -> Inclusions a -> Bool
$c/= :: forall a. Eq a => Inclusions a -> Inclusions a -> Bool
/= :: Inclusions a -> Inclusions a -> Bool
Eq, (forall a b. (a -> b) -> Inclusions a -> Inclusions b)
-> (forall a b. a -> Inclusions b -> Inclusions a)
-> Functor Inclusions
forall a b. a -> Inclusions b -> Inclusions a
forall a b. (a -> b) -> Inclusions a -> Inclusions b
forall (f :: * -> *).
(forall a b. (a -> b) -> f a -> f b)
-> (forall a b. a -> f b -> f a) -> Functor f
$cfmap :: forall a b. (a -> b) -> Inclusions a -> Inclusions b
fmap :: forall a b. (a -> b) -> Inclusions a -> Inclusions b
$c<$ :: forall a b. a -> Inclusions b -> Inclusions a
<$ :: forall a b. a -> Inclusions b -> Inclusions a
Functor, (forall x. Inclusions a -> Rep (Inclusions a) x)
-> (forall x. Rep (Inclusions a) x -> Inclusions a)
-> Generic (Inclusions a)
forall x. Rep (Inclusions a) x -> Inclusions a
forall x. Inclusions a -> Rep (Inclusions a) x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
forall a x. Rep (Inclusions a) x -> Inclusions a
forall a x. Inclusions a -> Rep (Inclusions a) x
$cfrom :: forall a x. Inclusions a -> Rep (Inclusions a) x
from :: forall x. Inclusions a -> Rep (Inclusions a) x
$cto :: forall a x. Rep (Inclusions a) x -> Inclusions a
to :: forall x. Rep (Inclusions a) x -> Inclusions a
Generic, [Inclusions a] -> Value
[Inclusions a] -> Encoding
Inclusions a -> Bool
Inclusions a -> Value
Inclusions a -> Encoding
(Inclusions a -> Value)
-> (Inclusions a -> Encoding)
-> ([Inclusions a] -> Value)
-> ([Inclusions a] -> Encoding)
-> (Inclusions a -> Bool)
-> ToJSON (Inclusions a)
forall a. ToJSON a => [Inclusions a] -> Value
forall a. ToJSON a => [Inclusions a] -> Encoding
forall a. ToJSON a => Inclusions a -> Bool
forall a. ToJSON a => Inclusions a -> Value
forall a. ToJSON a => Inclusions a -> Encoding
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: forall a. ToJSON a => Inclusions a -> Value
toJSON :: Inclusions a -> Value
$ctoEncoding :: forall a. ToJSON a => Inclusions a -> Encoding
toEncoding :: Inclusions a -> Encoding
$ctoJSONList :: forall a. ToJSON a => [Inclusions a] -> Value
toJSONList :: [Inclusions a] -> Value
$ctoEncodingList :: forall a. ToJSON a => [Inclusions a] -> Encoding
toEncodingList :: [Inclusions a] -> Encoding
$comitField :: forall a. ToJSON a => Inclusions a -> Bool
omitField :: Inclusions a -> Bool
ToJSON)

emptyExceptions :: Monoid a => Inclusions a
emptyExceptions :: forall a. Monoid a => Inclusions a
emptyExceptions = a -> Inclusions a
forall a. a -> Inclusions a
Blacklist a
forall a. Monoid a => a
mempty

type WalkabilityExceptions a = Inclusions (Set a)

instance (FromJSON a, Ord a) => FromJSON (WalkabilityExceptions a) where
  parseJSON :: Value -> Parser (WalkabilityExceptions a)
parseJSON = String
-> (Object -> Parser (WalkabilityExceptions a))
-> Value
-> Parser (WalkabilityExceptions a)
forall a. String -> (Object -> Parser a) -> Value -> Parser a
withObject String
"walkable" ((Object -> Parser (WalkabilityExceptions a))
 -> Value -> Parser (WalkabilityExceptions a))
-> (Object -> Parser (WalkabilityExceptions a))
-> Value
-> Parser (WalkabilityExceptions a)
forall a b. (a -> b) -> a -> b
$ \Object
v -> do
    [a]
whitelist <- Object
v Object -> Key -> Parser (Maybe [a])
forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
.:? Key
"only" Parser (Maybe [a]) -> [a] -> Parser [a]
forall a. Parser (Maybe a) -> a -> Parser a
.!= []
    [a]
blacklist <- Object
v Object -> Key -> Parser (Maybe [a])
forall a. FromJSON a => Object -> Key -> Parser (Maybe a)
.:? Key
"never" Parser (Maybe [a]) -> [a] -> Parser [a]
forall a. Parser (Maybe a) -> a -> Parser a
.!= []

    Bool -> Parser () -> Parser ()
forall (f :: * -> *). Applicative f => Bool -> f () -> f ()
unless ([a] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [a]
whitelist Bool -> Bool -> Bool
|| [a] -> Bool
forall a. [a] -> Bool
forall (t :: * -> *) a. Foldable t => t a -> Bool
null [a]
blacklist) (Parser () -> Parser ()) -> Parser () -> Parser ()
forall a b. (a -> b) -> a -> b
$
      String -> Parser ()
forall a. String -> Parser a
forall (m :: * -> *) a. MonadFail m => String -> m a
fail String
"Cannot specify both a whitelist and blacklist"

    let exceptionList :: Inclusions [a]
exceptionList =
          Inclusions [a]
-> (NonEmpty a -> Inclusions [a])
-> Maybe (NonEmpty a)
-> Inclusions [a]
forall b a. b -> (a -> b) -> Maybe a -> b
maybe
            ([a] -> Inclusions [a]
forall a. a -> Inclusions a
Blacklist [a]
blacklist) -- Note: empty blacklist is the typical case
            ([a] -> Inclusions [a]
forall a. a -> Inclusions a
Whitelist ([a] -> Inclusions [a])
-> (NonEmpty a -> [a]) -> NonEmpty a -> Inclusions [a]
forall b c a. (b -> c) -> (a -> b) -> a -> c
. NonEmpty a -> [a]
forall a. NonEmpty a -> [a]
NE.toList)
            ([a] -> Maybe (NonEmpty a)
forall a. [a] -> Maybe (NonEmpty a)
NE.nonEmpty [a]
whitelist)

    WalkabilityExceptions a -> Parser (WalkabilityExceptions a)
forall a. a -> Parser a
forall (m :: * -> *) a. Monad m => a -> m a
return (WalkabilityExceptions a -> Parser (WalkabilityExceptions a))
-> WalkabilityExceptions a -> Parser (WalkabilityExceptions a)
forall a b. (a -> b) -> a -> b
$ [a] -> Set a
forall a. Ord a => [a] -> Set a
S.fromList ([a] -> Set a) -> Inclusions [a] -> WalkabilityExceptions a
forall (f :: * -> *) a b. Functor f => (a -> b) -> f a -> f b
<$> Inclusions [a]
exceptionList

-- | Properties of a robot used to determine whether an entity is walkable
data WalkabilityContext
  = WalkabilityContext
      (Set Capability)
      -- | which entities are unwalkable by this robot
      (WalkabilityExceptions EntityName)
  deriving (Int -> WalkabilityContext -> ShowS
[WalkabilityContext] -> ShowS
WalkabilityContext -> String
(Int -> WalkabilityContext -> ShowS)
-> (WalkabilityContext -> String)
-> ([WalkabilityContext] -> ShowS)
-> Show WalkabilityContext
forall a.
(Int -> a -> ShowS) -> (a -> String) -> ([a] -> ShowS) -> Show a
$cshowsPrec :: Int -> WalkabilityContext -> ShowS
showsPrec :: Int -> WalkabilityContext -> ShowS
$cshow :: WalkabilityContext -> String
show :: WalkabilityContext -> String
$cshowList :: [WalkabilityContext] -> ShowS
showList :: [WalkabilityContext] -> ShowS
Show, WalkabilityContext -> WalkabilityContext -> Bool
(WalkabilityContext -> WalkabilityContext -> Bool)
-> (WalkabilityContext -> WalkabilityContext -> Bool)
-> Eq WalkabilityContext
forall a. (a -> a -> Bool) -> (a -> a -> Bool) -> Eq a
$c== :: WalkabilityContext -> WalkabilityContext -> Bool
== :: WalkabilityContext -> WalkabilityContext -> Bool
$c/= :: WalkabilityContext -> WalkabilityContext -> Bool
/= :: WalkabilityContext -> WalkabilityContext -> Bool
Eq, (forall x. WalkabilityContext -> Rep WalkabilityContext x)
-> (forall x. Rep WalkabilityContext x -> WalkabilityContext)
-> Generic WalkabilityContext
forall x. Rep WalkabilityContext x -> WalkabilityContext
forall x. WalkabilityContext -> Rep WalkabilityContext x
forall a.
(forall x. a -> Rep a x) -> (forall x. Rep a x -> a) -> Generic a
$cfrom :: forall x. WalkabilityContext -> Rep WalkabilityContext x
from :: forall x. WalkabilityContext -> Rep WalkabilityContext x
$cto :: forall x. Rep WalkabilityContext x -> WalkabilityContext
to :: forall x. Rep WalkabilityContext x -> WalkabilityContext
Generic, [WalkabilityContext] -> Value
[WalkabilityContext] -> Encoding
WalkabilityContext -> Bool
WalkabilityContext -> Value
WalkabilityContext -> Encoding
(WalkabilityContext -> Value)
-> (WalkabilityContext -> Encoding)
-> ([WalkabilityContext] -> Value)
-> ([WalkabilityContext] -> Encoding)
-> (WalkabilityContext -> Bool)
-> ToJSON WalkabilityContext
forall a.
(a -> Value)
-> (a -> Encoding)
-> ([a] -> Value)
-> ([a] -> Encoding)
-> (a -> Bool)
-> ToJSON a
$ctoJSON :: WalkabilityContext -> Value
toJSON :: WalkabilityContext -> Value
$ctoEncoding :: WalkabilityContext -> Encoding
toEncoding :: WalkabilityContext -> Encoding
$ctoJSONList :: [WalkabilityContext] -> Value
toJSONList :: [WalkabilityContext] -> Value
$ctoEncodingList :: [WalkabilityContext] -> Encoding
toEncodingList :: [WalkabilityContext] -> Encoding
$comitField :: WalkabilityContext -> Bool
omitField :: WalkabilityContext -> Bool
ToJSON)