Function GetNetworkRevisionString

src/network/core/network_game_info.cpp:46–85

* Get the network version string used by this build. * The returned string is guaranteed to be at most NETWORK_REVISION_LENGTH bytes including '\0' terminator. */

 * The returned string is guaranteed to be at most NETWORK_REVISION_LENGTH bytes including '\0' terminator.
 */
std::string_view GetNetworkRevisionString()
{
	static std::string network_revision;

	if (network_revision.empty()) {
#if not defined(NETWORK_INTERNAL_H)
#	error("network_internal.h must be included, otherwise the debug related preprocessor tokens won't be picked up correctly.")
#elif not defined(ENABLE_NETWORK_SYNC_EVERY_FRAME)
		/* Just a standard build. */
		network_revision = _openttd_revision;
#elif defined(NETWORK_SEND_DOUBLE_SEED)
		/* Build for debugging that sends both parts of the seeds and by doing that practically syncs every frame. */
		network_revision = fmt::format("dbg_seed-{}", _openttd_revision);
#else
		/* Build for debugging that sends the first part of the seed every frame, practically syncing every frame. */
		network_revision = fmt::format("dbg_sync-{}", _openttd_revision);
#endif
		if (_openttd_revision_tagged) {
			/* Tagged; do not mangle further, though ensure it's not too long. */
			if (network_revision.size() >= NETWORK_REVISION_LENGTH) network_revision.resize(NETWORK_REVISION_LENGTH - 1);
		} else {
			/* Not tagged; add the githash suffix while ensuring the string does not become too long. */
			assert(_openttd_revision_modified < 3);
			std::string githash_suffix = fmt::format("-{}{}", "gum"[_openttd_revision_modified], _openttd_revision_hash);
			if (githash_suffix.size() > GITHASH_SUFFIX_LEN) githash_suffix.resize(GITHASH_SUFFIX_LEN);

			/* Where did the hash start in the original string? Overwrite from that position, unless that would create a too long string. */
			size_t hash_end = network_revision.find_last_of('-');
			if (hash_end == std::string::npos) hash_end = network_revision.size();
			if (hash_end + githash_suffix.size() >= NETWORK_REVISION_LENGTH) hash_end = NETWORK_REVISION_LENGTH - githash_suffix.size() - 1;

			/* Replace the git hash in revision string. */
			network_revision.replace(hash_end, std::string::npos, githash_suffix);
		}
		assert(network_revision.size() < NETWORK_REVISION_LENGTH); // size does not include terminator, constant does, hence strictly less than
		Debug(net, 3, "Network revision name: {}", network_revision);
	}

	return network_revision;
}

/**
 * Extract the git hash from the revision string.