refactor some utils/client stuff to seperate folder

Author: Jasper Geurtz

pom.xml

@@ -62,7 +62,7 @@
                 <version>3.2.5</version>
                 <configuration>
                     <rerunFailingTestsCount>1</rerunFailingTestsCount>
-                    <argLine>--add-opens java.base/java.nio=ALL-UNNAMED -Xms1g -Xmx1g</argLine>
+                    <argLine>--add-opens java.base/java.nio=ALL-UNNAMED -Xms2g -Xmx2g</argLine>
                 </configuration>
             </plugin>
             <plugin>
@@ -96,7 +96,7 @@
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-javadoc-plugin</artifactId>
-                <version>3.4.1</version>
+                <version>3.11.2</version>
                 <configuration>
                     <additionalOptions>-Xdoclint:none</additionalOptions>
                     <additionalJOption>-Xdoclint:none</additionalJOption>
@@ -121,14 +121,14 @@
         <dependency>
             <groupId>net.java.dev.jna</groupId>
             <artifactId>jna</artifactId>
-            <version>5.12.1</version>
+            <version>5.17.0</version>
         </dependency>
 
         <!-- https://mvnrepository.com/artifact/net.java.dev.jna/jna-platform -->
         <dependency>
             <groupId>net.java.dev.jna</groupId>
             <artifactId>jna-platform</artifactId>
-            <version>5.12.1</version>
+            <version>5.17.0</version>
         </dependency>
 
         <!-- https://mvnrepository.com/artifact/junit/junit -->
@@ -151,7 +151,7 @@
         <dependency>
             <groupId>org.assertj</groupId>
             <artifactId>assertj-core</artifactId>
-            <version>3.23.1</version>
+            <version>3.27.3</version>
             <scope>test</scope>
         </dependency>
 

src/main/java/bwapi/BWClient.java

@@ -1,5 +1,8 @@
 package bwapi;
 
+import bwapi.client.Client;
+import bwapi.client.PerformanceMetrics;
+
 import java.util.Objects;
 
 /**
@@ -42,7 +45,7 @@ public BWClientConfiguration getConfiguration() {
     /**
      * @return Whether the current frame should be subject to timing.
      */
-    boolean doTime() {
+    public boolean doTime() {
         return ! configuration.getUnlimitedFrameZero() || (client.isConnected() && client.liveClientData().gameData().getFrameCount() > 0);
     }
 

src/main/java/bwapi/BWClientConfiguration.java

@@ -155,7 +155,7 @@ public boolean getLogVerbosely() {
         return logVerbosely;
     }
 
-    void log(String value) {
+    public void log(String value) {
         if (logVerbosely) {
             System.out.println(value);
         }

src/main/java/bwapi/BotWrapper.java

@@ -1,11 +1,15 @@
 package bwapi;
 
+import bwapi.client.FrameBuffer;
+import bwapi.client.PerformanceMetrics;
+import bwapi.client.WrappedBuffer;
+
 import java.util.concurrent.locks.ReentrantLock;
 
 /**
  * Manages invocation of bot event handlers
  */
-class BotWrapper {
+public class BotWrapper {
     private final ClientData liveClientData = new ClientData();
     private final BWClientConfiguration configuration;
     private final BWEventListener eventListener;
@@ -23,13 +27,13 @@ class BotWrapper {
     BotWrapper(BWClientConfiguration configuration, BWEventListener eventListener) {
         this.configuration = configuration;
         this.eventListener = eventListener;
-        frameBuffer = configuration.getAsync() ? new FrameBuffer(configuration) : null;
+        frameBuffer = configuration.getAsync() ? new FrameBuffer(configuration, ClientData.GameData.SIZE) : null;
     }
 
     /**
      * Resets the BotWrapper for a new botGame.
      */
-    void startNewGame(WrappedBuffer liveData, PerformanceMetrics performanceMetrics) {
+    public void startNewGame(WrappedBuffer liveData, PerformanceMetrics performanceMetrics) {
         if (configuration.getAsync()) {
             frameBuffer.initialize(liveData, performanceMetrics);
         }
@@ -246,7 +250,8 @@ private void handleEvents() {
         }
 
         if (configuration.getAsync()) {
-            performanceMetrics.getFramesBehind().record(Math.max(1, frameBuffer.framesBuffered()) - 1);
+            performanceMetrics.getFramesBehind().record(
+                    Math.max(1, frameBuffer.framesBuffered()) - 1);
         }
 
         performanceMetrics.getBotResponse().timeIf(

src/main/java/bwapi/ClientData.java

@@ -1,17 +1,18 @@
 package bwapi;
 
+import bwapi.client.WrappedBuffer;
 import com.sun.jna.Pointer;
 
-final class ClientData {
+public final class ClientData {
     private WrappedBuffer buffer;
     private GameData gameData;
-    ClientData() {
+    public ClientData() {
         gameData = new ClientData.GameData(0);
     }
-    GameData gameData() {
+    public GameData gameData() {
         return gameData;
     }
-    void setBuffer(WrappedBuffer buffer) {
+    public void setBuffer(WrappedBuffer buffer) {
         this.buffer = buffer;
     }
     void setPointer(Pointer pointer) {
@@ -66,13 +67,13 @@ void setExtra(int value) {
             buffer.putInt(myOffset + 20, value);
         }
     }
-    class GameData {
-        static final int SIZE = 33017048;
+    public class GameData {
+        public static final int SIZE = 33017048;
         private int myOffset;
         GameData(int myOffset) {
           this.myOffset = myOffset;
         }
-        int getClient_version() {
+        public int getClient_version() {
             int offset = myOffset + 0;
             return buffer.getInt(offset);
         }
@@ -534,7 +535,7 @@ int getNeutral() {
         void setNeutral(int value) {
             buffer.putInt(myOffset + 10586616, value);
         }
-        int getEventCount() {
+        public int getEventCount() {
             int offset = myOffset + 10586620;
             return buffer.getInt(offset);
         }

src/main/java/bwapi/Game.java

@@ -1,6 +1,7 @@
 package bwapi;
 
 import bwapi.ClientData.GameData;
+import bwapi.utils.BuildingPlacer;
 
 import java.util.*;
 import java.util.stream.Collectors;

src/main/java/bwapi/GameDataUtils.java

@@ -30,7 +30,6 @@ of this software and associated documentation files (the "Software"), to deal
  * These functions live outside GameData because GameData is auto-generated.
  */
 class GameDataUtils {
-
     static final int MAX_COUNT = 19999;
     private static final int MAX_STRING_SIZE = 1024;
 

src/main/java/bwapi/Client.java renamed to src/main/java/bwapi/client/Client.java

@@ -23,9 +23,14 @@ of this software and associated documentation files (the "Software"), to deal
 SOFTWARE.
 */
 
-package bwapi;
+package bwapi.client;
 
-class Client {
+import bwapi.BWClient;
+import bwapi.ClientData;
+import bwapi.client.*;
+
+
+public class Client {
     private static final int SUPPORTED_BWAPI_VERSION = 10003;
 
     private ClientData clientData;
@@ -35,34 +40,36 @@ class Client {
     private WrappedBuffer gameTableShm = null;
     private final ClientConnection clientConnector;
 
-    Client(BWClient bwClient) {
+    public Client(BWClient bwClient) {
         this.bwClient = bwClient;
         boolean windowsOs = System.getProperty("os.name").toLowerCase().contains("win");
-        clientConnector = windowsOs ? new ClientConnectionW32() : new ClientConnectionPosix();
+        clientConnector = windowsOs ?
+                new ClientConnectionW32(ClientData.GameData.SIZE) :
+                new ClientConnectionPosix(ClientData.GameData.SIZE);
     }
 
     /**
      * For test purposes only
      */
-    Client(final WrappedBuffer buffer) {
+    public Client(final WrappedBuffer buffer) {
         clientData = new ClientData();
         clientData.setBuffer(buffer);
         clientConnector = null;
     }
 
-    ClientData liveClientData() {
+    public ClientData liveClientData() {
         return clientData;
     }
 
-    WrappedBuffer mapFile() {
+    public WrappedBuffer mapFile() {
         return mapShm;
     }
 
-    boolean isConnected() {
+    public boolean isConnected() {
         return connected;
     }
 
-    void reconnect() {
+    public void reconnect() {
         while (!connect()) {
             sleep(1000);
         }
@@ -114,7 +121,7 @@ boolean connect() {
 
         int oldest = Integer.MAX_VALUE;
         for (int i = 0; i < GameTable.MAX_GAME_INSTANCES; i++) {
-            GameInstance gameInstance = gameTable.gameInstances[i];
+            GameTable.GameInstance gameInstance = gameTable.gameInstances[i];
             System.out.println(i + " | " + gameInstance.serverProcessID + " | " + (gameInstance.isConnected ? 1 : 0) + " | " + gameInstance.lastKeepAliveTime);
             if (gameInstance.serverProcessID != 0 && !gameInstance.isConnected) {
                 if (gameTableIndex == -1 || gameInstance.lastKeepAliveTime < oldest) {
@@ -193,7 +200,7 @@ boolean connect() {
         return true;
     }
 
-    void sendFrameReceiveFrame() {
+    public void sendFrameReceiveFrame() {
         final PerformanceMetrics metrics = bwClient.getPerformanceMetrics();
 
         // Tell BWAPI that we are done with the current frame

src/main/java/bwapi/ClientConnection.java renamed to src/main/java/bwapi/client/ClientConnection.java

@@ -1,11 +1,11 @@
-package bwapi;
+package bwapi.client;
 
 import java.io.IOException;
 
 /**
  * Client - Server connection abstraction
  */
-interface ClientConnection {
+public interface ClientConnection {
     void disconnect();
 
     WrappedBuffer getGameTable();

src/main/java/bwapi/ClientConnectionPosix.java renamed to src/main/java/bwapi/client/ClientConnectionPosix.java

@@ -1,4 +1,4 @@
-package bwapi;
+package bwapi.client;
 
 import com.sun.jna.LastErrorException;
 import com.sun.jna.Library;
@@ -20,7 +20,7 @@
  * To be used with OpenBWs BWAPI including server support. At time of writing, only the following fork includes this:
  * https://github.com/basil-ladder/openbw
  */
-class ClientConnectionPosix implements ClientConnection {
+public class ClientConnectionPosix implements ClientConnection {
     interface LibCExt extends LibC {
         LibCExt INSTANCE = Native.load(LibCExt.class);
 
@@ -40,6 +40,11 @@ interface PosixShm extends Library {
     }
 
     private AFUNIXSocket syncSocket = null;
+    private final int gameDataSize;
+
+    public ClientConnectionPosix(int gameDataSize) {
+        this.gameDataSize = gameDataSize;
+    }
 
     @Override
     public void disconnect() {
@@ -65,9 +70,13 @@ public WrappedBuffer getGameTable() {
     public WrappedBuffer getSharedMemory(int serverProcID) {
         String sharedMemoryName = "/bwapi_shared_memory_" + serverProcID;
         try {
-            Pointer mapFileView = LibCExt.INSTANCE.mmap(Pointer.NULL, ClientData.GameData.SIZE, PROT_READ | PROT_WRITE, MAP_SHARED, LibRT.INSTANCE.shm_open(sharedMemoryName, Fcntl.O_RDWR, 0),
+            Pointer mapFileView = LibCExt.INSTANCE.mmap(
+                    Pointer.NULL,
+                    gameDataSize,
+                    PROT_READ | PROT_WRITE, MAP_SHARED,
+                    LibRT.INSTANCE.shm_open(sharedMemoryName, Fcntl.O_RDWR, 0),
                     0);
-            return new WrappedBuffer(mapFileView, ClientData.GameData.SIZE);
+            return new WrappedBuffer(mapFileView, gameDataSize);
         } catch (Exception e) {
             throw new SharedMemoryConnectionException(sharedMemoryName, e);
         }

src/main/java/bwapi/ClientConnectionW32.java renamed to src/main/java/bwapi/client/ClientConnectionW32.java

@@ -1,4 +1,4 @@
-package bwapi;
+package bwapi.client;
 
 import com.sun.jna.Native;
 import com.sun.jna.Pointer;
@@ -12,7 +12,7 @@
 /**
  * Default Windows BWAPI pipe connection with shared memory.
  */
-class ClientConnectionW32 implements ClientConnection {
+public class ClientConnectionW32 implements ClientConnection {
     private static final int READ_WRITE = 0x1 | 0x2 | 0x4;
 
     interface MappingKernel extends Kernel32 {
@@ -23,6 +23,11 @@ interface MappingKernel extends Kernel32 {
 
 
     private RandomAccessFile pipeObjectHandle = null;
+    private final int gameDataSize;
+
+    public ClientConnectionW32(int gameDataSize) {
+        this.gameDataSize = gameDataSize;
+    }
 
     @Override
     public void disconnect() {
@@ -50,8 +55,8 @@ public WrappedBuffer getSharedMemory(int serverProcID) {
         try {
             final Pointer mapFileView = Kernel32.INSTANCE.MapViewOfFile(MappingKernel.INSTANCE
                             .OpenFileMapping(READ_WRITE, false, sharedMemoryName), READ_WRITE,
-                    0, 0, ClientData.GameData.SIZE);
-            return new WrappedBuffer(mapFileView, ClientData.GameData.SIZE);
+                    0, 0, gameDataSize);
+            return new WrappedBuffer(mapFileView, gameDataSize);
         } catch (Exception e) {
             throw new SharedMemoryConnectionException(sharedMemoryName, e);
         }