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 "common/array.h"
#include "common/algorithm.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"
#include "projexpl.h"
#include "dialog.h"

namespace DM {
void warning(bool repeat, const char* s, ...) {
	va_list va;

	va_start(va, s);
	Common::String output = Common::String::vformat(s, va);
	va_end(va);

	if (repeat) {
		::warning(output.c_str());
	} else {
		static Common::Array<Common::String> stringsPrinted;

		if (Common::find(stringsPrinted.begin(), stringsPrinted.end(), s) == stringsPrinted.end()) {
			stringsPrinted.push_back(output);
			::warning(output.c_str());
		}
	}
}

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 toggleFlag(uint16& val, uint16 mask) {
	return val ^= mask;
}

uint16 M75_bitmapByteCount(uint16 pixelWidth, uint16 height) {
	return pixelWidth / 2 * height;
}

uint16 M21_normalizeModulo4(uint16 val) {
	return val & 3;
}

int32 M30_time(int32 mapTime) {
	return mapTime & 0x00FFFFFF;
}

int32 M33_setMapAndTime(int32 &mapTime, uint32 map, uint32 time) {
	return (mapTime) = ((time) | (((long)(map)) << 24));
}

uint16 M29_map(int32 mapTime) {
	return ((uint16)((mapTime) >> 24));
}

Thing M15_thingWithNewCell(Thing thing, int16 cell) {
	return Thing(((thing.toUint16()) & 0x3FFF) | ((cell) << 14));
}

int16 M38_distance(int16 mapx1, int16 mapy1, int16 mapx2, int16 mapy2) {
	return ABS(mapx1 - mapx2) + ABS(mapy1 - mapy2);
}

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;
	_objectMan = nullptr;
	_inventoryMan = nullptr;
	_textMan = nullptr;
	_moveSens = nullptr;
	_groupMan = nullptr;
	_timeline = nullptr;
	_projexpl = nullptr;
	_displayMan = nullptr;

	_g528_saveFormat = 0;
	_g527_platform = 0;
	_g526_dungeonId = 0;

	_g298_newGame = false;
	_g523_restartGameRequest = false;
	_g321_stopWaitingForPlayerInput = true;
	_g301_gameTimeTicking = false;
	_g524_restartGameAllowed = false;
	_g525_gameId = 0;
	_g331_pressingEye = false;
	_g332_stopPressingEye = false;
	_g333_pressingMouth = false;
	_g334_stopPressingMouth = false;
	_g340_highlightBoxInversionRequested = false;
	_g311_projectileDisableMovementTicks = 0;
	_g312_lastProjectileDisabledMovementDirection = 0;
	_g302_gameWon = false;
	_g327_newPartyMapIndex = kM1_mapIndexNone;
	_g325_setMousePointerToObjectInMainLoop = false;
	_g310_disabledMovementTicks = 0;
	_g313_gameTime = 0;
	_g353_stringBuildBuffer[0] = '\0';
	_g318_waitForInputMaxVerticalBlankCount = 0;
	for (uint16 i = 0; i < 10; ++i)
		_g562_entranceDoorAnimSteps[i] = nullptr;
	_g564_interfaceCredits = nullptr;
	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 _objectMan;
	delete _inventoryMan;
	delete _textMan;
	delete _moveSens;
	delete _groupMan;
	delete _timeline;
	delete _projexpl;
	delete _dialog;

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

bool DMEngine::hasFeature(EngineFeature f) const {
	return
		(f == kSupportsSavingDuringRuntime) ||
		(f == kSupportsLoadingDuringRuntime);
}

void DMEngine::f22_delay(uint16 verticalBlank) {
	_system->delayMillis(verticalBlank * 20); // Google says most Amiga games had a refreshrate of 50 hz
}

uint16 DMEngine::f30_getScaledProduct(uint16 val, uint16 scale, uint16 vale2) {
	return ((uint32)val * vale2) >> scale;
}

void DMEngine::f463_initializeGame() {
	_displayMan->f479_loadGraphics();
	_displayMan->f460_initializeGraphicData();
	warning(false, "Dummy code in f463_initializeGame, setting palette");
	_displayMan->loadPalette(g21_PalDungeonView[0]);
	_displayMan->f94_loadFloorSet(k0_FloorSetStone);
	_displayMan->f95_loadWallSet(k0_WallSetStone);

	_textMan->f54_textInitialize();
	_objectMan->loadObjectNames();
	_eventMan->initMouse();
	f441_processEntrance();
	while (f435_loadgame(1) != k1_LoadgameSuccess) {
		f441_processEntrance();
	}
	//F0396_MENUS_LoadSpellAreaLinesBitmap() is not needed, every bitmap has been loaded

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

	f462_startGame();
	if (_g298_newGame)
		_moveSens->f267_getMoveResult(Thing::_party, kM1_MapXNotOnASquare, 0, _dungeonMan->_g306_partyMapX, _dungeonMan->_g307_partyMapY);
	_eventMan->f78_showMouse();
	_eventMan->f357_discardAllInput();
}

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

void DMEngine::f462_startGame() {
	static Box g61_boxScreenTop(0, 319, 0, 32); // @ G0061_s_Graphic562_Box_ScreenTop
	static Box g62_boxScreenRight(224, 319, 33, 169); // @ G0062_s_Graphic562_Box_ScreenRight
	static Box g63_boxScreenBottom(0, 319, 169, 199); // @ G0063_s_Graphic562_Box_ScreenBottom


	_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;
	_eventMan->_g443_primaryKeyboardInput = g458_primaryKeyboardInput_interface;
	_eventMan->_g444_secondaryKeyboardInput = g459_secondaryKeyboardInput_movement;

	f3_processNewPartyMap(_dungeonMan->_g309_partyMapIndex);

	if (!_g298_newGame) {
		_displayMan->_g578_useByteBoxCoordinates = false;
		f22_delay(1);
		_displayMan->D24_fillScreenBox(g61_boxScreenTop, k0_ColorBlack);
		_displayMan->D24_fillScreenBox(g62_boxScreenRight, k0_ColorBlack);
		_displayMan->D24_fillScreenBox(g63_boxScreenBottom, k0_ColorBlack);
	} else {
		_displayMan->_g578_useByteBoxCoordinates = false;
		_displayMan->D24_fillScreenBox(g61_boxScreenTop, k0_ColorBlack);
		_displayMan->D24_fillScreenBox(g62_boxScreenRight, k0_ColorBlack);
		_displayMan->D24_fillScreenBox(g63_boxScreenBottom, k0_ColorBlack);
	}

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

void DMEngine::f3_processNewPartyMap(uint16 mapIndex) {
	_groupMan->f194_removeAllActiveGroups();
	_dungeonMan->f174_setCurrentMapAndPartyMap(mapIndex);
	_displayMan->f96_loadCurrentMapGraphics();
	_groupMan->f195_addAllActiveGroups();
	_inventoryMan->f337_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);
	_objectMan = new ObjectMan(this);
	_inventoryMan = new InventoryMan(this);
	_textMan = new TextMan(this);
	_moveSens = new MovesensMan(this);
	_groupMan = new GroupMan(this);
	_timeline = new Timeline(this);
	_projexpl = new ProjExpl(this);
	_dialog = new DialogMan(this);
	_displayMan->setUpScreens(320, 200);

	f463_initializeGame();
	while (true) {
		f2_gameloop();
		warning(false, "TODO: F0444_STARTEND_Endgame(G0303_B_PartyDead);");
	}

	return Common::kNoError;
}

void DMEngine::f2_gameloop() {
	if (_g298_newGame) {
		warning(false, "DUMMY CODE: SETTING PARTY POS AND DIRECTION");
		_dungeonMan->_g306_partyMapX = 9;
		_dungeonMan->_g307_partyMapY = 9;
		_dungeonMan->_g308_partyDir = kDirWest;
	}

	_g318_waitForInputMaxVerticalBlankCount = 10;
	while (true) {
		if (_g327_newPartyMapIndex != kM1_mapIndexNone) {
T0002002:
			f3_processNewPartyMap(_g327_newPartyMapIndex);
			_moveSens->f267_getMoveResult(Thing::_party, kM1_MapXNotOnASquare, 0, _dungeonMan->_g306_partyMapX, _dungeonMan->_g307_partyMapY);
			_g327_newPartyMapIndex = kM1_mapIndexNone;
			_eventMan->f357_discardAllInput();
		}
		_timeline->f261_processTimeline();

		if (_g327_newPartyMapIndex != kM1_mapIndexNone)
			goto T0002002;

		if (!_inventoryMan->_g432_inventoryChampionOrdinal && !_championMan->_g300_partyIsSleeping) {
			Box box(0, 223, 0, 135);
			warning(false, "DUMMY CODE: clearing screen to black");
			_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);
			if (_g325_setMousePointerToObjectInMainLoop) {
				_g325_setMousePointerToObjectInMainLoop = false;
				_eventMan->f78_showMouse();
				_eventMan->f68_setPointerToObject(_objectMan->_g412_objectIconForMousePointer);
				_eventMan->f77_hideMouse();

			}
			if (_eventMan->_g326_refreshMousePointerInMainLoop) {
				_eventMan->_g326_refreshMousePointerInMainLoop = false;
				_eventMan->_g598_mousePointerBitmapUpdated = true;
				_eventMan->f78_showMouse();
				_eventMan->f77_hideMouse();
			}
		}
		// F0363_COMMAND_HighlightBoxDisable();
		// F0065_SOUND_PlayPendingSound_CPSD();
		_championMan->f320_applyAndDrawPendingDamageAndWounds();
		if (_championMan->_g303_partyDead)
			break;
		_g313_gameTime++;

		if (!(_g313_gameTime & 511))
			_inventoryMan->f338_decreaseTorchesLightPower();

		if (_championMan->_g407_party._freezeLifeTicks)
			_championMan->_g407_party._freezeLifeTicks -= 1;

		_menuMan->f390_refreshActionAreaAndSetChampDirMaxDamageReceived();

		if (!(_g313_gameTime & (_championMan->_g300_partyIsSleeping ? 15 : 63))) {
			_championMan->f331_applyTimeEffects();
		}

		if (_g310_disabledMovementTicks)
			_g310_disabledMovementTicks--;

		if (_g311_projectileDisableMovementTicks)
			_g311_projectileDisableMovementTicks--;

		_textMan->f44_messageAreaClearExpiredRows();
		_g321_stopWaitingForPlayerInput = false;
		uint16 vblankCounter = 0;
		do {
			_eventMan->processInput();

			if (_g332_stopPressingEye) {
				_g331_pressingEye = false;
				_g332_stopPressingEye = false;
				_inventoryMan->f353_drawStopPressingEye();
			} else if (_g334_stopPressingMouth) {
				_g333_pressingMouth = false;
				_g334_stopPressingMouth = false;
				_inventoryMan->f350_drawStopPressingMouth();
			}

			_eventMan->f380_processCommandQueue();
			_displayMan->updateScreen();
			// if (!_vm->_g321_stopWaitingForPlayerInput) {
			//		F0363_COMMAND_HighlightBoxDisable();
			// }

			_system->delayMillis(2);
			if (++vblankCounter >= _g318_waitForInputMaxVerticalBlankCount * 5)
				_g321_stopWaitingForPlayerInput = true;

		} while (!_g321_stopWaitingForPlayerInput || !_g301_gameTimeTicking);
	}
}

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

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


void DMEngine::f441_processEntrance() {
	uint16 L1402_ui_AnimationStep;
	Box L1405_s_Box;

	_eventMan->_g441_primaryMouseInput = g445_PrimaryMouseInput_Entrance;
	_eventMan->_g442_secondaryMouseInput = nullptr;
	_eventMan->_g443_primaryKeyboardInput = nullptr;
	_eventMan->_g444_secondaryKeyboardInput = nullptr;
	_g562_entranceDoorAnimSteps[0] = new byte[128 * 161 * 12];
	for (L1402_ui_AnimationStep = 1; L1402_ui_AnimationStep < 8; L1402_ui_AnimationStep++) {
		_g562_entranceDoorAnimSteps[L1402_ui_AnimationStep] = _g562_entranceDoorAnimSteps[L1402_ui_AnimationStep - 1] + 128 * 161;
	}
	_g562_entranceDoorAnimSteps[8] = _g562_entranceDoorAnimSteps[7] + 128 * 161;
	_g562_entranceDoorAnimSteps[9] = _g562_entranceDoorAnimSteps[8] + 128 * 161 * 2;

	_displayMan->f466_loadIntoBitmap(k3_entranceRightDoorGraphicIndice, _g562_entranceDoorAnimSteps[4]);
	_displayMan->f466_loadIntoBitmap(k2_entranceLeftDoorGraphicIndice, _g562_entranceDoorAnimSteps[0]);
	_g564_interfaceCredits = _displayMan->f489_getNativeBitmapOrGraphic(k5_creditsGraphicIndice);
	_displayMan->_g578_useByteBoxCoordinates = false;
	L1405_s_Box._x1 = 0;
	L1405_s_Box._x2 = 100;
	L1405_s_Box._y1 = 0;
	L1405_s_Box._y2 = 160;
	for (L1402_ui_AnimationStep = 1; L1402_ui_AnimationStep < 4; L1402_ui_AnimationStep++) {
		_displayMan->f132_blitToBitmap(_g562_entranceDoorAnimSteps[0], _g562_entranceDoorAnimSteps[L1402_ui_AnimationStep], L1405_s_Box, L1402_ui_AnimationStep << 2, 0, k64_byteWidth, k64_byteWidth, kM1_ColorNoTransparency, 161, 161);
		L1405_s_Box._x2 -= 4;
	}
	L1405_s_Box._x2 = 127;
	for (L1402_ui_AnimationStep = 5; L1402_ui_AnimationStep < 8; L1402_ui_AnimationStep++) {
		L1405_s_Box._x1 += 4;
		_displayMan->f132_blitToBitmap(_g562_entranceDoorAnimSteps[4], _g562_entranceDoorAnimSteps[L1402_ui_AnimationStep], L1405_s_Box, 0, 0, k64_byteWidth, k64_byteWidth, kM1_ColorNoTransparency, 161, 161);
	}
	do {
		f439_drawEntrance();
		_eventMan->f78_showMouse();
		_eventMan->f357_discardAllInput();
		_g298_newGame = k99_modeWaitingOnEntrance;
		do {
			_eventMan->processInput();
			_eventMan->f380_processCommandQueue();
			_displayMan->updateScreen();
		} while (_g298_newGame == k99_modeWaitingOnEntrance);
	} while (_g298_newGame == k202_CommandEntranceDrawCredits);
	//Strangerke: CHECKME: Earlier versions were using G0566_puc_Graphic534_Sound01Switch
	warning(false, "MISSING CODE: F0060_SOUND_Play");
	f22_delay(20);
	_eventMan->f78_showMouse();
	if (_g298_newGame) {
		warning(false, "MISSING CODE: F0438_STARTEND_OpenEntranceDoors();");
	}
	delete[] _g562_entranceDoorAnimSteps[0];
	for (uint16 i = 0; i < 10; ++i)
		_g562_entranceDoorAnimSteps[i] = nullptr;
}

void DMEngine::f439_drawEntrance() {
	static Box K0079_s_Box_Entrance_DoorsUpperHalf = Box(0, 231, 0, 80);
	static Box K0152_s_Box_Entrance_DoorsLowerHalf = Box(0, 231, 81, 160);
	static Box G0010_s_Graphic562_Box_Entrance_ClosedDoorLeft = Box(0, 104, 30, 190);
	static Box G0011_s_Graphic562_Box_Entrance_ClosedDoorRight = Box(105, 231, 30, 190);

	uint16 L1397_ui_ColumnIndex;
	byte* L1398_apuc_MicroDungeonCurrentMapData[32];
	Square L1399_auc_MicroDungeonSquares[25];

	_dungeonMan->_g309_partyMapIndex = k255_mapIndexEntrance;
	_displayMan->_g297_drawFloorAndCeilingRequested = true;
	_dungeonMan->_g273_currMapWidth = 5;
	_dungeonMan->_g274_currMapHeight = 5;
	_dungeonMan->_g271_currMapData = L1398_apuc_MicroDungeonCurrentMapData;

	Map map; // uninitialized, won't be used
	_dungeonMan->_g269_currMap = &map;
	for (uint16 i = 0; i < 25; ++i)
		L1399_auc_MicroDungeonSquares[i] = Square(k0_ElementTypeWall, 0);
	for (L1397_ui_ColumnIndex = 0; L1397_ui_ColumnIndex < 5; L1397_ui_ColumnIndex++) {
		L1398_apuc_MicroDungeonCurrentMapData[L1397_ui_ColumnIndex] = (byte*)&L1399_auc_MicroDungeonSquares[L1397_ui_ColumnIndex * 5];
		L1399_auc_MicroDungeonSquares[L1397_ui_ColumnIndex + 10] = Square(k1_CorridorElemType, 0);
	}
	L1399_auc_MicroDungeonSquares[7] = Square(k1_CorridorElemType, 0);
	warning(false, "MISSING CODE: F0436_STARTEND_FadeToPalette(G0345_aui_BlankBuffer);");

	// note, a global variable is used here in the original
	_displayMan->f466_loadIntoBitmap(k4_entranceGraphicIndice, _displayMan->_g348_bitmapScreen);
	_displayMan->f128_drawDungeon(kDirSouth, 2, 0);
	warning(false, "IGNORED CODE: G0324_B_DrawViewportRequested = false;");

	_displayMan->_g578_useByteBoxCoordinates = false, _displayMan->f132_blitToBitmap(_displayMan->_g348_bitmapScreen, _g562_entranceDoorAnimSteps[8], K0079_s_Box_Entrance_DoorsUpperHalf, 0, 30, k160_byteWidthScreen, k128_byteWidth, kM1_ColorNoTransparency, 200, 161);
	_displayMan->_g578_useByteBoxCoordinates = false, _displayMan->f132_blitToBitmap(_displayMan->_g348_bitmapScreen, _g562_entranceDoorAnimSteps[8], K0152_s_Box_Entrance_DoorsLowerHalf, 0, 111, k160_byteWidthScreen, k128_byteWidth, kM1_ColorNoTransparency, 200, 161);

	_displayMan->f21_blitToScreen(_g562_entranceDoorAnimSteps[0], &G0010_s_Graphic562_Box_Entrance_ClosedDoorLeft, k64_byteWidth, kM1_ColorNoTransparency, 161);
	_displayMan->f21_blitToScreen(_g562_entranceDoorAnimSteps[4], &G0011_s_Graphic562_Box_Entrance_ClosedDoorRight, k64_byteWidth, kM1_ColorNoTransparency, 161);
	warning(false, "MISSING CODE: F0436_STARTEND_FadeToPalette(g20_PalEntrance);");
}

} // End of namespace DM