Parameterize scenario datatypes #903
Conversation
| { cellTerrain :: TerrainType | ||
| , cellEntity :: Maybe Entity | ||
| , cellEntity :: Maybe e |
There was a problem hiding this comment.
So the idea is that instead of writing something like:
worldMapToText :: WorldPalette -> [[Cell]] -> Textwe would instead do it in two steps:
simplifyEntityForMe :: Entity -> SimplerEntity
simpleWorldMapToText :: WorldPalette (PCell SimplerEntity) -> Text
Is this because you want to have ToJSON (not ToJSONE) instance? 🤔
There was a problem hiding this comment.
@kostmo if this is about ToJSON we discussed with @byorgey, that you could simply use a custom tuple:
newtype Env e v = Env (e, v)
instance ToJSON (Env E Val) -- maybe we could codify this pattern as ToJSONE => ToJSON (Env, Val)which is the same as
simplify :: E -> Val -> SimpleVal
instance ToJSON SimpleValThere was a problem hiding this comment.
Is this because you want to have ToJSON (not ToJSONE) instance?
I haven't quite wrapped my head around how FromJSONE works (or how ToJSONE would).
For the purpose of the World Editor, we just need to emit a fragment of the scenario file (either to a file or via the web API ).
I'm not sure how easy it is to read in its current state, but here's what I'm trying to do in the World Editor PR.
There was a problem hiding this comment.
After reading through your PR, I think it makes sense to keep it simple. 👍
The idea with FromJSONE is that you need the environment to choose between parsing alternatives.
But with ToJSON no tricks are necessary, so I was incorrect in thinking that we would ever need it.
kostmo
force-pushed
the
world-editor-prep3
branch
from
beabffd to
be9a6ce
Compare
src/Swarm/Game/State.hs
Outdated
| @@ -144,6 +144,7 @@ import Swarm.Game.Recipe ( | |||
| reqRecipeMap, | |||
| ) | |||
| import Swarm.Game.Robot | |||
| import Swarm.Game.Scenario.WorldDescription | |||
There was a problem hiding this comment.
Why do we need this new import?
There was a problem hiding this comment.
Huh, I would have expected a compiler warning about an unused import. Anyway, I've removed it and it still works.
| @@ -52,7 +56,7 @@ instance FromJSONE (EntityMap, RobotMap) WorldDescription where | |||
| -- string into a nested list of 'Cell' values by looking up each | |||
| -- character in the palette, failing if any character in the raw map | |||
| -- is not contained in the palette. | |||
| paintMap :: MonadFail m => WorldPalette -> Text -> m [[Cell]] | |||
| paintMap :: MonadFail m => WorldPalette Cell -> Text -> m [[Cell]] | |||
There was a problem hiding this comment.
Can we make this polymorphic, WorldPalette c -> Text -> m [[c]] or something like that?
| newtype WorldPalette = WorldPalette | ||
| {unPalette :: KeyMap Cell} | ||
| newtype WorldPalette c = WorldPalette | ||
| {unPalette :: KeyMap c} |
There was a problem hiding this comment.
Would it be better to have newtype WorldPalette e = WorldPalette { unPalette :: KeyMap (PCell e) }? I am honestly not sure. Or maybe we should just double down on the generality and call it Palette instead of WorldPalette --- it maps characters to anything.
kostmo
force-pushed
the
world-editor-prep3
branch
from
be9a6ce to
ccdc763
Compare
Towards #873
Motivation
The
Entitydatatype has a fair amount of state and extra fields that are not relevant to serializing a scenario (in particular, a world map) to a file.In this PR, the
Cellrecord is renamed toPCell(representing "Parameterized Cell"), replacingEntitywith a type parameter. This permits the introduction of a trimmed-downEntitytype for the purpose of serialization. This lightweight type can also be a reliableMapkey.A type alias
Cellis created with the originalEntitytype as a parameter.The
WorldDescriptionandWorldPaletteare likewise parameterized on theCelltype.