X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fkbmap.h;h=b8eabff92d5db56af79b0c4c992b48f942e3711e;hb=de3c8e5b80effa940c92980032389c868f377d6b;hp=a21a66255802639cbb88123a4f369f9a40779a0e;hpb=e266fd847f7c1ec14c9802c85f19f1193bfdbf7c;p=lyx.git

diff --git a/src/kbmap.h b/src/kbmap.h
index a21a662558..b8eabff92d 100644
--- a/src/kbmap.h
+++ b/src/kbmap.h
@@ -1,76 +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 <list>
-#include <boost/smart_ptr.hpp>
+#include "frontends/key_state.h"
 
-#include "LString.h"
+#include <boost/shared_ptr.hpp>
+
+#include <vector>
 
 class kb_sequence;
+class LyXKeySym;
 
 /// Defines key maps and actions for key sequences
 class kb_keymap {
 public:
-	/** Bind a key-sequence to an action.
-	    Returns 0 on success. Otherwise, position in string where
-	    error occured. */
-	string::size_type bind(string 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(unsigned int key,
-		   unsigned int mod, kb_sequence * seq) const;
+	typedef boost::shared_ptr<LyXKeySym> 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 const findbinding(int action,
-				 string const & prefix = string()) const;
+	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);
+
+	typedef std::pair<key_modifier::state, key_modifier::state> modifier_pair;
+
 private:
 	///
 	struct kb_key {
 		/// Keysym
-		unsigned int code;
-		
+		LyXKeySymPtr code;
+
 		/// Modifier masks
-		unsigned int mod;
-		
+		modifier_pair mod;
+
 		/// Keymap for prefix keys
 		boost::shared_ptr<kb_keymap> table;
-		
+
 		/// Action for !prefix keys
-		int action;
+		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);
 
-	/// Define a new key sequence
-	int defkey(kb_sequence * seq, int action, int idx = 0);
-	///
-	static string const keyname(kb_key const & k);
-	
-	///
-	static
-	void printKey(kb_key const & key, string & buf);
-	///
+	///  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();
 	}
 	///
-	typedef std::list<kb_key> Table;
+	typedef std::vector<kb_key> Table;
 	///
 	Table table;
 };
 
-#endif
+#endif // KBMAP_H