src/KeyMap.h

   1 // -*- C++ -*-
   2 /**
   3  * \file KeyMap.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef KEYMAP_H
  15 #define KEYMAP_H
  16
  17 #include "FuncRequest.h"
  18
  19 #include "frontends/KeyModifier.h"
  20 #include "frontends/KeySymbol.h"
  21
  22 #include "support/docstream.h"
  23
  24 #include <boost/shared_ptr.hpp>
  25
  26 #include <vector>
  27 #include <deque>
  28
  29
  30 namespace lyx {
  31
  32 class KeySequence;
  33
  34 /// Defines key maps and actions for key sequences
  35 class KeyMap {
  36 public:
  37         /**
  38          * Bind a key sequence to an action.
  39          * @return 0 on success, or position in string seq where error
  40          * occurs.
  41          * See KeySequence::parse for the syntax of the seq string
  42          */
  43         size_t bind(std::string const & seq, FuncRequest const & func);
  44
  45         // Parse a bind file
  46         bool read(std::string const & bind_file);
  47
  48         /**
  49          * print all available keysyms
  50          * @param forgui true if the string should use translations and
  51          *   special characters.
  52          */
  53         docstring const print(bool forgui) const;
  54
  55         /**
  56          * Look up a key press in the keymap.
  57          * @param key the keysym
  58          * @param mod the modifiers
  59          * @param seq the current key sequence so far
  60          * @return the action / LFUN_COMMAND_PREFIX / LFUN_UNKNOWN_ACTION
  61          */
  62         FuncRequest const &
  63         lookup(KeySymbol const & key, KeyModifier mod, KeySequence * seq) const;
  64
  65         ///
  66         typedef std::deque<KeySequence> Bindings;
  67
  68         /// Given an action, find all keybindings.
  69         Bindings findbindings(FuncRequest const & func) const;
  70
  71         /// Given an action, print the keybindings.
  72         docstring const printbindings(FuncRequest const & func) const;
  73
  74         /**
  75          *  Given an action, find the first 1-key binding (if it exists).
  76          *  The KeySymbol pointer is 0 is no key is found.
  77          *  [only used by the Qt/Mac frontend]
  78          */
  79         std::pair<KeySymbol, KeyModifier>
  80         find1keybinding(FuncRequest const & func) const;
  81
  82
  83         /**
  84          * Returns a string of the given keysym, with modifiers.
  85          * @param key the key as a keysym
  86          * @param mod the modifiers
  87          */
  88         static std::string const printKeySym(KeySymbol const & key,
  89                                              KeyModifier mod);
  90
  91         typedef std::pair<KeyModifier, KeyModifier> ModifierPair;
  92
  93 private:
  94         ///
  95         struct Key {
  96                 /// Keysym
  97                 KeySymbol code;
  98
  99                 /// Modifier masks
 100                 ModifierPair mod;
 101
 102                 /// Keymap for prefix keys
 103                 boost::shared_ptr<KeyMap> table;
 104
 105                 /// Action for !prefix keys
 106                 FuncRequest func;
 107         };
 108
 109         /**
 110          * Define an action for a key sequence.
 111          * @param r internal recursion level
 112          */
 113         void defkey(KeySequence * seq, FuncRequest const & func,
 114                     unsigned int r = 0);
 115
 116         /**
 117          * Given an action, find all keybindings
 118          * @param func the action
 119          * @param prefix a sequence to prepend the results
 120          */
 121         Bindings findbindings(FuncRequest const & func,
 122                               KeySequence const & prefix) const;
 123
 124         /// is the table empty ?
 125         bool empty() const { return table.empty(); }
 126         ///
 127         typedef std::vector<Key> Table;
 128         ///
 129         Table table;
 130 };
 131
 132 /// Implementation is in LyX.cpp
 133 extern KeyMap & theTopLevelKeymap();
 134
 135
 136 } // namespace lyx
 137
 138 #endif // KEYMAP_H