OpenTTD Source  20241108-master-g80f628063a
cargotype.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD 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, version 2.
4  * OpenTTD 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.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "stdafx.h"
11 #include "cargotype.h"
12 #include "core/geometry_func.hpp"
13 #include "newgrf_cargo.h"
14 #include "string_func.h"
15 #include "strings_func.h"
16 #include "settings_type.h"
17 
18 #include "table/sprites.h"
19 #include "table/strings.h"
20 #include "table/cargo_const.h"
21 
22 #include "safeguards.h"
23 
25 std::array<std::vector<const CargoSpec *>, NUM_TPE> CargoSpec::town_production_cargoes{};
26 
31 CargoTypes _cargo_mask;
32 
37 
42 static std::vector<CargoLabel> _default_cargo_labels;
43 
49 static std::array<CargoLabel, 12> _v7_cargo_labels;
50 
56 static std::array<CargoLabel, 32> _v8_cargo_labels;
57 
63 {
64  assert(l < lengthof(_default_climate_cargo));
65 
66  _cargo_mask = 0;
67  _default_cargo_labels.clear();
70 
71  /* Copy from default cargo by label or index. */
72  auto insert = std::begin(CargoSpec::array);
73  for (const auto &cl : _default_climate_cargo[l]) {
74 
75  /* Check if value is an index into the cargo table */
76  if (std::holds_alternative<int>(cl)) {
77  /* Copy the default cargo by index. */
78  *insert = _default_cargo[std::get<int>(cl)];
79  } else {
80  /* Search for label in default cargo types and copy if found. */
81  CargoLabel label = std::get<CargoLabel>(cl);
82  auto found = std::find_if(std::begin(_default_cargo), std::end(_default_cargo), [&label](const CargoSpec &cs) { return cs.label == label; });
83  if (found != std::end(_default_cargo)) {
84  *insert = *found;
85  } else {
86  /* Index or label is invalid, this should not happen. */
87  NOT_REACHED();
88  }
89  }
90 
91  if (insert->IsValid()) {
92  SetBit(_cargo_mask, insert->Index());
93  _default_cargo_labels.push_back(insert->label);
94  _v7_cargo_labels[insert->Index()] = insert->label;
95  _v8_cargo_labels[insert->bitnum] = insert->label;
96  }
97  ++insert;
98  }
99 
100  /* Reset and disable remaining cargo types. */
101  std::fill(insert, std::end(CargoSpec::array), CargoSpec{});
102 
104 }
105 
111 std::span<const CargoLabel> GetDefaultCargoTranslationTable(uint8_t grf_version)
112 {
113  if (grf_version < 8) return _v7_cargo_labels;
114  return _v8_cargo_labels;
115 }
116 
123 {
124  CargoSpec::label_map.clear();
125  for (const CargoSpec &cs : CargoSpec::array) {
126  /* During initialization, CargoSpec can be marked valid before the label has been set. */
127  if (!cs.IsValid() || cs.label == CargoLabel{0} || cs.label == CT_INVALID) continue;
128  /* Label already exists, don't addd again. */
129  if (CargoSpec::label_map.count(cs.label) != 0) continue;
130 
131  CargoSpec::label_map.emplace(cs.label, cs.Index());
132  }
133 }
134 
141 {
142  auto cs = CargoSpec::Get(cid);
143  if (!cs->IsValid()) return false;
144 
145  CargoLabel label = cs->label;
146  return std::any_of(std::begin(_default_cargo_labels), std::end(_default_cargo_labels), [&label](const CargoLabel &cl) { return cl == label; });
147 }
148 
154 {
155  Dimension size = {0, 0};
156  for (const CargoSpec *cs : _sorted_cargo_specs) {
157  size = maxdim(size, GetSpriteSize(cs->GetCargoIcon()));
158  }
159  return size;
160 }
161 
167 {
168  SpriteID sprite = this->sprite;
169  if (sprite == 0xFFFF) {
170  /* A value of 0xFFFF indicates we should draw a custom icon */
172  }
173 
174  if (sprite == 0) sprite = SPR_CARGO_GOODS;
175 
176  return sprite;
177 }
178 
179 std::array<uint8_t, NUM_CARGO> _sorted_cargo_types;
180 std::vector<const CargoSpec *> _sorted_cargo_specs;
181 std::span<const CargoSpec *> _sorted_standard_cargo_specs;
182 
184 static bool CargoSpecNameSorter(const CargoSpec * const &a, const CargoSpec * const &b)
185 {
186  std::string a_name = GetString(a->name);
187  std::string b_name = GetString(b->name);
188 
189  int res = StrNaturalCompare(a_name, b_name); // Sort by name (natural sorting).
190 
191  /* If the names are equal, sort by cargo bitnum. */
192  return (res != 0) ? res < 0 : (a->bitnum < b->bitnum);
193 }
194 
196 static bool CargoSpecClassSorter(const CargoSpec * const &a, const CargoSpec * const &b)
197 {
198  int res = (b->classes & CC_PASSENGERS) - (a->classes & CC_PASSENGERS);
199  if (res == 0) {
200  res = (b->classes & CC_MAIL) - (a->classes & CC_MAIL);
201  if (res == 0) {
202  res = (a->classes & CC_SPECIAL) - (b->classes & CC_SPECIAL);
203  if (res == 0) {
204  return CargoSpecNameSorter(a, b);
205  }
206  }
207  }
208 
209  return res < 0;
210 }
211 
214 {
215  for (auto &tpc : CargoSpec::town_production_cargoes) tpc.clear();
216  _sorted_cargo_specs.clear();
217  /* Add each cargo spec to the list, and determine the largest cargo icon size. */
218  for (const CargoSpec *cargo : CargoSpec::Iterate()) {
219  _sorted_cargo_specs.push_back(cargo);
220  }
221 
222  /* Sort cargo specifications by cargo class and name. */
224 
225  /* Populate */
226  for (auto it = std::begin(_sorted_cargo_specs); it != std::end(_sorted_cargo_specs); ++it) {
227  _sorted_cargo_types[(*it)->Index()] = static_cast<uint8_t>(it - std::begin(_sorted_cargo_specs));
228  }
229 
230  /* Count the number of standard cargos and fill the mask. */
232  uint8_t nb_standard_cargo = 0;
233  for (const auto &cargo : _sorted_cargo_specs) {
234  assert(cargo->town_production_effect != INVALID_TPE);
235  CargoSpec::town_production_cargoes[cargo->town_production_effect].push_back(cargo);
236  if (cargo->classes & CC_SPECIAL) break;
237  nb_standard_cargo++;
238  SetBit(_standard_cargo_mask, cargo->Index());
239  }
240 
241  /* _sorted_standard_cargo_specs is a subset of _sorted_cargo_specs. */
242  _sorted_standard_cargo_specs = { _sorted_cargo_specs.data(), nb_standard_cargo };
243 }
244 
245 uint64_t CargoSpec::WeightOfNUnitsInTrain(uint32_t n) const
246 {
248  return this->WeightOfNUnits(n);
249 }
constexpr T SetBit(T &x, const uint8_t y)
Set a bit in a variable.
Table of all default cargo types.
static const CargoSpec _default_cargo[]
Cargo types available by default.
Definition: cargo_const.h:52
static const std::variant< CargoLabel, int > _default_climate_cargo[NUM_LANDSCAPE][NUM_ORIGINAL_CARGO]
Table of cargo types available in each climate, by default.
Definition: cargo_const.h:99
static constexpr CargoLabel CT_INVALID
Invalid cargo type.
Definition: cargo_type.h:71
uint8_t CargoID
Cargo slots to indicate a cargo type within a game.
Definition: cargo_type.h:22
static const CargoID NUM_CARGO
Maximum number of cargo types in a game.
Definition: cargo_type.h:74
bool IsDefaultCargo(CargoID cid)
Test if a cargo is a default cargo type.
Definition: cargotype.cpp:140
static std::vector< CargoLabel > _default_cargo_labels
List of default cargo labels, used when setting up cargo types for default vehicles.
Definition: cargotype.cpp:42
std::array< uint8_t, NUM_CARGO > _sorted_cargo_types
Sort order of cargoes by cargo ID.
Definition: cargotype.cpp:179
static bool CargoSpecClassSorter(const CargoSpec *const &a, const CargoSpec *const &b)
Sort cargo specifications by their cargo class.
Definition: cargotype.cpp:196
Dimension GetLargestCargoIconSize()
Get dimensions of largest cargo icon.
Definition: cargotype.cpp:153
std::span< const CargoLabel > GetDefaultCargoTranslationTable(uint8_t grf_version)
Get default cargo translation table for a NewGRF, used if the NewGRF does not provide its own.
Definition: cargotype.cpp:111
std::span< const CargoSpec * > _sorted_standard_cargo_specs
Standard cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:181
CargoTypes _standard_cargo_mask
Bitmask of real cargo types available.
Definition: cargotype.cpp:36
void BuildCargoLabelMap()
Build cargo label map.
Definition: cargotype.cpp:122
static std::array< CargoLabel, 32 > _v8_cargo_labels
Default cargo translation for version 8+ NewGRFs.
Definition: cargotype.cpp:56
std::vector< const CargoSpec * > _sorted_cargo_specs
Cargo specifications sorted alphabetically by name.
Definition: cargotype.cpp:180
static bool CargoSpecNameSorter(const CargoSpec *const &a, const CargoSpec *const &b)
Sort cargo specifications by their name.
Definition: cargotype.cpp:184
void InitializeSortedCargoSpecs()
Initialize the list of sorted cargo specifications.
Definition: cargotype.cpp:213
void SetupCargoForClimate(LandscapeID l)
Set up the default cargo types for the given landscape type.
Definition: cargotype.cpp:62
static std::array< CargoLabel, 12 > _v7_cargo_labels
Default cargo translation for upto version 7 NewGRFs.
Definition: cargotype.cpp:49
CargoTypes _cargo_mask
Bitmask of cargo types available.
Definition: cargotype.cpp:31
Types/functions related to cargoes.
@ CC_MAIL
Mail.
Definition: cargotype.h:51
@ CC_PASSENGERS
Passengers.
Definition: cargotype.h:50
@ CC_SPECIAL
Special bit used for livery refit tricks instead of normal cargoes.
Definition: cargotype.h:60
@ INVALID_TPE
Invalid town production effect.
Definition: cargotype.h:44
Dimension maxdim(const Dimension &d1, const Dimension &d2)
Compute bounding box of both dimensions.
Geometry functions.
Dimension GetSpriteSize(SpriteID sprid, Point *offset, ZoomLevel zoom)
Get the size of a sprite.
Definition: gfx.cpp:922
uint32_t SpriteID
The number of a sprite, without mapping bits and colourtables.
Definition: gfx_type.h:18
uint8_t LandscapeID
Landscape type.
SpriteID GetCustomCargoSprite(const CargoSpec *cs)
Get the custom sprite for the given cargo type.
Cargo support for NewGRFs.
A number of safeguards to prevent using unsafe methods.
GameSettings _settings_game
Game settings of a running game or the scenario editor.
Definition: settings.cpp:57
Types related to global configuration settings.
This file contains all sprite-related enums and defines.
Definition of base types and functions in a cross-platform compatible way.
#define lengthof(array)
Return the length of an fixed size array.
Definition: stdafx.h:280
int StrNaturalCompare(std::string_view s1, std::string_view s2, bool ignore_garbage_at_front)
Compares two strings using case insensitive natural sort.
Definition: string.cpp:589
Functions related to low-level strings.
std::string GetString(StringID string)
Resolve the given StringID into a std::string with all the associated DParam lookups and formatting.
Definition: strings.cpp:319
Functions related to OTTD's strings.
Specification of a cargo type.
Definition: cargotype.h:71
CargoClasses classes
Classes of this cargo type.
Definition: cargotype.h:78
uint8_t bitnum
Cargo bit number, is INVALID_CARGO_BITNUM for a non-used spec.
Definition: cargotype.h:73
SpriteID GetCargoIcon() const
Get sprite for showing cargo of this type.
Definition: cargotype.cpp:166
SpriteID sprite
Icon to display this cargo type, may be 0xFFF (which means to resolve an action123 chain).
Definition: cargotype.h:94
bool is_freight
Cargo type is considered to be freight (affects train freight multiplier).
Definition: cargotype.h:82
CargoLabel label
Unique label of the cargo type.
Definition: cargotype.h:72
static IterateWrapper Iterate(size_t from=0)
Returns an iterable ensemble of all valid CargoSpec.
Definition: cargotype.h:190
static CargoSpec array[NUM_CARGO]
Array holding all CargoSpecs.
Definition: cargotype.h:196
static CargoSpec * Get(size_t index)
Retrieve cargo details for the given cargo ID.
Definition: cargotype.h:134
StringID name
Name of this type of cargo.
Definition: cargotype.h:88
static std::map< CargoLabel, CargoID > label_map
Translation map from CargoLabel to Cargo ID.
Definition: cargotype.h:197
static std::array< std::vector< const CargoSpec * >, NUM_TPE > town_production_cargoes
List of cargo specs for each Town Product Effect.
Definition: cargotype.h:193
Dimensions (a width and height) of a rectangle in 2D.
VehicleSettings vehicle
options for vehicles
uint8_t freight_trains
value to multiply the weight of cargo by