controller.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 ULTIMA4_CONTROLLERS_CONTROLLER_H
#define ULTIMA4_CONTROLLERS_CONTROLLER_H

#include "ultima/ultima4/metaengine.h"

namespace Ultima {
namespace Ultima4 {

class Controller {
public:
    Controller(int timerInterval = 1);
    virtual ~Controller();

    /* methods for interacting with event manager */
    virtual bool isCombatController() const {
        return false;
    }

    bool notifyKeyPressed(int key);

    bool notifyMousePress(const Common::Point &mousePos);

    int getTimerInterval();

    static void timerCallback(void *data);

    virtual void setActive();

    virtual bool keyPressed(int key) {
        return false;
    }

    virtual bool mousePressed(const Common::Point &mousePos) {
        return false;
    }

    virtual void keybinder(KeybindingAction action) {}

    virtual void timerFired();

    bool shouldQuit() const;
private:
    int _timerInterval;
};

// helper functions for the waitable controller; they just avoid
// having eventhandler dependencies in this header file
void Controller_startWait();
void Controller_endWait();

template<class T>
class WaitableController : public Controller {
private:
    bool _exitWhenDone;
    T _defaultValue;
protected:
    T _value;
    void doneWaiting() {
        if (_exitWhenDone)
            Controller_endWait();
    }
public:
    WaitableController(T defaultValue) : _defaultValue(defaultValue),
        _value(defaultValue), _exitWhenDone(false) {}

    virtual T getValue() {
        return shouldQuit() ? _defaultValue : _value;
    }

    virtual T waitFor() {
        _exitWhenDone = true;
        Controller_startWait();
        return getValue();
    }

    virtual bool mousePressed(const Common::Point &mousePos) {
        // Treat mouse clicks as an abort
        doneWaiting();
        _value = _defaultValue;
        return true;
    }
};

class TurnCompleter {
public:
    virtual ~TurnCompleter() {
    }
    virtual void finishTurn() = 0;

    virtual void finishTurnAfterCombatEnds() {
        finishTurn();
    }
};

} // End of namespace Ultima4
} // End of namespace Ultima

#endif