Event.hh

Go to the documentation of this file.

#ifndef EVENT_HH
#define EVENT_HH

#include <string>

namespace openmsx {

class TclObject;

enum EventType
{
        OPENMSX_KEY_UP_EVENT,
        OPENMSX_KEY_DOWN_EVENT,
        OPENMSX_KEY_GROUP_EVENT,
        OPENMSX_MOUSE_MOTION_EVENT,
        OPENMSX_MOUSE_MOTION_GROUP_EVENT,
        OPENMSX_MOUSE_BUTTON_UP_EVENT,
        OPENMSX_MOUSE_BUTTON_DOWN_EVENT,
        OPENMSX_MOUSE_BUTTON_GROUP_EVENT,
        OPENMSX_MOUSE_WHEEL_EVENT,
        OPENMSX_MOUSE_WHEEL_GROUP_EVENT,
        OPENMSX_JOY_AXIS_MOTION_EVENT,
        OPENMSX_JOY_AXIS_MOTION_GROUP_EVENT,
        OPENMSX_JOY_HAT_EVENT,
        OPENMSX_JOY_HAT_GROUP_EVENT,
        OPENMSX_JOY_BUTTON_UP_EVENT,
        OPENMSX_JOY_BUTTON_DOWN_EVENT,
        OPENMSX_JOY_BUTTON_GROUP_EVENT,
        OPENMSX_FOCUS_EVENT,
        OPENMSX_RESIZE_EVENT,
        OPENMSX_QUIT_EVENT,
        OPENMSX_OSD_CONTROL_RELEASE_EVENT,
        OPENMSX_OSD_CONTROL_PRESS_EVENT,
        OPENMSX_BOOT_EVENT, // sent when the MSX resets or power ups

        OPENMSX_FINISH_FRAME_EVENT,

        OPENMSX_FRAME_DRAWN_EVENT,

        OPENMSX_BREAK_EVENT,
        OPENMSX_SWITCH_RENDERER_EVENT,

        OPENMSX_TAKE_REVERSE_SNAPSHOT,

        OPENMSX_CLICOMMAND_EVENT,

        OPENMSX_AFTER_TIMED_EVENT,

        OPENMSX_MACHINE_LOADED_EVENT,

        OPENMSX_MACHINE_ACTIVATED,
        OPENMSX_MACHINE_DEACTIVATED,

        OPENMSX_EXPOSE_EVENT,

        OPENMSX_DELETE_BOARDS,

        OPENMSX_MIDI_IN_READER_EVENT,
        OPENMSX_MIDI_IN_WINDOWS_EVENT,
        OPENMSX_MIDI_IN_COREMIDI_EVENT,
        OPENMSX_MIDI_IN_COREMIDI_VIRTUAL_EVENT,
        OPENMSX_RS232_TESTER_EVENT,

        NUM_EVENT_TYPES // must be last
};

class Event
{
public:
        Event(const Event&) = delete;
        Event& operator=(const Event&) = delete;

        EventType getType() const { return type; }

        std::string toString() const;

        virtual TclObject toTclList() const = 0;

        bool operator< (const Event& other) const;
        bool operator> (const Event& other) const;
        bool operator<=(const Event& other) const;
        bool operator>=(const Event& other) const;
        bool operator==(const Event& other) const;
        bool operator!=(const Event& other) const;

        virtual bool isRepeatStopper(const Event& /*other*/) const {
                return true;
        }

        virtual bool matches(const Event& other) const {
                return *this == other;
        }

protected:
        explicit Event(EventType type_) : type(type_) {}
        ~Event() = default;

private:
        virtual bool lessImpl(const Event& other) const = 0;

        const EventType type;
};

// implementation for events that don't need additional data
class SimpleEvent final : public Event
{
public:
        explicit SimpleEvent(EventType type_) : Event(type_) {}
        TclObject toTclList() const override;
        bool lessImpl(const Event& other) const override;
};

} // namespace openmsx

#endif