newgrf_class.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 <https://www.gnu.org/licenses/old-licenses/gpl-2.0>.
 */

 
#ifndef NEWGRF_CLASS_H
#define NEWGRF_CLASS_H
 
#include "strings_type.h"
 
/* Base for each type of NewGRF spec to be used with NewGRFClass. */
template <typename Tindex>
struct NewGRFSpecBase {
  Tindex class_index; 
  uint16_t index; 
};

template <typename Tspec, typename Tindex, Tindex Tmax>
class NewGRFClass {
private:
  /* Tspec must be of NewGRFSpecBase<Tindex>. */
  static_assert(std::is_base_of_v<NewGRFSpecBase<Tindex>, Tspec>);
 
  uint ui_count = 0; 
  Tindex index = static_cast<Tindex>(0); 
  std::vector<Tspec *> spec; 

  static inline std::vector<NewGRFClass<Tspec, Tindex, Tmax>> classes;

  static void InsertDefaults();
 
public:
  using spec_type = Tspec;
  using index_type = Tindex;
 
  uint32_t global_id; 
  StringID name;    
 
  /* Public constructor as emplace_back needs access. */
  NewGRFClass(uint32_t global_id, StringID name) : global_id(global_id), name(name) { }

  std::span<Tspec * const> Specs() const { return this->spec; }

  static std::span<NewGRFClass<Tspec, Tindex, Tmax> const> Classes() { return NewGRFClass::classes; }
 
  void Insert(Tspec *spec);
 
  Tindex Index() const { return this->index; }
  uint GetSpecCount() const { return static_cast<uint>(this->spec.size()); }
  uint GetUISpecCount() const { return this->ui_count; }
 
  const Tspec *GetSpec(uint index) const;

  bool IsUIAvailable(uint index) const;
 
  static void Reset();
  static Tindex Allocate(uint32_t global_id);
  static void Assign(Tspec *spec);
  static uint GetClassCount();
  static uint GetUIClassCount();
  static NewGRFClass *Get(Tindex class_index);
 
  static const Tspec *GetByGrf(uint32_t grfid, uint16_t local_id);
};
 
#endif /* NEWGRF_CLASS_H */