scummvm/engines/dm/dm.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 2
* 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, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
*
*/

/*
* Based on the Reverse Engineering work of Christophe Fontanel,
* maintainer of the Dungeon Master Encyclopaedia (http://dmweb.free.fr/)
*/

#include "common/scummsys.h"
#include "common/system.h"

#include "common/debug.h"
#include "common/debug-channels.h"
#include "common/error.h"

#include "engines/util.h"
#include "engines/engine.h"
#include "graphics/palette.h"
#include "common/file.h"
#include "common/events.h"

#include "dm/dm.h"
#include "gfx.h"
#include "dungeonman.h"
#include "eventman.h"
#include "menus.h"
#include "champion.h"
#include "loadsave.h"
#include "objectman.h"
#include "inventory.h"
#include "text.h"
#include "movesens.h"
#include "group.h"
#include "timeline.h"

namespace DM {

void turnDirRight(direction &dir) { dir = (direction)((dir + 1) & 3); }
void turnDirLeft(direction &dir) { dir = (direction)((dir - 1) & 3); }
direction returnOppositeDir(direction dir) { return (direction)((dir + 2) & 3); }

uint16 returnPrevVal(uint16 val) {
	return (direction)((val + 3) & 3);
}

uint16 returnNextVal(uint16 val) {
	return (val + 1) & 0x3;
}

bool isOrientedWestEast(direction dir) { return dir & 1; }

uint16 getFlag(uint16 val, uint16 mask) {
	return val & mask;
}

uint16 setFlag(uint16 &val, uint16 mask) {
	return val |= mask;
}

uint16 clearFlag(uint16 &val, uint16 mask) {
	return val &= ~mask;
}

uint16 toggleFlag(uint16& val, uint16 mask) {
	return val ^= mask;
}

DMEngine::DMEngine(OSystem *syst) : Engine(syst), _console(nullptr) {
// Do not load data files
// Do not initialize graphics here
// Do not initialize audio devices here
// Do these from run

//Specify all default directories
//const Common::FSNode gameDataDir(ConfMan.get("example"));
//SearchMan.addSubDirectoryMatching(gameDataDir, "example2");
	DebugMan.addDebugChannel(kDMDebugExample, "example", "example desc");

	// register random source
	_rnd = new Common::RandomSource("quux");

	_dungeonMan = nullptr;
	_displayMan = nullptr;
	_eventMan = nullptr;
	_menuMan = nullptr;
	_championMan = nullptr;
	_loadsaveMan = nullptr;
	_objectMan = nullptr;
	_inventoryMan = nullptr;
	_textMan = nullptr;
	_movsens = nullptr;
	_groupMan = nullptr;
	_timeline = nullptr;
	_g321_stopWaitingForPlayerInput = false;
	_g301_gameTimeTicking = false;
	_g524_restartGameAllowed = false;
	_g331_pressingEye = false;
	_g333_pressingMouth = false;
	_g332_stopPressingEye = false;
	_g334_stopPressingMouth = false;
	_g340_highlightBoxInversionRequested = false;

	debug("DMEngine::DMEngine");
}

DMEngine::~DMEngine() {
	debug("DMEngine::~DMEngine");

	// dispose of resources
	delete _rnd;
	delete _console;
	delete _displayMan;
	delete _dungeonMan;
	delete _eventMan;
	delete _menuMan;
	delete _championMan;
	delete _loadsaveMan;
	delete _objectMan;
	delete _inventoryMan;
	delete _textMan;
	delete _movsens;
	delete _groupMan;
	delete _timeline;

	// clear debug channels
	DebugMan.clearAllDebugChannels();
}

void DMEngine::f463_initializeGame() {
	_displayMan->f479_loadGraphics();
	_displayMan->f460_initializeGraphicData();
	// DUMMY CODE: next line
	_displayMan->loadPalette(g19_PalCredits);

	_eventMan->initMouse();

	while (_loadsaveMan->f435_loadgame() != k1_LoadgameSuccess) {
		warning("TODO: F0441_STARTEND_ProcessEntrance");
	}

	_displayMan->f94_loadFloorSet(k0_FloorSetStone);
	_displayMan->f95_loadWallSet(k0_WallSetStone);
	_objectMan->loadObjectNames();

	// There was some memory wizardy for the Amiga platform, I skipped that part
	_displayMan->f461_allocateFlippedWallBitmaps();

	f462_startGame();
	warning("MISSING CODE: F0267_MOVE_GetMoveResult_CPSCE (if newGame)");
	_eventMan->showMouse(true);
	warning("MISSING CODE: F0357_COMMAND_DiscardAllInput");
}

void DMEngine::f448_initMemoryManager() {
	warning("STUB FUNCTION");
	for (uint16 i = 0; i < 16; ++i)
		_displayMan->_g347_paletteTopAndBottomScreen[i] = g21_PalDungeonView[0][i];
}

void DMEngine::f462_startGame() {
	_g331_pressingEye = false;
	_g332_stopPressingEye = false;
	_g333_pressingMouth = false;
	_g334_stopPressingMouth = false;
	_g340_highlightBoxInversionRequested = false;
	_eventMan->_g341_highlightBoxEnabled = false;
	_championMan->_g300_partyIsSleeping = false;
	_championMan->_g506_actingChampionOrdinal = M0_indexToOrdinal(kM1_ChampionNone);
	_menuMan->_g509_actionAreaContainsIcons = true;
	_eventMan->_g599_useChampionIconOrdinalAsMousePointerBitmap = M0_indexToOrdinal(kM1_ChampionNone);

	_eventMan->_g441_primaryMouseInput = g447_PrimaryMouseInput_Interface;
	_eventMan->_g442_secondaryMouseInput = g448_SecondaryMouseInput_Movement;
	warning("MISSING CODE: set primary/secondary keyboard input");

	f3_processNewPartyMap(_dungeonMan->_g309_partyMapIndex);

	if (!_g298_newGame) {
		warning("TODO: loading game");
	} else {
		_displayMan->_g578_useByteBoxCoordinates = false;
		warning("TODO: clear screen");
	}

	warning("TODO: build copper");
	_menuMan->f395_drawMovementArrows();
	_championMan->f278_resetDataToStartGame();
	_g301_gameTimeTicking = true;
}

void DMEngine::f3_processNewPartyMap(uint16 mapIndex) {
	warning("MISSING CODE: F0194_GROUP_RemoveAllActiveGroups");
	_dungeonMan->f174_setCurrentMapAndPartyMap(mapIndex);
	_displayMan->f96_loadCurrentMapGraphics();
	warning("MISSING CODE: F0195_GROUP_AddAllActiveGroups");
	warning("MISSING CODE: F0337_INVENTORY_SetDungeonViewPalette");
}

Common::Error DMEngine::run() {
	initArrays();

	// scummvm/engine specific
	initGraphics(320, 200, false);
	_console = new Console(this);
	_displayMan = new DisplayMan(this);
	_dungeonMan = new DungeonMan(this);
	_eventMan = new EventManager(this);
	_menuMan = new MenuMan(this);
	_championMan = new ChampionMan(this);
	_loadsaveMan = new LoadsaveMan(this);
	_objectMan = new ObjectMan(this);
	_inventoryMan = new InventoryMan(this);
	_textMan = new TextMan(this);
	_movsens = new MovesensMan(this);
	_groupMan = new GroupMan(this);
	_timeline = new Timeline(this);
	_displayMan->setUpScreens(320, 200);

	f463_initializeGame(); // @ F0463_START_InitializeGame_CPSADEF
	while (true) {
		f2_gameloop();
		warning("TODO: F0444_STARTEND_Endgame(G0303_B_PartyDead);");
	}

	return Common::kNoError;
}

void DMEngine::f2_gameloop() {
	warning("DUMMY CODE SETTING PARTY POS AND DIRECTION");
	_dungeonMan->_g306_partyMapX = 10;
	_dungeonMan->_g307_partyMapY = 4;
	_dungeonMan->_g308_partyDir = kDirNorth;


	warning("DUMMY CODE: setting InventoryMan::_g432_inventoryChampionOrdinal to zero");
	_inventoryMan->_g432_inventoryChampionOrdinal = 0;
	warning("DUMMY CODE: clearing screen to black"); // in loop below
	while (true) {
		_g321_stopWaitingForPlayerInput = false;

		_menuMan->f390_refreshActionAreaAndSetChampDirMaxDamageReceived();

		//do {
		_eventMan->processInput();
		_eventMan->f380_processCommandQueue();
		//} while (!_g321_stopWaitingForPlayerInput || !_g301_gameTimeTicking);

		if (!_inventoryMan->_g432_inventoryChampionOrdinal && !_championMan->_g300_partyIsSleeping) {
			Box box(0, 223, 0, 135);
			_displayMan->f135_fillBoxBitmap(_displayMan->_g296_bitmapViewport, box, k0_ColorBlack, k112_byteWidthViewport, k136_heightViewport); // dummy code
			_displayMan->f128_drawDungeon(_dungeonMan->_g308_partyDir, _dungeonMan->_g306_partyMapX, _dungeonMan->_g307_partyMapY);
		}

		// DUMMY CODE: next 2 lines
		_menuMan->f395_drawMovementArrows();
		_displayMan->f97_drawViewport(k1_viewportDungeonView);

		_displayMan->updateScreen();
		_system->delayMillis(10);
	}
}

int16 DMEngine::M1_ordinalToIndex(int16 val) {
	return val - 1;
}

int16 DMEngine::M0_indexToOrdinal(int16 val) {
	return val + 1;
}

} // End of namespace DM