3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
14 * \author Martin Vermeer
15 * \author Jürgen Vigna
17 * Full author contact details are available in file CREDITS.
24 #include "BranchList.h"
26 #include "buffer_funcs.h"
27 #include "bufferlist.h"
28 #include "bufferparams.h"
29 #include "BufferView.h"
32 #include "dispatchresult.h"
36 #include "funcrequest.h"
40 #include "iterators.h"
44 #include "LyXAction.h"
48 #include "lyxserver.h"
50 #include "paragraph.h"
51 #include "ParagraphParameters.h"
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"
66 #include "mathed/math_cursor.h"
68 #include "frontends/Alert.h"
69 #include "frontends/Dialogs.h"
70 #include "frontends/FileDialog.h"
71 #include "frontends/lyx_gui.h"
72 #include "frontends/LyXKeySym.h"
73 #include "frontends/LyXView.h"
74 #include "frontends/Menubar.h"
75 #include "frontends/Toolbar.h"
77 #include "support/FileInfo.h"
78 #include "support/filetools.h"
79 #include "support/forkedcontr.h"
80 #include "support/globbing.h"
81 #include "support/path.h"
82 #include "support/path_defines.h"
83 #include "support/tostr.h"
84 #include "support/std_sstream.h"
85 #include "support/os.h"
87 using bv_funcs::changeDepth;
88 using bv_funcs::currentState;
89 using bv_funcs::DEC_DEPTH;
90 using bv_funcs::freefont2string;
91 using bv_funcs::INC_DEPTH;
93 using lyx::support::AddName;
94 using lyx::support::AddPath;
95 using lyx::support::bformat;
96 using lyx::support::ChangeExtension;
97 using lyx::support::FileFilterList;
98 using lyx::support::FileInfo;
99 using lyx::support::FileSearch;
100 using lyx::support::ForkedcallsController;
101 using lyx::support::i18nLibFileSearch;
102 using lyx::support::IsDirWriteable;
103 using lyx::support::IsFileReadable;
104 using lyx::support::isStrInt;
105 using lyx::support::MakeAbsPath;
106 using lyx::support::MakeDisplayPath;
107 using lyx::support::Path;
108 using lyx::support::rtrim;
109 using lyx::support::split;
110 using lyx::support::strToInt;
111 using lyx::support::strToUnsignedInt;
112 using lyx::support::system_lyxdir;
113 using lyx::support::token;
114 using lyx::support::trim;
115 using lyx::support::user_lyxdir;
116 using lyx::support::prefixIs;
117 using lyx::support::os::getTmpDir;
120 using std::make_pair;
123 using std::istringstream;
126 extern BufferList bufferlist;
127 extern LyXServer * lyxserver;
128 extern bool selection_possible;
130 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
133 extern tex_accent_struct get_accent(kb_action action);
136 LyXFunc::LyXFunc(LyXView * lv)
139 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
140 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
141 meta_fake_bit(key_modifier::none)
146 void LyXFunc::handleKeyFunc(kb_action action)
148 char c = encoded_last_key;
150 if (keyseq.length()) {
154 owner->getIntl().getTransManager()
155 .deadkey(c, get_accent(action).accent, view()->getLyXText());
156 // Need to clear, in case the minibuffer calls these
159 // copied verbatim from do_accent_char
161 view()->getLyXText()->anchor() = view()->getLyXText()->cursor();
165 void LyXFunc::processKeySym(LyXKeySymPtr keysym,
166 key_modifier::state state)
170 if (lyxerr.debugging(Debug::KEY)) {
171 lyxerr << "KeySym is "
172 << keysym->getSymbolName()
176 // Do nothing if we have nothing (JMarc)
177 if (!keysym->isOK()) {
178 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
183 if (keysym->isModifier()) {
184 lyxerr[Debug::KEY] << "isModifier true" << endl;
188 Encoding const * encoding = view()->getEncoding();
190 encoded_last_key = keysym->getISOEncoded(encoding ? encoding->Name() : "");
192 // Do a one-deep top-level lookup for
193 // cancel and meta-fake keys. RVDK_PATCH_5
194 cancel_meta_seq.reset();
196 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
197 lyxerr[Debug::KEY] << "action first set to [" << func.action << ']' << endl;
199 // When not cancel or meta-fake, do the normal lookup.
200 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
201 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
202 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_FAKE)) {
203 // remove Caps Lock and Mod2 as a modifiers
204 func = keyseq.addkey(keysym, (state | meta_fake_bit));
205 lyxerr[Debug::KEY] << "action now set to ["
206 << func.action << ']' << endl;
209 // Dont remove this unless you know what you are doing.
210 meta_fake_bit = key_modifier::none;
212 // can this happen now ?
213 if (func.action == LFUN_NOACTION) {
214 func = FuncRequest(LFUN_PREFIX);
217 if (lyxerr.debugging(Debug::KEY)) {
218 lyxerr << "Key [action="
219 << func.action << "]["
220 << keyseq.print() << ']'
224 // already here we know if it any point in going further
225 // why not return already here if action == -1 and
226 // num_bytes == 0? (Lgb)
228 if (keyseq.length() > 1) {
229 owner->message(keyseq.print());
233 // Maybe user can only reach the key via holding down shift.
234 // Let's see. But only if shift is the only modifier
235 if (func.action == LFUN_UNKNOWN_ACTION &&
236 state == key_modifier::shift) {
237 lyxerr[Debug::KEY] << "Trying without shift" << endl;
238 func = keyseq.addkey(keysym, key_modifier::none);
239 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
242 if (func.action == LFUN_UNKNOWN_ACTION) {
243 // Hmm, we didn't match any of the keysequences. See
244 // if it's normal insertable text not already covered
246 if (keysym->isText() && keyseq.length() == 1) {
247 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
248 func = FuncRequest(LFUN_SELFINSERT);
250 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
251 owner->message(_("Unknown function."));
256 if (func.action == LFUN_SELFINSERT) {
257 if (encoded_last_key != 0) {
259 arg += encoded_last_key;
261 dispatch(FuncRequest(view(), LFUN_SELFINSERT, arg));
263 lyxerr[Debug::KEY] << "SelfInsert arg[`"
264 << argument << "']" << endl;
272 FuncStatus LyXFunc::getStatus(FuncRequest const & ev) const
275 Buffer * buf = owner->buffer();
277 if (ev.action == LFUN_NOACTION) {
278 setStatusMessage(N_("Nothing to do"));
284 case LFUN_UNKNOWN_ACTION:
285 #ifndef HAVE_LIBAIKSAURUS
286 case LFUN_THESAURUS_ENTRY:
292 flag |= lyx_gui::getStatus(ev);
295 if (flag.unknown()) {
296 setStatusMessage(N_("Unknown action"));
300 // the default error message if we disable the command
301 setStatusMessage(N_("Command disabled"));
303 // Check whether we need a buffer
304 if (!lyxaction.funcHasFlag(ev.action, LyXAction::NoBuffer)) {
305 // Yes we need a buffer, do we have one?
308 // Can we use a readonly buffer?
309 if (buf->isReadonly() &&
310 !lyxaction.funcHasFlag(ev.action,
311 LyXAction::ReadOnly)) {
313 setStatusMessage(N_("Document is read-only"));
318 setStatusMessage(N_("Command not allowed with"
319 "out any document open"));
325 UpdatableInset * tli = view()->cursor().innerInset();
326 InsetTabular * tab = view()->cursor().innerInsetTabular();
328 // I would really like to avoid having this switch and rather try to
329 // encode this in the function itself.
330 bool disable = false;
333 disable = ev.argument != "custom"
334 && !Exporter::IsExportable(*buf, ev.argument);
337 disable = buf->undostack().empty();
340 disable = buf->redostack().empty();
344 if (tab && tab->hasSelection())
347 disable = !mathcursor && !view()->getLyXText()->selection.set();
351 disable = !buf->isLatex() || lyxrc.chktex_command == "none";
355 disable = !Exporter::IsExportable(*buf, "program");
358 case LFUN_LAYOUT_TABULAR:
359 disable = !view()->cursor().innerInsetTabular();
363 disable = !changeDepthAllowed(view(), view()->getLyXText(), DEC_DEPTH);
366 case LFUN_DEPTH_PLUS:
367 disable = !changeDepthAllowed(view(), view()->getLyXText(), INC_DEPTH);
371 case LFUN_LAYOUT_PARAGRAPH: {
372 InsetOld * inset = view()->getLyXText()->cursorPar()->inInset();
373 disable = inset && inset->forceDefaultParagraphs(inset);
377 case LFUN_INSET_OPTARG:
378 disable = (view()->getLyXText()->cursorPar()->layout()->optionalargs == 0);
381 case LFUN_TABULAR_FEATURE:
384 // FIXME: check temporarily disabled
386 char align = mathcursor->valign();
391 if (ev.argument.empty()) {
395 if (!contains("tcb", ev.argument[0])) {
399 flag.setOnOff(ev.argument[0] == align);
403 char align = mathcursor->halign();
408 if (ev.argument.empty()) {
412 if (!contains("lcr", ev.argument[0])) {
416 flag.setOnOff(ev.argument[0] == align);
418 disable = !mathcursor->halign();
424 //ret.disabled(true);
425 InsetTabular * tab = view()->cursor().innerInsetTabular();
427 ret = tab->getStatus(ev.argument);
434 static InsetTabular inset(*buf, 1, 1);
436 FuncStatus ret = inset.getStatus(ev.argument);
437 if (ret.onoff(true) || ret.onoff(false))
438 flag.setOnOff(false);
443 case LFUN_VC_REGISTER:
444 disable = buf->lyxvc().inUse();
446 case LFUN_VC_CHECKIN:
447 disable = !buf->lyxvc().inUse() || buf->isReadonly();
449 case LFUN_VC_CHECKOUT:
450 disable = !buf->lyxvc().inUse() || !buf->isReadonly();
454 disable = !buf->lyxvc().inUse();
456 case LFUN_MENURELOAD:
457 disable = buf->isUnnamed() || buf->isClean();
459 case LFUN_BOOKMARK_GOTO:
461 isSavedPosition(strToUnsignedInt(ev.argument));
464 case LFUN_MERGE_CHANGES:
465 case LFUN_ACCEPT_CHANGE:
466 case LFUN_REJECT_CHANGE:
467 case LFUN_ACCEPT_ALL_CHANGES:
468 case LFUN_REJECT_ALL_CHANGES:
469 disable = !buf->params().tracking_changes;
472 case LFUN_INSET_SETTINGS: {
474 UpdatableInset * inset = view()->cursor().innerInset();
479 // jump back to owner if an InsetText, so
480 // we get back to the InsetTabular or whatever
481 if (inset->lyxCode() == InsetOld::TEXT_CODE)
482 inset = inset->owner();
484 InsetOld::Code code = inset->lyxCode();
486 case InsetOld::TABULAR_CODE:
487 disable = ev.argument != "tabular";
489 case InsetOld::ERT_CODE:
490 disable = ev.argument != "ert";
492 case InsetOld::FLOAT_CODE:
493 disable = ev.argument != "float";
495 case InsetOld::WRAP_CODE:
496 disable = ev.argument != "wrap";
498 case InsetOld::NOTE_CODE:
499 disable = ev.argument != "note";
501 case InsetOld::BRANCH_CODE:
502 disable = ev.argument != "branch";
504 case InsetOld::BOX_CODE:
505 disable = ev.argument != "box";
513 case LFUN_MATH_MUTATE:
515 //flag.setOnOff(mathcursor->formula()->hullType() == ev.argument);
516 flag.setOnOff(false);
521 // we just need to be in math mode to enable that
523 case LFUN_MATH_SPACE:
524 case LFUN_MATH_LIMITS:
525 case LFUN_MATH_NONUMBER:
526 case LFUN_MATH_NUMBER:
527 case LFUN_MATH_EXTERN:
528 disable = !mathcursor;
531 case LFUN_DIALOG_SHOW: {
532 string const name = ev.getArg(0);
534 disable = !(name == "aboutlyx" ||
537 name == "preferences" ||
542 if (name == "print") {
543 disable = !Exporter::IsExportable(*buf, "dvi") ||
544 lyxrc.print_command == "none";
545 } else if (name == "character") {
546 UpdatableInset * tli = view()->cursor().innerInset();
547 disable = tli && tli->lyxCode() == InsetOld::ERT_CODE;
548 } else if (name == "vclog") {
549 disable = !buf->lyxvc().inUse();
550 } else if (name == "latexlog") {
551 disable = !IsFileReadable(buf->getLogName().second);
560 // the functions which insert insets
561 InsetOld::Code code = InsetOld::NO_CODE;
563 case LFUN_DIALOG_SHOW_NEW_INSET:
564 if (ev.argument == "bibitem")
565 code = InsetOld::BIBITEM_CODE;
566 else if (ev.argument == "bibtex")
567 code = InsetOld::BIBTEX_CODE;
568 else if (ev.argument == "box")
569 code = InsetOld::BOX_CODE;
570 else if (ev.argument == "branch")
571 code = InsetOld::BRANCH_CODE;
572 else if (ev.argument == "citation")
573 code = InsetOld::CITE_CODE;
574 else if (ev.argument == "ert")
575 code = InsetOld::ERT_CODE;
576 else if (ev.argument == "external")
577 code = InsetOld::EXTERNAL_CODE;
578 else if (ev.argument == "float")
579 code = InsetOld::FLOAT_CODE;
580 else if (ev.argument == "graphics")
581 code = InsetOld::GRAPHICS_CODE;
582 else if (ev.argument == "include")
583 code = InsetOld::INCLUDE_CODE;
584 else if (ev.argument == "index")
585 code = InsetOld::INDEX_CODE;
586 else if (ev.argument == "label")
587 code = InsetOld::LABEL_CODE;
588 else if (ev.argument == "note")
589 code = InsetOld::NOTE_CODE;
590 else if (ev.argument == "ref")
591 code = InsetOld::REF_CODE;
592 else if (ev.argument == "toc")
593 code = InsetOld::TOC_CODE;
594 else if (ev.argument == "url")
595 code = InsetOld::URL_CODE;
596 else if (ev.argument == "vspace")
597 code = InsetOld::VSPACE_CODE;
598 else if (ev.argument == "wrap")
599 code = InsetOld::WRAP_CODE;
603 code = InsetOld::ERT_CODE;
605 case LFUN_INSET_FOOTNOTE:
606 code = InsetOld::FOOT_CODE;
608 case LFUN_TABULAR_INSERT:
609 code = InsetOld::TABULAR_CODE;
611 case LFUN_INSET_MARGINAL:
612 code = InsetOld::MARGIN_CODE;
614 case LFUN_INSET_FLOAT:
615 case LFUN_INSET_WIDE_FLOAT:
616 code = InsetOld::FLOAT_CODE;
618 case LFUN_INSET_WRAP:
619 code = InsetOld::WRAP_CODE;
621 case LFUN_FLOAT_LIST:
622 code = InsetOld::FLOAT_LIST_CODE;
625 case LFUN_INSET_LIST:
626 code = InsetOld::LIST_CODE;
628 case LFUN_INSET_THEOREM:
629 code = InsetOld::THEOREM_CODE;
632 case LFUN_INSET_CAPTION:
633 code = InsetOld::CAPTION_CODE;
635 case LFUN_INSERT_NOTE:
636 code = InsetOld::NOTE_CODE;
638 case LFUN_INSERT_CHARSTYLE:
639 code = InsetOld::CHARSTYLE_CODE;
640 if (buf->params().getLyXTextClass().charstyles().empty())
643 case LFUN_INSERT_BOX:
644 code = InsetOld::BOX_CODE;
646 case LFUN_INSERT_BRANCH:
647 code = InsetOld::BRANCH_CODE;
648 if (buf->params().branchlist().empty())
651 case LFUN_INSERT_LABEL:
652 code = InsetOld::LABEL_CODE;
654 case LFUN_INSET_OPTARG:
655 code = InsetOld::OPTARG_CODE;
657 case LFUN_ENVIRONMENT_INSERT:
658 code = InsetOld::BOX_CODE;
660 case LFUN_INDEX_INSERT:
661 code = InsetOld::INDEX_CODE;
663 case LFUN_INDEX_PRINT:
664 code = InsetOld::INDEX_PRINT_CODE;
666 case LFUN_TOC_INSERT:
667 code = InsetOld::TOC_CODE;
671 code = InsetOld::URL_CODE;
674 // always allow this, since we will inset a raw quote
675 // if an inset is not allowed.
677 case LFUN_HYPHENATION:
678 case LFUN_LIGATURE_BREAK:
680 case LFUN_MENU_SEPARATOR:
682 case LFUN_END_OF_SENTENCE:
683 code = InsetOld::SPECIALCHAR_CODE;
685 case LFUN_SPACE_INSERT:
686 // slight hack: we know this is allowed in math mode
688 code = InsetOld::SPACE_CODE;
690 case LFUN_INSET_DIALOG_SHOW: {
691 InsetOld * inset = view()->getLyXText()->getInset();
694 code = inset->lyxCode();
695 if (!(code == InsetOld::INCLUDE_CODE
696 || code == InsetOld::BIBTEX_CODE
697 || code == InsetOld::FLOAT_LIST_CODE
698 || code == InsetOld::TOC_CODE))
706 if (code != InsetOld::NO_CODE && tli && !tli->insetAllowed(code))
712 // A few general toggles
714 case LFUN_TOOLTIPS_TOGGLE:
715 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
718 case LFUN_READ_ONLY_TOGGLE:
719 flag.setOnOff(buf->isReadonly());
722 flag.setOnOff(view()->getLyXText()->cursorPar()->params().startOfAppendix());
724 case LFUN_SWITCHBUFFER:
725 // toggle on the current buffer, but do not toggle off
726 // the other ones (is that a good idea?)
727 if (ev.argument == buf->fileName())
730 case LFUN_TRACK_CHANGES:
731 flag.setOnOff(buf->params().tracking_changes);
738 // the font related toggles
740 LyXFont const & font = view()->getLyXText()->real_current_font;
743 flag.setOnOff(font.emph() == LyXFont::ON);
746 flag.setOnOff(font.noun() == LyXFont::ON);
749 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
752 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
755 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
758 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
764 string tc = mathcursor->getLastCode();
767 flag.setOnOff(tc == "mathbf");
770 flag.setOnOff(tc == "mathsf");
773 flag.setOnOff(tc == "mathcal");
776 flag.setOnOff(tc == "mathrm");
779 flag.setOnOff(tc == "mathtt");
782 flag.setOnOff(tc == "mathbb");
785 flag.setOnOff(tc == "mathnormal");
793 // this one is difficult to get right. As a half-baked
794 // solution, we consider only the first action of the sequence
795 if (ev.action == LFUN_SEQUENCE) {
796 // argument contains ';'-terminated commands
797 #warning LyXAction arguments not handled here.
798 flag = getStatus(FuncRequest(lyxaction.lookupFunc(token(ev.argument, ';', 0))));
807 bool ensureBufferClean(BufferView * bv)
809 Buffer & buf = *bv->buffer();
813 string const file = MakeDisplayPath(buf.fileName(), 30);
814 string text = bformat(_("The document %1$s has unsaved "
815 "changes.\n\nDo you want to save "
816 "the document?"), file);
817 int const ret = Alert::prompt(_("Save changed document?"),
818 text, 0, 1, _("&Save"),
822 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
824 return buf.isClean();
830 void LyXFunc::dispatch(FuncRequest const & func, bool verbose)
832 string argument = func.argument;
833 kb_action action = func.action;
835 //lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << func << endl;
836 lyxerr << "LyXFunc::dispatch: cmd: " << func << endl;
838 // we have not done anything wrong yet.
840 dispatch_buffer.erase();
842 #ifdef NEW_DISPATCHER
843 // We try do call the most specific dispatcher first:
844 // 1. the lockinginset's dispatch
845 // 2. the bufferview's dispatch
846 // 3. the lyxview's dispatch
849 selection_possible = false;
851 // We cannot use this function here
852 if (getStatus(func).disabled()) {
853 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
854 << lyxaction.getActionName(action)
855 << " [" << action << "] is disabled at this location"
857 setErrorMessage(getStatusMessage());
861 if (view()->available())
862 view()->hideCursor();
867 if (!view()->available())
869 view()->cursor().pop();
870 // Tell the paragraph dialog that we changed paragraph
871 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
875 case LFUN_WORDFINDFORWARD:
876 case LFUN_WORDFINDBACKWARD: {
877 static string last_search;
878 string searched_string;
880 if (!argument.empty()) {
881 last_search = argument;
882 searched_string = argument;
884 searched_string = last_search;
886 if (searched_string.empty())
889 bool const fw = action == LFUN_WORDFINDFORWARD;
891 lyx::find::find2string(searched_string,
893 FuncRequest const fr(view(), LFUN_WORD_FIND, data);
894 view()->dispatch(fr);
899 owner->message(keyseq.printOptions());
902 case LFUN_EXEC_COMMAND:
903 owner->focus_command_buffer();
908 meta_fake_bit = key_modifier::none;
909 if (view()->available())
910 // cancel any selection
911 dispatch(FuncRequest(LFUN_MARK_OFF));
912 setMessage(N_("Cancel"));
916 meta_fake_bit = key_modifier::alt;
917 setMessage(keyseq.print());
920 case LFUN_READ_ONLY_TOGGLE:
921 if (owner->buffer()->lyxvc().inUse())
922 owner->buffer()->lyxvc().toggleReadOnly();
924 owner->buffer()->setReadonly(
925 !owner->buffer()->isReadonly());
928 case LFUN_CENTER: // this is center and redraw.
932 // --- Menus -----------------------------------------------
934 menuNew(argument, false);
937 case LFUN_MENUNEWTMPLT:
938 menuNew(argument, true);
941 case LFUN_CLOSEBUFFER:
946 if (!owner->buffer()->isUnnamed()) {
947 string const str = bformat(_("Saving document %1$s..."),
948 MakeDisplayPath(owner->buffer()->fileName()));
950 MenuWrite(owner->buffer());
951 owner->message(str + _(" done."));
953 WriteAs(owner->buffer());
957 WriteAs(owner->buffer(), argument);
960 case LFUN_MENURELOAD: {
961 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
962 string text = bformat(_("Any changes will be lost. Are you sure "
963 "you want to revert to the saved version of the document %1$s?"), file);
964 int const ret = Alert::prompt(_("Revert to saved document?"),
965 text, 0, 1, _("&Revert"), _("&Cancel"));
973 Exporter::Export(owner->buffer(), argument, true);
974 view()->showErrorList(BufferFormat(*owner->buffer()));
978 Exporter::Preview(owner->buffer(), argument);
979 view()->showErrorList(BufferFormat(*owner->buffer()));
983 Exporter::Export(owner->buffer(), "program", true);
984 view()->showErrorList(_("Build"));
988 owner->buffer()->runChktex();
989 view()->showErrorList(_("ChkTeX"));
993 if (argument == "custom")
994 owner->getDialogs().showSendto();
996 Exporter::Export(owner->buffer(), argument, false);
997 view()->showErrorList(BufferFormat(*owner->buffer()));
1009 case LFUN_TOCVIEW: {
1010 InsetCommandParams p("tableofcontents");
1011 string const data = InsetCommandMailer::params2string("toc", p);
1012 owner->getDialogs().show("toc", data, 0);
1028 case LFUN_RECONFIGURE:
1029 Reconfigure(view());
1032 case LFUN_HELP_OPEN: {
1033 string const arg = argument;
1035 setErrorMessage(N_("Missing argument"));
1038 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1039 if (fname.empty()) {
1040 lyxerr << "LyX: unable to find documentation file `"
1041 << arg << "'. Bad installation?" << endl;
1044 owner->message(bformat(_("Opening help file %1$s..."),
1045 MakeDisplayPath(fname)));
1046 view()->loadLyXFile(fname, false);
1050 // --- version control -------------------------------
1051 case LFUN_VC_REGISTER:
1052 if (!ensureBufferClean(view()))
1054 if (!owner->buffer()->lyxvc().inUse()) {
1055 owner->buffer()->lyxvc().registrer();
1060 case LFUN_VC_CHECKIN:
1061 if (!ensureBufferClean(view()))
1063 if (owner->buffer()->lyxvc().inUse()
1064 && !owner->buffer()->isReadonly()) {
1065 owner->buffer()->lyxvc().checkIn();
1070 case LFUN_VC_CHECKOUT:
1071 if (!ensureBufferClean(view()))
1073 if (owner->buffer()->lyxvc().inUse()
1074 && owner->buffer()->isReadonly()) {
1075 owner->buffer()->lyxvc().checkOut();
1080 case LFUN_VC_REVERT:
1081 owner->buffer()->lyxvc().revert();
1086 owner->buffer()->lyxvc().undoLast();
1090 // --- buffers ----------------------------------------
1091 case LFUN_SWITCHBUFFER:
1092 view()->buffer(bufferlist.getBuffer(argument));
1096 NewFile(view(), argument);
1099 case LFUN_FILE_OPEN:
1103 case LFUN_LAYOUT_TABULAR:
1104 if (InsetTabular * tab = view()->cursor().innerInsetTabular())
1105 tab->openLayoutDialog(view());
1108 case LFUN_DROP_LAYOUTS_CHOICE:
1109 owner->getToolbar().openLayoutList();
1112 case LFUN_MENU_OPEN_BY_NAME:
1113 owner->getMenubar().openByName(argument);
1116 // --- lyxserver commands ----------------------------
1118 setMessage(owner->buffer()->fileName());
1119 lyxerr[Debug::INFO] << "FNAME["
1120 << owner->buffer()->fileName()
1125 dispatch_buffer = keyseq.print();
1126 lyxserver->notifyClient(dispatch_buffer);
1129 case LFUN_GOTOFILEROW: {
1132 istringstream is(argument);
1133 is >> file_name >> row;
1134 if (prefixIs(file_name, getTmpDir())) {
1135 // Needed by inverse dvi search. If it is a file
1136 // in tmpdir, call the apropriated function
1137 view()->buffer(bufferlist.getBufferFromTmp(file_name));
1139 // Must replace extension of the file to be .lyx
1140 // and get full path
1141 string const s = ChangeExtension(file_name, ".lyx");
1142 // Either change buffer or load the file
1143 if (bufferlist.exists(s)) {
1144 view()->buffer(bufferlist.getBuffer(s));
1146 view()->loadLyXFile(s);
1150 view()->setCursorFromRow(row);
1153 // see BufferView_pimpl::center()
1154 view()->updateScrollbar();
1158 case LFUN_GOTO_PARAGRAPH: {
1159 istringstream is(argument);
1162 ParIterator par = owner->buffer()->getParFromID(id);
1163 if (par == owner->buffer()->par_iterator_end()) {
1164 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1165 << id << ']' << endl;
1168 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1169 << " found." << endl;
1172 par.lockPath(view());
1173 LyXText * lt = par.text(*view()->buffer());
1176 lt->setCursor(par.pit(), 0);
1177 view()->switchKeyMap();
1178 owner->view_state_changed();
1181 // see BufferView_pimpl::center()
1182 view()->updateScrollbar();
1186 // --- Mathed stuff. If we are here, there is no locked inset yet.
1187 case LFUN_MATH_EXTERN:
1188 case LFUN_MATH_NUMBER:
1189 case LFUN_MATH_NONUMBER:
1190 case LFUN_MATH_LIMITS:
1191 setErrorMessage(N_("This is only allowed in math mode!"));
1194 case LFUN_DIALOG_SHOW: {
1195 string const name = func.getArg(0);
1196 string data = trim(func.argument.substr(name.size()));
1198 if (name == "character") {
1199 data = freefont2string();
1201 owner->getDialogs().show("character", data);
1203 else if (name == "document")
1204 owner->getDialogs().showDocument();
1205 else if (name == "findreplace")
1206 owner->getDialogs().showSearch();
1207 else if (name == "forks")
1208 owner->getDialogs().showForks();
1209 else if (name == "preamble")
1210 owner->getDialogs().showPreamble();
1211 else if (name == "preferences")
1212 owner->getDialogs().showPreferences();
1213 else if (name == "print")
1214 owner->getDialogs().showPrint();
1215 else if (name == "spellchecker")
1216 owner->getDialogs().showSpellchecker();
1218 else if (name == "latexlog") {
1219 pair<Buffer::LogType, string> const logfile =
1220 owner->buffer()->getLogName();
1221 switch (logfile.first) {
1222 case Buffer::latexlog:
1225 case Buffer::buildlog:
1229 data += logfile.second;
1230 owner->getDialogs().show("log", data);
1232 else if (name == "vclog") {
1233 string const data = "vc " +
1234 owner->buffer()->lyxvc().getLogFile();
1235 owner->getDialogs().show("log", data);
1238 owner->getDialogs().show(name, data);
1242 case LFUN_DIALOG_SHOW_NEW_INSET: {
1243 string const name = func.getArg(0);
1244 string data = trim(func.argument.substr(name.size()));
1245 if (name == "bibitem" ||
1247 name == "include" ||
1253 InsetCommandParams p(name);
1254 data = InsetCommandMailer::params2string(name, p);
1255 } else if (name == "box") {
1256 // \c data == "Boxed" || "Frameless" etc
1257 InsetBoxParams p(data);
1258 data = InsetBoxMailer::params2string(p);
1259 } else if (name == "branch") {
1260 InsetBranchParams p;
1261 data = InsetBranchMailer::params2string(p);
1262 } else if (name == "citation") {
1263 InsetCommandParams p("cite");
1264 data = InsetCommandMailer::params2string(name, p);
1265 } else if (name == "ert") {
1266 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1267 } else if (name == "external") {
1268 InsetExternalParams p;
1269 Buffer const & buffer = *owner->buffer();
1270 data = InsetExternalMailer::params2string(p, buffer);
1271 } else if (name == "float") {
1273 data = InsetFloatMailer::params2string(p);
1274 } else if (name == "graphics") {
1275 InsetGraphicsParams p;
1276 Buffer const & buffer = *owner->buffer();
1277 data = InsetGraphicsMailer::params2string(p, buffer);
1278 } else if (name == "note") {
1280 data = InsetNoteMailer::params2string(p);
1281 } else if (name == "vspace") {
1283 data = InsetVSpaceMailer::params2string(space);
1284 } else if (name == "wrap") {
1286 data = InsetWrapMailer::params2string(p);
1288 owner->getDialogs().show(name, data, 0);
1292 case LFUN_DIALOG_SHOW_NEXT_INSET:
1295 case LFUN_INSET_DIALOG_SHOW: {
1296 InsetOld * inset = view()->getLyXText()->getInset();
1298 inset->dispatch(FuncRequest(view(), LFUN_INSET_DIALOG_SHOW));
1302 case LFUN_DIALOG_UPDATE: {
1303 string const & name = argument;
1304 // Can only update a dialog connected to an existing inset
1305 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1307 FuncRequest fr(view(), LFUN_INSET_DIALOG_UPDATE,
1309 inset->dispatch(fr);
1310 } else if (name == "paragraph") {
1311 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1316 case LFUN_DIALOG_HIDE:
1317 Dialogs::hide(argument, 0);
1320 case LFUN_DIALOG_DISCONNECT_INSET:
1321 owner->getDialogs().disconnect(argument);
1324 case LFUN_CHILDOPEN: {
1325 string const filename =
1326 MakeAbsPath(argument, owner->buffer()->filePath());
1327 setMessage(N_("Opening child document ") +
1328 MakeDisplayPath(filename) + "...");
1329 view()->savePosition(0);
1330 string const parentfilename = owner->buffer()->fileName();
1331 if (bufferlist.exists(filename))
1332 view()->buffer(bufferlist.getBuffer(filename));
1334 view()->loadLyXFile(filename);
1335 // Set the parent name of the child document.
1336 // This makes insertion of citations and references in the child work,
1337 // when the target is in the parent or another child document.
1338 owner->buffer()->setParentName(parentfilename);
1342 case LFUN_TOGGLECURSORFOLLOW:
1343 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1347 owner->getIntl().KeyMapOn(false);
1350 case LFUN_KMAP_PRIM:
1351 owner->getIntl().KeyMapPrim();
1355 owner->getIntl().KeyMapSec();
1358 case LFUN_KMAP_TOGGLE:
1359 owner->getIntl().ToggleKeyMap();
1365 argument = split(argument, countstr, ' ');
1366 istringstream is(countstr);
1369 lyxerr << "repeat: count: " << count << " cmd: " << argument << endl;
1370 for (int i = 0; i < count; ++i)
1371 dispatch(lyxaction.lookupFunc(argument));
1376 // argument contains ';'-terminated commands
1377 while (!argument.empty()) {
1379 argument = split(argument, first, ';');
1380 dispatch(lyxaction.lookupFunc(first));
1384 case LFUN_SAVEPREFERENCES: {
1385 Path p(user_lyxdir());
1386 lyxrc.write("preferences");
1390 case LFUN_SCREEN_FONT_UPDATE:
1391 // handle the screen font changes.
1392 lyxrc.set_font_norm_type();
1393 lyx_gui::update_fonts();
1394 // All visible buffers will need resize
1398 case LFUN_SET_COLOR: {
1400 string const x11_name = split(argument, lyx_name, ' ');
1401 if (lyx_name.empty() || x11_name.empty()) {
1402 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1407 bool const graphicsbg_changed =
1408 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1409 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1411 LColor::color col = lcolor.getFromLyXName(lyx_name);
1412 if (!lcolor.setColor(col, x11_name)) {
1414 bformat(_("Set-color \"%1$s\" failed "
1415 "- color is undefined or "
1416 "may not be redefined"), lyx_name));
1420 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1422 if (graphicsbg_changed) {
1423 #ifdef WITH_WARNINGS
1424 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1427 lyx::graphics::GCache::get().changeDisplay(true);
1434 owner->message(argument);
1437 case LFUN_FORKS_KILL:
1438 if (isStrInt(argument))
1439 ForkedcallsController::get().kill(strToInt(argument));
1442 case LFUN_TOOLTIPS_TOGGLE:
1443 owner->getDialogs().toggleTooltips();
1446 case LFUN_EXTERNAL_EDIT:
1447 InsetExternal().dispatch(FuncRequest(view(), action, argument));
1451 DispatchResult result =
1452 view()->cursor().dispatch(FuncRequest(func, view()));
1453 if (result.dispatched())
1454 lyxerr << "dispatched by Cursor::dispatch()" << endl;
1456 lyxerr << "### NOT DISPATCHED BY Cursor::dispatch() ###" << endl;
1462 view()->owner()->updateLayoutChoice();
1464 if (view()->available()) {
1465 view()->fitCursor();
1467 view()->cursor().updatePos();
1468 // if we executed a mutating lfun, mark the buffer as dirty
1469 if (!getStatus(func).disabled()
1470 && !lyxaction.funcHasFlag(func.action, LyXAction::NoBuffer)
1471 && !lyxaction.funcHasFlag(func.action, LyXAction::ReadOnly))
1472 view()->buffer()->markDirty();
1475 sendDispatchMessage(getMessage(), func, verbose);
1479 void LyXFunc::sendDispatchMessage(string const & msg,
1480 FuncRequest const & func, bool verbose)
1482 owner->updateMenubar();
1483 owner->updateToolbar();
1485 if (func.action == LFUN_SELFINSERT || !verbose) {
1486 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1488 owner->message(msg);
1492 string dispatch_msg = msg;
1493 if (!dispatch_msg.empty())
1494 dispatch_msg += ' ';
1496 string comname = lyxaction.getActionName(func.action);
1498 bool argsadded = false;
1500 if (!func.argument.empty()) {
1501 if (func.action != LFUN_UNKNOWN_ACTION) {
1502 comname += ' ' + func.argument;
1507 string const shortcuts = toplevel_keymap->findbinding(func);
1509 if (!shortcuts.empty()) {
1510 comname += ": " + shortcuts;
1511 } else if (!argsadded && !func.argument.empty()) {
1512 comname += ' ' + func.argument;
1515 if (!comname.empty()) {
1516 comname = rtrim(comname);
1517 dispatch_msg += '(' + comname + ')';
1520 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1521 if (!dispatch_msg.empty())
1522 owner->message(dispatch_msg);
1526 void LyXFunc::setupLocalKeymap()
1528 keyseq.stdmap = toplevel_keymap.get();
1529 keyseq.curmap = toplevel_keymap.get();
1530 cancel_meta_seq.stdmap = toplevel_keymap.get();
1531 cancel_meta_seq.curmap = toplevel_keymap.get();
1535 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1537 string initpath = lyxrc.document_path;
1538 string filename(name);
1540 if (view()->available()) {
1541 string const trypath = owner->buffer()->filePath();
1542 // If directory is writeable, use this as default.
1543 if (IsDirWriteable(trypath))
1547 static int newfile_number;
1549 if (filename.empty()) {
1550 filename = AddName(lyxrc.document_path,
1551 "newfile" + tostr(++newfile_number) + ".lyx");
1552 FileInfo fi(filename);
1553 while (bufferlist.exists(filename) || fi.readable()) {
1555 filename = AddName(lyxrc.document_path,
1556 "newfile" + tostr(newfile_number) +
1558 fi.newFile(filename);
1562 // The template stuff
1565 FileDialog fileDlg(_("Select template file"),
1566 LFUN_SELECT_FILE_SYNC,
1567 make_pair(string(_("Documents|#o#O")),
1568 string(lyxrc.document_path)),
1569 make_pair(string(_("Templates|#T#t")),
1570 string(lyxrc.template_path)));
1572 FileDialog::Result result =
1573 fileDlg.open(lyxrc.template_path,
1574 FileFilterList(_("LyX Documents (*.lyx)")),
1577 if (result.first == FileDialog::Later)
1579 if (result.second.empty())
1581 templname = result.second;
1584 view()->newFile(filename, templname, !name.empty());
1588 void LyXFunc::open(string const & fname)
1590 string initpath = lyxrc.document_path;
1592 if (view()->available()) {
1593 string const trypath = owner->buffer()->filePath();
1594 // If directory is writeable, use this as default.
1595 if (IsDirWriteable(trypath))
1601 if (fname.empty()) {
1602 FileDialog fileDlg(_("Select document to open"),
1604 make_pair(string(_("Documents|#o#O")),
1605 string(lyxrc.document_path)),
1606 make_pair(string(_("Examples|#E#e")),
1607 string(AddPath(system_lyxdir(), "examples"))));
1609 FileDialog::Result result =
1610 fileDlg.open(initpath,
1611 FileFilterList(_("LyX Documents (*.lyx)")),
1614 if (result.first == FileDialog::Later)
1617 filename = result.second;
1619 // check selected filename
1620 if (filename.empty()) {
1621 owner->message(_("Canceled."));
1627 // get absolute path of file and add ".lyx" to the filename if
1629 string const fullpath = FileSearch(string(), filename, "lyx");
1630 if (!fullpath.empty()) {
1631 filename = fullpath;
1634 string const disp_fn(MakeDisplayPath(filename));
1636 // if the file doesn't exist, let the user create one
1637 FileInfo const f(filename, true);
1639 // the user specifically chose this name. Believe them.
1640 view()->newFile(filename, "", true);
1644 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1647 if (view()->loadLyXFile(filename)) {
1648 str2 = bformat(_("Document %1$s opened."), disp_fn);
1650 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1652 owner->message(str2);
1656 void LyXFunc::doImport(string const & argument)
1659 string filename = split(argument, format, ' ');
1661 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1662 << " file: " << filename << endl;
1664 // need user interaction
1665 if (filename.empty()) {
1666 string initpath = lyxrc.document_path;
1668 if (view()->available()) {
1669 string const trypath = owner->buffer()->filePath();
1670 // If directory is writeable, use this as default.
1671 if (IsDirWriteable(trypath))
1675 string const text = bformat(_("Select %1$s file to import"),
1676 formats.prettyName(format));
1678 FileDialog fileDlg(text,
1680 make_pair(string(_("Documents|#o#O")),
1681 string(lyxrc.document_path)),
1682 make_pair(string(_("Examples|#E#e")),
1683 string(AddPath(system_lyxdir(), "examples"))));
1685 string const filter = formats.prettyName(format)
1686 + " (*." + formats.extension(format) + ')';
1688 FileDialog::Result result =
1689 fileDlg.open(initpath,
1690 FileFilterList(filter),
1693 if (result.first == FileDialog::Later)
1696 filename = result.second;
1698 // check selected filename
1699 if (filename.empty())
1700 owner->message(_("Canceled."));
1703 if (filename.empty())
1706 // get absolute path of file
1707 filename = MakeAbsPath(filename);
1709 string const lyxfile = ChangeExtension(filename, ".lyx");
1711 // Check if the document already is open
1712 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1713 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1714 owner->message(_("Canceled."));
1719 // if the file exists already, and we didn't do
1720 // -i lyx thefile.lyx, warn
1721 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1722 string const file = MakeDisplayPath(lyxfile, 30);
1724 string text = bformat(_("The document %1$s already exists.\n\n"
1725 "Do you want to over-write that document?"), file);
1726 int const ret = Alert::prompt(_("Over-write document?"),
1727 text, 0, 1, _("&Over-write"), _("&Cancel"));
1730 owner->message(_("Canceled."));
1735 Importer::Import(owner, filename, format);
1739 void LyXFunc::closeBuffer()
1741 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1742 if (bufferlist.empty()) {
1743 // need this otherwise SEGV may occur while
1744 // trying to set variables that don't exist
1745 // since there's no current buffer
1746 owner->getDialogs().hideBufferDependent();
1748 view()->buffer(bufferlist.first());
1754 // Each "owner" should have it's own message method. lyxview and
1755 // the minibuffer would use the minibuffer, but lyxserver would
1756 // send an ERROR signal to its client. Alejandro 970603
1757 // This func is bit problematic when it comes to NLS, to make the
1758 // lyx servers client be language indepenent we must not translate
1759 // strings sent to this func.
1760 void LyXFunc::setErrorMessage(string const & m) const
1762 dispatch_buffer = m;
1767 void LyXFunc::setMessage(string const & m) const
1769 dispatch_buffer = m;
1773 void LyXFunc::setStatusMessage(string const & m) const
1779 string const LyXFunc::view_status_message()
1781 // When meta-fake key is pressed, show the key sequence so far + "M-".
1783 return keyseq.print() + "M-";
1786 // Else, when a non-complete key sequence is pressed,
1787 // show the available options.
1788 if (keyseq.length() > 0 && !keyseq.deleted()) {
1789 return keyseq.printOptions();
1792 if (!view()->available())
1793 return _("Welcome to LyX!");
1795 return currentState(view());
1799 BufferView * LyXFunc::view() const
1801 BOOST_ASSERT(owner);
1802 return owner->view().get();
1806 bool LyXFunc::wasMetaKey() const
1808 return (meta_fake_bit != key_modifier::none);