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/insetcommand.h"
55 #include "insets/insetexternal.h"
56 #include "insets/insettabular.h"
58 #include "mathed/math_cursor.h"
60 #include "frontends/Alert.h"
61 #include "frontends/Dialogs.h"
62 #include "frontends/FileDialog.h"
63 #include "frontends/lyx_gui.h"
64 #include "frontends/LyXKeySym.h"
65 #include "frontends/LyXView.h"
66 #include "frontends/Menubar.h"
67 #include "frontends/Toolbar.h"
69 #include "support/FileInfo.h"
70 #include "support/filetools.h"
71 #include "support/forkedcontr.h"
72 #include "support/path.h"
73 #include "support/path_defines.h"
74 #include "support/tostr.h"
75 #include "support/std_sstream.h"
76 #include "support/os.h"
78 using bv_funcs::changeDepth;
79 using bv_funcs::currentState;
80 using bv_funcs::DEC_DEPTH;
81 using bv_funcs::freefont2string;
82 using bv_funcs::INC_DEPTH;
84 using lyx::support::AddName;
85 using lyx::support::AddPath;
86 using lyx::support::bformat;
87 using lyx::support::ChangeExtension;
88 using lyx::support::FileInfo;
89 using lyx::support::FileSearch;
90 using lyx::support::ForkedcallsController;
91 using lyx::support::i18nLibFileSearch;
92 using lyx::support::IsDirWriteable;
93 using lyx::support::IsFileReadable;
94 using lyx::support::isStrInt;
95 using lyx::support::MakeAbsPath;
96 using lyx::support::MakeDisplayPath;
97 using lyx::support::Path;
98 using lyx::support::rtrim;
99 using lyx::support::split;
100 using lyx::support::strToInt;
101 using lyx::support::strToUnsignedInt;
102 using lyx::support::system_lyxdir;
103 using lyx::support::token;
104 using lyx::support::trim;
105 using lyx::support::user_lyxdir;
106 using lyx::support::prefixIs;
107 using lyx::support::os::getTmpDir;
110 using std::make_pair;
112 using std::istringstream;
115 extern BufferList bufferlist;
116 extern LyXServer * lyxserver;
117 extern bool selection_possible;
119 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
122 extern tex_accent_struct get_accent(kb_action action);
125 LyXFunc::LyXFunc(LyXView * lv)
128 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
129 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
130 meta_fake_bit(key_modifier::none)
135 void LyXFunc::handleKeyFunc(kb_action action)
137 char c = encoded_last_key;
139 if (keyseq.length()) {
143 owner->getIntl().getTransManager()
144 .deadkey(c, get_accent(action).accent, view()->getLyXText());
145 // Need to clear, in case the minibuffer calls these
148 // copied verbatim from do_accent_char
150 view()->getLyXText()->selection.cursor = view()->getLyXText()->cursor;
154 void LyXFunc::processKeySym(LyXKeySymPtr keysym,
155 key_modifier::state state)
159 if (lyxerr.debugging(Debug::KEY)) {
160 lyxerr << "KeySym is "
161 << keysym->getSymbolName()
165 // Do nothing if we have nothing (JMarc)
166 if (!keysym->isOK()) {
167 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
172 if (keysym->isModifier()) {
173 lyxerr[Debug::KEY] << "isModifier true" << endl;
177 Encoding const * encoding = view()->getEncoding();
179 encoded_last_key = keysym->getISOEncoded(encoding ? encoding->Name() : "");
181 // Do a one-deep top-level lookup for
182 // cancel and meta-fake keys. RVDK_PATCH_5
183 cancel_meta_seq.reset();
185 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
186 lyxerr[Debug::KEY] << "action first set to [" << func.action << ']' << endl;
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;
198 // Dont remove this unless you know what you are doing.
199 meta_fake_bit = key_modifier::none;
201 // can this happen now ?
202 if (func.action == LFUN_NOACTION) {
203 func = FuncRequest(LFUN_PREFIX);
206 if (lyxerr.debugging(Debug::KEY)) {
207 lyxerr << "Key [action="
208 << func.action << "]["
209 << keyseq.print() << ']'
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)
217 if (keyseq.length() > 1) {
218 owner->message(keyseq.print());
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;
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
235 if (keysym->isText() && keyseq.length() == 1) {
236 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
237 func = FuncRequest(LFUN_SELFINSERT);
239 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
240 owner->message(_("Unknown function."));
245 if (func.action == LFUN_SELFINSERT) {
246 if (encoded_last_key != 0) {
248 arg += encoded_last_key;
250 dispatch(FuncRequest(view(), LFUN_SELFINSERT, arg));
252 lyxerr[Debug::KEY] << "SelfInsert arg[`"
253 << argument << "']" << endl;
261 FuncStatus LyXFunc::getStatus(FuncRequest const & ev) const
264 Buffer * buf = owner->buffer();
266 if (ev.action == LFUN_NOACTION) {
267 setStatusMessage(N_("Nothing to do"));
273 case LFUN_UNKNOWN_ACTION:
274 #ifndef HAVE_LIBAIKSAURUS
275 case LFUN_THESAURUS_ENTRY:
281 flag |= lyx_gui::getStatus(ev);
284 if (flag.unknown()) {
285 setStatusMessage(N_("Unknown action"));
289 // the default error message if we disable the command
290 setStatusMessage(N_("Command disabled"));
292 // Check whether we need a buffer
293 if (!lyxaction.funcHasFlag(ev.action, LyXAction::NoBuffer)) {
294 // Yes we need a buffer, do we have one?
297 // Can we use a readonly buffer?
298 if (buf->isReadonly() &&
299 !lyxaction.funcHasFlag(ev.action,
300 LyXAction::ReadOnly)) {
302 setStatusMessage(N_("Document is read-only"));
307 setStatusMessage(N_("Command not allowed with"
308 "out any document open"));
314 UpdatableInset * tli = view()->cursor().innerInset();
315 InsetTabular * tab = view()->cursor().innerInsetTabular();
317 // I would really like to avoid having this switch and rather try to
318 // encode this in the function itself.
319 bool disable = false;
322 disable = ev.argument != "custom"
323 && !Exporter::IsExportable(*buf, ev.argument);
326 disable = buf->undostack().empty();
329 disable = buf->redostack().empty();
333 if (tab && tab->hasSelection())
336 disable = !mathcursor && !view()->getLyXText()->selection.set();
340 disable = !buf->isLatex() || lyxrc.chktex_command == "none";
344 disable = !Exporter::IsExportable(*buf, "program");
347 case LFUN_LAYOUT_TABULAR:
348 disable = !view()->cursor().innerInsetTabular();
352 disable = !changeDepthAllowed(view(), view()->getLyXText(), DEC_DEPTH);
355 case LFUN_DEPTH_PLUS:
356 disable = !changeDepthAllowed(view(), view()->getLyXText(), INC_DEPTH);
360 case LFUN_LAYOUT_PARAGRAPH: {
361 InsetOld * inset = view()->getLyXText()->cursorPar()->inInset();
362 disable = inset && inset->forceDefaultParagraphs(inset);
366 case LFUN_INSET_OPTARG:
367 disable = (view()->getLyXText()->cursorPar()->layout()->optionalargs == 0);
370 case LFUN_TABULAR_FEATURE:
373 // FIXME: check temporarily disabled
375 char align = mathcursor->valign();
380 if (ev.argument.empty()) {
384 if (!contains("tcb", ev.argument[0])) {
388 flag.setOnOff(ev.argument[0] == align);
392 char align = mathcursor->halign();
397 if (ev.argument.empty()) {
401 if (!contains("lcr", ev.argument[0])) {
405 flag.setOnOff(ev.argument[0] == align);
407 disable = !mathcursor->halign();
413 //ret.disabled(true);
414 InsetTabular * tab = view()->cursor().innerInsetTabular();
416 ret = tab->getStatus(ev.argument);
423 static InsetTabular inset(*buf, 1, 1);
425 FuncStatus ret = inset.getStatus(ev.argument);
426 if (ret.onoff(true) || ret.onoff(false))
427 flag.setOnOff(false);
432 case LFUN_VC_REGISTER:
433 disable = buf->lyxvc().inUse();
435 case LFUN_VC_CHECKIN:
436 disable = !buf->lyxvc().inUse() || buf->isReadonly();
438 case LFUN_VC_CHECKOUT:
439 disable = !buf->lyxvc().inUse() || !buf->isReadonly();
443 disable = !buf->lyxvc().inUse();
445 case LFUN_MENURELOAD:
446 disable = buf->isUnnamed() || buf->isClean();
448 case LFUN_BOOKMARK_GOTO:
450 isSavedPosition(strToUnsignedInt(ev.argument));
453 case LFUN_MERGE_CHANGES:
454 case LFUN_ACCEPT_CHANGE:
455 case LFUN_REJECT_CHANGE:
456 case LFUN_ACCEPT_ALL_CHANGES:
457 case LFUN_REJECT_ALL_CHANGES:
458 disable = !buf->params().tracking_changes;
461 case LFUN_INSET_TOGGLE: {
462 LyXText * lt = view()->getLyXText();
463 disable = !(isEditableInset(lt->getInset())
465 && lt->inset_owner->owner()
466 && lt->inset_owner->owner()->isOpen()));
470 case LFUN_INSET_SETTINGS: {
472 UpdatableInset * inset = view()->cursor().innerInset();
477 // jump back to owner if an InsetText, so
478 // we get back to the InsetTabular or whatever
479 if (inset->lyxCode() == InsetOld::TEXT_CODE)
480 inset = inset->owner();
482 InsetOld::Code code = inset->lyxCode();
484 case InsetOld::TABULAR_CODE:
485 disable = ev.argument != "tabular";
487 case InsetOld::ERT_CODE:
488 disable = ev.argument != "ert";
490 case InsetOld::FLOAT_CODE:
491 disable = ev.argument != "float";
493 case InsetOld::MINIPAGE_CODE:
494 disable = ev.argument != "minipage";
496 case InsetOld::WRAP_CODE:
497 disable = ev.argument != "wrap";
499 case InsetOld::NOTE_CODE:
500 disable = ev.argument != "note";
502 case InsetOld::BRANCH_CODE:
503 disable = ev.argument != "branch";
505 case InsetOld::BOX_CODE:
506 disable = ev.argument != "box";
514 case LFUN_MATH_MUTATE:
516 //flag.setOnOff(mathcursor->formula()->hullType() == ev.argument);
517 flag.setOnOff(false);
522 // we just need to be in math mode to enable that
524 case LFUN_MATH_SPACE:
525 case LFUN_MATH_LIMITS:
526 case LFUN_MATH_NONUMBER:
527 case LFUN_MATH_NUMBER:
528 case LFUN_MATH_EXTERN:
529 disable = !mathcursor;
532 case LFUN_DIALOG_SHOW: {
533 string const name = ev.getArg(0);
535 disable = !(name == "aboutlyx" ||
538 name == "preferences" ||
543 if (name == "print") {
544 disable = !Exporter::IsExportable(*buf, "dvi") ||
545 lyxrc.print_command == "none";
546 } else if (name == "character") {
547 UpdatableInset * tli = view()->cursor().innerInset();
548 disable = tli && tli->lyxCode() == InsetOld::ERT_CODE;
549 } else if (name == "vclog") {
550 disable = !buf->lyxvc().inUse();
551 } else if (name == "latexlog") {
552 disable = !IsFileReadable(buf->getLogName().second);
561 // the functions which insert insets
562 InsetOld::Code code = InsetOld::NO_CODE;
564 case LFUN_DIALOG_SHOW_NEW_INSET:
565 if (ev.argument == "bibitem")
566 code = InsetOld::BIBITEM_CODE;
567 else if (ev.argument == "bibtex")
568 code = InsetOld::BIBTEX_CODE;
569 else if (ev.argument == "citation")
570 code = InsetOld::CITE_CODE;
571 else if (ev.argument == "ert")
572 code = InsetOld::ERT_CODE;
573 else if (ev.argument == "external")
574 code = InsetOld::EXTERNAL_CODE;
575 else if (ev.argument == "float")
576 code = InsetOld::FLOAT_CODE;
577 else if (ev.argument == "graphics")
578 code = InsetOld::GRAPHICS_CODE;
579 else if (ev.argument == "include")
580 code = InsetOld::INCLUDE_CODE;
581 else if (ev.argument == "index")
582 code = InsetOld::INDEX_CODE;
583 else if (ev.argument == "label")
584 code = InsetOld::LABEL_CODE;
585 else if (ev.argument == "minipage")
586 code = InsetOld::MINIPAGE_CODE;
587 else if (ev.argument == "ref")
588 code = InsetOld::REF_CODE;
589 else if (ev.argument == "toc")
590 code = InsetOld::TOC_CODE;
591 else if (ev.argument == "url")
592 code = InsetOld::URL_CODE;
593 else if (ev.argument == "wrap")
594 code = InsetOld::WRAP_CODE;
598 code = InsetOld::ERT_CODE;
600 case LFUN_INSET_FOOTNOTE:
601 code = InsetOld::FOOT_CODE;
603 case LFUN_TABULAR_INSERT:
604 code = InsetOld::TABULAR_CODE;
606 case LFUN_INSET_MARGINAL:
607 code = InsetOld::MARGIN_CODE;
609 case LFUN_INSET_MINIPAGE:
610 code = InsetOld::MINIPAGE_CODE;
612 case LFUN_INSET_FLOAT:
613 case LFUN_INSET_WIDE_FLOAT:
614 code = InsetOld::FLOAT_CODE;
616 case LFUN_INSET_WRAP:
617 code = InsetOld::WRAP_CODE;
619 case LFUN_FLOAT_LIST:
620 code = InsetOld::FLOAT_LIST_CODE;
623 case LFUN_INSET_LIST:
624 code = InsetOld::LIST_CODE;
626 case LFUN_INSET_THEOREM:
627 code = InsetOld::THEOREM_CODE;
630 case LFUN_INSET_CAPTION:
631 code = InsetOld::CAPTION_CODE;
633 case LFUN_INSERT_NOTE:
634 code = InsetOld::NOTE_CODE;
636 case LFUN_INSERT_CHARSTYLE:
637 code = InsetOld::CHARSTYLE_CODE;
638 if (buf->params().getLyXTextClass().charstyles().empty())
641 case LFUN_INSERT_BOX:
642 code = InsetOld::BOX_CODE;
644 case LFUN_INSERT_BRANCH:
645 code = InsetOld::BRANCH_CODE;
646 if (buf->params().branchlist().empty())
649 case LFUN_INSERT_LABEL:
650 code = InsetOld::LABEL_CODE;
652 case LFUN_INSET_OPTARG:
653 code = InsetOld::OPTARG_CODE;
655 case LFUN_ENVIRONMENT_INSERT:
656 code = InsetOld::MINIPAGE_CODE;
658 case LFUN_INDEX_INSERT:
659 code = InsetOld::INDEX_CODE;
661 case LFUN_INDEX_PRINT:
662 code = InsetOld::INDEX_PRINT_CODE;
664 case LFUN_TOC_INSERT:
665 code = InsetOld::TOC_CODE;
669 code = InsetOld::URL_CODE;
672 // always allow this, since we will inset a raw quote
673 // if an inset is not allowed.
675 case LFUN_HYPHENATION:
676 case LFUN_LIGATURE_BREAK:
678 case LFUN_MENU_SEPARATOR:
680 case LFUN_END_OF_SENTENCE:
681 code = InsetOld::SPECIALCHAR_CODE;
683 case LFUN_SPACE_INSERT:
684 // slight hack: we know this is allowed in math mode
686 code = InsetOld::SPACE_CODE;
688 case LFUN_INSET_DIALOG_SHOW: {
689 InsetOld * inset = view()->getLyXText()->getInset();
692 code = inset->lyxCode();
693 if (!(code == InsetOld::INCLUDE_CODE
694 || code == InsetOld::BIBTEX_CODE
695 || code == InsetOld::FLOAT_LIST_CODE
696 || code == InsetOld::TOC_CODE))
704 if (code != InsetOld::NO_CODE && tli && !tli->insetAllowed(code))
710 // A few general toggles
712 case LFUN_TOOLTIPS_TOGGLE:
713 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
716 case LFUN_READ_ONLY_TOGGLE:
717 flag.setOnOff(buf->isReadonly());
720 flag.setOnOff(view()->getLyXText()->cursorPar()->params().startOfAppendix());
722 case LFUN_SWITCHBUFFER:
723 // toggle on the current buffer, but do not toggle off
724 // the other ones (is that a good idea?)
725 if (ev.argument == buf->fileName())
728 case LFUN_TRACK_CHANGES:
729 flag.setOnOff(buf->params().tracking_changes);
736 // the font related toggles
738 LyXFont const & font = view()->getLyXText()->real_current_font;
741 flag.setOnOff(font.emph() == LyXFont::ON);
744 flag.setOnOff(font.noun() == LyXFont::ON);
747 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
750 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
753 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
756 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
762 string tc = mathcursor->getLastCode();
765 flag.setOnOff(tc == "mathbf");
768 flag.setOnOff(tc == "mathsf");
771 flag.setOnOff(tc == "mathcal");
774 flag.setOnOff(tc == "mathrm");
777 flag.setOnOff(tc == "mathtt");
780 flag.setOnOff(tc == "mathbb");
783 flag.setOnOff(tc == "mathnormal");
791 // this one is difficult to get right. As a half-baked
792 // solution, we consider only the first action of the sequence
793 if (ev.action == LFUN_SEQUENCE) {
794 // argument contains ';'-terminated commands
795 #warning LyXAction arguments not handled here.
796 flag = getStatus(FuncRequest(lyxaction.lookupFunc(token(ev.argument, ';', 0))));
805 bool ensureBufferClean(BufferView * bv)
807 Buffer & buf = *bv->buffer();
811 string const file = MakeDisplayPath(buf.fileName(), 30);
812 string text = bformat(_("The document %1$s has unsaved "
813 "changes.\n\nDo you want to save "
814 "the document?"), file);
815 int const ret = Alert::prompt(_("Save changed document?"),
816 text, 0, 1, _("&Save"),
820 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
822 return buf.isClean();
828 void LyXFunc::dispatch(FuncRequest const & func, bool verbose)
830 string argument = func.argument;
831 kb_action action = func.action;
833 //lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << func << endl;
834 lyxerr << "LyXFunc::dispatch: cmd: " << func << endl;
836 // we have not done anything wrong yet.
838 dispatch_buffer.erase();
840 #ifdef NEW_DISPATCHER
841 // We try do call the most specific dispatcher first:
842 // 1. the lockinginset's dispatch
843 // 2. the bufferview's dispatch
844 // 3. the lyxview's dispatch
847 selection_possible = false;
849 // We cannot use this function here
850 if (getStatus(func).disabled()) {
851 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
852 << lyxaction.getActionName(action)
853 << " [" << action << "] is disabled at this location"
855 setErrorMessage(getStatusMessage());
859 if (view()->available())
860 view()->hideCursor();
865 if (!view()->available())
867 view()->cursor().pop();
868 // Tell the paragraph dialog that we changed paragraph
869 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
873 case LFUN_WORDFINDFORWARD:
874 case LFUN_WORDFINDBACKWARD: {
875 static string last_search;
876 string searched_string;
878 if (!argument.empty()) {
879 last_search = argument;
880 searched_string = argument;
882 searched_string = last_search;
884 bool fw = (action == LFUN_WORDFINDFORWARD);
885 if (!searched_string.empty())
886 lyx::find::find(view(), searched_string,
892 owner->message(keyseq.printOptions());
895 case LFUN_EXEC_COMMAND:
896 owner->focus_command_buffer();
901 meta_fake_bit = key_modifier::none;
902 if (view()->available())
903 // cancel any selection
904 dispatch(FuncRequest(LFUN_MARK_OFF));
905 setMessage(N_("Cancel"));
909 meta_fake_bit = key_modifier::alt;
910 setMessage(keyseq.print());
913 case LFUN_READ_ONLY_TOGGLE:
914 if (owner->buffer()->lyxvc().inUse())
915 owner->buffer()->lyxvc().toggleReadOnly();
917 owner->buffer()->setReadonly(
918 !owner->buffer()->isReadonly());
921 case LFUN_CENTER: // this is center and redraw.
925 // --- Menus -----------------------------------------------
927 menuNew(argument, false);
930 case LFUN_MENUNEWTMPLT:
931 menuNew(argument, true);
934 case LFUN_CLOSEBUFFER:
939 if (!owner->buffer()->isUnnamed()) {
940 string const str = bformat(_("Saving document %1$s..."),
941 MakeDisplayPath(owner->buffer()->fileName()));
943 MenuWrite(owner->buffer());
944 owner->message(str + _(" done."));
946 WriteAs(owner->buffer());
950 WriteAs(owner->buffer(), argument);
953 case LFUN_MENURELOAD: {
954 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
955 string text = bformat(_("Any changes will be lost. Are you sure "
956 "you want to revert to the saved version of the document %1$s?"), file);
957 int const ret = Alert::prompt(_("Revert to saved document?"),
958 text, 0, 1, _("&Revert"), _("&Cancel"));
966 Exporter::Export(owner->buffer(), argument, true);
967 view()->showErrorList(BufferFormat(*owner->buffer()));
971 Exporter::Preview(owner->buffer(), argument);
972 view()->showErrorList(BufferFormat(*owner->buffer()));
976 Exporter::Export(owner->buffer(), "program", true);
977 view()->showErrorList(_("Build"));
981 owner->buffer()->runChktex();
982 view()->showErrorList(_("ChkTeX"));
986 if (argument == "custom")
987 owner->getDialogs().showSendto();
989 Exporter::Export(owner->buffer(), argument, false);
990 view()->showErrorList(BufferFormat(*owner->buffer()));
1002 case LFUN_TOCVIEW: {
1003 InsetCommandParams p("tableofcontents");
1004 string const data = InsetCommandMailer::params2string("toc", p);
1005 owner->getDialogs().show("toc", data, 0);
1021 case LFUN_RECONFIGURE:
1022 Reconfigure(view());
1025 case LFUN_HELP_OPEN: {
1026 string const arg = argument;
1028 setErrorMessage(N_("Missing argument"));
1031 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1032 if (fname.empty()) {
1033 lyxerr << "LyX: unable to find documentation file `"
1034 << arg << "'. Bad installation?" << endl;
1037 owner->message(bformat(_("Opening help file %1$s..."),
1038 MakeDisplayPath(fname)));
1039 view()->loadLyXFile(fname, false);
1043 // --- version control -------------------------------
1044 case LFUN_VC_REGISTER:
1045 if (!ensureBufferClean(view()))
1047 if (!owner->buffer()->lyxvc().inUse()) {
1048 owner->buffer()->lyxvc().registrer();
1053 case LFUN_VC_CHECKIN:
1054 if (!ensureBufferClean(view()))
1056 if (owner->buffer()->lyxvc().inUse()
1057 && !owner->buffer()->isReadonly()) {
1058 owner->buffer()->lyxvc().checkIn();
1063 case LFUN_VC_CHECKOUT:
1064 if (!ensureBufferClean(view()))
1066 if (owner->buffer()->lyxvc().inUse()
1067 && owner->buffer()->isReadonly()) {
1068 owner->buffer()->lyxvc().checkOut();
1073 case LFUN_VC_REVERT:
1074 owner->buffer()->lyxvc().revert();
1079 owner->buffer()->lyxvc().undoLast();
1083 // --- buffers ----------------------------------------
1084 case LFUN_SWITCHBUFFER:
1085 view()->buffer(bufferlist.getBuffer(argument));
1089 NewFile(view(), argument);
1092 case LFUN_FILE_OPEN:
1096 case LFUN_LAYOUT_TABULAR:
1097 if (InsetTabular * tab = view()->cursor().innerInsetTabular())
1098 tab->openLayoutDialog(view());
1101 case LFUN_DROP_LAYOUTS_CHOICE:
1102 owner->getToolbar().openLayoutList();
1105 case LFUN_MENU_OPEN_BY_NAME:
1106 owner->getMenubar().openByName(argument);
1109 // --- lyxserver commands ----------------------------
1111 setMessage(owner->buffer()->fileName());
1112 lyxerr[Debug::INFO] << "FNAME["
1113 << owner->buffer()->fileName()
1118 dispatch_buffer = keyseq.print();
1119 lyxserver->notifyClient(dispatch_buffer);
1122 case LFUN_GOTOFILEROW: {
1125 istringstream is(argument);
1126 is >> file_name >> row;
1127 if (prefixIs(file_name, getTmpDir())) {
1128 // Needed by inverse dvi search. If it is a file
1129 // in tmpdir, call the apropriated function
1130 view()->buffer(bufferlist.getBufferFromTmp(file_name));
1132 // Must replace extension of the file to be .lyx
1133 // and get full path
1134 string const s = ChangeExtension(file_name, ".lyx");
1135 // Either change buffer or load the file
1136 if (bufferlist.exists(s)) {
1137 view()->buffer(bufferlist.getBuffer(s));
1139 view()->loadLyXFile(s);
1143 view()->setCursorFromRow(row);
1146 // see BufferView_pimpl::center()
1147 view()->updateScrollbar();
1151 case LFUN_GOTO_PARAGRAPH: {
1152 istringstream is(argument);
1155 ParIterator par = owner->buffer()->getParFromID(id);
1156 if (par == owner->buffer()->par_iterator_end()) {
1157 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1158 << id << ']' << endl;
1161 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1162 << " found." << endl;
1165 par.lockPath(view());
1166 LyXText * lt = par.text(view());
1169 lt->setCursor(par.pit(), 0);
1170 view()->switchKeyMap();
1171 owner->view_state_changed();
1174 // see BufferView_pimpl::center()
1175 view()->updateScrollbar();
1179 // --- Mathed stuff. If we are here, there is no locked inset yet.
1180 case LFUN_MATH_EXTERN:
1181 case LFUN_MATH_NUMBER:
1182 case LFUN_MATH_NONUMBER:
1183 case LFUN_MATH_LIMITS:
1184 setErrorMessage(N_("This is only allowed in math mode!"));
1187 // passthrough hat and underscore outside mathed:
1188 case LFUN_SUBSCRIPT:
1189 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "_"));
1192 case LFUN_SUPERSCRIPT:
1193 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "^"));
1196 case LFUN_DIALOG_SHOW: {
1197 string const name = func.getArg(0);
1198 string data = trim(func.argument.substr(name.size()));
1200 if (name == "character") {
1201 data = freefont2string();
1203 owner->getDialogs().show("character", data);
1204 } else if (name == "document")
1205 owner->getDialogs().showDocument();
1206 else if (name == "findreplace")
1207 owner->getDialogs().showSearch();
1208 else if (name == "forks")
1209 owner->getDialogs().showForks();
1210 else if (name == "preamble")
1211 owner->getDialogs().showPreamble();
1212 else if (name == "preferences")
1213 owner->getDialogs().showPreferences();
1214 else if (name == "print")
1215 owner->getDialogs().showPrint();
1216 else if (name == "spellchecker")
1217 owner->getDialogs().showSpellchecker();
1219 owner->getDialogs().show(name, data);
1223 case LFUN_DIALOG_SHOW_NEW_INSET: {
1224 string const & name = argument;
1226 if (name == "bibitem" ||
1228 name == "include" ||
1233 InsetCommandParams p(name);
1234 data = InsetCommandMailer::params2string(name, p);
1235 } else if (name == "citation") {
1236 InsetCommandParams p("cite");
1237 data = InsetCommandMailer::params2string(name, p);
1239 owner->getDialogs().show(name, data, 0);
1243 case LFUN_DIALOG_SHOW_NEXT_INSET:
1246 case LFUN_INSET_DIALOG_SHOW: {
1247 InsetOld * inset = view()->getLyXText()->getInset();
1249 inset->dispatch(FuncRequest(view(), LFUN_INSET_DIALOG_SHOW));
1253 case LFUN_DIALOG_UPDATE: {
1254 string const & name = argument;
1255 // Can only update a dialog connected to an existing inset
1256 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1258 FuncRequest fr(view(), LFUN_INSET_DIALOG_UPDATE,
1260 inset->dispatch(fr);
1261 } else if (name == "paragraph") {
1262 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1267 case LFUN_DIALOG_HIDE:
1268 Dialogs::hide(argument, 0);
1271 case LFUN_DIALOG_DISCONNECT_INSET:
1272 owner->getDialogs().disconnect(argument);
1275 case LFUN_CHILDOPEN: {
1276 string const filename =
1277 MakeAbsPath(argument, owner->buffer()->filePath());
1278 setMessage(N_("Opening child document ") +
1279 MakeDisplayPath(filename) + "...");
1280 view()->savePosition(0);
1281 string const parentfilename = owner->buffer()->fileName();
1282 if (bufferlist.exists(filename))
1283 view()->buffer(bufferlist.getBuffer(filename));
1285 view()->loadLyXFile(filename);
1286 // Set the parent name of the child document.
1287 // This makes insertion of citations and references in the child work,
1288 // when the target is in the parent or another child document.
1289 owner->buffer()->setParentName(parentfilename);
1293 case LFUN_TOGGLECURSORFOLLOW:
1294 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1298 owner->getIntl().KeyMapOn(false);
1301 case LFUN_KMAP_PRIM:
1302 owner->getIntl().KeyMapPrim();
1306 owner->getIntl().KeyMapSec();
1309 case LFUN_KMAP_TOGGLE:
1310 owner->getIntl().ToggleKeyMap();
1316 argument = split(argument, countstr, ' ');
1317 istringstream is(countstr);
1320 lyxerr << "repeat: count: " << count << " cmd: " << argument << endl;
1321 for (int i = 0; i < count; ++i)
1322 dispatch(lyxaction.lookupFunc(argument));
1327 // argument contains ';'-terminated commands
1328 while (!argument.empty()) {
1330 argument = split(argument, first, ';');
1331 dispatch(lyxaction.lookupFunc(first));
1335 case LFUN_SAVEPREFERENCES: {
1336 Path p(user_lyxdir());
1337 lyxrc.write("preferences");
1341 case LFUN_SCREEN_FONT_UPDATE:
1342 // handle the screen font changes.
1343 lyxrc.set_font_norm_type();
1344 lyx_gui::update_fonts();
1345 // All visible buffers will need resize
1349 case LFUN_SET_COLOR: {
1351 string const x11_name = split(argument, lyx_name, ' ');
1352 if (lyx_name.empty() || x11_name.empty()) {
1353 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1358 bool const graphicsbg_changed =
1359 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1360 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1362 if (!lcolor.setColor(lyx_name, x11_name)) {
1364 bformat(_("Set-color \"%1$s\" failed "
1365 "- color is undefined or "
1366 "may not be redefined"), lyx_name));
1370 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1372 if (graphicsbg_changed) {
1373 #ifdef WITH_WARNINGS
1374 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1377 lyx::graphics::GCache::get().changeDisplay(true);
1384 owner->message(argument);
1387 case LFUN_FORKS_KILL:
1388 if (isStrInt(argument))
1389 ForkedcallsController::get().kill(strToInt(argument));
1392 case LFUN_TOOLTIPS_TOGGLE:
1393 owner->getDialogs().toggleTooltips();
1396 case LFUN_EXTERNAL_EDIT:
1397 InsetExternal().dispatch(FuncRequest(view(), action, argument));
1401 DispatchResult result =
1402 view()->cursor().dispatch(FuncRequest(func, view()));
1403 if (result.dispatched())
1404 lyxerr << "dispatched by Cursor::dispatch()" << endl;
1406 lyxerr << "### NOT DISPATCHED BY Cursor::dispatch() ###" << endl;
1412 view()->owner()->updateLayoutChoice();
1414 if (view()->available()) {
1415 view()->fitCursor();
1417 view()->cursor().updatePos();
1418 // if we executed a mutating lfun, mark the buffer as dirty
1419 if (!getStatus(func).disabled()
1420 && !lyxaction.funcHasFlag(func.action, LyXAction::NoBuffer)
1421 && !lyxaction.funcHasFlag(func.action, LyXAction::ReadOnly))
1422 view()->buffer()->markDirty();
1425 sendDispatchMessage(getMessage(), func, verbose);
1429 void LyXFunc::sendDispatchMessage(string const & msg,
1430 FuncRequest const & func, bool verbose)
1432 owner->updateMenubar();
1433 owner->updateToolbar();
1435 if (func.action == LFUN_SELFINSERT || !verbose) {
1436 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1438 owner->message(msg);
1442 string dispatch_msg = msg;
1443 if (!dispatch_msg.empty())
1444 dispatch_msg += ' ';
1446 string comname = lyxaction.getActionName(func.action);
1448 bool argsadded = false;
1450 if (!func.argument.empty()) {
1451 if (func.action != LFUN_UNKNOWN_ACTION) {
1452 comname += ' ' + func.argument;
1457 string const shortcuts = toplevel_keymap->findbinding(func);
1459 if (!shortcuts.empty()) {
1460 comname += ": " + shortcuts;
1461 } else if (!argsadded && !func.argument.empty()) {
1462 comname += ' ' + func.argument;
1465 if (!comname.empty()) {
1466 comname = rtrim(comname);
1467 dispatch_msg += '(' + comname + ')';
1470 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1471 if (!dispatch_msg.empty())
1472 owner->message(dispatch_msg);
1476 void LyXFunc::setupLocalKeymap()
1478 keyseq.stdmap = toplevel_keymap.get();
1479 keyseq.curmap = toplevel_keymap.get();
1480 cancel_meta_seq.stdmap = toplevel_keymap.get();
1481 cancel_meta_seq.curmap = toplevel_keymap.get();
1485 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1487 string initpath = lyxrc.document_path;
1488 string filename(name);
1490 if (view()->available()) {
1491 string const trypath = owner->buffer()->filePath();
1492 // If directory is writeable, use this as default.
1493 if (IsDirWriteable(trypath))
1497 static int newfile_number;
1499 if (filename.empty()) {
1500 filename = AddName(lyxrc.document_path,
1501 "newfile" + tostr(++newfile_number) + ".lyx");
1502 FileInfo fi(filename);
1503 while (bufferlist.exists(filename) || fi.readable()) {
1505 filename = AddName(lyxrc.document_path,
1506 "newfile" + tostr(newfile_number) +
1508 fi.newFile(filename);
1512 // The template stuff
1515 FileDialog fileDlg(_("Select template file"),
1516 LFUN_SELECT_FILE_SYNC,
1517 make_pair(string(_("Documents|#o#O")),
1518 string(lyxrc.document_path)),
1519 make_pair(string(_("Templates|#T#t")),
1520 string(lyxrc.template_path)));
1522 FileDialog::Result result =
1523 fileDlg.open(lyxrc.template_path,
1524 _("*.lyx| LyX Documents (*.lyx)"));
1526 if (result.first == FileDialog::Later)
1528 if (result.second.empty())
1530 templname = result.second;
1533 view()->newFile(filename, templname, !name.empty());
1537 void LyXFunc::open(string const & fname)
1539 string initpath = lyxrc.document_path;
1541 if (view()->available()) {
1542 string const trypath = owner->buffer()->filePath();
1543 // If directory is writeable, use this as default.
1544 if (IsDirWriteable(trypath))
1550 if (fname.empty()) {
1551 FileDialog fileDlg(_("Select document to open"),
1553 make_pair(string(_("Documents|#o#O")),
1554 string(lyxrc.document_path)),
1555 make_pair(string(_("Examples|#E#e")),
1556 string(AddPath(system_lyxdir(), "examples"))));
1558 FileDialog::Result result =
1559 fileDlg.open(initpath,
1560 _("*.lyx| LyX Documents (*.lyx)"));
1562 if (result.first == FileDialog::Later)
1565 filename = result.second;
1567 // check selected filename
1568 if (filename.empty()) {
1569 owner->message(_("Canceled."));
1575 // get absolute path of file and add ".lyx" to the filename if
1577 string const fullpath = FileSearch(string(), filename, "lyx");
1578 if (!fullpath.empty()) {
1579 filename = fullpath;
1582 string const disp_fn(MakeDisplayPath(filename));
1584 // if the file doesn't exist, let the user create one
1585 FileInfo const f(filename, true);
1587 // the user specifically chose this name. Believe them.
1588 view()->newFile(filename, "", true);
1592 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1595 if (view()->loadLyXFile(filename)) {
1596 str2 = bformat(_("Document %1$s opened."), disp_fn);
1598 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1600 owner->message(str2);
1604 void LyXFunc::doImport(string const & argument)
1607 string filename = split(argument, format, ' ');
1609 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1610 << " file: " << filename << endl;
1612 // need user interaction
1613 if (filename.empty()) {
1614 string initpath = lyxrc.document_path;
1616 if (view()->available()) {
1617 string const trypath = owner->buffer()->filePath();
1618 // If directory is writeable, use this as default.
1619 if (IsDirWriteable(trypath))
1623 string const text = bformat(_("Select %1$s file to import"),
1624 formats.prettyName(format));
1626 FileDialog fileDlg(text,
1628 make_pair(string(_("Documents|#o#O")),
1629 string(lyxrc.document_path)),
1630 make_pair(string(_("Examples|#E#e")),
1631 string(AddPath(system_lyxdir(), "examples"))));
1633 string const extension = "*." + formats.extension(format)
1634 + "| " + formats.prettyName(format)
1635 + " (*." + formats.extension(format) + ')';
1637 FileDialog::Result result = fileDlg.open(initpath,
1640 if (result.first == FileDialog::Later)
1643 filename = result.second;
1645 // check selected filename
1646 if (filename.empty())
1647 owner->message(_("Canceled."));
1650 if (filename.empty())
1653 // get absolute path of file
1654 filename = MakeAbsPath(filename);
1656 string const lyxfile = ChangeExtension(filename, ".lyx");
1658 // Check if the document already is open
1659 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1660 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1661 owner->message(_("Canceled."));
1666 // if the file exists already, and we didn't do
1667 // -i lyx thefile.lyx, warn
1668 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1669 string const file = MakeDisplayPath(lyxfile, 30);
1671 string text = bformat(_("The document %1$s already exists.\n\n"
1672 "Do you want to over-write that document?"), file);
1673 int const ret = Alert::prompt(_("Over-write document?"),
1674 text, 0, 1, _("&Over-write"), _("&Cancel"));
1677 owner->message(_("Canceled."));
1682 Importer::Import(owner, filename, format);
1686 void LyXFunc::closeBuffer()
1688 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1689 if (bufferlist.empty()) {
1690 // need this otherwise SEGV may occur while
1691 // trying to set variables that don't exist
1692 // since there's no current buffer
1693 owner->getDialogs().hideBufferDependent();
1695 view()->buffer(bufferlist.first());
1701 // Each "owner" should have it's own message method. lyxview and
1702 // the minibuffer would use the minibuffer, but lyxserver would
1703 // send an ERROR signal to its client. Alejandro 970603
1704 // This func is bit problematic when it comes to NLS, to make the
1705 // lyx servers client be language indepenent we must not translate
1706 // strings sent to this func.
1707 void LyXFunc::setErrorMessage(string const & m) const
1709 dispatch_buffer = m;
1714 void LyXFunc::setMessage(string const & m) const
1716 dispatch_buffer = m;
1720 void LyXFunc::setStatusMessage(string const & m) const
1726 string const LyXFunc::view_status_message()
1728 // When meta-fake key is pressed, show the key sequence so far + "M-".
1730 return keyseq.print() + "M-";
1733 // Else, when a non-complete key sequence is pressed,
1734 // show the available options.
1735 if (keyseq.length() > 0 && !keyseq.deleted()) {
1736 return keyseq.printOptions();
1739 if (!view()->available())
1740 return _("Welcome to LyX!");
1742 return currentState(view());
1746 BufferView * LyXFunc::view() const
1748 BOOST_ASSERT(owner);
1749 return owner->view().get();
1753 bool LyXFunc::wasMetaKey() const
1755 return (meta_fake_bit != key_modifier::none);