The Battle for Wesnoth  1.19.8+dev
race.cpp
Go to the documentation of this file.
1 /*
2  Copyright (C) 2003 - 2024
3  by David White <dave@whitevine.net>
4  Part of the Battle for Wesnoth Project https://www.wesnoth.org/
5 
6  This program is free software; you can redistribute it and/or modify
7  it under the terms of the GNU General Public License as published by
8  the Free Software Foundation; either version 2 of the License, or
9  (at your option) any later version.
10  This program is distributed in the hope that it will be useful,
11  but WITHOUT ANY WARRANTY.
12 
13  See the COPYING file for more details.
14 */
15 
16 /**
17  * @file
18  * Generate race-specific unit-names.
19  */
20 
21 #include "units/race.hpp"
22 
23 #include "filesystem.hpp"
24 #include "log.hpp"
25 #include "utils/name_generator.hpp"
27 
28 static lg::log_domain log_wml("wml");
29 #define ERR_WML LOG_STREAM(err, log_wml)
30 
31 /** Dummy race used when a race is not yet known. */
33 /** Standard string id (not translatable) for FEMALE */
34 const std::string unit_race::s_female("female");
35 /** Standard string id (not translatable) for MALE */
36 const std::string unit_race::s_male("male");
37 
38 static const config& empty_traits() {
39  static config cfg;
40  return cfg;
41 }
42 
43 static const config& empty_topics() {
44  static config cfg;
45  return cfg;
46 }
47 
49  : cfg_()
50  , id_()
51  , name_()
52  , plural_name_()
53  , description_()
54  , ntraits_(0)
55  , traits_(empty_traits().child_range("trait"))
56  , topics_(empty_topics().child_range("topic"))
57  , global_traits_(true)
58  , undead_variation_()
59  , help_taxonomy_()
60 {
61  for(auto& generator : name_generator_) {
62  generator.reset(new name_generator());
63  }
64 }
65 
67  : cfg_(cfg)
68  , id_(cfg["id"])
69  , icon_(cfg["editor_icon"])
70  , plural_name_(cfg["plural_name"].t_str())
71  , description_(cfg["description"].t_str())
72  , ntraits_(cfg["num_traits"].to_int())
73  , traits_(cfg.child_range("trait"))
74  , topics_(cfg.child_range("topic"))
75  , global_traits_(!cfg["ignore_global_traits"].to_bool())
76  , undead_variation_(cfg["undead_variation"])
77  , help_taxonomy_(cfg["help_taxonomy"])
78 {
79  if (plural_name_.empty()) {
80  lg::log_to_chat() << "[race] id='" << id_ << "' is missing a plural_name field.\n";
81  ERR_WML << "[race] id='" << id_ << "' is missing a plural_name field.";
82  plural_name_ = (cfg["name"]);
83  }
84 
85  // use "name" if "male_name" or "female_name" aren't available
86  name_[MALE] = cfg["male_name"];
87  if(name_[MALE].empty()) {
88  name_[MALE] = (cfg["name"]);
89  }
90  name_[FEMALE] = cfg["female_name"];
91  if(name_[FEMALE].empty()) {
92  name_[FEMALE] = (cfg["name"]);
93  }
94  if(std::any_of(name_.begin(), name_.end(), [](const auto& n) { return n.empty(); })) {
96  << "[race] id='" << id_
97  << "' is missing a singular name field (either 'name' or both 'male_name' and 'female_name').\n";
98  ERR_WML << "[race] id'" << id_
99  << "' is missing a singular name field (either 'name' or both 'male_name' and 'female_name').";
100  }
101 
102  name_generator_factory generator_factory = name_generator_factory(cfg, {"male", "female"});
103 
104  for(int i=MALE; i<NUM_GENDERS; i++) {
105  GENDER gender = static_cast<GENDER>(i);
106  name_generator_[i] = generator_factory.get_name_generator(gender_string(gender));
107  }
108 }
109 
111 {
112  return name_generator_[gender]->generate();
113 }
114 
116 {
117  return *name_generator_[gender];
118 }
119 
121 {
122  return global_traits_;
123 }
124 
126 {
127  return traits_;
128 }
129 
131 {
132  return topics_;
133 }
134 
135 unsigned int unit_race::num_traits() const { return ntraits_; }
136 
137 
138 const std::string& gender_string(unit_race::GENDER gender) {
139  switch(gender) {
140  case unit_race::FEMALE:
141  return unit_race::s_female;
142  default:
143  return unit_race::s_male;
144  }
145 }
146 
147 unit_race::GENDER string_gender(const std::string& str, unit_race::GENDER def) {
148  if ( str == unit_race::s_male ) {
149  return unit_race::MALE;
150  } else if ( str == unit_race::s_female ) {
151  return unit_race::FEMALE;
152  }
153  return def;
154 }
155 
157  const config& cfg, unit_race::GENDER gender, const std::string& male_key,
158  const std::string& female_key, const std::string& default_key)
159 {
160  return cfg.get_or(gender == unit_race::MALE ? male_key : female_key, default_key);
161 }
162 
163 std::string unit_race::get_icon_path_stem() const
164 {
165  if(!icon_.empty()) {
166  return icon_;
167  }
168 
169  std::string path = "icons/unit-groups/race_" + id_;
170 
171  // FIXME: hardcoded '30' is bad...
172  if(!filesystem::get_binary_file_location("images", path + "_30.png")) {
173  path = "icons/unit-groups/race_custom";
174  }
175 
176  return path;
177 }
Variant for storing WML attributes.
A config object defines a single node in a WML file, with access to child nodes.
Definition: config.hpp:158
const attribute_value & get_or(const config_key_type key, const config_key_type default_key) const
Chooses a value.
Definition: config.cpp:687
boost::iterator_range< const_child_iterator > const_child_itors
Definition: config.hpp:282
std::shared_ptr< name_generator > get_name_generator()
Gets the default name generator.
bool empty() const
Definition: tstring.hpp:195
bool global_traits_
Definition: race.hpp:87
bool uses_global_traits() const
Definition: race.cpp:120
std::string get_icon_path_stem() const
Gets this race's icon path without state/size suffix and extension.
Definition: race.cpp:163
std::string icon_
Definition: race.hpp:78
static const unit_race null_race
Dummy race used when a race is not yet known.
Definition: race.hpp:69
const config::const_child_itors & additional_topics() const
Definition: race.cpp:130
config::const_child_itors topics_
Definition: race.hpp:86
std::string generate_name(GENDER gender) const
Definition: race.cpp:110
unit_race()
Only used to construct null_race.
Definition: race.cpp:48
std::array< std::shared_ptr< name_generator >, NUM_GENDERS > name_generator_
Definition: race.hpp:83
unsigned int num_traits() const
Definition: race.cpp:135
unsigned int ntraits_
Definition: race.hpp:82
std::array< t_string, NUM_GENDERS > name_
Definition: race.hpp:79
std::string id_
Definition: race.hpp:77
config::const_child_itors traits_
Definition: race.hpp:85
const config::const_child_itors & additional_traits() const
Definition: race.cpp:125
static const std::string s_female
Standard string id (not translatable) for FEMALE.
Definition: race.hpp:29
static const std::string s_male
Standard string id (not translatable) for MALE.
Definition: race.hpp:30
t_string plural_name_
Definition: race.hpp:80
const name_generator & generator(GENDER gender) const
Definition: race.cpp:115
@ NUM_GENDERS
Definition: race.hpp:28
@ FEMALE
Definition: race.hpp:28
@ MALE
Definition: race.hpp:28
Declarations for File-IO.
std::size_t i
Definition: function.cpp:1029
Standard logging facilities (interface).
utils::optional< std::string > get_binary_file_location(const std::string &type, const std::string &filename)
Returns a complete path to the actual file of a given type, if it exists.
std::string path
Definition: filesystem.cpp:92
std::stringstream & log_to_chat()
Use this to show WML errors in the ingame chat.
Definition: log.cpp:520
const std::string & gender_string(unit_race::GENDER gender)
Definition: race.cpp:138
static const config & empty_traits()
Definition: race.cpp:38
#define ERR_WML
Definition: race.cpp:29
static const config & empty_topics()
Definition: race.cpp:43
unit_race::GENDER string_gender(const std::string &str, unit_race::GENDER def)
Definition: race.cpp:147
const config::attribute_value & gender_value(const config &cfg, unit_race::GENDER gender, const std::string &male_key, const std::string &female_key, const std::string &default_key)
Chooses a value from the given config based on gender.
Definition: race.cpp:156
static lg::log_domain log_wml("wml")
static map_location::direction n