X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fkbmap.h;h=9c1ddecd2259d3858e4dcb7cef6050e96a7b6b8b;hb=98c966c64594611e469313314abd1e59524adb4a;hp=d1aa78212a18293fd39dbd99175243415f8c025f;hpb=27de1486ca34aaad446adb798d71a77d6f6304da;p=lyx.git diff --git a/src/kbmap.h b/src/kbmap.h index d1aa78212a..9c1ddecd22 100644 --- a/src/kbmap.h +++ b/src/kbmap.h @@ -1,163 +1,98 @@ // -*- C++ -*- -/* ======================================================================= *\ - File : kbmap.h, kbmap.h,v 1.3 1996/12/10 04:35:57 larsbj Exp - Author : chb, 30.Oct.1995 - Docu : see kbmap.C - Purpose: class definitions for XKeyEvent keymap handling - \* ======================================================================= */ +/** + * \file kbmap.h + * Copyright 1995-2002 the LyX Team + * Read the file COPYING + * + * \author Lars Gullik Bjønnes + * \author John Levon + */ -#ifndef _KBMAP_H_ -#define _KBMAP_H_ +#ifndef KBMAP_H +#define KBMAP_H #ifdef __GNUG__ #pragma interface #endif -#include +#include +#include -#define KB_PREALLOC 16 -#define KB_HASHSIZE 128 // yes, yes - I know. 128 is not exactly prime :-) -// ... but we are dealing with ASCII chars mostly. +#include "LString.h" -class kb_keymap; class kb_sequence; -class LString; - -/// -struct kb_key { - /// Keysym - unsigned int code; - - /// Modifier masks - unsigned int mod; - - /// Keymap for prefix keys - kb_keymap *table; - - /// Action for !prefix keys - int action; -}; - /// Defines key maps and actions for key sequences class kb_keymap { public: - /// - kb_keymap() { - size = 0; - table = 0; - } - /// - ~kb_keymap(); - - /// Bind a key-sequence to an action - /** Returns 0 on success. Otherwise, position in string where - error occured. */ - int bind(char const* seq, int action); - - /// - int print(char* buf, int maxlen) const; - - /// Look up a key in the keymap - int lookup(KeySym key, unsigned mod, kb_sequence *seq); + /** + * Bind a key sequence to an action. + * @return 0 on success, or position in string seq where error + * occurs. + */ + string::size_type bind(string const & seq, int action); + + /// print all available keysyms + string const print() const; + + /** + * Look up a key press in the keymap. + * @param key the keysym + * @param mod the modifiers + * @param seq the current key sequence so far + * @return the action / LFUN_PREFIX / LFUN_UNKNOWN_ACTION + */ + int lookup(unsigned int key, + unsigned int mod, kb_sequence * seq) const; /// Given an action, find all keybindings. - LString findbinding(int action) const; + string const findbinding(int action, + string const & prefix = string()) const; + + /** + * Returns a string of the given keysym, with modifiers. + * @param key the key + * @param mod the modifiers + */ + static string const printKeysym(unsigned int key, unsigned int mod); + + /// return the ISO value of a keysym + static char getiso(unsigned int i); + private: - /// Define a new key sequence - int defkey(kb_sequence *seq, int action, int idx = 0); - - /// Size of the table (<0: hashtab) - int size; - - /// Holds the defined keys - /** Both kinds of tables ends with NoSymbol */ - union - { - /// Table for linear array - kb_key *table; - - /// Hash table holding key lists - kb_key **htable; + /// + struct kb_key { + /// Keysym + unsigned int code; + + /// Modifier masks + unsigned int mod; + + /// Keymap for prefix keys + boost::shared_ptr table; + + /// Action for !prefix keys + int action; }; -}; -/// Holds a key sequence and the current and standard keymaps -class kb_sequence { -public: - /// - kb_sequence() { - stdmap = curmap = 0; - sequence = staticseq; - modifiers = staticmod; - length = 0; - size = KB_PREALLOC; - } - - /// - - - /// - ~kb_sequence() - { - if (sequence != staticseq) { - delete sequence; - delete modifiers; - } + /** + * Define an action for a key sequence. + * @param r internal recursion level + */ + void defkey(kb_sequence * seq, int action, unsigned int r = 0); + + /// Returns a string of the given key + string const printKey(kb_key const & key) const; + + /// is the table empty ? + bool empty() const { + return table.empty(); } - - /// Add a key to the key sequence and look it up in the curmap - /** Add a key to the key sequence and look it up in the curmap - if the latter is defined. */ - int addkey(KeySym key, unsigned mod, unsigned nmod = 0); - /// - int print(char *buf, int maxlen, bool when_defined = false) const; //RVDK_PATCH_5 - - /// - int printOptions(char *buf, int maxlen) const; - - /// Make length negative to mark the sequence as deleted - void delseq(); - + typedef std::list Table; /// - char getiso(); - - /// - KeySym getsym(); - - /// - void reset(); - - /// - int parse(char const *s); - - /// Keymap to use if a new sequence is starting - kb_keymap *stdmap; - - /// Keymap to use for the next key - kb_keymap *curmap; - - /// Array holding the current key sequence - /** If sequence[length-1] < 0xff it can be used as ISO8859 char */ - unsigned int *sequence; - - /// - unsigned int *modifiers; - - /// Current length of key sequence - int length; - -private: - /// Static array preallocated for sequence - unsigned int staticseq[KB_PREALLOC]; - - /// - unsigned int staticmod[KB_PREALLOC]; - - /// Physically allocated storage size - int size; + Table table; }; -#endif +#endif // KBMAP_H