Starting work on the Map handler...

4 files changed, 356 insertions, 0 deletions

diff --git a/src/map/struct/map_battlemap.erl b/src/map/struct/map_battlemap.erl
new file mode 100644
index 0000000..595bcb3
--- /dev/null
+++ b/src/map/struct/map_battlemap.erl
@@ -0,0 +1,104 @@
+-module(map_map).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% TYPES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-type id() :: binary().
+
+-record
+(
+   map,
+   {
+      id :: id(),
+      owner :: binary(),
+      width :: integer(),
+      height :: integer(),
+      tile_class_ids :: array:array(btl_tile:class_id())
+   }
+).
+
+-opaque type() :: #map{}.
+
+-export_type([type/0, id/0]).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%% Accessors
+-export
+(
+   [
+      get_id/1,
+      get_owner/1,
+      get_width/1,
+      get_height/1,
+      get_tile_class_ids/1,
+      get_tile_class_id/2
+   ]
+).
+
+-export
+(
+   [
+      from_list/5
+   ]
+).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% LOCAL FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-spec location_to_array_index
+   (
+      non_neg_integer(),
+      btl_location:type()
+   )
+   -> ('error' | non_neg_integer()).
+location_to_array_index (ArrayWidth, {X, Y}) ->
+   if
+      (X < 0) -> error;
+      (Y < 0) -> error;
+      (X >= ArrayWidth) -> error;
+      true -> ((Y * ArrayWidth) + X)
+   end.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTED FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%% Accessors
+-spec get_id (type()) -> id().
+get_id (Map) -> Map#map.id.
+
+-spec get_width (type()) -> integer().
+get_width (Map) -> Map#map.width.
+
+-spec get_height (type()) -> integer().
+get_height (Map) -> Map#map.height.
+
+-spec get_tile_class_ids (type()) -> array:array(btl_tile:class_id()).
+get_tile_class_ids (Map) -> Map#map.tile_class_ids.
+
+-spec get_tile_class_id (btl_location:type(), type()) -> btl_tile:class_id().
+get_tile_class_id (Location, Map) ->
+   TileIX = location_to_array_index(Map#map.width, Location),
+   array:get(TileIX, Map#map.tile_class_ids).
+
+-spec from_list
+   (
+      non_neg_integer(),
+      binary(),
+      non_neg_integer(),
+      non_neg_integer(),
+      list(non_neg_integer())
+   )
+   -> type().
+from_list (ID, Owner, Width, Height, List) ->
+   TileClassIDs = lists:map(fun btl_tile:class_id_from_int/1, List),
+
+   #map
+   {
+      id = list_to_binary(integer_to_list(ID)),
+      owner = Owner,
+      width = Width,
+      height = Height,
+      tile_class_ids = array:from_list(TileClassIDs)
+   }.
diff --git a/src/map/struct/map_direction.erl b/src/map/struct/map_direction.erl
new file mode 100644
index 0000000..9fb5a01
--- /dev/null
+++ b/src/map/struct/map_direction.erl
@@ -0,0 +1,38 @@
+-module(btl_direction).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% TYPES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-type enum() :: ('up' | 'down' | 'left' | 'right').
+-type type() :: enum().
+
+-export_type([enum/0, type/0]).
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-export
+(
+   [
+      decode/1,
+      encode/1
+   ]
+).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% LOCAL FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTED FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-spec decode (binary()) -> enum().
+decode (<<"U">>) -> up;
+decode (<<"D">>) -> down;
+decode (<<"L">>) -> left;
+decode (<<"R">>) -> right.
+
+-spec encode (enum()) -> binary().
+encode (up) -> <<"U">>;
+encode (down) -> <<"D">>;
+encode (left) -> <<"L">>;
+encode (right) -> <<"R">>.
diff --git a/src/map/struct/map_location.erl b/src/map/struct/map_location.erl
new file mode 100644
index 0000000..9670cb0
--- /dev/null
+++ b/src/map/struct/map_location.erl
@@ -0,0 +1,90 @@
+-module(btl_location).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% TYPES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-type type() :: ({non_neg_integer(), non_neg_integer()} | 'nowhere').
+
+-export_type([type/0]).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-export
+(
+   [
+      decode/1,
+      encode/1,
+      get_nowhere/0
+   ]
+).
+
+-export
+(
+   [
+      apply_direction/2,
+      dist/2
+   ]
+).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% LOCAL FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-spec validate ({integer(), integer()}) -> type().
+validate ({X, Y}) ->
+   if
+      (X < 0) -> nowhere;
+      (Y < 0) -> nowhere;
+      true -> {X, Y}
+   end.
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTED FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-spec get_nowhere () -> type().
+get_nowhere () -> nowhere.
+
+-spec apply_direction (btl_direction:enum(), type()) -> type().
+apply_direction (left, {X, Y}) ->
+   validate({(X - 1), Y});
+apply_direction (right, {X, Y}) ->
+   validate({(X + 1), Y});
+apply_direction (up, {X, Y}) ->
+   validate({X, (Y - 1)});
+apply_direction (down, {X, Y}) ->
+   validate({X, (Y + 1)});
+apply_direction (_, nowhere) ->
+   error("Trying to move from 'nowhere'."),
+   nowhere.
+
+-spec dist(type(), type()) -> non_neg_integer().
+dist ({OX, OY}, {DX, DY}) ->
+   (abs(DY - OY) + abs(DX - OX));
+dist (_, _) ->
+   error("Trying to measure distance to 'nowhere'"),
+   999.
+
+-spec encode (type()) -> {list(any())}.
+encode ({X, Y}) ->
+   {
+      [
+         {<<"x">>, X},
+         {<<"y">>, Y}
+      ]
+   };
+encode (nowhere) ->
+   {
+      [
+         {<<"x">>, -1},
+         {<<"y">>, -1}
+      ]
+   }.
+
+-spec decode (map()) -> type().
+decode (Map) ->
+   X = maps:get(<<"x">>, Map),
+   Y = maps:get(<<"y">>, Map),
+
+   true = (is_integer(X) and is_integer(Y)),
+
+   validate({X, Y}).
diff --git a/src/map/struct/map_tile.erl b/src/map/struct/map_tile.erl
new file mode 100644
index 0000000..16e671b
--- /dev/null
+++ b/src/map/struct/map_tile.erl
@@ -0,0 +1,124 @@
+-module(btl_tile).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% TYPES %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-record
+(
+   tile,
+   {
+      id :: id(),
+      name :: binary(),
+      cost :: non_neg_integer(),
+      class_range_min :: non_neg_integer(),
+      class_range_max :: non_neg_integer()
+   }
+).
+
+-opaque id() :: non_neg_integer().
+-opaque class_id() :: non_neg_integer().
+-opaque type() :: #tile{}.
+
+-export_type([type/0, class_id/0, id/0]).
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+-export
+(
+   [
+      get_id/1,
+      get_name/1,
+      get_cost/1,
+      get_range_minimum/1,
+      get_range_maximum/1,
+      from_id/1,
+      cost_when_oob/0
+   ]
+).
+
+-export
+(
+   [
+      class_id_to_type_id/1,
+      class_id_from_int/1
+   ]
+).
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% LOCAL FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%% EXPORTED FUNCTIONS %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
+
+-spec class_id_to_type_id (class_id()) -> id().
+class_id_to_type_id (ClassID) ->
+   case ClassID of
+      0 -> 0;
+      1 -> 1;
+      2 -> 2;
+      N when ((N >= 3) and (N =< 17)) -> 3
+   end.
+
+-spec from_id (id()) -> type().
+from_id (0) ->
+   #tile
+   {
+      id = 0,
+      name = <<"[Grassland] Grass">>,
+      cost = 6,
+      class_range_min = 0,
+      class_range_max = 0
+   };
+from_id (1) ->
+   #tile
+   {
+      id = 1,
+      name = <<"[Grassland] Mushroom Infestation">>,
+      cost = 12,
+      class_range_min = 1,
+      class_range_max = 1
+   };
+from_id (2) ->
+   #tile
+   {
+      id = 2,
+      name = <<"[Grassland] Tree Remains">>,
+      cost = 24,
+      class_range_min = 2,
+      class_range_max = 2
+   };
+from_id (3) ->
+   #tile
+   {
+      id = 3,
+      name = <<"[Grassland] Clear Water">>,
+      cost = cost_when_occupied(),
+      class_range_min = 3,
+      class_range_max = 17
+   }.
+
+-spec cost_when_oob () -> non_neg_integer().
+cost_when_oob () -> 255.
+
+-spec cost_when_occupied () -> non_neg_integer().
+cost_when_occupied () -> 201.
+
+-spec get_id (type()) -> non_neg_integer().
+get_id (Tile) -> Tile#tile.id.
+
+-spec get_cost (type()) -> non_neg_integer().
+get_cost (Tile) -> Tile#tile.cost.
+
+-spec get_name (type()) -> binary().
+get_name (Tile) -> Tile#tile.name.
+
+-spec get_range_minimum (type()) -> non_neg_integer().
+get_range_minimum (Tile) -> Tile#tile.class_range_min.
+
+-spec get_range_maximum (type()) -> non_neg_integer().
+get_range_maximum (Tile) -> Tile#tile.class_range_max.
+
+-spec class_id_from_int (non_neg_integer()) -> id().
+class_id_from_int (I) -> I.