Initial commit

engines/director/lingo/xlibs/u/unittest.cpp

@@ -0,0 +1,210 @@
+/* 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+/*************************************
+ *
+ * ScummVM Unit Testing framework.
+ * Used in the Director Test suite - https://github.com/scummvm/director-tests
+ *
+ *************************************/
+
+#include "common/events.h"
+#include "director/director.h"
+#include "director/archive.h"
+#include "director/lingo/lingo.h"
+#include "director/lingo/lingo-object.h"
+#include "director/lingo/xlibs/u/unittest.h"
+#include "director/movie.h"
+#include "director/score.h"
+#include "director/window.h"
+#ifdef USE_PNG
+#include "image/png.h"
+#else
+#include "image/bmp.h"
+#endif
+
+namespace Director {
+
+const char *const UnitTestXObj::xlibName = "UnitTest";
+const XlibFileDesc UnitTestXObj::fileNames[] = {
+	{ "UnitTest",	nullptr },
+	{ nullptr,		nullptr },
+};
+/*
+-- ScummVM UnitTest XObject.
+UnitTest
+I      mNew                     --Creates a new instance of the XObject
+X      mDispose                 --Disposes of XObject instance
+I      mIsRealDirector          --Returns 1 for real Director, 0 for ScummVM
+IS     mScreenshot, path        --Copy contents of stage window to file
+III    mMoveMouse, x, y         --Move the mouse pointer to window position (x, y)
+I      mLeftMouseDown           --Press the LMB
+I      mLeftMouseUp             --Release the LMB
+ */
+
+static const MethodProto xlibMethods[] = {
+	{ "new",				UnitTestXObj::m_new,				0, 0,	400 },	// D4
+	{ "dispose",			UnitTestXObj::m_dispose,			0, 0,	400 },	// D4
+	{ "isRealDirector",		UnitTestXObj::m_isRealDirector,		0, 0,	400 },	// D4
+	{ "screenshot",			UnitTestXObj::m_screenshot,			1, 1,	400 },	// D4
+	{ "moveMouse",			UnitTestXObj::m_moveMouse,			2, 2,	400 },	// D4
+	{ "leftMouseDown",		UnitTestXObj::m_leftMouseDown,		0, 0,	400 },	// D4
+	{ "leftMouseUp",		UnitTestXObj::m_leftMouseUp,		0, 0,	400 },	// D4
+	{ nullptr, nullptr, 0, 0, 0 }
+};
+
+void UnitTestXObj::open(ObjectType type, const Common::Path &path) {
+	if (type == kXObj) {
+		UnitTestXObject::initMethods(xlibMethods);
+		UnitTestXObject *xobj = new UnitTestXObject(kXObj);
+		g_lingo->exposeXObject(xlibName, xobj);
+	}
+}
+
+void UnitTestXObj::close(ObjectType type) {
+	if (type == kXObj) {
+		UnitTestXObject::cleanupMethods();
+		g_lingo->_globalvars[xlibName] = Datum();
+	}
+}
+
+UnitTestXObject::UnitTestXObject(ObjectType ObjectType) :Object<UnitTestXObject>("UnitTest") {
+	_objType = ObjectType;
+}
+
+void UnitTestXObj::m_new(int nargs) {
+	g_lingo->push(g_lingo->_state->me);
+}
+
+void UnitTestXObj::m_dispose(int nargs) {
+}
+
+void UnitTestXObj::m_isRealDirector(int nargs) {
+	g_lingo->push(0);
+}
+
+void UnitTestXObj::m_screenshot(int nargs) {
+	if (nargs == 0) {
+		g_lingo->push(Datum(0));
+		warning("UnitTestXObj::m_screenshot(): expected filename argument");
+		return;
+	}
+	if (nargs > 1) {
+		g_lingo->dropStack(nargs - 1);
+		nargs = 1;
+	}
+	Datum name = g_lingo->pop();
+	if (name.type != STRING) {
+		warning("UnitTestXObj::m_screenshot(): expected string for arg 1");
+		g_lingo->push(Datum(0));
+		return;
+	}
+	Common::String filenameBase = *name.u.s;
+
+	Common::FSNode gameDataDir = g_director->_gameDataDir;
+	Common::FSNode screenDir = gameDataDir.getChild("scrtest");
+	if (!screenDir.exists()) {
+		screenDir.createDirectory();
+	}
+
+	// Fetch whatever is in the screen buffer.
+	// Don't force a redraw, we do that in the script with updateStage().
+	Window *window = g_director->getCurrentWindow();
+	Graphics::ManagedSurface *windowSurface = window->getSurface();
+
+#ifdef USE_PNG
+	Common::FSNode file = screenDir.getChild(Common::String::format("%s.png", filenameBase.c_str()));
+#else
+	Common::FSNode file = screenDir.getChild(Common::String::format("%s.bmp", filenameBase.c_str()));
+#endif
+
+	Common::SeekableWriteStream *stream = file.createWriteStream();
+	if (!stream) {
+		warning("UnitTestXObj::m_screenshot(): could not open file %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str());
+		return;
+	}
+
+	bool success = false;
+#ifdef USE_PNG
+	if (windowSurface->format.bytesPerPixel == 1) {
+		success = Image::writePNG(*stream, *windowSurface, g_director->getPalette());
+	} else {
+		success = Image::writePNG(*stream, *windowSurface);
+	}
+#else
+	success = Image::writeBMP(*stream, *windowSurface);
+#endif
+	if (!success) {
+		warning("UnitTestXObj::m_screenshot(): error writing screenshot data to file %s", file.getPath().toString(Common::Path::kNativeSeparator).c_str());
+	}
+	stream->finalize();
+	delete stream;
+}
+
+void UnitTestXObj::m_moveMouse(int nargs) {
+	if (nargs != 2) {
+		warning("UnitTestXObj::m_moveMouse: expected 2 arguments");
+		g_lingo->dropStack(nargs);
+		g_lingo->push(0);
+		return;
+	}
+	UnitTestXObject *me = static_cast<UnitTestXObject *>(g_lingo->_state->me.u.obj);
+	int16 y = (int16)g_lingo->pop().asInt();
+	int16 x = (int16)g_lingo->pop().asInt();
+	Common::Event ev;
+	ev.type = Common::EVENT_MOUSEMOVE;
+	ev.mouse = Common::Point(x, y);
+	me->_mousePos = ev.mouse;
+	g_director->_injectedEvents.push_back(ev);
+	g_lingo->push(0);
+}
+
+void UnitTestXObj::m_leftMouseDown(int nargs) {
+	if (nargs != 0) {
+		warning("UnitTestXObj::m_leftMouseDown: expected 0 arguments");
+		g_lingo->dropStack(nargs);
+		g_lingo->push(0);
+		return;
+	}
+	UnitTestXObject *me = static_cast<UnitTestXObject *>(g_lingo->_state->me.u.obj);
+	Common::Event ev;
+	ev.type = Common::EVENT_LBUTTONDOWN;
+	ev.mouse = me->_mousePos;
+	g_director->_injectedEvents.push_back(ev);
+	g_lingo->push(0);
+}
+
+void UnitTestXObj::m_leftMouseUp(int nargs) {
+	if (nargs != 0) {
+		warning("UnitTestXObj::m_leftMouseDown: expected 0 arguments");
+		g_lingo->dropStack(nargs);
+		g_lingo->push(0);
+		return;
+	}
+	UnitTestXObject *me = static_cast<UnitTestXObject *>(g_lingo->_state->me.u.obj);
+	Common::Event ev;
+	ev.type = Common::EVENT_LBUTTONUP;
+	ev.mouse = me->_mousePos;
+	g_director->_injectedEvents.push_back(ev);
+	g_lingo->push(0);
+}
+
+} // End of namespace Director

engines/director/lingo/xlibs/u/unittest.h

@@ -0,0 +1,53 @@
+/* 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 3 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, see <http://www.gnu.org/licenses/>.
+ *
+ */
+
+#ifndef DIRECTOR_LINGO_XLIBS_UNITTEST_H
+#define DIRECTOR_LINGO_XLIBS_UNITTEST_H
+
+namespace Director {
+
+class UnitTestXObject : public Object<UnitTestXObject> {
+public:
+	UnitTestXObject(ObjectType objType);
+	Common::Point _mousePos;
+};
+
+namespace UnitTestXObj {
+
+extern const char *const xlibName;
+extern const XlibFileDesc fileNames[];
+
+void open(ObjectType type, const Common::Path &path);
+void close(ObjectType type);
+
+void m_new(int nargs);
+void m_dispose(int nargs);
+void m_isRealDirector(int nargs);
+void m_screenshot(int nargs);
+void m_moveMouse(int nargs);
+void m_leftMouseDown(int nargs);
+void m_leftMouseUp(int nargs);
+
+} // End of namespace UnitTest
+
+} // End of namespace Director
+
+#endif