X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fkbmap.h;h=b8eabff92d5db56af79b0c4c992b48f942e3711e;hb=de3c8e5b80effa940c92980032389c868f377d6b;hp=e49d03067d02f949e15e146b5a41a940862c75a2;hpb=db54977b71c7e052b53dc97b5f539aaa86e24342;p=lyx.git diff --git a/src/kbmap.h b/src/kbmap.h index e49d03067d..b8eabff92d 100644 --- a/src/kbmap.h +++ b/src/kbmap.h @@ -1,155 +1,108 @@ // -*- 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 + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. + * + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * \author John Levon + * + * Full author contact details are available in file CREDITS. + */ #ifndef KBMAP_H #define KBMAP_H -#ifdef __GNUG__ -#pragma interface -#endif +#include "funcrequest.h" -#include +#include "frontends/key_state.h" -#include "LString.h" +#include -#define KB_PREALLOC 16 +#include -class kb_keymap; class kb_sequence; - -/// -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; -}; - +class LyXKeySym; /// 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); + /** + * Bind a key sequence to an action. + * @return 0 on success, or position in string seq where error + * occurs. + * See kb_sequence::parse for the syntax of the seq string + */ + std::string::size_type bind(std::string const & seq, FuncRequest const & func); + + // Parse a bind file + bool read(std::string const & bind_file); + + /// print all available keysyms + std::string const print() const; /// - void print(string & buf) const; - - /// Look up a key in the keymap - int lookup(KeySym key, unsigned mod, kb_sequence * seq); + typedef boost::shared_ptr LyXKeySymPtr; + /** + * 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 + */ + FuncRequest const & + lookup(LyXKeySymPtr key, + key_modifier::state mod, kb_sequence * seq) const; /// Given an action, find all keybindings. - string findbinding(int action) const; -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 - /// Table for linear array, table ends with NoSymbol. - kb_key * table; -}; + std::string const findbinding(FuncRequest const & func, + std::string const & prefix = std::string()) const; + /** + * Returns a string of the given keysym, with modifiers. + * @param key the key as a keysym + * @param mod the modifiers + */ + static std::string const printKeySym(LyXKeySym const & key, + key_modifier::state mod); -/// 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; - } - } - - /// 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); + typedef std::pair modifier_pair; +private: /// - int print(string & buf, bool when_defined = false) const; - - /// - int printOptions(string & buf) const; - - /// Make length negative to mark the sequence as deleted - void delseq(); - - /// - 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; - + struct kb_key { + /// Keysym + LyXKeySymPtr code; + + /// Modifier masks + modifier_pair mod; + + /// Keymap for prefix keys + boost::shared_ptr table; + + /// Action for !prefix keys + FuncRequest func; + }; + + /** + * Define an action for a key sequence. + * @param r internal recursion level + */ + void defkey(kb_sequence * seq, FuncRequest const & func, + unsigned int r = 0); + + /// Returns a string of the given key + std::string const printKey(kb_key const & key) const; + + /// is the table empty ? + bool empty() const { + return table.empty(); + } /// - unsigned int * modifiers; - - /// Current length of key sequence - int length; - -private: - /// Static array preallocated for sequence - unsigned int staticseq[KB_PREALLOC]; - + typedef std::vector Table; /// - unsigned int staticmod[KB_PREALLOC]; - - /// Physically allocated storage size - int size; + Table table; }; -#endif +#endif // KBMAP_H