Classes
struct	coordinate
	Contains an x and y coordinate used for starting positions in maps. More...

struct	error

struct	t_match
	This structure can be used for matching terrain strings. More...

struct	t_terrain
	A terrain string which is converted to a terrain is a string with 1 or 2 layers the layers are separated by a caret and each group consists of 2 to 4 characters if no second layer is defined it is stored as 0xFFFFFFFF, if the second layer is empty (needed for matching) the layer has the value 0. More...

Typedefs
typedef uint32_t	t_layer

typedef std::vector< t_terrain >	t_list

typedef std::vector < std::vector< t_terrain > >	t_map

using	tstarting_positions = boost::bimaps::bimap< boost::bimaps::set_of< std::string >, boost::bimaps::multiset_of< coordinate >>

Functions
size_t	max_map_size ()
	Return the maximum allowed map size (in either dimension), the maximum map area is, therefore, this value squared. More...

static t_layer	get_layer_mask_ (t_layer terrain)
	Get the mask for a single layer. More...

static t_terrain	get_mask_ (const t_terrain &terrain)
	Gets a mask for a terrain, this mask is used for wildcard matching. More...

static t_layer	string_to_layer_ (const char begin, const char end)
	Converts a string to a layer. More...

static t_layer	string_to_layer_ (const std::string &str)

static t_terrain	string_to_number_ (std::string str, std::string &start_position, const t_layer filler)
	Converts a terrain string to a number. More...

static t_terrain	string_to_number_ (const std::string &str, const t_layer filler=NO_LAYER)

static std::string	number_to_string_ (t_terrain terrain, const std::string &start_position="")
	Converts a terrain number to a string. More...

static t_terrain	string_to_builder_number_ (std::string str)
	Converts a terrain string to a number for the builder. More...

const t_match	ALL_FORESTS ("F,^F*")

t_terrain	read_terrain_code (const std::string &str, const t_layer filler=NO_LAYER)
	Reads a single terrain from a string. More...

std::string	write_terrain_code (const t_terrain &tcode)
	Writes a single terrain code to a string. More...

t_list	read_list (const std::string &str, const t_layer filler=NO_LAYER)
	Reads a list of terrains from a string, when reading the. More...

std::string	write_list (const t_list &list)
	Writes a list of terrains to a string, only writes the new format. More...

t_map	read_game_map (const std::string &str, tstarting_positions &starting_positions, coordinate border_offset=coordinate{0, 0})
	Reads a gamemap string into a 2D vector. More...

std::string	write_game_map (const t_map &map, const tstarting_positions &starting_positions=tstarting_positions(), coordinate border_offset=coordinate{0, 0})
	Write a gamemap in to a vector string. More...

bool	terrain_matches (const t_terrain &src, const t_terrain &dest)
	Tests whether a specific terrain matches an expression, for matching rules see above. More...

bool	terrain_matches (const t_terrain &src, const t_list &dest)
	Tests whether a specific terrain matches a list of expressions. More...

bool	terrain_matches (const t_terrain &src, const t_match &dest)
	Tests whether a certain terrain matches a list of expressions, for matching rules see above. More...

bool	has_wildcard (const t_terrain &tcode)
	Tests whether a terrain code contains a wildcard. More...

bool	has_wildcard (const t_list &list)
	Tests whether a terrain-code list contains at least one item with a wildcard. More...

t_map	read_builder_map (const std::string &str)
	Reads a builder map. More...

bool	operator< (const t_terrain &a, const t_terrain &b)

bool	operator== (const t_terrain &a, const t_terrain &b)

bool	operator!= (const t_terrain &a, const t_terrain &b)

t_terrain	operator& (const t_terrain &a, const t_terrain &b)

t_terrain	operator\| (const t_terrain &a, const t_terrain &b)

std::ostream &	operator<< (std::ostream &s, const t_terrain &a)

Variables
const t_terrain	OFF_MAP_USER = string_to_number_("_off^_usr")

const t_terrain	VOID_TERRAIN = string_to_number_("_s")

const t_terrain	FOGGED = string_to_number_("_f")

const t_terrain	HUMAN_CASTLE = string_to_number_("Ch")

const t_terrain	HUMAN_KEEP = string_to_number_("Kh")

const t_terrain	SHALLOW_WATER = string_to_number_("Ww")

const t_terrain	DEEP_WATER = string_to_number_("Wo")

const t_terrain	GRASS_LAND = string_to_number_("Gg")

const t_terrain	FOREST = string_to_number_("Gg^Ff")

const t_terrain	MOUNTAIN = string_to_number_("Mm")

const t_terrain	HILL = string_to_number_("Hh")

const t_terrain	CAVE_WALL = string_to_number_("Xu")

const t_terrain	CAVE = string_to_number_("Uu")

const t_terrain	UNDERGROUND_VILLAGE = string_to_number_("Uu^Vu")

const t_terrain	DWARVEN_CASTLE = string_to_number_("Cud")

const t_terrain	DWARVEN_KEEP = string_to_number_("Kud")

const t_terrain	PLUS = string_to_number_("+")

const t_terrain	MINUS = string_to_number_("-")

const t_terrain	NOT = string_to_number_("!")

const t_terrain	STAR = string_to_number_("*")

const t_terrain	BASE = string_to_number_("_bas")

const t_match	ALL_HILLS ("!,^V,!,H*")

const t_match	ALL_MOUNTAINS ("!,^V,!,M*")

const t_match	ALL_SWAMPS ("!,^V,^B,!,S*")

const t_layer	WILDCARD = 0x2A000000

const t_layer	NO_LAYER = 0xFFFFFFFF

const t_terrain	NONE_TERRAIN = t_terrain()

const t_match	ALL_FORESTS

const t_layer	TB_STAR = '*' << 24

const t_layer	TB_DOT = '.' << 24

Typedef Documentation

typedef uint32_t t_translation::t_layer

Definition at line 36 of file translation.hpp.

typedef std::vector<t_terrain> t_translation::t_list

Definition at line 75 of file translation.hpp.

typedef std::vector<std::vector<t_terrain> > t_translation::t_map

Definition at line 76 of file translation.hpp.

using t_translation::tstarting_positions = typedef boost::bimaps::bimap<boost::bimaps::set_of<std::string>, boost::bimaps::multiset_of<coordinate>>

Definition at line 205 of file translation.hpp.

Function Documentation

const t_match t_translation::ALL_FORESTS	(	"F*	,
		^F "
	)

t_layer t_translation::get_layer_mask_ ( t_layer terrain )

inlinestatic

Get the mask for a single layer.

Parameters

terrain 1 layer of a terrain, might have a wildcard.

Returns: Mask for that layer.

Definition at line 663 of file translation.cpp.

Referenced by get_mask_(), and has_wildcard().

static t_terrain t_translation::get_mask_ ( const t_terrain & terrain )

static

Gets a mask for a terrain, this mask is used for wildcard matching.

Parameters

terrain The terrain which might have a wildcard.

Returns: The mask for this terrain.

Definition at line 688 of file translation.cpp.

References t_translation::t_terrain::base, get_layer_mask_(), NO_LAYER, and t_translation::t_terrain::overlay.

Referenced by t_translation::t_match::t_match(), and terrain_matches().

bool t_translation::has_wildcard ( const t_terrain & tcode )

Tests whether a terrain code contains a wildcard.

Parameters

tcode the terrain code to test for a wildcard

Returns: true if wildcard found, else false

Definition at line 561 of file translation.cpp.

References t_translation::t_terrain::base, get_layer_mask_(), NO_LAYER, and t_translation::t_terrain::overlay.

Referenced by has_wildcard(), and terrain_matches().

bool t_translation::has_wildcard ( const t_list & list )

Tests whether a terrain-code list contains at least one item with a wildcard.

Parameters

list	the list to test for a wildcard

Returns: true if a wildcard found, else false

Definition at line 570 of file translation.cpp.

References has_wildcard(), and itor.

size_t t_translation::max_map_size ( )

Return the maximum allowed map size (in either dimension), the maximum map area is, therefore, this value squared.

Definition at line 36 of file translation.cpp.

Referenced by read_game_map().

static std::string t_translation::number_to_string_	(	t_terrain	terrain,
		const std::string &	start_position = `""`
	)

static

Converts a terrain number to a string.

Parameters

terrain	The terrain number to convert.
start_position	The starting position, if smaller than 0 it's ignored else it's written.

Returns: The converted string, if no starting position given it's padded to 4 chars else padded to 7 chars.

Definition at line 777 of file translation.cpp.

References t_translation::t_terrain::base, i, NO_LAYER, and t_translation::t_terrain::overlay.

Referenced by write_game_map(), write_list(), and write_terrain_code().

bool t_translation::operator!=	(	const t_terrain &	a,
		const t_terrain &	b
	)

inline

Definition at line 64 of file translation.hpp.

References t_translation::t_terrain::base, and t_translation::t_terrain::overlay.

t_terrain t_translation::operator&	(	const t_terrain &	a,
		const t_terrain &	b
	)

inline

Definition at line 67 of file translation.hpp.

References t_translation::t_terrain::base, and t_translation::t_terrain::overlay.

bool t_translation::operator<	(	const t_terrain &	a,
		const t_terrain &	b
	)

inline

Definition at line 58 of file translation.hpp.

References t_translation::t_terrain::base, and t_translation::t_terrain::overlay.

std::ostream& t_translation::operator<<	(	std::ostream &	s,
		const t_terrain &	a
	)

inline

Definition at line 182 of file translation.hpp.

References write_terrain_code().

bool t_translation::operator==	(	const t_terrain &	a,
		const t_terrain &	b
	)

inline

Definition at line 61 of file translation.hpp.

References t_translation::t_terrain::base, and t_translation::t_terrain::overlay.

t_terrain t_translation::operator\|	(	const t_terrain &	a,
		const t_terrain &	b
	)

inline

Definition at line 70 of file translation.hpp.

References t_translation::t_terrain::base, and t_translation::t_terrain::overlay.

t_map t_translation::read_builder_map ( const std::string & str )

Reads a builder map.

A builder map differs a great deal from a normal map, hence the different functions.

Parameters

str	The map data, a terrain letter is either a * or a . or a number as anchor. The star or dot are stored in the base part of the terrain and the anchor in the overlay part. If more letters are allowed as special case they will be stored in the base part. Anchor 0 is no anchor.

Returns: A 2D vector with the data found the vector data is stored like result[y][x] where x the column number is and y the row number.

Definition at line 588 of file translation.cpp.

References utils::isnewline(), string_to_builder_number_(), and gui2::terrain.

Referenced by terrain_builder::parse_mapstring().

t_map t_translation::read_game_map	(	const std::string &	str,
		tstarting_positions &	starting_positions,
		coordinate	border_offset = `coordinate{0, 0}`
	)

Reads a gamemap string into a 2D vector.

Parameters

str

A string containing the gamemap, the following rules are stated for a gamemap:

The map is square
The map can be prefixed with one or more empty lines, these lines are ignored
The map can be postfixed with one or more empty lines, these lines are ignored
Every end of line can be followed by one or more empty lines, these lines are ignored.

Deprecated:

NOTE it's deprecated to use this feature.

Terrain strings are separated by comma's or an end of line symbol, for the last terrain string in the row. For readability it's allowed to pad strings with either spaces or tab, however the tab is deprecated.

A terrain string contains either a terrain or a terrain and starting location. The following format is used [S ]T S = starting location a positive non-zero number T = terrain code (see read_terrain_code)

Parameters

starting_positions This parameter will be filled with the starting locations found. Starting locations can only occur once if multiple definitions occur of the same position only the last is stored. The returned value is a map:

first the starting locations
second a coordinate structure where the location was found

Returns: A 2D vector with the terrains found the vector data is stored like result[x][y] where x the column number is and y the row number.

Definition at line 273 of file translation.cpp.

References ERR_G, error(), utils::isnewline(), max_map_size(), NO_LAYER, string_to_number_(), gui2::terrain, WRN_G, t_translation::coordinate::x, and t_translation::coordinate::y.

Referenced by gamemap::read().

t_list t_translation::read_list	(	const std::string &	str,
		const t_layer	filler = `NO_LAYER`
	)

Reads a list of terrains from a string, when reading the.

Parameters

str	A string with one or more terrain codes (see read_terrain_code)
filler	If there's no layer, this value will be used as the second layer

Returns: A vector which contains the terrain codes found in the string

Definition at line 223 of file translation.cpp.

References string_to_number_(), and gui2::terrain.

Referenced by default_map_generator_job::default_generate_map(), preferences::manager::manager(), gamemap::overlay(), place_village(), placing_score(), and terrain_type::terrain_type().

t_terrain t_translation::read_terrain_code	(	const std::string &	str,
		const t_layer	filler = `NO_LAYER`
	)

Reads a single terrain from a string.

Parameters

str

The string which should contain 1 terrain code; the new format of a terrain code is 2 to 4 characters in the set

*               [a-Z][A-Z]/|\_
*

The underscore is intended for internal use. Other letters and characters are not validated but users of these letters can get nasty surprises. The * is used as wildcard in some cases. The terrain code can be two groups separated by a caret, the first group is the base terrain, the second the overlay terrain.

filler if there's no layer this value will be used as the second layer

Returns: A single terrain code

Definition at line 213 of file translation.cpp.

References string_to_number_().

Referenced by game_board::change_terrain(), editor::context_manager::create_default_context(), default_map_generator_job::default_generate_map(), game_lua_kernel::intf_get_terrain_info(), intf_unit_defense(), intf_unit_jamming_cost(), intf_unit_movement_cost(), and intf_unit_vision_cost().

static t_terrain t_translation::string_to_builder_number_ ( std::string str )

static

Converts a terrain string to a number for the builder.

The translation rules differ from the normal conversion rules

Parameters

str	The terrain string.

Returns: Number for the builder map.

Definition at line 823 of file translation.cpp.

References lexical_cast_default(), and schema_validation::number.

Referenced by read_builder_map().

static t_layer t_translation::string_to_layer_	(	const char *	begin,
		const char *	end
	)

static

Converts a string to a layer.

Parameters

str	The terrain string to convert, but needs to be sanitized so no spaces and only the terrain to convert.

Returns: The converted layer.

Definition at line 697 of file translation.cpp.

References _(), c, i, NO_LAYER, and VALIDATE.

Referenced by string_to_layer_(), and string_to_number_().

static t_layer t_translation::string_to_layer_ ( const std::string & str )

static

Definition at line 74 of file translation.cpp.

References string_to_layer_().

static t_terrain t_translation::string_to_number_	(	std::string	str,
		std::string &	start_position,
		const t_layer	filler
	)

static

Converts a terrain string to a number.

Parameters

str	The terrain string with an optional number.
start_position	Returns the start_position, the caller should set it on -1 and it's only changed it there is a starting position found.
filler	If the terrain has only 1 layer then the filler will be used as the second layer.

Returns: The terrain code found in the string if no valid terrain is found VOID will be returned.

Definition at line 732 of file translation.cpp.

References t_translation::t_terrain::base, NO_LAYER, t_translation::t_terrain::overlay, string_to_layer_(), VOID_TERRAIN, and WILDCARD.

Referenced by read_game_map(), read_list(), read_terrain_code(), and string_to_number_().

static t_terrain t_translation::string_to_number_	(	const std::string &	str,
		const t_layer	filler = `NO_LAYER`
	)

static

Definition at line 727 of file translation.cpp.

References string_to_number_().

bool t_translation::terrain_matches	(	const t_terrain &	src,
		const t_terrain &	dest
	)

Tests whether a specific terrain matches an expression, for matching rules see above.

Parameters

src	the value to match (may not contain wildcards)
dest	the expression to match against

Returns: the result of the match (depending on the !'s)

Definition at line 408 of file translation.cpp.

Referenced by default_map_generator_job::default_generate_map(), flood_name(), terrain_filter::match_internal(), unit_animation::matches(), gamemap::overlay(), and terrain_builder::terrain_matches().

bool t_translation::terrain_matches	(	const t_terrain &	src,
		const t_list &	dest
	)

Tests whether a specific terrain matches a list of expressions.

The list can use wildcard matching with *. It also has an inversion function. When a ! is found the result of the match is inverted. The matching stops at the first match (regardless of the ! found) the data is match from start to end.

Example: Ww, W* does match and returns true Ww, {!, W*} does match and returns false (due to the !) WW, Ww doesn't match and return false

Multilayer rules: If a terrain has multiple layers, each layer will be matched separately, returning true only if both layers match.

Example: A*^* matches Abcd but also Abcd^Abcd A*^ matches Abcd but not Abcd^Abcd A*^Abcd does not match Abcd but matches Abcd^Abcd

Note: If an expression doesn't specify a second layer (i.e. it contains no caret) the second layer will be filled in with a default value (See read_terrain_code and read_list).

In the terrain building code, the second layer will default to the wildcard, so both A* and A*^* will match Abcd^Abcd

Parameters

src	the value to match (may not contain wildcards)
dest	the list of expressions to match against

Returns: the result of the match (depending on the !'s)

Definition at line 413 of file translation.cpp.

References t_translation::t_terrain::base, get_mask_(), has_wildcard(), itor, and t_translation::t_terrain::overlay.

bool t_translation::terrain_matches	(	const t_terrain &	src,
		const t_match &	dest
	)

Tests whether a certain terrain matches a list of expressions, for matching rules see above.

The matching requires some bit mask which impose a certain overhead. This version uses a cache to cache the masks so if a list needs to be matched often this version is preferred.

Parameters

src	the value to match (may not contain wildcards)
dest	the cached list of expressions to match against

Returns: the result of the match (depending on the !'s)

Definition at line 496 of file translation.cpp.

References t_translation::t_terrain::base, t_translation::t_match::has_wildcard, i, t_translation::t_match::is_empty, t_translation::t_match::mask, t_translation::t_match::masked_terrain, t_translation::t_terrain::overlay, and t_translation::t_match::terrain.

std::string t_translation::write_game_map	(	const t_map &	map,
		const tstarting_positions &	starting_positions = `tstarting_positions()`,
		coordinate	border_offset = `coordinate{0, 0}`
	)

Write a gamemap in to a vector string.

Parameters

map	A terrain vector, as returned from read_game_map
starting_positions	A starting positions map, as returned from read_game_map

Returns: A terrain string which can be read with read_game_map. For readability the map is padded to groups of 12 chars, followed by a comma and space.

Definition at line 378 of file translation.cpp.

References itor, number_to_string_(), t_translation::coordinate::x, and t_translation::coordinate::y.

Referenced by cave_map_generator::cave_map_generator_job::cave_map_generator_job(), output_map(), and gamemap::write().

std::string t_translation::write_list ( const t_list & list )

Writes a list of terrains to a string, only writes the new format.

Parameters