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