metadata_stringifier.cpp

/**
 * =============================================================================
 * DumpSource2
 * Copyright (C) 2024 ValveResourceFormat Contributors
 *
 * source2gen
 * Copyright 2024 neverlosecc
 * =============================================================================
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License, version 3.0, as published by the
 * Free Software Foundation.
 *
 * This program 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
 * this program.  If not, see <http://www.gnu.org/licenses/>.
 */

#include "globalvariables.h"
#include "interfaces.h"
#include <filesystem>
#include <map>
#include "metadatalist.h"
#include <optional>
#include <cstring>
#include <fmt/format.h>
#include "metadata_stringifier.h"
#include <modules.h>
#include <unordered_set>

class SimpleCUtlString {
public:
	const char* Get() {
		return m_pString;
	}
private:
	const char* m_pString = nullptr;
};

namespace Dumpers::Schemas
{

	std::unordered_set<std::string> g_classWithBrokenDefaults =
	{
		"CastSphereSATParams_t",
		"Dop26_t",
		"FourCovMatrices3",
		"VMixVocoderDesc_t",
	};

  // Any function called after this will have uninitialized variables set to zero
#ifdef WIN32
	__declspec(noinline)
#else
	__attribute__((noinline))
#endif
	void CleanStack() {
		// stack size might need to be increased for larger classes (perhaps use alloca with class size + extra)
		volatile char stack[0x10000]; 
		for(size_t i = 0; i < sizeof(stack); ++i) {
			stack[i] = 0;
		}
	}

	// Determine how and if to output metadata entry value based on it's type.
	std::optional<std::string> GetMetadataValue(const SchemaMetadataEntryData_t& entry, const char* metadataTargetName)
	{
		if (g_mapMetadataNameToValue.find(entry.m_pszName) != g_mapMetadataNameToValue.end())
		{
			auto valueType = g_mapMetadataNameToValue.at(entry.m_pszName);
			switch (valueType)
			{
			case MetadataValueType::STRING:
			{
				auto value = *static_cast<const char**>(entry.m_pData);
				Globals::stringsIgnoreStream << value << "\n";
				return fmt::format("\"{}\"", value);
			}
			case MetadataValueType::INTEGER:
				return std::to_string(*static_cast<int*>(entry.m_pData));
			case MetadataValueType::FLOAT:
				return std::to_string(*static_cast<float*>(entry.m_pData));
			case MetadataValueType::INLINE_STRING:
			{
				// max 8 characters. Also check for null term.
				char* result = static_cast<char*>(entry.m_pData);
				for (uint8_t i = 0; i < 8; ++i) {
					if (result[i] == '\0') {
						return fmt::format("\"{}\"", std::string(result, i));
					}
				}
				return fmt::format("\"{}\"", std::string(result, 8));
			}
			case MetadataValueType::VARNAME:
			{
				auto value = static_cast<CSchemaVarName*>(entry.m_pData);

				const auto check_ptr = [](const char* ptr) -> bool {
					// Authored: source2gen
					// @note: hotfix for the deadlock 14/09/24 update,
					// where they filled some ptrs with -1 instead of nullptr
					return ptr != nullptr && ptr != reinterpret_cast<const char*>(-1);
					};

				std::stringstream stringStream;
				auto hasType = check_ptr(value->m_pszType);
				auto hasName = check_ptr(value->m_pszName);

				stringStream << "\"";

				if (hasType)
					stringStream << value->m_pszType;

				if (hasName)
				{
					if (hasType)
						stringStream << " ";
					stringStream << value->m_pszName;
				}

				stringStream << "\"";

				return stringStream.str();
			}
			case MetadataValueType::KV3DEFAULTS:
				typedef void* (*GetKV3DefaultsFn)();
				typedef int (*SaveKV3AsJsonFn)(void* kv3, SimpleCUtlString& err, SimpleCUtlString& str);

				if (!entry.m_pData || !(*(void**)entry.m_pData) || g_classWithBrokenDefaults.contains(metadataTargetName)) return "Could not parse KV3 Defaults";

			  CleanStack(); // Prepare stack for uninitialized variables in class constructor inside GetKV3Defaults
				auto value = reinterpret_cast<GetKV3DefaultsFn>(*(void**)entry.m_pData)();

				if (!value) return "Could not parse KV3 Defaults";

#ifdef WIN32
				static auto SaveKV3AsJson = Modules::tier0->GetSymbol<SaveKV3AsJsonFn>("?SaveKV3AsJSON@@YA_NPEBVKeyValues3@@PEAVCUtlString@@1@Z");
#else
				static auto SaveKV3AsJson = Modules::tier0->GetSymbol<SaveKV3AsJsonFn>("_Z13SaveKV3AsJSONPK10KeyValues3P10CUtlStringS3_");
#endif
				if (!SaveKV3AsJson) {
					spdlog::critical("SaveKV3AsJson not found");
					return {};
				}

				SimpleCUtlString err;
				SimpleCUtlString buf;
				int res = SaveKV3AsJson(*(void**)value, err, buf);

				if (res) {
					return buf.Get();
				}

				return "Could not parse KV3 Defaults";
			}
		}

		return {};
	}

} // namespace Dumpers::Schemas