Revert "Revert "Preparatory refactoring towards pluggable games; separates out into 'scalatron.core' a set of classes shared by game implementations and Scalatron API""

scalatron · scalatron · commit 8a16de798e2d · 2012-05-21T10:56:59.000+02:00
This reverts commit 76b7d33.
diff --git a/Scalatron/doc/markdown/Scalatron Pluggable Games.md b/Scalatron/doc/markdown/Scalatron Pluggable Games.md
@@ -0,0 +1,27 @@
+---
+layout: default
+title: Scalatron Pluggable Games
+subtitle: Draft Architecture Documentation
+---
+
+WARNING: this is a draft documenting a work-in-progress!
+
+# Summary
+
+The goal of this project is to move the implementation of the BotWar game implementation into a plug-in and to turn
+Scalatron into a framework and server for hosting a variety of such pluggable games.
+
+
+# Decisions
+
+The primary decisions concern the level of abstraction: what should the framework require all pluggable games to
+have in common?
+
+
+# TODO
+
+
+
+
+
+
diff --git a/Scalatron/src/scalatron/botwar/AugmentedDynamics.scala b/Scalatron/src/scalatron/botwar/AugmentedDynamics.scala
@@ -5,7 +5,7 @@ package scalatron.botwar
 
 import scala.util.Random
 import scalatron.botwar.Decoration.{Bonus, Explosion, Text, Bonk, Annihilation}
-import scalatron.scalatron.impl.TournamentRoundResult
+import scalatron.core.TournamentRoundResult
 
 
 case object AugmentedDynamics extends ((State,Random,Iterable[(Entity.Id,Iterable[Command])]) => Either[State,TournamentRoundResult])
diff --git a/Scalatron/src/scalatron/botwar/Board.scala b/Scalatron/src/scalatron/botwar/Board.scala
@@ -5,12 +5,11 @@ package scalatron.botwar
 
 import State.Time
 import scala.util.Random
-import scalatron.scalatron.impl.Plugin
 import BoardParams.Perimeter
 import akka.dispatch.{Await, Future, ExecutionContext}
-import akka.util.Duration
 import akka.util.duration._
 import java.util.concurrent.TimeoutException
+import scalatron.core.Plugin
 
 
 /** Contains the temporally variable aspects of the game state.
@@ -180,17 +179,12 @@ object Board
                 val controlFunction = plugin.controlFunctionFactory.apply()
 
                 // invoke Welcome()
-                plugin match {
-                    case external: Plugin.External =>
-                        controlFunction(
-                            Protocol.ServerOpcode.Welcome + "(" +
-                                "name=" + external.name + "," +
-                                "path=" + external.dirPath + "," +
-                                "apocalypse=" + stepsPerRound + "," +
-                                "round=" + roundIndex +
-                                ")")
-                    case internal: Plugin.Internal => // OK
-                }
+                controlFunction(
+                    Protocol.ServerOpcode.Welcome + "(" +
+                        "name=" + plugin.name + "," +
+                        "apocalypse=" + stepsPerRound + "," +
+                        "round=" + roundIndex +
+                        ")")
 
                 Some((plugin, controlFunction))
             } catch {
diff --git a/Scalatron/src/scalatron/botwar/BotWar.scala b/Scalatron/src/scalatron/botwar/BotWar.scala
@@ -6,10 +6,9 @@ package scalatron.botwar
 import renderer.Renderer
 import scalatron.botwar.BotWarSimulation.SimState
 import java.awt.event.{WindowEvent, WindowAdapter, KeyEvent, KeyListener}
-import scalatron.scalatron.api.Scalatron
-import scalatron.scalatron.impl.{TournamentRoundResult, TournamentState, Plugin, PluginCollection, Game}
 import akka.dispatch.ExecutionContext
 import akka.actor.ActorSystem
+import scalatron.core._
 
 
 /** BotWar: an implementation of the Scalatron Game trait.
@@ -18,12 +17,7 @@ case object BotWar extends Game
 {
     val name = Constants.GameName
 
-    val pluginLoadSpec =
-        PluginCollection.LoadSpec(
-            Scalatron.Constants.JarFilename,          // "ScalatronBot.jar"
-            "scalatron.botwar.botPlugin",
-            "ControlFunctionFactory")
-
+    def gameSpecificPackagePath = "scalatron.botwar.botPlugin"
 
     def runVisually(
         pluginPath: String,
@@ -95,7 +89,7 @@ case object BotWar extends Game
         }
 
 
-        var pluginCollection = PluginCollection(pluginPath, pluginLoadSpec, verbose)
+        var pluginCollection = PluginCollection(pluginPath, gameSpecificPackagePath, verbose)
 
         // now perform game runs ad infinitum
         var roundIndex = 0
@@ -166,7 +160,7 @@ case object BotWar extends Game
             tournamentState.addResult(tournamentRoundResult)
         }
 
-        var pluginCollection = PluginCollection(pluginPath, pluginLoadSpec, verbose)
+        var pluginCollection = PluginCollection(pluginPath, gameSpecificPackagePath, verbose)
 
         // now perform game runs ad infinitum
         var roundIndex = 0
@@ -208,7 +202,7 @@ case object BotWar extends Game
       * @return the initial simulation state
       */
     def startHeadless(
-        plugins: Iterable[Plugin.External],
+        plugins: Iterable[Plugin.FromJarFile],
         secureMode: Boolean,
         argMap: Map[String,String]
     )(
@@ -240,7 +234,7 @@ case object BotWar extends Game
       * @return the initial simulation state
       */
     def startHeadless(
-        plugins: Iterable[Plugin.External],
+        plugins: Iterable[Plugin.FromJarFile],
         permanentConfig: PermanentConfig,
         gameConfig: Config
     )(
diff --git a/Scalatron/src/scalatron/botwar/BotWarSimulation.scala b/Scalatron/src/scalatron/botwar/BotWarSimulation.scala
@@ -4,7 +4,7 @@
 package scalatron.botwar
 
 import scala.util.Random
-import scalatron.scalatron.impl.{Plugin, TournamentRoundResult}
+import scalatron.core.{Plugin, TournamentRoundResult}
 import akka.dispatch.ExecutionContext
 import akka.actor.ActorSystem
 
@@ -27,7 +27,7 @@ object BotWarSimulation
 
 
     case class Factory(config: Config) extends Simulation.Factory[SimState,TournamentRoundResult] {
-        def createInitialState(randomSeed: Int, plugins: Iterable[Plugin.External])(executionContextForUntrustedCode: ExecutionContext) = {
+        def createInitialState(randomSeed: Int, plugins: Iterable[Plugin.FromJarFile])(executionContextForUntrustedCode: ExecutionContext) = {
             val state = State.createInitial(config, randomSeed, plugins)(executionContextForUntrustedCode)
             SimState(state)
         }
diff --git a/Scalatron/src/scalatron/botwar/Config.scala b/Scalatron/src/scalatron/botwar/Config.scala
@@ -3,7 +3,7 @@
   */
 package scalatron.botwar
 
-import scalatron.scalatron.impl.Plugin
+import scalatron.core.{PermanentConfig, Plugin}
 
 
 /** Configuration container for a specific game rounds. Incorporates the permanent configuration
@@ -17,7 +17,7 @@ case class Config(
 
 
 object Config {
-    def create(permanentConfig: PermanentConfig, roundIndex: Int, plugins: Iterable[Plugin.External], argMap: Map[String,String]) = {
+    def create(permanentConfig: PermanentConfig, roundIndex: Int, plugins: Iterable[Plugin.FromJarFile], argMap: Map[String,String]) = {
         val pluginCount = plugins.size
 
         // compute the default arena size
diff --git a/Scalatron/src/scalatron/botwar/Dynamics.scala b/Scalatron/src/scalatron/botwar/Dynamics.scala
@@ -4,12 +4,12 @@
 package scalatron.botwar
 
 import scala.util.Random
-import scalatron.scalatron.impl.TournamentRoundResult
 import akka.util.duration._
 import akka.dispatch._
 import java.util.concurrent.TimeoutException
 import akka.actor.ActorSystem
 import akka.util.Duration
+import scalatron.core.TournamentRoundResult
 
 
 /** Game dynamics. Function that, when applied to a game state, returns either a successor
diff --git a/Scalatron/src/scalatron/botwar/Entity.scala b/Scalatron/src/scalatron/botwar/Entity.scala
@@ -6,7 +6,7 @@ package scalatron.botwar
 import State.Time
 import util.Random
 import java.lang.IllegalStateException
-import scalatron.scalatron.impl.Plugin
+import scalatron.core.Plugin
 
 
 /** A game entity. An entity can be a collidable Bot (player, slave, beast, plant, wall) or
diff --git a/Scalatron/src/scalatron/botwar/Simulation.scala b/Scalatron/src/scalatron/botwar/Simulation.scala
@@ -3,10 +3,10 @@
   */
 package scalatron.botwar
 
-import scalatron.scalatron.impl.Plugin
 import akka.util.Duration
 import akka.dispatch.{ExecutionContext, Future, Await}
 import akka.actor.ActorSystem
+import scalatron.core.Plugin
 
 
 /** Traits for generic simulations, of which a game like BotWar is an example.
@@ -32,7 +32,7 @@ object Simulation
       * @tparam R type of the result returned by the simulator (arbitrary)
       */
     trait Factory[S <: State[S, R], R] {
-        def createInitialState(randomSeed: Int, plugins: Iterable[Plugin.External])(executionContextForUntrustedCode: ExecutionContext) : S
+        def createInitialState(randomSeed: Int, plugins: Iterable[Plugin.FromJarFile])(executionContextForUntrustedCode: ExecutionContext) : S
     }
 
     /** Simulation.Runner: a generic runner for simulations that uses .step() to iteratively
@@ -52,7 +52,7 @@ object Simulation
           * @return an optional simulation result (if the simulation was not prematurely aborted)
           */
         def apply(
-            plugins: Iterable[Plugin.External],
+            plugins: Iterable[Plugin.FromJarFile],
             randomSeed: Int
         )(
             actorSystem: ActorSystem,
diff --git a/Scalatron/src/scalatron/botwar/State.scala b/Scalatron/src/scalatron/botwar/State.scala
@@ -4,8 +4,8 @@
 package scalatron.botwar
 
 import State.Time
-import scalatron.scalatron.impl.Plugin
 import akka.dispatch.ExecutionContext
+import scalatron.core.Plugin
 
 
 /** Game state storing the current (game) time, the board parameters, the actual board (i.e.
diff --git a/Scalatron/src/scalatron/botwar/renderer/GameStateRenderer.scala b/Scalatron/src/scalatron/botwar/renderer/GameStateRenderer.scala
@@ -8,7 +8,6 @@ import java.awt.Color
 
 import RenderUtil.makeTransparent
 import scalatron.botwar._
-import scalatron.scalatron.impl.TournamentState
 
 object GameStateRenderer {
     def drawGameState(state: State, drawBotHorizon: Boolean)(implicit ctx: RenderContext) {
diff --git a/Scalatron/src/scalatron/botwar/renderer/LeaderboardPanelRenderer.scala b/Scalatron/src/scalatron/botwar/renderer/LeaderboardPanelRenderer.scala
@@ -6,7 +6,7 @@ package scalatron.botwar.renderer
 
 
 import java.awt.{Font, Color}
-import scalatron.scalatron.impl.TournamentState
+import scalatron.core.TournamentState
 
 
 object LeaderboardPanelRenderer
diff --git a/Scalatron/src/scalatron/botwar/renderer/RenderStage.scala b/Scalatron/src/scalatron/botwar/renderer/RenderStage.scala
@@ -1,8 +1,8 @@
 package scalatron.botwar.renderer
 
-import scalatron.scalatron.impl.TournamentState
-import scalatron.botwar.{PermanentConfig, State}
-import java.awt.{Font, Color, Graphics2D}
+import scalatron.botwar.State
+import java.awt.{Color, Graphics2D}
+import scalatron.core.{PermanentConfig, TournamentState}
 
 
 case class RenderSourceAndTarget(
diff --git a/Scalatron/src/scalatron/botwar/renderer/Renderer.scala b/Scalatron/src/scalatron/botwar/renderer/Renderer.scala
@@ -5,11 +5,11 @@ package scalatron.botwar.renderer
 
 import scalatron.botwar.Display.RenderTarget
 
-import scalatron.scalatron.impl.TournamentState
 import scalatron.botwar._
 import akka.util.Duration
 import java.awt.Color
 import akka.dispatch.{ExecutionContext, Await, Future}
+import scalatron.core.{PermanentConfig, TournamentState}
 
 
 object Renderer {
diff --git a/Scalatron/src/scalatron/botwar/renderer/StatsPanelRenderer.scala b/Scalatron/src/scalatron/botwar/renderer/StatsPanelRenderer.scala
@@ -4,8 +4,8 @@
 package scalatron.botwar.renderer
 
 import java.awt.{Font, Color}
-import scalatron.scalatron.impl.TournamentState
-import scalatron.botwar.{PermanentConfig, State}
+import scalatron.botwar.State
+import scalatron.core.{PermanentConfig, TournamentState}
 
 
 object StatsPanelRenderer
diff --git a/Scalatron/src/scalatron/core/Game.scala b/Scalatron/src/scalatron/core/Game.scala
@@ -1,19 +1,23 @@
-package scalatron.scalatron.impl
+/** This material is intended as a community resource and is licensed under the
+  * Creative Commons Attribution 3.0 Unported License. Feel free to use, modify and share it.
+  */
+
+package scalatron.core
 
 import akka.dispatch.ExecutionContext
 import akka.actor.ActorSystem
-import scalatron.botwar.{Config, PermanentConfig}
+import scalatron.botwar.Config
 import scalatron.botwar.BotWarSimulation.SimState
 
-/** This material is intended as a community resource and is licensed under the
-  * Creative Commons Attribution 3.0 Unported License. Feel free to use, modify and share it.
-  */
 /** Base trait for game implementations that run within a Scalatron server (e.g. BotWar). */
-trait Game {
-    def name: String // e.g. "BotWar"
+trait Game
+{
+    /** @return the name of this game; TODO: like player names, should be derived from plug-in name, e.g. "BotWar" */
+    def name: String
 
-    /** The parameters of this game that are relevant for loading plug-ins (e.g. game name). */
-    def pluginLoadSpec: PluginCollection.LoadSpec
+    /** @return the package path to be used for constructing fully qualified class names for bot plug-ins,
+      *         e.g. "scalatron.botwar.botPlugin" */
+    def gameSpecificPackagePath: String
 
     /** Dump the game-specific command line configuration options via println. */
     def printArgList()
@@ -67,11 +71,11 @@ trait Game {
 
 
     def startHeadless(
-        plugins: Iterable[Plugin.External],
+        plugins: Iterable[Plugin.FromJarFile],
         permanentConfig: PermanentConfig,
         gameConfig: Config
     )(
         executionContextForUntrustedCode: ExecutionContext
-    ) : SimState
+    ): SimState
 
 }
diff --git a/Scalatron/src/scalatron/core/PermanentConfig.scala b/Scalatron/src/scalatron/core/PermanentConfig.scala
@@ -1,8 +1,7 @@
 /** This material is intended as a community resource and is licensed under the
   * Creative Commons Attribution 3.0 Unported License. Feel free to use, modify and share it.
   */
-package scalatron.botwar
-
+package scalatron.core
 
 /** Configuration settings that won't change round-to-round
   * @param secureMode if true, certain bot processing restrictions apply
@@ -11,8 +10,9 @@ package scalatron.botwar
 case class PermanentConfig(secureMode: Boolean, stepsPerRound: Int)
 
 
-object PermanentConfig {
-    def fromArgMap(secureMode: Boolean, argMap: Map[String,String]) = {
+object PermanentConfig
+{
+    def fromArgMap(secureMode: Boolean, argMap: Map[String, String]) = {
         val steps = argMap.get("-steps").map(_.toInt).getOrElse(5000)
         PermanentConfig(secureMode = secureMode, stepsPerRound = steps)
     }
diff --git a/Scalatron/src/scalatron/core/Plugin.scala b/Scalatron/src/scalatron/core/Plugin.scala
diff --git a/Scalatron/src/scalatron/core/PluginCollection.scala b/Scalatron/src/scalatron/core/PluginCollection.scala
diff --git a/Scalatron/src/scalatron/core/TournamentRoundResult.scala b/Scalatron/src/scalatron/core/TournamentRoundResult.scala
diff --git a/Scalatron/src/scalatron/core/TournamentState.scala b/Scalatron/src/scalatron/core/TournamentState.scala
diff --git a/Scalatron/src/scalatron/scalatron/api/Scalatron.scala b/Scalatron/src/scalatron/scalatron/api/Scalatron.scala
diff --git a/Scalatron/src/scalatron/scalatron/impl/ScalatronImpl.scala b/Scalatron/src/scalatron/scalatron/impl/ScalatronImpl.scala
diff --git a/Scalatron/src/scalatron/scalatron/impl/ScalatronUser.scala b/Scalatron/src/scalatron/scalatron/impl/ScalatronUser.scala
