+// -*- C++ -*-
+/**
+ * \file KeySequence.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
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
+#ifndef KB_SEQUENCE_H
+#define KB_SEQUENCE_H
+
+#include "frontends/key_state.h"
+#include "frontends/LyXKeySym.h"
+
+#include <string>
+#include <vector>
+
+
+namespace lyx {
+
+class KeyMap;
+class FuncRequest;
+
+/// Holds a key sequence and the current and standard keymaps
+class KeySequence {
+public:
+ typedef std::vector<LyXKeySymPtr> Sequence;
+
+ friend class KeyMap;
+
+ ///
+ KeySequence(KeyMap * std, KeyMap * cur)
+ : stdmap(std), curmap(cur), deleted_(false) {}
+
+ /**
+ * Add a key to the key sequence and look it up in the curmap
+ * if the latter is defined.
+ * @param keysym the key to add
+ * @param mod modifier mask
+ * @param nmod which modifiers to mask out for equality test
+ * @return the action matching this key sequence or LFUN_UNKNOWN_ACTION
+ */
+ FuncRequest const &
+ addkey(LyXKeySymPtr keysym, key_modifier::state mod,
+ key_modifier::state nmod = key_modifier::none);
+
+ /**
+ * Add a sequence of keys from a string to the sequence
+ * @return string::npos if OK, else error position in string
+ *
+ * Keys in the string must be separated with whitespace;
+ * Use the keysym names used by XStringToKeysym, f.ex.
+ * "Space", "a", "Return", ...
+ * Prefixes are S-, C-, M- for shift, control, meta
+ * Prefixes can also be ignored by using the Tilde "~"
+ * f.ex.: "~S-Space".
+ */
+ size_t parse(std::string const & s);
+
+ /**
+ * Return the current sequence as a string.
+ * @param forgui true if the string should use translations and
+ * special characters.
+ * @see parse()
+ */
+ docstring const print(bool forgui) const;
+
+ /**
+ * Return the current sequence and available options as
+ * a string. No options are added if no curmap kb map exists.
+ * @param forgui true if the string should use translations and
+ * special characters.
+ */
+ docstring const printOptions(bool forgui) const;
+
+ /// Mark the sequence as deleted.
+ void mark_deleted();
+
+ /// Reset sequence to become "deleted"
+ void reset();
+
+ /// clear in full
+ void clear();
+
+ bool deleted() const { return deleted_; }
+
+ /// length of sequence
+ size_t length() const { return sequence.size(); }
+
+ /// Keymap to use if a new sequence is starting
+ KeyMap * stdmap;
+
+ /// Keymap to use for the next key
+ KeyMap * curmap;
+
+private:
+ /**
+ * Array holding the current key sequence as KeySyms.
+ * If sequence[length - 1] < 0xff it can be used as ISO8859 char
+ */
+ Sequence sequence;
+
+ typedef std::pair<key_modifier::state, key_modifier::state>
+ modifier_pair;
+
+ /// modifiers for keys in the sequence
+ std::vector<modifier_pair> modifiers;
+
+ /// is keysequence deleted ?
+ bool deleted_;
+};
+
+
+} // namespace lyx
+
+#endif