Move type definitions from an include file to egs.erl.

include/records.hrl

@@ -23,9 +23,9 @@
 -record(client, {
 	socket			:: ssl:sslsocket(),
 	transport		:: module(),
-	gid = 0			:: gid(),
-	slot = 0		:: character_slot(), %% @todo Probably should remove this one from the state.
-	lid = 16#ffff	:: lid(),
+	gid = 0			:: egs:gid(),
+	slot = 0		:: egs:character_slot(), %% @todo Probably should remove this one from the state.
+	lid = 16#ffff	:: egs:lid(),
 	areanb = 0		:: non_neg_integer()
 }).
 
@@ -33,8 +33,8 @@
 %% @todo Probably can use a "param" or "extra" field to store the game-specific information (for things that don't need to be queried).
 -record(users, {
 	%% General information.
-	gid				:: gid(),
-	lid = 16#ffff	:: lid(),
+	gid				:: egs:gid(),
+	lid = 16#ffff	:: egs:lid(),
 	pid				:: pid(),
 	%% Character information.
 	%% @todo Specs it.
@@ -63,12 +63,12 @@
 	zonepid		:: pid(),
 	partypid	:: pid(),
 	areatype	:: counter | mission | lobby | myroom,
-	area		:: area(),
-	entryid		:: entryid(),
-	pos = {0.0, 0.0, 0.0, 0.0} :: position(),
+	area		:: egs:area(),
+	entryid		:: egs:entryid(),
+	pos = {0.0, 0.0, 0.0, 0.0} :: egs:position(),
 	shopid		:: integer(),
-	prev_area = {0, 0, 0} :: area(),
-	prev_entryid = 0 :: entryid(),
+	prev_area = {0, 0, 0} :: egs:area(),
+	prev_entryid = 0 :: egs:entryid(),
 	%% To be moved or deleted later on.
 	instancepid	:: pid()
 }).

include/types.hrl

@@ -1,31 +0,0 @@
-%% @author Loïc Hoguin <essen@dev-extend.eu>
-%% @copyright 2011 Loïc Hoguin.
-%% @doc Project-wide Erlang types.
-%%
-%%	This file is part of EGS.
-%%
-%%	EGS is free software: you can redistribute it and/or modify
-%%	it under the terms of the GNU Affero General Public License as
-%%	published by the Free Software Foundation, either version 3 of the
-%%	License, or (at your option) any later version.
-%%
-%%	EGS is distributed in the hope that it will be useful,
-%%	but WITHOUT ANY WARRANTY; without even the implied warranty of
-%%	MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-%%	GNU Affero General Public License for more details.
-%%
-%%	You should have received a copy of the GNU Affero General Public License
-%%	along with EGS.  If not, see <http://www.gnu.org/licenses/>.
-
--type gid() :: 0..16#ffffffff.
--type lid() :: 0..1023 | 16#ffff.
-
--type questid()	:: 0..16#ffffffff. %% @todo What's the real max?
--type zoneid()	:: 0..16#ffff. %% @todo What's the real max?
--type mapid()	:: 0..9999.
--type entryid()	:: 0..16#ffff. %% @todo What's the real max?
-
--type area() :: {questid(), zoneid(), mapid()}.
--type position() :: {X :: float(), Y :: float(), Z :: float(), Dir :: float()}.
-
--type character_slot() :: 0..3.

src/egs.erl

@@ -20,8 +20,22 @@
 -module(egs).
 -export([start/0, stop/0, global/1, warp/4, warp/5]). %% API.
 
-%% @todo Don't use an include file for type specs.
--include("include/types.hrl").
+%% Player and account-related types.
+
+-type gid() :: 0..16#ffffffff.
+-type lid() :: 0..1023 | 16#ffff.
+-type character_slot() :: 0..3.
+-export_type([gid/0, lid/0, character_slot/0]).
+
+%% Location related types.
+
+-type questid() :: 0..16#ffffffff. %% @todo What's the real max?
+-type zoneid() :: 0..16#ffff. %% @todo What's the real max?
+-type mapid() :: 0..9999.
+-type entryid() :: 0..16#ffff. %% @todo What's the real max?
+-type area() :: {questid(), zoneid(), mapid()}. %% @todo Probably remove later.
+-type position() :: {X::float(), Y::float(), Z::float(), Dir::float()}.
+-export_type([questid/0, zoneid/0, mapid/0, entryid/0, area/0, position/0]).
 
 %% API.
 

src/egs_accounts.erl

@@ -25,20 +25,18 @@
 
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
-
 %% @todo Make accounts permanent.
 %% @todo Hash the password.
 %% @todo Add email, password_salt, is_ingame, register_time, last_login_time, etc.
 -record(accounts, {
-	gid			:: gid(),
+	gid			:: egs:gid(),
 	username	:: string(),
 	password	:: string(),
 	auth_state	:: undefined | {wait_for_authentication, binary(), any()}
 }).
 
 -record(state, {
-	accounts = []			:: list({GID::gid(), #accounts{}}),
+	accounts = []			:: list({egs:gid(), #accounts{}}),
 	next_gid = 10000001		:: integer(),
 	tmp_gid  = 16#ff000001	:: integer()
 }).
@@ -57,17 +55,17 @@ stop() ->
 get_folder(GID) ->
 	gen_server:call(?SERVER, {get_folder, GID}).
 
--spec key_auth(GID::gid(), AuthKey::binary()) -> ok | {error, badarg}.
+-spec key_auth(egs:gid(), AuthKey::binary()) -> ok | {error, badarg}.
 %% @doc Authenticate using the given key.
 key_auth(GID, AuthKey) ->
 	gen_server:call(?SERVER, {key_auth, GID, AuthKey}).
 
--spec key_auth_init(GID::gid()) -> {ok, AuthKey::binary()}.
+-spec key_auth_init(egs:gid()) -> {ok, AuthKey::binary()}.
 %% @doc Initialize key authentication. Obtain a key for a subsequent re-authentication on a different connection.
 key_auth_init(GID) ->
 	gen_server:call(?SERVER, {key_auth_init, GID}).
 
--spec key_auth_timeout(GID::gid()) -> ok.
+-spec key_auth_timeout(egs:gid()) -> ok.
 %% @doc Key authentication timeout handling.
 %% @todo Probably handle the authentication in a gen_fsm properly.
 key_auth_timeout(GID) ->
@@ -79,7 +77,7 @@ key_auth_timeout(GID) ->
 login_auth(Username, Password) ->
 	gen_server:call(?SERVER, {login_auth, Username, Password}).
 
--spec tmp_gid() -> GID::gid().
+-spec tmp_gid() -> egs:gid().
 %% @doc Return an unused temporary GID for initial connection and APC characters.
 tmp_gid() ->
 	gen_server:call(?SERVER, tmp_gid).

src/egs_char_select.erl

@@ -20,7 +20,6 @@
 -module(egs_char_select).
 -export([keepalive/1, info/2, cast/3, raw/3, event/2]).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% @doc Send a keepalive.

src/egs_counters_db.erl

@@ -26,8 +26,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
-
 %% API.
 
 %% @spec start_link() -> {ok,Pid::pid()}

src/egs_files.erl

@@ -21,8 +21,6 @@
 -export([load_counter_pack/2, load_quest_xnr/1, load_script_bin/1, load_set_rel/4, load_table_rel/1,
 	load_text_bin/1, load_unit_title_table_rel/2, nbl_pack/1, nbl_padded_size/1]).
 
--include("include/types.hrl").
-
 %% @doc Build a counter's pack file, options and return them along with the background value.
 load_counter_pack(ConfFilename, CounterNbl) ->
 	{ok, Settings} = file:consult(ConfFilename),

src/egs_game.erl

@@ -21,7 +21,6 @@
 -export([keepalive/1, info/2, cast/3, raw/3, event/2]).
 -export([char_load/2]). %% Hopefully temporary export.
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% @doc Send a keepalive.

src/egs_game_protocol.erl

@@ -20,7 +20,6 @@
 -module(egs_game_protocol).
 -export([start_link/3, init/2]).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 -spec start_link(ssl:sslsocket(), module(), []) -> {ok, pid()}.

src/egs_items_db.erl

@@ -26,7 +26,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 -include("priv/items.hrl").
 

src/egs_login.erl

@@ -20,7 +20,6 @@
 -module(egs_login).
 -export([keepalive/1, info/2, cast/3, raw/3, event/2]).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% @doc Don't keep alive here, authentication should go fast.

src/egs_login_protocol.erl

@@ -20,7 +20,6 @@
 -module(egs_login_protocol).
 -export([start_link/3, init/2]).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 -spec start_link(ssl:sslsocket(), module(), []) -> {ok, pid()}.

src/egs_network.erl

@@ -20,7 +20,6 @@
 -module(egs_network).
 -export([recv/3]). %% API.
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% API.

src/egs_npc_db.erl

@@ -26,7 +26,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 -include("priv/npc.hrl").
 

src/egs_proto.erl

@@ -20,7 +20,6 @@
 -module(egs_proto).
 -compile(export_all).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% @spec assert() -> ok

src/egs_quests.erl

@@ -23,8 +23,6 @@
 -export([start_link/2, stop/1, zone_pid/2]). %% API.
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). %% gen_server.
 
--include("include/types.hrl").
-
 -record(state, {zones}).
 
 %% API.

src/egs_quests_db.erl

@@ -26,8 +26,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
-
 -record(state, {quests=[], quests_bin=[], zones_bin=[], sets=[]}).
 
 %% API.

src/egs_seasons.erl

@@ -27,8 +27,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
-
 %% Seasonal values: {IsSeasonal, SeasonID, QuestList}.
 -define(SEASON_NONE,      {0,255, []}).
 -define(SEASON_PARTY,     {1,  0, [1100000]}).

src/egs_shops_db.erl

@@ -26,8 +26,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
-
 %% API.
 
 %% @spec start_link() -> {ok,Pid::pid()}

src/egs_universes.erl

@@ -26,8 +26,6 @@
 %% Use the module name for the server's name.
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
-
 -record(state, {unis=[], lobbies=[]}).
 
 %% Default universe IDs.

src/egs_users.erl

@@ -27,11 +27,10 @@
 
 -define(SERVER, ?MODULE).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 -record(state, {
-	users = [] :: list({GID::gid(), #users{}})
+	users = [] :: list({egs:gid(), #users{}})
 }).
 
 %% API.

src/egs_zones.erl

@@ -23,8 +23,6 @@
 -export([start_link/4, stop/1, setid/1, enter/2, leave/2, get_all_players/2, broadcast/3]). %% API.
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). %% gen_server.
 
--include("include/types.hrl").
-
 -record(state, {
 	setid = 0		:: integer(),
 	objects = []	:: list(),

src/psu/psu_appearance.erl

@@ -20,7 +20,6 @@
 -module(psu_appearance).
 -export([binary_to_tuple/2, tuple_to_binary/2, validate_char_create/3]).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% @doc Convert the binary character creation appearance data into a tuple.

src/psu/psu_characters.erl

@@ -24,7 +24,6 @@
 	race_atom_to_binary/1, race_binary_to_atom/1, stats_tuple_to_binary/1
 ]).
 
--include("include/types.hrl").
 -include("include/records.hrl").
 
 %% @doc Convert a character tuple into a binary to be sent to clients.

src/psu/psu_party.erl

@@ -22,8 +22,6 @@
 -export([start_link/1, stop/1, join/3, leave/2, get_instance/1, set_instance/2, remove_instance/1, get_member/2, remove_member/2, get_npc/1]). %% API.
 -export([init/1, handle_call/3, handle_cast/2, handle_info/2, terminate/2, code_change/3]). %% gen_server.
 
--include("include/types.hrl").
-
 -record(state, {free_spots, users, instancepid}).
 
 %% API