SDLInput Class Reference

#include <sdlinput.h>

Public Member Functions
	SDLInput ()
void	pushInput (const SDL_Event &event)
KeyInput	dequeueKeyInput ()
bool	isKeyQueueEmpty () const
bool	isMouseQueueEmpty () const
MouseInput	dequeueMouseInput ()
void	simulateMouseClick (const int x, const int y, const MouseButtonT button)
void	simulateMouseMove ()
void	simulateKey (const int guiKey, const InputActionT actionId)

Static Protected Member Functions
static MouseButtonT	convertMouseButton (const int button)
static int	convertKeyCharacter (const SDL_Event &event)
static void	convertKeyEventToKey (const SDL_Event &event, KeyInput &keyInput)

Protected Attributes
std::queue< KeyInput >	mKeyInputQueue
std::queue< MouseInput >	mMouseInputQueue
time_t	mMouseMoveTime
bool	mMouseDown
bool	mMouseInWindow

Detailed Description

SDL implementation of SDLInput.

Definition at line 104 of file sdlinput.h.

Constructor & Destructor Documentation

SDLInput()

SDLInput::SDLInput

(

)

Constructor.

Definition at line 103 of file sdlinput.cpp.

                   :
    mKeyInputQueue(),
    mMouseInputQueue(),
    mMouseMoveTime(0),
    mMouseDown(false),
    mMouseInWindow(true)
{
}

Member Function Documentation

convertKeyCharacter()

static int SDLInput::convertKeyCharacter ( const SDL_Event &  event )

inlinestaticprotected

Converts an SDL event key to a key value.

Parameters

event

an SDL event with a key to convert.

Returns

a key value.

See also

Key

Definition at line 157 of file sdlinput.h.

        {
            const SDL_keysym keysym = event.key.keysym;
#ifdef USE_SDL2
            int value = keysym.scancode;
#else  // USE_SDL2
 
            int value = keysym.unicode;
#endif  // USE_SDL2
 
            PRAGMA45(GCC diagnostic push)
            PRAGMA45(GCC diagnostic ignored "-Wswitch-enum")
            switch (keysym.sym)
            {
              case SDLK_TAB:
                  value = KeyValue::TAB;
                  break;
              case SDLK_LALT:
                  value = KeyValue::LEFT_ALT;
                  break;
              case SDLK_RALT:
                  value = KeyValue::RIGHT_ALT;
                  break;
              case SDLK_LSHIFT:
                  value = KeyValue::LEFT_SHIFT;
                  break;
              case SDLK_RSHIFT:
                  value = KeyValue::RIGHT_SHIFT;
                  break;
              case SDLK_LCTRL:
                  value = KeyValue::LEFT_CONTROL;
                  break;
              case SDLK_RCTRL:
                  value = KeyValue::RIGHT_CONTROL;
                  break;
              case SDLK_BACKSPACE:
                  value = KeyValue::BACKSPACE;
                  break;
              case SDLK_PAUSE:
                  value = KeyValue::PAUSE;
                  break;
              case SDLK_SPACE:
                  // Special characters like ~ (tilde) ends up
                  // with the keysym.sym SDLK_SPACE which
                  // without this check would be lost. The check
                  // is only valid on key down events in SDL.
#ifndef USE_SDL2
                  if (event.type == SDL_KEYUP ||
                      keysym.unicode == ' ')
#endif  // USE_SDL2
                  {
                      value = KeyValue::SPACE;
                  }
                  break;
              case SDLK_ESCAPE:
#ifdef USE_SDL2
              case SDLK_AC_BACK:
#endif  // USE_SDL2
                  value = KeyValue::ESCAPE;
                  break;
              case SDLK_DELETE:
                  value = KeyValue::DELETE_;
                  break;
              case SDLK_INSERT:
                  value = KeyValue::INSERT;
                  break;
              case SDLK_HOME:
                  value = KeyValue::HOME;
                  break;
              case SDLK_END:
                  value = KeyValue::END;
                  break;
              case SDLK_PAGEUP:
                  value = KeyValue::PAGE_UP;
                  break;
              case SDLK_PRINT:
                  value = KeyValue::PRINT_SCREEN;
                  break;
              case SDLK_PAGEDOWN:
                  value = KeyValue::PAGE_DOWN;
                  break;
              case SDLK_F1:
                  value = KeyValue::F1;
                  break;
              case SDLK_F2:
                  value = KeyValue::F2;
                  break;
              case SDLK_F3:
                  value = KeyValue::F3;
                  break;
              case SDLK_F4:
                  value = KeyValue::F4;
                  break;
              case SDLK_F5:
                  value = KeyValue::F5;
                  break;
              case SDLK_F6:
                  value = KeyValue::F6;
                  break;
              case SDLK_F7:
                  value = KeyValue::F7;
                  break;
              case SDLK_F8:
                  value = KeyValue::F8;
                  break;
              case SDLK_F9:
                  value = KeyValue::F9;
                  break;
              case SDLK_F10:
                  value = KeyValue::F10;
                  break;
              case SDLK_F11:
                  value = KeyValue::F11;
                  break;
              case SDLK_F12:
                  value = KeyValue::F12;
                  break;
              case SDLK_F13:
                  value = KeyValue::F13;
                  break;
              case SDLK_F14:
                  value = KeyValue::F14;
                  break;
              case SDLK_F15:
                  value = KeyValue::F15;
                  break;
              case SDLK_NUMLOCK:
                  value = KeyValue::NUM_LOCK;
                  break;
              case SDLK_CAPSLOCK:
                  value = KeyValue::CAPS_LOCK;
                  break;
              case SDLK_SCROLLOCK:
                  value = KeyValue::SCROLL_LOCK;
                  break;
              case SDLK_RMETA:
                  value = KeyValue::RIGHT_META;
                  break;
              case SDLK_LMETA:
                  value = KeyValue::LEFT_META;
                  break;
#ifndef USE_SDL2
              case SDLK_LSUPER:
                  value = KeyValue::LEFT_SUPER;
                  break;
              case SDLK_RSUPER:
                  value = KeyValue::RIGHT_SUPER;
                  break;
#endif  // USE_SDL2
 
              case SDLK_MODE:
                  value = KeyValue::ALT_GR;
                  break;
              case SDLK_UP:
                  value = KeyValue::UP;
                  break;
              case SDLK_DOWN:
                  value = KeyValue::DOWN;
                  break;
              case SDLK_LEFT:
                  value = KeyValue::LEFT;
                  break;
              case SDLK_RIGHT:
                  value = KeyValue::RIGHT;
                  break;
              case SDLK_RETURN:
              case SDLK_KP_ENTER:
                  value = KeyValue::ENTER;
                  break;
 
              default:
                  break;
            }
            PRAGMA45(GCC diagnostic pop)
 
            if ((CAST_U32(keysym.mod) & KMOD_NUM) == 0U)
            {
                PRAGMA45(GCC diagnostic push)
                PRAGMA45(GCC diagnostic ignored "-Wswitch-enum")
                switch (keysym.sym)
                {
                  case SDLK_KP0:
                      value = KeyValue::INSERT;
                      break;
                  case SDLK_KP1:
                      value = KeyValue::END;
                      break;
                  case SDLK_KP2:
                      value = KeyValue::DOWN;
                      break;
                  case SDLK_KP3:
                      value = KeyValue::PAGE_DOWN;
                      break;
                  case SDLK_KP4:
                      value = KeyValue::LEFT;
                      break;
                  case SDLK_KP5:
                      value = 0;
                      break;
                  case SDLK_KP6:
                      value = KeyValue::RIGHT;
                      break;
                  case SDLK_KP7:
                      value = KeyValue::HOME;
                      break;
                  case SDLK_KP8:
                      value = KeyValue::UP;
                      break;
                  case SDLK_KP9:
                      value = KeyValue::PAGE_UP;
                      break;
                  default:
                      break;
                }
                PRAGMA45(GCC diagnostic pop)
            }
            return value;
        }

References KeyValue::ALT_GR, KeyValue::BACKSPACE, KeyValue::CAPS_LOCK, CAST_U32, KeyValue::DELETE_, KeyValue::DOWN, KeyValue::END, KeyValue::ENTER, KeyValue::ESCAPE, KeyValue::F1, KeyValue::F10, KeyValue::F11, KeyValue::F12, KeyValue::F13, KeyValue::F14, KeyValue::F15, KeyValue::F2, KeyValue::F3, KeyValue::F4, KeyValue::F5, KeyValue::F6, KeyValue::F7, KeyValue::F8, KeyValue::F9, KeyValue::HOME, KeyValue::INSERT, KeyValue::LEFT, KeyValue::LEFT_ALT, KeyValue::LEFT_CONTROL, KeyValue::LEFT_META, KeyValue::LEFT_SHIFT, KeyValue::LEFT_SUPER, KeyValue::NUM_LOCK, KeyValue::PAGE_DOWN, KeyValue::PAGE_UP, KeyValue::PAUSE, PRAGMA45(), KeyValue::PRINT_SCREEN, KeyValue::RIGHT, KeyValue::RIGHT_ALT, KeyValue::RIGHT_CONTROL, KeyValue::RIGHT_META, KeyValue::RIGHT_SHIFT, KeyValue::RIGHT_SUPER, KeyValue::SCROLL_LOCK, KeyValue::SPACE, KeyValue::TAB, and KeyValue::UP.

Referenced by convertKeyEventToKey().

convertKeyEventToKey()

void SDLInput::convertKeyEventToKey ( const SDL_Event &  event, KeyInput &  keyInput  )

staticprotected

Definition at line 329 of file sdlinput.cpp.

{
    keyInput.setKey(Key(convertKeyCharacter(event)));
    const InputActionT actionId = inputManager.getActionByKey(event);
    if (actionId > InputAction::NO_VALUE)
        keyInput.setActionId(actionId);
}

References convertKeyCharacter(), InputManager::getActionByKey(), inputManager, InputAction::NO_VALUE, KeyInput::setActionId(), and KeyInput::setKey().

Referenced by pushInput().

convertMouseButton()

MouseButtonT SDLInput::convertMouseButton ( const int  button )

staticprotected

Converts a mouse button from SDL to a Guichan mouse button representation.

Parameters

button

an SDL mouse button.

Returns

a Guichan mouse button.

Definition at line 337 of file sdlinput.cpp.

{
    switch (button)
    {
        case SDL_BUTTON_LEFT:
            return MouseButton::LEFT;
        case SDL_BUTTON_RIGHT:
            return MouseButton::RIGHT;
        case SDL_BUTTON_MIDDLE:
            return MouseButton::MIDDLE;
#ifndef USE_SDL2
        case SDL_BUTTON_WHEELUP:
        case SDL_BUTTON_WHEELDOWN:
            return MouseButton::EMPTY;
#endif  // USE_SDL2
 
        default:
            // We have an unknown mouse type which is ignored.
            logger->log("unknown button type: %d", button);
            return MouseButton::EMPTY;
    }
}

References MouseButton::EMPTY, MouseButton::LEFT, Logger::log(), logger, MouseButton::MIDDLE, and MouseButton::RIGHT.

Referenced by pushInput().

dequeueKeyInput()

KeyInput SDLInput::dequeueKeyInput

(

)

Definition at line 112 of file sdlinput.cpp.

{
    if (mKeyInputQueue.empty())
        return KeyInput();
 
    KeyInput keyInput = mKeyInputQueue.front();
    mKeyInputQueue.pop();
 
    return keyInput;
}

References mKeyInputQueue.

Referenced by Gui::handleKeyInput().

dequeueMouseInput()

MouseInput SDLInput::dequeueMouseInput

(

)

Definition at line 123 of file sdlinput.cpp.

{
    MouseInput mouseInput;
 
    if (mMouseInputQueue.empty())
        return MouseInput();
 
    mouseInput = mMouseInputQueue.front();
    mMouseInputQueue.pop();
 
    return mouseInput;
}

References mMouseInputQueue.

Referenced by Gui::handleMouseInput().

isKeyQueueEmpty()

bool SDLInput::isKeyQueueEmpty ( ) const

inline

Definition at line 124 of file sdlinput.h.

        { return mKeyInputQueue.empty(); }

References mKeyInputQueue.

Referenced by Gui::handleKeyInput().

isMouseQueueEmpty()

bool SDLInput::isMouseQueueEmpty ( ) const

inline

Definition at line 127 of file sdlinput.h.

        { return mMouseInputQueue.empty(); }

References mMouseInputQueue.

Referenced by Gui::handleMouseInput().

pushInput()

void SDLInput::pushInput

(

const SDL_Event &

event

)

Pushes an SDL event. It should be called at least once per frame to update input with user input.

Parameters

event

an event from SDL.

< The app has mouse coverage

< The app has mouse coverage

Definition at line 136 of file sdlinput.cpp.

{
    BLOCK_START("SDLInput::pushInput")
    KeyInput keyInput;
    MouseInput mouseInput;
 
#ifdef __SWITCH__
    // send an enter/select key on keyboard dismiss event
    bool visible = SDL_GetEventState(SDL_TEXTINPUT) == SDL_ENABLE;
    if (visible)
    {
        keyboardClosed = false;
    }
    else if (!keyboardClosed)
    {
        simulateKey(KeyValue::ENTER, InputAction::GUI_SELECT2);
        keyboardClosed = true;
    }
#endif
 
    switch (event.type)
    {
        case SDL_KEYDOWN:
        {
            keyInput.setType(KeyEventType::PRESSED);
            convertKeyEventToKey(event, keyInput);
            mKeyInputQueue.push(keyInput);
            break;
        }
 
        case SDL_KEYUP:
        {
            keyInput.setType(KeyEventType::RELEASED);
            convertKeyEventToKey(event, keyInput);
            mKeyInputQueue.push(keyInput);
            break;
        }
 
#ifdef USE_SDL2
        case SDL_TEXTINPUT:
            keyInput.setType(KeyEventType::PRESSED);
            keyInput.setKey(Key(KeyValue::TEXTINPUT));
            keyInput.setText(event.text.text);
            mKeyInputQueue.push(keyInput);
            break;
 
        case SDL_MOUSEWHEEL:
        {
            const int y = event.wheel.y;
            if (y)
            {
                mouseInput.setX(gui->getLastMouseX());
                mouseInput.setY(gui->getLastMouseY());
#ifdef ANDROID
                mouseInput.setReal(0, 0);
#endif  // ANDROID
 
                mouseInput.setButton(MouseButton::WHEEL);
                if (y > 0)
                    mouseInput.setType(MouseEventType::WHEEL_MOVED_UP);
                else
                    mouseInput.setType(MouseEventType::WHEEL_MOVED_DOWN);
                mouseInput.setTimeStamp(SDL_GetTicks());
                mMouseInputQueue.push(mouseInput);
            }
 
            break;
        }
#endif  // USE_SDL2
 
#ifdef ANDROID
#ifndef USE_SDL2
        case SDL_ACCELEROMETER:
            break;
#endif  // USE_SDL2
#endif  // ANDROID
 
        case SDL_MOUSEBUTTONDOWN:
        {
            mMouseDown = true;
            const int scale = mainGraphics->getScale();
            const int x = event.button.x / scale;
            const int y = event.button.y / scale;
            mouseInput.setX(x);
            mouseInput.setY(y);
#ifdef ANDROID
#ifdef USE_SDL2
            mouseInput.setReal(x, y);
#else  // USE_SDL2
 
            mouseInput.setReal(event.button.realx / scale,
                event.button.realy / scale);
#endif  // USE_SDL2
#endif  // ANDROID
 
            mouseInput.setButton(convertMouseButton(event.button.button));
 
#ifndef USE_SDL2
            if (event.button.button == SDL_BUTTON_WHEELDOWN)
                mouseInput.setType(MouseEventType::WHEEL_MOVED_DOWN);
            else if (event.button.button == SDL_BUTTON_WHEELUP)
                mouseInput.setType(MouseEventType::WHEEL_MOVED_UP);
            else
#endif  // USE_SDL2
                mouseInput.setType(MouseEventType::PRESSED);
            mouseInput.setTimeStamp(SDL_GetTicks());
            mMouseInputQueue.push(mouseInput);
            break;
        }
        case SDL_MOUSEBUTTONUP:
        {
            mMouseDown = false;
            const int scale = mainGraphics->getScale();
            const int x = event.button.x / scale;
            const int y = event.button.y / scale;
            mouseInput.setX(x);
            mouseInput.setY(y);
#ifdef ANDROID
#ifdef USE_SDL2
            mouseInput.setReal(x, y);
#else  // USE_SDL2
 
            mouseInput.setReal(event.button.realx / scale,
                event.button.realy / scale);
#endif  // USE_SDL2
#endif  // ANDROID
 
            mouseInput.setButton(convertMouseButton(event.button.button));
            mouseInput.setType(MouseEventType::RELEASED);
            mouseInput.setTimeStamp(SDL_GetTicks());
            mMouseInputQueue.push(mouseInput);
            break;
        }
        case SDL_MOUSEMOTION:
        {
            const int scale = mainGraphics->getScale();
            const int x = event.motion.x / scale;
            const int y = event.motion.y / scale;
            mouseInput.setX(x);
            mouseInput.setY(y);
#ifdef ANDROID
#ifdef USE_SDL2
            mouseInput.setReal(x, y);
#else  // USE_SDL2
 
            mouseInput.setReal(event.motion.realx / scale,
                event.motion.realy / scale);
#endif  // USE_SDL2
#endif  // ANDROID
 
            mouseInput.setButton(MouseButton::EMPTY);
            mouseInput.setType(MouseEventType::MOVED);
            mouseInput.setTimeStamp(SDL_GetTicks());
            mMouseInputQueue.push(mouseInput);
            mMouseMoveTime = cur_time;
            break;
        }
#ifndef USE_SDL2
        case SDL_ACTIVEEVENT:
            /*
             * This occurs when the mouse leaves the window and the Gui-chan
             * application loses its mousefocus.
             */
            if ((event.active.state & SDL_APPMOUSEFOCUS) != 0 &&
                event.active.gain == 0U)
            {
                mMouseInWindow = false;
 
                if (!mMouseDown)
                {
                    mouseInput.setX(-1);
                    mouseInput.setY(-1);
                    mouseInput.setButton(MouseButton::EMPTY);
                    mouseInput.setType(MouseEventType::MOVED);
                    mMouseInputQueue.push(mouseInput);
                    mMouseMoveTime = cur_time;
                }
            }
 
            if ((event.active.state & SDL_APPMOUSEFOCUS) != 0 &&
                event.active.gain != 0U)
            {
                mMouseInWindow = true;
            }
            break;
#endif  // USE_SDL2
 
        default:
            break;
    }  // end switch
    BLOCK_END("SDLInput::pushInput")
}

References BLOCK_END, BLOCK_START, convertKeyEventToKey(), convertMouseButton(), cur_time, MouseButton::EMPTY, KeyValue::ENTER, Gui::getLastMouseX(), Gui::getLastMouseY(), Graphics::getScale(), gui, InputAction::GUI_SELECT2, mainGraphics, mKeyInputQueue, mMouseDown, mMouseInputQueue, mMouseInWindow, mMouseMoveTime, MouseEventType::MOVED, KeyEventType::PRESSED, MouseEventType::PRESSED, KeyEventType::RELEASED, MouseEventType::RELEASED, MouseInput::setButton(), KeyInput::setKey(), MouseInput::setReal(), MouseInput::setTimeStamp(), KeyInput::setType(), MouseInput::setType(), MouseInput::setX(), MouseInput::setY(), simulateKey(), KeyValue::TEXTINPUT, MouseButton::WHEEL, MouseEventType::WHEEL_MOVED_DOWN, MouseEventType::WHEEL_MOVED_UP, x, and y.

Referenced by InputManager::handleEvent().

simulateKey()

void SDLInput::simulateKey	(	const int	guiKey,
		const InputActionT	actionId
	)

Definition at line 403 of file sdlinput.cpp.

{
    KeyInput keyInput;
    keyInput.setType(KeyEventType::PRESSED);
#ifdef USE_SDL2
    char str[2];
    str[0] = CAST_S8(guiKey);
    str[1] = 0;
 
    keyInput.setKey(Key(KeyValue::TEXTINPUT));
    keyInput.setText(str);
    if (guiKey >= 32)
        mKeyInputQueue.push(keyInput);
#endif  // USE_SDL2
 
    keyInput.setKey(Key(guiKey));
    if (actionId > InputAction::NO_VALUE)
        keyInput.setActionId(actionId);
    mKeyInputQueue.push(keyInput);
    keyInput.setType(KeyEventType::RELEASED);
    mKeyInputQueue.push(keyInput);
}

References CAST_S8, mKeyInputQueue, InputAction::NO_VALUE, KeyEventType::PRESSED, KeyEventType::RELEASED, KeyInput::setActionId(), KeyInput::setKey(), KeyInput::setType(), and KeyValue::TEXTINPUT.

Referenced by pushInput().

simulateMouseClick()

void SDLInput::simulateMouseClick	(	const int	x,
		const int	y,
		const MouseButtonT	button
	)

Definition at line 360 of file sdlinput.cpp.

{
    MouseInput mouseInput;
    mouseInput.setX(x);
    mouseInput.setY(y);
    mouseInput.setReal(x, y);
    mouseInput.setButton(MouseButton::EMPTY);
    mouseInput.setType(MouseEventType::MOVED);
    mouseInput.setTimeStamp(SDL_GetTicks());
    mMouseInputQueue.push(mouseInput);
    mouseInput.setButton(button);
    mouseInput.setType(MouseEventType::PRESSED);
    mouseInput.setTimeStamp(SDL_GetTicks());
    mMouseInputQueue.push(mouseInput);
    mouseInput.setType(MouseEventType::RELEASED);
    mouseInput.setTimeStamp(SDL_GetTicks());
    mMouseInputQueue.push(mouseInput);
}

References MouseButton::EMPTY, mMouseInputQueue, MouseEventType::MOVED, MouseEventType::PRESSED, MouseEventType::RELEASED, MouseInput::setButton(), MouseInput::setReal(), MouseInput::setTimeStamp(), MouseInput::setType(), MouseInput::setX(), MouseInput::setY(), x, and y.

simulateMouseMove()

void SDLInput::simulateMouseMove

(

)

Definition at line 380 of file sdlinput.cpp.

{
    if (gui == nullptr)
        return;
 
    if (mMouseMoveTime == cur_time)
        return;
 
    mMouseMoveTime = cur_time;
    int x;
    int y;
    Gui::getMouseState(x, y);
 
    MouseInput mouseInput;
    mouseInput.setX(x);
    mouseInput.setY(y);
    mouseInput.setReal(x, y);
    mouseInput.setButton(MouseButton::EMPTY);
    mouseInput.setType(MouseEventType::MOVED);
    mouseInput.setTimeStamp(SDL_GetTicks());
    mMouseInputQueue.push(mouseInput);
}

References cur_time, MouseButton::EMPTY, Gui::getMouseState(), gui, mMouseInputQueue, mMouseMoveTime, MouseEventType::MOVED, MouseInput::setButton(), MouseInput::setReal(), MouseInput::setTimeStamp(), MouseInput::setType(), MouseInput::setX(), MouseInput::setY(), x, and y.

Referenced by ActorManager::addChar(), and Gui::slowLogic().

Field Documentation

mKeyInputQueue

std::queue<KeyInput> SDLInput::mKeyInputQueue

protected

Definition at line 380 of file sdlinput.h.

Referenced by dequeueKeyInput(), isKeyQueueEmpty(), pushInput(), and simulateKey().

mMouseDown

bool SDLInput::mMouseDown

protected

Definition at line 384 of file sdlinput.h.

Referenced by pushInput().

mMouseInputQueue

std::queue<MouseInput> SDLInput::mMouseInputQueue

protected

Definition at line 381 of file sdlinput.h.

Referenced by dequeueMouseInput(), isMouseQueueEmpty(), pushInput(), simulateMouseClick(), and simulateMouseMove().

mMouseInWindow

bool SDLInput::mMouseInWindow

protected

Definition at line 385 of file sdlinput.h.

Referenced by pushInput().

mMouseMoveTime

time_t SDLInput::mMouseMoveTime

protected

Definition at line 382 of file sdlinput.h.

Referenced by pushInput(), and simulateMouseMove().

---

The documentation for this class was generated from the following files:

• src/gui/sdlinput.h (986a3bf)
• src/gui/sdlinput.cpp (986a3bf)