translation.hpp

Go to the documentation of this file.

/*
    Copyright (C) 2006 - 2022
    by Mark de Wever <koraq@xs4all.nl>
    Part of the Battle for Wesnoth Project https://www.wesnoth.org/

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU General Public License as published by
    the Free Software Foundation; either version 2 of the License, or
    (at your option) any later version.
    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY.

    See the COPYING file for more details.
*/

#pragma once

#include <vector>
#include <map>
#include <cstdint>
#include <boost/bimap.hpp>
#include <boost/bimap/set_of.hpp>
#include <boost/bimap/multiset_of.hpp>

#include "exceptions.hpp"
#include "map/location.hpp"

#include <string_view>

namespace t_translation {

    /**
     * Return the maximum allowed map size (in either dimension),
     * the maximum map area is, therefore, this value squared.
     */
    int max_map_size();

    typedef uint32_t ter_layer;
    const ter_layer WILDCARD = 0x2A000000;
    const ter_layer NO_LAYER = 0xFFFFFFFF;

    // The definitions for a 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.
     */
    struct terrain_code {
        terrain_code(const std::string& b, const std::string& o);
        explicit terrain_code(const std::string& b, ter_layer o = NO_LAYER);
        terrain_code(ter_layer b, ter_layer o) : base(b), overlay(o) {}
        terrain_code() : base(0), overlay(NO_LAYER) {}

        ter_layer base;
        ter_layer overlay;
    };
    const terrain_code NONE_TERRAIN = terrain_code();

    inline bool operator<(const terrain_code& a, const terrain_code& b)
        { return std::tie(a.base, a.overlay) < std::tie(b.base, b.overlay); };

    inline bool operator==(const terrain_code& a, const terrain_code& b)
        { return a.base == b.base && a.overlay == b.overlay; }

    inline bool operator!=(const terrain_code& a, const terrain_code& b)
        { return a.base != b.base || a.overlay != b.overlay; }

    inline terrain_code operator&(const terrain_code& a, const terrain_code& b)
        { return terrain_code(a.base & b.base, a.overlay & b.overlay); }

    inline terrain_code operator|(const terrain_code& a, const terrain_code& b)
        { return terrain_code(a.base | b.base, a.overlay | b.overlay); }

    // operator<< is defined later

    typedef std::vector<terrain_code> ter_list;
    struct ter_map {

        ter_map() = default;
        ter_map(const ter_map&) = default;
        ter_map(ter_map&&) = default;

        ter_map(int w, int h, terrain_code fill = terrain_code()) : data(w * h, fill), w(w), h(h) {}

        ter_map & operator= (const ter_map &) = default;
        ter_map & operator= (ter_map &&) = default;

        terrain_code& get(int x, int y) { std::size_t index = x * h + y; return data.at(index); }
        const terrain_code& get(int x, int y) const { std::size_t index = x * h + y; return data.at(index); }

        std::vector<terrain_code> data;
        int w;
        int h;
        std::vector<terrain_code>::iterator operator[](int x) { return data.begin() + h * x; }
        std::vector<terrain_code>::const_iterator operator[](int x) const { return data.begin() + h * x; }
    };

    /**
     * This structure can be used for matching terrain strings.
     * It optimized for strings that need to be matched often,
     * and caches the wildcard info required for matching.
     */
    struct ter_match{
        ter_match();
        ter_match(std::string_view str, const ter_layer filler = NO_LAYER);
        ter_match(const terrain_code& tcode);

        ter_list terrain;
        ter_list mask;
        ter_list masked_terrain;
        bool has_wildcard;
        bool is_empty;
    };

    /**  Contains an x and y coordinate used for starting positions in maps. */
    using coordinate = map_location;

    // Exception thrown if there's an error with the terrain.
    // Note: atm most thrown result in a crash, but I like
    // an uncatched exception better than an assert.
    struct error : public game::error {
        error(const std::string& message) : game::error(message) {}
    };

    // Some types of terrain which must be known, and can't just
    // be loaded in dynamically because they're special.
    // It's asserted that there will be corresponding entries for
    // these types of terrain in the terrain configuration file.
    extern const terrain_code VOID_TERRAIN;
    extern const terrain_code FOGGED;

    // On the map the user can use this type to make odd shaped maps look good.
    extern const terrain_code OFF_MAP_USER;

    extern const terrain_code HUMAN_CASTLE;
    extern const terrain_code HUMAN_KEEP;
    extern const terrain_code SHALLOW_WATER;
    extern const terrain_code DEEP_WATER;
    extern const terrain_code GRASS_LAND;
    extern const terrain_code FOREST;
    extern const terrain_code MOUNTAIN;
    extern const terrain_code HILL;

    extern const terrain_code CAVE_WALL;
    extern const terrain_code CAVE;
    extern const terrain_code UNDERGROUND_VILLAGE;
    extern const terrain_code DWARVEN_CASTLE;
    extern const terrain_code DWARVEN_KEEP;

    extern const terrain_code PLUS; // +
    extern const terrain_code MINUS;    // -
    extern const terrain_code NOT;      // !
    extern const terrain_code STAR; // *
    extern const terrain_code BASE; // references the base terrain in movement/defense aliases

    extern const ter_match ALL_OFF_MAP;
    extern const ter_match ALL_FORESTS;
    extern const ter_match ALL_HILLS;
    extern const ter_match ALL_MOUNTAINS; //excluding impassable mountains
    extern const ter_match ALL_SWAMPS;

    /**
     * Reads a single terrain from a string.
     *
     * @param str       The string which should contain 1 terrain code;
     *                  the new format of a terrain code
     *                  is 2 to 4 characters in the set
     *@verbatim
     *                  [a-Z][A-Z]/|\_
     *@endverbatim
     *                  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.
     *
     * @param filler    if there's no layer this value will be used as the second layer
     *
     * @return          A single terrain code
     */
    terrain_code read_terrain_code(std::string_view str, const ter_layer filler = NO_LAYER);

    /**
     * Writes a single terrain code to a string.
     * The writers only support the new format.
     *
     * @param tcode The terrain code to convert to a string
     *
     * @return      A string containing the terrain code
     */
    std::string write_terrain_code(const terrain_code& tcode);
    inline std::ostream &operator<<(std::ostream &s, const terrain_code &a)
        { s << write_terrain_code(a); return s; }

    /**
     * Reads a list of terrains from a string, when reading the
     *
     * @param str       A string with one or more terrain codes (see read_terrain_code)
     * @param 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
     */
     ter_list read_list(std::string_view str, const ter_layer filler = NO_LAYER);

    /**
     * Writes a list of terrains to a string, only writes the new format.
     *
     * @param list      A vector with one or more terrain codes
     *
     * @returns     A string with the terrain codes, comma separated
     *          and a space behind the commas. Not padded.
     */
    std::string write_list(const ter_list& list);

    using starting_positions = boost::bimaps::bimap<boost::bimaps::set_of<std::string>, boost::bimaps::multiset_of<coordinate>>;
    /**
     * Reads a gamemap string into a 2D vector
     *
     * @param 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)
     * @param 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
     * @param border_offset
     *
     * @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.
     */
    ter_map read_game_map(std::string_view str, starting_positions& positions, coordinate border_offset = coordinate{ 0, 0 });

    /**
     * Write a gamemap in to a vector string.
     *
     * @param map                A terrain vector, as returned from read_game_map
     * @param positions A starting positions map, as returned from read_game_map
     * @param border_offset
     *
     * @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.
     */
    std::string write_game_map(const ter_map& map, const starting_positions& positions = starting_positions(), coordinate border_offset = coordinate{ 0, 0 });

    /**
     * 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
     *
     * @param src   the value to match (may not contain wildcards)
     * @param dest  the list of expressions to match against
     *
     * @returns     the result of the match (depending on the !'s)
     */
    bool terrain_matches(const terrain_code& src, const ter_list& dest);

    /**
     * Tests whether a specific terrain matches an expression,
     * for matching rules see above.
     *
     * @param src   the value to match (may not contain wildcards)
     * @param dest  the expression to match against
     *
     * @returns     the result of the match (depending on the !'s)
     */
    bool terrain_matches(const terrain_code& src, const terrain_code& 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.
     *
     * @param src   the value to match (may not contain wildcards)
     * @param dest  the cached list of expressions to match against
     *
     * @returns     the result of the match (depending on the !'s)
     */
    bool terrain_matches(const terrain_code& src, const ter_match& dest);

    /**
     * Tests whether a terrain code contains a wildcard
     *
     *  @param tcode    the terrain code to test for a wildcard
     *
     *  @returns        true if wildcard found, else false
     */
    bool has_wildcard(const terrain_code& tcode);

    /**
     * Tests whether a terrain-code list contains at least
     * one item with a wildcard
     *
     *  @param list     the list to test for a wildcard
     *
     *  @returns        true if a wildcard found, else false
     */
    bool has_wildcard(const ter_list& list);

    // These terrain letters are in the builder format,
    // and not usable in other parts of the engine
    const ter_layer TB_STAR = '*' << 24;    // It can be assumed this is the equivalent of STAR
    const ter_layer TB_DOT  = '.' << 24;

    /**
     * Reads a builder map.
     * A builder map differs a great deal from a normal map,
     * hence the different functions.
     *
     * @param 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.
     */
    ter_map read_builder_map(const std::string& str);

} // end namespace t_translation