-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright 1995 Matthias Ettrich
- * Copyright 1995-2001 The LyX Team.
- *
- * ====================================================== */
+/**
+ * \file LyXAction.C
+ * Copyright 1995-2002 the LyX Team
+ * Read the file COPYING
+ */
#include <config.h>
#endif
#include "LyXAction.h"
+
#include "debug.h"
#include "gettext.h"
#include "support/lstrings.h"
using std::ostream;
using std::endl;
+using std::pair;
+using std::make_pair;
-/*
+/*
NAMING RULES FOR USER-COMMANDS
Here's the set of rules to apply when a new command name is introduced:
-
+
1) Use the object.event order. That is, use `word-forward'
- instead of `forward-word'.
+ instead of `forward-word'.
2) Don't introduce an alias for an already named object. Same for events.
3) Forward movement or focus is called `forward' (not `right').
4) Backward movement or focus is called `backward' (not `left').
6) Downward movement is called `down'.
7) The begin of an object is called `begin' (not `start').
8) The end of an object is called `end'.
-
+
(May 19 1996, 12:04, RvdK)
- */
+*/
-// These are globals.
LyXAction lyxaction;
-// Small helper function
-inline
-bool isPseudoAction(int a)
-{
- return a > int(LFUN_LASTACTION);
+namespace {
+
+/// return true if the given action is a pseudo-action
+inline bool isPseudoAction(int a)
+{
+ return a > int(LFUN_LASTACTION);
+}
+
}
-
void LyXAction::newFunc(kb_action action, string const & name,
// times. Since the array is not static we get back the memory it
// occupies after the init is completed. It compiles several
// magnitudes faster.
-
+
static bool init;
if (init) return;
- struct lfun_item {
+ struct ev_item {
kb_action action;
char const * name;
char const * helpText;
unsigned int attrib;
};
- lfun_item items[] = {
+ ev_item const items[] = {
{ LFUN_ACUTE, "accent-acute", "", Noop },
{ LFUN_BREVE, "accent-breve", "", Noop },
{ LFUN_CARON, "accent-caron", "", Noop },
{ LFUN_BREAKPARAGRAPHKEEPLAYOUT, "break-paragraph-keep-layout",
"", Noop },
{ LFUN_BREAKPARAGRAPH_SKIP, "break-paragraph-skip", "", Noop },
- { LFUN_BUILDPROG, "build-program",
+ { LFUN_BUILDPROG, "build-program",
N_("Build program"), ReadOnly },
{ LFUN_AUTOSAVE, "buffer-auto-save", N_("Autosave"), Noop },
{ LFUN_BEGINNINGBUF, "buffer-begin",
{ LFUN_EXPORT, "buffer-export", N_("Export to"), ReadOnly },
{ LFUN_IMPORT, "buffer-import",
N_("Import document"), NoBuffer },
- { LFUN_BUFFER_PRINT, "buffer-print-xtl", N_("Print"),
- ReadOnly },
- { LFUN_PRINTER_PARAMS_GET, "printer-params-get",
- N_("Get the printer parameters"), ReadOnly },
{ LFUN_MENUNEW, "buffer-new", N_("New document") , NoBuffer },
{ LFUN_MENUNEWTMPLT,"buffer-new-template",
N_("New document from template"), NoBuffer },
{ LFUN_MENUPRINT, "buffer-print", N_("Print"), ReadOnly },
{ LFUN_MENURELOAD, "buffer-reload",
N_("Revert to saved"), ReadOnly },
- { LFUN_SWITCHBUFFER, "buffer-switch",
+ { LFUN_SWITCHBUFFER, "buffer-switch",
N_("Switch to an open document"), ReadOnly },
{ LFUN_READ_ONLY_TOGGLE, "buffer-toggle-read-only",
N_("Toggle read-only"), ReadOnly },
{ LFUN_EXEC_COMMAND, "command-execute", "", NoBuffer },
{ LFUN_PREFIX, "command-prefix",
N_("Execute command"), NoBuffer },
- { LFUN_SEQUENCE, "command-sequence", "", Noop },
+ { LFUN_SEQUENCE, "command-sequence", "", NoBuffer },
{ LFUN_COPY, "copy", N_("Copy"), ReadOnly },
{ LFUN_CUT, "cut", N_("Cut"), Noop },
{ LFUN_DATE_INSERT, "date-insert", "", Noop },
N_("Decrement environment depth"), Noop },
{ LFUN_DEPTH_PLUS, "depth-increment",
N_("Increment environment depth"), Noop },
- { LFUN_DEPTH, "depth-next",
- N_("Change environment depth"), Noop },
{ LFUN_LDOTS, "dots-insert", N_("Insert ... dots"), Noop },
{ LFUN_DOWN, "down", N_("Go down"), ReadOnly },
{ LFUN_DOWNSEL, "down-select",
N_("Choose Paragraph Environment"), ReadOnly },
{ LFUN_END_OF_SENTENCE, "end-of-sentence-period-insert",
N_("Insert end of sentence period"), Noop },
- { LFUN_GOTOERROR, "error-next", N_("Go to next error"), Noop },
+ { LFUN_GOTOERROR, "error-next",
+ N_("Go to next error"), ReadOnly },
{ LFUN_REMOVEERRORS, "error-remove-all",
N_("Remove all error boxes"), ReadOnly },
{ LFUN_INSET_ERT, "ert-insert",
N_("Insert a new ERT Inset"), Noop },
{ LFUN_INSET_EXTERNAL, "external-insert",
N_("Insert a new external inset"), Noop },
- { LFUN_FIGURE, "figure-insert", N_("Insert Graphics"), Noop },
{ LFUN_INSET_GRAPHICS, "graphics-insert",
N_("Insert Graphics"), Noop },
{ LFUN_FILE_INSERT, "file-insert", "", Noop },
ReadOnly },
{ LFUN_HFILL, "hfill-insert",
N_("Insert horizontal fill"), Noop },
- { LFUN_HELP_OPEN, "help-open", N_("Open a Help file"),
+ { LFUN_HELP_OPEN, "help-open", N_("Open a Help file"),
NoBuffer|Argument},
{ LFUN_HTMLURL, "html-insert", "", Noop },
{ LFUN_HYPHENATION, "hyphenation-point-insert",
N_("Insert hyphenation point"), Noop },
{ LFUN_LIGATURE_BREAK, "ligature-break-insert",
N_("Insert ligature break"), Noop },
- { LFUN_INDEX_CREATE, "index-insert",
+ { LFUN_INDEX_INSERT, "index-insert",
N_("Insert index item"), Noop },
- { LFUN_INDEX_INSERT_LAST, "index-insert-last",
- N_("Insert last index item"), Noop },
{ LFUN_INDEX_PRINT, "index-print", N_("Insert index list"),
Noop },
{ LFUN_KMAP_OFF, "keymap-off", N_("Turn off keymap"),
ReadOnly },
{ LFUN_INSERT_LABEL, "label-insert", N_("Insert Label"),
Noop },
+ { LFUN_INSET_OPTARG, "optional-insert", N_("Insert Optional Argument"),
+ Noop },
{ LFUN_LANGUAGE, "language", N_("Change language"), Noop },
{ LFUN_LATEX_LOG, "latex-view-log", N_("View LaTeX log"),
ReadOnly },
#endif
{ LFUN_QUIT, "lyx-quit", N_("Exit"), NoBuffer },
{ LFUN_INSET_MARGINAL, "marginalnote-insert",
- N_("Insert Marginalnote"), Noop },
+ N_("Insert margin note"), Noop },
{ LFUN_MARK_OFF, "mark-off", "", ReadOnly },
{ LFUN_MARK_ON, "mark-on", "", ReadOnly },
{ LFUN_SETMARK, "mark-toggle", "", ReadOnly },
{ LFUN_GREEK_TOGGLE, "math-greek-toggle", "", Noop },
{ LFUN_INSERT_MATH, "math-insert",
N_("Insert math symbol"), Noop },
- { LFUN_SUBSCRIPT, "math-subscript", "", Noop },
- { LFUN_SUPERSCRIPT, "math-superscript", "", Noop },
+ { LFUN_SUBSCRIPT, "math-subscript", N_("Add subscript"), Noop },
+ { LFUN_SUPERSCRIPT, "math-superscript", N_("Add superscript"), Noop },
{ LFUN_MATH_LIMITS, "math-limits", "", Noop },
{ LFUN_MATH_MACRO, "math-macro", "", Noop },
{ LFUN_MATH_MUTATE, "math-mutate", "", Noop },
{ LFUN_MATH_SPACE, "math-space", "", Noop },
{ LFUN_MATH_IMPORT_SELECTION, "math-import-selection", "", Noop },
- { LFUN_MATH_MACROARG, "math-macro-arg", "", Noop },
{ LFUN_INSERT_MATRIX, "math-matrix", "", Noop },
{ LFUN_MATH_MODE, "math-mode", N_("Math mode"), Noop },
{ LFUN_MATH_NONUMBER, "math-nonumber", "", Noop },
{ LFUN_MATH_NUMBER, "math-number", "", Noop },
{ LFUN_MATH_EXTERN, "math-extern", "", Noop },
- { LFUN_MATH_VALIGN, "math-valign", "", Noop },
- { LFUN_MATH_HALIGN, "math-halign", "", Noop },
- { LFUN_MATH_ROW_INSERT, "math-row-insert", "", Noop },
- { LFUN_MATH_ROW_DELETE, "math-row-delete", "", Noop },
- { LFUN_MATH_COLUMN_INSERT, "math-column-insert", "", Noop },
- { LFUN_MATH_COLUMN_DELETE, "math-column-delete", "", Noop },
{ LFUN_MATH_PANEL, "math-panel", "", Noop },
{ LFUN_MATH_SIZE, "math-size", "", Noop },
{ LFUN_MENU_OPEN_BY_NAME, "menu-open", "", NoBuffer },
{ LFUN_INSET_MINIPAGE, "minipage-insert", "", Noop },
{ LFUN_INSERT_NOTE, "note-insert", "", Noop },
{ LFUN_GOTONOTE, "note-next", "", ReadOnly },
- { LFUN_INSET_TOGGLE, "inset-toggle",
+ { LFUN_INSET_TOGGLE, "inset-toggle",
N_("toggle inset"), ReadOnly },
{ LFUN_DOWN_PARAGRAPH, "paragraph-down",
N_("Go one paragraph down"), ReadOnly },
{ LFUN_DOWN_PARAGRAPHSEL, "paragraph-down-select",
N_("Select next paragraph"), ReadOnly },
- { LFUN_GOTO_PARAGRAPH, "paragraph-goto",
+ { LFUN_GOTO_PARAGRAPH, "paragraph-goto",
N_("Go to paragraph"), ReadOnly },
{ LFUN_PARAGRAPH_SPACING, "paragraph-spacing", "", Noop },
{ LFUN_UP_PARAGRAPH, "paragraph-up",
{ LFUN_SHIFT_TAB, "tab-backward", "", Noop },
{ LFUN_TAB, "tab-forward", "", Noop },
{ LFUN_TABINSERT, "tab-insert", "", Noop },
- { LFUN_DIALOG_TABULAR_INSERT, "dialog-tabular-insert",
- N_("Insert Table"), Noop },
+ { LFUN_TABULAR_INSERT, "tabular-insert", N_("Insert Table"), Noop },
{ LFUN_TABULAR_FEATURE, "tabular-feature",
N_("Tabular Features"), Noop },
- { LFUN_INSET_TABULAR, "tabular-insert",
- N_("Insert a new Tabular Inset"), Noop },
- { LFUN_INSET_TEXT, "text-insert",
- N_("Insert a new Text Inset"), Noop },
#if 0
{ LFUN_INSET_THEOREM, "theorem-insert", "", Noop },
#endif
{ LFUN_TOGGLECURSORFOLLOW, "toggle-cursor-follows-scrollbar",
N_("Toggle cursor does/doesn't follow the scrollbar"),
ReadOnly },
- { LFUN_ADD_TO_TOOLBAR, "toolbar-add-to", "", NoBuffer },
- { LFUN_PUSH_TOOLBAR, "toolbar-push", "", NoBuffer },
{ LFUN_UNDO, "undo", N_("Undo"), Noop },
{ LFUN_UP, "up", "", ReadOnly },
{ LFUN_UPSEL, "up-select", "", ReadOnly },
{ LFUN_UPCASE_WORD, "word-upcase", "", Noop },
{ LFUN_MESSAGE, "message",
N_("Show message in minibuffer"), NoBuffer },
- { LFUN_MESSAGE_PUSH, "message-push",
- N_("Push old message and show this one in minibuffer"),
- NoBuffer },
- { LFUN_MESSAGE_POP, "message-pop",
- N_("Pop old message and show it in the minibuffer"),
- NoBuffer },
{ LFUN_TRANSPOSE_CHARS, "chars-transpose", "", Noop },
{ LFUN_FLOAT_LIST, "float-list", "Insert a float list", Noop },
{ LFUN_ESCAPE, "escape", "", Noop },
N_("Display information about LyX"), NoBuffer },
{ LFUN_HELP_TEXINFO, "help-Texinfo",
N_("Display information about the TeX installation"), NoBuffer },
+ { LFUN_FORKS_SHOW, "show-forks",
+ N_("Show the processes forked by LyX"), NoBuffer },
+ { LFUN_FORKS_KILL, "kill-forks",
+ N_("Kill the forked process with this PID"), NoBuffer },
+ { LFUN_TOOLTIPS_TOGGLE, "toggle-tooltips", "", NoBuffer },
{ LFUN_NOACTION, "", "", Noop }
};
- int i = 0;
- while (items[i].action != LFUN_NOACTION) {
- newFunc(items[i].action,
- items[i].name,
- _(items[i].helpText),
- items[i].attrib);
- ++i;
+ for (int i = 0; items[i].action != LFUN_NOACTION; ++i) {
+ newFunc(items[i].action, items[i].name,
+ _(items[i].helpText), items[i].attrib);
}
init = true;
}
-// Search for an existent pseudoaction, return LFUN_UNKNOWN_ACTION
-// if it doesn't exist.
int LyXAction::searchActionArg(kb_action action, string const & arg) const
{
arg_map::const_iterator pit = lyx_arg_map.find(action);
if (pit == lyx_arg_map.end()) {
- // the action does not have any pseudoactions
lyxerr[Debug::ACTION] << "Action " << action
<< " does not have any pseudo actions."
<< endl;
arg_item::const_iterator aci = pit->second.find(arg);
if (aci == pit->second.end()) {
- // the action does not have any pseudoactions with this arg
- lyxerr[Debug::ACTION]
+ lyxerr[Debug::ACTION]
<< "Action " << action
<< "does not have any pseudoactions with arg "
<< arg << endl;
return LFUN_UNKNOWN_ACTION;
}
- // pseudo action exist
- lyxerr[Debug::ACTION] << "Pseudoaction exist["
- << action << '|'
+ lyxerr[Debug::ACTION] << "Pseudoaction exists["
+ << action << '|'
<< arg << "] = " << aci->second << endl;
return aci->second;
}
-// Returns a pseudo-action given an action and its argument.
-int LyXAction::getPseudoAction(kb_action action, string const & arg) const
+int LyXAction::getPseudoAction(kb_action action, string const & arg)
{
int const psdaction = searchActionArg(action, arg);
static unsigned int pseudo_counter = LFUN_LASTACTION;
// Create new pseudo action.
- pseudo_func tmp_p;
- tmp_p.action = action;
- tmp_p.arg = arg;
- lyx_pseudo_map[++pseudo_counter] = tmp_p;
+ lyx_pseudo_map[++pseudo_counter] = FuncRequest(0, action, arg);
// First ensure that the action is in lyx_arg_map;
lyx_arg_map[action];
lyxerr[Debug::ACTION] << "Creating new pseudoaction "
<< pseudo_counter << " for [" << action
<< '|' << arg << "]\n";
-
+
return pseudo_counter;
}
-// Retrieves the real action and its argument.
-// perhaps a pair<kb_action, string> should be returned?
-kb_action LyXAction::retrieveActionArg(int pseudo, string & arg) const
+FuncRequest LyXAction::retrieveActionArg(int pseudo) const
{
- arg.erase(); // clear it to be sure.
+ if (!isPseudoAction(pseudo))
+ return FuncRequest(static_cast<kb_action>(pseudo));
- if (!isPseudoAction(pseudo))
- return static_cast<kb_action>(pseudo);
-
pseudo_map::const_iterator pit = lyx_pseudo_map.find(pseudo);
if (pit != lyx_pseudo_map.end()) {
lyxerr[Debug::ACTION] << "Found the pseudoaction: ["
<< pit->second.action << '|'
- << pit->second.arg << "]\n";
- arg = pit->second.arg;
- return pit->second.action;
+ << pit->second.argument << "]\n";
+ return pit->second;
} else {
- lyxerr << "Lyx Error: Unrecognized pseudo-action\n";
- return LFUN_UNKNOWN_ACTION;
+ lyxerr << "Lyx Error: Unrecognized pseudo-action "
+ << pseudo << endl;
+ return FuncRequest(LFUN_UNKNOWN_ACTION);
}
}
// Returns an action tag from a string.
-int LyXAction::LookupFunc(string const & func) const
+int LyXAction::LookupFunc(string const & func)
{
- if (func.empty()) return LFUN_NOACTION;
+ string const func2 = trim(func);
+ if (func2.empty()) return LFUN_NOACTION;
// split action and arg
string actstr;
- string const argstr = split(func, actstr, ' ');
+ string const argstr = split(func2, actstr, ' ');
lyxerr[Debug::ACTION] << "Action: " << actstr << '\n';
lyxerr[Debug::ACTION] << "Arg : " << argstr << '\n';
}
-//#ifdef WITH_WARNINGS
-//#warning Not working as it should.
-//#endif
-// I have no clue what is wrong with it... (Lgb)
-int LyXAction::getApproxFunc(string const & func) const
- // This func should perhaps also be able to return a list of all
- // actions that has func as a prefix. That should actually be quite
- // easy, just let it return a vector<int> or something.
-{
- int action = LookupFunc(func);
- if (action == LFUN_UNKNOWN_ACTION) {
- // func is not an action, but perhaps it is
- // part of one...check if it is prefix if one of the
- // actions.
- // Checking for prefix is not so simple, but
- // using a simple bounding function gives
- // a similar result. [ale 19981103]
- func_map::const_iterator fit =
- lyx_func_map.lower_bound(func);
-
- if (fit != lyx_func_map.end()) {
- action = fit->second;
- }
- } else { // Go get the next function
- func_map::const_iterator fit =
- lyx_func_map.upper_bound(func);
-
- if (fit != lyx_func_map.end()) {
- action = fit->second;
- }
- }
-
- return action;
-}
-
-
-string const LyXAction::getApproxFuncName(string const & func) const
+string const LyXAction::getActionName(int action) const
{
- int const f = getApproxFunc(func);
- // This will return empty string if f isn't an action.
- return getActionName(f);
-}
+ FuncRequest ev = retrieveActionArg(action);
+ if (!ev.argument.empty())
+ ev.argument.insert(0, " ");
+ info_map::const_iterator iit = lyx_info_map.find(ev.action);
-string const LyXAction::getActionName(int action) const
-{
- kb_action ac;
- string arg;
-
- ac = retrieveActionArg(action, arg);
- if (!arg.empty())
- arg.insert(0, " ");
-
- info_map::const_iterator iit = lyx_info_map.find(ac);
-
- if (iit != lyx_info_map.end()) {
- string ret(iit->second.name);
- ret += arg;
- return ret;
- } else
- return string();
+ if (iit != lyx_info_map.end())
+ return iit->second.name + ev.argument;
+ return string();
}
-// Returns one line help associated with a (pseudo)action, i.e. appends
-// the argument of the action if necessary
string const LyXAction::helpText(int pseudoaction) const
{
- string help, arg;
- kb_action action;
+ FuncRequest ev = retrieveActionArg(pseudoaction);
- action = retrieveActionArg(pseudoaction, arg);
-
- info_map::const_iterator ici = lyx_info_map.find(action);
+ string help;
+
+ info_map::const_iterator ici = lyx_info_map.find(ev.action);
if (ici != lyx_info_map.end()) {
if (lyxerr.debugging(Debug::ACTION)) {
- lyxerr << "Action: " << action << '\n';
+ lyxerr << "Action: " << ev.action << '\n';
lyxerr << " name: "
<< ici->second.name << '\n';
lyxerr << " attrib: "
if (help.empty()) {
help = _("No description available!");
- } else if (!arg.empty()) {
+ } else if (!ev.argument.empty()) {
help += ' ';
- help += arg;
+ help += ev.argument;
}
return help;
}
-bool LyXAction::funcHasFlag(kb_action action,
- LyXAction::func_attrib flag) const
+bool LyXAction::funcHasFlag(kb_action action,
+ LyXAction::func_attrib flag) const
{
info_map::const_iterator ici = lyx_info_map.find(action);
}
-LyXAction::const_func_iterator LyXAction::func_begin() const
+LyXAction::const_func_iterator LyXAction::func_begin() const
{
return lyx_func_map.begin();
}
-LyXAction::const_func_iterator LyXAction::func_end() const
+LyXAction::const_func_iterator LyXAction::func_end() const
{
return lyx_func_map.end();
}