]> git.lyx.org Git - lyx.git/blob - src/lyxfunc.C
fix typo that put too many include paths for most people
[lyx.git] / src / lyxfunc.C
1 /* This file is part of
2  * ======================================================
3  *
4  *           LyX, The Document Processor
5  *
6  *          Copyright 1995 Matthias Ettrich
7  *          Copyright 1995-2001 The LyX Team.
8  *
9  * ====================================================== */
10
11 #include <config.h>
12
13 #ifdef __GNUG__
14 #pragma implementation
15 #endif
16
17 #include "lyxfunc.h"
18 #include "version.h"
19 #include "kbmap.h"
20 #include "lyxrow.h"
21 #include "bufferlist.h"
22 #include "BufferView.h"
23 #include "ColorHandler.h"
24 #include "lyxserver.h"
25 #include "intl.h"
26 #include "lyx_main.h"
27 #include "lyx_cb.h"
28 #include "LyXAction.h"
29 #include "debug.h"
30 #include "lyxrc.h"
31 #include "lyxtext.h"
32 #include "gettext.h"
33 #include "Lsstream.h"
34 #include "trans_mgr.h"
35 #include "layout.h"
36 #include "bufferview_funcs.h"
37 #include "minibuffer.h"
38 #include "vspace.h"
39 #include "LyXView.h"
40 #include "FloatList.h"
41 #include "converter.h"
42 #include "exporter.h"
43 #include "importer.h"
44 #include "FontLoader.h"
45 #include "TextCache.h"
46 #include "lyxfind.h"
47 #include "undo_funcs.h"
48 #include "ParagraphParameters.h"
49
50 #include "insets/inseturl.h"
51 #include "insets/insetlatexaccent.h"
52 #include "insets/insettoc.h"
53 #include "insets/insetref.h"
54 #include "insets/insetparent.h"
55 #include "insets/insetindex.h"
56 #include "insets/insetinclude.h"
57 #include "insets/insetbib.h"
58 #include "insets/insetcite.h"
59 #include "insets/insettext.h"
60 #include "insets/insetert.h"
61 #include "insets/insetexternal.h"
62 #include "insets/insetgraphics.h"
63 #include "insets/insetfoot.h"
64 #include "insets/insetmarginal.h"
65 #include "insets/insetminipage.h"
66 #include "insets/insetfloat.h"
67 #if 0
68 #include "insets/insetlist.h"
69 #include "insets/insettheorem.h"
70 #endif
71 #include "insets/insettabular.h"
72 #include "insets/insetcaption.h"
73
74 #include "mathed/formulamacro.h"
75 #include "mathed/math_cursor.h"
76 #include "mathed/math_inset.h"
77
78 #include "frontends/FileDialog.h"
79 #include "frontends/Dialogs.h"
80 #include "frontends/Toolbar.h"
81 #include "frontends/Menubar.h"
82 #include "frontends/Alert.h"
83
84 #include "graphics/GraphicsCache.h"
85
86 #include "support/lyxalgo.h"
87 #include "support/LAssert.h"
88 #include "support/filetools.h"
89 #include "support/FileInfo.h"
90 #include "support/forkedcontr.h"
91 #include "support/lstrings.h"
92 #include "support/path.h"
93 #include "support/lyxfunctional.h"
94
95 #include <ctime>
96 #include <clocale>
97 #include <cstdlib>
98 #include <cctype>
99
100 #include <utility>
101 #include <algorithm>
102
103
104 using std::pair;
105 using std::make_pair;
106 using std::endl;
107 using std::find_if;
108 using std::vector;
109 using std::transform;
110 using std::back_inserter;
111
112 extern BufferList bufferlist;
113 extern LyXServer * lyxserver;
114 extern bool selection_possible;
115
116 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
117
118 extern void show_symbols_form(LyXFunc *);
119
120 extern LyXAction lyxaction;
121 // (alkis)
122 extern tex_accent_struct get_accent(kb_action action);
123
124 extern void ShowLatexLog();
125
126
127 #if 0
128
129 ///
130 class MiniBufferController : public SigC::Object {
131 public:
132         ///
133         MiniBufferController() {
134                 minibuffer
135                         .cmdReady
136                         .connect(slot(this,
137                                       &MiniBufferController::receiveCommand));
138                 minibuffer
139                         .argReady
140                         .connect(slot(this,
141                                       &MiniBufferController::receiveArg));
142         }
143         ///
144         void receiveCmd(string const & cmd) {}
145         ///
146         void receiveArg(string const & arg) {}
147
148
149 private:
150 };
151
152 namespace {
153
154 MiniBufferController mb_ctrl;
155
156 }
157 #endif
158
159
160 /* === globals =========================================================== */
161
162
163 LyXFunc::LyXFunc(LyXView * o)
164         : owner(o),
165         keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
166         cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get())
167 {
168         meta_fake_bit = 0;
169         lyx_dead_action = LFUN_NOACTION;
170         lyx_calling_dead_action = LFUN_NOACTION;
171 }
172
173
174 inline
175 LyXText * LyXFunc::TEXT(bool flag = true) const
176 {
177         if (flag)
178                 return owner->view()->text;
179         return owner->view()->getLyXText();
180 }
181
182
183 // I changed this func slightly. I commented out the ...FinishUndo(),
184 // this means that all places that used to have a moveCursorUpdate, now
185 // have a ...FinishUndo() as the preceeding statement. I have also added
186 // a moveCursorUpdate to some of the functions that updated the cursor, but
187 // that did not show its new position.
188 inline
189 void LyXFunc::moveCursorUpdate(bool flag, bool selecting)
190 {
191         if (selecting || TEXT(flag)->selection.mark()) {
192                 TEXT(flag)->setSelection(owner->view());
193                 if (TEXT(flag)->bv_owner)
194                     owner->view()->toggleToggle();
195         }
196         owner->view()->update(TEXT(flag), BufferView::SELECT|BufferView::FITCUR);
197         owner->view()->showCursor();
198
199         /* ---> Everytime the cursor is moved, show the current font state. */
200         // should this too me moved out of this func?
201         owner->view()->setState();
202 }
203
204
205 void LyXFunc::handleKeyFunc(kb_action action)
206 {
207         char c = keyseq.getiso();
208
209         if (keyseq.length() > 1) {
210                 c = 0;
211         }
212
213         owner->getIntl()->getTrans()
214                 .deadkey(c, get_accent(action).accent, TEXT(false));
215         // Need to clear, in case the minibuffer calls these
216         // actions
217         keyseq.clear();
218         // copied verbatim from do_accent_char
219         owner->view()->update(TEXT(false),
220                BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
221         TEXT(false)->selection.cursor = TEXT(false)->cursor;
222 }
223
224
225 void LyXFunc::processKeySym(KeySym keysym, unsigned int state)
226 {
227         string argument;
228
229         if (lyxerr.debugging(Debug::KEY)) {
230                 char const * tmp = XKeysymToString(keysym);
231                 string const stm = (tmp ? tmp : "");
232                 lyxerr << "KeySym is "
233                        << stm
234                        << "["
235                        << keysym << "] State is ["
236                        << state << "]"
237                        << endl;
238         }
239         // Do nothing if we have nothing (JMarc)
240         if (keysym == NoSymbol) {
241                 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
242                                    << endl;
243                 return;
244         }
245
246         // Can we be sure that this will work for all X Window
247         // implementations? (Lgb)
248         // This code snippet makes lyx ignore some keys. Perhaps
249         // all of them should be explictly mentioned?
250         if ((keysym >= XK_Shift_L && keysym <= XK_Hyper_R)
251             || keysym == XK_Mode_switch || keysym == 0x0) {
252                 return;
253         }
254
255         // Do a one-deep top-level lookup for
256         // cancel and meta-fake keys. RVDK_PATCH_5
257         cancel_meta_seq.reset();
258
259         int action = cancel_meta_seq.addkey(keysym, state
260                                             &(ShiftMask|ControlMask
261                                               |Mod1Mask));
262         if (lyxerr.debugging(Debug::KEY)) {
263                 lyxerr << "action first set to [" << action << "]" << endl;
264         }
265
266         // When not cancel or meta-fake, do the normal lookup.
267         // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
268         // Mostly, meta_fake_bit = 0. RVDK_PATCH_5.
269         if ((action != LFUN_CANCEL) && (action != LFUN_META_FAKE)) {
270                 if (lyxerr.debugging(Debug::KEY)) {
271                         lyxerr << "meta_fake_bit is ["
272                                << meta_fake_bit << "]" << endl;
273                 }
274                 // remove Caps Lock and Mod2 as a modifiers
275                 action = keyseq.addkey(keysym,
276                                        (state | meta_fake_bit)
277                                        &(ShiftMask|ControlMask
278                                          |Mod1Mask));
279                 if (lyxerr.debugging(Debug::KEY)) {
280                         lyxerr << "action now set to ["
281                                << action << "]" << endl;
282                 }
283         }
284         // Dont remove this unless you know what you are doing.
285         meta_fake_bit = 0;
286
287         // can this happen now ?
288         if (action == LFUN_NOACTION) {
289                 action = LFUN_PREFIX;
290         }
291
292         if (lyxerr.debugging(Debug::KEY)) {
293                 lyxerr << "Key [action="
294                        << action << "]["
295                        << keyseq.print() << "]"
296                        << endl;
297         }
298
299         // already here we know if it any point in going further
300         // why not return already here if action == -1 and
301         // num_bytes == 0? (Lgb)
302
303         if (keyseq.length() > 1) {
304                 owner->message(keyseq.print());
305         }
306
307         if (action == LFUN_UNKNOWN_ACTION) {
308                 // It is unknown, but what if we remove all
309                 // the modifiers? (Lgb)
310                 action = keyseq.addkey(keysym, 0);
311
312                 if (lyxerr.debugging(Debug::KEY)) {
313                         lyxerr << "Removing modifiers...\n"
314                                << "Action now set to ["
315                                << action << "]" << endl;
316                 }
317                 if (action == LFUN_UNKNOWN_ACTION) {
318                         owner->message(_("Unknown function."));
319                         return;
320                 }
321         }
322
323         if (action == LFUN_SELFINSERT) {
324                 // This is very X dependent.
325                 unsigned int c = keysym;
326                 string argument;
327
328                 c = kb_keymap::getiso(c);
329
330                 if (c > 0)
331                         argument = static_cast<char>(c);
332
333                 dispatch(LFUN_SELFINSERT, argument);
334                 lyxerr[Debug::KEY] << "SelfInsert arg[`"
335                                    << argument << "']" << endl;
336         }
337         else
338                 verboseDispatch(action, false);
339 }
340
341
342 FuncStatus LyXFunc::getStatus(int ac) const
343 {
344         kb_action action;
345         string argument;
346         action = lyxaction.retrieveActionArg(ac, argument);
347         return getStatus(action, argument);
348 }
349
350
351 FuncStatus LyXFunc::getStatus(kb_action action,
352                               string const & argument) const
353 {
354         FuncStatus flag;
355         Buffer * buf = owner->buffer();
356
357         if (action == LFUN_NOACTION) {
358                 setStatusMessage(N_("Nothing to do"));
359                 return flag.disabled(true);
360         }
361
362         if (action == LFUN_UNKNOWN_ACTION) {
363                 setStatusMessage(N_("Unknown action"));
364                 return flag.unknown(true);
365         }
366
367         // the default error message if we disable the command
368         setStatusMessage(N_("Command disabled"));
369
370         // Check whether we need a buffer
371         if (!lyxaction.funcHasFlag(action, LyXAction::NoBuffer)) {
372                 // Yes we need a buffer, do we have one?
373                 if (buf) {
374                         // yes
375                         // Can we use a readonly buffer?
376                         if (buf->isReadonly() &&
377                             !lyxaction.funcHasFlag(action,
378                                                    LyXAction::ReadOnly)) {
379                                 // no
380                                 setStatusMessage(N_("Document is read-only"));
381                                 flag.disabled(true);
382                         }
383                 } else {
384                         // no
385                         setStatusMessage(N_("Command not allowed with"
386                                            "out any document open"));
387                         return flag.disabled(true);
388                 }
389         }
390
391         UpdatableInset * tli = owner->view()->theLockingInset();
392
393         // I would really like to avoid having this switch and rather try to
394         // encode this in the function itself.
395         bool disable = false;
396         switch (action) {
397         case LFUN_MENUPRINT:
398                 disable = !Exporter::IsExportable(buf, "dvi")
399                         || lyxrc.print_command == "none";
400                 break;
401         case LFUN_EXPORT:
402                 disable = argument == "fax" &&
403                         !Exporter::IsExportable(buf, argument);
404                 break;
405         case LFUN_UNDO:
406                 disable = buf->undostack.empty();
407                 break;
408         case LFUN_REDO:
409                 disable = buf->redostack.empty();
410                 break;
411         case LFUN_SPELLCHECK:
412                 disable = lyxrc.isp_command == "none";
413                 break;
414 #ifndef HAVE_LIBAIKSAURUS
415         case LFUN_THESAURUS_ENTRY:
416                 disable = true;
417                 break;
418 #endif
419         case LFUN_RUNCHKTEX:
420                 disable = lyxrc.chktex_command == "none";
421                 break;
422         case LFUN_BUILDPROG:
423                 disable = !Exporter::IsExportable(buf, "program");
424                 break;
425
426         case LFUN_LAYOUT_TABULAR:
427                 disable = !tli
428                         || (tli->lyxCode() != Inset::TABULAR_CODE
429                             && !tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
430                 break;
431
432         case LFUN_LAYOUT:
433         case LFUN_LAYOUT_PARAGRAPH: {
434                 Inset * inset = TEXT(false)->cursor.par()->inInset();
435                 disable = inset && inset->forceDefaultParagraphs(inset);
436                 break;
437         }
438
439         case LFUN_TABULAR_FEATURE:
440                 disable = true;
441                 if (tli) {
442                         FuncStatus ret;
443                         //ret.disabled(true);
444                         if (tli->lyxCode() == Inset::TABULAR_CODE) {
445                                 ret = static_cast<InsetTabular *>(tli)
446                                         ->getStatus(argument);
447                         } else if (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE)) {
448                                 ret = static_cast<InsetTabular *>
449                                         (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE))
450                                         ->getStatus(argument);
451                         }
452                         flag |= ret;
453                         disable = false;
454                 } else {
455                         static InsetTabular inset(*owner->buffer(), 1, 1);
456                         FuncStatus ret;
457
458                         disable = true;
459                         ret = inset.getStatus(argument);
460                         if (ret.onoff(true) || ret.onoff(false))
461                                 flag.setOnOff(false);
462                 }
463                 break;
464
465         case LFUN_VC_REGISTER:
466                 disable = buf->lyxvc.inUse();
467                 break;
468         case LFUN_VC_CHECKIN:
469                 disable = !buf->lyxvc.inUse() || buf->isReadonly();
470                 break;
471         case LFUN_VC_CHECKOUT:
472                 disable = !buf->lyxvc.inUse() || !buf->isReadonly();
473                 break;
474         case LFUN_VC_REVERT:
475         case LFUN_VC_UNDO:
476         case LFUN_VC_HISTORY:
477                 disable = !buf->lyxvc.inUse();
478                 break;
479         case LFUN_BOOKMARK_GOTO:
480                 disable =  !owner->view()->
481                         isSavedPosition(strToUnsignedInt(argument));
482                 break;
483
484
485         case LFUN_INSET_TOGGLE: {
486                 LyXText * lt = owner->view()->getLyXText();
487                 disable = !(isEditableInset(lt->getInset())
488                             || (lt->inset_owner
489                                 && lt->inset_owner->owner()
490                                 && lt->inset_owner->owner()->isOpen()));
491                 break;
492         }
493         case LFUN_MATH_VALIGN:
494                 if (mathcursor) {
495                         char align = mathcursor->valign();
496                         if (align == '\0') {
497                                 disable = true;
498                                 break;
499                         }
500                         if (argument.empty()) {
501                                 flag.clear();
502                                 break;
503                         }
504                         if (!contains("tcb", argument[0])) {
505                                 disable = true;
506                                 break;
507                         }
508                         flag.setOnOff(argument[0] == align);
509                 } else
510                         disable = true;
511                 break;
512
513         case LFUN_MATH_HALIGN:
514                 if (mathcursor) {
515                         char align = mathcursor->halign();
516                         if (align == '\0') {
517                                 disable = true;
518                                 break;
519                         }
520                         if (argument.empty()) {
521                                 flag.clear();
522                                 break;
523                         }
524                         if (!contains("lcr", argument[0])) {
525                                 disable = true;
526                                 break;
527                         }
528                         flag.setOnOff(argument[0] == align);
529                 } else
530                         disable = true;
531                 break;
532
533         case LFUN_MATH_MUTATE:
534                 if (tli && (tli->lyxCode() == Inset::MATH_CODE)) {
535                         MathInsetTypes type = mathcursor->formula()->getType();
536                         if (argument == "inline") {
537                                 flag.setOnOff(type == LM_OT_SIMPLE);
538                         } else if (argument == "display") {
539                                 flag.setOnOff(type == LM_OT_EQUATION);
540                         } else if (argument == "eqnarray") {
541                                 flag.setOnOff(type == LM_OT_EQNARRAY);
542                         } else if (argument == "align") {
543                                 flag.setOnOff(type == LM_OT_ALIGN);
544                         } else {
545                                 disable = true;
546                         }
547                 } else
548                         disable = true;
549                 break;
550
551         // we just need to be in math mode to enable that
552         case LFUN_MATH_SIZE:
553         case LFUN_MATH_SPACE:
554         case LFUN_MATH_LIMITS:
555         case LFUN_MATH_NONUMBER:
556         case LFUN_MATH_NUMBER:
557                 disable = !mathcursor;
558                 break;
559
560         // we need to be math mode and a math array for that
561         // Hack: halign produces non-zero result iff we are in a math array
562         case LFUN_MATH_ROW_INSERT:
563         case LFUN_MATH_ROW_DELETE:
564         case LFUN_MATH_COLUMN_INSERT:
565         case LFUN_MATH_COLUMN_DELETE:
566                 disable = !mathcursor || !mathcursor->halign();
567                 break;
568
569         default:
570                 break;
571         }
572
573         // the functions which insert insets
574         Inset::Code code = Inset::NO_CODE;
575         switch (action) {
576         case LFUN_INSET_ERT:
577                 code = Inset::ERT_CODE;
578                 break;
579         case LFUN_INSET_GRAPHICS:
580                 code = Inset::GRAPHICS_CODE;
581                 break;
582         case LFUN_INSET_FOOTNOTE:
583                 code = Inset::FOOT_CODE;
584                 break;
585         case LFUN_DIALOG_TABULAR_INSERT:
586         case LFUN_INSET_TABULAR:
587                 code = Inset::TABULAR_CODE;
588                 break;
589         case LFUN_INSET_EXTERNAL:
590                 code = Inset::EXTERNAL_CODE;
591                 break;
592         case LFUN_INSET_MARGINAL:
593                 code = Inset::MARGIN_CODE;
594                 break;
595         case LFUN_INSET_MINIPAGE:
596                 code = Inset::MINIPAGE_CODE;
597                 break;
598         case LFUN_INSET_FLOAT:
599         case LFUN_INSET_WIDE_FLOAT:
600                 code = Inset::FLOAT_CODE;
601                 break;
602         case LFUN_FLOAT_LIST:
603                 code = Inset::FLOAT_LIST_CODE;
604                 break;
605 #if 0
606         case LFUN_INSET_LIST:
607                 code = Inset::LIST_CODE;
608                 break;
609         case LFUN_INSET_THEOREM:
610                 code = Inset::THEOREM_CODE;
611                 break;
612 #endif
613         case LFUN_INSET_CAPTION:
614                 code = Inset::CAPTION_CODE;
615                 break;
616         case LFUN_INSERT_NOTE:
617                 code = Inset::IGNORE_CODE;
618                 break;
619         case LFUN_INSERT_LABEL:
620                 code = Inset::LABEL_CODE;
621                 break;
622         case LFUN_REF_INSERT:
623                 code = Inset::REF_CODE;
624                 break;
625         case LFUN_CITATION_CREATE:
626         case LFUN_CITATION_INSERT:
627                 code = Inset::CITE_CODE;
628                 break;
629         case LFUN_INSERT_BIBTEX:
630                 code = Inset::BIBTEX_CODE;
631                 break;
632         case LFUN_INDEX_INSERT:
633         case LFUN_INDEX_INSERT_LAST:
634         case LFUN_INDEX_CREATE:
635                 code = Inset::INDEX_CODE;
636                 break;
637         case LFUN_INDEX_PRINT:
638                 code = Inset::INDEX_PRINT_CODE;
639                 break;
640         case LFUN_CHILD_INSERT:
641                 code = Inset::INCLUDE_CODE;
642                 break;
643         case LFUN_TOC_INSERT:
644                 code = Inset::TOC_CODE;
645                 break;
646         case LFUN_PARENTINSERT:
647                 code = Inset::PARENT_CODE;
648                 break;
649         case LFUN_HTMLURL:
650         case LFUN_URL:
651         case LFUN_INSERT_URL:
652                 code = Inset::URL_CODE;
653                 break;
654         case LFUN_QUOTE:
655                 // always allow this, since we will inset a raw quote
656                 // if an inset is not allowed.
657                 break;
658         case LFUN_HYPHENATION:
659         case LFUN_LIGATURE_BREAK:
660         case LFUN_HFILL:
661         case LFUN_MENU_SEPARATOR:
662         case LFUN_LDOTS:
663         case LFUN_END_OF_SENTENCE:
664         case LFUN_PROTECTEDSPACE:
665                 code = Inset::SPECIALCHAR_CODE;
666                 break;
667         default:
668                 break;
669         }
670         if (code != Inset::NO_CODE && tli && !tli->insetAllowed(code)) {
671                 disable = true;
672         }
673
674         if (disable)
675                         flag.disabled(true);
676
677         // A few general toggles
678         switch (action) {
679         case LFUN_TOOLTIPS_TOGGLE:
680                 flag.setOnOff(owner->getDialogs()->tooltipsEnabled());
681                 break;
682
683         case LFUN_READ_ONLY_TOGGLE:
684                 flag.setOnOff(buf->isReadonly());
685                 break;
686         case LFUN_APPENDIX:
687                 flag.setOnOff(TEXT(false)->cursor.par()->params().startOfAppendix());
688                 break;
689         case LFUN_SWITCHBUFFER:
690                 // toggle on the current buffer, but do not toggle off
691                 // the other ones (is that a good idea?)
692                 if (argument == buf->fileName())
693                         flag.setOnOff(true);
694                 break;
695         default:
696                 break;
697         }
698
699         // the font related toggles
700         if (!mathcursor) {
701                 LyXFont const & font = TEXT(false)->real_current_font;
702                 switch (action) {
703                 case LFUN_EMPH:
704                         flag.setOnOff(font.emph() == LyXFont::ON);
705                         break;
706                 case LFUN_NOUN:
707                         flag.setOnOff(font.noun() == LyXFont::ON);
708                         break;
709                 case LFUN_BOLD:
710                         flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
711                         break;
712                 case LFUN_SANS:
713                         flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
714                         break;
715                 case LFUN_ROMAN:
716                         flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
717                         break;
718                 case LFUN_CODE:
719                         flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
720                         break;
721                 default:
722                         break;
723                 }
724         }
725         else {
726                 MathTextCodes tc = mathcursor->getLastCode();
727                 switch (action) {
728                 case LFUN_BOLD:
729                         flag.setOnOff(tc == LM_TC_BF);
730                         break;
731                 case LFUN_SANS:
732                         flag.setOnOff(tc == LM_TC_SF);
733                         break;
734                 case LFUN_EMPH:
735                         flag.setOnOff(tc == LM_TC_CAL);
736                         break;
737                 case LFUN_ROMAN:
738                         flag.setOnOff(tc == LM_TC_RM);
739                         break;
740                 case LFUN_CODE:
741                         flag.setOnOff(tc == LM_TC_TT);
742                         break;
743                 case LFUN_NOUN:
744                         flag.setOnOff(tc == LM_TC_BB);
745                         break;
746                 case LFUN_DEFAULT:
747                         flag.setOnOff(tc == LM_TC_VAR);
748                         break;
749                 default:
750                         break;
751                 }
752         }
753
754         return flag;
755 }
756
757
758 // temporary dispatch method
759 void LyXFunc::miniDispatch(string const & s)
760 {
761         string s2(frontStrip(strip(s)));
762
763         if (!s2.empty()) {
764                 verboseDispatch(s2, true);
765         }
766 }
767
768
769 void LyXFunc::verboseDispatch(string const & s, bool show_sc)
770 {
771         int action = lyxaction.LookupFunc(frontStrip(s));
772
773         if (action == LFUN_UNKNOWN_ACTION) {
774                 string const msg = string(_("Unknown function ("))
775                         + s + ")";
776                 owner->message(msg);
777         } else {
778                 verboseDispatch(action, show_sc);
779         }
780 }
781
782
783 void LyXFunc::verboseDispatch(int ac, bool show_sc)
784 {
785         string argument;
786         kb_action action;
787
788         // get the real action and argument
789         action = lyxaction.retrieveActionArg(ac, argument);
790
791         verboseDispatch(action, argument, show_sc);
792 }
793
794
795
796 void LyXFunc::verboseDispatch(kb_action action,
797                               string const & argument, bool show_sc)
798 {
799         string res = dispatch(action, argument);
800
801         commandshortcut.erase();
802
803         if (lyxrc.display_shortcuts && show_sc) {
804                 if (action != LFUN_SELFINSERT) {
805                         // Put name of command and list of shortcuts
806                         // for it in minibuffer
807                         string comname = lyxaction.getActionName(action);
808
809                         int pseudoaction = action;
810                         bool argsadded = false;
811
812                         if (!argument.empty()) {
813                                 // the pseudoaction is useful for the bindings
814                                 pseudoaction =
815                                         lyxaction.searchActionArg(action,
816                                                                   argument);
817
818                                 if (pseudoaction == LFUN_UNKNOWN_ACTION) {
819                                         pseudoaction = action;
820                                 } else {
821                                         comname += " " + argument;
822                                         argsadded = true;
823                                 }
824                         }
825
826                         string const shortcuts =
827                                 toplevel_keymap->findbinding(pseudoaction);
828
829                         if (!shortcuts.empty()) {
830                                 comname += ": " + shortcuts;
831                         } else if (!argsadded && !argument.empty()) {
832                                 comname += " " + argument;
833                         }
834
835                         if (!comname.empty()) {
836                                 comname = strip(comname);
837                                 commandshortcut = "(" + comname + ')';
838                         }
839                 }
840         }
841
842         if (res.empty()) {
843                 if (!commandshortcut.empty()) {
844                         owner->getMiniBuffer()->addSet(commandshortcut);
845                 }
846         } else {
847                 owner->getMiniBuffer()->addSet(' ' + commandshortcut);
848         }
849 }
850
851
852 string const LyXFunc::dispatch(kb_action action, string argument)
853 {
854         lyxerr[Debug::ACTION] << "LyXFunc::Dispatch: action[" << action
855                               <<"] arg[" << argument << "]" << endl;
856
857         // we have not done anything wrong yet.
858         errorstat = false;
859         dispatch_buffer.erase();
860
861 #ifdef NEW_DISPATCHER
862         // We try do call the most specific dispatcher first:
863         //  1. the lockinginset's dispatch
864         //  2. the bufferview's dispatch
865         //  3. the lyxview's dispatch
866 #endif
867
868         selection_possible = false;
869
870         if (owner->view()->available())
871                 owner->view()->hideCursor();
872
873         // We cannot use this function here
874         if (getStatus(action, argument).disabled()) {
875                 lyxerr[Debug::ACTION] << "LyXFunc::Dispatch: "
876                        << lyxaction.getActionName(action)
877                        << " [" << action << "] is disabled at this location"
878                        << endl;
879                 setErrorMessage(getStatusMessage());
880                 goto exit_with_message;
881         }
882
883         if (owner->view()->available() && owner->view()->theLockingInset()) {
884                 UpdatableInset::RESULT result;
885                 if ((action > 1) || ((action == LFUN_UNKNOWN_ACTION) &&
886                                      (!keyseq.deleted())))
887                 {
888                         if ((action == LFUN_UNKNOWN_ACTION)
889                             && argument.empty()) {
890                                 argument = keyseq.getiso();
891                         }
892                         // Undo/Redo is a bit tricky for insets.
893                         if (action == LFUN_UNDO) {
894                                 owner->view()->menuUndo();
895                                 goto exit_with_message;
896                         } else if (action == LFUN_REDO) {
897                                 owner->view()->menuRedo();
898                                 goto exit_with_message;
899                         } else if (((result=owner->view()->theLockingInset()->
900                                      // Hand-over to inset's own dispatch:
901                                      localDispatch(owner->view(), action, argument)) ==
902                                     UpdatableInset::DISPATCHED) ||
903                                    (result == UpdatableInset::DISPATCHED_NOUPDATE))
904                                 goto exit_with_message;
905                                         // If UNDISPATCHED, just soldier on
906                         else if (result == UpdatableInset::FINISHED) {
907                                         if (TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
908                                                 TEXT()->cursorRight(owner->view());
909                                                 moveCursorUpdate(true, false);
910                                                 owner->showState();
911                                         }
912                                         goto exit_with_message;
913                         } else if (result == UpdatableInset::FINISHED_RIGHT) {
914                                 if (!TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
915                                         TEXT()->cursorRight(owner->view());
916                                         moveCursorUpdate(true, false);
917                                         owner->showState();
918                                 }
919                                 goto exit_with_message;
920                         } else if (result == UpdatableInset::FINISHED_UP) {
921                                 if (TEXT()->cursor.row()->previous()) {
922                                         TEXT()->cursorUp(owner->view());
923                                         moveCursorUpdate(true, false);
924                                         owner->showState();
925                                 } else {
926                                         owner->view()->update(TEXT(), BufferView::SELECT|BufferView::FITCUR);
927                                 }
928                                 goto exit_with_message;
929                         } else if (result == UpdatableInset::FINISHED_DOWN) {
930                                 if (TEXT()->cursor.row()->next())
931                                         TEXT()->cursorDown(owner->view());
932                                 else
933                                         TEXT()->cursorRight(owner->view());
934                                 moveCursorUpdate(true, false);
935                                 owner->showState();
936                                 goto exit_with_message;
937                         } else {
938                                 //setMessage(N_("Text mode"));
939                                 switch (action) {
940                                 case LFUN_UNKNOWN_ACTION:
941                                 case LFUN_BREAKPARAGRAPH:
942                                 case LFUN_BREAKLINE:
943                                         TEXT()->cursorRight(owner->view());
944                                         owner->view()->setState();
945                                         owner->showState();
946                                         break;
947                                 case LFUN_RIGHT:
948                                         if (!TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
949                                                 TEXT()->cursorRight(owner->view());
950                                                 moveCursorUpdate(true, false);
951                                                 owner->showState();
952                                         }
953                                         goto exit_with_message;
954                                 case LFUN_LEFT:
955                                         if (TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
956                                                 TEXT()->cursorRight(owner->view());
957                                                 moveCursorUpdate(true, false);
958                                                 owner->showState();
959                                         }
960                                         goto exit_with_message;
961                                 case LFUN_DOWN:
962                                         if (TEXT()->cursor.row()->next())
963                                                 TEXT()->cursorDown(owner->view());
964                                         else
965                                                 TEXT()->cursorRight(owner->view());
966                                         moveCursorUpdate(true, false);
967                                         owner->showState();
968                                         goto exit_with_message;
969                                 default:
970                                         break;
971                                 }
972                         }
973                 }
974         }
975
976         switch (action) {
977
978         case LFUN_ESCAPE:
979         {
980                 if (!owner->view()->available()) break;
981                 // this function should be used always [asierra060396]
982                 UpdatableInset * tli =
983                         owner->view()->theLockingInset();
984                 if (tli) {
985                         UpdatableInset * lock = tli->getLockingInset();
986
987                         if (tli == lock) {
988                                 owner->view()->unlockInset(tli);
989                                 TEXT()->cursorRight(owner->view());
990                                 moveCursorUpdate(true, false);
991                                 owner->showState();
992                         } else {
993                                 tli->unlockInsetInInset(owner->view(),
994                                                         lock,
995                                                         true);
996                         }
997                         finishUndo();
998                 }
999         }
1000         break;
1001
1002                 // --- Misc -------------------------------------------
1003         case LFUN_WORDFINDFORWARD  :
1004         case LFUN_WORDFINDBACKWARD : {
1005                 static string last_search;
1006                 string searched_string;
1007
1008                 if (!argument.empty()) {
1009                         last_search = argument;
1010                         searched_string = argument;
1011                 } else {
1012                         searched_string = last_search;
1013                 }
1014                 bool fw = (action == LFUN_WORDFINDBACKWARD);
1015                 if (!searched_string.empty()) {
1016                         LyXFind(owner->view(), searched_string, fw);
1017                 }
1018 //              owner->view()->showCursor();
1019         }
1020         break;
1021
1022         case LFUN_PREFIX:
1023         {
1024                 if (owner->view()->available() && !owner->view()->theLockingInset()) {
1025                         owner->view()->update(TEXT(),
1026                                               BufferView::SELECT|BufferView::FITCUR);
1027                 }
1028                 owner->message(keyseq.printOptions());
1029         }
1030         break;
1031
1032         // --- Misc -------------------------------------------
1033         case LFUN_EXEC_COMMAND:
1034         {
1035                 vector<string> allCmds;
1036                 transform(lyxaction.func_begin(), lyxaction.func_end(),
1037                           back_inserter(allCmds), lyx::firster());
1038                 static vector<string> hist;
1039                 owner->getMiniBuffer()->getString(MiniBuffer::spaces,
1040                                                   allCmds, hist);
1041         }
1042         break;
1043
1044         case LFUN_CANCEL:                   // RVDK_PATCH_5
1045                 keyseq.reset();
1046                 meta_fake_bit = 0;
1047                 if (owner->view()->available())
1048                         // cancel any selection
1049                         dispatch(LFUN_MARK_OFF);
1050                 setMessage(N_("Cancel"));
1051                 break;
1052
1053         case LFUN_META_FAKE:                                 // RVDK_PATCH_5
1054         {
1055                 meta_fake_bit = Mod1Mask;
1056                 setMessage(keyseq.print());
1057         }
1058         break;
1059
1060         case LFUN_READ_ONLY_TOGGLE:
1061                 if (owner->buffer()->lyxvc.inUse()) {
1062                         owner->buffer()->lyxvc.toggleReadOnly();
1063                 } else {
1064                         owner->buffer()->setReadonly(
1065                                 !owner->buffer()->isReadonly());
1066                 }
1067                 break;
1068
1069         case LFUN_CENTER: // this is center and redraw.
1070                 owner->view()->center();
1071                 break;
1072
1073                 // --- Menus -----------------------------------------------
1074         case LFUN_MENUNEW:
1075                 menuNew(false);
1076                 break;
1077
1078         case LFUN_MENUNEWTMPLT:
1079                 menuNew(true);
1080                 break;
1081
1082         case LFUN_CLOSEBUFFER:
1083                 closeBuffer();
1084                 break;
1085
1086         case LFUN_MENUWRITE:
1087                 if (!owner->buffer()->isUnnamed()) {
1088                         ostringstream s1;
1089                         s1 << _("Saving document") << ' '
1090                            << MakeDisplayPath(owner->buffer()->fileName() + "...");
1091                         owner->message(s1.str().c_str());
1092                         MenuWrite(owner->view(), owner->buffer());
1093                 } else
1094                         WriteAs(owner->view(), owner->buffer());
1095                 break;
1096
1097         case LFUN_WRITEAS:
1098                 WriteAs(owner->view(), owner->buffer(), argument);
1099                 break;
1100
1101         case LFUN_MENURELOAD:
1102                 reloadBuffer();
1103                 break;
1104
1105         case LFUN_UPDATE:
1106                 Exporter::Export(owner->buffer(), argument, true);
1107                 break;
1108
1109         case LFUN_PREVIEW:
1110                 Exporter::Preview(owner->buffer(), argument);
1111                 break;
1112
1113         case LFUN_BUILDPROG:
1114                 Exporter::Export(owner->buffer(), "program", true);
1115                 break;
1116
1117         case LFUN_RUNCHKTEX:
1118                 MenuRunChktex(owner->buffer());
1119                 break;
1120
1121         case LFUN_MENUPRINT:
1122                 owner->getDialogs()->showPrint();
1123                 break;
1124
1125         case LFUN_EXPORT:
1126                 if (argument == "custom")
1127                         owner->getDialogs()->showSendto();
1128                 else
1129                         Exporter::Export(owner->buffer(), argument, false);
1130                 break;
1131
1132         case LFUN_IMPORT:
1133                 doImport(argument);
1134                 break;
1135
1136         case LFUN_QUIT:
1137                 QuitLyX();
1138                 break;
1139
1140         case LFUN_TOCVIEW:
1141 #if 0
1142         case LFUN_LOFVIEW:
1143         case LFUN_LOTVIEW:
1144         case LFUN_LOAVIEW:
1145 #endif
1146         {
1147                 InsetCommandParams p;
1148
1149 #if 0
1150                 if (action == LFUN_TOCVIEW)
1151 #endif
1152                         p.setCmdName("tableofcontents");
1153 #if 0
1154                 else if (action == LFUN_LOAVIEW)
1155                         p.setCmdName("listof{algorithm}{List of Algorithms}");
1156                 else if (action == LFUN_LOFVIEW)
1157                         p.setCmdName("listoffigures");
1158                 else
1159                         p.setCmdName("listoftables");
1160 #endif
1161                 owner->getDialogs()->createTOC(p.getAsString());
1162                 break;
1163         }
1164
1165         case LFUN_DIALOG_TABULAR_INSERT:
1166                 owner->getDialogs()->showTabularCreate();
1167                 break;
1168
1169         case LFUN_AUTOSAVE:
1170                 AutoSave(owner->view());
1171                 break;
1172
1173         case LFUN_UNDO:
1174                 owner->view()->menuUndo();
1175                 break;
1176
1177         case LFUN_REDO:
1178                 owner->view()->menuRedo();
1179                 break;
1180
1181         case LFUN_MENUSEARCH:
1182                 owner->getDialogs()->showSearch();
1183                 break;
1184
1185         case LFUN_REMOVEERRORS:
1186                 if (owner->view()->removeAutoInsets()) {
1187                         owner->view()->redraw();
1188                         owner->view()->fitCursor();
1189                 }
1190                 break;
1191
1192         case LFUN_DEPTH_MIN:
1193                 changeDepth(owner->view(), TEXT(false), -1);
1194                 break;
1195
1196         case LFUN_DEPTH_PLUS:
1197                 changeDepth(owner->view(), TEXT(false), 1);
1198                 break;
1199
1200         case LFUN_FREE:
1201                 owner->getDialogs()->setUserFreeFont();
1202                 break;
1203
1204         case LFUN_RECONFIGURE:
1205                 Reconfigure(owner->view());
1206                 break;
1207
1208 #if 0
1209         case LFUN_FLOATSOPERATE:
1210                 if (argument == "openfoot")
1211                         owner->view()->allFloats(1,0);
1212                 else if (argument == "closefoot")
1213                         owner->view()->allFloats(0,0);
1214                 else if (argument == "openfig")
1215                         owner->view()->allFloats(1,1);
1216                 else if (argument == "closefig")
1217                         owner->view()->allFloats(0,1);
1218                 break;
1219 #else
1220 #ifdef WITH_WARNINGS
1221 //#warning Find another implementation here (or another lyxfunc)!
1222 #endif
1223 #endif
1224         case LFUN_HELP_ABOUTLYX:
1225                 owner->getDialogs()->showAboutlyx();
1226                 break;
1227
1228         case LFUN_HELP_TEXINFO:
1229                 owner->getDialogs()->showTexinfo();
1230                 break;
1231
1232         case LFUN_HELP_OPEN:
1233         {
1234                 string const arg = argument;
1235                 if (arg.empty()) {
1236                         setErrorMessage(N_("Missing argument"));
1237                         break;
1238                 }
1239                 owner->prohibitInput();
1240                 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1241                 if (fname.empty()) {
1242                         lyxerr << "LyX: unable to find documentation file `"
1243                                << arg << "'. Bad installation?" << endl;
1244                         owner->allowInput();
1245                         break;
1246                 }
1247                 ostringstream str;
1248                 str << _("Opening help file") << ' '
1249                     << MakeDisplayPath(fname) << "...";
1250                 owner->message(str.str().c_str());
1251                 owner->view()->buffer(bufferlist.loadLyXFile(fname, false));
1252                 owner->allowInput();
1253                 break;
1254         }
1255
1256                 // --- version control -------------------------------
1257         case LFUN_VC_REGISTER:
1258         {
1259                 if (!owner->buffer()->lyxvc.inUse())
1260                         owner->buffer()->lyxvc.registrer();
1261         }
1262         break;
1263
1264         case LFUN_VC_CHECKIN:
1265         {
1266                 if (owner->buffer()->lyxvc.inUse()
1267                     && !owner->buffer()->isReadonly())
1268                         owner->buffer()->lyxvc.checkIn();
1269         }
1270         break;
1271
1272         case LFUN_VC_CHECKOUT:
1273         {
1274                 if (owner->buffer()->lyxvc.inUse()
1275                     && owner->buffer()->isReadonly())
1276                         owner->buffer()->lyxvc.checkOut();
1277         }
1278         break;
1279
1280         case LFUN_VC_REVERT:
1281         {
1282                 owner->buffer()->lyxvc.revert();
1283         }
1284         break;
1285
1286         case LFUN_VC_UNDO:
1287         {
1288                 owner->buffer()->lyxvc.undoLast();
1289         }
1290         break;
1291
1292         case LFUN_VC_HISTORY:
1293         {
1294                 owner->getDialogs()->showVCLogFile();
1295                 break;
1296         }
1297
1298         // --- buffers ----------------------------------------
1299
1300         case LFUN_SWITCHBUFFER:
1301                 owner->view()->buffer(bufferlist.getBuffer(argument));
1302                 break;
1303
1304         case LFUN_FILE_NEW:
1305         {
1306                 // servercmd: argument must be <file>:<template>
1307                 Buffer * tmpbuf = NewLyxFile(argument);
1308                 if (tmpbuf)
1309                         owner->view()->buffer(tmpbuf);
1310         }
1311         break;
1312
1313         case LFUN_FILE_OPEN:
1314                 open(argument);
1315                 break;
1316
1317         case LFUN_LATEX_LOG:
1318                 owner->getDialogs()->showLogFile();
1319                 break;
1320
1321         case LFUN_LAYOUT_DOCUMENT:
1322                 owner->getDialogs()->showDocument();
1323                 break;
1324
1325         case LFUN_LAYOUT_PARAGRAPH:
1326                 owner->getDialogs()->showParagraph();
1327                 break;
1328
1329         case LFUN_LAYOUT_CHARACTER:
1330                 owner->getDialogs()->showCharacter();
1331                 break;
1332
1333         case LFUN_LAYOUT_TABULAR:
1334             if (owner->view()->theLockingInset()) {
1335                 if (owner->view()->theLockingInset()->lyxCode()==Inset::TABULAR_CODE) {
1336                     InsetTabular * inset = static_cast<InsetTabular *>
1337                         (owner->view()->theLockingInset());
1338                     inset->openLayoutDialog(owner->view());
1339                 } else if (owner->view()->theLockingInset()->
1340                            getFirstLockingInsetOfType(Inset::TABULAR_CODE)!=0) {
1341                     InsetTabular * inset = static_cast<InsetTabular *>(
1342                         owner->view()->theLockingInset()->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
1343                     inset->openLayoutDialog(owner->view());
1344                 }
1345             }
1346             break;
1347
1348         case LFUN_LAYOUT_PREAMBLE:
1349                 owner->getDialogs()->showPreamble();
1350                 break;
1351
1352         case LFUN_DROP_LAYOUTS_CHOICE:
1353                 owner->getToolbar()->openLayoutList();
1354                 break;
1355
1356         case LFUN_MENU_OPEN_BY_NAME:
1357                 owner->getMenubar()->openByName(argument);
1358                 break; // RVDK_PATCH_5
1359
1360         case LFUN_SPELLCHECK:
1361                 if (lyxrc.isp_command != "none")
1362                         owner->getDialogs()->showSpellchecker();
1363                 break;
1364
1365         // --- lyxserver commands ----------------------------
1366
1367
1368         case LFUN_GETNAME:
1369                 setMessage(owner->buffer()->fileName());
1370                 lyxerr[Debug::INFO] << "FNAME["
1371                                << owner->buffer()->fileName()
1372                                << "] " << endl;
1373                 break;
1374
1375         case LFUN_NOTIFY:
1376         {
1377                 dispatch_buffer = keyseq.print();
1378                 lyxserver->notifyClient(dispatch_buffer);
1379         }
1380         break;
1381
1382         case LFUN_GOTOFILEROW:
1383         {
1384                 string file_name;
1385                 int row;
1386                 istringstream istr(argument.c_str());
1387                 istr >> file_name >> row;
1388                 // Must replace extension of the file to be .lyx and get full path
1389                 string const s(ChangeExtension(file_name, ".lyx"));
1390
1391                 // Either change buffer or load the file
1392                 if (bufferlist.exists(s)) {
1393                         owner->view()->buffer(bufferlist.getBuffer(s));
1394                 } else {
1395                         owner->view()->buffer(bufferlist.loadLyXFile(s));
1396                 }
1397
1398                 // Set the cursor
1399                 owner->view()->setCursorFromRow(row);
1400
1401                 // Recenter screen
1402                 owner->view()->center();
1403         }
1404         break;
1405
1406         case LFUN_GOTO_PARAGRAPH:
1407         {
1408                 istringstream istr(argument.c_str());
1409
1410                 int id;
1411                 istr >> id;
1412                 Paragraph * par = owner->buffer()->getParFromID(id);
1413                 if (par == 0) {
1414                         lyxerr[Debug::INFO] << "No matching paragraph found! ["
1415                                             << id << "]" << endl;
1416                         break;
1417                 } else {
1418                         lyxerr[Debug::INFO] << "Paragraph " << par->id()
1419                                             << " found." << endl;
1420                 }
1421
1422                 if (owner->view()->theLockingInset())
1423                         owner->view()->unlockInset(owner->view()->theLockingInset());
1424                 if (par->inInset()) {
1425                         par->inInset()->edit(owner->view());
1426                 }
1427                 // Set the cursor
1428                 owner->view()->getLyXText()->setCursor(owner->view(), par, 0);
1429                 owner->view()->setState();
1430                 owner->showState();
1431
1432                 // Recenter screen
1433                 owner->view()->center();
1434         }
1435         break;
1436
1437         case LFUN_APROPOS:
1438         case LFUN_GETTIP:
1439         {
1440                 int const qa = lyxaction.LookupFunc(argument);
1441                 setMessage(lyxaction.helpText(static_cast<kb_action>(qa)));
1442         }
1443         break;
1444
1445         // --- toolbar ----------------------------------
1446         case LFUN_PUSH_TOOLBAR:
1447         {
1448                 int nth = strToInt(argument);
1449                 if (nth <= 0) {
1450                         setErrorMessage(N_("Push-toolbar needs argument > 0"));
1451                 } else {
1452                         owner->getToolbar()->push(nth);
1453                 }
1454         }
1455         break;
1456
1457         case LFUN_ADD_TO_TOOLBAR:
1458         {
1459                 if (lyxerr.debugging(Debug::GUI)) {
1460                         lyxerr << "LFUN_ADD_TO_TOOLBAR:"
1461                                 "argument = `" << argument << '\'' << endl;
1462                 }
1463                 string tmp(argument);
1464                 //lyxerr <<string("Argument: ") + argument);
1465                 //lyxerr <<string("Tmp     : ") + tmp);
1466                 if (tmp.empty()) {
1467                         setErrorMessage(N_("Usage: toolbar-add-to <LyX command>"));
1468                 } else {
1469                         owner->getToolbar()->add(argument, false);
1470                         owner->getToolbar()->set();
1471                 }
1472         }
1473         break;
1474
1475         // --- insert characters ----------------------------------------
1476
1477         // ---  Mathed stuff. If we are here, there is no locked inset yet.
1478         case LFUN_MATH_EXTERN:
1479         case LFUN_MATH_NUMBER:
1480         case LFUN_MATH_NONUMBER:
1481         case LFUN_MATH_LIMITS:
1482         {
1483                 setErrorMessage(N_("This is only allowed in math mode!"));
1484         }
1485         break;
1486
1487         // passthrough hat and underscore outside mathed:
1488         case LFUN_SUBSCRIPT:
1489                 dispatch(LFUN_SELFINSERT, "_");
1490                 break;
1491         case LFUN_SUPERSCRIPT:
1492                 dispatch(LFUN_SELFINSERT, "^");
1493                 break;
1494
1495         case LFUN_MATH_PANEL:
1496                 owner->getDialogs()->showMathPanel();
1497                 break;
1498
1499         case LFUN_CITATION_CREATE:
1500         {
1501                 InsetCommandParams p("cite");
1502
1503                 if (!argument.empty()) {
1504                         // This should be set at source, ie when typing
1505                         // "citation-insert foo" in the minibuffer.
1506                         // Question: would pybibliographer also need to be
1507                         // changed. Suspect so. Leave as-is therefore.
1508                         if (contains(argument, "|")) {
1509                                 p.setContents(token(argument, '|', 0));
1510                                 p.setOptions( token(argument, '|', 1));
1511                         } else {
1512                                 p.setContents(argument);
1513                         }
1514                         dispatch(LFUN_CITATION_INSERT, p.getAsString());
1515                 } else
1516                         owner->getDialogs()->createCitation(p.getAsString());
1517         }
1518         break;
1519
1520         case LFUN_CHILDOPEN:
1521         {
1522                 string const filename =
1523                         MakeAbsPath(argument,
1524                                     owner->buffer()->filePath());
1525                 setMessage(N_("Opening child document ") +
1526                            MakeDisplayPath(filename) + "...");
1527                 owner->view()->savePosition(0);
1528                 if (bufferlist.exists(filename))
1529                         owner->view()->buffer(bufferlist.getBuffer(filename));
1530                 else
1531                         owner->view()->buffer(bufferlist.loadLyXFile(filename));
1532         }
1533         break;
1534
1535         case LFUN_TOGGLECURSORFOLLOW:
1536                 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1537                 break;
1538
1539         case LFUN_KMAP_OFF:             // keymap off
1540                 owner->getIntl()->KeyMapOn(false);
1541                 break;
1542
1543         case LFUN_KMAP_PRIM:    // primary keymap
1544                 owner->getIntl()->KeyMapPrim();
1545                 break;
1546
1547         case LFUN_KMAP_SEC:             // secondary keymap
1548                 owner->getIntl()->KeyMapSec();
1549                 break;
1550
1551         case LFUN_KMAP_TOGGLE:  // toggle keymap
1552                 owner->getIntl()->ToggleKeyMap();
1553                 break;
1554
1555         case LFUN_SEQUENCE:
1556         {
1557                 // argument contains ';'-terminated commands
1558                 while (argument.find(';') != string::npos) {
1559                         string first;
1560                         argument = split(argument, first, ';');
1561                         verboseDispatch(first, false);
1562                 }
1563         }
1564         break;
1565
1566         case LFUN_DIALOG_PREFERENCES:
1567                 owner->getDialogs()->showPreferences();
1568                 break;
1569
1570         case LFUN_SAVEPREFERENCES:
1571         {
1572                 Path p(user_lyxdir);
1573                 lyxrc.write("preferences");
1574         }
1575         break;
1576
1577         case LFUN_SCREEN_FONT_UPDATE:
1578         {
1579                 // handle the screen font changes.
1580                 //
1581                 lyxrc.set_font_norm_type();
1582                 fontloader.update();
1583                 // Of course we should only do the resize and the textcache.clear
1584                 // if values really changed...but not very important right now. (Lgb)
1585                 // All visible buffers will need resize
1586                 owner->resize();
1587                 // We also need to empty the textcache so that
1588                 // the buffer will be formatted correctly after
1589                 // a zoom change.
1590                 textcache.clear();
1591         }
1592         break;
1593
1594         case LFUN_SET_COLOR:
1595         {
1596                 string lyx_name;
1597                 string const x11_name = split(argument, lyx_name, ' ');
1598                 if (lyx_name.empty() || x11_name.empty()) {
1599                         setErrorMessage(N_("Syntax: set-color <lyx_name>"
1600                                                 " <x11_name>"));
1601                         break;
1602                         }
1603
1604                 bool const graphicsbg_changed =
1605                         (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1606                          x11_name != lcolor.getX11Name(LColor::graphicsbg));
1607
1608                 if (!lcolor.setColor(lyx_name, x11_name)) {
1609                         static string const err1 (N_("Set-color \""));
1610                         static string const err2 (
1611                                 N_("\" failed - color is undefined "
1612                                    "or may not be redefined"));
1613                         setErrorMessage(_(err1) + lyx_name + _(err2));
1614                         break;
1615                 }
1616
1617                 lyxColorHandler->updateColor(lcolor.getFromLyXName(lyx_name));
1618
1619                 if (graphicsbg_changed) {
1620                         grfx::GCache & gc = grfx::GCache::get();
1621                         gc.changeDisplay(true);
1622                 }
1623
1624                 owner->view()->redraw();
1625                 break;
1626         }
1627
1628         case LFUN_MESSAGE:
1629                 owner->message(argument);
1630                 break;
1631
1632         case LFUN_MESSAGE_PUSH:
1633                 owner->messagePush(argument);
1634                 break;
1635
1636         case LFUN_MESSAGE_POP:
1637                 owner->messagePop();
1638                 break;
1639
1640         case LFUN_FORKS_SHOW:
1641                 owner->getDialogs()->showForks();
1642                 break;
1643
1644         case LFUN_FORKS_KILL:
1645         {
1646                 if (!isStrInt(argument))
1647                         break;
1648
1649                 pid_t const pid = strToInt(argument);
1650                 ForkedcallsController & fcc = ForkedcallsController::get();
1651                 fcc.kill(pid);
1652                 break;
1653         }
1654
1655         case LFUN_TOOLTIPS_TOGGLE:
1656                 owner->getDialogs()->toggleTooltips();
1657                 break;
1658
1659         default:
1660                 // Then if it was none of the above
1661                 // Trying the BufferView::pimpl dispatch:
1662                 if (!owner->view()->Dispatch(action, argument))
1663                         lyxerr << "A truly unknown func ["
1664                                << lyxaction.getActionName(action) << "]!"
1665                                << endl;
1666                 break;
1667         } // end of switch
1668
1669 exit_with_message:
1670
1671         string const res = getMessage();
1672
1673         if (!res.empty())
1674                 owner->message(_(res));
1675         owner->updateMenubar();
1676         owner->updateToolbar();
1677
1678         return res;
1679 }
1680
1681
1682 void LyXFunc::setupLocalKeymap()
1683 {
1684         keyseq.stdmap = keyseq.curmap = toplevel_keymap.get();
1685         cancel_meta_seq.stdmap = cancel_meta_seq.curmap = toplevel_keymap.get();
1686 }
1687
1688
1689 void LyXFunc::menuNew(bool fromTemplate)
1690 {
1691         string initpath = lyxrc.document_path;
1692
1693         if (owner->view()->available()) {
1694                 string const trypath = owner->buffer()->filePath();
1695                 // If directory is writeable, use this as default.
1696                 if (IsDirWriteable(trypath))
1697                         initpath = trypath;
1698         }
1699
1700         static int newfile_number;
1701         string s;
1702
1703         if (lyxrc.new_ask_filename) {
1704                 FileDialog fileDlg(owner, _("Enter filename for new document"),
1705                                    LFUN_SELECT_FILE_SYNC,
1706                         make_pair(string(_("Documents|#o#O")),
1707                                   string(lyxrc.document_path)),
1708                         make_pair(string(_("Templates|#T#t")),
1709                                   string(lyxrc.template_path)));
1710
1711                 FileDialog::Result result =
1712                         fileDlg.Select(initpath,
1713                                        _("*.lyx|LyX Documents (*.lyx)"),
1714                                        _("newfile"));
1715
1716                 if (result.second.empty()) {
1717                         owner->message(_("Canceled."));
1718                         lyxerr[Debug::INFO] << "New Document Cancelled." << endl;
1719                         return;
1720                 }
1721
1722                 // get absolute path of file and make sure the filename ends
1723                 // with .lyx
1724                 s = MakeAbsPath(result.second);
1725                 if (!IsLyXFilename(s))
1726                         s += ".lyx";
1727
1728                 // Check if the document already is open
1729                 if (bufferlist.exists(s)) {
1730                         switch (Alert::askConfirmation(_("Document is already open:"),
1731                                                 MakeDisplayPath(s, 50),
1732                                                 _("Do you want to close that document now?\n"
1733                                                   "('No' will just switch to the open version)")))
1734                         {
1735                         case 1: // Yes: close the document
1736                                 if (!bufferlist.close(bufferlist.getBuffer(s)))
1737                                 // If close is canceled, we cancel here too.
1738                                         return;
1739                                 break;
1740                         case 2: // No: switch to the open document
1741                                 owner->view()->buffer(bufferlist.getBuffer(s));
1742                                 return;
1743                         case 3: // Cancel: Do nothing
1744                                 owner->message(_("Canceled."));
1745                                 return;
1746                         }
1747                 }
1748                 // Check whether the file already exists
1749                 FileInfo fi(s);
1750                 if (fi.readable() &&
1751                     Alert::askQuestion(_("File already exists:"),
1752                                 MakeDisplayPath(s, 50),
1753                                 _("Do you want to open the document?"))) {
1754                                 // loads document
1755                         string const disp_fn(MakeDisplayPath(s));
1756
1757                         ostringstream str;
1758                         str << _("Opening  document") << ' '
1759                             << disp_fn << "...";
1760
1761                         owner->message(str.str().c_str());
1762                         //XFlush(fl_get_display());
1763                         owner->view()->buffer(bufferlist.loadLyXFile(s));
1764                         ostringstream str2;
1765                         str2 << _("Document") << ' '
1766                              << disp_fn << ' ' << _("opened.");
1767
1768                         owner->message(str2.str().c_str());
1769
1770                         return;
1771                 }
1772         } else {
1773                 s = AddName(lyxrc.document_path,
1774                             "newfile" + tostr(++newfile_number) + ".lyx");
1775                 FileInfo fi(s);
1776                 while (bufferlist.exists(s) || fi.readable()) {
1777                         ++newfile_number;
1778                         s = AddName(lyxrc.document_path,
1779                                     "newfile" + tostr(newfile_number) +
1780                                     ".lyx");
1781                         fi.newFile(s);
1782                 }
1783         }
1784
1785         // The template stuff
1786         string templname;
1787         if (fromTemplate) {
1788                 FileDialog fileDlg(owner, _("Select template file"),
1789                         LFUN_SELECT_FILE_SYNC,
1790                         make_pair(string(_("Documents|#o#O")),
1791                                   string(lyxrc.document_path)),
1792                         make_pair(string(_("Templates|#T#t")),
1793                                   string(lyxrc.template_path)));
1794
1795                 FileDialog::Result result =
1796                         fileDlg.Select(lyxrc.template_path,
1797                                        _("*.lyx|LyX Documents (*.lyx)"));
1798
1799                 if (result.first == FileDialog::Later)
1800                         return;
1801
1802                 string const fname = result.second;
1803
1804                 if (fname.empty())
1805                         return;
1806                 templname = fname;
1807         }
1808
1809         // find a free buffer
1810         lyxerr[Debug::INFO] << "Find a free buffer." << endl;
1811         owner->view()->buffer(bufferlist.newFile(s, templname));
1812 }
1813
1814
1815 void LyXFunc::open(string const & fname)
1816 {
1817         string initpath = lyxrc.document_path;
1818
1819         if (owner->view()->available()) {
1820                 string const trypath = owner->buffer()->filePath();
1821                 // If directory is writeable, use this as default.
1822                 if (IsDirWriteable(trypath))
1823                         initpath = trypath;
1824         }
1825
1826         string filename;
1827
1828         if (fname.empty()) {
1829                 FileDialog fileDlg(owner, _("Select document to open"),
1830                         LFUN_FILE_OPEN,
1831                         make_pair(string(_("Documents|#o#O")),
1832                                   string(lyxrc.document_path)),
1833                         make_pair(string(_("Examples|#E#e")),
1834                                   string(AddPath(system_lyxdir, "examples"))));
1835
1836                 FileDialog::Result result =
1837                         fileDlg.Select(initpath,
1838                                        "*.lyx|LyX Documents (*.lyx)");
1839
1840                 if (result.first == FileDialog::Later)
1841                         return;
1842
1843                 filename = result.second;
1844
1845                 // check selected filename
1846                 if (filename.empty()) {
1847                         owner->message(_("Canceled."));
1848                         return;
1849                 }
1850         } else
1851                 filename = fname;
1852
1853         // get absolute path of file and add ".lyx" to the filename if
1854         // necessary
1855         string const fullpath = FileSearch(string(), filename, "lyx");
1856         if (fullpath.empty()) {
1857                 Alert::alert(_("Error"), _("Could not find file"), filename);
1858                 return;
1859         }
1860
1861         filename = fullpath;
1862
1863         // loads document
1864         string const disp_fn(MakeDisplayPath(filename));
1865
1866         ostringstream str;
1867         str << _("Opening document") << ' ' << disp_fn << "...";
1868
1869         owner->message(str.str().c_str());
1870
1871         Buffer * openbuf = bufferlist.loadLyXFile(filename);
1872         if (openbuf) {
1873                 owner->view()->buffer(openbuf);
1874                 ostringstream str;
1875                 str << _("Document") << ' ' << disp_fn << ' ' << _("opened.");
1876                 owner->message(str.str().c_str());
1877         } else {
1878                 ostringstream str;
1879                 str << _("Could not open document") << ' ' << disp_fn;
1880                 owner->message(str.str().c_str());
1881         }
1882 }
1883
1884
1885 // checks for running without gui are missing.
1886 void LyXFunc::doImport(string const & argument)
1887 {
1888         string format;
1889         string filename = split(argument, format, ' ');
1890         lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1891                             << " file: " << filename << endl;
1892
1893         if (filename.empty()) { // need user interaction
1894                 string initpath = lyxrc.document_path;
1895
1896                 if (owner->view()->available()) {
1897                         string const trypath = owner->buffer()->filePath();
1898                         // If directory is writeable, use this as default.
1899                         if (IsDirWriteable(trypath))
1900                                 initpath = trypath;
1901                 }
1902
1903                 string const text = _("Select ") + formats.prettyName(format)
1904                         + _(" file to import");
1905
1906                 FileDialog fileDlg(owner, text,
1907                         LFUN_IMPORT,
1908                         make_pair(string(_("Documents|#o#O")),
1909                                   string(lyxrc.document_path)),
1910                         make_pair(string(_("Examples|#E#e")),
1911                                   string(AddPath(system_lyxdir, "examples"))));
1912
1913                 string const extension = "*." + formats.extension(format)
1914                         + "| " + formats.prettyName(format)
1915                         + " (*." + formats.extension(format) + ")";
1916
1917                 FileDialog::Result result = fileDlg.Select(initpath,
1918                                                            extension);
1919
1920                 if (result.first == FileDialog::Later)
1921                         return;
1922
1923                 filename = result.second;
1924
1925                 // check selected filename
1926                 if (filename.empty())
1927                         owner->message(_("Canceled."));
1928         }
1929
1930         // still no filename? abort
1931         if (filename.empty())
1932                 return;
1933
1934         // get absolute path of file
1935         filename = MakeAbsPath(filename);
1936
1937         string const lyxfile = ChangeExtension(filename, ".lyx");
1938
1939         // Check if the document already is open
1940         if (bufferlist.exists(lyxfile)) {
1941                 switch (Alert::askConfirmation(_("Document is already open:"),
1942                                         MakeDisplayPath(lyxfile, 50),
1943                                         _("Do you want to close that document now?\n"
1944                                           "('No' will just switch to the open version)")))
1945                         {
1946                         case 1: // Yes: close the document
1947                                 if (!bufferlist.close(bufferlist.getBuffer(lyxfile)))
1948                                 // If close is canceled, we cancel here too.
1949                                         return;
1950                                 break;
1951                         case 2: // No: switch to the open document
1952                                 owner->view()->buffer(bufferlist.getBuffer(lyxfile));
1953                                 return;
1954                         case 3: // Cancel: Do nothing
1955                                 owner->message(_("Canceled."));
1956                                 return;
1957                         }
1958         }
1959
1960         // Check if a LyX document by the same root exists in filesystem
1961         FileInfo const f(lyxfile, true);
1962         if (f.exist() && !Alert::askQuestion(_("A document by the name"),
1963                                       MakeDisplayPath(lyxfile),
1964                                       _("already exists. Overwrite?"))) {
1965                 owner->message(_("Canceled"));
1966                 return;
1967         }
1968         // filename should be valid now
1969
1970         Importer::Import(owner, filename, format);
1971 }
1972
1973
1974 void LyXFunc::reloadBuffer()
1975 {
1976         string const fn = owner->buffer()->fileName();
1977         if (bufferlist.close(owner->buffer()))
1978                 owner->view()->buffer(bufferlist.loadLyXFile(fn));
1979 }
1980
1981
1982 void LyXFunc::closeBuffer()
1983 {
1984         if (bufferlist.close(owner->buffer()) && !quitting) {
1985                 if (bufferlist.empty()) {
1986                         // need this otherwise SEGV may occur while trying to
1987                         // set variables that don't exist
1988                         // since there's no current buffer
1989                         owner->getDialogs()->hideBufferDependent();
1990                 } else {
1991                         owner->view()->buffer(bufferlist.first());
1992                 }
1993         }
1994 }
1995
1996
1997 // Each "owner" should have it's own message method. lyxview and
1998 // the minibuffer would use the minibuffer, but lyxserver would
1999 // send an ERROR signal to its client.  Alejandro 970603
2000 // This func is bit problematic when it comes to NLS, to make the
2001 // lyx servers client be language indepenent we must not translate
2002 // strings sent to this func.
2003 void LyXFunc::setErrorMessage(string const & m) const
2004 {
2005         dispatch_buffer = m;
2006         errorstat = true;
2007 }
2008
2009
2010 void LyXFunc::setMessage(string const & m) const
2011 {
2012         dispatch_buffer = m;
2013 }
2014
2015
2016 void LyXFunc::setStatusMessage(string const & m) const
2017 {
2018         status_buffer = m;
2019 }
2020
2021
2022 void LyXFunc::initMiniBuffer()
2023 {
2024         string text = _("Welcome to LyX!");
2025
2026         // When meta-fake key is pressed, show the key sequence so far + "M-".
2027         if (wasMetaKey()) {
2028                 text = keyseq.print();
2029                 text += "M-";
2030         }
2031
2032         // Else, when a non-complete key sequence is pressed,
2033         // show the available options.
2034         if (keyseq.length() > 0 && !keyseq.deleted()) {
2035                 text = keyseq.printOptions();
2036         }
2037
2038         // Else, show the buffer state.
2039         else if (owner->view()->available()) {
2040                 Buffer * tmpbuf = owner->buffer();
2041
2042                 string const nicename =
2043                         MakeDisplayPath(tmpbuf->fileName());
2044                 // Should we do this instead? (kindo like emacs)
2045                 // leaves more room for other information
2046                 text = "LyX: ";
2047                 text += nicename;
2048                 if (tmpbuf->lyxvc.inUse()) {
2049                         text += " [";
2050                         text += tmpbuf->lyxvc.versionString();
2051                         text += ' ';
2052                         text += tmpbuf->lyxvc.locker();
2053                         if (tmpbuf->isReadonly())
2054                                 text += " (RO)";
2055                         text += ']';
2056                 } else if (tmpbuf->isReadonly())
2057                         text += " [RO]";
2058                 if (!tmpbuf->isLyxClean())
2059                         text += _(" (Changed)");
2060         } else {
2061                 if (text != _("Welcome to LyX!")) // this is a hack
2062                         text = _("* No document open *");
2063         }
2064
2065         owner->message(text);
2066 }