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