scummvm/engines/lab/processroom.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.
 *
 */

/*
 * This code is based on Labyrinth of Time code with assistance of
 *
 * Copyright (c) 1993 Terra Nova Development
 * Copyright (c) 2004 The Wyrmkeep Entertainment Co.
 *
 */

#include "gui/message.h"

#include "lab/lab.h"
#include "lab/labfun.h"
#include "lab/parsetypes.h"
#include "lab/parsefun.h"
#include "lab/resource.h"
#include "lab/anim.h"
#include "lab/interface.h"

namespace Lab {

/* Global parser data */

#define NOFILE         "no file"

RoomData *_rooms;
InventoryData *Inventory;
uint16 NumInv, ManyRooms, HighestCondition, Direction;

extern bool DoNotDrawMessage, noupdatediff, QuitLab, MusicOn;

/*****************************************************************************/
/* Generates a random number.                                                */
/*****************************************************************************/
uint16 getRandom(uint16 max) {
	uint32 secs, micros;

	g_lab->getTime(&secs, &micros);
	return ((micros + secs) % max);
}

/*****************************************************************************/
/* Checks whether all the conditions in a condition list are met.            */
/*****************************************************************************/
static bool checkConditions(int16 *Condition) {
	int16 Counter;
	bool res;

	if (Condition == NULL)
		return true;

	if (Condition[0] == 0)
		return true;

	Counter = 1;
	res     = g_lab->_conditions->in(Condition[0]);

	while (Condition[Counter] && res) {
		res = g_lab->_conditions->in(Condition[Counter]);
		Counter++;
	}

	return res;
}

/*****************************************************************************/
/* Gets the current ViewDataPointer.                                         */
/*****************************************************************************/
ViewData *getViewData(uint16 roomNum, uint16 direction) {
	ViewData *view = NULL;

	if (!_rooms[roomNum]._roomMsg)
		g_lab->_resource->readViews(roomNum);

	if (direction == NORTH)
		view = _rooms[roomNum]._northView;
	else if (direction == SOUTH)
		view = _rooms[roomNum]._southView;
	else if (direction == EAST)
		view = _rooms[roomNum]._eastView;
	else if (direction == WEST)
		view = _rooms[roomNum]._westView;

	do {
		if (checkConditions(view->Condition))
			break;

		view = view->NextCondition;
	} while (true);

	return view;
}

/*****************************************************************************/
/* Gets an object, if any, from the user's click on the screen.              */
/*****************************************************************************/
static CloseData *getObject(uint16 x, uint16 y, CloseDataPtr lcptr) {
	ViewData *VPtr;

	if (lcptr == NULL) {
		VPtr = getViewData(g_lab->_roomNum, Direction);
		lcptr = VPtr->closeUps;
	}

	else
		lcptr = lcptr->SubCloseUps;


	while (lcptr != NULL) {
		if ((x >= scaleX(lcptr->x1)) && (y >= scaleY(lcptr->y1)) &&
		        (x <= scaleX(lcptr->x2)) && (y <= scaleY(lcptr->y2)))
			return lcptr;

		lcptr = lcptr->NextCloseUp;
	}

	return NULL;
}

/*****************************************************************************/
/* Goes through the list of closeups to find a match.                        */
/* NYI: Known bug here.  If there are two objects that have closeups, and    */
/*      some of the closeups have the same hit boxes, then this returns the  */
/*      first occurence of the object with the same hit box.                 */
/*****************************************************************************/
static CloseDataPtr findCPtrMatch(CloseDataPtr Main, CloseDataPtr List) {
	CloseDataPtr cptr;

	while (List) {
		if ((Main->x1 == List->x1) && (Main->x2 == List->x2) &&
		        (Main->y1 == List->y1) && (Main->y2 == List->y2) &&
		        (Main->depth == List->depth))
			return List;

		cptr = findCPtrMatch(Main, List->SubCloseUps);

		if (cptr)
			return cptr;
		else
			List = List->NextCloseUp;
	}

	return NULL;
}

/*****************************************************************************/
/* Returns the current picture name.                                         */
/*****************************************************************************/
char *getPictName(CloseDataPtr *lcptr) {
	ViewData *ViewPtr = getViewData(g_lab->_roomNum, Direction);

	if (*lcptr != NULL) {
		*lcptr = findCPtrMatch(*lcptr, ViewPtr->closeUps);

		if (*lcptr)
			return (*lcptr)->GraphicName;
	}

	return ViewPtr->GraphicName;
}

/*****************************************************************************/
/* Draws the current direction to the screen.                                */
/*****************************************************************************/
void LabEngine::drawDirection(CloseDataPtr lcptr) {
	if (lcptr != NULL && lcptr->Message) {
		drawMessage(lcptr->Message);
		return;
	}

	Common::String message;

	if (_rooms[_roomNum]._roomMsg) {
		message += _rooms[_roomNum]._roomMsg;
		message += ", ";
	}

	if (Direction == NORTH)
		message += _resource->getStaticText(kTextFacingNorth);
	else if (Direction == EAST)
		message += _resource->getStaticText(kTextFacingEast);
	else if (Direction == SOUTH)
		message += _resource->getStaticText(kTextFacingSouth);
	else if (Direction == WEST)
		message += _resource->getStaticText(kTextFacingWest);

	drawMessage(message.c_str());
}

/*****************************************************************************/
/* process a arrow gadget movement.                                          */
/*****************************************************************************/
bool processArrow(uint16 *direction, uint16 Arrow) {
	uint16 room = 1;

	if (Arrow == 1) { /* Forward */
		if (*direction == NORTH)
			room = _rooms[g_lab->_roomNum]._northDoor;
		else if (*direction == SOUTH)
			room = _rooms[g_lab->_roomNum]._southDoor;
		else if (*direction == EAST)
			room = _rooms[g_lab->_roomNum]._eastDoor;
		else if (*direction == WEST)
			room = _rooms[g_lab->_roomNum]._westDoor;

		if (room == 0)
			return false;
		else
			g_lab->_roomNum = room;
	} else if (Arrow == 0) { /* Left */
		if (*direction == NORTH)
			*direction = WEST;
		else if (*direction == WEST)
			*direction = SOUTH;
		else if (*direction == SOUTH)
			*direction = EAST;
		else
			*direction = NORTH;
	} else if (Arrow == 2) { /* Right */
		if (*direction == NORTH)
			*direction = EAST;
		else if (*direction == EAST)
			*direction = SOUTH;
		else if (*direction == SOUTH)
			*direction = WEST;
		else
			*direction = NORTH;
	}

	return true;
}

/*****************************************************************************/
/* Sets the current close up data.                                           */
/*****************************************************************************/
void setCurClose(Common::Point pos, CloseDataPtr *cptr, bool useAbsoluteCoords) {
	ViewData *VPtr;
	CloseDataPtr lcptr;
	uint16 x1, y1, x2, y2;

	if (*cptr == NULL) {
		VPtr = getViewData(g_lab->_roomNum, Direction);
		lcptr = VPtr->closeUps;
	} else
		lcptr = (*cptr)->SubCloseUps;

	while (lcptr != NULL) {
		if (!useAbsoluteCoords) {
			x1 = lcptr->x1;
			y1 = lcptr->y1;
			x2 = lcptr->x2;
			y2 = lcptr->y2;
		} else {
			x1 = scaleX(lcptr->x1);
			y1 = scaleY(lcptr->y1);
			x2 = scaleX(lcptr->x2);
			y2 = scaleY(lcptr->y2);
		}

		if (pos.x >= x1 && pos.y >= y1 && pos.x <= x2 && pos.y <= y2 && lcptr->GraphicName) {
			*cptr = lcptr;
			return;
		}

		lcptr = lcptr->NextCloseUp;
	}
}

/*****************************************************************************/
/* Takes the currently selected item.                                        */
/*****************************************************************************/
bool takeItem(uint16 x, uint16 y, CloseDataPtr *cptr) {
	ViewData *VPtr;
	CloseDataPtr lcptr;

	if (*cptr == NULL) {
		VPtr = getViewData(g_lab->_roomNum, Direction);
		lcptr = VPtr->closeUps;
	} else if ((*cptr)->CloseUpType < 0) {
		g_lab->_conditions->inclElement(abs((*cptr)->CloseUpType));
		return true;
	} else
		lcptr = (*cptr)->SubCloseUps;


	while (lcptr != NULL) {
		if ((x >= scaleX(lcptr->x1)) && (y >= scaleY(lcptr->y1)) &&
		        (x <= scaleX(lcptr->x2)) && (y <= scaleY(lcptr->y2)) &&
		        (lcptr->CloseUpType < 0)) {
			g_lab->_conditions->inclElement(abs(lcptr->CloseUpType));
			return true;
		}

		lcptr = lcptr->NextCloseUp;
	}

	return false;
}

/*****************************************************************************/
/* Processes the action list.                                                */
/*****************************************************************************/
static void doActions(Action *APtr, CloseDataPtr *lcptr) {
	CloseDataPtr tlcptr;
	bool FirstLoaded = true;
	char **str, *Test;
	uint32 StartSecs, StartMicros, CurSecs, CurMicros;

	while (APtr) {
		g_lab->_music->updateMusic();

		switch (APtr->ActionType) {
		case PLAYSOUND:
			g_lab->_music->_loopSoundEffect = false;
			g_lab->_music->_waitTillFinished = true;
			readMusic((char *)APtr->Data, true);
			g_lab->_music->_waitTillFinished = false;
			break;

		case PLAYSOUNDB:
			g_lab->_music->_loopSoundEffect = false;
			g_lab->_music->_waitTillFinished = false;
			readMusic((char *)APtr->Data, false);
			break;

		case PLAYSOUNDCONT:
			g_lab->_music->_doNotFilestopSoundEffect = true;
			g_lab->_music->_loopSoundEffect = true;
			readMusic((char *)APtr->Data, g_lab->_music->_waitTillFinished);
			break;

		case SHOWDIFF:
			readPict((char *)APtr->Data, true);
			break;

		case SHOWDIFFCONT:
			readPict((char *)APtr->Data, false);
			break;

		case LOADDIFF:
			if (FirstLoaded) {
				resetBuffer();
				FirstLoaded = false;
			}

			if (APtr->Data)
				g_lab->_music->newOpen((char *)APtr->Data);          /* Puts a file into memory */

			break;

		case WIPECMD:
			g_lab->doWipe(APtr->Param1, lcptr, (char *)APtr->Data);
			break;

		case NOUPDATE:
			noupdatediff = true;
			g_lab->_anim->_doBlack = false;
			break;

		case FORCEUPDATE:
			g_lab->_curFileName = " ";
			break;

		case SHOWCURPICT:
			Test = getPictName(lcptr);

			if (strcmp(Test, g_lab->_curFileName) != 0) {
				g_lab->_curFileName = Test;
				readPict(g_lab->_curFileName, true);
			}

			break;

		case SETELEMENT:
			g_lab->_conditions->inclElement(APtr->Param1);
			break;

		case UNSETELEMENT:
			g_lab->_conditions->exclElement(APtr->Param1);
			break;

		case SHOWMESSAGE:
			DoNotDrawMessage = false;

			if (g_lab->_longWinInFront)
				g_lab->longDrawMessage((char *)APtr->Data);
			else
				g_lab->drawMessage((char *)APtr->Data);

			DoNotDrawMessage = true;
			break;

		case CSHOWMESSAGE:
			if (*lcptr == NULL) {
				DoNotDrawMessage = false;
				g_lab->drawMessage((char *)APtr->Data);
				DoNotDrawMessage = true;
			}

			break;

		case SHOWMESSAGES:
			str = (char **)APtr->Data;
			DoNotDrawMessage = false;
			g_lab->drawMessage(str[getRandom(APtr->Param1)]);
			DoNotDrawMessage = true;
			break;

		case SETPOSITION:
			if (APtr->Param1 & 0x8000) {
				// This is a Wyrmkeep Windows trial version, thus stop at this
				// point, since we can't check for game payment status
				readPict(getPictName(lcptr), true);
				APtr = NULL;
				GUI::MessageDialog trialMessage("This is the end of the trial version. You can play the full game using the original interpreter from Wyrmkeep");
				trialMessage.runModal();
				continue;
			}

			g_lab->_roomNum   = APtr->Param1;
			Direction = APtr->Param2 - 1;
			*lcptr      = NULL;
			g_lab->_anim->_doBlack = true;
			break;

		case SETCLOSEUP:
			tlcptr = getObject(scaleX(APtr->Param1), scaleY(APtr->Param2), *lcptr);

			if (tlcptr)
				*lcptr = tlcptr;

			break;

		case MAINVIEW:
			*lcptr = NULL;
			break;

		case SUBINV:
			if (Inventory[APtr->Param1].Many)
				(Inventory[APtr->Param1].Many)--;

			if (Inventory[APtr->Param1].Many == 0)
				g_lab->_conditions->exclElement(APtr->Param1);

			break;

		case ADDINV:
			(Inventory[APtr->Param1].Many) += APtr->Param2;
			g_lab->_conditions->inclElement(APtr->Param1);
			break;

		case SHOWDIR:
			DoNotDrawMessage = false;
			break;

		case WAITSECS:
			g_lab->addCurTime(APtr->Param1, 0, &StartSecs, &StartMicros);

			g_lab->screenUpdate();

			while (1) {
				g_lab->_music->updateMusic();
				g_lab->_anim->diffNextFrame();
				g_lab->getTime(&CurSecs, &CurMicros);

				if ((CurSecs > StartSecs) || ((CurSecs == StartSecs) &&
				                              (CurMicros >= StartMicros)))
					break;
			}

			break;

		case STOPMUSIC:
			g_lab->_music->setMusic(false);
			break;

		case STARTMUSIC:
			g_lab->_music->setMusic(true);
			break;

		case CHANGEMUSIC:
			g_lab->_music->changeMusic((const char *)APtr->Data);
			g_lab->_music->setMusicReset(false);
			break;

		case RESETMUSIC:
			g_lab->_music->resetMusic();
			g_lab->_music->setMusicReset(true);
			break;

		case FILLMUSIC:
			g_lab->_music->updateMusic();
			break;

		case WAITSOUND:
			while (g_lab->_music->isSoundEffectActive()) {
				g_lab->_music->updateMusic();
				g_lab->_anim->diffNextFrame();
				g_lab->waitTOF();
			}

			break;

		case CLEARSOUND:
			if (g_lab->_music->_loopSoundEffect) {
				g_lab->_music->_loopSoundEffect = false;
				g_lab->_music->stopSoundEffect();
			} else if (g_lab->_music->isSoundEffectActive())
				g_lab->_music->stopSoundEffect();

			break;

		case WINMUSIC:
			g_lab->_music->_winmusic = true;
			g_lab->_music->freeMusic();
			g_lab->_music->initMusic();
			break;

		case WINGAME:
			QuitLab = true;
			break;

		case LOSTGAME:
			QuitLab = true;
			break;

		case RESETBUFFER:
			resetBuffer();
			break;

		case SPECIALCMD:
			if (APtr->Param1 == 0)
				g_lab->_anim->_doBlack = true;
			else if (APtr->Param1 == 1)
				g_lab->_anim->_doBlack = (g_lab->_cptr == NULL);
			else if (APtr->Param1 == 2)
				g_lab->_anim->_doBlack = (g_lab->_cptr != NULL);
			else if (APtr->Param1 == 5) { /* inverse the palette */
				for (uint16 idx = (8 * 3); idx < (255 * 3); idx++)
					g_lab->_anim->_diffPalette[idx] = 255 - g_lab->_anim->_diffPalette[idx];

				g_lab->waitTOF();
				g_lab->setPalette(g_lab->_anim->_diffPalette, 256);
				g_lab->waitTOF();
				g_lab->waitTOF();
			} else if (APtr->Param1 == 4) { /* white the palette */
				whiteScreen();
				g_lab->waitTOF();
				g_lab->waitTOF();
			} else if (APtr->Param1 == 6) { /* Restore the palette */
				g_lab->waitTOF();
				g_lab->setPalette(g_lab->_anim->_diffPalette, 256);
				g_lab->waitTOF();
				g_lab->waitTOF();
			} else if (APtr->Param1 == 7) { /* Quick pause */
				g_lab->waitTOF();
				g_lab->waitTOF();
				g_lab->waitTOF();
			}

			break;
		}

		APtr = APtr->NextAction;
	}

	if (g_lab->_music->_loopSoundEffect) {
		g_lab->_music->_loopSoundEffect = false;
		g_lab->_music->stopSoundEffect();
	} else {
		while (g_lab->_music->isSoundEffectActive()) {
			g_lab->_music->updateMusic();
			g_lab->_anim->diffNextFrame();
			g_lab->waitTOF();
		}
	}

	g_lab->_music->_doNotFilestopSoundEffect = false;
}

/*****************************************************************************/
/* Does the work for doActionRule.                                           */
/*****************************************************************************/
static bool doActionRuleSub(int16 action, int16 roomNum, CloseDataPtr lcptr, CloseDataPtr *Set, bool AllowDefaults) {
	action++;

	if (lcptr) {
		RuleList *rules = _rooms[g_lab->_roomNum]._rules;

		if ((rules == NULL) && (roomNum == 0)) {
			g_lab->_resource->readViews(roomNum);
			rules = _rooms[roomNum]._rules;
		}

		for (RuleList::iterator rule = rules->begin(); rule != rules->end(); ++rule) {
			if (((*rule)->RuleType == ACTION) &&
				(((*rule)->Param1 == action) || (((*rule)->Param1 == 0) && AllowDefaults))) {
				if ((((*rule)->Param2 == lcptr->CloseUpType) ||
					(((*rule)->Param2 == 0) && AllowDefaults))
				        ||
						((action == 1) && ((*rule)->Param2 == (-lcptr->CloseUpType)))) {
					if (checkConditions((*rule)->Condition)) {
						doActions((*rule)->ActionList, Set);
						return true;
					}
				}
			}
		}
	}

	return false;
}

/*****************************************************************************/
/* Goes through the rules if an action is taken.                             */
/*****************************************************************************/
bool doActionRule(Common::Point pos, int16 action, int16 roomNum, CloseDataPtr *lcptr) {
	CloseDataPtr tlcptr;

	if (roomNum)
		g_lab->_newFileName = NOFILE;
	else
		g_lab->_newFileName = g_lab->_curFileName;

	tlcptr = getObject(pos.x, pos.y, *lcptr);

	if (doActionRuleSub(action, roomNum, tlcptr, lcptr, false))
		return true;
	else if (doActionRuleSub(action, roomNum, *lcptr, lcptr, false))
		return true;
	else if (doActionRuleSub(action, roomNum, tlcptr, lcptr, true))
		return true;
	else if (doActionRuleSub(action, roomNum, *lcptr, lcptr, true))
		return true;

	return false;
}

/*****************************************************************************/
/* Does the work for doActionRule.                                           */
/*****************************************************************************/
static bool doOperateRuleSub(int16 ItemNum, int16 roomNum, CloseDataPtr lcptr, CloseDataPtr *Set, bool AllowDefaults) {
	if (lcptr)
		if (lcptr->CloseUpType > 0) {
			RuleList *rules = _rooms[roomNum]._rules;

			if ((rules == NULL) && (roomNum == 0)) {
				g_lab->_resource->readViews(roomNum);
				rules = _rooms[roomNum]._rules;
			}

			for (RuleList::iterator rule = rules->begin(); rule != rules->end(); ++rule) {
				if (((*rule)->RuleType == OPERATE) &&
				        (((*rule)->Param1 == ItemNum) || (((*rule)->Param1 == 0) && AllowDefaults)) &&
						(((*rule)->Param2 == lcptr->CloseUpType) || (((*rule)->Param2 == 0) && AllowDefaults))) {
					if (checkConditions((*rule)->Condition)) {
						doActions((*rule)->ActionList, Set);
						return true;
					}
				}
			}
		}

	return false;
}

/*****************************************************************************/
/* Goes thru the rules if the user tries to operate an item on an object.    */
/*****************************************************************************/
bool doOperateRule(int16 x, int16 y, int16 ItemNum, CloseDataPtr *lcptr) {
	CloseDataPtr tlcptr;

	g_lab->_newFileName = NOFILE;

	tlcptr = getObject(x, y, *lcptr);

	if (doOperateRuleSub(ItemNum, g_lab->_roomNum, tlcptr, lcptr, false))
		return true;
	else if (doOperateRuleSub(ItemNum, g_lab->_roomNum, *lcptr, lcptr, false))
		return true;
	else if (doOperateRuleSub(ItemNum, g_lab->_roomNum, tlcptr, lcptr, true))
		return true;
	else if (doOperateRuleSub(ItemNum, g_lab->_roomNum, *lcptr, lcptr, true))
		return true;
	else {
		g_lab->_newFileName = g_lab->_curFileName;

		if (doOperateRuleSub(ItemNum, 0, tlcptr, lcptr, false))
			return true;
		else if (doOperateRuleSub(ItemNum, 0, *lcptr, lcptr, false))
			return true;
		else if (doOperateRuleSub(ItemNum, 0, tlcptr, lcptr, true))
			return true;
		else if (doOperateRuleSub(ItemNum, 0, *lcptr, lcptr, true))
			return true;
	}

	return false;
}

/*****************************************************************************/
/* Goes thru the rules if the user tries to go forward.                      */
/*****************************************************************************/
bool doGoForward(CloseDataPtr *lcptr) {
	RuleList *rules = _rooms[g_lab->_roomNum]._rules;

	for (RuleList::iterator rule = rules->begin(); rule != rules->end(); ++rule) {
		if (((*rule)->RuleType == GOFORWARD) && ((*rule)->Param1 == (Direction + 1))) {
			if (checkConditions((*rule)->Condition)) {
				doActions((*rule)->ActionList, lcptr);
				return true;
			}
		}
	}

	return false;
}

/*****************************************************************************/
/* Goes thru the rules if the user tries to turn.                            */
/*****************************************************************************/
bool doTurn(uint16 from, uint16 to, CloseDataPtr *lcptr) {
	from++;
	to++;

	RuleList *rules = _rooms[g_lab->_roomNum]._rules;

	for (RuleList::iterator rule = rules->begin(); rule != rules->end(); ++rule) {
		if (((*rule)->RuleType == TURN) ||
		        (((*rule)->RuleType == TURNFROMTO) &&
		         ((*rule)->Param1   == from) && ((*rule)->Param2 == to))) {
			if (checkConditions((*rule)->Condition)) {
				doActions((*rule)->ActionList, lcptr);
				return true;
			}
		}
	}

	return false;
}

/*****************************************************************************/
/* Goes thru the rules if the user tries to go to the main view              */
/*****************************************************************************/
bool doMainView(CloseDataPtr *lcptr) {
	RuleList *rules = _rooms[g_lab->_roomNum]._rules;
	for (RuleList::iterator rule = rules->begin(); rule != rules->end(); ++rule) {
		if ((*rule)->RuleType == GOMAINVIEW) {
			if (checkConditions((*rule)->Condition)) {
				doActions((*rule)->ActionList, lcptr);
				return true;
			}
		}
	}

	return false;
}

} // End of namespace Lab