/* 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/archive.h" #include "common/file.h" #include "common/str-array.h" #include "director/lingo/lingo.h" #include "director/lingo/lingo-gr.h" namespace Director { Lingo *g_lingo; struct EventHandlerType { LEvent handler; const char *name; } static const eventHanlerDescs[] = { { kEventPrepareMovie, "prepareMovie" }, { kEventStartMovie, "startMovie" }, { kEventStopMovie, "stopMovie" }, { kEventNew, "newSprite" }, { kEventBeginSprite, "beginSprite" }, { kEventEndSprite, "endSprite" }, { kEventEnterFrame, "enterFrame" }, { kEventPrepareFrame, "prepareFrame" }, { kEventIdle, "idle" }, { kEventStepFrame, "stepFrame"}, { kEventExitFrame, "exitFrame" }, { kEventActivateWindow, "activateWindow" }, { kEventDeactivateWindow, "deactivateWindow" }, { kEventMoveWindow, "moveWindow" }, { kEventResizeWindow, "resizeWindow" }, { kEventOpenWindow, "openWindow" }, { kEventCloseWindow, "closeWindow" }, { kEventStart, "start" }, { kEventKeyUp, "keyUp" }, { kEventKeyDown, "keyDown" }, // D2 as when { kEventMouseUp, "mouseUp" }, // D2 as when { kEventMouseDown, "mouseDown" }, // D2 as when { kEventRightMouseDown, "rightMouseDown" }, { kEventRightMouseUp, "rightMouseUp" }, { kEventMouseEnter, "mouseEnter" }, { kEventMouseLeave, "mouseLeave" }, { kEventMouseUpOutSide, "mouseUpOutSide" }, { kEventMouseWithin, "mouseWithin" }, { kEventTimeout, "timeout" }, // D2 as when { kEventNone, 0 }, }; Symbol::Symbol() { name = NULL; type = VOID; u.s = NULL; nargs = 0; maxArgs = 0; parens = true; global = false; } Lingo::Lingo(DirectorEngine *vm) : _vm(vm) { g_lingo = this; for (const EventHandlerType *t = &eventHanlerDescs[0]; t->handler != kEventNone; ++t) _eventHandlerTypes[t->handler] = t->name; initBuiltIns(); initFuncs(); initTheEntities(); _currentScript = 0; _currentScriptType = kMovieScript; _pc = 0; _returning = false; _indef = false; _linenumber = _colnumber = 0; _hadError = false; _inFactory = false; _floatPrecision = 4; _floatPrecisionFormat = "%.4f"; _exitRepeat = false; _localvars = NULL; warning("Lingo Inited"); } Lingo::~Lingo() { } const char *Lingo::findNextDefinition(const char *s) { const char *res = s; while (*res) { while (*res && (*res == ' ' || *res == '\t' || *res == '\n')) res++; if (!*res) return NULL; if (!strncmp(res, "macro ", 6)) { debugC(3, kDebugLingoCompile, "See macro"); return res; } if (!strncmp(res, "factory ", 8)) { debugC(3, kDebugLingoCompile, "See factory"); return res; } if (!strncmp(res, "method ", 7)) { debugC(3, kDebugLingoCompile, "See method"); return res; } while (*res && *res != '\n') res++; } return NULL; } void Lingo::addCode(const char *code, ScriptType type, uint16 id) { debugC(2, kDebugLingoCompile, "Add code \"%s\" for type %d with id %d", code, type, id); if (_scripts[type].contains(id)) { delete _scripts[type][id]; } _currentScript = new ScriptData; _currentScriptType = type; _scripts[type][id] = _currentScript; _linenumber = _colnumber = 1; _hadError = false; const char *begin, *end; if (!strncmp(code, "menu:", 5)) { debugC(2, kDebugLingoCompile, "Parsing menu"); parseMenu(code); return; } // macros and factories have conflicting grammar. Thus we ease life for the parser. if ((begin = findNextDefinition(code))) { bool first = true; while ((end = findNextDefinition(begin + 1))) { if (first) { begin = code; first = false; } Common::String chunk(begin, end); if (chunk.hasPrefix("factory") || chunk.hasPrefix("method")) _inFactory = true; else if (chunk.hasPrefix("macro")) _inFactory = false; else _inFactory = false; debugC(2, kDebugLingoCompile, "Code chunk:\n#####\n%s#####", chunk.c_str()); parse(chunk.c_str()); if (debugChannelSet(3, kDebugLingoCompile)) { uint pc = 0; while (pc < _currentScript->size()) { Common::String instr = decodeInstruction(pc, &pc); debugC(3, kDebugLingoCompile, "[%5d] %s", pc, instr.c_str()); } } _currentScript->clear(); begin = end; } _hadError = true; // HACK: This is for preventing test execution debugC(2, kDebugLingoCompile, "Code chunk:\n#####\n%s#####", begin); parse(begin); } else { parse(code); code1(STOP); } _inFactory = false; if (debugChannelSet(3, kDebugLingoCompile)) { if (_currentScript->size() && !_hadError) Common::hexdump((byte *)&_currentScript->front(), _currentScript->size() * sizeof(inst)); uint pc = 0; while (pc < _currentScript->size()) { Common::String instr = decodeInstruction(pc, &pc); debugC(3, kDebugLingoCompile, "[%5d] %s", pc, instr.c_str()); } } } void Lingo::executeScript(ScriptType type, uint16 id) { if (!_scripts[type].contains(id)) { debugC(3, kDebugLingoExec, "Request to execute non-existant script type %d id %d", type, id); return; } debugC(2, kDebugLingoExec, "Executing script type: %d, id: %d", type, id); _currentScript = _scripts[type][id]; _pc = 0; _returning = false; _localvars = new SymbolHash; execute(_pc); cleanLocalVars(); } ScriptType Lingo::event2script(LEvent ev) { if (_vm->getVersion() < 4) { switch (ev) { //case kEventStartMovie: // We are precompiling it now // return kMovieScript; case kEventEnterFrame: return kFrameScript; default: return kNoneScript; } } return kNoneScript; } void Lingo::processEvent(LEvent event, int entityId) { if (!_eventHandlerTypes.contains(event)) error("processEvent: Unknown event %d for entity %d", event, entityId); ScriptType st = event2script(event); if (st != kNoneScript) { executeScript(st, entityId + 1); } else if (_handlers.contains(_eventHandlerTypes[event])) { call(_eventHandlerTypes[event], 0); pop(); } else { debugC(8, kDebugLingoExec, "STUB: processEvent(%s) for %d", _eventHandlerTypes[event], entityId); } } int Lingo::alignTypes(Datum &d1, Datum &d2) { int opType = INT; if (d1.type == FLOAT || d2.type == FLOAT) { opType = FLOAT; d1.toFloat(); d2.toFloat(); } return opType; } int Datum::toInt() { switch (type) { case INT: // no-op break; case FLOAT: u.i = (int)u.f; type = INT; break; default: warning("Incorrect operation toInt() for type: %s", type2str()); } return u.i; } double Datum::toFloat() { switch (type) { case INT: u.f = (double)u.i; type = FLOAT; break; case FLOAT: // no-op break; default: warning("Incorrect operation toFloat() for type: %s", type2str()); } return u.f; } Common::String *Datum::toString() { Common::String *s = new Common::String; switch (type) { case INT: *s = Common::String::format("%d", u.i); break; case FLOAT: *s = Common::String::format(g_lingo->_floatPrecisionFormat.c_str(), u.f); break; case STRING: delete s; s = u.s; break; case OBJECT: *s = Common::String::format("#%s", u.s->c_str()); break; case VOID: *s = "#void"; break; case VAR: *s = Common::String::format("var: #%s", u.sym->name); break; default: warning("Incorrect operation toString() for type: %s", type2str()); } u.s = s; type = STRING; return u.s; } const char *Datum::type2str(bool isk) { static char res[20]; switch (isk ? u.i : type) { case INT: return isk ? "#integer" : "INT"; case FLOAT: return isk ? "#float" : "FLOAT"; case STRING: return isk ? "#string" : "STRING"; case CASTREF: return "CASTREF"; case VOID: return isk ? "#void" : "VOID"; case POINT: return isk ? "#point" : "POINT"; case SYMBOL: return isk ? "#symbol" : "SYMBOL"; case OBJECT: return isk ? "#object" : "OBJECT"; case VAR: return isk ? "#var" : "VAR"; default: snprintf(res, 20, "-- (%d) --", type); return res; } } // This is table for built-in Macintosh font lowercasing. // '.' means that the symbol should be not changed, rest // of the symbols are stripping the diacritics // The table starts from 0x80 // // TODO: Check it for correctness. static char lowerCaseConvert[] = "aacenoua" // 80 "aaaaacee" // 88 "eeiiiino" // 90 "oooouuuu" // 98 "........" // a0 ".......o" // a8 "........" // b0 ".......o" // b8 "........" // c0 ".. aao.." // c8 "--.....y";// d0-d8 Common::String *Lingo::toLowercaseMac(Common::String *s) { Common::String *res = new Common::String; const unsigned char *p = (const unsigned char *)s->c_str(); while (*p) { if (*p >= 0x80 && *p <= 0xd8) { if (lowerCaseConvert[*p - 0x80] != '.') *res += lowerCaseConvert[*p - 0x80]; else *res += *p; } else if (*p < 0x80) { *res += tolower(*p); } else { warning("Unacceptable symbol in toLowercaseMac: %c", *p); *res += *p; } p++; } return res; } void Lingo::parseMenu(const char *code) { warning("STUB: parseMenu"); } void Lingo::runTests() { Common::File inFile; Common::ArchiveMemberList fsList; SearchMan.listMatchingMembers(fsList, "*.lingo"); Common::StringArray fileList; int counter = 1; for (Common::ArchiveMemberList::iterator it = fsList.begin(); it != fsList.end(); ++it) fileList.push_back((*it)->getName()); Common::sort(fileList.begin(), fileList.end()); for (uint i = 0; i < fileList.size(); i++) { Common::SeekableReadStream *const stream = SearchMan.createReadStreamForMember(fileList[i]); if (stream) { uint size = stream->size(); char *script = (char *)calloc(size + 1, 1); stream->read(script, size); debugC(2, kDebugLingoCompile, "Compiling file %s of size %d, id: %d", fileList[i].c_str(), size, counter); _hadError = false; addCode(script, kMovieScript, counter); if (!_hadError) executeScript(kMovieScript, counter); else debugC(2, kDebugLingoCompile, "Skipping execution"); free(script); counter++; } inFile.close(); } } } // End of namespace Director