Function GetEncodedStringWithArgs

src/strings.cpp:102–141

* Encode a string with its parameters into an encoded string. * The encoded string can be stored and decoded later without requiring parameters to be stored separately. * @param str The StringID to format. * @param params The parameters of the string. * @returns The encoded string. */

 * @returns The encoded string.
 */
EncodedString GetEncodedStringWithArgs(StringID str, std::span<const StringParameter> params)
{
	std::string result;
	StringBuilder builder(result);
	builder.PutUtf8(SCC_ENCODED_INTERNAL);
	builder.PutIntegerBase(str, 16);

	struct visitor {
		StringBuilder &builder;

		void operator()(const std::monostate &) {}

		void operator()(const uint64_t &arg)
		{
			this->builder.PutUtf8(SCC_ENCODED_NUMERIC);
			this->builder.PutIntegerBase(arg, 16);
		}

		void operator()(const std::string &value)
		{
#ifdef WITH_ASSERT
			/* Don't allow an encoded string to contain another encoded string. */
			{
				auto [len, c] = DecodeUtf8(value);
				assert(len == 0 || (c != SCC_ENCODED && c != SCC_ENCODED_INTERNAL && c != SCC_RECORD_SEPARATOR));
			}
#endif /* WITH_ASSERT */
			this->builder.PutUtf8(SCC_ENCODED_STRING);
			this->builder += value;
		}
	};

	visitor v{builder};
	for (const auto &param : params) {
		builder.PutUtf8(SCC_RECORD_SEPARATOR);
		std::visit(v, param.data);
	}

	return EncodedString{std::move(result)};
}

/**
 * Replace a parameter of this EncodedString.