KeyTranslator Class Reference

#include <keytrans.h>

Collaboration diagram for KeyTranslator:

Public Member Functions
	KeyTranslator ()
	~KeyTranslator ()
int	SwitchTo (int)
int	switchMap (TKeyDef &tk)
const char *	TranslateKey (WORD wVirtualKeyCode, DWORD dwControlKeyState)
int	AddKeyDef (WORD wVirtualKeyCode, DWORD dwControlKeyState, char *lpzKeyDef)
int	AddKeyDef (WORD wVirtualKeyCode, DWORD dwControlKeyState, tn_ops op)
int	DeleteKeyDef (WORD wVirtualKeyCode, DWORD dwControlKeyState)
void	set_ext_mode (DWORD mode)
void	unset_ext_mode (DWORD mode)
void	clear_ext_mode ()
DWORD	get_ext_mode ()

Private Member Functions
DWORD	Fix_ControlKeyState (char *)
char *	Fix_Tok (char *)
void	DeleteAllDefs (void)
int	AddGlobalDef (WORD wVirtualKeyCode, char *lpzKeyDef)
int	LookOnGlobal (char *vkey)
DWORD	GetGlobalCode (int i)

Private Attributes
DWORD	ext_mode
TArrayAsVector< KeyMap >	mapArray
TArrayAsVector< TKeyDef >	globals
int	currentKeyMap
int	mainKeyMap

Friends
class	TMapLoader

Detailed Description

Definition at line 51 of file keytrans.h.

Constructor & Destructor Documentation

KeyTranslator()

KeyTranslator::KeyTranslator

(

)

Definition at line 58 of file keytrans.cpp.

                            :
mapArray(0,0,sizeof(KeyMap)),
globals(0,0,sizeof(TKeyDef)) {
    ext_mode = 0;           // Paul Brannan 8/28/98
    currentKeyMap = mainKeyMap = -1;
};

~KeyTranslator()

KeyTranslator::~KeyTranslator ( )

inline

Definition at line 55 of file keytrans.h.

{ DeleteAllDefs(); }

Member Function Documentation

AddGlobalDef()

int KeyTranslator::AddGlobalDef ( WORD  wVirtualKeyCode, char *  lpzKeyDef  )

private

Definition at line 160 of file keytrans.cpp.

                                                                    {
    if ( ! globals.IsEmpty() ) {
        int max = globals.GetItemsInContainer();
        for ( int i = 0; i < max ; i++ ) {
            const char *s = globals[i].GetszKey();
            if ( stricmp(s, lpzKeyDef) == 0 ) {
                globals[i] = DWORD(wVirtualKeyCode);
                return 1;
            }
        }
    }
    return globals.Add( TKeyDef(lpzKeyDef, 0, wVirtualKeyCode));
}

Referenced by TMapLoader::LoadGlobal().

AddKeyDef() [1/2]

int KeyTranslator::AddKeyDef	(	WORD	wVirtualKeyCode,
		DWORD	dwControlKeyState,
		char *	lpzKeyDef
	)

Definition at line 119 of file keytrans.cpp.

{
    if ( ! mapArray[currentKeyMap].map.IsEmpty() ) {
        int i = mapArray[currentKeyMap].map.Find(TKeyDef(NULL, dwControlKeyState, wVirtualKeyCode));
        if ( i != INT_MAX) {
            mapArray[currentKeyMap].map[i] = lpzKeyDef;
            return 1;
        }
    };
    return mapArray[currentKeyMap].map.Add( TKeyDef(lpzKeyDef, dwControlKeyState, wVirtualKeyCode));
}

Referenced by TMapLoader::LoadKeyMap().

AddKeyDef() [2/2]

int KeyTranslator::AddKeyDef	(	WORD	wVirtualKeyCode,
		DWORD	dwControlKeyState,
		tn_ops	op
	)

Definition at line 133 of file keytrans.cpp.

{
    optype op;
    op.sendstr = 0;
    op.the_op = the_op;
    if ( ! mapArray[currentKeyMap].map.IsEmpty() ) {
        int i = mapArray[currentKeyMap].map.Find(TKeyDef(NULL, dwControlKeyState, wVirtualKeyCode));
        if ( i != INT_MAX) {
            mapArray[currentKeyMap].map[i] = op;
            return 1;
        }
    };
    return mapArray[currentKeyMap].map.Add( TKeyDef(op, dwControlKeyState, wVirtualKeyCode));
}

clear_ext_mode()

void KeyTranslator::clear_ext_mode ( )

inline

Definition at line 76 of file keytrans.h.

{ext_mode = 0;}

Referenced by TANSIParser::Init().

DeleteAllDefs()

void KeyTranslator::DeleteAllDefs ( void  )

private

Definition at line 193 of file keytrans.cpp.

{
    // This code wants to crash under the STL; Apparently the Destroy()
    // function actually deletes the entry, rather than simply releasing
    // memory.  I think flush() should do the same thing, at least the
    // way it is written with STL_BIDS (Paul Brannan 5/25/98).
    int max;
 
    max = mapArray.GetItemsInContainer();
    if ( ! mapArray.IsEmpty() ) {
        for ( int i = 0; i < max; i++ ) {
            if ( !mapArray[i].map.IsEmpty() ) {
                mapArray[i].map.Flush();
            };
        };
    };
    globals.Flush();
    mapArray.Flush();
    currentKeyMap = -1;
    mainKeyMap    = -1;
};

Referenced by TMapLoader::Load(), and ~KeyTranslator().

DeleteKeyDef()

int KeyTranslator::DeleteKeyDef	(	WORD	wVirtualKeyCode,
		DWORD	dwControlKeyState
	)

Definition at line 177 of file keytrans.cpp.

{
    if ( mapArray.IsEmpty() || mapArray[currentKeyMap].map.IsEmpty() )
        return 0;
 
    int i = mapArray[currentKeyMap].map.Find(TKeyDef(NULL, dwControlKeyState, wVirtualKeyCode));
 
    if ( i != INT_MAX) {
        mapArray[currentKeyMap].map.Destroy(i);
        return 1;
    };
    return 0;
};

Fix_ControlKeyState()

DWORD KeyTranslator::Fix_ControlKeyState ( char *  )

private

Fix_Tok()

char * KeyTranslator::Fix_Tok ( char *  )

private

get_ext_mode()

DWORD KeyTranslator::get_ext_mode ( )

inline

Definition at line 77 of file keytrans.h.

{return ext_mode;}

Referenced by FindClosestKey().

GetGlobalCode()

DWORD KeyTranslator::GetGlobalCode ( int  i )

inlineprivate

Definition at line 90 of file keytrans.h.

{return globals[i].GetCodeKey();}

Referenced by TMapLoader::LoadKeyMap(), and TMapLoader::ParseKeyDef().

LookOnGlobal()

int KeyTranslator::LookOnGlobal ( char *  vkey )

private

Definition at line 150 of file keytrans.cpp.

                                          {
    if ( ! globals.IsEmpty() ) {
        int max = globals.GetItemsInContainer();
        for ( int i = 0; i < max ; i++ )
            if ( stricmp(globals[i].GetszKey(), vkey) == 0 )
                return i;
    };
    return INT_MAX;
};

Referenced by TMapLoader::LoadKeyMap(), and TMapLoader::ParseKeyDef().

set_ext_mode()

void KeyTranslator::set_ext_mode ( DWORD  mode )

inline

Definition at line 74 of file keytrans.h.

{ext_mode |= mode;}

Referenced by TANSIParser::ParseEscape(), and TANSIParser::ParseEscapeANSI().

switchMap()

int KeyTranslator::switchMap

(

TKeyDef &

tk

)

Definition at line 67 of file keytrans.cpp.

                                        {
    if ( mapArray.IsEmpty() ) {
        return currentKeyMap = -1;
    };
    int i = mapArray.Find(KeyMap(tk));
    if ( i != INT_MAX ) {
        if (currentKeyMap == i)
            currentKeyMap = mainKeyMap; // restore to default
        else currentKeyMap = i;
        return 1;
    };
    return 0;
};

Referenced by TMapLoader::Load(), and TranslateKey().

SwitchTo()

int KeyTranslator::SwitchTo

(

int

to

)

Definition at line 82 of file keytrans.cpp.

                                  {
 
    int max = mapArray.GetItemsInContainer();
    if (max == 0) return -1;
    if (to < 0 || to > (max-1)) return 0;
 
    currentKeyMap = to;
    return 1;
};

Referenced by Telnet::SwitchKeyMap().

TranslateKey()

const char * KeyTranslator::TranslateKey	(	WORD	wVirtualKeyCode,
		DWORD	dwControlKeyState
	)

Definition at line 94 of file keytrans.cpp.

{
    if ( mapArray.IsEmpty() ) return NULL;
 
    TKeyDef ask(NULL, dwControlKeyState, wVirtualKeyCode);
 
    // if a keymap switch pressed
    if ( switchMap(ask) > 0 ) return "";
 
    int i = mapArray[currentKeyMap].map.Find(ask);
 
    if ( i != INT_MAX) return mapArray[currentKeyMap].map[i].GetszKey();
 
    // if not found in current keymap
    if ( currentKeyMap != mainKeyMap ) {
        i = mapArray[mainKeyMap].map.Find(ask);
        if ( i != INT_MAX)  return mapArray[mainKeyMap].map[i].GetszKey();
    };
    return NULL;
};

Referenced by ClosestStateKey().

unset_ext_mode()

void KeyTranslator::unset_ext_mode ( DWORD  mode )

inline

Definition at line 75 of file keytrans.h.

{ext_mode &= ~mode;}

Referenced by TANSIParser::ParseEscape(), and TANSIParser::ParseEscapeANSI().

Friends And Related Function Documentation

TMapLoader

friend class TMapLoader

friend

Definition at line 52 of file keytrans.h.

Member Data Documentation

currentKeyMap

int KeyTranslator::currentKeyMap

private

Definition at line 92 of file keytrans.h.

Referenced by AddKeyDef(), DeleteAllDefs(), DeleteKeyDef(), TMapLoader::Display(), KeyTranslator(), TMapLoader::Load(), switchMap(), SwitchTo(), and TranslateKey().

ext_mode

DWORD KeyTranslator::ext_mode

private

Definition at line 82 of file keytrans.h.

Referenced by clear_ext_mode(), get_ext_mode(), KeyTranslator(), set_ext_mode(), and unset_ext_mode().

globals

TArrayAsVector<TKeyDef> KeyTranslator::globals

private

Definition at line 85 of file keytrans.h.

Referenced by AddGlobalDef(), DeleteAllDefs(), GetGlobalCode(), and LookOnGlobal().

mainKeyMap

int KeyTranslator::mainKeyMap

private

Definition at line 92 of file keytrans.h.

Referenced by DeleteAllDefs(), KeyTranslator(), TMapLoader::Load(), switchMap(), and TranslateKey().

mapArray

TArrayAsVector<KeyMap> KeyTranslator::mapArray

private

Definition at line 84 of file keytrans.h.

Referenced by AddKeyDef(), DeleteAllDefs(), DeleteKeyDef(), TMapLoader::Display(), TMapLoader::Load(), switchMap(), SwitchTo(), and TranslateKey().

---

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

• base/applications/network/telnet/src/keytrans.h
• base/applications/network/telnet/src/keytrans.cpp