/* $Id$ */ /* * 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/>. */ /** @file newgrf_class_func.h Implementation of the NewGRF class' functions. */ #include "newgrf_class.h" #include "table/strings.h" /** * Helper for defining the class method's signatures. * @param type The type of the class. */ #define DEFINE_NEWGRF_CLASS_METHOD(type) \ template <typename Tspec, typename Tid, Tid Tmax> \ type NewGRFClass<Tspec, Tid, Tmax> /** Instantiate the array. */ template <typename Tspec, typename Tid, Tid Tmax> NewGRFClass<Tspec, Tid, Tmax> NewGRFClass<Tspec, Tid, Tmax>::classes[Tmax]; /** Reset the classes, i.e. clear everything. */ DEFINE_NEWGRF_CLASS_METHOD(void)::Reset() { for (Tid i = (Tid)0; i < Tmax; i++) { classes[i].global_id = 0; classes[i].name = STR_EMPTY; classes[i].count = 0; free(classes[i].spec); classes[i].spec = NULL; } InsertDefaults(); } /** * Allocate a class with a given global class ID. * @param cls_id The global class id, such as 'DFLT'. * @return The (non global!) class ID for the class. * @note Upon allocating the same global class ID for a * second time, this first allocation will be given. */ DEFINE_NEWGRF_CLASS_METHOD(Tid)::Allocate(uint32 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 %d classes, using default", Tmax); return (Tid)0; } /** * Set the name of a particular class. * @param cls_id The id for the class. * @pre index < GetCount(cls_id) * @param name The new name for the class. */ DEFINE_NEWGRF_CLASS_METHOD(void)::SetName(Tid cls_id, StringID name) { assert(cls_id < Tmax); classes[cls_id].name = name; } /** * Assign a spec to one of the classes. * @param spec The spec to assign. * @note The spec must have a valid class id set. */ DEFINE_NEWGRF_CLASS_METHOD(void)::Assign(Tspec *spec) { assert(spec->cls_id < Tmax); NewGRFClass<Tspec, Tid, Tmax> *cls = &classes[spec->cls_id]; uint i = cls->count++; cls->spec = ReallocT(cls->spec, cls->count); cls->spec[i] = spec; } /** * Get the name of a particular class. * @param cls_id The class to get the name of. * @pre index < GetCount(cls_id) * @return The name of said class. */ DEFINE_NEWGRF_CLASS_METHOD(StringID)::GetName(Tid cls_id) { assert(cls_id < Tmax); return classes[cls_id].name; } /** * Get the number of allocated classes. * @return The number of classes. */ DEFINE_NEWGRF_CLASS_METHOD(uint)::GetCount() { uint i; for (i = 0; i < Tmax && classes[i].global_id != 0; i++) {} return i; } /** * Get the number of allocated specs within a particular class. * @param cls_id The class to get the size of. * @pre cls_id < GetCount() * @return The size of the class. */ DEFINE_NEWGRF_CLASS_METHOD(uint)::GetCount(Tid cls_id) { assert(cls_id < Tmax); return classes[cls_id].count; } /** * Get a spec from a particular class at a given index. * @param cls_id The class to get the spec from. * @param index The index where to find the spec. * @pre index < GetCount(cls_id) * @return The spec at given location. */ DEFINE_NEWGRF_CLASS_METHOD(const Tspec *)::Get(Tid cls_id, uint index) { assert(cls_id < Tmax); if (index < classes[cls_id].count) return classes[cls_id].spec[index]; /* If the custom spec isn't defined any more, then the GRF file probably was not loaded. */ return NULL; } /** * Retrieve a spec by GRF location. * @param grfid GRF ID of spec. * @param local_id Index within GRF file of spec. * @param index Pointer to return the index of the spec in its class. If NULL then not used. * @return The spec. */ DEFINE_NEWGRF_CLASS_METHOD(const Tspec *)::GetByGrf(uint32 grfid, byte local_id, int *index) { uint j; for (Tid i = (Tid)0; i < Tmax; i++) { for (j = 0; j < classes[i].count; j++) { const Tspec *spec = classes[i].spec[j]; if (spec == NULL) continue; if (spec->grf_prop.grffile->grfid == grfid && spec->grf_prop.local_id == local_id) { if (index != NULL) *index = j; return spec; } } } return NULL; } #undef DEFINE_NEWGRF_CLASS_METHOD /** Force instantiation of the methods so we don't get linker errors. */ #define INSTANTIATE_NEWGRF_CLASS_METHODS(name, Tspec, Tid, Tmax) \ template void name::Reset(); \ template Tid name::Allocate(uint32 global_id); \ template void name::SetName(Tid cls_id, StringID name); \ template void name::Assign(Tspec *spec); \ template StringID name::GetName(Tid cls_id); \ template uint name::GetCount(); \ template uint name::GetCount(Tid cls_id); \ template const Tspec *name::Get(Tid cls_id, uint index); \ template const Tspec *name::GetByGrf(uint32 grfid, byte localidx, int *index);