mirror
/
OpenTTD
mirror of https://github.com/OpenTTD/OpenTTD
1
0
Fork 0
Code Issues

Change: [Script] Match FormatString behaviour more closely

pull/12241/head
glx22 2024-03-01 19:10:35 +01:00 committed by Loïc Guilloux
parent ae27ce12a7
commit 3a71f36393
2 changed files with 57 additions and 36 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

88
src/script/api/script_text.cpp
View File

@ -184,10 +184,19 @@ void ScriptText::_FillParamList(ParamList &params, ScriptTextList &seen_texts)
} }
seen_texts.pop_back(); seen_texts.pop_back();
/* Fill with dummy parameters to match FormatString() behaviour. */
if (seen_texts.empty()) {
static Param dummy = 0;
int nb_extra = SCRIPT_TEXT_MAX_PARAMETERS - (int)params.size();
for (int i = 0; i < nb_extra; i++)
params.emplace_back(-1, i, &dummy);
}
} }
void ScriptText::ParamCheck::Encode(std::back_insert_iterator<std::string> &output) void ScriptText::ParamCheck::Encode(std::back_insert_iterator<std::string> &output, const char *cmd)
{ {
if (this->cmd == nullptr) this->cmd = cmd;
if (this->used) return; if (this->used) return;
if (std::holds_alternative<std::string>(*this->param)) fmt::format_to(output, ":\"{}\"", std::get<std::string>(*this->param)); if (std::holds_alternative<std::string>(*this->param)) fmt::format_to(output, ":\"{}\"", std::get<std::string>(*this->param));
if (std::holds_alternative<SQInteger>(*this->param)) fmt::format_to(output, ":{:X}", std::get<SQInteger>(*this->param)); if (std::holds_alternative<SQInteger>(*this->param)) fmt::format_to(output, ":{:X}", std::get<SQInteger>(*this->param));
@ -220,46 +229,57 @@ void ScriptText::_GetEncodedText(std::back_insert_iterator<std::string> &output,
auto skip_args = [&](size_t nb) { idx += nb; }; auto skip_args = [&](size_t nb) { idx += nb; };
for (const StringParam &cur_param : params) { for (const StringParam &cur_param : params) {
switch (cur_param.type) { try {
case StringParam::UNUSED: switch (cur_param.type) {
skip_args(cur_param.consumes); case StringParam::UNUSED:
break; skip_args(cur_param.consumes);
break;
case StringParam::RAW_STRING: { case StringParam::RAW_STRING:
ParamCheck &p = *get_next_arg(); {
p.Encode(output); ParamCheck &p = *get_next_arg();
if (!std::holds_alternative<std::string>(*p.param)) ScriptLog::Error(fmt::format("{}({}): {{{}}} expects a raw string", name, param_count + 1, cur_param.cmd)); p.Encode(output, cur_param.cmd);
break; if (p.cmd != cur_param.cmd) throw 1;
} if (!std::holds_alternative<std::string>(*p.param)) ScriptLog::Error(fmt::format("{}({}): {{{}}} expects a raw string", name, param_count + 1, cur_param.cmd));
case StringParam::STRING: {
ParamCheck &p = *get_next_arg();
p.Encode(output);
if (!std::holds_alternative<ScriptTextRef>(*p.param)){
ScriptLog::Error(fmt::format("{}({}): {{{}}} expects a GSText", name, param_count + 1, cur_param.cmd));
break; break;
} }
int count = 0;
ScriptTextRef &ref = std::get<ScriptTextRef>(*p.param); case StringParam::STRING:
ref->_GetEncodedText(output, count, args.subspan(idx), false); {
if (++count != cur_param.consumes) { ParamCheck &p = *get_next_arg();
ScriptLog::Error(fmt::format("{}({}): {{{}}} expects {} to be consumed, but {} consumes {}", name, param_count + 1, cur_param.cmd, cur_param.consumes - 1, GetGameStringName(ref->string), count - 1)); p.Encode(output, cur_param.cmd);
/* Fill missing params if needed. */ if (p.cmd != cur_param.cmd) throw 1;
for (int i = count; i < cur_param.consumes; i++) fmt::format_to(output, ":0"); if (!std::holds_alternative<ScriptTextRef>(*p.param)) {
ScriptLog::Error(fmt::format("{}({}): {{{}}} expects a GSText", name, param_count + 1, cur_param.cmd));
param_count++;
continue;
}
int count = 0;
ScriptTextRef &ref = std::get<ScriptTextRef>(*p.param);
ref->_GetEncodedText(output, count, args.subspan(idx), false);
if (++count != cur_param.consumes) {
ScriptLog::Warning(fmt::format("{}({}): {{{}}} expects {} to be consumed, but {} consumes {}", name, param_count + 1, cur_param.cmd, cur_param.consumes - 1, GetGameStringName(ref->string), count - 1));
/* Fill missing params if needed. */
for (int i = count; i < cur_param.consumes; i++) fmt::format_to(output, ":0");
}
skip_args(cur_param.consumes - 1);
break;
} }
skip_args(cur_param.consumes - 1);
break; default:
for (int i = 0; i < cur_param.consumes; i++) {
ParamCheck &p = *get_next_arg();
p.Encode(output, i == 0 ? cur_param.cmd : nullptr);
if (i == 0 && p.cmd != cur_param.cmd) throw 1;
if (!std::holds_alternative<SQInteger>(*p.param)) ScriptLog::Error(fmt::format("{}({}): {{{}}} expects an integer", name, param_count + i + 1, cur_param.cmd));
}
} }
default: param_count += cur_param.consumes;
for (int i = 0; i < cur_param.consumes; i++) { } catch (int nb) {
ParamCheck &p = *get_next_arg(); param_count += nb;
p.Encode(output); ScriptLog::Warning(fmt::format("{}({}): Invalid parameter", name, param_count));
if (!std::holds_alternative<SQInteger>(*p.param)) ScriptLog::Error(fmt::format("{}({}): {{{}}} expects an integer", name, param_count + i + 1, cur_param.cmd));
}
} }
param_count += cur_param.consumes;
} }
} }

5
src/script/api/script_text.hpp
View File

@ -137,10 +137,11 @@ private:
int idx; int idx;
Param *param; Param *param;
bool used; bool used;
const char *cmd;
ParamCheck(StringID owner, int idx, Param *param) : owner(owner), idx(idx), param(param), used(false) {} ParamCheck(StringID owner, int idx, Param *param) : owner(owner), idx(idx), param(param), used(false), cmd(nullptr) {}
void Encode(std::back_insert_iterator<std::string> &output); void Encode(std::back_insert_iterator<std::string> &output, const char *cmd);
}; };
using ParamList = std::vector<ParamCheck>; using ParamList = std::vector<ParamCheck>;