X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLyXAction.h;h=bf7bf35638e729f283afa80a142e512a1cd142f3;hb=aef8746712ccc64f1f10073fe6d011ff1d7eb4a4;hp=4f6c6e1ad5368c6e5851204b4e9b1c06b1708d34;hpb=a040c0bc6f017d0591bbc7ad1aa590589dbc40ff;p=lyx.git diff --git a/src/LyXAction.h b/src/LyXAction.h index 4f6c6e1ad5..bf7bf35638 100644 --- a/src/LyXAction.h +++ b/src/LyXAction.h @@ -1,93 +1,138 @@ // -*- 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 "FuncCode.h" -#include "commandtags.h" +#include +#include -class LString; -/// Command name - action -struct kb_func_table { - /// - char const * name; - /// - kb_action action; -}; +namespace lyx { + +// current LFUN format +static unsigned int const LFUN_FORMAT = 4; // gm: tabular-feature +class FuncRequest; +class LyXErr; -/** This class encapsulates LyX action and user command operations. +/** + * This class is a container for LyX actions. It associates a name to + * most of them and describes some of their properties. */ class LyXAction { public: - /// + /// category of an action, used in the Shortcuts dialog + enum FuncType { + Hidden, //< Not listed for configuration + Edit, //< Cursor and mouse movement, copy/paste etc + Math, //< Mathematics + Buffer, //< Buffer and window related + Layout, //< Font, Layout and textclass related + System //< Lyx preference, server etc + }; + +private: + /// information for an action + struct FuncInfo { + /// the action name + std::string name; + /// the FuncAttribs values set + unsigned int attrib; + /// the category of this func + FuncType type; + }; + /// type for map between a function name and its action + typedef std::map FuncMap; + /// type for map between an action and its info + typedef std::map InfoMap; + +public: + /// possible "permissions" for an action + enum FuncAttribs { + 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 + AtPoint = 32, //< dispatch first to inset at cursor if there is one + NoInternal = 64 //< Cannot be used for internal, non-document Buffers + }; + LyXAction(); + + /** + * Creates a FuncRequest from a string of the form: + * lyx-function [argument] + * where the argument is optional and "lyx-function" is in the form you'd + * enter it in the mini-buffer. + */ + FuncRequest lookupFunc(std::string const & func_name) const; + + /// Return the command name associated with the given action + /// Thus: getActionName(LFUN_ERT_INSERT) --> "ert-insert". + std::string const getActionName(FuncCode action) const; /// - ~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; + FuncType getActionType(FuncCode action) const; + + /// True if the command has `flag' set + bool funcHasFlag(FuncCode action, FuncAttribs flag) const; + + /// iterator across all LFUNs + typedef FuncMap::const_iterator const_iterator; + + /// return an iterator to the start of the list of LFUNs + const_iterator func_begin() const; + + /// return an iterator to one past the end of the list of LFUNs + const_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; + /// noncopyable + LyXAction(LyXAction const &); + void operator=(LyXAction const &); + + /// populate the action container with our actions + void init(); + /// add the given action + void newFunc(FuncCode, std::string const & name, unsigned int attrib, FuncType type); + + /** + * This maps LyX function names to function codes, e.g.: + * lyx_func_map["ert-insert"] == LFUN_ERT_INSERT + */ + FuncMap lyx_func_map; + + /** + * This maps function codes to objects holding info about the corresponding + * action. E.g., if + * FuncInfo const & ert = lyx_info_map[LFUN_ERT_INSERT]; + * then: + * ert.name == "ert-insert"' + * ert.attrib == Noop + * ert.type == Edit + */ + InfoMap lyx_info_map; }; - - -/* -------------------- Inlines ------------------ */ - - -inline -bool LyXAction::isPseudoAction(int a) -{ - return (a >= int(LFUN_LASTACTION)); -} - - -#endif + +LyXErr & operator<<(LyXErr &, FuncCode); + +/// singleton instance +extern LyXAction lyxaction; + + +} // namespace lyx + +#endif // LYXACTION_H