KeyboardConfig Class Reference

#include <keyboardconfig.h>

Public Member Functions
	KeyboardConfig ()
void	init ()
void	deinit ()
bool	isEnabled () const
void	setEnabled (const bool flag)
void	refreshActiveKeys ()
KeysVector *	getActionVector (const SDL_Event &event)
KeysVector *	getActionVectorByKey (const int i)
bool	isActionActive (const InputActionT index) const
void	update ()
void	handleActivateKey (const SDL_Event &event)
void	handleActivateKey (const int key)
void	handleDeActicateKey (const SDL_Event &event)
void	handleDeActicateKey (const int key)
InputActionT	getActionId (const SDL_Event &event)
void	handleRepeat (const int time)
void	resetRepeat (const int key)

Static Public Member Functions
static InputActionT	getKeyIndex (const SDL_Event &event, const int grp)
static std::string	getKeyShortString (const std::string &key)
static SDLKey	getKeyFromEvent (const SDL_Event &event)
static int	getKeyValueFromEvent (const SDL_Event &event)
static std::string	getKeyName (const int key)

Private Attributes
bool	mEnabled
const uint8_t *	mActiveKeys
uint8_t *	mActiveKeys2
unsigned int	mRepeatTime
KeyToActionMap	mKeyToAction
KeyToIdMap	mKeyToId
KeyTimeMap	mKeyTimeMap
bool	mBlockAltTab

Detailed Description

Definition at line 42 of file keyboardconfig.h.

Constructor & Destructor Documentation

KeyboardConfig()

KeyboardConfig::KeyboardConfig

(

)

Definition at line 42 of file keyboardconfig.cpp.

                               :
    mEnabled(true),
    mActiveKeys(nullptr),
    mActiveKeys2(nullptr),
    mRepeatTime(0),
    mKeyToAction(),
    mKeyToId(),
    mKeyTimeMap(),
    mBlockAltTab(true)
{
}

Member Function Documentation

deinit()

void KeyboardConfig::deinit

(

)

Definition at line 63 of file keyboardconfig.cpp.

{
    delete [] mActiveKeys2;
    mActiveKeys2 = nullptr;
}

References mActiveKeys2.

Referenced by Client::gameClear().

getActionId()

InputActionT KeyboardConfig::getActionId

(

const SDL_Event &

event

)

Definition at line 162 of file keyboardconfig.cpp.

{
    const int i = getKeyValueFromEvent(event);
//    logger->log("getActionId: %d", i);
    if (i != 0 && i < SDLK_LAST && mKeyToId.find(i) != mKeyToId.end())
        return mKeyToId[i];
    return InputAction::NO_VALUE;
}

References getKeyValueFromEvent(), mKeyToId, and InputAction::NO_VALUE.

Referenced by InputManager::getActionByKey().

getActionVector()

KeysVector * KeyboardConfig::getActionVector

(

const SDL_Event &

event

)

Definition at line 145 of file keyboardconfig.cpp.

{
    const int i = getKeyValueFromEvent(event);
//    logger->log("key triggerAction: %d", i);
    if (i != 0 && i < SDLK_LAST && mKeyToAction.find(i) != mKeyToAction.end())
        return &mKeyToAction[i];
    return nullptr;
}

References getKeyValueFromEvent(), and mKeyToAction.

Referenced by InputManager::handleEvent().

getActionVectorByKey()

KeysVector * KeyboardConfig::getActionVectorByKey

(

const int

i

)

Definition at line 154 of file keyboardconfig.cpp.

{
//    logger->log("key triggerAction: %d", i);
    if (i != 0 && i < SDLK_LAST && mKeyToAction.find(i) != mKeyToAction.end())
        return &mKeyToAction[i];
    return nullptr;
}

References mKeyToAction.

Referenced by handleRepeat().

getKeyFromEvent()

static SDLKey KeyboardConfig::getKeyFromEvent ( const SDL_Event &  event )

inlinestatic

Definition at line 82 of file keyboardconfig.h.

        {
#ifdef USE_SDL2
            return event.key.keysym.scancode;
#else  // USE_SDL2
 
            return event.key.keysym.sym;
#endif  // USE_SDL2
        }

getKeyIndex()

InputActionT KeyboardConfig::getKeyIndex ( const SDL_Event &  event, const int  grp  )

static

Get the key function index by providing the keys value.

Definition at line 69 of file keyboardconfig.cpp.

{
    const int keyValue = getKeyValueFromEvent(event);
    return inputManager.getKeyIndex(keyValue, grp, InputType::KEYBOARD);
}

References InputManager::getKeyIndex(), getKeyValueFromEvent(), inputManager, and InputType::KEYBOARD.

Referenced by Game::updateHistory().

getKeyName()

std::string KeyboardConfig::getKeyName ( const int  key )

static

Definition at line 80 of file keyboardconfig.cpp.

{
    if (key == -1)
        return "";
    if (key > -1)
    {
#ifdef USE_SDL2
        return SDL_GetScancodeName(
            static_cast<SDL_Scancode>(key));
#else  // USE_SDL2
 
        return SDL_GetKeyName(static_cast<SDLKey>(key));
#endif  // USE_SDL2
    }
 
    // TRANSLATORS: long key name, should be short
    return strprintf(_("key_%d"), CAST_S32(key));
}

References _, CAST_S32, and strprintf().

Referenced by InputManager::getKeyStringLong(), and InputManager::updateKeyString().

getKeyShortString()

std::string KeyboardConfig::getKeyShortString ( const std::string &  key )

static

Definition at line 99 of file keyboardconfig.cpp.

{
    if (key == "backspace")
        return "bksp";
    else if (key == "numlock")
        return "numlock";
    else if (key == "caps lock")
        return "caplock";
    else if (key == "scroll lock")
        return "scrlock";
    else if (key == "right shift")
        return "rshift";
    else if (key == "left shift")
        return "lshift";
    else if (key == "right ctrl")
        return "rctrl";
    else if (key == "left ctrl")
        return "lctrl";
    else if (key == "right alt")
        return "ralt";
    else if (key == "left alt")
        return "lalt";
    else if (key == "right meta")
        return "rmeta";
    else if (key == "left meta")
        return "lmeta";
    else if (key == "right super")
        return "rsuper";
    else if (key == "left super")
        return "lsuper";
    else if (key == "print screen")
        return "print screen";
    else if (key == "page up")
        return "pg up";
    else if (key == "page down")
        return "pg down";
 
    if (key == "unknown key")
    {
        // TRANSLATORS: Unknown key short string.
        // TRANSLATORS: This string must be maximum 5 chars
        return _("u key");
    }
    return key;
}

References _.

Referenced by EAthena::BeingRecv::processBeingSpawn(), EAthena::BeingRecv::processBeingVisible(), TmwAthena::BeingRecv::processBeingVisible(), LocalPlayer::setHome(), InputManager::updateKeyString(), and SocialNavigationTab::updateList().

getKeyValueFromEvent()

static int KeyboardConfig::getKeyValueFromEvent ( const SDL_Event &  event )

inlinestatic

Definition at line 93 of file keyboardconfig.h.

        {
#ifdef USE_SDL2
            return event.key.keysym.scancode;
#else  // USE_SDL2
 
            if (event.key.keysym.sym != 0U)
                return CAST_S32(event.key.keysym.sym);
            else if (event.key.keysym.scancode > 1)
                return -event.key.keysym.scancode;
            return 0;
#endif  // USE_SDL2
        }

References CAST_S32.

Referenced by getActionId(), getActionVector(), getKeyIndex(), handleActivateKey(), handleDeActicateKey(), and InputManager::setNewKey().

handleActivateKey() [1/2]

void KeyboardConfig::handleActivateKey

(

const int

key

)

Definition at line 214 of file keyboardconfig.cpp.

{
    if (mActiveKeys2 == nullptr)
        return;
    if (key < -1 && key > -500)
        mActiveKeys2[-key] = 1;
    resetRepeat(key);
}

References mActiveKeys2, and resetRepeat().

handleActivateKey() [2/2]

void KeyboardConfig::handleActivateKey

(

const SDL_Event &

event

)

Definition at line 204 of file keyboardconfig.cpp.

{
    if (mActiveKeys2 == nullptr)
        return;
    const int key = getKeyValueFromEvent(event);
    if (key < -1 && key > -500)
        mActiveKeys2[-key] = 1;
    resetRepeat(key);
}

References getKeyValueFromEvent(), mActiveKeys2, and resetRepeat().

Referenced by InputManager::handleEvent().

handleDeActicateKey() [1/2]

void KeyboardConfig::handleDeActicateKey

(

const int

key

)

Definition at line 233 of file keyboardconfig.cpp.

{
    if (mActiveKeys2 == nullptr)
        return;
    if (key < -1 && key > -500)
        mActiveKeys2[-key] = 0;
    resetRepeat(key);
}

References mActiveKeys2, and resetRepeat().

handleDeActicateKey() [2/2]

void KeyboardConfig::handleDeActicateKey

(

const SDL_Event &

event

)

Definition at line 223 of file keyboardconfig.cpp.

{
    if (mActiveKeys2 == nullptr)
        return;
    const int key = getKeyValueFromEvent(event);
    if (key < -1 && key > -500)
        mActiveKeys2[-key] = 0;
    resetRepeat(key);
}

References getKeyValueFromEvent(), mActiveKeys2, and resetRepeat().

Referenced by InputManager::handleEvent().

handleRepeat()

void KeyboardConfig::handleRepeat

(

const int

time

)

Definition at line 242 of file keyboardconfig.cpp.

{
    BLOCK_START("KeyboardConfig::handleRepeat")
    FOR_EACH (KeyTimeMapIter, it, mKeyTimeMap)
    {
        bool repeat(false);
        const int key = (*it).first;
        if (key >= 0)
        {
            if ((mActiveKeys != nullptr) && (mActiveKeys[key] != 0U))
                repeat = true;
        }
        else if (key < -1 && key > -500)
        {
            if ((mActiveKeys2 != nullptr) && (mActiveKeys2[-key] != 0U))
                repeat = true;
        }
        if (repeat)
        {
            int &keyTime = (*it).second;
            if (time > keyTime && abs(time - keyTime)
                > CAST_S32(mRepeatTime))
            {
                keyTime = time;
                inputManager.triggerAction(getActionVectorByKey(key));
            }
        }
    }
    BLOCK_END("KeyboardConfig::handleRepeat")
}

References BLOCK_END, BLOCK_START, CAST_S32, FOR_EACH, getActionVectorByKey(), inputManager, mActiveKeys, mActiveKeys2, mKeyTimeMap, mRepeatTime, and InputManager::triggerAction().

Referenced by InputManager::handleRepeat().

init()

void KeyboardConfig::init

(

)

Initializes the keyboard config explicitly.

Definition at line 54 of file keyboardconfig.cpp.

{
    mEnabled = true;
    delete [] mActiveKeys2;
    mActiveKeys2 = new uint8_t[500];
    mRepeatTime = config.getIntValue("repeateInterval2") / 10;
    mBlockAltTab = config.getBoolValue("blockAltTab");
}

References config, Configuration::getBoolValue(), Configuration::getIntValue(), mActiveKeys2, mBlockAltTab, mEnabled, and mRepeatTime.

Referenced by Client::gameInit().

isActionActive()

bool KeyboardConfig::isActionActive

(

const InputActionT

index

)

const

Definition at line 171 of file keyboardconfig.cpp.

{
    if ((mActiveKeys == nullptr) || (mActiveKeys2 == nullptr))
        return false;
 
    const InputFunction &key = inputManager.getKey(index);
    for (size_t i = 0; i < inputFunctionSize; i ++)
    {
        const InputItem &val = key.values[i];
        if (val.type != InputType::KEYBOARD)
            continue;
 
        const int value = val.value;
        if (value >= 0)
        {
            if (mActiveKeys[value] != 0U)
                return true;
        }
        else if (value < -1 && value > -500)
        {
            if (mActiveKeys2[-value] != 0U)
                return true;
        }
    }
    return false;
}

References InputManager::getKey(), inputFunctionSize, inputManager, InputType::KEYBOARD, mActiveKeys, mActiveKeys2, InputItem::type, InputItem::value, and InputFunction::values.

Referenced by InputManager::isActionActive0().

isEnabled()

bool KeyboardConfig::isEnabled ( ) const

inline

Get the enable flag, which will stop the user from doing actions.

Definition at line 59 of file keyboardconfig.h.

        { return mEnabled; }

References mEnabled.

Referenced by Game::handleInput(), and InputManager::updateConditionMask().

refreshActiveKeys()

void KeyboardConfig::refreshActiveKeys

(

)

Takes a snapshot of all the active keys.

Definition at line 75 of file keyboardconfig.cpp.

{
    mActiveKeys = SDL_GetKeyState(nullptr);
}

References mActiveKeys.

Referenced by InputManager::handleEvent().

resetRepeat()

void KeyboardConfig::resetRepeat

(

const int

key

)

Definition at line 273 of file keyboardconfig.cpp.

{
    const KeyTimeMapIter it = mKeyTimeMap.find(key);
    if (it != mKeyTimeMap.end())
        (*it).second = tick_time;
}

References mKeyTimeMap, and tick_time.

Referenced by handleActivateKey(), and handleDeActicateKey().

setEnabled()

void KeyboardConfig::setEnabled ( const bool  flag )

inline

Set the enable flag, which will stop the user from doing actions.

Definition at line 71 of file keyboardconfig.h.

        { mEnabled = flag; }

References mEnabled.

Referenced by Setup_Input::action(), Setup_Input::apply(), Setup_Input::cancel(), ItemAmountWindow::close(), TextDialog::close(), ItemAmountWindow::ItemAmountWindow(), TextCommandEditor::scheduleDelete(), TextCommandEditor::TextCommandEditor(), and TextDialog::TextDialog().

update()

void KeyboardConfig::update

(

)

Definition at line 198 of file keyboardconfig.cpp.

{
    inputManager.updateKeyActionMap(mKeyToAction, mKeyToId,
        mKeyTimeMap, InputType::KEYBOARD);
}

References inputManager, InputType::KEYBOARD, mKeyTimeMap, mKeyToAction, mKeyToId, and InputManager::updateKeyActionMap().

Referenced by Client::gameInit(), initEngines(), and InputManager::update().

Field Documentation

mActiveKeys

const uint8_t* KeyboardConfig::mActiveKeys

private

Stores a list of all the keys

Definition at line 140 of file keyboardconfig.h.

Referenced by handleRepeat(), isActionActive(), and refreshActiveKeys().

mActiveKeys2

uint8_t* KeyboardConfig::mActiveKeys2

private

Stores a list of all the keys

Definition at line 142 of file keyboardconfig.h.

Referenced by deinit(), handleActivateKey(), handleDeActicateKey(), handleRepeat(), init(), and isActionActive().

mBlockAltTab

bool KeyboardConfig::mBlockAltTab

private

Definition at line 152 of file keyboardconfig.h.

Referenced by init().

mEnabled

bool KeyboardConfig::mEnabled

private

Flag to respond to key input

Definition at line 138 of file keyboardconfig.h.

Referenced by init(), isEnabled(), and setEnabled().

mKeyTimeMap

KeyTimeMap KeyboardConfig::mKeyTimeMap

private

Definition at line 150 of file keyboardconfig.h.

Referenced by handleRepeat(), resetRepeat(), and update().

mKeyToAction

KeyToActionMap KeyboardConfig::mKeyToAction

private

Definition at line 146 of file keyboardconfig.h.

Referenced by getActionVector(), getActionVectorByKey(), and update().

mKeyToId

KeyToIdMap KeyboardConfig::mKeyToId

private

Definition at line 148 of file keyboardconfig.h.

Referenced by getActionId(), and update().

mRepeatTime

unsigned int KeyboardConfig::mRepeatTime

private

Definition at line 144 of file keyboardconfig.h.

Referenced by handleRepeat(), and init().

---

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

• src/input/keyboardconfig.h (986a3bf)
• src/input/keyboardconfig.cpp (986a3bf)