/* 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. * */ #include "common/random.h" #include "common/error.h" #include "adl/adl_v2.h" #include "adl/display.h" #include "adl/graphics.h" #include "adl/detection.h" namespace Adl { AdlEngine_v2::~AdlEngine_v2() { delete _disk; } AdlEngine_v2::AdlEngine_v2(OSystem *syst, const AdlGameDescription *gd) : AdlEngine(syst, gd), _maxLines(4), _disk(nullptr), _currentVolume(0), _itemRemoved(false), _roomOnScreen(0), _picOnScreen(0), _itemsOnScreen(0) { } void AdlEngine_v2::insertDisk(byte volume) { delete _disk; _disk = new DiskImage(); if (!_disk->open(getDiskImageName(volume))) error("Failed to open disk volume %d", volume); _currentVolume = volume; } void AdlEngine_v2::setupOpcodeTables() { AdlEngine::setupOpcodeTables(); _condOpcodes[0x01] = opcode(&AdlEngine_v2::o_isFirstTime); _condOpcodes[0x02] = opcode(&AdlEngine_v2::o_isRandomGT); _condOpcodes[0x04] = opcode(&AdlEngine_v2::o_isNounNotInRoom); _condOpcodes[0x07] = opcode(&AdlEngine_v2::o_isCarryingSomething); _actOpcodes.resize(0x21); _actOpcodes[0x0c] = opcode(&AdlEngine_v2::o_moveAllItems); _actOpcodes[0x1e] = opcode(&AdlEngine_v2::o_tellTime); _actOpcodes[0x1f] = opcode(&AdlEngine_v2::o_setRoomFromVar); _actOpcodes[0x20] = opcode(&AdlEngine_v2::o_initDisk); } void AdlEngine_v2::initState() { AdlEngine::initState(); _linesPrinted = 0; _picOnScreen = 0; _roomOnScreen = 0; _itemRemoved = false; _itemsOnScreen = 0; } byte AdlEngine_v2::roomArg(byte room) const { if (room == IDI_CUR_ROOM) return _state.room; return room; } void AdlEngine_v2::advanceClock() { Time &time = _state.time; time.minutes += 5; if (time.minutes == 60) { time.minutes = 0; ++time.hours; if (time.hours == 13) time.hours = 1; } } void AdlEngine_v2::checkTextOverflow(char c) { if (c != _display->asciiToNative('\r')) return; ++_linesPrinted; if (_linesPrinted >= _maxLines) handleTextOverflow(); } void AdlEngine_v2::handleTextOverflow() { _linesPrinted = 0; _display->renderText(); if (_inputScript) { // Set pause flag to activate regular behaviour of delay and inputKey _scriptPaused = true; if (_scriptDelay > 0) delay(_scriptDelay); else inputKey(); _scriptPaused = false; return; } bell(); while (true) { char key = inputKey(false); if (shouldQuit()) return; if (key == _display->asciiToNative('\r')) break; bell(3); } } Common::String AdlEngine_v2::loadMessage(uint idx) const { if (_messages[idx]) { StreamPtr strStream(_messages[idx]->createReadStream()); return readString(*strStream, 0xff); } return Common::String(); } void AdlEngine_v2::printString(const Common::String &str) { Common::String s(str); const uint textWidth = _display->getTextWidth(); uint endPos = textWidth - 1; uint startPos = 0; uint pos = 0; const char spaceChar = _display->asciiToNative(' '); const char returnChar = _display->asciiToNative('\r'); while (pos < s.size()) { s.setChar(_display->asciiToNative(s[pos]), pos); if (pos == endPos) { while (s[pos] != spaceChar && s[pos] != returnChar) { if (pos-- == startPos) error("Word wrapping failed"); } s.setChar(returnChar, pos); endPos = pos + textWidth; startPos = pos + 1; } ++pos; } for (pos = 0; pos < s.size(); ++pos) { checkTextOverflow(s[pos]); _display->printChar(s[pos]); } checkTextOverflow(returnChar); _display->printChar(returnChar); _display->renderText(); } void AdlEngine_v2::drawItem(Item &item, const Common::Point &pos) { item.isOnScreen = true; StreamPtr stream(_itemPics[item.picture - 1]->createReadStream()); stream->readByte(); // Skip clear opcode _graphics->drawPic(*stream, pos); } void AdlEngine_v2::loadRoom(byte roomNr) { if (Common::find(_brokenRooms.begin(), _brokenRooms.end(), roomNr) != _brokenRooms.end()) { debug("Warning: attempt to load non-existent room %d", roomNr); _roomData.description.clear(); _roomData.pictures.clear(); _roomData.commands.clear(); return; } Room &room = getRoom(roomNr); StreamPtr stream(room.data->createReadStream()); uint16 descOffset = stream->readUint16LE(); uint16 commandOffset = stream->readUint16LE(); _roomData.pictures.clear(); // There's no picture count. The original engine always checks at most // five pictures. We use the description offset to bound our search. uint16 picCount = (descOffset - 4) / 5; for (uint i = 0; i < picCount; ++i) { byte nr = stream->readByte(); _roomData.pictures[nr] = readDataBlockPtr(*stream); } _roomData.description = readStringAt(*stream, descOffset, 0xff); _roomData.commands.clear(); if (commandOffset != 0) { stream->seek(commandOffset); readCommands(*stream, _roomData.commands); } applyRoomWorkarounds(roomNr); } void AdlEngine_v2::showRoom() { bool redrawPic = false; _state.curPicture = getCurRoom().curPicture; if (_state.room != _roomOnScreen) { loadRoom(_state.room); _graphics->clearScreen(); if (!_state.isDark) redrawPic = true; } else { if (_state.curPicture != _picOnScreen || _itemRemoved) redrawPic = true; } if (redrawPic) { _roomOnScreen = _state.room; _picOnScreen = _state.curPicture; drawPic(_state.curPicture); _itemRemoved = false; _itemsOnScreen = 0; Common::List::iterator item; for (item = _state.items.begin(); item != _state.items.end(); ++item) item->isOnScreen = false; } if (!_state.isDark) drawItems(); _display->renderGraphics(); printString(_roomData.description); } // TODO: Merge this into AdlEngine? void AdlEngine_v2::takeItem(byte noun) { Common::List::iterator item; for (item = _state.items.begin(); item != _state.items.end(); ++item) { if (item->noun == noun && item->room == _state.room && item->region == _state.region) { if (item->state == IDI_ITEM_DOESNT_MOVE) { printMessage(_messageIds.itemDoesntMove); return; } if (item->state == IDI_ITEM_DROPPED) { item->room = IDI_ANY; _itemRemoved = true; return; } Common::Array::const_iterator pic; for (pic = item->roomPictures.begin(); pic != item->roomPictures.end(); ++pic) { if (*pic == getCurRoom().curPicture || *pic == IDI_ANY) { if (!isInventoryFull()) { item->room = IDI_ANY; _itemRemoved = true; item->state = IDI_ITEM_DROPPED; } return; } } } } printMessage(_messageIds.itemNotHere); } void AdlEngine_v2::drawItems() { Common::List::iterator item; for (item = _state.items.begin(); item != _state.items.end(); ++item) { // Skip items not in this room if (item->region == _state.region && item->room == _state.room && !item->isOnScreen) { if (item->state == IDI_ITEM_DROPPED) { // Draw dropped item if in normal view if (getCurRoom().picture == getCurRoom().curPicture) drawItem(*item, _itemOffsets[_itemsOnScreen++]); } else { // Draw fixed item if current view is in the pic list Common::Array::const_iterator pic; for (pic = item->roomPictures.begin(); pic != item->roomPictures.end(); ++pic) { if (*pic == _state.curPicture || *pic == IDI_ANY) { drawItem(*item, item->position); break; } } } } } } DataBlockPtr AdlEngine_v2::readDataBlockPtr(Common::ReadStream &f) const { byte track = f.readByte(); byte sector = f.readByte(); byte offset = f.readByte(); byte size = f.readByte(); if (f.eos() || f.err()) error("Error reading DataBlockPtr"); if (track == 0 && sector == 0 && offset == 0 && size == 0) return DataBlockPtr(); adjustDataBlockPtr(track, sector, offset, size); return _disk->getDataBlock(track, sector, offset, size); } void AdlEngine_v2::loadItems(Common::ReadStream &stream) { byte id; while ((id = stream.readByte()) != 0xff && !stream.eos() && !stream.err()) { Item item; item.id = id; item.noun = stream.readByte(); item.room = stream.readByte(); item.picture = stream.readByte(); item.region = stream.readByte(); item.position.x = stream.readByte(); item.position.y = stream.readByte(); item.state = stream.readByte(); item.description = stream.readByte(); stream.readByte(); // Struct size byte picListSize = stream.readByte(); // Flag to keep track of what has been drawn on the screen stream.readByte(); for (uint i = 0; i < picListSize; ++i) item.roomPictures.push_back(stream.readByte()); _state.items.push_back(item); } if (stream.eos() || stream.err()) error("Error loading items"); } void AdlEngine_v2::loadRooms(Common::ReadStream &stream, byte count) { for (uint i = 0; i < count; ++i) { Room room; stream.readByte(); // number for (uint j = 0; j < 6; ++j) room.connections[j] = stream.readByte(); room.data = readDataBlockPtr(stream); room.picture = stream.readByte(); room.curPicture = stream.readByte(); room.isFirstTime = stream.readByte(); _state.rooms.push_back(room); } if (stream.eos() || stream.err()) error("Error loading rooms"); } void AdlEngine_v2::loadMessages(Common::ReadStream &stream, byte count) { for (uint i = 0; i < count; ++i) _messages.push_back(readDataBlockPtr(stream)); } void AdlEngine_v2::loadPictures(Common::ReadStream &stream) { byte picNr; while ((picNr = stream.readByte()) != 0xff) { if (stream.eos() || stream.err()) error("Error reading global pic list"); _pictures[picNr] = readDataBlockPtr(stream); } } void AdlEngine_v2::loadItemPictures(Common::ReadStream &stream, byte count) { for (uint i = 0; i < count; ++i) { stream.readByte(); // number _itemPics.push_back(readDataBlockPtr(stream)); } } int AdlEngine_v2::o_isFirstTime(ScriptEnv &e) { OP_DEBUG_0("\t&& IS_FIRST_TIME()"); bool oldFlag = getCurRoom().isFirstTime; getCurRoom().isFirstTime = false; if (!oldFlag) return -1; return 0; } int AdlEngine_v2::o_isRandomGT(ScriptEnv &e) { OP_DEBUG_1("\t&& RAND() > %d", e.arg(1)); byte rnd = _random->getRandomNumber(255); if (rnd > e.arg(1)) return 1; return -1; } int AdlEngine_v2::o_isNounNotInRoom(ScriptEnv &e) { OP_DEBUG_1("\t&& NO_SUCH_ITEMS_IN_ROOM(%s)", itemRoomStr(e.arg(1)).c_str()); Common::List::const_iterator item; for (item = _state.items.begin(); item != _state.items.end(); ++item) if (item->noun == e.getNoun() && (item->room == roomArg(e.arg(1)))) return -1; return 1; } int AdlEngine_v2::o_isCarryingSomething(ScriptEnv &e) { OP_DEBUG_0("\t&& IS_CARRYING_SOMETHING()"); Common::List::const_iterator item; for (item = _state.items.begin(); item != _state.items.end(); ++item) if (item->room == IDI_ANY) return 0; return -1; } int AdlEngine_v2::o_moveItem(ScriptEnv &e) { OP_DEBUG_2("\tSET_ITEM_ROOM(%s, %s)", itemStr(e.arg(1)).c_str(), itemRoomStr(e.arg(2)).c_str()); byte room = roomArg(e.arg(2)); Item &item = getItem(e.arg(1)); if (item.room == _roomOnScreen) _picOnScreen = 0; // Set items that move from inventory to a room to state "dropped" if (item.room == IDI_ANY && room != IDI_VOID_ROOM) item.state = IDI_ITEM_DROPPED; item.room = room; return 2; } int AdlEngine_v2::o_setCurPic(ScriptEnv &e) { OP_DEBUG_1("\tSET_CURPIC(%d)", e.arg(1)); getCurRoom().curPicture = _state.curPicture = e.arg(1); return 1; } int AdlEngine_v2::o_setPic(ScriptEnv &e) { OP_DEBUG_1("\tSET_PIC(%d)", e.arg(1)); getCurRoom().picture = getCurRoom().curPicture = _state.curPicture = e.arg(1); return 1; } int AdlEngine_v2::o_moveAllItems(ScriptEnv &e) { OP_DEBUG_2("\tMOVE_ALL_ITEMS(%s, %s)", itemRoomStr(e.arg(1)).c_str(), itemRoomStr(e.arg(2)).c_str()); byte room1 = roomArg(e.arg(1)); if (room1 == _state.room) _picOnScreen = 0; byte room2 = roomArg(e.arg(2)); Common::List::iterator item; for (item = _state.items.begin(); item != _state.items.end(); ++item) if (item->room == room1) { item->room = room2; if (room1 == IDI_ANY) item->state = IDI_ITEM_DROPPED; } return 2; } int AdlEngine_v2::o_save(ScriptEnv &e) { OP_DEBUG_0("\tSAVE_GAME()"); int slot = askForSlot(_strings_v2.saveInsert); if (slot < 0) return -1; saveGameState(slot, ""); _display->printString(_strings_v2.saveReplace); inputString(); return 0; } int AdlEngine_v2::o_restore(ScriptEnv &e) { OP_DEBUG_0("\tRESTORE_GAME()"); int slot = askForSlot(_strings_v2.restoreInsert); if (slot < 0) return -1; loadGameState(slot); _isRestoring = false; _display->printString(_strings_v2.restoreReplace); inputString(); _picOnScreen = 0; _roomOnScreen = 0; return 0; } int AdlEngine_v2::o_placeItem(ScriptEnv &e) { OP_DEBUG_4("\tPLACE_ITEM(%s, %s, (%d, %d))", itemStr(e.arg(1)).c_str(), itemRoomStr(e.arg(2)).c_str(), e.arg(3), e.arg(4)); Item &item = getItem(e.arg(1)); item.room = roomArg(e.arg(2)); item.position.x = e.arg(3); item.position.y = e.arg(4); item.state = IDI_ITEM_NOT_MOVED; return 4; } int AdlEngine_v2::o_tellTime(ScriptEnv &e) { OP_DEBUG_0("\tTELL_TIME()"); Common::String time = _strings_v2.time; const char zeroChar = _display->asciiToNative('0'); time.setChar(zeroChar + _state.time.hours / 10, 12); time.setChar(zeroChar + _state.time.hours % 10, 13); time.setChar(zeroChar + _state.time.minutes / 10, 15); time.setChar(zeroChar + _state.time.minutes % 10, 16); printString(time); return 0; } int AdlEngine_v2::o_setRoomFromVar(ScriptEnv &e) { OP_DEBUG_1("\tROOM = VAR[%d]", e.arg(1)); getCurRoom().curPicture = getCurRoom().picture; _state.room = getVar(e.arg(1)); return 1; } int AdlEngine_v2::o_initDisk(ScriptEnv &e) { OP_DEBUG_0("\tINIT_DISK()"); _display->printAsciiString("NOT REQUIRED\r"); return 0; } bool AdlEngine_v2::canSaveGameStateCurrently() { if (!_canSaveNow) return false; // Back up first visit flag as it may be changed by this test const bool isFirstTime = getCurRoom().isFirstTime; const bool retval = AdlEngine::canSaveGameStateCurrently(); getCurRoom().isFirstTime = isFirstTime; return retval; } int AdlEngine_v2::askForSlot(const Common::String &question) { while (1) { _display->printString(question); Common::String input = inputString(); if (shouldQuit()) return -1; if (input.size() > 0 && input[0] >= _display->asciiToNative('A') && input[0] <= _display->asciiToNative('O')) return input[0] - _display->asciiToNative('A'); } } } // End of namespace Adl