miguel.horta/openttd-cmclient
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Codechange: Split NewGRF loader into separate Action handlers.

Browse Source
This commit is contained in:
Peter Nelson
2025-03-21 19:55:33 +00:00
committed by Peter Nelson
parent 0b7fa11a5b
commit 828e808444
42 changed files with 9356 additions and 8351 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/newgrf/newgrf_act8.cpp
+84
View File
@@ -0,0 +1,84 @@
/*
* 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_act8.cpp NewGRF Action 0x08 handler. */
#include "../stdafx.h"
#include "../debug.h"
#include "../string_func.h"
#include "newgrf_bytereader.h"
#include "newgrf_internal.h"
#include "../table/strings.h"
#include "../safeguards.h"
/* Action 0x08 (GLS_FILESCAN) */
static void ScanInfo(ByteReader &buf)
{
uint8_t grf_version = buf.ReadByte();
uint32_t grfid = buf.ReadDWord();
std::string_view name = buf.ReadString();
_cur.grfconfig->ident.grfid = grfid;
if (grf_version < 2 || grf_version > 8) {
_cur.grfconfig->flags.Set(GRFConfigFlag::Invalid);
Debug(grf, 0, "{}: NewGRF \"{}\" (GRFID {:08X}) uses GRF version {}, which is incompatible with this version of OpenTTD.", _cur.grfconfig->filename, StrMakeValid(name), std::byteswap(grfid), grf_version);
}
/* GRF IDs starting with 0xFF are reserved for internal TTDPatch use */
if (GB(grfid, 0, 8) == 0xFF) _cur.grfconfig->flags.Set(GRFConfigFlag::System);
AddGRFTextToList(_cur.grfconfig->name, 0x7F, grfid, false, name);
if (buf.HasData()) {
std::string_view info = buf.ReadString();
AddGRFTextToList(_cur.grfconfig->info, 0x7F, grfid, true, info);
}
/* GLS_INFOSCAN only looks for the action 8, so we can skip the rest of the file */
_cur.skip_sprites = -1;
}
/* Action 0x08 */
static void GRFInfo(ByteReader &buf)
{
/* <08> <version> <grf-id> <name> <info>
*
* B version newgrf version, currently 06
* 4*B grf-id globally unique ID of this .grf file
* S name name of this .grf set
* S info string describing the set, and e.g. author and copyright */
uint8_t version = buf.ReadByte();
uint32_t grfid = buf.ReadDWord();
std::string_view name = buf.ReadString();
if (_cur.stage < GLS_RESERVE && _cur.grfconfig->status != GCS_UNKNOWN) {
DisableGrf(STR_NEWGRF_ERROR_MULTIPLE_ACTION_8);
return;
}
if (_cur.grffile->grfid != grfid) {
Debug(grf, 0, "GRFInfo: GRFID {:08X} in FILESCAN stage does not match GRFID {:08X} in INIT/RESERVE/ACTIVATION stage", std::byteswap(_cur.grffile->grfid), std::byteswap(grfid));
_cur.grffile->grfid = grfid;
}
_cur.grffile->grf_version = version;
_cur.grfconfig->status = _cur.stage < GLS_RESERVE ? GCS_INITIALISED : GCS_ACTIVATED;
/* Do swap the GRFID for displaying purposes since people expect that */
Debug(grf, 1, "GRFInfo: Loaded GRFv{} set {:08X} - {} (palette: {}, version: {})", version, std::byteswap(grfid), StrMakeValid(name), (_cur.grfconfig->palette & GRFP_USE_MASK) ? "Windows" : "DOS", _cur.grfconfig->version);
}
template <> void GrfActionHandler<0x08>::FileScan(ByteReader &buf) { ScanInfo(buf); }
template <> void GrfActionHandler<0x08>::SafetyScan(ByteReader &) { }
template <> void GrfActionHandler<0x08>::LabelScan(ByteReader &) { }
template <> void GrfActionHandler<0x08>::Init(ByteReader &buf) { GRFInfo(buf); }
template <> void GrfActionHandler<0x08>::Reserve(ByteReader &buf) { GRFInfo(buf); }
template <> void GrfActionHandler<0x08>::Activation(ByteReader &buf) { GRFInfo(buf); }