eventmanager.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005-2019 by the FIFE team                              *
 *   http://www.fifengine.net                                              *
 *   This file is part of FIFE.                                            *
 *                                                                         *
 *   FIFE is free software; you can redistribute it and/or                 *
 *   modify it under the terms of the GNU Lesser General Public            *
 *   License as published by the Free Software Foundation; either          *
 *   version 2.1 of the License, or (at your option) any later version.    *
 *                                                                         *
 *   This library 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     *
 *   Lesser General Public License for more details.                       *
 *                                                                         *
 *   You should have received a copy of the GNU Lesser General Public      *
 *   License along with this library; if not, write to the                 *
 *   Free Software Foundation, Inc.,                                       *
 *   51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA          *
 ***************************************************************************/

#ifndef FIFE_EVENTCHANNEL_EVENTMANAGER_H
#define FIFE_EVENTCHANNEL_EVENTMANAGER_H

// Standard C++ library includes
//
#include <deque>
#include <map>
#include <list>

// 3rd party library includes
//

// FIFE includes
// These includes are split up in two parts, separated by one empty line
// First block: files included from the FIFE root src directory
// Second block: files included from the same folder
//
#include "util/base/fife_stdint.h"
#include "eventchannel/command/command.h"
#include "eventchannel/command/icommandcontroller.h"
#include "eventchannel/command/icommandlistener.h"

#include "eventchannel/drop/idropcontroller.h"
#include "eventchannel/drop/idroplistener.h"
#include "eventchannel/drop/dropevent.h"

#include "eventchannel/key/ikeycontroller.h"
#include "eventchannel/key/ikeylistener.h"
#include "eventchannel/key/keyevent.h"
#include "eventchannel/key/key.h"

#include "eventchannel/text/itextcontroller.h"
#include "eventchannel/text/itextlistener.h"
#include "eventchannel/text/textevent.h"
#include "eventchannel/text/text.h"

#include "eventchannel/mouse/imousecontroller.h"
#include "eventchannel/mouse/imouselistener.h"
#include "eventchannel/mouse/mouseevent.h"

#include "eventchannel/sdl/isdleventcontroller.h"
#include "eventchannel/sdl/isdleventlistener.h"

namespace FIFE {

    class ICommandListener;
    class InputEvent;
    class IJoystickListener;
    class Joystick;
    class JoystickManager;
    class MouseEvent;
    class KeyEvent;
    class IKeyFilter;
    class DropEvent;

    class EventManager:
        public ICommandController,
        public IKeyController,
        public ITextController,
        public IMouseController,
        public ISdlEventController,
        public IDropController,
        public IEventSource {
    public:
        EventManager();

        virtual ~EventManager();

        void addCommandListener(ICommandListener* listener);
        void addCommandListenerFront(ICommandListener* listener);
        void removeCommandListener(ICommandListener* listener);

        void dispatchCommand(Command& command);

        void addKeyListener(IKeyListener* listener);
        void addKeyListenerFront(IKeyListener* listener);
        void removeKeyListener(IKeyListener* listener);

        void addTextListener(ITextListener* listener);
        void addTextListenerFront(ITextListener* listener);
        void removeTextListener(ITextListener* listener);

        void addMouseListener(IMouseListener* listener);
        void addMouseListenerFront(IMouseListener* listener);
        void removeMouseListener(IMouseListener* listener);

        void addSdlEventListener(ISdlEventListener* listener);
        void addSdlEventListenerFront(ISdlEventListener* listener);
        void removeSdlEventListener(ISdlEventListener* listener);

        void addDropListener(IDropListener* listener);
        void addDropListenerFront(IDropListener* listener);
        void removeDropListener(IDropListener* listener);

        void addJoystickListener(IJoystickListener* listener);
        void addJoystickListenerFront(IJoystickListener* listener);
        void removeJoystickListener(IJoystickListener* listener);

        EventSourceType getEventSourceType();

        void processEvents();

        void setKeyFilter(IKeyFilter* keyFilter);

        void setMouseSensitivity(float sensitivity);

        float getMouseSensitivity() const;

        void setMouseAccelerationEnabled(bool acceleration);

        bool isMouseAccelerationEnabled() const;

        bool isClipboardText() const;

        std::string getClipboardText() const;

        void setClipboardText(const std::string& text);

        void setJoystickSupport(bool support);

        Joystick* getJoystick(int32_t instanceId);

        uint8_t getJoystickCount() const;

        void loadGamepadMapping(const std::string& file);

        void saveGamepadMapping(const std::string guid, const std::string& file);

        void saveGamepadMappings(const std::string& file);

        std::string getGamepadStringMapping(const std::string& guid);

        void setGamepadStringMapping(const std::string& mapping);

    private:
        // Helpers for processEvents
        void processWindowEvent(SDL_Event event);
        void processKeyEvent(SDL_Event event);
        void processTextEvent(SDL_Event event);
        void processMouseEvent(SDL_Event event);
        void processDropEvent(SDL_Event event);
        bool combineEvents(SDL_Event& event1, const SDL_Event& event2);

        // Events dispatchers - only dispatchSdlevent may reject the event.
        bool dispatchSdlEvent(SDL_Event& evt);
        void dispatchKeyEvent(KeyEvent& evt);
        void dispatchTextEvent(TextEvent& evt);
        void dispatchMouseEvent(MouseEvent& evt);
        void dispatchDropEvent(DropEvent& evt);

        // Translate events
        void fillModifiers(InputEvent& evt);
        void fillKeyEvent(const SDL_Event& sdlevt, KeyEvent& keyevt);
        void fillTextEvent(const SDL_Event& sdlevt, TextEvent& txtevt);
        void fillMouseEvent(const SDL_Event& sdlevt, MouseEvent& mouseevt);

        // Listeners
        std::deque<ICommandListener*> m_commandListeners;
        std::deque<IKeyListener*> m_keyListeners;
        std::deque<ITextListener*> m_textListeners;
        std::deque<IMouseListener*> m_mouseListeners;
        std::deque<ISdlEventListener*> m_sdleventListeners;
        std::deque<IDropListener*> m_dropListeners;

        std::map<int32_t, bool> m_keystatemap;
        IKeyFilter* m_keyfilter;
        int32_t m_mousestate;
        MouseEvent::MouseButtonType m_mostrecentbtn;

        // m_mouseSensitivity is the mouse speed factor - 1, so a value of 0 won't
        // influence mouse speed, a value of 1 would double the speed and
        // -.5 would make it half the speed
        float m_mouseSensitivity;
        bool m_acceleration;
        bool m_warp;
        bool m_enter;
        uint16_t m_oldX;
        uint16_t m_oldY;
        uint32_t m_lastTicks;
        float m_oldVelocity;

        JoystickManager* m_joystickManager;

    };
} //FIFE

#endif