scummvm/engines/crab/mainmenu.cpp

/* ScummVM - Graphic Adventure Engine
 *
 * ScummVM is the legal property of its developers, whose names
 * are too numerous to list here. Please refer to the COPYRIGHT
 * file distributed with this source distribution.
 *
 * 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/>.
 *
 */

/*
 * This code is based on the CRAB engine
 *
 * Copyright (c) Arvind Raja Yadav
 *
 * Licensed under MIT
 *
 */

#include "crab/mainmenu.h"
#include "crab/XMLDoc.h"

namespace Crab {

using namespace pyrodactyl::music;
using namespace pyrodactyl::image;
using namespace pyrodactyl::text;
using namespace pyrodactyl::input;
using namespace pyrodactyl::ui;

//------------------------------------------------------------------------
// Purpose: Constructor
//------------------------------------------------------------------------
MainMenu::MainMenu() {
	XMLDoc conf(g_engine->_filePath->_mainmenuL);
	if (conf.ready()) {
		rapidxml::xml_node<char> *node = conf.doc()->first_node("main_menu");
		if (nodeValid(node)) {
			_meMain.load(node->first_node("main"));
			_logo.load(node->first_node("logo"));

			_back.load(node->first_node("back"));

			if (!g_engine->_optionMenu->_loaded) {
				g_engine->_optionMenu->load(node->first_node("option")->first_attribute("path")->value());
				g_engine->_optionMenu->_loaded = true;
			}

			_mod.load(node->first_node("mod")->first_attribute("path")->value());
			_credits.load(node->first_node("credits")->first_attribute("path")->value());

			{
				XMLDoc loadconf(node->first_node("load")->first_attribute("path")->value());
				if (loadconf.ready()) {
					rapidxml::xml_node<char> *loadnode = loadconf.doc()->first_node("load_menu");
					if (nodeValid(loadnode))
						g_engine->_loadMenu->load(loadnode);
				}
			}

			{
				XMLDoc helpconf(node->first_node("help")->first_attribute("path")->value());
				if (helpconf.ready()) {
					rapidxml::xml_node<char> *hnode = helpconf.doc()->first_node("help");
					if (nodeValid(hnode))
						g_engine->_helpScreen->load(hnode);
				}
			}

			if (nodeValid("scene", node)) {
				rapidxml::xml_node<char> *snode = node->first_node("scene");

				if (nodeValid("bg", snode))
					_bg.load(snode->first_node("bg"));

				if (nodeValid("lights", snode)) {
					rapidxml::xml_node<char> *lnode = snode->first_node("lights");

					for (rapidxml::xml_node<char> *n = lnode->first_node("img"); n != nullptr; n = n->next_sibling("img"))
						_lights.push_back(n);
				}
			}

			if (nodeValid("difficulty", node)) {
				rapidxml::xml_node<char> *dinode = node->first_node("difficulty");

				if (nodeValid("bg", dinode))
					_diff._bg.load(dinode->first_node("bg"));

				if (nodeValid("menu", dinode))
					_diff._menu.load(dinode->first_node("menu"));

				if (nodeValid("heading", dinode))
					_diff._heading.load(dinode->first_node("heading"));
			}

			if (nodeValid("prompt", node)) {
				rapidxml::xml_node<char> *prnode = node->first_node("prompt");

				_save.load(prnode);

				if (nodeValid("warning", prnode))
					_warning.load(prnode->first_node("warning"));

				if (nodeValid("bg", prnode))
					_bgSave.load(prnode->first_node("bg"));

				if (nodeValid("accept", prnode))
					_accept.load(prnode->first_node("accept"));

				if (nodeValid("cancel", prnode))
					_cancel.load(prnode->first_node("cancel"));
			}

			if (nodeValid("music", node)) {
				loadNum(_musicKey._normal, "normal", node->first_node("music"));
				loadNum(_musicKey._credits, "credits", node->first_node("music"));
			}

			if ((g_engine->getFeatures() & ADGF_DEMO) && nodeValid("demo", node)) {
				rapidxml::xml_node<char> *denode = node->first_node("demo");

				if (nodeValid("steam", denode))
					_steam.load(denode->first_node("steam"));

				if (nodeValid("direct", denode))
					_direct.load(denode->first_node("direct"));
			}
		}
	}

	if (g_engine->_tempData->_credits)
		changeState(STATE_CREDITS, true);
	else
		changeState(STATE_NORMAL, true);

	g_engine->_tempData->_credits = false;
	g_engine->_filePath->_currentR = g_engine->_filePath->_mainmenuR;
}

//------------------------------------------------------------------------
// Purpose: Event/input handling Events
//------------------------------------------------------------------------
void MainMenu::handleEvents(Common::Event &event, bool &shouldChangeState, GameStateID &newStateId) {
	g_engine->_mouse->handleEvents(event);

	if (_state != STATE_CREDITS) {
		int choice = _meMain.handleEvents(event);
		if (choice >= 0) {
			for (uint i = 0; i < _meMain._element.size(); ++i)
				_meMain._element[i].state(i == (uint)choice);

			switch (choice) {
			case 0:
				if (g_engine->_loadMenu->selectNewestFile()) {
					changeState(STATE_NORMAL);
					shouldChangeState = true;
					newStateId = GAMESTATE_LOAD_GAME;
				}
				break;
			case 1:
				changeState(STATE_DIFF);
				break;
			case 2:
				changeState(STATE_LOAD);
				g_engine->_loadMenu->scanDir();
				break;
			case 3:
				changeState(STATE_OPTIONS);
				break;
			case 4:
				changeState(STATE_MOD);
				break;
			case 5:
				changeState(STATE_HELP);
				break;
			case 6:
				changeState(STATE_CREDITS);
				_credits.reset();
				break;
			case 7:
				shouldChangeState = true;
				newStateId = GAMESTATE_EXIT;
				break;
			default:
				break;
			}
		}
	}

	if (g_engine->_inputManager->state(IU_BACK) || ((_back.handleEvents(event) != BUAC_IGNORE) &&
	   (_state != STATE_SAVENAME && _state != STATE_CREDITS))) {
		if (_state == STATE_SAVENAME)
			changeState(STATE_DIFF);
		else if (_state != STATE_NORMAL)
			changeState(STATE_NORMAL);
	}


	switch (_state) {
	case STATE_NORMAL:
		if ((g_engine->getFeatures() & ADGF_DEMO) && _steam.handleEvents(event) == BUAC_LCLICK) {
			// Open steam in browser window
			g_system->openUrl("https://store.steampowered.com/app/292400/");
		}

		if ((g_engine->getFeatures() & ADGF_DEMO) && _direct.handleEvents(event) == BUAC_LCLICK) {
			// Open humble widget in browser window
			g_system->openUrl("https://www.humblebundle.com/store/unrest/Udg6Ytd8Dfw");
		}
		break;

	case STATE_OPTIONS:
		if (g_engine->_optionMenu->handleEvents(_back, event))
			changeState(STATE_NORMAL);
		break;

	case STATE_CREDITS:
		if (_credits.handleEvents(event))
			changeState(STATE_NORMAL);
		break;

	case STATE_LOAD:
		if (g_engine->loadGameDialog()) {
			shouldChangeState = true;
			newStateId = GAMESTATE_LOAD_GAME;
		}
		changeState(STATE_NORMAL);
		return;

	case STATE_DIFF: {
		int choice = _diff._menu.handleEvents(event);

		// First menu option is Non-iron man, second is iron man
		// For the second choice, we must display a prompt to choose the name of the save game
		if (choice == 0) {
			g_engine->_tempData->_ironman = false;
			shouldChangeState = true;
			newStateId = GAMESTATE_NEW_GAME;
		} else if (choice == 1)
			changeState(STATE_SAVENAME);
	} break;

	case STATE_SAVENAME:
		if (_save.handleEvents(event) || (_accept.handleEvents(event)) != BUAC_IGNORE) {
			if (_save._text != "") {
				g_engine->_tempData->_filename = _save._text;
				g_engine->_tempData->_ironman = true;
				shouldChangeState = true;
				newStateId = GAMESTATE_NEW_GAME;
			} else
				debug("Please enter a valid filename for the iron man save.");
		} else if (_cancel.handleEvents(event) != BUAC_IGNORE)
			changeState(STATE_DIFF);

		break;

	case STATE_MOD:
		if (_mod.handleEvents(event))
			changeState(STATE_NORMAL);
		break;

	case STATE_HELP:
		g_engine->_helpScreen->handleEvents(event);
		break;

	default:
		break;
	}
}

//------------------------------------------------------------------------
// Purpose: Internal Events
//------------------------------------------------------------------------
void MainMenu::internalEvents(bool &shouldChangeState, GameStateID &newStateId) {
	// Make the lights flicker
	for (auto &i : _lights)
		i.internalEvents();

	if (_state == STATE_OPTIONS)
		g_engine->_optionMenu->internalEvents();
}

//------------------------------------------------------------------------
// Purpose: We need to toggle button visibility
// and enable/disable keyboard for each state change
//------------------------------------------------------------------------
void MainMenu::changeState(MenuState ms, const bool &start) {
	// Start = true means this is the first run, and no music is playing
	// Just play the appropriate music
	if (start) {
		if (ms == STATE_CREDITS)
			g_engine->_musicManager->playMusic(_musicKey._credits);
		else
			g_engine->_musicManager->playMusic(_musicKey._normal);
	} else {
		// This is not our first run, which means some music track is already playing
		// Only change tracks when going from main menu->credits or credits->main menu
		if (_state == STATE_CREDITS && ms != STATE_CREDITS)
			g_engine->_musicManager->playMusic(_musicKey._normal);
		else if (_state != STATE_CREDITS && ms == STATE_CREDITS)
			g_engine->_musicManager->playMusic(_musicKey._credits);
	}

	// Disable keymapper if switching state to input savename so inputs do not get "eaten".
	KeyBindingMode mode = (ms == STATE_SAVENAME ? KBM_NONE : KBM_GAME);
	g_engine->_inputManager->setKeyBindingMode(mode);

	// Set current state
	_state = ms;

	// We are entering the normal state, i.e outside all menus - reset color of menu items
	if (_state == STATE_NORMAL) {
		for (uint i = 0; i < _meMain._element.size(); ++i)
			_meMain._element[i].state(false);
	}

	// Enable keyboard navigation if outside all menus, otherwise disable it
	_meMain.useKeyboard((_state == STATE_NORMAL));

	// Continue button is only enabled if there is a save to load
	_meMain._element[0]._visible = !g_engine->_loadMenu->empty();

	// Enable credits and quit button if outside all menus, otherwise disable it
	_meMain._element[6]._visible = (_state == STATE_NORMAL);
	_meMain._element[7]._visible = (_state == STATE_NORMAL);

	// If switching to help screen, load latest image otherwise remove it from memory
	if (_state == STATE_HELP)
		g_engine->_helpScreen->refresh();
	else
		g_engine->_helpScreen->clear();
}

//------------------------------------------------------------------------
// Purpose: Drawing function
//------------------------------------------------------------------------
void MainMenu::draw() {
	_bg.draw();

	for (auto &i : _lights)
		i.draw();

	switch (_state) {
	case STATE_NORMAL:
		// Draw the logo
		_logo.draw();

		// Draw the game name and mod path if a mod is loaded
		if (g_engine->_filePath->_modCur != "res/default.xml") {
			g_engine->_textManager->draw(g_engine->_screenSettings->_cur.w / 2, g_engine->_screenSettings->_cur.h / 2, "Unrest", 0, 0, ALIGN_CENTER);
			//g_engine->_textManager->draw(g_engine->_screenSettings->cur.w / 2, g_engine->_screenSettings->cur.h / 2 + 50, g_engine->_filePath->mod_cur, 5, 1, ALIGN_CENTER);
		}

		_meMain.draw();

		if (g_engine->getFeatures() & ADGF_DEMO) {
			g_engine->_textManager->draw(_logo.x + _logo.w, _logo.y + _logo.h / 2, "Demo", 0, 0, ALIGN_CENTER);
			_steam.draw();
			_direct.draw();
		}
		break;

	case STATE_OPTIONS:
		g_engine->_optionMenu->draw(_back);
		_meMain.draw();
		break;

	case STATE_CREDITS:
		_credits.draw();
		break;

	case STATE_DIFF:
		_diff._bg.draw();
		_diff._heading.draw();
		_diff._menu.draw();
		_back.draw();
		_meMain.draw();
		break;

	case STATE_SAVENAME:
		_bgSave.draw();
		_warning.draw();
		_save.draw();
		_accept.draw();
		_cancel.draw();
		_meMain.draw();
		break;

	case STATE_MOD:
		_mod.draw();
		_back.draw();
		_meMain.draw();
		break;

	case STATE_HELP:
		g_engine->_helpScreen->draw();
		_back.draw();
		_meMain.draw();
		break;

	default:
		break;
	}

	g_engine->_mouse->draw();
}

void MainMenu::setUI() {
	_meMain.setUI();
	_logo.setUI();

	_back.setUI();
	g_engine->_optionMenu->setUI();
	_mod.setUI();
	g_engine->_loadMenu->setUI();
	g_engine->_helpScreen->setUI();
	_credits.setUI();

	_accept.setUI();
	_cancel.setUI();

	_bg.setUI();
	for (auto &i : _lights)
		i.setUI();

	_diff._menu.setUI();
	_diff._bg.setUI();
	_diff._heading.setUI();

	_save.setUI();
	_warning.setUI();
	_bgSave.setUI();

	if(g_engine->getFeatures() & ADGF_DEMO) {
		_steam.setUI();
		_direct.setUI();
	}
}

} // End of namespace Crab