Move World DSL to its module and re-export (#2567)

xsebek · web-flow · commit 37158092a585 · 2025-08-26T04:33:17.000Z
* move World DSL to `Swarm.Game.World.DSL` * re-export from `swarm-scenario/Swarm/Game/World/DSL.hs` * split off from #2555
diff --git a/src/swarm-doc/Swarm/Doc/Pedagogy.hs b/src/swarm-doc/Swarm/Doc/Pedagogy.hs
@@ -54,7 +54,7 @@ import Swarm.Game.ScenarioInfo (
   pathifyCollection,
   scenarioCollectionToList,
  )
-import Swarm.Game.World.Load (loadWorlds)
+import Swarm.Game.World.DSL (loadWorlds)
 import Swarm.Language.Syntax
 import Swarm.Language.Text.Markdown (docToText, findCode)
 import Swarm.Language.Types (Polytype)
diff --git a/src/swarm-engine/Swarm/Game/Scenario/Status.hs b/src/swarm-engine/Swarm/Game/Scenario/Status.hs
@@ -26,7 +26,7 @@ import Swarm.Game.Scenario.Scoring.CodeSize
 import Swarm.Game.Scenario.Scoring.ConcreteMetrics
 import Swarm.Game.Scenario.Scoring.GenericMetrics
 import Swarm.Game.Tick (TickNumber)
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.Util.Lens (makeLensesNoSigs)
 
 -- | These launch parameters are used in a number of ways:
diff --git a/src/swarm-engine/Swarm/Game/State/Initialize.hs b/src/swarm-engine/Swarm/Game/State/Initialize.hs
@@ -49,7 +49,7 @@ import Swarm.Game.State.Landscape (mkLandscape)
 import Swarm.Game.State.Runtime
 import Swarm.Game.State.Substate
 import Swarm.Game.Step.Util (adaptGameState)
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.Language.Capability (constCaps)
 import Swarm.Language.Syntax (allConst, erase)
 import Swarm.Language.Types
diff --git a/src/swarm-engine/Swarm/Game/State/Runtime.hs b/src/swarm-engine/Swarm/Game/State/Runtime.hs
@@ -38,7 +38,7 @@ import Swarm.Game.Land
 import Swarm.Game.Recipe (loadRecipes)
 import Swarm.Game.Scenario (GameStateInputs (..), ScenarioInputs (..))
 import Swarm.Game.State.Substate
-import Swarm.Game.World.Load (loadWorlds)
+import Swarm.Game.World.DSL (loadWorlds)
 import Swarm.Log
 import Swarm.ResourceLoading (initNameGenerator, readAppData)
 import Swarm.Util.Lens (makeLensesNoSigs)
diff --git a/src/swarm-engine/Swarm/Game/State/Substate.hs b/src/swarm-engine/Swarm/Game/State/Substate.hs
@@ -111,7 +111,7 @@ import Swarm.Game.Scenario.Topography.Structure.Recognition
 import Swarm.Game.Scenario.Topography.Structure.Recognition.Registry (emptyFoundStructures)
 import Swarm.Game.State.Config
 import Swarm.Game.Tick (TickNumber (..))
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.Language.Syntax (Const, Syntax)
 import Swarm.Language.Types (Polytype)
 import Swarm.Language.Value (Value)
diff --git a/src/swarm-scenario/Swarm/Game/Recipe/Graph.hs b/src/swarm-scenario/Swarm/Game/Recipe/Graph.hs
@@ -30,7 +30,7 @@ import Swarm.Game.Scenario.Topography.Cell (PCell (..))
 import Swarm.Game.Scenario.Topography.Grid
 import Swarm.Game.Scenario.Topography.Structure.Overlay (gridContent)
 import Swarm.Game.Scenario.Topography.WorldDescription
-import Swarm.Game.World.Gen (extractEntities)
+import Swarm.Game.World.DSL (extractEntities)
 import Swarm.Util (both)
 import Swarm.Util.Erasable (erasableToMaybe)
 
diff --git a/src/swarm-scenario/Swarm/Game/Scenario.hs b/src/swarm-scenario/Swarm/Game/Scenario.hs
@@ -99,9 +99,7 @@ import Swarm.Game.Scenario.Topography.Structure.Recognition.Type
 import Swarm.Game.Scenario.Topography.WorldDescription
 import Swarm.Game.Terrain
 import Swarm.Game.Universe
-import Swarm.Game.World.Gen (Seed)
-import Swarm.Game.World.Load (loadWorlds)
-import Swarm.Game.World.Typecheck (WorldMap)
+import Swarm.Game.World.DSL (Seed, WorldMap, loadWorlds)
 import Swarm.Language.Syntax (Syntax, TSyntax)
 import Swarm.Language.Text.Markdown (Document)
 import Swarm.Pretty (prettyText)
diff --git a/src/swarm-scenario/Swarm/Game/Scenario/Topography/WorldDescription.hs b/src/swarm-scenario/Swarm/Game/Scenario/Topography/WorldDescription.hs
@@ -45,9 +45,7 @@ import Swarm.Game.Scenario.Topography.Structure.Recognition.Static (LocatedStruc
 import Swarm.Game.Scenario.Topography.WorldPalette
 import Swarm.Game.Terrain (TerrainType (..))
 import Swarm.Game.Universe (SubworldName (DefaultRootSubworld))
-import Swarm.Game.World.Parse ()
-import Swarm.Game.World.Syntax
-import Swarm.Game.World.Typecheck
+import Swarm.Game.World.DSL
 import Swarm.Language.Syntax (Syntax)
 import Swarm.Language.Text.Markdown (Document, fromText)
 import Swarm.Pretty (prettyString)
diff --git a/src/swarm-scenario/Swarm/Game/State/Landscape.hs b/src/swarm-scenario/Swarm/Game/State/Landscape.hs
@@ -53,8 +53,7 @@ import Swarm.Game.Terrain (TerrainType (..), terrainIndexByName)
 import Swarm.Game.Universe as U
 import Swarm.Game.World
 import Swarm.Game.World.Coords
-import Swarm.Game.World.Eval (runWorld)
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World.DSL (runWorld)
 import Swarm.Util.Erasable
 import Swarm.Util.Lens (makeLensesNoSigs)
 
diff --git a/src/swarm-scenario/Swarm/Game/World.hs b/src/swarm-scenario/Swarm/Game/World.hs
@@ -43,6 +43,9 @@ module Swarm.Game.World (
 
   -- ** Runtime updates
   WorldUpdate (..),
+
+  -- * Re-export
+  Seed,
 ) where
 
 import Control.Algebra (Has)
@@ -69,6 +72,7 @@ import Swarm.Game.Scenario.Topography.Modify
 import Swarm.Game.Terrain (TerrainMap, TerrainType (BlankT), terrainByIndex, terrainName)
 import Swarm.Game.Universe
 import Swarm.Game.World.Coords
+import Swarm.Game.World.DSL.Gen (Seed)
 import Swarm.Util ((?))
 import Swarm.Util.Erasable
 import Prelude hiding (Foldable (..), lookup)
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL.hs b/src/swarm-scenario/Swarm/Game/World/DSL.hs
@@ -0,0 +1,50 @@
+{-# LANGUAGE PatternSynonyms #-}
+
+-- |
+-- SPDX-License-Identifier: BSD-3-Clause
+-- Description: Grid on which the game takes place
+--
+-- DSL for programming worlds.
+module Swarm.Game.World.DSL (
+  -- ** Syntax
+  World,
+  Seed,
+  CellVal,
+  TTerm (..),
+
+  -- ** Typechecking
+  check,
+  WorldMap,
+  CheckErr (..),
+  Ctx (..),
+  TTy (..),
+  pattern TTyBool,
+  pattern TTyInt,
+  pattern TTyFloat,
+  pattern TTyCell,
+
+  -- ** World function conversion
+  runWorld,
+  extractEntities,
+
+  -- ** Loading files
+  loadWorld,
+  loadWorlds,
+) where
+
+import Swarm.Game.World.DSL.Eval (runWorld)
+import Swarm.Game.World.DSL.Gen (Seed, extractEntities)
+import Swarm.Game.World.DSL.Load (loadWorld, loadWorlds)
+import Swarm.Game.World.DSL.Syntax (CellVal, World)
+import Swarm.Game.World.DSL.Typecheck (
+  CheckErr (..),
+  Ctx (..),
+  TTerm (..),
+  TTy (..),
+  WorldMap,
+  check,
+  pattern TTyBool,
+  pattern TTyCell,
+  pattern TTyFloat,
+  pattern TTyInt,
+ )
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Abstract.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Abstract.hs
@@ -13,10 +13,10 @@
 -- For more information, see:
 --
 --   https://byorgey.wordpress.com/2023/07/13/compiling-to-intrinsically-typed-combinators/
-module Swarm.Game.World.Abstract where
+module Swarm.Game.World.DSL.Abstract where
 
 import Data.Kind (Type)
-import Swarm.Game.World.Typecheck (Applicable (..), Const (..), HasConst (..), Idx (..), TTerm (..), ($$.), (.$$), (.$$.))
+import Swarm.Game.World.DSL.Typecheck (Applicable (..), Const (..), HasConst (..), Idx (..), TTerm (..), ($$.), (.$$), (.$$.))
 
 ------------------------------------------------------------
 -- Bracket abstraction
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Compile.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Compile.hs
@@ -15,19 +15,19 @@
 -- For more info, see:
 --
 --   https://byorgey.wordpress.com/2023/07/13/compiling-to-intrinsically-typed-combinators/
-module Swarm.Game.World.Compile where
+module Swarm.Game.World.DSL.Compile where
 
 import Data.ByteString (ByteString)
 import Data.Hash.Murmur (murmur3)
 import Data.Kind (Constraint)
 import Data.Tagged (Tagged (unTagged))
 import Numeric.Noise.Perlin (noiseValue, perlin)
 import Swarm.Game.Location (pattern Location)
-import Swarm.Game.World.Abstract (BTerm (..))
 import Swarm.Game.World.Coords (Coords (..), coordsToLoc, locToCoords)
-import Swarm.Game.World.Gen (Seed)
-import Swarm.Game.World.Syntax (Axis (..), World)
-import Swarm.Game.World.Typecheck (Applicable (..), Const (..), Empty (..), NotFun, Over (..))
+import Swarm.Game.World.DSL.Abstract (BTerm (..))
+import Swarm.Game.World.DSL.Gen (Seed)
+import Swarm.Game.World.DSL.Syntax (Axis (..), World)
+import Swarm.Game.World.DSL.Typecheck (Applicable (..), Const (..), Empty (..), NotFun, Over (..))
 import Witch (from)
 import Witch.Encoding qualified as Encoding
 
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Eval.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Eval.hs
@@ -4,19 +4,19 @@
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Evaluation for the Swarm world description DSL.
-module Swarm.Game.World.Eval (
+module Swarm.Game.World.DSL.Eval (
   runWorld,
 ) where
 
 import Swarm.Game.Entity (Entity)
 import Swarm.Game.Terrain (TerrainType (..))
 import Swarm.Game.World (WorldFun (..))
-import Swarm.Game.World.Abstract (bracket)
 import Swarm.Game.World.Coords (Coords)
-import Swarm.Game.World.Gen (Seed)
-import Swarm.Game.World.Interpret (interpBTerm)
-import Swarm.Game.World.Syntax
-import Swarm.Game.World.Typecheck
+import Swarm.Game.World.DSL.Abstract (bracket)
+import Swarm.Game.World.DSL.Gen (Seed)
+import Swarm.Game.World.DSL.Interpret (interpBTerm)
+import Swarm.Game.World.DSL.Syntax
+import Swarm.Game.World.DSL.Typecheck
 
 -- | Run a typechecked world description DSL term to produce a
 --   'WorldFun'.
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Gen.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Gen.hs
@@ -4,13 +4,13 @@
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Utilities for working with procedurally generated worlds.
-module Swarm.Game.World.Gen where
+module Swarm.Game.World.DSL.Gen where
 
 import Data.Semigroup (Last (..))
 import Data.Set qualified as S
 import Swarm.Game.Entity
-import Swarm.Game.World.Syntax (CellVal (..))
-import Swarm.Game.World.Typecheck (Const (CCell), TTerm (..))
+import Swarm.Game.World.DSL.Syntax (CellVal (..))
+import Swarm.Game.World.DSL.Typecheck (Const (CCell), TTerm (..))
 import Swarm.Util.Erasable
 
 type Seed = Int
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Interpret.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Interpret.hs
@@ -6,7 +6,7 @@
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Interpreter for the Swarm world description DSL.
-module Swarm.Game.World.Interpret (
+module Swarm.Game.World.DSL.Interpret (
   interpBTerm,
   interpConst,
 ) where
@@ -16,11 +16,11 @@ import Data.Hash.Murmur (murmur3)
 import Data.Tagged (unTagged)
 import Numeric.Noise.Perlin (noiseValue, perlin)
 import Swarm.Game.Location (pattern Location)
-import Swarm.Game.World.Abstract (BTerm (..))
 import Swarm.Game.World.Coords (Coords (..), coordsToLoc, locToCoords)
-import Swarm.Game.World.Gen (Seed)
-import Swarm.Game.World.Syntax (Axis (..))
-import Swarm.Game.World.Typecheck (Const (..), Empty (..), Over (..))
+import Swarm.Game.World.DSL.Abstract (BTerm (..))
+import Swarm.Game.World.DSL.Gen (Seed)
+import Swarm.Game.World.DSL.Syntax (Axis (..))
+import Swarm.Game.World.DSL.Typecheck (Const (..), Empty (..), Over (..))
 import Witch (from)
 import Witch.Encoding qualified as Encoding
 
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Load.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Load.hs
@@ -4,7 +4,7 @@
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Loading world descriptions from `worlds/*.world`.
-module Swarm.Game.World.Load where
+module Swarm.Game.World.DSL.Load where
 
 import Control.Algebra (Has)
 import Control.Arrow (left)
@@ -15,8 +15,8 @@ import Data.Map qualified as M
 import Data.Text (Text)
 import Swarm.Failure (Asset (..), AssetData (..), LoadingFailure (..), SystemFailure (..))
 import Swarm.Game.Land
-import Swarm.Game.World.Parse (parseWExp, runParser)
-import Swarm.Game.World.Typecheck
+import Swarm.Game.World.DSL.Parse (parseWExp, runParser)
+import Swarm.Game.World.DSL.Typecheck
 import Swarm.Pretty (prettyText)
 import Swarm.ResourceLoading (getDataDirSafe)
 import Swarm.Util (acquireAllWithExt)
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Parse.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Parse.hs
@@ -8,7 +8,7 @@
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Parser for the Swarm world description DSL.
-module Swarm.Game.World.Parse where
+module Swarm.Game.World.DSL.Parse where
 
 import Control.Monad (void)
 import Control.Monad.Combinators.Expr (Operator (..), makeExprParser)
@@ -18,7 +18,7 @@ import Data.Text (Text)
 import Data.Text qualified as T
 import Data.Void (Void)
 import Data.Yaml (FromJSON (parseJSON), withText)
-import Swarm.Game.World.Syntax
+import Swarm.Game.World.DSL.Syntax
 import Swarm.Language.Parser.Util (fully)
 import Swarm.Util (failT, showT, squote)
 import Text.Megaparsec hiding (runParser)
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Syntax.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Syntax.hs
@@ -4,7 +4,7 @@
 -- SPDX-License-Identifier: BSD-3-Clause
 --
 -- Abstract syntax for the Swarm world description DSL.
-module Swarm.Game.World.Syntax (
+module Swarm.Game.World.DSL.Syntax (
   -- | Various component types
   World,
   RawCellVal,
diff --git a/src/swarm-scenario/Swarm/Game/World/DSL/Typecheck.hs b/src/swarm-scenario/Swarm/Game/World/DSL/Typecheck.hs
@@ -18,7 +18,7 @@
 -- information, see:
 --
 --   https://byorgey.wordpress.com/2023/07/13/compiling-to-intrinsically-typed-combinators/
-module Swarm.Game.World.Typecheck where
+module Swarm.Game.World.DSL.Typecheck where
 
 import Control.Algebra (Has)
 import Control.Effect.Reader (Reader, ask)
@@ -38,7 +38,7 @@ import Prettyprinter
 import Swarm.Game.Entity (lookupEntityName)
 import Swarm.Game.Land
 import Swarm.Game.Terrain
-import Swarm.Game.World.Syntax
+import Swarm.Game.World.DSL.Syntax
 import Swarm.Pretty (PrettyPrec (..), pparens, ppr)
 import Swarm.Util (showT)
 import Swarm.Util.Erasable
diff --git a/src/swarm-scenario/Swarm/Game/World/Render.hs b/src/swarm-scenario/Swarm/Game/World/Render.hs
@@ -47,7 +47,7 @@ import Swarm.Game.Scenario.Topography.WorldDescription
 import Swarm.Game.State.Landscape
 import Swarm.Game.Universe
 import Swarm.Game.World.Coords
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World.DSL.Gen (Seed)
 import Swarm.Pretty (prettyText)
 import Swarm.Util (failT)
 import Swarm.Util.Content
diff --git a/src/swarm-tournament/Swarm/Web/Tournament/Type.hs b/src/swarm-tournament/Swarm/Web/Tournament/Type.hs
@@ -20,7 +20,7 @@ import Servant.Docs qualified as SD
 import Swarm.Game.Scenario.Scoring.CodeSize
 import Swarm.Game.State (Sha1 (..))
 import Swarm.Game.Tick (TickNumber (..))
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import System.Time.Extra
 
 newtype UserAlias = UserAlias TL.Text
diff --git a/src/swarm-tui/Swarm/TUI/Launch/Prep.hs b/src/swarm-tui/Swarm/TUI/Launch/Prep.hs
@@ -22,7 +22,7 @@ import Data.Text qualified as T
 import Swarm.Failure (SystemFailure)
 import Swarm.Game.Scenario.Status (ParameterizableLaunchParams (..), ScenarioInfo, ScenarioWith (..), getLaunchParams, scenarioStatus)
 import Swarm.Game.State (ValidatedLaunchParams, getRunCodePath, parseCodeFile)
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.Pretty (prettyText)
 import Swarm.TUI.Launch.Model
 import Swarm.TUI.Model.Name
diff --git a/src/swarm-tui/Swarm/TUI/Model.hs b/src/swarm-tui/Swarm/TUI/Model.hs
@@ -123,7 +123,7 @@ import Swarm.Game.State
 import Swarm.Game.State.Runtime
 import Swarm.Game.State.Substate
 import Swarm.Game.Tick (TickNumber (..))
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.Log
 import Swarm.TUI.Inventory.Sorting
 import Swarm.TUI.Model.DebugOption (DebugOption)
diff --git a/src/swarm-tui/Swarm/TUI/Model/Menu.hs b/src/swarm-tui/Swarm/TUI/Model/Menu.hs
@@ -28,7 +28,7 @@ import Swarm.Game.ScenarioInfo (
   ScenarioWith,
   scenarioCollectionToList,
  )
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.TUI.Model.Name
 
 ------------------------------------------------------------
diff --git a/src/swarm-tui/Swarm/TUI/Model/StateUpdate.hs b/src/swarm-tui/Swarm/TUI/Model/StateUpdate.hs
@@ -84,7 +84,7 @@ import Swarm.Game.State.Landscape
 import Swarm.Game.State.Runtime
 import Swarm.Game.State.Substate
 import Swarm.Game.Tick (TickNumber (TickNumber))
-import Swarm.Game.World.Gen (Seed)
+import Swarm.Game.World (Seed)
 import Swarm.Log (LogSource (SystemLog), Severity (..))
 import Swarm.Pretty (prettyText)
 import Swarm.ResourceLoading (getSwarmHistoryPath)
diff --git a/src/swarm-tui/Swarm/TUI/View.hs b/src/swarm-tui/Swarm/TUI/View.hs
@@ -112,8 +112,8 @@ import Swarm.Game.State.Runtime
 import Swarm.Game.State.Substate
 import Swarm.Game.Tick (TickNumber (..), formatTicks)
 import Swarm.Game.Universe
+import Swarm.Game.World (Seed)
 import Swarm.Game.World.Coords
-import Swarm.Game.World.Gen (Seed)
 import Swarm.Language.Capability (Capability (..), constCaps)
 import Swarm.Language.Syntax
 import Swarm.Language.Typecheck (inferConst)
diff --git a/swarm.cabal b/swarm.cabal
diff --git a/weeder.toml b/weeder.toml

Original file line number	Diff line number	Diff line change
`@@ -54,7 +54,7 @@ import Swarm.Game.ScenarioInfo (`
`54`	`54`	`pathifyCollection,`
`55`	`55`	`scenarioCollectionToList,`
`56`	`56`	`)`
`57`		`-import Swarm.Game.World.Load (loadWorlds)`
	`57`	`+import Swarm.Game.World.DSL (loadWorlds)`
`58`	`58`	`import Swarm.Language.Syntax`
`59`	`59`	`import Swarm.Language.Text.Markdown (docToText, findCode)`
`60`	`60`	`import Swarm.Language.Types (Polytype)`