/* 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/scummsys.h" #include "common/savefile.h" #include "composer/composer.h" #include "composer/graphics.h" #include "composer/resource.h" namespace Composer { // new script ops enum { kOpPlusPlus = 0x1, kOpMinusMinus = 0x2, kOpAssign = 0x3, kOpAdd = 0x4, kOpSubtract = 0x5, kOpMultiply = 0x6, kOpDivide = 0x7, kOpModulo = 0x8, kOpMaybeAlsoAssign = 0x9, kOpBooleanAssign = 0xA, kOpNegate = 0xB, kOpAnd = 0xC, kOpOr = 0xD, kOpXor = 0xE, kOpNot = 0xF, kOpSqrt = 0x10, kOpRandom = 0x11, kOpExecuteScript = 0x12, kOpCallFunc = 0x13, kOpBoolLessThanEq = 0x17, kOpBoolLessThan = 0x16, kOpBoolGreaterThanEq = 0x15, kOpBoolGreaterThan = 0x14, kOpBoolEqual = 0x18, kOpBoolNotEqual = 0x19, kOpSaveArgs = 0x1A, kOpRestoreArgs = 0x1B, kOpReturn = 0x20, kOpLessThanEq = 0x22, kOpLessThan = 0x21, kOpGreaterThanEq = 0x24, kOpGreaterThan = 0x23, kOpEqual = 0x25, kOpNotEqual = 0x26, kOpJump = 0x80, kOpJumpIfNot = 0x81, kOpJumpIf = 0x82, kOpJumpIfNotValue = 0x83, kOpJumpIfValue = 0x84 }; enum { kFuncPlayAnim = 35001, kFuncStopAnim = 35002, // (no 35003) kFuncQueueScript = 35004, kFuncDequeueScript = 35005, kFuncSetCursor = 35006, kFuncGetCursor = 35007, kFuncShowCursor = 35008, kFuncHideCursor = 35009, // (no 35010) kFuncActivateButton = 35011, kFuncDeactivateButton = 35012, kFuncNewPage = 35013, kFuncLoadPage = 35014, kFuncUnloadPage = 35015, kFuncSetPalette = 35016, kFuncSaveVars = 35017, kFuncLoadVars = 35018, kFuncQueueScriptOnce = 35019, kFuncGetMousePos = 35020, kFuncChangeBackground = 35021, kFuncSetBackgroundColor = 35022, kFuncClearSprites = 35023, kFuncAddSprite = 35024, kFuncRemoveSprite = 35025, kFuncQuit = 35026, kFuncSaveData = 35027, kFuncLoadData = 35028, kFuncGetSpriteSize = 35029 }; void ComposerEngine::runEvent(uint16 id, int16 param1, int16 param2, int16 param3) { if (!hasResource(ID_EVNT, id)) return; Common::SeekableReadStream *stream = getResource(ID_EVNT, id); if (stream->size() != 2) error("bad EVNT size %d", stream->size()); uint16 scriptId = stream->readUint16LE(); delete stream; if (!scriptId) return; debug(2, "running event %d via script %d(%d, %d, %d)", id, scriptId, param1, param2, param3); runScript(scriptId, param1, param2, param3); } int16 ComposerEngine::runScript(uint16 id, int16 param1, int16 param2, int16 param3) { _vars[1] = param1; _vars[2] = param2; _vars[3] = param3; runScript(id); return _vars[0]; } int16 ComposerEngine::getArg(uint16 arg, uint16 type) { switch (type) { case 0: return (int16)arg; case 1: return (int16)_vars[arg]; case 2: return (int16)_vars[_vars[arg]]; default: error("invalid argument type %d (getting arg %d)", type, arg); } } void ComposerEngine::setArg(uint16 arg, uint16 type, uint16 val) { switch (type) { case 1: _vars[arg] = val; break; case 2: _vars[_vars[arg]] = val; break; default: error("invalid argument type %d (setting arg %d)", type, arg); } } void ComposerEngine::runScript(uint16 id) { if (!hasResource(ID_SCRP, id)) { warning("ignoring attempt to run script %d, because it doesn't exist", id); return; } uint stackBase = _stack.size(); _stack.resize(_stack.size() + 19); Common::SeekableReadStream *stream = getResource(ID_SCRP, id); if (stream->size() < 2) error("SCRP was too small (%d)", stream->size()); uint16 size = stream->readUint16LE(); if (stream->size() < 2 + 2*size) error("SCRP was too small (%d, but claimed %d entries)", stream->size(), size); uint16 *script = new uint16[size]; for (uint i = 0; i < size; i++) script[i] = stream->readUint16LE(); delete stream; uint16 pos = 0; bool lastResult = false; while (pos < size) { int16 val1, val2, val3; byte op = (byte)script[pos]; uint numParams = (script[pos] & 0x300) >> 8; // 2 bits if (pos + numParams >= size) error("script ran out of content"); uint arg1 = (script[pos] & 0xc00) >> 10; // 2 bits uint arg2 = (script[pos] & 0x3000) >> 12; // 2 bits uint arg3 = (script[pos] & 0xC000) >> 14; // 2 bits switch (op) { case kOpPlusPlus: if (numParams != 1) error("kOpPlusPlus had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); debug(9, "[%d/%d]++ (now %d)", script[pos + 1], arg1, val1 + 1); setArg(script[pos + 1], arg1, val1 + 1); break; case kOpMinusMinus: if (numParams != 1) error("kOpMinusMinus had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); debug(9, "[%d/%d]-- (now %d)", script[pos + 1], arg1, val1 - 1); setArg(script[pos + 1], arg1, val1 - 1); break; case kOpAssign: if (numParams != 2) error("kOpAssign had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] = [%d/%d] (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2); setArg(script[pos + 1], arg1, val2); break; case kOpAdd: if (numParams != 3) error("kOpAdd had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d]=%d + [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 + val3); setArg(script[pos + 1], arg1, val2 + val3); break; case kOpSubtract: if (numParams != 3) error("kOpSubtract had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d]=%d - [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 - val3); setArg(script[pos + 1], arg1, val2 - val3); break; case kOpMultiply: if (numParams != 3) error("kOpMultiply had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d]=%d * [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 * val3); setArg(script[pos + 1], arg1, val2 * val3); break; case kOpDivide: if (numParams != 3) error("kOpDivide had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); if (val3 == 0) error("script tried to divide by zero"); debug(9, "[%d/%d] = [%d/%d]=%d / [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 / val3); setArg(script[pos + 1], arg1, val2 / val3); break; case kOpModulo: if (numParams != 3) error("kOpModulo had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); if (val3 == 0) error("script tried to divide by zero (modulo)"); debug(9, "[%d/%d] = [%d/%d]=%d %% [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 % val3); setArg(script[pos + 1], arg1, val2 % val3); break; case kOpMaybeAlsoAssign: if (numParams != 2) error("kOpMaybeAlsoAssign had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] =(?) [%d/%d] (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2); setArg(script[pos + 1], arg1, val2); break; case kOpBooleanAssign: if (numParams != 2) error("kOpBooleanAssign had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] = [%d/%d] (%d) ? 1 : 0", script[pos + 1], arg1, script[pos + 2], arg2, val2); setArg(script[pos + 1], arg1, val2 ? 1 : 0); break; case kOpNegate: if (numParams != 2) error("kOpNegate had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] = -[%d/%d] (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2); setArg(script[pos + 1], arg1, -val2); break; case kOpAnd: if (numParams != 3) error("kOpAnd had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d]=%d & [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 & val3); setArg(script[pos + 1], arg1, val2 & val3); break; case kOpOr: if (numParams != 3) error("kOpOr had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d]=%d | [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 | val3); setArg(script[pos + 1], arg1, val2 | val3); break; case kOpXor: if (numParams != 3) error("kOpXor had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d]=%d ^ [%d/%d]=%d (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val2 ^ val3); setArg(script[pos + 1], arg1, val2 ^ val3); break; case kOpNot: if (numParams != 2) error("kOpNot had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] = ![%d/%d] (!%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2); setArg(script[pos + 1], arg1, val2 ? 0 : 1); break; case kOpSqrt: if (numParams != 2) error("kOpSqrt had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] = sqrt([%d/%d] (%d))", script[pos + 1], arg1, script[pos + 2], arg2, val2); setArg(script[pos + 1], arg1, (int16)sqrt((double)val2)); break; case kOpRandom: if (numParams != 3) error("kOpRandom had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); val1 = _rnd->getRandomNumberRng(val2, val3); debug(9, "[%d/%d] = rnd([%d/%d]=%d, [%d/%d]=%d) (%d)", script[pos + 1], arg1, script[pos + 2], arg2, val2, script[pos+3], arg3, val3, val1); setArg(script[pos + 1], arg1, val1); break; case kOpExecuteScript: if (numParams != 1) error("kOpExecuteScript had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); debug(8, "run script [%d/%d]=%d", script[pos + 1], arg1, val1); runScript(val1); debug(8, "done run script"); break; case kOpCallFunc: if (numParams != 1) error("kOpCallFunc had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); debug(8, "%d(%d, %d, %d)", (uint16)val1, _vars[1], _vars[2], _vars[3]); _vars[0] = scriptFuncCall(val1, _vars[1], _vars[2], _vars[3]); break; case kOpBoolLessThanEq: if (numParams != 2) error("kOpBoolLessThanEq had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] <= [%d/%d]? (%d <= %d)", script[pos + 1], arg1, script[pos + 2], arg2, val1, val2); lastResult = (val1 <= val2); break; case kOpBoolLessThan: if (numParams != 2) error("kOpBoolLessThan had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] < [%d/%d]? (%d < %d)", script[pos + 1], arg1, script[pos + 2], arg2, val1, val2); lastResult = (val1 < val2); break; case kOpBoolGreaterThanEq: if (numParams != 2) error("kOpBoolGreaterThanEq had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] >= [%d/%d]? (%d >= %d)", script[pos + 1], arg1, script[pos + 2], arg2, val1, val2); lastResult = (val1 >= val2); break; case kOpBoolGreaterThan: if (numParams != 2) error("kOpBoolGreaterThan had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] > [%d/%d]? (%d > %d)", script[pos + 1], arg1, script[pos + 2], arg2, val1, val2); lastResult = (val1 > val2); break; case kOpBoolEqual: if (numParams != 2) error("kOpBoolEqual had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] == [%d/%d]? (%d == %d)", script[pos + 1], arg1, script[pos + 2], arg2, val1, val2); lastResult = (val1 == val2); break; case kOpBoolNotEqual: if (numParams != 2) error("kOpBoolNotEqual had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "[%d/%d] != [%d/%d]? (%d != %d)", script[pos + 1], arg1, script[pos + 2], arg2, val1, val2); lastResult = (val1 != val2); break; case kOpSaveArgs: if (numParams != 0) error("kOpSaveArgs had wrong number of params (%d)", numParams); debug(9, "save args"); for (uint i = 1; i < 19; i++) _stack[stackBase + i] = _vars[i]; break; case kOpRestoreArgs: if (numParams != 0) error("kOpRestoreArgs had wrong number of params (%d)", numParams); debug(9, "restore args"); for (uint i = 1; i < 19; i++) _vars[i] = _stack[stackBase + i]; break; case kOpReturn: if (numParams != 1) error("kOpReturn had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); debug(9, "return [%d/%d]=%d", script[pos + 1], arg1, val1); _vars[0] = val1; break; case kOpLessThanEq: if (numParams != 3) error("kOpLessThanEq had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d] <= [%d/%d]? (%d <= %d)", script[pos + 1], arg1, script[pos + 2], arg2, script[pos + 3], arg3, val3, val2); setArg(script[pos + 1], arg1, (val3 <= val2) ? 1 : 0); break; case kOpLessThan: if (numParams != 3) error("kOpLessThan had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d] < [%d/%d]? (%d < %d)", script[pos + 1], arg1, script[pos + 2], arg2, script[pos + 3], arg3, val3, val2); setArg(script[pos + 1], arg1, (val3 < val2) ? 1 : 0); break; case kOpGreaterThanEq: if (numParams != 3) error("kOpGreaterThanEq had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d] >= [%d/%d]? (%d >= %d)", script[pos + 1], arg1, script[pos + 2], arg2, script[pos + 3], arg3, val3, val2); setArg(script[pos + 1], arg1, (val3 >= val2) ? 1 : 0); break; case kOpGreaterThan: if (numParams != 3) error("kOpGreaterThan had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d] > [%d/%d]? (%d > %d)", script[pos + 1], arg1, script[pos + 2], arg2, script[pos + 3], arg3, val3, val2); setArg(script[pos + 1], arg1, (val3 > val2) ? 1 : 0); break; case kOpEqual: if (numParams != 3) error("kOpEqual had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d] == [%d/%d]? (%d == %d)", script[pos + 1], arg1, script[pos + 2], arg2, script[pos + 3], arg3, val2, val3); setArg(script[pos + 1], arg1, (val3 == val2) ? 1 : 0); break; case kOpNotEqual: if (numParams != 3) error("kOpNotEqual had wrong number of params (%d)", numParams); val2 = getArg(script[pos + 2], arg2); val3 = getArg(script[pos + 3], arg3); debug(9, "[%d/%d] = [%d/%d] != [%d/%d]? (%d != %d)", script[pos + 1], arg1, script[pos + 2], arg2, script[pos + 3], arg3, val2, val3); setArg(script[pos + 1], arg1, (val3 != val2) ? 1 : 0); break; case kOpJump: if (numParams != 1) error("kOpJump had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); debug(9, "jump by [%d/%d]=%d", script[pos + 1], arg1, val1); pos += val1; break; case kOpJumpIfNot: if (numParams != 1) error("kOpJumpIfNot had wrong number of params (%d)", numParams); if (lastResult) break; val1 = getArg(script[pos + 1], arg1); debug(9, "jump if not, by [%d/%d]=%d", script[pos + 1], arg1, val1); pos += val1; break; case kOpJumpIf: if (numParams != 1) error("kOpJumpIf had wrong number of params (%d)", numParams); if (!lastResult) break; val1 = getArg(script[pos + 1], arg1); debug(9, "jump if, by [%d/%d]=%d", script[pos + 1], arg1, val1); pos += val1; break; case kOpJumpIfNotValue: if (numParams != 2) error("kOpJumpIfNotValue had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "jump if not [%d/%d]=%d", script[pos + 1], arg1, val1); if (val1) break; debug(9, "--> jump by [%d/%d]=%d", script[pos + 2], arg2, val2); pos += val2; break; case kOpJumpIfValue: if (numParams != 2) error("kOpJumpIfValue had wrong number of params (%d)", numParams); val1 = getArg(script[pos + 1], arg1); val2 = getArg(script[pos + 2], arg2); debug(9, "jump if [%d/%d]=%d", script[pos + 1], arg1, val1); if (!val1) break; debug(9, "--> jump by [%d/%d]=%d", script[pos + 2], arg2, val2); pos += val2; break; default: error("unknown script op 0x%02x", op); } pos += (1 + numParams); if (op == kOpReturn) break; } delete[] script; _stack.resize(_stack.size() - 19); } int16 ComposerEngine::scriptFuncCall(uint16 id, int16 param1, int16 param2, int16 param3) { switch (id) { case kFuncPlayAnim: debug(3, "kFuncPlayAnim(%d, %d, %d)", param1, param2, param3); playAnimation(param1, param2, param3, 0); return 1; // TODO: return 0 on failure case kFuncStopAnim: debug(3, "kFuncStopAnim(%d)", param1); for (Common::List::iterator i = _anims.begin(); i != _anims.end(); i++) { if ((*i)->_id == param1) stopAnimation(*i); } return 0; case kFuncQueueScript: debug(3, "kFuncQueueScript(%d, %d, %d)", param1, param2, param3); _queuedScripts[param1]._baseTime = _system->getMillis(); _queuedScripts[param1]._duration = 10 * param2; _queuedScripts[param1]._count = 0xffffffff; _queuedScripts[param1]._scriptId = param3; return 0; case kFuncDequeueScript: debug(3, "kFuncDequeueScript(%d)", param1); _queuedScripts[param1]._count = 0; _queuedScripts[param1]._scriptId = 0; return 0; case kFuncSetCursor: debug(3, "kSetCursor(%d, (%d, %d))", param1, param2, param3); { uint16 oldCursor = _mouseSpriteId; setCursor(param1, Common::Point(param2, param3)); return oldCursor; } case kFuncGetCursor: debug(3, "kFuncGetCursor()"); return _mouseSpriteId; case kFuncShowCursor: debug(3, "kFuncShowCursor()"); setCursorVisible(true); return 0; case kFuncHideCursor: debug(3, "kFuncHideCursor()"); setCursorVisible(false); return 0; case kFuncActivateButton: debug(3, "kFuncActivateButton(%d)", param1); for (Common::List::iterator l = _libraries.begin(); l != _libraries.end(); l++) { for (Common::List