Merge pull request #636 from sev-/lab

This is a pull request for the game The Labyrinth of Time. This game is
currently available on www.wyrmkeep.com and on GOG.com. The game should
be completable: it was completable a month ago and we did regularly
regression testing. All the work has been based on sources kindly
provided by Wyrmkeep.

The DOS and the Windows versions are supported by this engine.

This is a manual merge of the PR, with some history fixups.

1 files changed, 478 insertions, 0 deletions

diff --git a/engines/lab/special.cpp b/engines/lab/special.cpp
new file mode 100644
index 0000000000..649c725102
--- /dev/null
+++ b/engines/lab/special.cpp
@@ -0,0 +1,478 @@
+/* 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 "lab/lab.h"
+
+#include "lab/anim.h"
+#include "lab/dispman.h"
+#include "lab/eventman.h"
+#include "lab/image.h"
+#include "lab/labsets.h"
+#include "lab/music.h"
+#include "lab/processroom.h"
+#include "lab/resource.h"
+#include "lab/utils.h"
+
+namespace Lab {
+#define BRIDGE0     148
+#define BRIDGE1     104
+#define DIRTY       175
+#define NONEWS      135
+#define NOCLEAN     152
+
+void LabEngine::doNotes() {
+	TextFont *noteFont = _resource->getFont("F:Note.fon");
+	Common::String noteText = _resource->getText("Lab:Rooms/Notes");
+
+	Common::Rect textRect = Common::Rect(_utils->vgaScaleX(25) + _utils->svgaCord(15), _utils->vgaScaleY(50), _utils->vgaScaleX(295) - _utils->svgaCord(15), _utils->vgaScaleY(148));
+	_graphics->flowText(noteFont, -2 + _utils->svgaCord(1), 0, 0, false, false, true, true, textRect, noteText.c_str());
+	_graphics->setPalette(_anim->_diffPalette, 256);
+	_graphics->closeFont(&noteFont);
+}
+
+void LabEngine::doWestPaper() {
+	TextFont *paperFont = _resource->getFont("F:News22.fon");
+	Common::String paperText = _resource->getText("Lab:Rooms/Date");
+
+	Common::Rect textRect = Common::Rect(_utils->vgaScaleX(57), _utils->vgaScaleY(77) + _utils->svgaCord(2), _utils->vgaScaleX(262), _utils->vgaScaleY(91));
+	_graphics->flowText(paperFont, 0, 0, 0, false, true, false, true, textRect, paperText.c_str());
+	_graphics->closeFont(&paperFont);
+
+	paperFont = _resource->getFont("F:News32.fon");
+	paperText = _resource->getText("Lab:Rooms/Headline");
+
+	int fileLen = paperText.size() - 1;
+	textRect = Common::Rect(_utils->vgaScaleX(57), _utils->vgaScaleY(86) - _utils->svgaCord(2), _utils->vgaScaleX(262), _utils->vgaScaleY(118));
+	int charsPrinted = _graphics->flowText(paperFont, -8, 0, 0, false, true, false, true, textRect, paperText.c_str());
+
+	uint16 y;
+
+	if (charsPrinted < fileLen) {
+		y = 130 - _utils->svgaCord(5);
+		textRect = Common::Rect(_utils->vgaScaleX(57), _utils->vgaScaleY(86) - _utils->svgaCord(2), _utils->vgaScaleX(262), _utils->vgaScaleY(132));
+		_graphics->flowText(paperFont, -8 - _utils->svgaCord(1), 0, 0, false, true, false, true, textRect, paperText.c_str());
+	} else
+		y = 115 - _utils->svgaCord(5);
+
+	_graphics->closeFont(&paperFont);
+
+	paperFont = _resource->getFont("F:Note.fon");
+	paperText = _resource->getText("Lab:Rooms/Col1");
+	_graphics->flowText(paperFont, -4, 0, 0, false, false, false, true, _utils->vgaRectScale(45, y, 158, 148), paperText.c_str());
+
+	paperText = _resource->getText("Lab:Rooms/Col2");
+	_graphics->flowText(paperFont, -4, 0, 0, false, false, false, true, _utils->vgaRectScale(162, y, 275, 148), paperText.c_str());
+
+	_graphics->closeFont(&paperFont);
+	_graphics->setPalette(_anim->_diffPalette, 256);
+}
+
+void LabEngine::loadJournalData() {
+	if (_journalFont)
+		_graphics->closeFont(&_journalFont);
+
+	_journalFont = _resource->getFont("F:Journal.fon");
+	updateMusicAndEvents();
+
+	Common::String filename = "Lab:Rooms/j0";
+
+	bool bridge = _conditions->in(BRIDGE0) || _conditions->in(BRIDGE1);
+	bool dirty  = _conditions->in(DIRTY);
+	bool news   = !_conditions->in(NONEWS);
+	bool clean  = !_conditions->in(NOCLEAN);
+
+	if (bridge && clean && news)
+		filename += '8';
+	else if (clean && news)
+		filename += '9';
+	else if (bridge && clean)
+		filename += '6';
+	else if (clean)
+		filename += '7';
+	else if (bridge && dirty && news)
+		filename += '4';
+	else if (dirty && news)
+		filename += '5';
+	else if (bridge && dirty)
+		filename += '2';
+	else if (dirty)
+		filename += '3';
+	else if (bridge)
+		filename += '1';
+
+	_journalText = _resource->getText(filename);
+	_journalTextTitle = _resource->getText("Lab:Rooms/jt");
+
+	Common::File *journalFile = _resource->openDataFile("P:JImage");
+	_journalButtonList.push_back(_event->createButton( 80, _utils->vgaScaleY(162) + _utils->svgaCord(1), 0, VKEY_LTARROW, new Image(journalFile, this), new Image(journalFile, this)));	// back
+	_journalButtonList.push_back(_event->createButton(194, _utils->vgaScaleY(162) + _utils->svgaCord(1), 2,            0, new Image(journalFile, this), new Image(journalFile, this)));	// cancel
+	_journalButtonList.push_back(_event->createButton(144, _utils->vgaScaleY(164) - _utils->svgaCord(1), 1, VKEY_RTARROW, new Image(journalFile, this), new Image(journalFile, this)));	// forward
+	delete journalFile;
+
+	_anim->_noPalChange = true;
+	_journalBackImage->_imageData = new byte[_graphics->_screenWidth * _graphics->_screenHeight];
+	_graphics->readPict("P:Journal.pic", true, false, _journalBackImage->_imageData);
+	_anim->_noPalChange = false;
+
+	// Keep a copy of the blank journal
+	_blankJournal = new byte[_graphics->_screenWidth * _graphics->_screenHeight];
+	memcpy(_blankJournal, _journalBackImage->_imageData, _graphics->_screenWidth * _graphics->_screenHeight);
+
+	_screenImage->_imageData = _graphics->getCurrentDrawingBuffer();
+}
+
+void LabEngine::drawJournalText() {
+	uint16 drawingToPage = 1;
+	int charsDrawn = 0;
+	const char *curText = _journalText.c_str();
+
+	while (drawingToPage < _journalPage) {
+		updateMusicAndEvents();
+		curText = _journalText.c_str() + charsDrawn;
+		charsDrawn += _graphics->flowText(_journalFont, -2, 2, 0, false, false, false, false, _utils->vgaRectScale(52, 32, 152, 148), curText);
+
+		_lastPage = (*curText == 0);
+
+		if (_lastPage)
+			_journalPage = (drawingToPage / 2) * 2;
+		else
+			drawingToPage++;
+	}
+
+	if (_journalPage <= 1) {
+		curText = _journalTextTitle.c_str();
+		_graphics->flowTextToMem(_journalBackImage, _journalFont, -2, 2, 0, false, true, true, true, _utils->vgaRectScale(52, 32, 152, 148), curText);
+	} else {
+		curText = _journalText.c_str() + charsDrawn;
+		charsDrawn += _graphics->flowTextToMem(_journalBackImage, _journalFont, -2, 2, 0, false, false, false, true, _utils->vgaRectScale(52, 32, 152, 148), curText);
+	}
+
+	updateMusicAndEvents();
+	curText = _journalText.c_str() + charsDrawn;
+	_lastPage = (*curText == 0);
+	_graphics->flowTextToMem(_journalBackImage, _journalFont, -2, 2, 0, false, false, false, true, _utils->vgaRectScale(171, 32, 271, 148), curText);
+}
+
+void LabEngine::turnPage(bool fromLeft) {
+	if (fromLeft) {
+		for (int i = 0; i < _graphics->_screenWidth; i += 8) {
+			updateMusicAndEvents();
+			waitTOF();
+			_screenImage->_imageData = _graphics->getCurrentDrawingBuffer();
+			_journalBackImage->blitBitmap(i, 0, _screenImage, i, 0, 8, _graphics->_screenHeight, false);
+		}
+	} else {
+		for (int i = (_graphics->_screenWidth - 8); i > 0; i -= 8) {
+			updateMusicAndEvents();
+			waitTOF();
+			_screenImage->_imageData = _graphics->getCurrentDrawingBuffer();
+			_journalBackImage->blitBitmap(i, 0, _screenImage, i, 0, 8, _graphics->_screenHeight, false);
+		}
+	}
+}
+
+void LabEngine::drawJournal(uint16 wipenum, bool needFade) {
+	_event->mouseHide();
+	updateMusicAndEvents();
+	drawJournalText();
+	_graphics->loadBackPict("P:Journal.pic", _highPalette);
+
+	if (wipenum == 0)
+		_journalBackImage->blitBitmap(0, 0, _screenImage, 0, 0, _graphics->_screenWidth, _graphics->_screenHeight, false);
+	else
+		turnPage((wipenum == 1));
+
+	_event->toggleButton(_event->getButton(0), 15, (_journalPage > 0));	// back button
+	_event->toggleButton(_event->getButton(2), 15, (!_lastPage));	// forward button
+
+	if (needFade)
+		_graphics->fade(true, 0);
+
+	// Reset the journal background, so that all the text that has been blitted on it is erased
+	memcpy(_journalBackImage->_imageData, _blankJournal, _graphics->_screenWidth * _graphics->_screenHeight);
+
+	eatMessages();
+	_event->mouseShow();
+}
+
+void LabEngine::processJournal() {
+	while (1) {
+		// Make sure we check the music at least after every message
+		updateMusicAndEvents();
+		IntuiMessage *msg = _event->getMsg();
+		if (g_engine->shouldQuit()) {
+			_quitLab = true;
+			return;
+		}
+
+		if (!msg)
+			updateMusicAndEvents();
+		else {
+			uint32 msgClass  = msg->_msgClass;
+			uint16 buttonId  = msg->_code;
+
+			if ((msgClass == kMessageRightClick) ||
+				((msgClass == kMessageRawKey) && (buttonId == Common::KEYCODE_ESCAPE)))
+				return;
+			else if (msgClass == kMessageButtonUp) {
+				if (buttonId == 0) {
+					if (_journalPage >= 2) {
+						_journalPage -= 2;
+						drawJournal(1, false);
+					}
+				} else if (buttonId == 1) {
+					return;
+				} else if (buttonId == 2) {
+					if (!_lastPage) {
+						_journalPage += 2;
+						drawJournal(2, false);
+					}
+				}
+			}
+		}
+	}
+}
+
+void LabEngine::doJournal() {
+	_graphics->blackAllScreen();
+	_lastPage = false;
+
+	_screenImage->_width = _journalBackImage->_width = _graphics->_screenWidth;
+	_screenImage->_height = _journalBackImage->_height = _graphics->_screenHeight;
+	_journalBackImage->_imageData = nullptr;
+	_screenImage->_imageData = _graphics->getCurrentDrawingBuffer();
+
+	updateMusicAndEvents();
+	loadJournalData();
+	_event->attachButtonList(&_journalButtonList);
+	drawJournal(0, true);
+	_event->mouseShow();
+	processJournal();
+	_event->attachButtonList(nullptr);
+	_graphics->fade(false, 0);
+	_event->mouseHide();
+
+	delete[] _blankJournal;
+	delete[] _journalBackImage->_imageData;
+	_blankJournal = _journalBackImage->_imageData = nullptr;
+
+	_event->freeButtonList(&_journalButtonList);
+	_graphics->closeFont(&_journalFont);
+
+	_screenImage->_imageData = _graphics->getCurrentDrawingBuffer();
+
+	_graphics->setPen(0);
+	_graphics->rectFill(0, 0, _graphics->_screenWidth - 1, _graphics->_screenHeight - 1);
+	_graphics->blackScreen();
+}
+
+void LabEngine::drawMonText(char *text, TextFont *monitorFont, Common::Rect textRect, bool isinteractive) {
+	uint16 drawingToPage = 0, yspacing = 0;
+	int charsDrawn = 0;
+	char *curText = text;
+
+	_event->mouseHide();
+
+	if (*text == '%') {
+		text++;
+		uint16 numlines = (*text - '0') * 10;
+		text++;
+		numlines += (*text - '0');
+		text += 2;
+
+		uint16 fheight = _graphics->textHeight(monitorFont);
+		textRect.left = _monitorButton->_width + _utils->vgaScaleX(3);
+		_monitorButtonHeight = _monitorButton->_height + _utils->vgaScaleY(3);
+
+		if (_monitorButtonHeight > fheight)
+			yspacing = _monitorButtonHeight - fheight;
+		else
+			_monitorButtonHeight = fheight;
+
+		_graphics->setPen(0);
+		_graphics->rectFill(0, 0, _graphics->_screenWidth - 1, textRect.bottom);
+
+		for (int i = 0; i < numlines; i++)
+			_monitorButton->drawImage(0, i * _monitorButtonHeight);
+	} else if (isinteractive) {
+		_graphics->setPen(0);
+		_graphics->rectFill(0, 0, _graphics->_screenWidth - 1, textRect.bottom);
+	} else {
+		_graphics->setPen(0);
+		_graphics->rectFill(textRect);
+	}
+
+	while (drawingToPage < _monitorPage) {
+		updateMusicAndEvents();
+		curText = text + charsDrawn;
+		charsDrawn += _graphics->flowText(monitorFont, yspacing, 0, 0, false, false, false, false, textRect, curText);
+		_lastPage = (*curText == 0);
+
+		if (_lastPage)
+			_monitorPage = drawingToPage;
+		else
+			drawingToPage++;
+	}
+
+	curText = text + charsDrawn;
+	_lastPage = (*curText == 0);
+	charsDrawn = _graphics->flowText(monitorFont, yspacing, 2, 0, false, false, false, true, textRect, curText);
+	_event->mouseShow();
+}
+
+void LabEngine::processMonitor(char *ntext, TextFont *monitorFont, bool isInteractive, Common::Rect textRect) {
+	Common::String startFileName = _monitorTextFilename;
+	CloseDataPtr startClosePtr = _closeDataPtr, lastClosePtr[10];
+	uint16 depth = 0;
+
+	lastClosePtr[0] = _closeDataPtr;
+
+	while (1) {
+		if (isInteractive) {
+			if (!_closeDataPtr)
+				_closeDataPtr = startClosePtr;
+
+			Common::String test;
+			if (_closeDataPtr == startClosePtr)
+				test = startFileName;
+			else
+				test = _closeDataPtr->_graphicName;
+
+			if (test != _monitorTextFilename) {
+				_monitorPage = 0;
+				_monitorTextFilename = test;
+
+				Common::String text = _resource->getText(_monitorTextFilename);
+				_graphics->fade(false, 0);
+				drawMonText((char *)text.c_str(), monitorFont, textRect, isInteractive);
+				_graphics->fade(true, 0);
+			}
+		}
+
+		// Make sure we check the music at least after every message
+		updateMusicAndEvents();
+		IntuiMessage *msg = _event->getMsg();
+		if (g_engine->shouldQuit()) {
+			_quitLab = true;
+			return;
+		}
+
+		if (!msg) {
+			updateMusicAndEvents();
+		} else {
+			uint32 msgClass  = msg->_msgClass;
+			uint16 mouseX    = msg->_mouse.x;
+			uint16 mouseY    = msg->_mouse.y;
+			uint16 code      = msg->_code;
+
+			if ((msgClass == kMessageRightClick) ||
+				  ((msgClass == kMessageRawKey) && (code == Common::KEYCODE_ESCAPE)))
+				return;
+			else if (msgClass == kMessageLeftClick) {
+				if ((mouseY >= _utils->vgaScaleY(171)) && (mouseY <= _utils->vgaScaleY(200))) {
+					if (mouseX <= _utils->vgaScaleX(31)) {
+						return;
+					} else if (mouseX <= _utils->vgaScaleX(59)) {
+						if (isInteractive) {
+							_monitorPage = 0;
+
+							if (depth) {
+								depth--;
+								_closeDataPtr = lastClosePtr[depth];
+							}
+						} else if (_monitorPage > 0) {
+							_monitorPage = 0;
+							drawMonText(ntext, monitorFont, textRect, isInteractive);
+						}
+					} else if (mouseX < _utils->vgaScaleX(259)) {
+						return;
+					} else if (mouseX <= _utils->vgaScaleX(289)) {
+						if (!_lastPage) {
+							_monitorPage += 1;
+							drawMonText(ntext, monitorFont, textRect, isInteractive);
+						}
+					} else if (_monitorPage >= 1) {
+						// mouseX between 290 and 320 (scaled)
+						_monitorPage -= 1;
+						drawMonText(ntext, monitorFont, textRect, isInteractive);
+					}
+				} else if (isInteractive) {
+					CloseDataPtr tmpClosePtr = _closeDataPtr;
+					mouseY = 64 + (mouseY / _monitorButtonHeight) * 42;
+					mouseX = 101;
+					setCurrentClose(Common::Point(mouseX, mouseY), &_closeDataPtr, false);
+
+					if (tmpClosePtr != _closeDataPtr) {
+						lastClosePtr[depth] = tmpClosePtr;
+						depth++;
+					}
+				}
+			}
+		}
+	}
+}
+
+void LabEngine::doMonitor(const Common::String background, const Common::String textfile, bool isinteractive, Common::Rect textRect) {
+	Common::Rect scaledRect = _utils->vgaRectScale(textRect.left, textRect.top, textRect.right, textRect.bottom);
+	_monitorTextFilename = textfile;
+
+	_graphics->blackAllScreen();
+	_graphics->readPict("P:Mon/Monitor.1");
+	_graphics->readPict("P:Mon/NWD1");
+	_graphics->readPict("P:Mon/NWD2");
+	_graphics->readPict("P:Mon/NWD3");
+	_graphics->blackAllScreen();
+
+	_monitorPage = 0;
+	_lastPage = false;
+	_graphics->_fadePalette = _highPalette;
+
+	TextFont *monitorFont = _resource->getFont("F:Map.fon");
+	Common::File *buttonFile = _resource->openDataFile("P:MonImage");
+	_monitorButton = new Image(buttonFile, this);
+	delete buttonFile;
+
+	Common::String ntext = _resource->getText(textfile);
+	_graphics->loadBackPict(background, _highPalette);
+	drawMonText((char *)ntext.c_str(), monitorFont, scaledRect, isinteractive);
+	_event->mouseShow();
+	_graphics->fade(true, 0);
+	processMonitor((char *)ntext.c_str(), monitorFont, isinteractive, scaledRect);
+	_graphics->fade(false, 0);
+	_event->mouseHide();
+	_graphics->closeFont(&monitorFont);
+
+	_graphics->setPen(0);
+	_graphics->rectFill(0, 0, _graphics->_screenWidth - 1, _graphics->_screenHeight - 1);
+	_graphics->blackAllScreen();
+	_graphics->freePict();
+}
+
+} // End of namespace Lab