sfall/sfall/Modules/Message.cpp

/*
 *    sfall
 *    Copyright (C) 2008-2024  The sfall team
 *
 *    This program 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, either version 3 of the License, or
 *    (at your option) any later version.
 *
 *    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 <string>

#include "..\main.h"
#include "..\FalloutEngine\Fallout2.h"
#include "..\Utils.h"
#include "LoadGameHook.h"

#include "Message.h"

namespace sfall
{

#define CASTMSG(adr) reinterpret_cast<fo::MessageList*>(adr)

const fo::MessageList* Message::gameMsgFiles[] = {
	CASTMSG(MSG_FILE_COMBAT),
	CASTMSG(MSG_FILE_AI),
	CASTMSG(MSG_FILE_SCRNAME),
	CASTMSG(MSG_FILE_MISC),
	CASTMSG(MSG_FILE_CUSTOM),
	CASTMSG(MSG_FILE_INVENTRY),
	CASTMSG(MSG_FILE_ITEM),
	CASTMSG(MSG_FILE_LSGAME),
	CASTMSG(MSG_FILE_MAP),
	CASTMSG(MSG_FILE_OPTIONS),
	CASTMSG(MSG_FILE_PERK),
	CASTMSG(MSG_FILE_PIPBOY),
	CASTMSG(MSG_FILE_QUESTS),
	CASTMSG(MSG_FILE_PROTO),
	CASTMSG(MSG_FILE_SCRIPT),
	CASTMSG(MSG_FILE_SKILL),
	CASTMSG(MSG_FILE_SKILLDEX),
	CASTMSG(MSG_FILE_STAT),
	CASTMSG(MSG_FILE_TRAIT),
	CASTMSG(MSG_FILE_WORLDMAP),
	CASTMSG(MSG_FILE_EDITOR)
};
#undef CASTMSG

static char gameLanguage[32]; // (max length of language string is 40)

const char* Message::GameLanguage() {
	return &gameLanguage[0];
}

ExtraGameMessageListsMap Message::gExtraGameMsgLists;
static std::vector<std::string> msgFileList;
static std::unordered_map<std::string, long> addedExtraMsgFiles;

static long msgNumCounter = 0x3000;

static long heroIsFemale = -1;

// Searches the special character in the text and removes the text depending on the player's gender
// example: <MaleText^FemaleText>
static long __fastcall ReplaceGenderWord(fo::MessageNode* msgData, fo::MessageList* msgFile) {
	if (!InDialog() || msgData->flags & MSG_GENDER_CHECK_FLG) return 1;
	if (heroIsFemale < 0) heroIsFemale = fo::util::HeroIsFemale();

	unsigned char* _pos = (unsigned char*)msgData->message;
	unsigned char* pos;

	while ((pos = (unsigned char*)std::strchr((char*)_pos, '^')) != 0) { // pos - pointer to the character position
		_pos = pos; // next find position
		for (unsigned char* n = pos - 1; ; n--) {
			if (n < (unsigned char*)msgData->message) {
				_pos++; // error, open char not found
				break;
			} else if (*n == '<') {
				if (heroIsFemale) { // remove left(male) side
					pos++;
					// shift all chars to the left
					do {
						*n++ = *pos++;
						if (*pos == '>') { // skip close char
							_pos = n; // set next find position
							do *n++ = *++pos; while (*pos); // continue shift (with '\0')
							break;
						}
					} while (*pos);
				} else { // remove right(female) side
					pos = n;
					pos++;
					// shift all chars to the left
					do {
						if (pos == _pos) { // skip '^' char
							while (*++pos && *pos != '>');  // skip female side
							do *n++ = *++pos; while (*pos); // continue shift (with '\0')
							break;
						}
						*n++ = *pos++;
					} while (*pos);
				}
				break; // exit for
			}
		}
		if (_pos > pos) break;
	}

	// set flag
	unsigned long outValue;
	fo::func::message_find(msgFile, msgData->number, &outValue);
	msgFile->nodes[outValue].flags |= MSG_GENDER_CHECK_FLG;

	return 1;
}

static void __declspec(naked) scr_get_msg_str_speech_hook() {
	__asm {
		call fo::funcoffs::message_search_;
		cmp  eax, 1;
		jne  end;
		push ecx;
		lea  ecx, [esp + 8]; // message data
		mov  edx, [esp + 0x1C - 0x0C + 8]; // message file
		call ReplaceGenderWord;
		pop  ecx;
end:
		retn;
	}
}

struct MessageListInfo {
	std::string FileName;
	fo::MessageList* List;
};

std::unordered_map<fo::MessageList*, MessageListInfo> messageListMap;

static bool messageLoadForceEnglish;

static fo::DbFile* __fastcall MessageLoadHook(const char* fullPath, const char* mode, const char* msgFile, fo::MessageList* messageList) {
	fo::DbFile* file = !messageLoadForceEnglish ? fo::func::db_fopen(fullPath, mode) : nullptr;
	if (file == nullptr) {
		messageLoadForceEnglish = false;
		char buf[MAX_PATH];
		sprintf(buf, "text\\english\\%s", msgFile);
		return fo::func::db_fopen(buf, mode);
	}

	// Remember loaded message list name.
	MessageListInfo listInfo = {msgFile, nullptr};
	messageListMap.insert(std::make_pair(messageList, listInfo));
	return file;
}

static long __fastcall MessageFindHook(fo::MessageList** list, long num, DWORD* outIndex) {
	if (fo::func::message_find(*list, num, outIndex)) {
		return true;
	}
	// If message not found in original list, try to find in fallback list.
	std::unordered_map<fo::MessageList*, MessageListInfo>::iterator& listIt = messageListMap.find(*list);
	if (listIt == messageListMap.end()) {
		return false;
	}
	MessageListInfo& listInfo = listIt->second;
	if (listInfo.List == nullptr) {
		// Load fallback message list.
		messageLoadForceEnglish = true;
		listInfo.List = new fo::MessageList();
		fo::func::message_load(listInfo.List, listInfo.FileName.c_str());
		// TODO: some error message if fallback file wasn't loaded?
	}
	*list = listInfo.List;
	return fo::func::message_find(*list, num, outIndex);
}

static void __fastcall MessageExitHook(fo::MessageList* list) {
	// Delete fallback message file.
	std::unordered_map<fo::MessageList*, MessageListInfo>::iterator& listIt = messageListMap.find(list);
	if (listIt == messageListMap.end()) {
		return;
	}
	MessageListInfo& listInfo = listIt->second;
	if (listInfo.List != nullptr) {
		fo::func::message_exit(listInfo.List);
		delete listInfo.List;
	}
	messageListMap.erase(listIt);
}

// Loads the msg file from the 'english' folder if it does not exist in the current language directory
static void __declspec(naked) message_load__db_fopen_hook() {
	__asm {
		push esi;      // message list
		push ebp;      // relative path
		mov  ecx, eax; // full path
		call MessageLoadHook; // edx - mode
		retn;
	}
}

static void __declspec(naked) message_search__message_find_hook() {
	__asm {
		push ecx; // save msg list
		push ebx;            // out index
		lea  ecx, [esp + 4]; // msg list **
		call MessageFindHook; // edx - msg num
		pop  ecx; // restore, possibly modified list ptr
		retn;
	}
}

static void __declspec(naked) message_exit__mem_free_hook() {
	__asm {
		push eax; // save msgList->nodes
		mov  ecx, ebx; // message list
		call MessageExitHook;
		pop  eax; // restore
		jmp  fo::funcoffs::mem_free_;
	}
}

void ReadExtraGameMsgFiles() {
	if (!msgFileList.empty()) {
		int number = 0;
		for (std::vector<std::string>::iterator it = msgFileList.begin(); it != msgFileList.end(); ++it) {
			std::string path("game\\");
			size_t n = it->find(':');
			if (n == std::string::npos) {
				path += *it;
			} else {
				path += it->substr(0, n);
				number = std::stoi(it->substr(n + 1), nullptr, 0);
			}
			path += ".msg";
			fo::MessageList* list = new fo::MessageList();
			if (fo::func::message_load(list, path.c_str()) == 1) {
				Message::gExtraGameMsgLists.insert(std::make_pair(0x2000 + number, list));
			} else {
				delete list;
			}
			if (++number == 4096) break;
		}
		msgFileList.clear();
	}
}

long Message::AddExtraMsgFile(const char* msgName, long msgNumber) {
	if (msgNumber) {
		if (msgNumber < 0x2000 || msgNumber > 0x2FFF) return -1;
		if (Message::gExtraGameMsgLists.find(msgNumber) != Message::gExtraGameMsgLists.cend()) {
			return 0; // file has already been added
		}
	} else if (msgNumCounter > 0x3FFF) return -3;

	std::string path("game\\");
	path += msgName;
	ToLowerCase(path);

	const std::unordered_map<std::string, long>::iterator &msgIt = addedExtraMsgFiles.find(path.c_str());
	if (msgIt != addedExtraMsgFiles.cend()) return msgIt->second; // file has already been added by func

	fo::MessageList* list = new fo::MessageList();
	if (!fo::func::message_load(list, path.c_str())) {
		// change current language folder
		//path.insert(0, "..\\english\\");
		//if (!fo::func::message_load(list, path.c_str())) {
			delete list;
			return -2;
		//}
	}
	if (msgNumber == 0) msgNumber = msgNumCounter++;
	Message::gExtraGameMsgLists.insert(std::make_pair(msgNumber, list));
	addedExtraMsgFiles.insert(std::make_pair(path, msgNumber));
	return msgNumber;
}

void ClearScriptAddedExtraGameMsg() {
	for (ExtraGameMessageListsMap::iterator it = Message::gExtraGameMsgLists.begin(); it != Message::gExtraGameMsgLists.end();) {
		if (it->first >= 0x3000 && it->first <= 0x3FFF) {
			fo::func::message_exit(it->second);
			delete it->second;
			it = Message::gExtraGameMsgLists.erase(it);
		} else {
			++it;
		}
	}
	addedExtraMsgFiles.clear();
	msgNumCounter = 0x3000;
	heroIsFemale = -1;
}

void FallbackEnglishLoadMsgFiles() {
	const char* lang;
	if (fo::func::get_game_config_string(&lang, "system", "language")) {
		strncpy_s(gameLanguage, lang, _TRUNCATE);
		if (_stricmp(lang, "english") != 0) {
			HookCall(0x484B18, message_load__db_fopen_hook);
			HookCall(0x484C4B, message_search__message_find_hook);
			HookCall(0x4849B9, message_exit__mem_free_hook);
		}
	}
}

void ClearReadExtraGameMsgFiles() {
	for (ExtraGameMessageListsMap::iterator it = Message::gExtraGameMsgLists.begin(); it != Message::gExtraGameMsgLists.end(); ++it) {
		fo::func::message_exit(it->second);
		delete it->second;
	}
}

void Message::init() {
	msgFileList = IniReader::GetConfigList("Misc", "ExtraGameMsgFileList", "");

	if (IniReader::GetConfigInt("Misc", "DialogGenderWords", 0)) {
		dlogr("Applying dialog gender words patch.", DL_INIT);
		HookCall(0x4A6CEE, scr_get_msg_str_speech_hook);
		SafeWrite16(0x484C62, 0x9090); // message_search_
	}
}

//void Message::exit() {
	//gExtraGameMsgLists.clear();
//}

}