Initial commit

engines/testbed/testsuite.h

@@ -0,0 +1,203 @@
+/* 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 TESTBED_TESTSUITE_H
+#define TESTBED_TESTSUITE_H
+
+#include "common/array.h"
+#include "common/rect.h"
+#include "common/scummsys.h"
+#include "common/system.h"
+#include "common/str.h"
+#include "graphics/font.h"
+
+#include "graphics/fontman.h"
+
+#include "testbed/config-params.h"
+
+namespace Testbed {
+
+enum {
+	kColorBlack = 0,
+	kColorWhite = 1,
+	kColorCustom = 2,
+	kColorSpecial = 5 	///< some random number
+};
+
+enum OptionSelected {
+	kOptionLeft = 0,
+	kOptionRight = 1
+};
+
+enum {
+	kEngineQuit = 0,
+	kSkipNext = 1,
+	kLoopNormal = 2,
+	// Event handling time,(in ms) used in parseEvent()
+	kEventHandlingTime = 50
+};
+
+enum TestExitStatus {
+	kTestPassed = 0,
+	kTestSkipped,
+	kTestFailed
+};
+
+enum WriteFlags {
+	kWriteNoFlag = 0,
+	kWriteRGBColors = (1 << 0),
+	kWriteDrawFrame = (1 << 1)
+};
+
+typedef TestExitStatus (*InvokingFunction)();
+
+/**
+ * This represents a feature to be tested
+ */
+
+struct Test {
+	Test(Common::String name, InvokingFunction f, bool interactive) : featureName(name) {
+		driver = f;
+		enabled = true;
+		passed = false;
+		isInteractive = interactive;
+	}
+	const Common::String featureName;	///< Name of feature to be tested
+	InvokingFunction driver;		///< Pointer to the function that will invoke this feature test
+	bool enabled;				    ///< Decides whether or not this test is to be executed
+	bool passed;					///< Collects and stores result of this feature test
+	bool isInteractive;				///< Decides if the test is interactive or not, An interactive testsuite may have non-interactive tests, hence this change.
+};
+
+
+/**
+ * The basic Testsuite class
+ * All the other testsuites would inherit it and override its virtual methods
+ */
+
+class Testsuite {
+public:
+	Testsuite();
+	virtual ~Testsuite();
+	int getNumTests() const { return _testsToExecute.size(); }
+	int getNumTestsPassed() const { return _numTestsPassed; }
+	int getNumTestsSkipped() const { return _numTestsSkipped; }
+	int getNumTestsFailed() const { return _numTestsExecuted - _numTestsPassed; }
+	void genReport() const;
+	bool isEnabled() const { return _isTsEnabled; }
+	virtual void enable(bool flag) {
+		_isTsEnabled = flag;
+	}
+	bool enableTest(const Common::String &testName, bool enable);
+	void reset();
+
+	/**
+	 * Prompts for User Input in form of "Yes" or "No" for interactive tests
+	 * e.g: "Is this like you expect?" "Yes" or "No"
+	 *
+	 * @param	textToDisplay Display text
+	 * @return	true if "Yes" false otherwise
+	 */
+	static bool handleInteractiveInput(const Common::String &textToDisplay, const char *opt1 = "Yes", const char *opt2 = "No", OptionSelected result = kOptionLeft);
+
+	static void displayMessage(const Common::String &textToDisplay, const char *defaultButton = "OK");
+	static Common::Rect writeOnScreen(const Common::String &textToDisplay, const Common::Point &pt, WriteFlags flag = kWriteNoFlag);
+	static void clearScreen(const Common::Rect &rect);
+	static void clearEntireScreen() {
+		const int width = g_system->getWidth();
+		const int height = g_system->getHeight();
+		Common::Rect r(0, 0, width, height);
+		clearScreen(r);
+	}
+	static void clearScreen();
+	static void clearScreen(bool flag);
+
+	/**
+	 * Adds a test to the list of tests to be executed
+	 *
+	 * @param	name the string description of the test, for display purposes
+	 * @param	f pointer to the function that invokes this test
+	 * @param	isInteractive	decides if the test is to be executed in interactive mode/ default true
+	 */
+	void addTest(const Common::String &name, InvokingFunction f, bool isInteractive = true);
+
+	/**
+	 * Testsuite state preparation code, like tweaking mouse cursors should go there
+	 */
+	virtual void prepare() {}
+
+	/**
+	 * The driver function for the testsuite
+	 * All code should go in here.
+	 */
+	virtual void execute();
+	static uint parseEvents();
+
+	virtual const char *getName() const = 0;
+	virtual const char *getDescription() const = 0;
+
+	static void logPrintf(MSVC_PRINTF const char *s, ...) GCC_PRINTF(1, 2);
+	static void logDetailedPrintf(MSVC_PRINTF const char *s, ...) GCC_PRINTF(1, 2);
+
+	// Progress bar (Information Display) related methods.
+	/**
+	 * Display region is in the bottom. Probably 1/4th of the game screen.
+	 * It contains:
+	 * 1) Information about executing testsuite.
+	 * 2) Total progress within this testsuite.
+	 * 3) Total overall progress in the number of testsuites
+	 */
+
+	static Common::Point getDisplayRegionCoordinates() {
+		Common::Point pt(0, 0);
+		// start from bottom
+		pt.y = g_system->getHeight();
+		// Will Contain 3 lines
+		pt.y -= (FontMan.getFontByUsage(ConfParams.getCurrentFontUsageType())->getFontHeight() * 3 + 15); // Buffer of 5 pixels per line
+		return pt;
+	}
+
+	static uint getLineSeparation() {
+		return FontMan.getFontByUsage(ConfParams.getCurrentFontUsageType())->getFontHeight() + 5;
+	}
+
+	static void updateStats(const char *prefix, const char *info, uint numTests, uint testNum, Common::Point pt);
+	const Common::Array<Test *>& getTestList() { return _testsToExecute; }
+	int getNumTestsEnabled();
+
+protected:
+	Common::Array<Test *> _testsToExecute;			///< List of tests to be executed
+	int		    _numTestsPassed;					///< Number of tests passed
+	int			_numTestsExecuted;					///< Number of tests executed
+	int			_numTestsSkipped;
+	bool		_isTsEnabled;
+
+private:
+
+	/**
+	 * Used from the code to decide if the engine needs to exit
+	 */
+	uint _toQuit;
+};
+
+} // End of namespace Testbed
+
+#endif // TESTBED_TESTSUITE_H