newgrf_class_func.h

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 <http://www.gnu.org/licenses/>.
 */
 
#include "newgrf_class.h"
 
#include "table/strings.h"
 
#define DEFINE_NEWGRF_CLASS_METHOD(type) \
  template <typename Tspec, typename Tid, Tid Tmax> \
  type NewGRFClass<Tspec, Tid, Tmax>
 
template <typename Tspec, typename Tid, Tid Tmax>
NewGRFClass<Tspec, Tid, Tmax> NewGRFClass<Tspec, Tid, Tmax>::classes[Tmax];
 
DEFINE_NEWGRF_CLASS_METHOD(void)::ResetClass()
{
  this->global_id = 0;
  this->name      = STR_EMPTY;
  this->ui_count  = 0;
 
  this->spec.clear();
}
 
DEFINE_NEWGRF_CLASS_METHOD(void)::Reset()
{
  for (Tid i = (Tid)0; i < Tmax; i++) {
    classes[i].ResetClass();
  }
 
  InsertDefaults();
}
 
DEFINE_NEWGRF_CLASS_METHOD(Tid)::Allocate(uint32_t global_id)
{
  for (Tid i = (Tid)0; i < Tmax; i++) {
    if (classes[i].global_id == global_id) {
      /* ClassID is already allocated, so reuse it. */
      return i;
    } else if (classes[i].global_id == 0) {
      /* This class is empty, so allocate it to the global id. */
      classes[i].global_id = global_id;
      return i;
    }
  }
 
  GrfMsg(2, "ClassAllocate: already allocated {} classes, using default", Tmax);
  return (Tid)0;
}
 
DEFINE_NEWGRF_CLASS_METHOD(void)::Insert(Tspec *spec)
{
  this->spec.push_back(spec);
 
  if (this->IsUIAvailable(static_cast<uint>(this->spec.size() - 1))) this->ui_count++;
}
 
DEFINE_NEWGRF_CLASS_METHOD(void)::Assign(Tspec *spec)
{
  assert(spec->cls_id < Tmax);
  Get(spec->cls_id)->Insert(spec);
}
 
template <typename Tspec, typename Tid, Tid Tmax>
NewGRFClass<Tspec, Tid, Tmax> *NewGRFClass<Tspec, Tid, Tmax>::Get(Tid cls_id)
{
  assert(cls_id < Tmax);
  return classes + cls_id;
}
 
DEFINE_NEWGRF_CLASS_METHOD(uint)::GetClassCount()
{
  uint i;
  for (i = 0; i < Tmax && classes[i].global_id != 0; i++) {}
  return i;
}
 
DEFINE_NEWGRF_CLASS_METHOD(uint)::GetUIClassCount()
{
  uint cnt = 0;
  for (uint i = 0; i < Tmax && classes[i].global_id != 0; i++) {
    if (classes[i].GetUISpecCount() > 0) cnt++;
  }
  return cnt;
}
 
DEFINE_NEWGRF_CLASS_METHOD(Tid)::GetUIClass(uint index)
{
  for (uint i = 0; i < Tmax && classes[i].global_id != 0; i++) {
    if (classes[i].GetUISpecCount() == 0) continue;
    if (index-- == 0) return (Tid)i;
  }
  NOT_REACHED();
}
 
DEFINE_NEWGRF_CLASS_METHOD(const Tspec *)::GetSpec(uint index) const
{
  /* If the custom spec isn't defined any more, then the GRF file probably was not loaded. */
  return index < this->GetSpecCount() ? this->spec[index] : nullptr;
}
 
DEFINE_NEWGRF_CLASS_METHOD(int)::GetIndexFromUI(int ui_index) const
{
  if (ui_index < 0) return -1;
  for (uint i = 0; i < this->GetSpecCount(); i++) {
    if (!this->IsUIAvailable(i)) continue;
    if (ui_index-- == 0) return i;
  }
  return -1;
}
 
DEFINE_NEWGRF_CLASS_METHOD(int)::GetUIFromIndex(int index) const
{
  if ((uint)index >= this->GetSpecCount()) return -1;
  uint ui_index = 0;
  for (int i = 0; i < index; i++) {
    if (this->IsUIAvailable(i)) ui_index++;
  }
  return ui_index;
}
 
DEFINE_NEWGRF_CLASS_METHOD(const Tspec *)::GetByGrf(uint32_t grfid, uint16_t local_id, int *index)
{
  uint j;
 
  for (Tid i = (Tid)0; i < Tmax; i++) {
    uint count = static_cast<uint>(classes[i].spec.size());
    for (j = 0; j < count; j++) {
      const Tspec *spec = classes[i].spec[j];
      if (spec == nullptr) continue;
      if (spec->grf_prop.grffile->grfid == grfid && spec->grf_prop.local_id == local_id) {
        if (index != nullptr) *index = j;
        return spec;
      }
    }
  }
 
  return nullptr;
}
 
#undef DEFINE_NEWGRF_CLASS_METHOD
 
#define INSTANTIATE_NEWGRF_CLASS_METHODS(name, Tspec, Tid, Tmax) \
  template void name::ResetClass(); \
  template void name::Reset(); \
  template Tid name::Allocate(uint32_t global_id); \
  template void name::Insert(Tspec *spec); \
  template void name::Assign(Tspec *spec); \
  template NewGRFClass<Tspec, Tid, Tmax> *name::Get(Tid cls_id); \
  template uint name::GetClassCount(); \
  template uint name::GetUIClassCount(); \
  template Tid name::GetUIClass(uint index); \
  template const Tspec *name::GetSpec(uint index) const; \
  template int name::GetUIFromIndex(int index) const; \
  template int name::GetIndexFromUI(int ui_index) const; \
  template const Tspec *name::GetByGrf(uint32_t grfid, uint16_t local_id, int *index);