C4KeyboardInput Class Reference

#include <C4KeyboardInput.h>

Public Member Functions
	C4KeyboardInput ()
	~C4KeyboardInput ()
void	Clear ()
void	RegisterKey (C4CustomKey *pRegKey)
void	UnregisterKey (const StdStrBuf &rsName)
void	UnregisterKeyBinding (C4CustomKey *pKey)
bool	DoInput (const C4KeyCodeEx &InKey, C4KeyEventType InEvent, DWORD InScope, int32_t iStrength)
void	CompileFunc (StdCompiler *pComp)
bool	LoadCustomConfig ()
C4CustomKey *	GetKeyByName (const char *szKeyName)
StdStrBuf	GetKeyCodeNameByKeyName (const char *szKeyName, bool fShort=false, int32_t iIndex=0)
const C4KeyEventData &	GetLastKeyExtraData () const
void	SetLastKeyExtraData (const C4KeyEventData &data)

Static Public Attributes
static bool	IsValid = false

Detailed Description

Definition at line 488 of file C4KeyboardInput.h.

Constructor & Destructor Documentation

C4KeyboardInput()

C4KeyboardInput::C4KeyboardInput ( )

inline

Definition at line 507 of file C4KeyboardInput.h.

{ IsValid = true; }

References IsValid.

~C4KeyboardInput()

C4KeyboardInput::~C4KeyboardInput ( )

inline

Definition at line 508 of file C4KeyboardInput.h.

{ Clear(); IsValid = false; }

References Clear(), and IsValid.

Here is the call graph for this function:

Member Function Documentation

Clear()

void C4KeyboardInput::Clear

(

)

Definition at line 759 of file C4KeyboardInput.cpp.

{
    LastKeyExtraData = C4KeyEventData();
    // release all keys - name map is guarantueed to contain them all
    for (KeyNameMap::const_iterator i = KeysByName.begin(); i != KeysByName.end(); ++i)
        i->second->Deref();
    // clear maps
    KeysByCode.clear();
    KeysByName.clear();
}

Referenced by C4Game::Clear(), C4Game::InitKeyboard(), and ~C4KeyboardInput().

Here is the caller graph for this function:

CompileFunc()

void C4KeyboardInput::CompileFunc

(

StdCompiler *

pComp

)

Definition at line 936 of file C4KeyboardInput.cpp.

{
    // compile all keys that are already defined
    // no definition of new keys with current compiler...
    pComp->Name("Keys");
    try
    {
        for (KeyNameMap::const_iterator i = KeysByName.begin(); i != KeysByName.end(); ++i)
        {
            // naming done in C4CustomKey, because default is determined by key only
            C4CustomKey::CodeList OldCodes = i->second->GetCodes();
            pComp->Value(*i->second);
            // resort in secondary map if key changed
            if (pComp->isDeserializer())
            {
                const C4CustomKey::CodeList &rNewCodes = i->second->GetCodes();
                if (!(OldCodes == rNewCodes)) UpdateKeyCodes(i->second, OldCodes, rNewCodes);
            }
        }
    }
    catch (StdCompiler::Exception *pEx)
    {
        pComp->NameEnd(true);
        throw pEx;
    }
    pComp->NameEnd();
}

References StdCompiler::isDeserializer(), StdCompiler::Name(), StdCompiler::NameEnd(), and StdCompiler::Value().

Here is the call graph for this function:

DoInput()

bool C4KeyboardInput::DoInput	(	const C4KeyCodeEx &	InKey,
		C4KeyEventType	InEvent,
		DWORD	InScope,
		int32_t	iStrength
	)

Definition at line 870 of file C4KeyboardInput.cpp.

{
    // store last-key-info
    LastKeyExtraData.iStrength = (iStrength >= 0) ? iStrength : ((InEvent != KEYEV_Up) * 100);
    LastKeyExtraData.game_x = LastKeyExtraData.game_y = LastKeyExtraData.vp_x = LastKeyExtraData.vp_y = C4KeyEventData::KeyPos_None;
    // check all key events generated by this key: First the keycode itself, then any more generic key events like KEY_Any
    const int32_t iKeyRangeMax = 5;
    int32_t iKeyRangeCnt=0, j;
    C4KeyCode FallbackKeys[iKeyRangeMax];
    FallbackKeys[iKeyRangeCnt++] = InKey.Key;
    if (Key_IsGamepadButton(InKey.Key))
    {
        // "any gamepad button"-event
        FallbackKeys[iKeyRangeCnt++] = KEY_Gamepad(KEY_CONTROLLER_AnyButton);
    }
    else if (Key_IsGamepadAxis(InKey.Key))
    {
        // TODO: do we need "any axis" events?
    }
    if (InKey.Key != KEY_Any) FallbackKeys[iKeyRangeCnt++] = KEY_Any;
    // now get key ranges for fallback chain
    std::pair<KeyCodeMap::iterator, KeyCodeMap::iterator> KeyRanges[iKeyRangeMax];
    assert(iKeyRangeCnt <= iKeyRangeMax);
    for (int32_t i = 0; i<iKeyRangeCnt; ++i)
    {
        KeyRanges[i] = KeysByCode.equal_range(FallbackKeys[i]);
    }
    // check all assigned keys
    // exec from highest to lowest priority
    unsigned int uiLastPrio = C4CustomKey::PRIO_MoreThanMax;
    for (;;)
    {
        KeyCodeMap::const_iterator i;
        // get priority to exec
        unsigned int uiExecPrio = C4CustomKey::PRIO_None, uiCurr;
        for (j = 0; j < iKeyRangeCnt; ++j)
            for (i = KeyRanges[j].first; i != KeyRanges[j].second; ++i)
            {
                uiCurr = i->second->GetPriority();
                if (uiCurr > uiExecPrio && uiCurr < uiLastPrio) uiExecPrio = uiCurr;
            }
        // nothing with correct priority set left?
        if (uiExecPrio == C4CustomKey::PRIO_None) break;
        // exec all of this priority
        for (j = 0; j < iKeyRangeCnt; ++j)
            for (i = KeyRanges[j].first; i != KeyRanges[j].second; ++i)
            {
                C4CustomKey *pKey = i->second;
                assert(pKey);
                // check priority
                if (pKey->GetPriority() == uiExecPrio)
                    // check scope and modifier
                    // (not on release of a key that has been down, because a key release might happen with a different modifier or in different scope than its pressing!)
                    if ((InEvent == KEYEV_Up && pKey->IsDown())
                        || ((pKey->GetScope() & InScope) && pKey->IsCodeMatched(C4KeyCodeEx(FallbackKeys[j], C4KeyShiftState(InKey.dwShift)))))
                        // exec it
                        if (pKey->Execute(InEvent, InKey))
                                return true;
            }
        // nothing found in this priority: exec next
        uiLastPrio = uiExecPrio;
    }
    // no key matched or all returned false in Execute: Not processed
    return false;
}

References C4KeyCodeEx::dwShift, C4CustomKey::Execute(), C4KeyEventData::game_x, C4KeyEventData::game_y, C4CustomKey::GetPriority(), C4CustomKey::GetScope(), C4CustomKey::IsCodeMatched(), C4CustomKey::IsDown(), C4KeyEventData::iStrength, C4KeyCodeEx::Key, KEY_Any, KEY_CONTROLLER_AnyButton, KEY_Gamepad(), Key_IsGamepadAxis(), Key_IsGamepadButton(), KEYEV_Up, C4KeyEventData::KeyPos_None, C4CustomKey::PRIO_MoreThanMax, C4CustomKey::PRIO_None, C4KeyEventData::vp_x, and C4KeyEventData::vp_y.

Referenced by C4Game::DoKeyboardInput().

Here is the call graph for this function:

Here is the caller graph for this function:

GetKeyByName()

C4CustomKey * C4KeyboardInput::GetKeyByName

(

const char *

szKeyName

)

Definition at line 978 of file C4KeyboardInput.cpp.

{
    KeyNameMap::const_iterator i = KeysByName.find(szKeyName);
    if (i == KeysByName.end()) return nullptr; else return (*i).second;
}

Referenced by GetKeyCodeNameByKeyName().

Here is the caller graph for this function:

GetKeyCodeNameByKeyName()

StdStrBuf C4KeyboardInput::GetKeyCodeNameByKeyName	(	const char *	szKeyName,
		bool	fShort = false,
		int32_t	iIndex = 0
	)

Definition at line 984 of file C4KeyboardInput.cpp.

{
    C4CustomKey *pKey = GetKeyByName(szKeyName);
    if (pKey)
    {
        const C4CustomKey::CodeList &codes = pKey->GetCodes();
        if ((size_t)iIndex < codes.size())
        {
            C4KeyCodeEx code = codes[iIndex];
            return code.ToString(true, fShort);
        }
    }
    // Error
    return StdStrBuf();
}

References C4CustomKey::GetCodes(), GetKeyByName(), and C4KeyCodeEx::ToString().

Referenced by GetKeyboardInputName(), and C4FullScreen::ViewportCheck().

Here is the call graph for this function:

Here is the caller graph for this function:

GetLastKeyExtraData()

const C4KeyEventData& C4KeyboardInput::GetLastKeyExtraData ( ) const

inline

Definition at line 528 of file C4KeyboardInput.h.

{ return LastKeyExtraData; }

LoadCustomConfig()

bool C4KeyboardInput::LoadCustomConfig

(

)

Definition at line 964 of file C4KeyboardInput.cpp.

{
    // load from INI file (2do: load from registry)
    C4Group GrpExtra;
    if (!GrpExtra.Open(C4CFN_Extra)) return false;
    StdBuf sFileContents;
    if (!GrpExtra.LoadEntry(C4CFN_KeyConfig, &sFileContents)) return false;
    StdStrBuf sFileContentsString((const char *) sFileContents.getData());
    if (!CompileFromBuf_LogWarn<StdCompilerINIRead>(*this, sFileContentsString, "Custom keys from" C4CFN_Extra DirSep C4CFN_KeyConfig))
        return false;
    LogF(LoadResStr("IDS_PRC_LOADEDKEYCONF"), C4CFN_Extra DirSep C4CFN_KeyConfig);
    return true;
}

References C4CFN_Extra, C4CFN_KeyConfig, DirSep, StdBuf::getData(), C4Group::LoadEntry(), LoadResStr(), LogF(), and C4Group::Open().

Referenced by C4Game::InitKeyboard().

Here is the call graph for this function:

Here is the caller graph for this function:

RegisterKey()

void C4KeyboardInput::RegisterKey

(

C4CustomKey *

pRegKey

)

Definition at line 797 of file C4KeyboardInput.cpp.

{
    assert(pRegKey); if (!pRegKey) return;
    // key will be added: ref it
    pRegKey->Ref();
    // search key of same name first
    C4CustomKey *pDupKey = KeysByName[pRegKey->GetName().getData()];
    if (pDupKey)
    {
        // key of this name exists: Merge them (old codes copied cuz they'll be overwritten)
        C4CustomKey::CodeList OldCodes = pDupKey->GetCodes();
        const C4CustomKey::CodeList &rNewCodes = pRegKey->GetCodes();
        pDupKey->Update(pRegKey);
        // update access map if key changed
        if (!(OldCodes == rNewCodes)) UpdateKeyCodes(pDupKey, OldCodes, rNewCodes);
        // key to be registered no longer used
        pRegKey->Deref();
    }
    else
    {
        // new unique key: Insert into map
        KeysByName[pRegKey->GetName().getData()] = pRegKey;
        for (C4CustomKey::CodeList::const_iterator i = pRegKey->GetCodes().begin(); i != pRegKey->GetCodes().end(); ++i)
        {
            KeysByCode.insert(std::make_pair((*i).Key, pRegKey));
        }
    }
}

References C4CustomKey::Deref(), C4CustomKey::GetCodes(), StdStrBuf::getData(), C4CustomKey::GetName(), C4CustomKey::Ref(), and C4CustomKey::Update().

Referenced by C4KeyBinding::C4KeyBinding(), C4Game::InitKeyboard(), and UnregisterKeyBinding().

Here is the call graph for this function:

Here is the caller graph for this function:

SetLastKeyExtraData()

void C4KeyboardInput::SetLastKeyExtraData ( const C4KeyEventData &  data )

inline

Definition at line 529 of file C4KeyboardInput.h.

{ LastKeyExtraData=data; }

Referenced by C4PlayerControl::DoMouseInput().

Here is the caller graph for this function:

UnregisterKey()

void C4KeyboardInput::UnregisterKey

(

const StdStrBuf &

rsName

)

Definition at line 826 of file C4KeyboardInput.cpp.

{
    // kill from name map
    KeyNameMap::iterator in = KeysByName.find(rsName.getData());
    if (in == KeysByName.end()) return;
    C4CustomKey *pKey = in->second;
    KeysByName.erase(in);
    // kill all key bindings from key map
    for (C4CustomKey::CodeList::const_iterator iCode = pKey->GetCodes().begin(); iCode != pKey->GetCodes().end(); ++iCode)
    {
        std::pair<KeyCodeMap::iterator, KeyCodeMap::iterator> KeyRange = KeysByCode.equal_range((*iCode).Key);
        for (KeyCodeMap::iterator i = KeyRange.first; i != KeyRange.second; ++i)
            if (i->second == pKey)
            {
                KeysByCode.erase(i);
                break;
            }
    }
    // release reference to key
    pKey->Deref();
}

References C4CustomKey::Deref(), C4CustomKey::GetCodes(), and StdStrBuf::getData().

Referenced by UnregisterKeyBinding().

Here is the call graph for this function:

Here is the caller graph for this function:

UnregisterKeyBinding()

void C4KeyboardInput::UnregisterKeyBinding

(

C4CustomKey *

pKey

)

Definition at line 848 of file C4KeyboardInput.cpp.

{
    // find key in name map
    KeyNameMap::iterator in = KeysByName.find(pUnregKey->GetName().getData());
    if (in == KeysByName.end()) return;
    C4CustomKey *pKey = in->second;
    // is this key in the map?
    if (pKey != pUnregKey)
    {
        // Other key is in the list: Just remove the callbacks
        pKey->KillCallbacks(pUnregKey);
        return;
    }
    // this key is in the list: Replace by a duplicate...
    C4CustomKey *pNewKey = new C4CustomKey(*pUnregKey, true);
    // ...without the own callbacks
    pNewKey->KillCallbacks(pUnregKey);
    // and replace current key by duplicate
    UnregisterKey(pUnregKey->GetName());
    RegisterKey(pNewKey);
}

References StdStrBuf::getData(), C4CustomKey::GetName(), C4CustomKey::KillCallbacks(), RegisterKey(), and UnregisterKey().

Referenced by C4KeyBinding::~C4KeyBinding().

Here is the call graph for this function:

Here is the caller graph for this function:

Member Data Documentation

IsValid

bool C4KeyboardInput::IsValid = false

static

Definition at line 505 of file C4KeyboardInput.h.

Referenced by C4KeyboardInput(), C4KeyBinding::~C4KeyBinding(), and ~C4KeyboardInput().

---

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

• C4KeyboardInput.h
• C4KeyboardInput.cpp