add (untested) bwem

Author: JasperGeurtz

pom.xml

@@ -35,6 +35,13 @@
             <version>4.5.2</version>
         </dependency>
 
+        <!-- https://mvnrepository.com/artifact/org.apache.commons/commons-lang3 -->
+        <dependency>
+            <groupId>org.apache.commons</groupId>
+            <artifactId>commons-lang3</artifactId>
+            <version>3.8.1</version>
+        </dependency>
+
 
     </dependencies>
 

src/main/java/bwapi/point/Point.java

@@ -15,6 +15,14 @@ abstract class Point {
 		this.scalar = type;
 	}
 
+	public int getX() {
+		return x;
+	}
+
+	public int getY() {
+		return y;
+	}
+
 	public double getLength() {
 		return Math.sqrt(x * x + y * y);
 	}

src/main/java/bwem/BWEM.java

@@ -0,0 +1,44 @@
+// Original work Copyright (c) 2015, 2017, Igor Dimitrijevic
+// Modified work Copyright (c) 2017-2018 OpenBW Team
+
+//////////////////////////////////////////////////////////////////////////
+//
+// This file is part of the BWEM Library.
+// BWEM is free software, licensed under the MIT/X11 License.
+// A copy of the license is provided with the library in the LICENSE file.
+// Copyright (c) 2015, 2017, Igor Dimitrijevic
+//
+//////////////////////////////////////////////////////////////////////////
+
+package bwem;
+
+import bwapi.Game;
+import bwem.map.Map;
+import bwem.map.MapInitializer;
+import bwem.map.MapInitializerImpl;
+
+public final class BWEM {
+  private final Map map;
+
+  public BWEM(final Game game) {
+    this.map = new MapInitializerImpl(game);
+  }
+
+  /** Returns the root internal data container. */
+  public Map getMap() {
+    return this.map;
+  }
+
+
+  /**
+   * Initializes and pre-computes all of the internal data.
+   *
+   */
+  public void initialize() {
+    if (!(this.map instanceof MapInitializer)) {
+      throw new IllegalStateException("BWEM was not instantiated properly.");
+    } else {
+      ((MapInitializer) this.map).initialize();
+    }
+  }
+}

src/main/java/bwem/Base.java

@@ -0,0 +1,82 @@
+// Original work Copyright (c) 2015, 2017, Igor Dimitrijevic
+// Modified work Copyright (c) 2017-2018 OpenBW Team
+
+//////////////////////////////////////////////////////////////////////////
+//
+// This file is part of the BWEM Library.
+// BWEM is free software, licensed under the MIT/X11 License.
+// A copy of the license is provided with the library in the LICENSE file.
+// Copyright (c) 2015, 2017, Igor Dimitrijevic
+//
+//////////////////////////////////////////////////////////////////////////
+
+package bwem;
+
+import bwapi.point.Position;
+import bwapi.point.TilePosition;
+import bwem.area.Area;
+import bwem.map.MapData;
+import bwem.unit.Geyser;
+import bwem.unit.Mineral;
+import bwem.unit.Neutral;
+import java.util.List;
+
+/**
+ * After Areas and ChokePoints, Bases are the third kind of object BWEM automatically computes from
+ * Brood War's maps. A Base is essentially a suggested location (intended to be optimal) to put a
+ * resource depot. It also provides information on the resources available, and some statistics. A
+ * Base always belongs to some Area. An Area may contain zero, one or several Bases. Like Areas and
+ * ChokePoints, the number and the addresses of Base instances remain unchanged.
+ */
+public interface Base {
+  /**
+   * Tests whether this base is a start location.<br>
+   * - Note: all players start at locations taken from {@link MapData#getStartingLocations()},<br>
+   * which doesn't mean all the locations in {@link MapData#getStartingLocations()} are actually
+   * used.
+   */
+  boolean isStartingLocation();
+
+  /** Returns the area in which this base is located. */
+  Area getArea();
+
+  /**
+   * Returns the position (top-left TilePosition) of the location for a resource depot.<br>
+   * - Note: If {@link #isStartingLocation()} == true, it is guaranteed that the location
+   * corresponds exactly to one of {@link MapData#getStartingLocations()}.
+   */
+  TilePosition getLocation();
+
+  /** Returns the center position of {@link #getLocation()}. */
+  Position getCenter();
+
+  /**
+   * Returns the available minerals.<br>
+   * - These minerals are assigned to this base (it is guaranteed that no other base provides them).
+   * <br>
+   * - Note: The size of the returned list may decrease, as some of the minerals may get destroyed.
+   */
+  List<Mineral> getMinerals();
+
+  /**
+   * Returns the available geysers.<br>
+   * - These geysers are assigned to this Base (it is guaranteed that no other Base provides them).
+   * <br>
+   * - Note: The size of the returned list will NOT decrease, as geysers never get destroyed.
+   */
+  List<Geyser> getGeysers();
+
+  /**
+   * Returns the blocking minerals.<br>
+   * - These are special minerals. They are placed at or near the resource depot location,<br>
+   * thus blocking the building of a resource depot from being close to the resources.<br>
+   * - So, before trying to build a resource depot, these minerals must be gathered first.<br>
+   * - Fortunately, these are guaranteed to have their initialAmount() <= 8.<br>
+   * - As an example of blocking minerals, see the two islands in Andromeda.scx.<br>
+   * - Note: if {@link #isStartingLocation()} == true, an empty list is returned.<br>
+   * - Note: {@link #getBlockingMinerals()} should not be confused with {@link
+   * ChokePoint#getBlockingNeutral()} and {@link Neutral#isBlocking()}:<br>
+   * The last two refer to a Neutral blocking a ChokePoint, not a Base.
+   */
+  List<Mineral> getBlockingMinerals();
+}

src/main/java/bwem/BaseImpl.java

@@ -0,0 +1,131 @@
+// Original work Copyright (c) 2015, 2017, Igor Dimitrijevic
+// Modified work Copyright (c) 2017-2018 OpenBW Team
+
+//////////////////////////////////////////////////////////////////////////
+//
+// This file is part of the BWEM Library.
+// BWEM is free software, licensed under the MIT/X11 License.
+// A copy of the license is provided with the library in the LICENSE file.
+// Copyright (c) 2015, 2017, Igor Dimitrijevic
+//
+//////////////////////////////////////////////////////////////////////////
+
+package bwem;
+
+import bwapi.point.Position;
+import bwapi.point.TilePosition;
+import bwapi.types.UnitType;
+import bwem.area.Area;
+import bwem.unit.Geyser;
+import bwem.unit.Mineral;
+import bwem.unit.Resource;
+import bwem.util.BwemExt;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.Objects;
+public class BaseImpl implements Base {
+  private final Area area;
+  private TilePosition location;
+  private Position center;
+  private final List<Mineral> minerals = new ArrayList<>();
+  private final List<Geyser> geysers = new ArrayList<>();
+  private final List<Mineral> blockingMinerals;
+  private boolean isStartingLocation = false;
+
+  public BaseImpl(
+      final Area area,
+      final TilePosition location,
+      final List<Resource> assignedResources,
+      final List<Mineral> blockingMinerals) {
+    this.area = area;
+    this.location = location;
+    this.center = BwemExt.centerOfBuilding(location, UnitType.Terran_Command_Center.tileSize());
+    this.blockingMinerals = blockingMinerals;
+
+    //        bwem_assert(!AssignedResources.empty());
+    if (assignedResources.isEmpty()) {
+      throw new IllegalArgumentException();
+    }
+
+    for (final Resource assignedResource : assignedResources) {
+      if (assignedResource instanceof Mineral) {
+        final Mineral assignedMineral = (Mineral) assignedResource;
+        this.minerals.add(assignedMineral);
+      } else if (assignedResource instanceof Geyser) {
+        final Geyser assignedGeyser = (Geyser) assignedResource;
+        this.geysers.add(assignedGeyser);
+      }
+    }
+  }
+
+  @Override
+  public boolean isStartingLocation() {
+    return this.isStartingLocation;
+  }
+
+  @Override
+  public Area getArea() {
+    return this.area;
+  }
+
+  @Override
+  public TilePosition getLocation() {
+    return this.location;
+  }
+
+  @Override
+  public Position getCenter() {
+    return this.center;
+  }
+
+  @Override
+  public List<Mineral> getMinerals() {
+    return this.minerals;
+  }
+
+  @Override
+  public List<Geyser> getGeysers() {
+    return this.geysers;
+  }
+
+  @Override
+  public List<Mineral> getBlockingMinerals() {
+    return this.blockingMinerals;
+  }
+
+  public void assignStartingLocation(final TilePosition actualLocation) {
+    this.isStartingLocation = true;
+    this.location = actualLocation;
+    this.center =
+        BwemExt.centerOfBuilding(actualLocation, UnitType.Terran_Command_Center.tileSize());
+  }
+
+  public void onMineralDestroyed(final Mineral mineral) {
+    //    	bwem_assert(pMineral);
+    if (mineral == null) {
+      throw new IllegalArgumentException();
+    }
+
+    this.minerals.remove(mineral);
+    this.blockingMinerals.remove(mineral);
+  }
+
+  @Override
+  public boolean equals(final Object object) {
+    if (this == object) {
+      return true;
+    } else if (!(object instanceof Base)) {
+      return false;
+    } else {
+      final Base that = (Base) object;
+      return (getArea().equals(that.getArea())
+          && getLocation().equals(that.getLocation())
+          && getCenter().equals(that.getCenter()));
+    }
+  }
+
+  @Override
+  public int hashCode() {
+    return Objects.hash(this.area, this.location, this.center);
+  }
+}

src/main/java/bwem/CheckMode.java

@@ -0,0 +1,18 @@
+// Original work Copyright (c) 2015, 2017, Igor Dimitrijevic
+// Modified work Copyright (c) 2017-2018 OpenBW Team
+
+//////////////////////////////////////////////////////////////////////////
+//
+// This file is part of the BWEM Library.
+// BWEM is free software, licensed under the MIT/X11 License.
+// A copy of the license is provided with the library in the LICENSE file.
+// Copyright (c) 2015, 2017, Igor Dimitrijevic
+//
+//////////////////////////////////////////////////////////////////////////
+
+package bwem;
+
+public enum CheckMode {
+  CHECK,
+  NO_CHECK
+}