1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
14 #pragma implementation
17 #include "LyXAction.h"
20 #include "support/lstrings.h"
26 NAMING RULES FOR USER-COMMANDS
27 Here's the set of rules to apply when a new command name is introduced:
29 1) Use the object.event order. That is, use `word-forward'
30 instead of `forward-word'.
31 2) Don't introduce an alias for an already named object. Same for events.
32 3) Forward movement or focus is called `forward' (not `right').
33 4) Backward movement or focus is called `backward' (not `left').
34 5) Upward movement of focus is called `up'.
35 6) Downward movement is called `down'.
36 7) The begin of an object is called `begin' (not `start').
37 8) The end of an object is called `end'.
39 (May 19 1996, 12:04, RvdK)
45 // Small helper function
47 bool isPseudoAction(int a)
49 return a > int(LFUN_LASTACTION);
54 void LyXAction::newFunc(kb_action action, string const & name,
55 string const & helpText, unsigned int attrib)
57 lyx_func_map[name] = action;
60 tmpinfo.attrib = attrib;
61 tmpinfo.helpText = helpText;
62 lyx_info_map[action] = tmpinfo;
66 void LyXAction::init()
68 // This function was changed to use the array below in initalization
69 // instead of calling newFunc numerous times because of compilation
70 // times. Since the array is not static we get back the memory it
71 // occupies after the init is completed. It compiles several
80 char const * helpText;
85 { LFUN_ACUTE, "accent-acute", "", Noop },
86 { LFUN_BREVE, "accent-breve", "", Noop },
87 { LFUN_CARON, "accent-caron", "", Noop },
88 { LFUN_CEDILLA, "accent-cedilla", "", Noop },
89 { LFUN_CIRCLE, "accent-circle", "", Noop },
90 { LFUN_CIRCUMFLEX, "accent-circumflex", "", Noop },
91 { LFUN_DOT, "accent-dot", "", Noop },
92 { LFUN_GRAVE, "accent-grave", "", Noop },
93 { LFUN_HUNG_UMLAUT, "accent-hungarian-umlaut", "", Noop },
94 { LFUN_MACRON, "accent-macron", "", Noop },
95 { LFUN_OGONEK, "accent-ogonek", "", Noop },
96 { LFUN_SPECIAL_CARON, "accent-special-caron", "", Noop },
97 { LFUN_TIE, "accent-tie", "", Noop },
98 { LFUN_TILDE, "accent-tilde", "", Noop },
99 { LFUN_UMLAUT, "accent-umlaut", "", Noop },
100 { LFUN_UNDERBAR, "accent-underbar", "", Noop },
101 { LFUN_UNDERDOT, "accent-underdot", "", Noop },
102 { LFUN_VECTOR, "accent-vector", "", Noop },
103 { LFUN_APPENDIX, "appendix", N_("Insert appendix"), Noop },
104 { LFUN_APROPOS, "apropos", N_("Describe command"),
106 { LFUN_LEFTSEL, "backward-select",
107 N_("Select previous char"), ReadOnly },
108 { LFUN_BIBDB_ADD, "bibtex-database-add", "", Noop },
109 { LFUN_BIBDB_DEL, "bibtex-database-del", "", Noop },
110 { LFUN_INSERT_BIBTEX, "bibtex-insert", N_("Insert bibtex"),
112 { LFUN_BIBTEX_STYLE, "bibtex-style", "", Noop },
113 { LFUN_BOOKMARK_GOTO, "bookmark-goto", "", ReadOnly },
114 { LFUN_BOOKMARK_SAVE, "bookmark-save", "", ReadOnly },
115 { LFUN_BREAKLINE, "break-line", "", Noop },
116 { LFUN_BREAKPARAGRAPH, "break-paragraph", "", Noop },
117 { LFUN_BREAKPARAGRAPHKEEPLAYOUT, "break-paragraph-keep-layout",
119 { LFUN_BREAKPARAGRAPH_SKIP, "break-paragraph-skip", "", Noop },
120 { LFUN_BUILDPROG, "build-program",
121 N_("Build program"), ReadOnly },
122 { LFUN_AUTOSAVE, "buffer-auto-save", N_("Autosave"), Noop },
123 { LFUN_BEGINNINGBUF, "buffer-begin",
124 N_("Go to beginning of document"), ReadOnly },
125 { LFUN_BEGINNINGBUFSEL, "buffer-begin-select",
126 N_("Select to beginning of document"), ReadOnly },
127 { LFUN_CHILD_INSERT, "buffer-child-insert", "", Noop },
128 { LFUN_CHILDOPEN, "buffer-child-open", "", ReadOnly },
129 { LFUN_RUNCHKTEX, "buffer-chktex", N_("Check TeX"), ReadOnly },
130 { LFUN_CLOSEBUFFER, "buffer-close", N_("Close"), ReadOnly },
131 { LFUN_ENDBUF, "buffer-end",
132 N_("Go to end of document"), ReadOnly },
133 { LFUN_ENDBUFSEL, "buffer-end-select",
134 N_("Select to end of document"), ReadOnly },
135 { LFUN_EXPORT, "buffer-export", N_("Export to"), ReadOnly },
136 { LFUN_IMPORT, "buffer-import",
137 N_("Import document"), NoBuffer },
138 { LFUN_MENUNEW, "buffer-new", N_("New document") , NoBuffer },
139 { LFUN_MENUNEWTMPLT,"buffer-new-template",
140 N_("New document from template"), NoBuffer },
141 { LFUN_MENUPRINT, "buffer-print", N_("Print"), ReadOnly },
142 { LFUN_MENURELOAD, "buffer-reload",
143 N_("Revert to saved"), ReadOnly },
144 { LFUN_SWITCHBUFFER, "buffer-switch",
145 N_("Switch to an open document"), ReadOnly },
146 { LFUN_READ_ONLY_TOGGLE, "buffer-toggle-read-only",
147 N_("Toggle read-only"), ReadOnly },
148 { LFUN_UPDATE, "buffer-update", N_("Update"), ReadOnly },
149 { LFUN_PREVIEW, "buffer-view", N_("View") , ReadOnly },
150 { LFUN_MENUWRITE, "buffer-write", N_("Save"), ReadOnly },
151 { LFUN_WRITEAS, "buffer-write-as", N_("Save As"),
153 { LFUN_CANCEL, "cancel", N_("Cancel"), NoBuffer },
154 { LFUN_INSET_CAPTION, "caption-insert", "", Noop },
155 { LFUN_LEFT, "char-backward", N_("Go one char back"),
157 { LFUN_RIGHT, "char-forward", N_("Go one char forward"),
159 { LFUN_CITATION_CREATE, "citation-insert",
160 N_("Insert citation"), Noop },
161 { LFUN_CITATION_INSERT, "", "internal only", Noop },
162 { LFUN_EXEC_COMMAND, "command-execute", "", NoBuffer },
163 { LFUN_PREFIX, "command-prefix",
164 N_("Execute command"), NoBuffer },
165 { LFUN_SEQUENCE, "command-sequence", "", NoBuffer },
166 { LFUN_COPY, "copy", N_("Copy"), ReadOnly },
167 { LFUN_CUT, "cut", N_("Cut"), Noop },
168 { LFUN_DATE_INSERT, "date-insert", "", Noop },
169 { LFUN_BACKSPACE, "delete-backward", "", Noop },
170 { LFUN_BACKSPACE_SKIP, "delete-backward-skip", "", Noop },
171 { LFUN_DELETE, "delete-forward", "", Noop },
172 { LFUN_DELETE_SKIP, "delete-forward-skip", "", Noop },
173 { LFUN_DEPTH_MIN, "depth-decrement",
174 N_("Decrement environment depth"), Noop },
175 { LFUN_DEPTH_PLUS, "depth-increment",
176 N_("Increment environment depth"), Noop },
177 { LFUN_LDOTS, "dots-insert", N_("Insert ... dots"), Noop },
178 { LFUN_DOWN, "down", N_("Go down"), ReadOnly },
179 { LFUN_DOWNSEL, "down-select",
180 N_("Select next line"), ReadOnly },
181 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice",
182 N_("Choose Paragraph Environment"), ReadOnly },
183 { LFUN_END_OF_SENTENCE, "end-of-sentence-period-insert",
184 N_("Insert end of sentence period"), Noop },
185 { LFUN_GOTOERROR, "error-next",
186 N_("Go to next error"), ReadOnly },
187 { LFUN_REMOVEERRORS, "error-remove-all",
188 N_("Remove all error boxes"), ReadOnly },
189 { LFUN_INSET_ERT, "ert-insert",
190 N_("Insert a new ERT Inset"), Noop },
191 { LFUN_INSET_EXTERNAL, "external-insert",
192 N_("Insert a new external inset"), Noop },
193 { LFUN_INSET_GRAPHICS, "graphics-insert",
194 N_("Insert Graphics"), Noop },
195 { LFUN_FILE_INSERT, "file-insert", "", Noop },
196 { LFUN_FILE_INSERT_ASCII, "file-insert-ascii", _("Insert ASCII files as lines"), Noop },
197 { LFUN_FILE_INSERT_ASCII_PARA, "file-insert-ascii-para", _("Insert ASCII file as a paragraph"), Noop },
198 { LFUN_FILE_NEW, "file-new", "", NoBuffer },
199 { LFUN_FILE_OPEN, "file-open", _("Open a file"), NoBuffer },
200 { LFUN_MENUSEARCH, "find-replace", N_("Find & Replace"),
202 { LFUN_INSET_FLOAT, "float-insert", "Insert a Float", Noop },
203 { LFUN_INSET_WIDE_FLOAT, "float-wide-insert",
204 "Insert a wide Float", Noop },
205 { LFUN_BOLD, "font-bold", N_("Toggle bold"), Noop },
206 { LFUN_CODE, "font-code", N_("Toggle code style"), Noop },
207 { LFUN_DEFAULT, "font-default", N_("Default font style"),
209 { LFUN_EMPH, "font-emph", N_("Toggle emphasize"), Noop },
210 { LFUN_FREE, "font-free", N_("Toggle user defined style"),
212 { LFUN_NOUN, "font-noun", N_("Toggle noun style"), Noop },
213 { LFUN_ROMAN, "font-roman", N_("Toggle roman font style"),
215 { LFUN_SANS, "font-sans", N_("Toggle sans font style"), Noop },
216 { LFUN_FRAK, "font-frak", N_("Toggle fraktur font style"), Noop },
217 { LFUN_ITAL, "font-ital", N_("Toggle italic font style"), Noop },
218 { LFUN_FONT_SIZE, "font-size", N_("Set font size"), Noop },
219 { LFUN_FONT_STATE, "font-state", N_("Show font state"),
221 { LFUN_UNDERLINE, "font-underline",
222 N_("Toggle font underline"), Noop },
223 { LFUN_INSET_FOOTNOTE, "footnote-insert",
224 N_("Insert Footnote"), Noop },
225 { LFUN_RIGHTSEL, "forward-select", N_("Select next char"),
227 { LFUN_HFILL, "hfill-insert",
228 N_("Insert horizontal fill"), Noop },
229 { LFUN_HELP_OPEN, "help-open", N_("Open a Help file"),
231 { LFUN_HTMLURL, "html-insert", "", Noop },
232 { LFUN_HYPHENATION, "hyphenation-point-insert",
233 N_("Insert hyphenation point"), Noop },
234 { LFUN_LIGATURE_BREAK, "ligature-break-insert",
235 N_("Insert ligature break"), Noop },
236 { LFUN_INDEX_INSERT, "index-insert",
237 N_("Insert index item"), Noop },
238 { LFUN_INDEX_PRINT, "index-print", N_("Insert index list"),
240 { LFUN_KMAP_OFF, "keymap-off", N_("Turn off keymap"),
242 { LFUN_KMAP_PRIM, "keymap-primary",
243 N_("Use primary keymap"), ReadOnly },
244 { LFUN_KMAP_SEC, "keymap-secondary",
245 N_("Use secondary keymap"), ReadOnly },
246 { LFUN_KMAP_TOGGLE, "keymap-toggle", N_("Toggle keymap"),
248 { LFUN_INSERT_LABEL, "label-insert", N_("Insert Label"),
250 { LFUN_LANGUAGE, "language", N_("Change language"), Noop },
251 { LFUN_LATEX_LOG, "latex-view-log", N_("View LaTeX log"),
253 { LFUN_LAYOUT, "layout", "", Noop },
254 { LFUN_LAYOUT_CHARACTER, "layout-character", "", Noop },
255 { LFUN_LAYOUT_COPY, "layout-copy",
256 N_("Copy paragraph environment type"), Noop },
257 { LFUN_LAYOUT_DOCUMENT, "layout-document", "", ReadOnly },
258 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", "", ReadOnly },
259 { LFUN_LAYOUT_PASTE, "layout-paste",
260 N_("Paste paragraph environment type"), Noop },
261 { LFUN_LAYOUT_PREAMBLE, "layout-preamble", "", ReadOnly },
262 { LFUN_LAYOUT_TABULAR, "layout-tabular",
263 N_("Open the tabular layout"), Noop },
264 { LFUN_HOME, "line-begin",
265 N_("Go to beginning of line"), ReadOnly },
266 { LFUN_HOMESEL, "line-begin-select",
267 N_("Select to beginning of line"), ReadOnly },
268 { LFUN_DELETE_LINE_FORWARD, "line-delete-forward", "", Noop },
269 { LFUN_END, "line-end", N_("Go to end of line"), ReadOnly },
270 { LFUN_ENDSEL, "line-end-select",
271 N_("Select to end of line"), ReadOnly },
273 { LFUN_INSET_LIST, "list-insert", "", Noop },
275 { LFUN_QUIT, "lyx-quit", N_("Exit"), NoBuffer },
276 { LFUN_INSET_MARGINAL, "marginalnote-insert",
277 N_("Insert Marginalnote"), Noop },
278 { LFUN_MARK_OFF, "mark-off", "", ReadOnly },
279 { LFUN_MARK_ON, "mark-on", "", ReadOnly },
280 { LFUN_SETMARK, "mark-toggle", "", ReadOnly },
281 { LFUN_MATH, "math", "", Noop },
282 { LFUN_MATH_DELIM, "math-delim", "", Noop },
283 { LFUN_MATH_DISPLAY, "math-display", "", Noop },
284 { LFUN_GREEK, "math-greek", N_("Math Greek"), Noop },
285 { LFUN_GREEK_TOGGLE, "math-greek-toggle", "", Noop },
286 { LFUN_INSERT_MATH, "math-insert",
287 N_("Insert math symbol"), Noop },
288 { LFUN_SUBSCRIPT, "math-subscript", "", Noop },
289 { LFUN_SUPERSCRIPT, "math-superscript", "", Noop },
290 { LFUN_MATH_LIMITS, "math-limits", "", Noop },
291 { LFUN_MATH_MACRO, "math-macro", "", Noop },
292 { LFUN_MATH_MUTATE, "math-mutate", "", Noop },
293 { LFUN_MATH_SPACE, "math-space", "", Noop },
294 { LFUN_MATH_IMPORT_SELECTION, "math-import-selection", "", Noop },
295 { LFUN_INSERT_MATRIX, "math-matrix", "", Noop },
296 { LFUN_MATH_MODE, "math-mode", N_("Math mode"), Noop },
297 { LFUN_MATH_NONUMBER, "math-nonumber", "", Noop },
298 { LFUN_MATH_NUMBER, "math-number", "", Noop },
299 { LFUN_MATH_EXTERN, "math-extern", "", Noop },
300 { LFUN_MATH_VALIGN, "math-valign", "", Noop },
301 { LFUN_MATH_HALIGN, "math-halign", "", Noop },
302 { LFUN_MATH_ROW_INSERT, "math-row-insert", "", Noop },
303 { LFUN_MATH_ROW_DELETE, "math-row-delete", "", Noop },
304 { LFUN_MATH_COLUMN_INSERT, "math-column-insert", "", Noop },
305 { LFUN_MATH_COLUMN_DELETE, "math-column-delete", "", Noop },
306 { LFUN_MATH_PANEL, "math-panel", "", Noop },
307 { LFUN_MATH_SIZE, "math-size", "", Noop },
308 { LFUN_MENU_OPEN_BY_NAME, "menu-open", "", NoBuffer },
309 { LFUN_MENU_SEPARATOR, "menu-separator-insert", "", Noop },
310 { LFUN_META_FAKE, "meta-prefix", "", NoBuffer },
311 { LFUN_INSET_MINIPAGE, "minipage-insert", "", Noop },
312 { LFUN_INSERT_NOTE, "note-insert", "", Noop },
313 { LFUN_GOTONOTE, "note-next", "", ReadOnly },
314 { LFUN_INSET_TOGGLE, "inset-toggle",
315 N_("toggle inset"), ReadOnly },
316 { LFUN_DOWN_PARAGRAPH, "paragraph-down",
317 N_("Go one paragraph down"), ReadOnly },
318 { LFUN_DOWN_PARAGRAPHSEL, "paragraph-down-select",
319 N_("Select next paragraph"), ReadOnly },
320 { LFUN_GOTO_PARAGRAPH, "paragraph-goto",
321 N_("Go to paragraph"), ReadOnly },
322 { LFUN_PARAGRAPH_SPACING, "paragraph-spacing", "", Noop },
323 { LFUN_UP_PARAGRAPH, "paragraph-up",
324 N_("Go one paragraph up"), ReadOnly },
325 { LFUN_UP_PARAGRAPHSEL, "paragraph-up-select",
326 N_("Select previous paragraph"), ReadOnly },
327 { LFUN_PARENTINSERT, "parent-insert", "", Noop },
328 { LFUN_PASTE, "paste", N_("Paste") , Noop },
329 { LFUN_DIALOG_PREFERENCES, "dialog-preferences",
330 N_("Edit Preferences"), NoBuffer },
331 { LFUN_SAVEPREFERENCES, "preferences-save",
332 N_("Save Preferences"), NoBuffer },
333 { LFUN_PASTESELECTION, "primary-selection-paste", "", Noop },
334 { LFUN_PROTECTEDSPACE, "protected-space-insert",
335 N_("Insert protected space"), Noop },
336 { LFUN_QUOTE, "quote-insert", N_("Insert quote"), Noop },
337 { LFUN_RECONFIGURE, "reconfigure",
338 N_("Reconfigure"), NoBuffer },
339 { LFUN_REDO, "redo", N_("Redo"), Noop },
340 { LFUN_REF_GOTO, "reference-goto", "", ReadOnly },
341 { LFUN_REF_INSERT, "reference-insert",
342 N_("Insert cross reference"), ReadOnly },
343 { LFUN_REFERENCE_GOTO, "reference-next", "", ReadOnly },
344 { LFUN_NEXT, "screen-down", "", ReadOnly },
345 { LFUN_NEXTSEL, "screen-down-select", "", ReadOnly },
346 { LFUN_SCREEN_FONT_UPDATE, "screen-font-update",
348 { LFUN_CENTER, "screen-recenter", "", ReadOnly },
349 { LFUN_PRIOR, "screen-up", "", ReadOnly },
350 { LFUN_PRIORSEL, "screen-up-select", "", ReadOnly },
351 { LFUN_SCROLL_INSET, "inset-scroll", N_("Scroll inset"),
353 { LFUN_SELFINSERT, "self-insert", "", Noop },
354 { LFUN_CHARATCURSOR, "server-char-after", "", ReadOnly },
355 { LFUN_GETFONT, "server-get-font", "", ReadOnly },
356 { LFUN_GETLAYOUT, "server-get-layout", "", ReadOnly },
357 { LFUN_GETNAME, "server-get-name", "", ReadOnly },
358 { LFUN_GETTIP, "server-get-tip", "", ReadOnly },
359 { LFUN_GETXY, "server-get-xy", "", ReadOnly },
360 { LFUN_GOTOFILEROW, "server-goto-file-row", "", Noop },
361 { LFUN_NOTIFY, "server-notify", "", ReadOnly },
362 { LFUN_SETXY, "server-set-xy", "", ReadOnly },
363 { LFUN_SET_COLOR, "set-color", "", ReadOnly|NoBuffer },
364 { LFUN_SPELLCHECK, "spellchecker", "", Noop },
365 { LFUN_SHIFT_TAB, "tab-backward", "", Noop },
366 { LFUN_TAB, "tab-forward", "", Noop },
367 { LFUN_TABINSERT, "tab-insert", "", Noop },
368 { LFUN_TABULAR_INSERT, "tabular-insert", N_("Insert Table"), Noop },
369 { LFUN_TABULAR_FEATURE, "tabular-feature",
370 N_("Tabular Features"), Noop },
372 { LFUN_INSET_THEOREM, "theorem-insert", "", Noop },
374 { LFUN_THESAURUS_ENTRY, "thesaurus-entry", N_("Open thesaurus"), ReadOnly },
375 { LFUN_TOC_INSERT, "toc-insert",
376 N_("Insert table of contents"), Noop },
377 { LFUN_TOCVIEW, "toc-view",
378 N_("View table of contents"), ReadOnly },
379 { LFUN_TOGGLECURSORFOLLOW, "toggle-cursor-follows-scrollbar",
380 N_("Toggle cursor does/doesn't follow the scrollbar"),
382 { LFUN_UNDO, "undo", N_("Undo"), Noop },
383 { LFUN_UP, "up", "", ReadOnly },
384 { LFUN_UPSEL, "up-select", "", ReadOnly },
385 { LFUN_URL, "url-insert", "", Noop },
386 { LFUN_INSERT_URL, "", "internal only", Noop },
387 { LFUN_VC_CHECKIN, "vc-check-in", "", ReadOnly },
388 { LFUN_VC_CHECKOUT, "vc-check-out", "", ReadOnly },
389 { LFUN_VC_HISTORY, "vc-history", "", ReadOnly },
390 { LFUN_VC_REGISTER, "vc-register",
391 N_("Register document under version control"), ReadOnly },
392 { LFUN_VC_REVERT, "vc-revert", "", ReadOnly },
393 { LFUN_VC_UNDO, "vc-undo-last", "", ReadOnly },
394 { LFUN_WORDLEFT, "word-backward", "", ReadOnly },
395 { LFUN_WORDLEFTSEL, "word-backward-select", "", ReadOnly },
396 { LFUN_CAPITALIZE_WORD, "word-capitalize", "", Noop },
397 { LFUN_DELETE_WORD_BACKWARD, "word-delete-backward",
399 { LFUN_DELETE_WORD_FORWARD, "word-delete-forward", "", Noop },
400 { LFUN_WORDFINDBACKWARD, "word-find-backward", "", ReadOnly },
401 { LFUN_WORDFINDFORWARD, "word-find-forward", "", ReadOnly },
402 { LFUN_WORDRIGHT, "word-forward", "", ReadOnly },
403 { LFUN_WORDRIGHTSEL, "word-forward-select", "", ReadOnly },
404 { LFUN_LOWCASE_WORD, "word-lowcase", "", Noop },
405 { LFUN_UPCASE_WORD, "word-upcase", "", Noop },
406 { LFUN_MESSAGE, "message",
407 N_("Show message in minibuffer"), NoBuffer },
408 { LFUN_TRANSPOSE_CHARS, "chars-transpose", "", Noop },
409 { LFUN_FLOAT_LIST, "float-list", "Insert a float list", Noop },
410 { LFUN_ESCAPE, "escape", "", Noop },
411 { LFUN_HELP_ABOUTLYX, "help-aboutlyx",
412 N_("Display information about LyX"), NoBuffer },
413 { LFUN_HELP_TEXINFO, "help-Texinfo",
414 N_("Display information about the TeX installation"), NoBuffer },
415 { LFUN_FORKS_SHOW, "show-forks",
416 N_("Show the processes forked by LyX"), NoBuffer },
417 { LFUN_FORKS_KILL, "kill-forks",
418 N_("Kill the forked process with this PID"), NoBuffer },
419 { LFUN_TOOLTIPS_TOGGLE, "toggle-tooltips", "", NoBuffer },
420 { LFUN_NOACTION, "", "", Noop }
424 while (items[i].action != LFUN_NOACTION) {
425 newFunc(items[i].action,
427 _(items[i].helpText),
436 LyXAction::LyXAction()
442 // Search for an existent pseudoaction, return LFUN_UNKNOWN_ACTION
443 // if it doesn't exist.
444 int LyXAction::searchActionArg(kb_action action, string const & arg) const
446 arg_map::const_iterator pit = lyx_arg_map.find(action);
448 if (pit == lyx_arg_map.end()) {
449 // the action does not have any pseudoactions
450 lyxerr[Debug::ACTION] << "Action " << action
451 << " does not have any pseudo actions."
453 return LFUN_UNKNOWN_ACTION;
456 arg_item::const_iterator aci = pit->second.find(arg);
458 if (aci == pit->second.end()) {
459 // the action does not have any pseudoactions with this arg
460 lyxerr[Debug::ACTION]
461 << "Action " << action
462 << "does not have any pseudoactions with arg "
464 return LFUN_UNKNOWN_ACTION;
467 // pseudo action exist
468 lyxerr[Debug::ACTION] << "Pseudoaction exist["
470 << arg << "] = " << aci->second << endl;
476 // Returns a pseudo-action given an action and its argument.
477 int LyXAction::getPseudoAction(kb_action action, string const & arg) const
479 int const psdaction = searchActionArg(action, arg);
481 if (isPseudoAction(psdaction)) return psdaction;
483 static unsigned int pseudo_counter = LFUN_LASTACTION;
485 // Create new pseudo action.
487 tmp_p.action = action;
489 lyx_pseudo_map[++pseudo_counter] = tmp_p;
491 // First ensure that the action is in lyx_arg_map;
493 // get the arg_item map
494 arg_map::iterator ami = lyx_arg_map.find(action);
495 // put the new pseudo function in it
496 ami->second[arg] = pseudo_counter;
498 lyxerr[Debug::ACTION] << "Creating new pseudoaction "
499 << pseudo_counter << " for [" << action
500 << '|' << arg << "]\n";
502 return pseudo_counter;
506 // Retrieves the real action and its argument.
507 // perhaps a pair<kb_action, string> should be returned?
508 kb_action LyXAction::retrieveActionArg(int pseudo, string & arg) const
510 arg.erase(); // clear it to be sure.
512 if (!isPseudoAction(pseudo))
513 return static_cast<kb_action>(pseudo);
515 pseudo_map::const_iterator pit = lyx_pseudo_map.find(pseudo);
517 if (pit != lyx_pseudo_map.end()) {
518 lyxerr[Debug::ACTION] << "Found the pseudoaction: ["
519 << pit->second.action << '|'
520 << pit->second.arg << "]\n";
521 arg = pit->second.arg;
522 return pit->second.action;
524 lyxerr << "Lyx Error: Unrecognized pseudo-action "
526 return LFUN_UNKNOWN_ACTION;
531 // Returns an action tag from a string.
532 int LyXAction::LookupFunc(string const & func) const
534 string const func2 = trim(func);
535 if (func2.empty()) return LFUN_NOACTION;
537 // split action and arg
539 string const argstr = split(func2, actstr, ' ');
540 lyxerr[Debug::ACTION] << "Action: " << actstr << '\n';
541 lyxerr[Debug::ACTION] << "Arg : " << argstr << '\n';
543 func_map::const_iterator fit = lyx_func_map.find(actstr);
545 if (!argstr.empty() && fit != lyx_func_map.end()) {
546 // might be pseudo (or create one)
547 return getPseudoAction(fit->second, argstr);
550 return fit != lyx_func_map.end() ? fit->second : LFUN_UNKNOWN_ACTION;
554 //#ifdef WITH_WARNINGS
555 //#warning Not working as it should.
557 // I have no clue what is wrong with it... (Lgb)
558 int LyXAction::getApproxFunc(string const & func) const
559 // This func should perhaps also be able to return a list of all
560 // actions that has func as a prefix. That should actually be quite
561 // easy, just let it return a vector<int> or something.
563 int action = LookupFunc(func);
564 if (action == LFUN_UNKNOWN_ACTION) {
565 // func is not an action, but perhaps it is
566 // part of one...check if it is prefix if one of the
568 // Checking for prefix is not so simple, but
569 // using a simple bounding function gives
570 // a similar result. [ale 19981103]
571 func_map::const_iterator fit =
572 lyx_func_map.lower_bound(func);
574 if (fit != lyx_func_map.end()) {
575 action = fit->second;
577 } else { // Go get the next function
578 func_map::const_iterator fit =
579 lyx_func_map.upper_bound(func);
581 if (fit != lyx_func_map.end()) {
582 action = fit->second;
590 string const LyXAction::getApproxFuncName(string const & func) const
592 int const f = getApproxFunc(func);
593 // This will return empty string if f isn't an action.
594 return getActionName(f);
598 string const LyXAction::getActionName(int action) const
603 ac = retrieveActionArg(action, arg);
607 info_map::const_iterator iit = lyx_info_map.find(ac);
609 if (iit != lyx_info_map.end()) {
610 string ret(iit->second.name);
618 // Returns one line help associated with a (pseudo)action, i.e. appends
619 // the argument of the action if necessary
620 string const LyXAction::helpText(int pseudoaction) const
625 action = retrieveActionArg(pseudoaction, arg);
627 info_map::const_iterator ici = lyx_info_map.find(action);
628 if (ici != lyx_info_map.end()) {
629 if (lyxerr.debugging(Debug::ACTION)) {
630 lyxerr << "Action: " << action << '\n';
632 << ici->second.name << '\n';
633 lyxerr << " attrib: "
634 << ici->second.attrib << '\n';
636 << ici->second.helpText << '\n';
638 help = ici->second.helpText;
639 // if the is no help text use the name of the func instead.
640 if (help.empty()) help = ici->second.name;
644 help = _("No description available!");
645 } else if (!arg.empty()) {
654 bool LyXAction::funcHasFlag(kb_action action,
655 LyXAction::func_attrib flag) const
657 info_map::const_iterator ici = lyx_info_map.find(action);
659 if (ici != lyx_info_map.end()) {
660 return ici->second.attrib & flag;
662 // it really should exist, but...
663 lyxerr << "LyXAction::funcHasFlag: "
664 "No info about kb_action: " << action << '\n';
670 LyXAction::const_func_iterator LyXAction::func_begin() const
672 return lyx_func_map.begin();
676 LyXAction::const_func_iterator LyXAction::func_end() const
678 return lyx_func_map.end();
682 ostream & operator<<(ostream & o, kb_action action)
684 return o << int(action);