X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.h;h=4d66c0f76b593ea6c0cba96dafe6022a75b7a539;hb=9ee46b846e5e84ad40ceda4f4af94aeb86cd90a2;hp=4f6c6e1ad5368c6e5851204b4e9b1c06b1708d34;hpb=a040c0bc6f017d0591bbc7ad1aa590589dbc40ff;p=lyx.git

diff --git a/src/LyXAction.h b/src/LyXAction.h
index 4f6c6e1ad5..4d66c0f76b 100644
--- a/src/LyXAction.h
+++ b/src/LyXAction.h
@@ -1,93 +1,106 @@
 // -*- C++ -*-
+/**
+ * \file LyXAction.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 John Levon
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 #ifndef LYXACTION_H
 #define LYXACTION_H
 
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "lfuns.h"
 
-#include "commandtags.h"
+#include <boost/utility.hpp>
 
-class LString;
-
-/// Command name - action   
-struct kb_func_table {
-	///
-	char const * name;
-	///
-	kb_action action;
-};
+#include <map>
+#include <string>
 
+class FuncRequest;
 
-/** This class encapsulates LyX action and user command operations.
+/**
+ * This class is a container for LyX actions. It also
+ * stores and managers "pseudo-actions". Pseudo-actions
+ * are not part of the kb_action enum, but are created
+ * dynamically, for encapsulating a real action and an
+ * argument. They are used for things like the menus.
  */
-class LyXAction {
+class LyXAction : boost::noncopyable {
+private:
+	/// information for an action
+	struct func_info {
+		/// the action name
+		std::string name;
+		/// the func_attrib values set
+		unsigned int attrib;
+	};
+
 public:
-	///
+	/// type for map between a function name and its action
+	typedef std::map<std::string, kb_action> func_map;
+	/// type for map between an action and its info
+	typedef std::map<kb_action, func_info> info_map;
+
+	/// possible "permissions" for an action
+	enum func_attrib {
+		Noop = 0, //< nothing special about this func
+		ReadOnly = 1, //< can be used in RO mode (perhaps this should change)
+		NoBuffer = 2, //< Can be used when there is no document open
+		Argument = 4, //< Requires argument
+		NoUpdate = 8, //< Does not (usually) require update
+		SingleParUpdate = 16 //< Usually only requires this par updated
+	};
+
 	LyXAction();
-	///
-	~LyXAction();
-    
-	/** Returns an action tag from a string. Returns kb_action.
-	  Include arguments in func_name ONLY if you
-	  want to create new pseudo actions. */
-	int LookupFunc(char const * func_name); 
-
-        /** Returns an action tag which name is the most similar to a string.
-	    Don't include arguments, they would be ignored. */
-        int getApproxFunc(char const * func);
-
-        /** Returns an action name the most similar to a string.
-	    Don't include arguments, they would be ignored. */
-        char const * getApproxFuncName(char const * func);
-
-	/// Returns a pseudo-action given an action and its argument.
-	int getPseudoAction(kb_action action, char const * arg);
-
-	/// Retrieves the real action and its argument.
-	int retrieveActionArg(int i, char const ** arg);
-    
-	/// Search for an existent pseudoaction, return -1 if it doesn't exist.
-	int searchActionArg(kb_action action, char const * arg);
-
-	/// Check if a value is a pseudo-action. 
-	bool isPseudoAction(int);
-    
-	/// Not sure if this function should be here 
-	int bindKey(char const * seq, int action);
-	
-	/// Return the name associated with command
-	char const * getActionName(int action) const;
-
-	/// Return one line help text associated with command
-	char const * helpText(kb_action action) const;
-
-	 /// True if the command is Read Only (not allowed for RO buffers)
-	bool isFuncRO(kb_action action) const;
+
+	/**
+	 * Returns an pseudoaction from a string
+	 * If you include arguments in func_name, a new pseudoaction
+	 * will be created if needed.
+	 */
+	FuncRequest lookupFunc(std::string const & func_name) const;
+
+	/// Return the name (and argument) associated with the given (pseudo) action
+	std::string const getActionName(kb_action action) const;
+
+	/// True if the command has `flag' set
+	bool funcHasFlag(kb_action action, func_attrib flag) const;
+
+	/// iterator across all real actions
+	typedef func_map::const_iterator const_func_iterator;
+
+	/// return an iterator to the start of all real actions
+	const_func_iterator func_begin() const;
+
+	/// return an iterator to the end of all real actions
+	const_func_iterator func_end() const;
 
 private:
-     
-        ///  Standard commands
-        static kb_func_table const * lyx_func_table;
-	/// Number of commands
-	int funcCount;
-	///  Pseudoactions
-	static kb_func_table * lyx_func_args;
-	///  Pseudoaction index
-	static int psd_idx; 
-	/// Last action index found
-	int last_action_idx;
+	/// populate the action container with our actions
+	void init();
+	/// add the given action
+	void newFunc(kb_action, std::string const & name, unsigned int attrib);
+
+	/**
+	 * This is a list of all the LyXFunc names with the
+	 * coresponding action number. It is usually only used by the
+	 * minibuffer or when assigning commands to keys during init.
+	 */
+	func_map lyx_func_map;
+
+	/**
+	 * This is a mapping from action number to an object holding
+	 * info about this action. f.ex. command name (string),
+	 * command attributes (ro)
+	 */
+	info_map lyx_info_map;
 };
-     
-
-/* --------------------   Inlines  ------------------ */
-    
-     
-inline
-bool LyXAction::isPseudoAction(int a) 
-{ 
-	return (a >= int(LFUN_LASTACTION)); 
-}
-     
-
-#endif
+
+/// singleton instance
+extern LyXAction lyxaction;
+
+#endif // LYXACTION_H