cargotype.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#include "stdafx.h"
#include "cargotype.h"
#include "core/geometry_func.hpp"
#include "newgrf_cargo.h"
#include "string_func.h"
#include "strings_func.h"
#include "settings_type.h"
 
#include "table/sprites.h"
#include "table/strings.h"
#include "table/cargo_const.h"
 
#include "safeguards.h"
 
CargoSpec CargoSpec::array[NUM_CARGO];

CargoTypes _cargo_mask;

CargoTypes _standard_cargo_mask;

static std::vector<CargoLabel> _default_cargo_labels;

static std::array<CargoLabel, 12> _climate_dependent_cargo_labels;

static std::array<CargoLabel, 32> _climate_independent_cargo_labels;

void SetupCargoForClimate(LandscapeType l)
{
  assert(to_underlying(l) < std::size(_default_climate_cargo));
 
  _cargo_mask = 0;
  _default_cargo_labels.clear();
  _climate_dependent_cargo_labels.fill(CT_INVALID);
  _climate_independent_cargo_labels.fill(CT_INVALID);
 
  /* Copy from default cargo by label or index. */
  auto insert = std::begin(CargoSpec::array);
  for (const auto &cl : _default_climate_cargo[to_underlying(l)]) {
 
    struct visitor {
      const CargoSpec &operator()(const int &index)
      {
        /* Copy the default cargo by index. */
        return _default_cargo[index];
      }
      const CargoSpec &operator()(const CargoLabel &label)
      {
        /* Search for label in default cargo types and copy if found. */
        auto found = std::ranges::find(_default_cargo, label, &CargoSpec::label);
        if (found != std::end(_default_cargo)) return *found;
 
        /* Index or label is invalid, this should not happen. */
        NOT_REACHED();
      }
    };
 
    *insert = std::visit(visitor{}, cl);
 
    if (insert->IsValid()) {
      SetBit(_cargo_mask, insert->Index());
      _default_cargo_labels.push_back(insert->label);
      _climate_dependent_cargo_labels[insert->Index()] = insert->label;
      _climate_independent_cargo_labels[insert->bitnum] = insert->label;
    }
    ++insert;
  }
 
  /* Reset and disable remaining cargo types. */
  std::fill(insert, std::end(CargoSpec::array), CargoSpec{});
 
  BuildCargoLabelMap();
}

std::span<const CargoLabel> GetClimateDependentCargoTranslationTable()
{
  return _climate_dependent_cargo_labels;
}

std::span<const CargoLabel> GetClimateIndependentCargoTranslationTable()
{
  return _climate_independent_cargo_labels;
}

void BuildCargoLabelMap()
{
  CargoSpec::label_map.clear();
  for (const CargoSpec &cs : CargoSpec::array) {
    /* During initialization, CargoSpec can be marked valid before the label has been set. */
    if (!cs.IsValid() || cs.label == CargoLabel{} || cs.label == CT_INVALID) continue;
    /* Label already exists, don't add again. */
    if (CargoSpec::label_map.count(cs.label) != 0) continue;
 
    CargoSpec::label_map.emplace(cs.label, cs.Index());
  }
}

bool IsDefaultCargo(CargoType cargo_type)
{
  auto cs = CargoSpec::Get(cargo_type);
  if (!cs->IsValid()) return false;
 
  CargoLabel label = cs->label;
  return std::any_of(std::begin(_default_cargo_labels), std::end(_default_cargo_labels), [&label](const CargoLabel &cl) { return cl == label; });
}

Dimension GetLargestCargoIconSize()
{
  Dimension size = {0, 0};
  for (const CargoSpec *cs : _sorted_cargo_specs) {
    size = maxdim(size, GetSpriteSize(cs->GetCargoIcon()));
  }
  return size;
}

SpriteID CargoSpec::GetCargoIcon() const
{
  SpriteID sprite = this->sprite;
  if (sprite == 0xFFFF) {
    /* A value of 0xFFFF indicates we should draw a custom icon */
    sprite = GetCustomCargoSprite(this);
  }
 
  if (sprite == 0) sprite = SPR_CARGO_GOODS;
 
  return sprite;
}
 
std::array<uint8_t, NUM_CARGO> _sorted_cargo_types; 
std::vector<const CargoSpec *> _sorted_cargo_specs;   
std::span<const CargoSpec *> _sorted_standard_cargo_specs; 

static bool CargoSpecNameSorter(const CargoSpec * const &a, const CargoSpec * const &b)
{
  std::string a_name = GetString(a->name);
  std::string b_name = GetString(b->name);
 
  int res = StrNaturalCompare(a_name, b_name); // Sort by name (natural sorting).
 
  /* If the names are equal, sort by cargo bitnum. */
  return (res != 0) ? res < 0 : (a->bitnum < b->bitnum);
}

static bool CargoSpecClassSorter(const CargoSpec * const &a, const CargoSpec * const &b)
{
  int res = b->classes.Test(CargoClass::Passengers) - a->classes.Test(CargoClass::Passengers);
  if (res == 0) {
    res = b->classes.Test(CargoClass::Mail) - a->classes.Test(CargoClass::Mail);
    if (res == 0) {
      res = a->classes.Test(CargoClass::Special) - b->classes.Test(CargoClass::Special);
      if (res == 0) {
        return CargoSpecNameSorter(a, b);
      }
    }
  }
 
  return res < 0;
}

void InitializeSortedCargoSpecs()
{
  for (auto &tpc : CargoSpec::town_production_cargoes) tpc.clear();
  _sorted_cargo_specs.clear();
  /* Add each cargo spec to the list, and determine the largest cargo icon size. */
  for (const CargoSpec *cargo : CargoSpec::Iterate()) {
    _sorted_cargo_specs.push_back(cargo);
  }
 
  /* Sort cargo specifications by cargo class and name. */
  std::sort(_sorted_cargo_specs.begin(), _sorted_cargo_specs.end(), &CargoSpecClassSorter);
 
  /* Populate */
  for (auto it = std::begin(_sorted_cargo_specs); it != std::end(_sorted_cargo_specs); ++it) {
    _sorted_cargo_types[(*it)->Index()] = static_cast<uint8_t>(it - std::begin(_sorted_cargo_specs));
  }
 
  /* Count the number of standard cargos and fill the mask. */
  _standard_cargo_mask = 0;
  uint8_t nb_standard_cargo = 0;
  for (const auto &cargo : _sorted_cargo_specs) {
    assert(cargo->town_production_effect != TownProductionEffect::Invalid);
    CargoSpec::town_production_cargoes[cargo->town_production_effect].push_back(cargo);
    if (cargo->classes.Test(CargoClass::Special)) break;
    nb_standard_cargo++;
    SetBit(_standard_cargo_mask, cargo->Index());
  }
 
  /* _sorted_standard_cargo_specs is a subset of _sorted_cargo_specs. */
  _sorted_standard_cargo_specs = { _sorted_cargo_specs.data(), nb_standard_cargo };
}
 
uint64_t CargoSpec::WeightOfNUnitsInTrain(uint32_t n) const
{
  if (this->is_freight) n *= _settings_game.vehicle.freight_trains;
  return this->WeightOfNUnits(n);
}

std::optional<std::string> BuildCargoAcceptanceString(const CargoArray &acceptance, StringID label)
{
  std::string_view list_separator = GetListSeparator();
 
  std::stringstream line;
 
  bool found = false;
  for (const CargoSpec *cs : _sorted_cargo_specs) {
    CargoType cargo_type = cs->Index();
    if (acceptance[cargo_type] > 0) {
      /* Add a comma between each item. */
      if (found) line << list_separator;
      found = true;
 
      /* If the accepted value is less than 8, show it in 1/8:ths */
      if (acceptance[cargo_type] < 8) {
        line << GetString(STR_LAND_AREA_INFORMATION_CARGO_EIGHTS, acceptance[cargo_type], cs->name);
      } else {
        line << GetString(cs->name);
      }
    }
  }
 
  if (found) return GetString(label, line.str());
 
  return std::nullopt;
}