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