OpenTTD Source: src/newgrf/newgrf_actb.cpp Source File

OpenTTD Source 15.3

newgrf_actb.cpp
Go to the documentation of this file.
1/*
2 * This file is part of OpenTTD.
3 * 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.
4 * 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.
5 * 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>.
6 */
7
10#include "../stdafx.h"
11#include "../debug.h"
12#include "newgrf_bytereader.h"
13#include "newgrf_internal.h"
14
15#include "table/strings.h"
16
17#include "../safeguards.h"
18
19/* Action 0x0B */
20static void GRFLoadError(ByteReader &buf)
21{
22 /* <0B> <severity> <language-id> <message-id> [<message...> 00] [<data...>] 00 [<parnum>]
23 *
24 * B severity 00: notice, continue loading grf file
25 * 01: warning, continue loading grf file
26 * 02: error, but continue loading grf file, and attempt
27 * loading grf again when loading or starting next game
28 * 03: error, abort loading and prevent loading again in
29 * the future (only when restarting the patch)
30 * B language-id see action 4, use 1F for built-in error messages
31 * B message-id message to show, see below
32 * S message for custom messages (message-id FF), text of the message
33 * not present for built-in messages.
34 * V data additional data for built-in (or custom) messages
35 * B parnum parameter numbers to be shown in the message (maximum of 2) */
36
37 static const StringID msgstr[] = {
38 STR_NEWGRF_ERROR_VERSION_NUMBER,
39 STR_NEWGRF_ERROR_DOS_OR_WINDOWS,
40 STR_NEWGRF_ERROR_UNSET_SWITCH,
41 STR_NEWGRF_ERROR_INVALID_PARAMETER,
42 STR_NEWGRF_ERROR_LOAD_BEFORE,
43 STR_NEWGRF_ERROR_LOAD_AFTER,
44 STR_NEWGRF_ERROR_OTTD_VERSION_NUMBER,
45 };
46
47 static const StringID sevstr[] = {
48 STR_NEWGRF_ERROR_MSG_INFO,
49 STR_NEWGRF_ERROR_MSG_WARNING,
50 STR_NEWGRF_ERROR_MSG_ERROR,
51 STR_NEWGRF_ERROR_MSG_FATAL
52 };
53
54 uint8_t severity = buf.ReadByte();
55 uint8_t lang = buf.ReadByte();
56 uint8_t message_id = buf.ReadByte();
57
58 /* Skip the error if it isn't valid for the current language. */
59 if (!CheckGrfLangID(lang, _cur_gps.grffile->grf_version)) return;
60
61 /* Skip the error until the activation stage unless bit 7 of the severity
62 * is set. */
63 if (!HasBit(severity, 7) && _cur_gps.stage == GLS_INIT) {
64 GrfMsg(7, "GRFLoadError: Skipping non-fatal GRFLoadError in stage {}", _cur_gps.stage);
65 return;
66 }
67 ClrBit(severity, 7);
68
69 if (severity >= lengthof(sevstr)) {
70 GrfMsg(7, "GRFLoadError: Invalid severity id {}. Setting to 2 (non-fatal error).", severity);
71 severity = 2;
72 } else if (severity == 3) {
73 /* This is a fatal error, so make sure the GRF is deactivated and no
74 * more of it gets loaded. */
75 DisableGrf();
76 }
77
78 if (message_id >= lengthof(msgstr) && message_id != 0xFF) {
79 GrfMsg(7, "GRFLoadError: Invalid message id.");
80 return;
81 }
82
83 if (buf.Remaining() <= 1) {
84 GrfMsg(7, "GRFLoadError: No message data supplied.");
85 return;
86 }
87
88 /* An error may be emitted multiple times in different loading stages. Re-use if so. */
89 auto it = std::ranges::find(_cur_gps.grfconfig->errors, _cur_gps.nfo_line, &GRFError::nfo_line);
90 if (it == std::end(_cur_gps.grfconfig->errors)) {
91 it = _cur_gps.grfconfig->errors.emplace(it, sevstr[severity], _cur_gps.nfo_line);
92 }
93
94 GRFError &error = *it;
95
96 if (message_id == 0xFF) {
97 /* This is a custom error message. */
98 if (buf.HasData()) {
99 std::string_view message = buf.ReadString();
100
101 error.custom_message = TranslateTTDPatchCodes(_cur_gps.grffile->grfid, lang, true, message, SCC_RAW_STRING_POINTER);
102 } else {
103 GrfMsg(7, "GRFLoadError: No custom message supplied.");
104 error.custom_message.clear();
105 }
106 } else {
107 error.message = msgstr[message_id];
108 }
109
110 if (buf.HasData()) {
111 std::string_view data = buf.ReadString();
112
113 error.data = TranslateTTDPatchCodes(_cur_gps.grffile->grfid, lang, true, data);
114 } else {
115 GrfMsg(7, "GRFLoadError: No message data supplied.");
116 error.data.clear();
117 }
118
119 /* Only two parameter numbers can be used in the string. */
120 for (uint i = 0; i < error.param_value.size() && buf.HasData(); i++) {
121 uint param_number = buf.ReadByte();
122 error.param_value[i] = _cur_gps.grffile->GetParam(param_number);
123 }
124}
125
126template <> void GrfActionHandler<0x0B>::FileScan(ByteReader &) { }
127template <> void GrfActionHandler<0x0B>::SafetyScan(ByteReader &) { }
128template <> void GrfActionHandler<0x0B>::LabelScan(ByteReader &) { }
129template <> void GrfActionHandler<0x0B>::Init(ByteReader &buf) { GRFLoadError(buf); }
130template <> void GrfActionHandler<0x0B>::Reserve(ByteReader &buf) { GRFLoadError(buf); }
131template <> void GrfActionHandler<0x0B>::Activation(ByteReader &buf) { GRFLoadError(buf); }
HasBit
constexpr bool HasBit(const T x, const uint8_t y)
Checks if a bit in a value is set.
Definition bitmath_func.hpp:103
ClrBit
constexpr T ClrBit(T &x, const uint8_t y)
Clears a bit in a variable.
Definition bitmath_func.hpp:139
ByteReader
Class to read from a NewGRF file.
Definition newgrf_bytereader.h:18
ByteReader::ReadString
std::string_view ReadString()
Read a NUL-terminated string.
Definition newgrf_bytereader.h:91
ByteReader::ReadByte
uint8_t ReadByte()
Read a single byte (8 bits).
Definition newgrf_bytereader.h:34
DisableGrf
GRFError * DisableGrf(StringID message, GRFConfig *config)
Disable a GRF.
Definition newgrf.cpp:135
newgrf_bytereader.h
NewGRF buffer reader definition.
newgrf_internal.h
NewGRF internal processing state.
TranslateTTDPatchCodes
std::string TranslateTTDPatchCodes(uint32_t grfid, uint8_t language_id, bool allow_newlines, std::string_view str, StringControlCode byte80)
Translate TTDPatch string codes into something OpenTTD can handle (better).
Definition newgrf_text.cpp:237
lengthof
#define lengthof(array)
Return the length of an fixed size array.
Definition stdafx.h:271
StringID
uint32_t StringID
Numeric value that represents a string, independent of the selected language.
Definition strings_type.h:19
GRFConfig::errors
std::vector< GRFError > errors
NOSAVE: Error/Warning during GRF loading (Action 0x0B)
Definition newgrf_config.h:174
GRFError
Information about why GRF had problems during initialisation.
Definition newgrf_config.h:109
GRFError::param_value
std::array< uint32_t, 2 > param_value
Values of GRF parameters to show for message and custom_message.
Definition newgrf_config.h:118
GRFError::nfo_line
uint32_t nfo_line
Line within NewGRF of error.
Definition newgrf_config.h:117
GRFError::message
StringID message
Default message.
Definition newgrf_config.h:115
GRFError::custom_message
std::string custom_message
Custom message (if present)
Definition newgrf_config.h:113
GRFError::data
std::string data
Additional data for message and custom_message.
Definition newgrf_config.h:114
GRFFile::GetParam
uint32_t GetParam(uint number) const
Get GRF Parameter with range checking.
Definition newgrf.h:167
GrfActionHandler
GRF action handler.
Definition newgrf_internal.h:37
GrfProcessingState::grffile
GRFFile * grffile
Currently processed GRF file.
Definition newgrf_internal.h:67
GrfProcessingState::nfo_line
uint32_t nfo_line
Currently processed pseudo sprite number in the GRF.
Definition newgrf_internal.h:69
GrfProcessingState::grfconfig
GRFConfig * grfconfig
Config of the currently processed GRF file.
Definition newgrf_internal.h:68
GrfProcessingState::stage
GrfLoadingStage stage
Current loading stage.
Definition newgrf_internal.h:62