Modularize the engine (more or less)

Author: kitskub

src/main/java/com/flowpowered/api/Client.java

@@ -29,7 +29,7 @@
 /**
  * Represents the client-specific component of the Flow platform.
  */
-public interface Client extends Engine {
+public interface Client extends EnginePart {
 
     /**
      * Gets the renderer that the client is using.

src/main/java/com/flowpowered/api/Engine.java

@@ -23,51 +23,45 @@
  */
 package com.flowpowered.api;
 
+import javax.annotation.Nullable;
+
 import org.apache.logging.log4j.Logger;
 
-import com.flowpowered.commons.Named;
-import com.flowpowered.events.EventManager;
-import com.flowpowered.filesystem.FileSystem;
 import com.flowpowered.api.geo.WorldManager;
+import com.flowpowered.api.plugins.FlowContext;
 import com.flowpowered.api.scheduler.Scheduler;
+import com.flowpowered.events.EventManager;
+import com.flowpowered.filesystem.FileSystem;
 import com.flowpowered.plugins.PluginManager;
 
 /**
  * Represents the core of an implementation of an engine (powers a game).
  */
-public interface Engine extends Named {
+public interface Engine {
 
     /**
      * Gets the version.
      *
      * @return build version
      */
     String getVersion();
-
-    Platform getPlatform();
 
     Logger getLogger();
 
-    /**
-     * Ends this engine instance safely. All worlds, players, and configuration data is saved, and all threads are ended cleanly.<br/> <br/> Players will be sent a default disconnect message.
-     *
-     * @return true for for the first stop
-     */
-    boolean stop();
-
     /**
      * Ends this engine instance safely. All worlds, players, and configuration data is saved, and all threads are ended cleanly. <br/> If any players are connected, will kick them with the given reason.
      *
      * @param reason for stopping the game instance
      * @return true for for the first stop
      */
-    boolean stop(String reason);
+    boolean stop(@Nullable String reason);
 
     /**
      * Returns true if the game is running in debug mode <br/> <br/> To start debug mode, start Flow with -debug
      *
      * @return true if server is started with the -debug flag, false if not
      */
+    // TODO: move to Configuration or something
     boolean debugMode();
 
     Scheduler getScheduler();
@@ -89,5 +83,8 @@ public interface Engine extends Named {
 
     WorldManager getWorldManager();
 
-    PluginManager getPluginManager();
+    PluginManager<FlowContext> getPluginManager();
+
+    @Nullable
+    <P extends EnginePart> P get(Class<P> part);
 }

src/main/java/com/flowpowered/api/EnginePart.java

@@ -0,0 +1,27 @@
+/*
+ * This file is part of Flow Engine, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) 2013 Spout LLC <http://www.spout.org/>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.flowpowered.api;
+
+public interface EnginePart {
+}

src/main/java/com/flowpowered/api/Platform.java

@@ -24,7 +24,7 @@
 package com.flowpowered.api;
 
 /**
- * Platform describes whether the plugin was written for the client, the server, or for both.
+ * Represents a startup argument for the engine. Not used elsewhere; should use Engine#get to get an EnginePart.
  */
 public enum Platform {
     SERVER(false, true),

src/main/java/com/flowpowered/api/Server.java

@@ -25,13 +25,13 @@
 
 import java.util.Collection;
 
-import com.flowpowered.api.player.Player;
 import com.flowpowered.api.geo.ServerWorldManager;
+import com.flowpowered.api.player.Player;
 
 /**
- * Represents the server-specific implementation.
+ * Represents the server part of an engine.
  */
-public interface Server extends Engine {
+public interface Server extends EnginePart {
     /**
      * Gets all players currently online
      *
@@ -76,6 +76,5 @@ public interface Server extends Engine {
      */
     Player getPlayer(String name, boolean exact);
 
-    @Override
     ServerWorldManager getWorldManager();
 }

src/main/java/com/flowpowered/api/Singleplayer.java

@@ -27,7 +27,10 @@
 
 import com.flowpowered.api.player.Player;
 
-public interface Singleplayer extends Server, Client {
+/**
+ * Represents an EnginePart which has a Player connected to a local server.
+ */
+public interface Singleplayer extends EnginePart {
 
     @Nullable
     Player getPlayer();

src/main/java/com/flowpowered/api/component/entity/EntityObserver.java

@@ -23,6 +23,7 @@
  */
 package com.flowpowered.api.component.entity;
 
+import com.flowpowered.api.Server;
 import com.flowpowered.api.component.AbstractObserver;
 import com.flowpowered.api.entity.Entity;
 import com.flowpowered.api.event.EntityStartObservingChunksEvent;
@@ -81,7 +82,7 @@ public void setSyncDistance(final int syncDistance) {
 
     @Override
     public void update() {
-        if (!engine.getPlatform().isServer()) {
+        if (engine.get(Server.class) == null) {
             return;
         }
         //Entity changed chunks as observer OR observer status changed so update

src/main/java/com/flowpowered/api/event/engine/EnginePartAddedEvent.java

@@ -0,0 +1,39 @@
+/*
+ * This file is part of Flow Engine, licensed under the MIT License (MIT).
+ *
+ * Copyright (c) 2013 Spout LLC <http://www.spout.org/>
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+package com.flowpowered.api.event.engine;
+
+import com.flowpowered.api.EnginePart;
+import com.flowpowered.events.SimpleEvent;
+
+public class EnginePartAddedEvent extends SimpleEvent {
+    private final EnginePart part;
+
+    public EnginePartAddedEvent(EnginePart part) {
+        this.part = part;
+    }
+
+    public EnginePart getPart() {
+        return part;
+    }
+}

src/main/java/com/flowpowered/api/material/MaterialRegistry.java

@@ -29,7 +29,6 @@
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.atomic.AtomicReference;
 
-import com.flowpowered.api.Engine;
 import com.flowpowered.api.Server;
 import com.flowpowered.api.material.block.BlockFullState;
 import com.flowpowered.api.util.SyncedStringMap;
@@ -56,38 +55,31 @@ public abstract class MaterialRegistry {
         }
     }
 
-    /**
-     * Sets up the material registry for its first use. May not be called more than once.<br/> This attempts to load the materials.dat file from the 'worlds' directory into memory.<br/>
-     *
-     * Can throw an {@link IllegalStateException} if the material registry has already been setup.
-     *
-     * @return StringToUniqueIntegerMap of registered materials
-     */
-    public static SyncedStringMap setupRegistry(Engine engine) {
+    public static void setupServer(Server server) {
         if (setup) {
             throw new IllegalStateException("Can not setup material registry twice!");
         }
-        if (engine.getPlatform().isServer()) {
-            setupServer((Server) engine);
-        } else {
-            setupClient();
-        }
-
-        setup = true;
-        return materialRegistry;
-    }
-
-    private static void setupServer(Server server) {
         Path serverItemMap = server.getWorldManager().getWorldFolder().resolve("materials.dat");
         BinaryFileStore store = new BinaryFileStore(serverItemMap);
         materialRegistry = SyncedStringMap.create(null, store, 1, Short.MAX_VALUE, Material.class.getName());
         if (Files.exists(serverItemMap)) {
             store.load();
         }
+
+        setup = true;
     }
 
-    private static void setupClient() {
+    public static void setupClient() {
+        if (setup) {
+            throw new IllegalStateException("Can not setup material registry twice!");
+        }
         materialRegistry = SyncedStringMap.create(null, new MemoryStore<Integer>(), 1, Short.MAX_VALUE, Material.class.getName());
+
+        setup = true;
+    }
+
+    public static boolean isSetup() {
+        return setup;
     }
 
     /**

src/main/java/com/flowpowered/api/player/PlayerNetwork.java

@@ -29,10 +29,11 @@
 import java.util.Set;
 import java.util.concurrent.atomic.AtomicReference;
 
+import com.flowpowered.api.Client;
 import com.flowpowered.api.geo.LoadOption;
 import com.flowpowered.api.geo.cuboid.Chunk;
-import com.flowpowered.api.geo.reference.ChunkReference;
 import com.flowpowered.api.geo.discrete.Transform;
+import com.flowpowered.api.geo.reference.ChunkReference;
 import com.flowpowered.api.player.reposition.NullRepositionManager;
 import com.flowpowered.api.player.reposition.RepositionManager;
 import com.flowpowered.engine.geo.chunk.FlowChunk;
@@ -105,7 +106,7 @@ public void removeChunks(Set<Chunk> toRemove) {
     }
 
     public void preSnapshotRun(Transform transform) {
-        if (session.getEngine().getPlatform().isClient()) {
+        if (session.getEngine().get(Client.class) != null) {
             return;
         }