testsuite.h

/* 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   
};

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)();

struct Test {
    Test(Common::String name, InvokingFunction f, bool interactive) : featureName(name) {
        driver = f;
        enabled = true;
        passed = false;
        isInteractive = interactive;
    }
    const Common::String featureName;   
    InvokingFunction driver;        
    bool enabled;                   
    bool passed;                    
    bool isInteractive;             
};


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();

    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);

    void addTest(const Common::String &name, InvokingFunction f, bool isInteractive = true);

    virtual void prepare() {}

    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.
    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;          
    int         _numTestsPassed;                    
    int         _numTestsExecuted;                  
    int         _numTestsSkipped;
    bool        _isTsEnabled;

private:

    uint _toQuit;
};

} // End of namespace Testbed

#endif // TESTBED_TESTSUITE_H