1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-1999 The LyX Team.
9 * ====================================================== */
14 #pragma implementation
17 #include "LyXAction.h"
20 #include "support/lstrings.h"
23 NAMING RULES FOR USER-COMMANDS
24 Here's the set of rules to apply when a new command name is introduced:
26 1) Use the object.event order. That is, use `word-forward'
27 instead of `forward-word'.
28 2) Don't introduce an alias for an already named object. Same for events.
29 3) Forward movement or focus is called `forward' (not `right').
30 4) Backward movement or focus is called `backward' (not `left').
31 5) Upward movement of focus is called `up'.
32 6) Downward movement is called `down'.
33 7) The begin of an object is called `begin' (not `start').
34 8) The end of an object is called `end'.
36 (May 19 1996, 12:04, RvdK)
43 void LyXAction::newFunc(kb_action action, string const & name,
44 string const & helpText, unsigned int attrib)
46 lyx_func_map[name] = action;
49 tmpinfo.attrib = attrib;
50 tmpinfo.helpText = helpText;
51 lyx_info_map[action] = tmpinfo;
58 char const * helpText;
62 void LyXAction::init()
64 // This function was changed to use the array below in initalization
65 // instead of calling newFunc numerous times because of compilation
66 // times. Since the array is not static we get back the memory it
67 // occupies after the init is completed. It compiles several
70 static bool init = false;
74 { LFUN_ACUTE, "accent-acute", "", Noop },
75 { LFUN_BREVE, "accent-breve", "", Noop },
76 { LFUN_CARON, "accent-caron", "", Noop },
77 { LFUN_CEDILLA, "accent-cedilla", "", Noop },
78 { LFUN_CIRCLE, "accent-circle", "", Noop },
79 { LFUN_CIRCUMFLEX, "accent-circumflex", "", Noop },
80 { LFUN_DOT, "accent-dot", "", Noop },
81 { LFUN_GRAVE, "accent-grave", "", Noop },
82 { LFUN_HUNG_UMLAUT, "accent-hungarian-umlaut", "", Noop },
83 { LFUN_MACRON, "accent-macron", "", Noop },
84 { LFUN_OGONEK, "accent-ogonek", "", Noop },
85 { LFUN_SPECIAL_CARON, "accent-special-caron", "", Noop },
86 { LFUN_TIE, "accent-tie", "", Noop },
87 { LFUN_TILDE, "accent-tilde", "", Noop },
88 { LFUN_UMLAUT, "accent-umlaut", "", Noop },
89 { LFUN_UNDERBAR, "accent-underbar", "", Noop },
90 { LFUN_UNDERDOT, "accent-underdot", "", Noop },
91 { LFUN_VECTOR, "accent-vector", "", Noop },
92 { LFUN_APPENDIX, "appendix", N_("Insert appendix"), Noop },
93 { LFUN_APROPOS, "apropos", N_("Describe command"),
95 { LFUN_LEFTSEL, "backward-select",
96 N_("Select previous char"), ReadOnly },
97 { LFUN_BIBDB_ADD, "bibtex-database-add", "", Noop },
98 { LFUN_BIBDB_DEL, "bibtex-database-del", "", Noop },
99 { LFUN_INSERT_BIBTEX, "bibtex-insert", N_("Insert bibtex"),
101 { LFUN_BIBTEX_STYLE, "bibtex-style", "", Noop },
102 { LFUN_BREAKLINE, "break-line", "", Noop },
103 { LFUN_BREAKPARAGRAPH, "break-paragraph", "", Noop },
104 { LFUN_BREAKPARAGRAPHKEEPLAYOUT, "break-paragraph-keep-layout",
106 { LFUN_BREAKPARAGRAPH_SKIP, "break-paragraph-skip", "", Noop },
107 { LFUN_BUILDPROG, "build-program", _("Build program"), Noop },
108 { LFUN_AUTOSAVE, "buffer-auto-save", N_("Autosave"), Noop },
109 { LFUN_BEGINNINGBUF, "buffer-begin",
110 N_("Go to beginning of document"), ReadOnly },
111 { LFUN_BEGINNINGBUFSEL, "buffer-begin-select",
112 N_("Select to beginning of document"), ReadOnly },
113 { LFUN_CHILDINSERT, "buffer-child-insert", "", Noop },
114 { LFUN_CHILDOPEN, "buffer-child-open", "", ReadOnly },
115 { LFUN_RUNCHKTEX, "buffer-chktex", N_("Check TeX"), ReadOnly },
116 { LFUN_CLOSEBUFFER, "buffer-close", N_("Close"), ReadOnly },
117 { LFUN_ENDBUF, "buffer-end",
118 N_("Go to end of document"), ReadOnly },
119 { LFUN_ENDBUFSEL, "buffer-end-select",
120 N_("Select to end of document"), ReadOnly },
121 { LFUN_EXPORT, "buffer-export", N_("Export to"), ReadOnly },
122 { LFUN_FAX, "buffer-fax", N_("Fax"), ReadOnly },
123 { LFUN_INSERTFOOTNOTE, "buffer-float-insert", "", Noop },
124 { LFUN_IMPORT, "buffer-import",
125 N_("Import document"), NoBuffer },
126 { LFUN_BUFFERBULLETSSELECT, "buffer-itemize-bullets-select",
128 { LFUN_MENUNEW, "buffer-new", N_("New document") , NoBuffer },
129 { LFUN_MENUNEWTMPLT,"buffer-new-template",
130 N_("New document from template"), NoBuffer },
131 { LFUN_MENUOPEN, "buffer-open", N_("Open"), NoBuffer },
132 { LFUN_PREVBUFFER, "buffer-previous",
133 N_("Switch to previous document"), ReadOnly },
134 { LFUN_MENUPRINT, "buffer-print", N_("Print"), ReadOnly },
135 { LFUN_MENURELOAD, "buffer-reload",
136 N_("Revert to saved"), ReadOnly },
137 { LFUN_READ_ONLY_TOGGLE, "buffer-toggle-read-only",
138 N_("Toggle read-only"), ReadOnly },
139 { LFUN_RUNLATEX, "buffer-typeset", N_("Update DVI"),
141 { LFUN_RUNDVIPS, "buffer-typeset-ps",
142 N_("Update PostScript"), ReadOnly },
143 { LFUN_PREVIEW, "buffer-view", N_("View DVI") , ReadOnly },
144 { LFUN_PREVIEWPS, "buffer-view-ps",
145 N_("View PostScript") , ReadOnly },
146 { LFUN_MENUWRITE, "buffer-write", N_("Save"), ReadOnly },
147 { LFUN_MENUWRITEAS, "buffer-write-as", N_("Save As"),
149 { LFUN_CANCEL, "cancel", N_("Cancel"), NoBuffer },
150 { LFUN_LEFT, "char-backward", N_("Go one char back"),
152 { LFUN_RIGHT, "char-forward", N_("Go one char forward"),
154 { LFUN_INSERT_CITATION, "citation-insert",
155 N_("Insert citation"), Noop },
156 { LFUN_EXEC_COMMAND, "command-execute", "", NoBuffer },
157 { LFUN_PREFIX, "command-prefix",
158 N_("Execute command"), NoBuffer },
159 { LFUN_SEQUENCE, "command-sequence", "", Noop },
160 { LFUN_COPY, "copy", N_("Copy"), ReadOnly },
161 { LFUN_CUT, "cut", N_("Cut"), Noop },
162 { LFUN_BACKSPACE, "delete-backward", "", Noop },
163 { LFUN_BACKSPACE_SKIP, "delete-backward-skip", "", Noop },
164 { LFUN_DELETE, "delete-forward", "", Noop },
165 { LFUN_DELETE_SKIP, "delete-forward-skip", "", Noop },
166 { LFUN_DEPTH_MIN, "depth-decrement",
167 N_("Decrement environment depth"), Noop },
168 { LFUN_DEPTH_PLUS, "depth-increment",
169 N_("Increment environment depth"), Noop },
170 { LFUN_DEPTH, "depth-next",
171 N_("Change environment depth"), Noop },
172 { LFUN_LDOTS, "dots-insert", N_("Insert ... dots"), Noop },
173 { LFUN_DOWN, "down", N_("Go down"), ReadOnly },
174 { LFUN_DOWNSEL, "down-select",
175 N_("Select next line"), ReadOnly },
176 { LFUN_DROP_LAYOUTS_CHOICE, "drop-layouts-choice",
177 N_("Choose Paragraph Environment"), ReadOnly },
178 { LFUN_END_OF_SENTENCE, "end-of-sentence-period-insert",
179 N_("Insert end of sentence period"), Noop },
180 { LFUN_GOTOERROR, "error-next", N_("Go to next error"), Noop },
181 { LFUN_REMOVEERRORS, "error-remove-all",
182 N_("Remove all error boxes"), ReadOnly },
183 { LFUN_FIGURE, "figure-insert", N_("Insert Figure"), Noop },
184 { LFUN_FILE_INSERT, "file-insert", "", Noop },
185 { LFUN_FILE_INSERT_ASCII, "file-insert-ascii", "", Noop },
186 { LFUN_FILE_NEW, "file-new", "", NoBuffer },
187 { LFUN_FILE_OPEN, "file-open", "", NoBuffer },
188 { LFUN_MENUSEARCH, "find-replace", N_("Find & Replace"),
190 { LFUN_BOLD, "font-bold", N_("Toggle bold"), Noop },
191 { LFUN_CODE, "font-code", N_("Toggle code style"), Noop },
192 { LFUN_DEFAULT, "font-default", N_("Default font style"),
194 { LFUN_EMPH, "font-emph", N_("Toggle emphasize"), Noop },
195 { LFUN_FREE, "font-free", N_("Toggle user defined style"),
197 { LFUN_NOUN, "font-noun", N_("Toggle noun style"), Noop },
198 { LFUN_ROMAN, "font-roman", N_("Toggle roman font style"),
200 { LFUN_SANS, "font-sans", N_("Toggle sans font style"), Noop },
201 { LFUN_FONT_SIZE, "font-size", N_("Set font size"), Noop },
202 { LFUN_FONT_STATE, "font-state", N_("Show font state"),
204 { LFUN_UNDERLINE, "font-underline",
205 N_("Toggle font underline"), Noop },
206 { LFUN_FOOTMELT, "footnote-insert", N_("Insert Footnote"),
208 { LFUN_RIGHTSEL, "forward-select", N_("Select next char"),
210 { LFUN_HFILL, "hfill-insert",
211 N_("Insert horizontal fill"), Noop },
212 { LFUN_HTMLURL, "html-insert", "", Noop },
213 { LFUN_HYPHENATION, "hyphenation-point-insert",
214 N_("Insert hyphenation point"), Noop },
215 { LFUN_INDEX_INSERT, "index-insert",
216 N_("Insert index item"), Noop },
217 { LFUN_INDEX_INSERT_LAST, "index-insert-last",
218 N_("Insert last index item"), Noop },
219 { LFUN_INDEX_PRINT, "index-print", N_("Insert index list"),
221 { LFUN_KMAP_OFF, "keymap-off", N_("Turn off keymap"),
223 { LFUN_KMAP_PRIM, "keymap-primary",
224 N_("Use primary keymap"), ReadOnly },
225 { LFUN_KMAP_SEC, "keymap-secondary",
226 N_("Use secondary keymap"), ReadOnly },
227 { LFUN_KMAP_TOGGLE, "keymap-toggle", N_("Toggle keymap"),
229 { LFUN_INSERT_LABEL, "label-insert", N_("Insert Label"),
231 { LFUN_LATEX_LOG, "latex-view-log", N_("View LaTeX log"),
233 { LFUN_LAYOUT, "layout", "", Noop },
234 { LFUN_LAYOUT_CHARACTER, "layout-character", "", Noop },
235 { LFUN_LAYOUT_COPY, "layout-copy",
236 N_("Copy paragraph environment type"), Noop },
237 { LFUN_LAYOUT_DOCUMENT, "layout-document", "", ReadOnly },
238 { LFUN_LAYOUTNO, "layout-number", "", Noop }, // internal only
239 { LFUN_LAYOUT_PARAGRAPH, "layout-paragraph", "", ReadOnly },
240 { LFUN_LAYOUT_PAPER, "layout-paper", "", ReadOnly },
241 { LFUN_LAYOUT_PASTE, "layout-paste",
242 N_("Paste paragraph environment type"), Noop },
243 { LFUN_LAYOUT_PREAMBLE, "layout-preamble", "", ReadOnly },
244 { LFUN_LAYOUT_QUOTES, "layout-quotes", "", ReadOnly },
245 { LFUN_LAYOUT_SAVE_DEFAULT, "layout-save-default", "",
247 { LFUN_LAYOUT_TABLE, "layout-table", "", Noop },
248 { LFUN_HOME, "line-begin",
249 N_("Go to beginning of line"), ReadOnly },
250 { LFUN_HOMESEL, "line-begin-select",
251 N_("Select to beginning of line"), ReadOnly },
252 { LFUN_DELETE_LINE_FORWARD, "line-delete-forward", "", Noop },
253 { LFUN_END, "line-end", N_("Go to end of line"), ReadOnly },
254 { LFUN_ENDSEL, "line-end-select",
255 N_("Select to end of line"), ReadOnly },
256 { LFUN_LOA_INSERT, "loa-insert",
257 N_("Insert list of algorithms"), Noop },
258 { LFUN_LOF_INSERT, "lof-insert",
259 N_("Insert list of figures"), Noop },
260 { LFUN_LOT_INSERT, "lot-insert",
261 N_("Insert list of tables"), Noop },
262 { LFUN_QUIT, "lyx-quit", N_("Exit"), NoBuffer },
263 { LFUN_MARGINMELT, "marginpar-insert",
264 N_("Insert Margin note"), Noop },
265 { LFUN_MARK_OFF, "mark-off", "", ReadOnly },
266 { LFUN_MARK_ON, "mark-on", "", ReadOnly },
267 { LFUN_SETMARK, "mark-toggle", "", ReadOnly },
268 { LFUN_MATH_DELIM, "math-delim", "", Noop },
269 { LFUN_MATH_DISPLAY, "math-display", "", Noop },
270 { LFUN_GREEK, "math-greek", N_("Math Greek"), Noop },
271 { LFUN_GREEK_TOGGLE, "math-greek-toggle", "", Noop },
272 { LFUN_INSERT_MATH, "math-insert",
273 N_("Insert math symbol"), Noop },
274 { LFUN_MATH_LIMITS, "math-limits", "", Noop },
275 { LFUN_MATH_MACRO, "math-macro", "", Noop },
276 { LFUN_MATH_MACROARG, "math-macro-arg", "", Noop },
277 { LFUN_INSERT_MATRIX, "math-matrix", "", Noop },
278 { LFUN_MATH_MODE, "math-mode", N_("Math mode"), Noop },
279 { LFUN_MATH_NONUMBER, "math-nonumber", "", Noop },
280 { LFUN_MATH_NUMBER, "math-number", "", Noop },
281 { LFUN_MATH_SIZE, "math-size", "", Noop },
282 { LFUN_MELT, "melt", N_("Melt"), Noop },
283 { LFUN_MENU_OPEN_BY_NAME, "menu-open", "", NoBuffer },
284 { LFUN_MENU_SEPARATOR, "menu-separator-insert", "", Noop },
285 { LFUN_META_FAKE, "meta-prefix", "", NoBuffer },
286 { LFUN_INSERT_NOTE, "note-insert", "", Noop },
287 { LFUN_GOTONOTE, "note-next", "", ReadOnly },
288 { LFUN_OPENSTUFF, "open-stuff", "", ReadOnly },
289 { LFUN_DOWN_PARAGRAPH, "paragraph-down",
290 N_("Go one paragraph down"), ReadOnly },
291 { LFUN_DOWN_PARAGRAPHSEL, "paragraph-down-select",
292 N_("Select next paragraph"), ReadOnly },
293 { LFUN_UP_PARAGRAPH, "paragraph-up",
294 N_("Go one paragraph up"), ReadOnly },
295 { LFUN_UP_PARAGRAPHSEL, "paragraph-up-select",
296 N_("Select previous paragraph"), ReadOnly },
297 { LFUN_PARENTINSERT, "parent-insert", "", Noop },
298 { LFUN_PASTE, "paste", N_("Paste") , Noop },
299 { LFUN_SAVEPREFERENCES, "preferences-save",
300 "Save Preferences", NoBuffer },
301 { LFUN_PASTESELECTION, "primary-selection-paste", "", Noop },
302 { LFUN_PROTECTEDSPACE, "protected-space-insert",
303 N_("Insert protected space"), Noop },
304 { LFUN_QUOTE, "quote-insert", N_("Insert quote"), Noop },
305 { LFUN_RECONFIGURE, "reconfigure",
306 N_("Reconfigure"), NoBuffer },
307 { LFUN_REDO, "redo", N_("Redo"), Noop },
308 { LFUN_REFBACK, "reference-back", "", ReadOnly },
309 { LFUN_REFGOTO, "reference-goto", "", ReadOnly },
310 { LFUN_INSERT_REF, "reference-insert",
311 N_("Insert cross reference"), Noop },
312 { LFUN_REFTOGGLE, "reference-toggle", "", Noop },
313 { LFUN_NEXT, "screen-down", "", ReadOnly },
314 { LFUN_NEXTSEL, "screen-down-select", "", ReadOnly },
315 { LFUN_CENTER, "screen-recenter", "", ReadOnly },
316 { LFUN_PRIOR, "screen-up", "", ReadOnly },
317 { LFUN_PRIORSEL, "screen-up-select", "", ReadOnly },
318 { LFUN_SELFINSERT, "self-insert", "", Noop },
319 { LFUN_CHARATCURSOR, "server-char-after", "", ReadOnly },
320 { LFUN_GETFONT, "server-get-font", "", ReadOnly },
321 { LFUN_GETLATEX, "server-get-latex", "", ReadOnly },
322 { LFUN_GETLAYOUT, "server-get-layout", "", ReadOnly },
323 { LFUN_GETNAME, "server-get-name", "", ReadOnly },
324 { LFUN_GETTIP, "server-get-tip", "", ReadOnly },
325 { LFUN_GETXY, "server-get-xy", "", ReadOnly },
326 { LFUN_GOTOFILEROW, "server-goto-file-row", "", Noop },
327 { LFUN_NOTIFY, "server-notify", "", ReadOnly },
328 { LFUN_SETXY, "server-set-xy", "", ReadOnly },
329 { LFUN_SPELLCHECK, "spellchecker", "", Noop },
330 { LFUN_INSERT_MATH, "symbol-insert", "", Noop },
331 { LFUN_TAB, "tab-forward", "", Noop },
332 { LFUN_TABINSERT, "tab-insert", "", Noop },
333 { LFUN_TABLE, "table-insert", N_("Insert Table"), Noop },
334 { LFUN_TEX, "tex-mode", N_("Toggle TeX style"), Noop },
335 { LFUN_TOC_INSERT, "toc-insert",
336 N_("Insert table of contents"), Noop },
337 { LFUN_TOCVIEW, "toc-view",
338 N_("View table of contents"), ReadOnly },
339 { LFUN_TOGGLECURSORFOLLOW, "toggle-cursor-follows-scrollbar",
340 N_("Toggle cursor does/doesn't follow the scrollbar"),
342 { LFUN_ADD_TO_TOOLBAR, "toolbar-add-to", "", NoBuffer },
343 { LFUN_PUSH_TOOLBAR, "toolbar-push", "", NoBuffer },
344 { LFUN_UNDO, "undo", N_("Undo"), Noop },
345 { LFUN_UP, "up", "", ReadOnly },
346 { LFUN_UPSEL, "up-select", "", ReadOnly },
347 { LFUN_URL, "url-insert", "", Noop },
348 { LFUN_VC_CHECKIN, "vc-check-in", "", ReadOnly },
349 { LFUN_VC_CHECKOUT, "vc-check-out", "", ReadOnly },
350 { LFUN_VC_HISTORY, "vc-history", "", ReadOnly },
351 { LFUN_VC_REGISTER, "vc-register",
352 N_("Register document under version control"), ReadOnly },
353 { LFUN_VC_REVERT, "vc-revert", "", ReadOnly },
354 { LFUN_VC_UNDO, "vc-undo-last", "", ReadOnly },
355 { LFUN_WORDLEFT, "word-backward", "", ReadOnly },
356 { LFUN_WORDLEFTSEL, "word-backward-select", "", ReadOnly },
357 { LFUN_CAPITALIZE_WORD, "word-capitalize", "", Noop },
358 { LFUN_DELETE_WORD_BACKWARD, "word-delete-backward",
360 { LFUN_DELETE_WORD_FORWARD, "word-delete-forward", "", Noop },
361 { LFUN_WORDFINDBACKWARD, "word-find-backward", "", ReadOnly },
362 { LFUN_WORDFINDFORWARD, "word-find-forward", "", ReadOnly },
363 { LFUN_WORDRIGHT, "word-forward", "", ReadOnly },
364 { LFUN_WORDRIGHTSEL, "word-forward-select", "", ReadOnly },
365 { LFUN_LOWCASE_WORD, "word-lowcase", "", Noop },
366 { LFUN_UPCASE_WORD, "word-upcase", "", Noop },
367 { LFUN_NOACTION, "", "", Noop }
371 while (items[i].action != LFUN_NOACTION) {
372 newFunc(items[i].action,
374 _(items[i].helpText),
383 LyXAction::LyXAction()
389 // Search for an existent pseudoaction, return LFUN_UNKNOWN_ACTION
390 // if it doesn't exist.
391 int LyXAction::searchActionArg(kb_action action, string const & arg) const
393 arg_map::const_iterator pit = lyx_arg_map.find(action);
395 if (pit == lyx_arg_map.end()) {
396 // the action does not have any pseudoactions
397 lyxerr[Debug::ACTION] << "Action " << action
398 << " does not have any pseudo actions."
400 return LFUN_UNKNOWN_ACTION;
403 arg_item::const_iterator aci = (*pit).second.find(arg);
405 if (aci == (*pit).second.end()) {
406 // the action does not have any pseudoactions with this arg
407 lyxerr[Debug::ACTION]
408 << "Action " << action
409 << "does not have any pseudoactions with arg "
411 return LFUN_UNKNOWN_ACTION;
414 // pseudo action exist
415 lyxerr[Debug::ACTION] << "Pseudoaction exist["
417 << arg << "] = " << (*aci).second << endl;
419 return (*aci).second;
423 // Returns a pseudo-action given an action and its argument.
424 int LyXAction::getPseudoAction(kb_action action, string const & arg) const
426 int psdaction = searchActionArg(action, arg);
428 if (isPseudoAction(psdaction)) return psdaction;
430 static unsigned int pseudo_counter = LFUN_LASTACTION;
432 // Create new pseudo action.
434 tmp_p.action = action;
436 lyx_pseudo_map[++pseudo_counter] = tmp_p;
438 // First ensure that the action is in lyx_arg_map;
440 // get the arg_item map
441 arg_map::iterator ami = lyx_arg_map.find(action);
442 // put the new pseudo function in it
443 (*ami).second[arg] = pseudo_counter;
445 lyxerr[Debug::ACTION] << "Creating new pseudoaction "
446 << pseudo_counter << " for [" << action
447 << '|' << arg << "]\n";
449 return pseudo_counter;
453 // Retrieves the real action and its argument.
454 // perhaps a pair<kb_action, string> should be returned?
455 kb_action LyXAction::retrieveActionArg(int pseudo, string & arg) const
457 pseudo_map::const_iterator pit = lyx_pseudo_map.find(pseudo);
459 if (pit != lyx_pseudo_map.end()) {
460 lyxerr[Debug::ACTION] << "Found the pseudoaction: ["
461 << (*pit).second.action << '|'
462 << (*pit).second.arg << '\n';
463 arg = (*pit).second.arg;
464 return (*pit).second.action;
466 lyxerr << "Lyx Error: Unrecognized pseudo-action\n";
467 return LFUN_UNKNOWN_ACTION;
473 // Returns an action tag from a string.
474 int LyXAction::LookupFunc(string const & func) const
476 if (func.empty()) return LFUN_NOACTION;
478 // split action and arg
480 string argstr = split(func, actstr, ' ');
481 lyxerr[Debug::ACTION] << "Action: " << actstr << '\n';
482 lyxerr[Debug::ACTION] << "Arg : " << argstr << '\n';
484 func_map::const_iterator fit = lyx_func_map.find(actstr);
486 if (!argstr.empty() && fit != lyx_func_map.end()) {
487 // might be pseudo (or create one)
488 return getPseudoAction((*fit).second, argstr);
491 return fit != lyx_func_map.end() ? (*fit).second : LFUN_UNKNOWN_ACTION;
496 #warning Not working as it should.
498 int LyXAction::getApproxFunc(string const & func) const
499 // This func should perhaps also be able to return a list of all
500 // actions that has func as a prefix. That should actually be quite
501 // easy, just let it return a vector<int> or something.
503 int action = LookupFunc(func);
504 if (action == LFUN_UNKNOWN_ACTION) {
505 // func is not an action, but perhaps it is
506 // part of one...check if it is prefix if one of the
508 // Checking for prefix is not so simple, but
509 // using a simple bounding function gives
510 // a similar result. [ale 19981103]
511 func_map::const_iterator fit =
512 lyx_func_map.lower_bound(func);
514 if (fit != lyx_func_map.end()) {
515 action = (*fit).second;
517 } else { // Go get the next function
518 func_map::const_iterator fit =
519 lyx_func_map.upper_bound(func);
521 if (fit != lyx_func_map.end()) {
522 action = (*fit).second;
530 string LyXAction::getApproxFuncName(string const & func) const
532 int f = getApproxFunc(func);
533 // This will return empty string if f isn't an action.
534 return getActionName(f);
538 string LyXAction::getActionName(int action) const
540 info_map::const_iterator iit =
541 lyx_info_map.find(static_cast<kb_action>(action));
543 return iit != lyx_info_map.end() ? (*iit).second.name : string();
547 // Returns one line help associated with a (pseudo)action, i.e. appends
548 // the argument of the action if necessary
549 string LyXAction::helpText(int pseudoaction) const
554 if (isPseudoAction(pseudoaction))
555 action = retrieveActionArg(pseudoaction, arg);
557 action = static_cast<kb_action>(pseudoaction);
559 info_map::const_iterator ici = lyx_info_map.find(action);
560 if (ici != lyx_info_map.end()) {
561 if (lyxerr.debugging(Debug::ACTION)) {
562 lyxerr << "Action: " << action << '\n';
564 << (*ici).second.name << '\n';
565 lyxerr << " attrib: "
566 << (*ici).second.attrib << '\n';
568 << (*ici).second.helpText << '\n';
570 help = (*ici).second.helpText;
571 // if the is no help text use the name of the func instead.
572 if (help.empty()) help = (*ici).second.name;
576 help = _("No description available!");
577 } else if (!arg.empty()) {
586 bool LyXAction::funcHasFlag(kb_action action,
587 LyXAction::func_attrib flag) const
589 info_map::const_iterator ici = lyx_info_map.find(action);
591 if (ici != lyx_info_map.end()) {
592 return (*ici).second.attrib & flag;
594 // it really should exist, but...
595 lyxerr << "No info about kb_action: " << action << '\n';
602 ostream & operator<<(ostream & o, kb_action action)
604 return o << int(action);