Rename AsyncClientData to ClientDataAsync

Author: Jasper Geurtz

src/main/java/bwapi/BotWrapperAsync.java

@@ -26,8 +26,8 @@ void startNewGame(WrappedBuffer liveData, PerformanceMetrics performanceMetrics)
         frameBuffer.initialize(liveData, performanceMetrics);
 
         this.performanceMetrics = performanceMetrics;
-        AsyncClientData asyncClientData = new AsyncClientData(liveData);
-        botGame = new Game(asyncClientData);
+        ClientDataAsync clientDataAsync = new ClientDataAsync(liveData);
+        botGame = new Game(clientDataAsync);
         botGame.setConfiguration(configuration);
         botGame.botClientData().setBuffer(liveData);
         gameOver = false;

src/main/java/bwapi/AsyncClientData.java src/main/java/bwapi/ClientDataAsync.javasrc/main/java/bwapi/AsyncClientData.java renamed to src/main/java/bwapi/ClientDataAsync.java

@@ -5,16 +5,16 @@
  * and dynamic information through pre-shifted slice views.
  * Automatically generated by DumpToClient.
  */
-class AsyncClientData extends ClientData {
+class ClientDataAsync extends ClientData {
     private WrappedBuffer staticBuffer;
     private PackedWrappedBuffer staticPackedView;
     PackedWrappedBuffer packedBuffer;
 
-    AsyncClientData() {
+    ClientDataAsync() {
         super();
     }
 
-    AsyncClientData(WrappedBuffer staticBuffer) {
+    ClientDataAsync(WrappedBuffer staticBuffer) {
         super();
         setStaticBuffer(staticBuffer);
     }

src/main/java/bwapi/FrameBuffer.java

@@ -120,7 +120,7 @@ void enqueueFrame() {
 
         // Copy dynamic game information into the current frame buffer slot.
         // Static information (e.g. walkability/buildability/regions) is accessed
-        // directly from the main shared memory buffer by AsyncClientData.
+        // directly from the main shared memory buffer by ClientDataAsync.
         if (stepGame == 0) {
             copyBuffer(liveData, dataBuffer.get(indexGame()));
         } else {
@@ -174,7 +174,7 @@ void dequeue() {
      *
      * To minimize both memory footprint and copy time, we:
      * 1. Omit static map and region data (groundHeight, isWalkable, isBuildable, regions), which are read directly
-     *    from the main shared memory buffer via AsyncClientData.
+     *    from the main shared memory buffer via ClientDataAsync.
      * 2. Omit client-to-server output buffers (strings, shapes, commands, unitCommands), which are flushed directly
      *    to live shared memory by SideEffectQueue at the end of the frame.
      * 3. Pack the remaining 3 dynamic ranges into a 4.08 MB PackedWrappedBuffer (using pre-shifted slice views so

src/test/java/DumpToClient.java

@@ -162,16 +162,16 @@ public static void main(String[] args) throws IOException {
             out.println(" * and dynamic information through pre-shifted slice views.");
             out.println(" * Automatically generated by DumpToClient.");
             out.println(" */");
-            out.println("class AsyncClientData extends ClientData {");
+            out.println("class ClientDataAsync extends ClientData {");
             out.println("    private WrappedBuffer staticBuffer;");
             out.println("    private PackedWrappedBuffer staticPackedView;");
             out.println("    PackedWrappedBuffer packedBuffer;");
             out.println("");
-            out.println("    AsyncClientData() {");
+            out.println("    ClientDataAsync() {");
             out.println("        super();");
             out.println("    }");
             out.println("");
-            out.println("    AsyncClientData(WrappedBuffer staticBuffer) {");
+            out.println("    ClientDataAsync(WrappedBuffer staticBuffer) {");
             out.println("        super();");
             out.println("        setStaticBuffer(staticBuffer);");
             out.println("    }");
@@ -239,9 +239,9 @@ public static void main(String[] args) throws IOException {
             out.println("    }");
             out.println("}");
         }
-        String asyncClientDataText = swAsync.toString().replace("\r\n", "\n");
-        Files.write(Paths.get("src/main/java/bwapi/AsyncClientData.java"),
-            asyncClientDataText.getBytes(StandardCharsets.UTF_8),
+        String clientDataAsyncText = swAsync.toString().replace("\r\n", "\n");
+        Files.write(Paths.get("src/main/java/bwapi/ClientDataAsync.java"),
+            clientDataAsyncText.getBytes(StandardCharsets.UTF_8),
             StandardOpenOption.TRUNCATE_EXISTING, StandardOpenOption.CREATE);
     }
 

…test/java/bwapi/AsyncClientDataTest.java …test/java/bwapi/ClientDataAsyncTest.javasrc/test/java/bwapi/AsyncClientDataTest.java renamed to src/test/java/bwapi/ClientDataAsyncTest.java src/test/java/bwapi/AsyncClientDataTest.java renamed to src/test/java/bwapi/ClientDataAsyncTest.java

@@ -4,7 +4,7 @@
 
 import static org.junit.Assert.*;
 
-public class AsyncClientDataTest {
+public class ClientDataAsyncTest {
 
     @Test
     public void retainedViewsSurviveLiveAndPackedHandoffs() {
@@ -18,7 +18,7 @@ public void retainedViewsSurviveLiveAndPackedHandoffs() {
         new FrameBuffer(new BWClientConfiguration.Builder().withAsyncFrameBufferCapacity(1).build())
                 .copyBuffer(live, packed);
 
-        AsyncClientData data = new AsyncClientData(live);
+        ClientDataAsync data = new ClientDataAsync(live);
         data.setBuffer(live);
         ClientData.Event event = data.gameData().getEvents(0);
         ClientData.Position position = data.gameData().getStartLocations(0);
@@ -61,7 +61,7 @@ byte getByte(int offset) {
         new FrameBuffer(new BWClientConfiguration.Builder().withAsyncFrameBufferCapacity(1).build())
                 .copyBuffer(live, packed);
 
-        AsyncClientData data = new AsyncClientData(live);
+        ClientDataAsync data = new ClientDataAsync(live);
         data.setBuffer(live);
         live.handoff = () -> data.setBuffer(packed);
         assertTrue(data.gameData().isVisible(0, 0));
@@ -84,7 +84,7 @@ public void frameBufferAllocatesReducedMemory() {
     }
 
     @Test
-    public void asyncClientDataReadsStaticDataFromStaticBuffer() {
+    public void clientDataAsyncReadsStaticDataFromStaticBuffer() {
         WrappedBuffer mainBuffer = new WrappedBuffer(ClientData.GameData.SIZE);
         PackedWrappedBuffer dynamicBuffer = new PackedWrappedBuffer();
 
@@ -106,8 +106,8 @@ public void asyncClientDataReadsStaticDataFromStaticBuffer() {
         mainData.gameData().getRegions(2).setIsAccessible(true);
         mainData.gameData().getRegions(2).setIsHigherGround(true);
 
-        // Configure AsyncClientData with mainBuffer as static and dynamicBuffer as active
-        AsyncClientData asyncData = new AsyncClientData(mainBuffer);
+        // Configure ClientDataAsync with mainBuffer as static and dynamicBuffer as active
+        ClientDataAsync asyncData = new ClientDataAsync(mainBuffer);
         asyncData.setBuffer(dynamicBuffer);
 
         assertEquals(2, asyncData.gameData().getGroundHeight(10, 20));
@@ -127,7 +127,7 @@ public void asyncClientDataReadsStaticDataFromStaticBuffer() {
     }
 
     @Test
-    public void asyncClientDataReadsDynamicDataWithPackedOffsets() {
+    public void clientDataAsyncReadsDynamicDataWithPackedOffsets() {
         WrappedBuffer mainBuffer = new WrappedBuffer(ClientData.GameData.SIZE);
         PackedWrappedBuffer packedBuffer = new PackedWrappedBuffer();
 
@@ -166,8 +166,8 @@ public void asyncClientDataReadsDynamicDataWithPackedOffsets() {
         FrameBuffer frameBuffer = new FrameBuffer(config);
         frameBuffer.copyBuffer(mainBuffer, packedBuffer);
 
-        // Verify AsyncClientData reads packed dynamic data accurately
-        AsyncClientData asyncData = new AsyncClientData(mainBuffer);
+        // Verify ClientDataAsync reads packed dynamic data accurately
+        ClientDataAsync asyncData = new ClientDataAsync(mainBuffer);
         asyncData.setBuffer(packedBuffer);
 
         // Range 1
@@ -199,7 +199,7 @@ public void asyncClientDataReadsDynamicDataWithPackedOffsets() {
     }
 
     @Test
-    public void asyncClientDataWorksWithFullUnpackedBuffer() {
+    public void clientDataAsyncWorksWithFullUnpackedBuffer() {
         // Tests asyncUnsafe mode where bot is placed directly on the full 33MB liveData buffer
         WrappedBuffer fullBuffer = new WrappedBuffer(ClientData.GameData.SIZE);
 
@@ -208,7 +208,7 @@ public void asyncClientDataWorksWithFullUnpackedBuffer() {
         syncData.gameData().setIsVisible(10, 20, true);
         syncData.gameData().setIsInGame(true);
 
-        AsyncClientData asyncData = new AsyncClientData(fullBuffer);
+        ClientDataAsync asyncData = new ClientDataAsync(fullBuffer);
         asyncData.setBuffer(fullBuffer); // Unpacked full buffer
 
         assertTrue(asyncData.gameData().isVisible(10, 20));
@@ -237,7 +237,7 @@ public void copyBufferTracksMaxUnitsAndOnlyCopiesActiveUnitsAndEvents() {
                 new BWClientConfiguration.Builder().withAsyncFrameBufferCapacity(1).build());
         frameBuffer.copyBuffer(mainBuffer, packedBuffer);
 
-        AsyncClientData asyncData = new AsyncClientData(mainBuffer);
+        ClientDataAsync asyncData = new ClientDataAsync(mainBuffer);
         asyncData.setBuffer(packedBuffer);
 
         assertEquals(3, frameBuffer.getMaxUnitCount());