Cleanup

Author: dgant

src/main/java/bwapi/BWClient.java

@@ -27,7 +27,6 @@ public Game getGame() {
     /**
      * @return JBWAPI performance metrics.
      */
-    @SuppressWarnings("unused")
     public PerformanceMetrics getPerformanceMetrics() {
         return performanceMetrics;
     }
@@ -36,11 +35,17 @@ public PerformanceMetrics getPerformanceMetrics() {
      * @return The number of frames between the one exposed to the bot and the most recent received by JBWAPI.
      * This tracks the size of the frame buffer except when the game is paused (which results in multiple frames arriving with the same count).
      */
-    @SuppressWarnings("unused")
     public int framesBehind() {
         return botWrapper == null ? 0 : Math.max(0, client.clientData().gameData().getFrameCount() - getGame().getFrameCount());
     }
 
+    /**
+     * For internal test use.
+     */
+    Client getClient() {
+        return client;
+    }
+
     /**
      * Start the game with default settings.
      */

src/main/java/bwapi/BotWrapper.java

@@ -1,28 +1,3 @@
-/*
-MIT License
-
-Copyright (c) 2018 Hannes Bredberg
-Modified work Copyright (c) 2018 Jasper
-
-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 bwapi;
 
 import java.nio.ByteBuffer;

src/main/java/bwapi/Bullet.java

@@ -21,7 +21,7 @@
  * represents a new Bullet.
  * <p>
  * If {@link Flag#CompleteMapInformation} is disabled, then a {@link Bullet} is accessible if and only if
- * it is visible. Otherwise if {@link Flag#CompleteMapInformation} is timersEnabled, then all Bullets
+ * it is visible. Otherwise if {@link Flag#CompleteMapInformation} is enabled, then all Bullets
  * in the game are accessible.
  *
  * @see Game#getBullets
@@ -54,7 +54,7 @@ public int getID() {
      * return value will be false regardless of the Bullet's true existence. This is because
      * absolutely no state information on invisible enemy bullets is made available to the AI.
      * <p>
-     * If {@link Flag#CompleteMapInformation} is timersEnabled, then this function is accurate for all
+     * If {@link Flag#CompleteMapInformation} is enabled, then this function is accurate for all
      * {@link Bullet} information.
      *
      * @return true if the bullet exists or is visible, false if the bullet was destroyed or has gone out of scope.

src/main/java/bwapi/CommandTemp.java

@@ -2,7 +2,7 @@
 
 /**
  * Latency Compensation:
- * Only need to implement LatCom for current frame, the server updates the next frame already if latcom is timersEnabled.
+ * Only need to implement LatCom for current frame, the server updates the next frame already if latcom is enabled.
  * Use Caches for all internal state that might be affected by latcom, and add the (current) frame, to let Player & Unit
  * check if they need to use the cached/latcom version of the value or the from server (or a combination of both)
  * <p>

src/main/java/bwapi/FrameBuffer.java

@@ -1,28 +1,3 @@
-/*
-MIT License
-
-Copyright (c) 2018 Hannes Bredberg
-Modified work Copyright (c) 2018 Jasper
-
-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 bwapi;
 
 import com.sun.jna.Platform;

src/main/java/bwapi/Game.java

@@ -329,7 +329,7 @@ public List<Player> getPlayers() {
 
     /**
      * Retrieves the set of all accessible units.
-     * If {@link Flag#CompleteMapInformation} is timersEnabled, then the set also includes units that are not
+     * If {@link Flag#CompleteMapInformation} is enabled, then the set also includes units that are not
      * visible to the player.
      * <p>
      * Units that are inside refineries are not included in this set.
@@ -624,13 +624,13 @@ public void pingMinimap(final Position p) {
     }
 
     /**
-     * Checks if the state of the given flag is timersEnabled or not.
+     * Checks if the state of the given flag is enabled or not.
      * <p>
-     * Flags may only be timersEnabled at the start of the match during the {@link BWEventListener#onStart}
+     * Flags may only be enabled at the start of the match during the {@link BWEventListener#onStart}
      * callback.
      *
      * @param flag The {@link Flag} entry describing the flag's effects on BWAPI.
-     * @return true if the given flag is timersEnabled, false if the flag is disabled.
+     * @return true if the given flag is enabled, false if the flag is disabled.
      * @see Flag
      */
     public boolean isFlagEnabled(final Flag flag) {
@@ -640,7 +640,7 @@ public boolean isFlagEnabled(final Flag flag) {
     /**
      * Enables the state of a given flag.
      * <p>
-     * Flags may only be timersEnabled at the start of the match during the {@link BWEventListener#onStart}
+     * Flags may only be enabled at the start of the match during the {@link BWEventListener#onStart}
      * callback.
      *
      * @param flag The {@link Flag} entry describing the flag's effects on BWAPI.
@@ -1640,7 +1640,7 @@ public boolean issueCommand(final Collection<Unit> units, final UnitCommand comm
 
     /**
      * Retrieves the set of units that are currently selected by the user outside of
-     * BWAPI. This function requires that{@link Flag#UserInput} be timersEnabled.
+     * BWAPI. This function requires that{@link Flag#UserInput} be enabled.
      *
      * @return A List<Unit> containing the user's selected units. If {@link Flag#UserInput} is disabled,
      * then this set is always empty.
@@ -2163,7 +2163,7 @@ public boolean isDebug() {
     /**
      * Checks the state of latency compensation.
      *
-     * @return true if latency compensation is timersEnabled, false if it is disabled.
+     * @return true if latency compensation is enabled, false if it is disabled.
      * @see #setLatCom
      */
     public boolean isLatComEnabled() {
@@ -2174,9 +2174,9 @@ public boolean isLatComEnabled() {
      * Changes the state of latency compensation. Latency compensation
      * modifies the state of BWAPI's representation of units to reflect the implications of
      * issuing a command immediately after the command was performed, instead of waiting
-     * consecutive frames for the results. Latency compensation is timersEnabled by default.
+     * consecutive frames for the results. Latency compensation is enabled by default.
      *
-     * @param isEnabled Set whether the latency compensation feature will be timersEnabled (true) or disabled (false).
+     * @param isEnabled Set whether the latency compensation feature will be enabled (true) or disabled (false).
      * @see #isLatComEnabled
      */
     public void setLatCom(final boolean isEnabled) {
@@ -2278,11 +2278,11 @@ public boolean setVision(Player player, boolean enabled) {
     }
 
     /**
-     * Checks if the GUI is timersEnabled.
+     * Checks if the GUI is enabled.
      * <p>
      * The GUI includes all drawing functions of BWAPI, as well as screen updates from Broodwar.
      *
-     * @return true if the GUI is timersEnabled, and everything is visible, false if the GUI is disabled and drawing
+     * @return true if the GUI is enabled, and everything is visible, false if the GUI is disabled and drawing
      * functions are rejected
      * @see #setGUI
      */
@@ -2341,7 +2341,7 @@ public boolean setMap(final String mapFileName) {
     /**
      * Sets the state of the fog of war when watching a replay.
      *
-     * @param reveal The state of the reveal all flag. If false, all fog of war will be timersEnabled. If true,
+     * @param reveal The state of the reveal all flag. If false, all fog of war will be enabled. If true,
      *               then the fog of war will be revealed. It is true by default.
      */
     public boolean setRevealAll(boolean reveal) {

src/main/java/bwapi/PerformanceMetrics.java

@@ -1,7 +1,7 @@
 package bwapi;
 
 /**
- * When performance diagnostics are timersEnabled, collects various performance metrics.
+ * Collects various performance metrics.
  */
 public class PerformanceMetrics {
 

src/main/java/bwapi/Unit.java

@@ -19,8 +19,8 @@
  * becoming invalid).
  * <p>
  * Every Unit in the game is either accessible or inaccessible. To determine if an AI can access
- * a particular unit, BWAPI checks to see if {@link Flag#CompleteMapInformation} is timersEnabled. So there
- * are two cases to consider - either the flag is timersEnabled, or it is disabled:
+ * a particular unit, BWAPI checks to see if {@link Flag#CompleteMapInformation} is enabled. So there
+ * are two cases to consider - either the flag is enabled, or it is disabled:
  * <p>
  * If {@link Flag#CompleteMapInformation} is disabled, then a unit is accessible if and only if it is visible.
  * <p>
@@ -31,7 +31,7 @@
  * AI must watch for {@link BWEventListener#onUnitDestroy} messages from BWAPI, which is only called for visible units
  * which get destroyed.
  * <p>
- * If {@link Flag#CompleteMapInformation} is timersEnabled, then all units that exist in the game are accessible, and
+ * If {@link Flag#CompleteMapInformation} is enabled, then all units that exist in the game are accessible, and
  * {@link Unit#exists} is accurate for all units. Similarly {@link BWEventListener#onUnitDestroy} messages are generated for all
  * units that get destroyed, not just visible ones.
  * <p>
@@ -128,7 +128,7 @@ public boolean exists() {
     /**
      * Retrieves the unit identifier for this unit as seen in replay data.
      * <p>
-     * This is only available if {@link Flag#CompleteMapInformation} is timersEnabled.
+     * This is only available if {@link Flag#CompleteMapInformation} is enabled.
      *
      * @return An integer containing the replay unit identifier.
      * @see #getID
@@ -1882,7 +1882,7 @@ public boolean isResearching() {
 
     /**
      * Checks if this unit has been selected in the user interface. This
-     * function is only available if the flag Flag#UserInput is timersEnabled.
+     * function is only available if the flag Flag#UserInput is enabled.
      *
      * @return true if this unit is currently selected, and false if this unit is not selected
      * @see Game#getSelectedUnits
@@ -2046,7 +2046,7 @@ public boolean isVisible() {
      * @param player The player to check visibility for. If this parameter is omitted, then the BWAPI player obtained from {@link Game#self()} will be used.
      * @return true if this unit is visible to the specified player, and false if it is not.
      * <p>
-     * If the {@link Flag#CompleteMapInformation} flag is timersEnabled, existing units hidden by the
+     * If the {@link Flag#CompleteMapInformation} flag is enabled, existing units hidden by the
      * fog of war will be accessible, but isVisible will still return false.
      * @see #exists
      */

src/test/java/bwapi/GameBuilder.java

@@ -10,15 +10,16 @@
 
 public class GameBuilder {
 
+    private final static String RESOURCES = "src/test/resources/";
     public final static String DEFAULT_MAP_FILE = "(2)Benzene.scx";
-    public final static String DEFAULT_BUFFER_PATH = "src/test/resources/" + DEFAULT_MAP_FILE + "_frame0_buffer.bin";
+    public final static String DEFAULT_BUFFER_PATH = RESOURCES + DEFAULT_MAP_FILE + "_frame0_buffer.bin";
 
     public static Game createGame() throws IOException {
         return createGame(DEFAULT_MAP_FILE);
     }
 
     public static Game createGame(String mapName) throws IOException {
-        final ByteBuffer buffer = binToBuffer(DEFAULT_BUFFER_PATH);
+        final ByteBuffer buffer = binToBuffer(RESOURCES + mapName + "_frame0_buffer.bin");
         return createGame(new Client(buffer));
     }
 
@@ -29,14 +30,6 @@ public static Game createGame(Client client) {
         return game;
     }
 
-    public static Game createGameUnchecked() {
-        try {
-            return GameBuilder.createGame();
-        } catch (IOException exception) {
-            throw new RuntimeException(exception);
-        }
-    }
-
     public static ByteBuffer binToBuffer(String binLocation) throws IOException {
         final byte[] compressedBytes = Files.readAllBytes(Paths.get(binLocation));
         final ByteArrayOutputStream out = new ByteArrayOutputStream();

src/test/java/bwapi/GameStateDumper.java

@@ -36,9 +36,7 @@ public void onStart() {
     }
 
     private void dumpBuffer(String name) throws IOException {
-        // TODO
-        //ByteBuffer buf = game.getClient().clientData().buffer.getBuffer();
-        ByteBuffer buf = null;
+        ByteBuffer buf = client.getClient().mapFile();
         buf.rewind();
         byte[] bytearr = new byte[buf.remaining()];
         buf.get(bytearr);