merge develop

JasperGeurtz · JasperGeurtz · commit 5c2212da105e · 2019-08-15T08:45:46.000+02:00
diff --git a/README.md b/README.md
@@ -35,7 +35,7 @@ Add JBWAPI as a dependecy
 <dependency>
     <groupId>com.github.JavaBWAPI</groupId>
     <artifactId>JBWAPI</artifactId>
-    <version>0.7.1</version>
+    <version>0.7.2</version>
 </dependency>
 ```
 
@@ -53,7 +53,7 @@ allprojects {
 Add JBWAPI as a dependency
 ```
 dependencies {
-    implementation 'com.github.JavaBWAPI:JBWAPI:0.7.1'
+    implementation 'com.github.JavaBWAPI:JBWAPI:0.7.2'
 }
 ```
 
@@ -68,6 +68,11 @@ or if you already have maven installed
 
 `mvn package`
 
+## documentation
+
+The api documentation can be found [here](https://javabwapi.github.io/JBWAPI/).
+
 ## tutorial
 
 If you are a just starting out with bot development, it might be helpful to follow the [tutorial](https://github.com/JavaBWAPI/Java-BWAPI-Tutorial/wiki)!
+
diff --git a/it/bots/SittingDuck/pom.xml b/it/bots/SittingDuck/pom.xml
@@ -9,7 +9,7 @@
   <parent>
     <groupId>jbwapi.it</groupId>
     <artifactId>bots</artifactId>
-    <version>0.7.1</version>
+    <version>0.7.2</version>
   </parent>
 
   <artifactId>SittingDuck</artifactId>
diff --git a/it/bots/jbwapibot/pom.xml b/it/bots/jbwapibot/pom.xml
@@ -9,7 +9,7 @@
   <parent>
     <groupId>jbwapi.it</groupId>
     <artifactId>bots</artifactId>
-    <version>0.7.1</version>
+    <version>0.7.2</version>
   </parent>
 
   <artifactId>MarineHell</artifactId>
diff --git a/it/bots/pom.xml b/it/bots/pom.xml
@@ -9,7 +9,7 @@
 
   <groupId>jbwapi.it</groupId>
   <artifactId>bots</artifactId>
-  <version>0.7.1</version>
+  <version>0.7.2</version>
 
   <properties>
     <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
@@ -43,7 +43,7 @@
     <dependency>
       <groupId>jbwapi</groupId>
       <artifactId>jbwapi</artifactId>
-      <version>0.7.1</version>
+      <version>0.7.2</version>
     </dependency>
   </dependencies>
 </project>
diff --git a/pom.xml b/pom.xml
@@ -6,10 +6,11 @@
 
     <groupId>jbwapi</groupId>
     <artifactId>jbwapi</artifactId>
-    <version>0.7.1</version>
+    <version>0.7.2</version>
 
     <properties>
         <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
+        <jmh.version>1.21</jmh.version>
     </properties>
 
     <build>
@@ -50,12 +51,35 @@
                 <artifactId>maven-site-plugin</artifactId>
                 <version>3.7.1</version>
             </plugin>
-
             <plugin>
                 <groupId>org.apache.maven.plugins</groupId>
                 <artifactId>maven-project-info-reports-plugin</artifactId>
                 <version>3.0.0</version>
             </plugin>
+            <plugin>
+                <groupId>org.codehaus.mojo</groupId>
+                <artifactId>exec-maven-plugin</artifactId>
+                <version>1.6.0</version>
+                <executions>
+                    <execution>
+                        <id>run-benchmarks</id>
+                        <phase>integration-test</phase>
+                        <goals>
+                            <goal>exec</goal>
+                        </goals>
+                        <configuration>
+                            <classpathScope>test</classpathScope>
+                            <executable>java</executable>
+                            <arguments>
+                                <argument>-classpath</argument>
+                                <classpath/>
+                                <argument>org.openjdk.jmh.Main</argument>
+                                <argument>.*</argument>
+                            </arguments>
+                        </configuration>
+                    </execution>
+                </executions>
+            </plugin>
         </plugins>
     </build>
 
@@ -111,5 +135,20 @@
             <version>3.12.2</version>
             <scope>test</scope>
         </dependency>
+
+        <!-- https://mvnrepository.com/artifact/org.openjdk.jmh -->
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-core</artifactId>
+            <version>${jmh.version}</version>
+            <scope>test</scope>
+        </dependency>
+
+        <dependency>
+            <groupId>org.openjdk.jmh</groupId>
+            <artifactId>jmh-generator-annprocess</artifactId>
+            <version>${jmh.version}</version>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 </project>
diff --git a/src/main/java/bwapi/Client.java b/src/main/java/bwapi/Client.java
@@ -45,7 +45,7 @@ class Client {
             + 4 // LastKeepAliveTime
             ;
     private static final List<Integer> SUPPORTED_BWAPI_VERSIONS = Arrays.asList(10003);
-    private static final int MAX_COUNT = 19999;
+    static final int MAX_COUNT = 19999;
 
     private static final int maxNumGames = 8;
     private static final int gameTableSize = GAME_SIZE * maxNumGames;
@@ -71,6 +71,13 @@ class Client {
         throw new Exception("All servers busy!");
     }
 
+    /**
+     * For test purposes only
+     */
+    Client(ByteBuffer buffer) {
+        data = new ClientData(buffer).new GameData(0);
+    }
+
     public GameData data() {
         return data;
     }
diff --git a/src/main/java/bwapi/Color.java b/src/main/java/bwapi/Color.java
@@ -62,8 +62,16 @@ public class Color {
             RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, RGBRESERVE, new RGBQUAD(255, 255, 255)
     };
 
-    private static boolean rgbInitialized;
     private static final byte[][][] closestColor = new byte[64][64][64];
+    static {
+        for (int r = 0; r < 64; ++r) {
+            for (int g = 0; g < 64; ++g) {
+                for (int b = 0; b < 64; ++b) {
+                    closestColor[r][g][b] = (byte) getBestIdFor(r << 2, g << 2, b << 2);
+                }
+            }
+        }
+    }
     public final int id;
 
     /**
@@ -115,16 +123,6 @@ private static int getBestIdFor(final int red, final int green, final int blue)
     }
 
     private static int getRGBIndex(final int red, final int green, final int blue) {
-        if (!rgbInitialized) {
-            rgbInitialized = true;
-            for (int r = 0; r < 64; ++r) {
-                for (int g = 0; g < 64; ++g) {
-                    for (int b = 0; b < 64; ++b) {
-                        closestColor[r][g][b] = (byte) getBestIdFor(r << 2, g << 2, b << 2);
-                    }
-                }
-            }
-        }
         return closestColor[(byte) (red >> 2)][(byte) (green >> 2)][(byte) (blue >> 2)];
     }
 
diff --git a/src/main/java/bwapi/TechType.java b/src/main/java/bwapi/TechType.java
@@ -54,11 +54,15 @@ public enum TechType {
 
     /// IMPLEMENTATION
     private static final int[] defaultOreCost =         // Same as default gas cost
-            {100, 200, 200, 100, 0, 150, 0, 200, 100, 150, 100, 100, 0, 100, 0, 200, 100, 100, 0, 200, 150, 150, 150, 0, 100, 200, 0, 200, 0, 100, 100, 100, 200};
+            {100, 200, 200, 100, 0, 150, 0, 200, 100, 150, 100, 100, 0, 100, 0, 200, 100, 100, 0, 200, 150, 150, 150, 0,
+                    100, 200, 0, 200, 0, 100, 100, 100, 200, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
     private static final int[] defaultTimeCost =
-            {1200, 1500, 1800, 1200, 0, 1200, 0, 1200, 1800, 1500, 1200, 1200, 0, 1200, 0, 1500, 1500, 1200, 0, 1800, 1200, 1800, 1500, 0, 1200, 1200, 0, 1800, 0, 1800, 1800, 1500, 1800};
+            {1200, 1500, 1800, 1200, 0, 1200, 0, 1200, 1800, 1500, 1200, 1200, 0, 1200, 0, 1500, 1500, 1200, 0, 1800,
+                    1200, 1800, 1500, 0, 1200, 1200, 0, 1800, 0, 1800, 1800, 1500, 1800, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
+                    0, 0, 0, 0};
     private static final int[] defaultEnergyCost =
-            {0, 100, 100, 0, 50, 0, 100, 75, 150, 25, 25, 0, 0, 150, 100, 150, 0, 75, 75, 75, 100, 150, 100, 0, 50, 125, 0, 150, 0, 50, 75, 100, 0, 0, 1};
+            {0, 100, 100, 0, 50, 0, 100, 75, 150, 25, 25, 0, 0, 150, 100, 150, 0, 75, 75, 75, 100, 150, 100, 0, 50, 125,
+                    0, 150, 0, 50, 75, 100, 0, 0, 1, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0};
     private static final UnitType[] whatResearches = {
             UnitType.Terran_Academy, UnitType.Terran_Covert_Ops, UnitType.Terran_Science_Facility, UnitType.Terran_Machine_Shop,
             UnitType.None, UnitType.Terran_Machine_Shop, UnitType.None, UnitType.Terran_Science_Facility, UnitType.Terran_Physics_Lab,
@@ -91,7 +95,7 @@ public enum TechType {
             0, TARG_UNIT, TARG_BOTH, TARG_POS, TARG_BOTH, 0, TARG_UNIT, TARG_UNIT, TARG_UNIT, 0, 0, 0,
             TARG_UNIT, TARG_UNIT, TARG_BOTH, TARG_BOTH, TARG_UNIT, TARG_BOTH, TARG_UNIT, TARG_BOTH, TARG_UNIT,
             TARG_BOTH, TARG_BOTH, TARG_UNIT, TARG_UNIT, TARG_BOTH, 0, TARG_UNIT, TARG_UNIT, TARG_UNIT, TARG_UNIT,
-            TARG_BOTH, 0, 0, TARG_BOTH, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, TARG_BOTH
+            TARG_BOTH, 0, 0, TARG_BOTH, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, TARG_BOTH, 0
     };
     private static final Order[] techOrders = {
             Order.None, CastLockdown, CastEMPShockwave, PlaceMine, CastScannerSweep, Order.None, CastDefensiveMatrix,
diff --git a/src/main/java/bwapi/TextColor.java b/src/main/java/bwapi/TextColor.java
@@ -48,7 +48,7 @@ public static String formatText(final String text, final TextColor format) {
     }
 
     //SINCE 4.2
-    //C hecks if the given character is a color-changing control code.
+    //C checks if the given character is a color-changing control code.
     boolean isColor() {
         final int c = this.id;
         return (2 <= c && c <= 8) || (14 <= c && c <= 17) || (21 <= c && c <= 31);
diff --git a/src/main/java/bwapi/WrappedBuffer.java b/src/main/java/bwapi/WrappedBuffer.java
@@ -14,9 +14,6 @@
  * Wrapper around ByteBuffer that makes use of sun.misc.Unsafe if available.
  */
 class WrappedBuffer {
-    private static final Charset charSet = StandardCharsets.ISO_8859_1;
-    private static final CharsetEncoder enc = charSet.newEncoder();
-
     private final ByteBuffer buffer;
     private final long address;
     private final Unsafe unsafe;
@@ -72,23 +69,26 @@ void putDouble(final int offset, final double value) {
     }
 
     String getString(final int offset, final int maxLen) {
-        final byte[] buf = new byte[maxLen];
-
-        unsafe.copyMemory(null, address + offset, buf, Unsafe.ARRAY_BYTE_BASE_OFFSET, maxLen);
-
-        int len = 0;
-        while (len < maxLen && buf[len] != 0) {
-            ++len;
+        char[] buf = new char[maxLen];
+        long pos = offset + address;
+        for (int i = 0; i < maxLen; i++) {
+            byte b = unsafe.getByte(pos);
+            if (b == 0) break;
+            buf[i] = (char) (b & 0xff);
+            pos++;
         }
-        return new String(buf, 0, len, charSet);
+        return new String(buf, 0, (int) (pos - offset - address));
     }
 
     void putString(final int offset, final int maxLen, final String string) {
         if (string.length() + 1 >= maxLen) {
             throw new StringIndexOutOfBoundsException();
         }
-        buffer.position(offset);
-        enc.encode(CharBuffer.wrap(string), buffer, true);
-        buffer.put((byte) 0);
+        long pos = offset + address;
+        for (int i = 0; i < string.length(); i++) {
+            unsafe.putByte(pos, (byte) string.charAt(i));
+            pos++;
+        }
+        unsafe.putByte(pos, (byte) 0);
     }
 }
diff --git a/src/test/java/bwapi/ClientDataBenchmark.java b/src/test/java/bwapi/ClientDataBenchmark.java
@@ -0,0 +1,91 @@
+package bwapi;
+
+import org.openjdk.jmh.annotations.*;
+import org.openjdk.jmh.infra.Blackhole;
+
+import java.nio.ByteBuffer;
+import java.util.SplittableRandom;
+import java.util.stream.Collectors;
+
+@Warmup(iterations = 3, time = 5)
+@Measurement(iterations = 3, time = 5)
+@Fork(3)
+public class ClientDataBenchmark {
+    @State(Scope.Thread)
+    public static class EmptyState {
+        Client client;
+        Game game;
+        String[] strings;
+
+        @Setup(Level.Invocation)
+        public void setup() {
+            client = new Client(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
+            game = new Game(client);
+            strings = buildStrings();
+        }
+
+    }
+
+    @State(Scope.Thread)
+    public static class FilledWithStrings {
+        Client client;
+        ClientData.GameData data;
+        Game game;
+
+        @Setup(Level.Invocation)
+        public void setup() {
+            client = new Client(ByteBuffer.allocateDirect(ClientData.GameData.SIZE));
+            data = client.data();
+            game = new Game(client);
+            String[] strings = buildStrings();
+            for (String s : strings) {
+                client.addString(s);
+            }
+        }
+    }
+
+    private static String[] buildStrings() {
+        SplittableRandom rnd = new SplittableRandom(987654321L);
+        String[] strings = new String[Client.MAX_COUNT];
+        for (int i = 0; i < strings.length; i++) {
+            strings[i] = rnd.ints(1022, 0, 9)
+                    .mapToObj(Integer::toString)
+                    .collect(Collectors.joining());
+        }
+        return strings;
+    }
+
+    @Benchmark
+    @Measurement(iterations = 2, time = 2)
+    @Warmup(time = 2)
+    @Fork(2)
+    public void reference(Blackhole blackhole) {
+        blackhole.consume(0);
+    }
+
+    @Benchmark
+    @OperationsPerInvocation(Client.MAX_COUNT)
+    public int addUnitCommand(EmptyState s) {
+        for (int i = 0; i < Client.MAX_COUNT; i++) {
+            s.game.addUnitCommand(0, 1, 2, 3, 4, 5);
+        }
+        return s.client.data().getCommandCount();
+    }
+
+    @Benchmark
+    @OperationsPerInvocation(Client.MAX_COUNT)
+    public int addString(EmptyState s) {
+        for (int i = 0; i < Client.MAX_COUNT; i++) {
+            s.client.addString(s.strings[i]);
+        }
+        return s.client.data().getStringCount();
+    }
+
+    @Benchmark
+    @OperationsPerInvocation(Client.MAX_COUNT)
+    public void getString(FilledWithStrings s, Blackhole blackhole) {
+        for (int i = 0; i < Client.MAX_COUNT; i++) {
+            blackhole.consume(s.data.getStrings(i));
+        }
+    }
+}
diff --git a/src/test/java/bwapi/PlayerTypeTest.java b/src/test/java/bwapi/PlayerTypeTest.java
@@ -0,0 +1,12 @@
+package bwapi;
+
+import org.junit.Test;
+
+import java.lang.reflect.InvocationTargetException;
+
+public class PlayerTypeTest {
+    @Test
+    public void ensureSimpleGettersReturnNonNullAndDontFail() throws InvocationTargetException, IllegalAccessException {
+        TypeTester.ensureSimpleGettersReturnNonNullAndDontFail(WeaponType.class);
+    }
+}
diff --git a/src/test/java/bwapi/TechTypeTest.java b/src/test/java/bwapi/TechTypeTest.java
diff --git a/src/test/java/bwapi/TypeTester.java b/src/test/java/bwapi/TypeTester.java
diff --git a/src/test/java/bwapi/UnitTypeTest.java b/src/test/java/bwapi/UnitTypeTest.java
diff --git a/src/test/java/bwapi/UpgradeTypeTest.java b/src/test/java/bwapi/UpgradeTypeTest.java
diff --git a/src/test/java/bwapi/WeaponTypeTest.java b/src/test/java/bwapi/WeaponTypeTest.java
diff --git a/src/test/java/bwapi/WrappedBufferTest.java b/src/test/java/bwapi/WrappedBufferTest.java

Original file line number	Diff line number	Diff line change
`@@ -48,7 +48,7 @@ public static String formatText(final String text, final TextColor format) {`
`48`	`48`	`}`
`49`	`49`
`50`	`50`	`//SINCE 4.2`
`51`		`- //C hecks if the given character is a color-changing control code.`
	`51`	`+ //C checks if the given character is a color-changing control code.`
`52`	`52`	`boolean isColor() {`
`53`	`53`	`final int c = this.id;`
`54`	`54`	`return (2 <= c && c <= 8) \|\| (14 <= c && c <= 17) \|\| (21 <= c && c <= 31);`