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/path.h"
81 #include "support/path_defines.h"
82 #include "support/tostr.h"
83 #include "support/std_sstream.h"
84 #include "support/os.h"
86 using bv_funcs::changeDepth;
87 using bv_funcs::currentState;
88 using bv_funcs::DEC_DEPTH;
89 using bv_funcs::freefont2string;
90 using bv_funcs::INC_DEPTH;
92 using lyx::support::AddName;
93 using lyx::support::AddPath;
94 using lyx::support::bformat;
95 using lyx::support::ChangeExtension;
96 using lyx::support::FileInfo;
97 using lyx::support::FileSearch;
98 using lyx::support::ForkedcallsController;
99 using lyx::support::i18nLibFileSearch;
100 using lyx::support::IsDirWriteable;
101 using lyx::support::IsFileReadable;
102 using lyx::support::isStrInt;
103 using lyx::support::MakeAbsPath;
104 using lyx::support::MakeDisplayPath;
105 using lyx::support::Path;
106 using lyx::support::rtrim;
107 using lyx::support::split;
108 using lyx::support::strToInt;
109 using lyx::support::strToUnsignedInt;
110 using lyx::support::system_lyxdir;
111 using lyx::support::token;
112 using lyx::support::trim;
113 using lyx::support::user_lyxdir;
114 using lyx::support::prefixIs;
115 using lyx::support::os::getTmpDir;
118 using std::make_pair;
121 using std::istringstream;
124 extern BufferList bufferlist;
125 extern LyXServer * lyxserver;
126 extern bool selection_possible;
128 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
131 extern tex_accent_struct get_accent(kb_action action);
134 LyXFunc::LyXFunc(LyXView * lv)
137 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
138 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
139 meta_fake_bit(key_modifier::none)
144 void LyXFunc::handleKeyFunc(kb_action action)
146 char c = encoded_last_key;
148 if (keyseq.length()) {
152 owner->getIntl().getTransManager()
153 .deadkey(c, get_accent(action).accent, view()->getLyXText());
154 // Need to clear, in case the minibuffer calls these
157 // copied verbatim from do_accent_char
159 view()->getLyXText()->selection.cursor = view()->getLyXText()->cursor;
163 void LyXFunc::processKeySym(LyXKeySymPtr keysym,
164 key_modifier::state state)
168 if (lyxerr.debugging(Debug::KEY)) {
169 lyxerr << "KeySym is "
170 << keysym->getSymbolName()
174 // Do nothing if we have nothing (JMarc)
175 if (!keysym->isOK()) {
176 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
181 if (keysym->isModifier()) {
182 lyxerr[Debug::KEY] << "isModifier true" << endl;
186 Encoding const * encoding = view()->getEncoding();
188 encoded_last_key = keysym->getISOEncoded(encoding ? encoding->Name() : "");
190 // Do a one-deep top-level lookup for
191 // cancel and meta-fake keys. RVDK_PATCH_5
192 cancel_meta_seq.reset();
194 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
195 lyxerr[Debug::KEY] << "action first set to [" << func.action << ']' << endl;
197 // When not cancel or meta-fake, do the normal lookup.
198 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
199 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
200 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_FAKE)) {
201 // remove Caps Lock and Mod2 as a modifiers
202 func = keyseq.addkey(keysym, (state | meta_fake_bit));
203 lyxerr[Debug::KEY] << "action now set to ["
204 << func.action << ']' << endl;
207 // Dont remove this unless you know what you are doing.
208 meta_fake_bit = key_modifier::none;
210 // can this happen now ?
211 if (func.action == LFUN_NOACTION) {
212 func = FuncRequest(LFUN_PREFIX);
215 if (lyxerr.debugging(Debug::KEY)) {
216 lyxerr << "Key [action="
217 << func.action << "]["
218 << keyseq.print() << ']'
222 // already here we know if it any point in going further
223 // why not return already here if action == -1 and
224 // num_bytes == 0? (Lgb)
226 if (keyseq.length() > 1) {
227 owner->message(keyseq.print());
231 // Maybe user can only reach the key via holding down shift.
232 // Let's see. But only if shift is the only modifier
233 if (func.action == LFUN_UNKNOWN_ACTION &&
234 state == key_modifier::shift) {
235 lyxerr[Debug::KEY] << "Trying without shift" << endl;
236 func = keyseq.addkey(keysym, key_modifier::none);
237 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
240 if (func.action == LFUN_UNKNOWN_ACTION) {
241 // Hmm, we didn't match any of the keysequences. See
242 // if it's normal insertable text not already covered
244 if (keysym->isText() && keyseq.length() == 1) {
245 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
246 func = FuncRequest(LFUN_SELFINSERT);
248 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
249 owner->message(_("Unknown function."));
254 if (func.action == LFUN_SELFINSERT) {
255 if (encoded_last_key != 0) {
257 arg += encoded_last_key;
259 dispatch(FuncRequest(view(), LFUN_SELFINSERT, arg));
261 lyxerr[Debug::KEY] << "SelfInsert arg[`"
262 << argument << "']" << endl;
270 FuncStatus LyXFunc::getStatus(FuncRequest const & ev) const
273 Buffer * buf = owner->buffer();
275 if (ev.action == LFUN_NOACTION) {
276 setStatusMessage(N_("Nothing to do"));
282 case LFUN_UNKNOWN_ACTION:
283 #ifndef HAVE_LIBAIKSAURUS
284 case LFUN_THESAURUS_ENTRY:
290 flag |= lyx_gui::getStatus(ev);
293 if (flag.unknown()) {
294 setStatusMessage(N_("Unknown action"));
298 // the default error message if we disable the command
299 setStatusMessage(N_("Command disabled"));
301 // Check whether we need a buffer
302 if (!lyxaction.funcHasFlag(ev.action, LyXAction::NoBuffer)) {
303 // Yes we need a buffer, do we have one?
306 // Can we use a readonly buffer?
307 if (buf->isReadonly() &&
308 !lyxaction.funcHasFlag(ev.action,
309 LyXAction::ReadOnly)) {
311 setStatusMessage(N_("Document is read-only"));
316 setStatusMessage(N_("Command not allowed with"
317 "out any document open"));
323 UpdatableInset * tli = view()->cursor().innerInset();
324 InsetTabular * tab = view()->cursor().innerInsetTabular();
326 // I would really like to avoid having this switch and rather try to
327 // encode this in the function itself.
328 bool disable = false;
331 disable = ev.argument != "custom"
332 && !Exporter::IsExportable(*buf, ev.argument);
335 disable = buf->undostack().empty();
338 disable = buf->redostack().empty();
342 if (tab && tab->hasSelection())
345 disable = !mathcursor && !view()->getLyXText()->selection.set();
349 disable = !buf->isLatex() || lyxrc.chktex_command == "none";
353 disable = !Exporter::IsExportable(*buf, "program");
356 case LFUN_LAYOUT_TABULAR:
357 disable = !view()->cursor().innerInsetTabular();
361 disable = !changeDepthAllowed(view(), view()->getLyXText(), DEC_DEPTH);
364 case LFUN_DEPTH_PLUS:
365 disable = !changeDepthAllowed(view(), view()->getLyXText(), INC_DEPTH);
369 case LFUN_LAYOUT_PARAGRAPH: {
370 InsetOld * inset = view()->getLyXText()->cursorPar()->inInset();
371 disable = inset && inset->forceDefaultParagraphs(inset);
375 case LFUN_INSET_OPTARG:
376 disable = (view()->getLyXText()->cursorPar()->layout()->optionalargs == 0);
379 case LFUN_TABULAR_FEATURE:
382 // FIXME: check temporarily disabled
384 char align = mathcursor->valign();
389 if (ev.argument.empty()) {
393 if (!contains("tcb", ev.argument[0])) {
397 flag.setOnOff(ev.argument[0] == align);
401 char align = mathcursor->halign();
406 if (ev.argument.empty()) {
410 if (!contains("lcr", ev.argument[0])) {
414 flag.setOnOff(ev.argument[0] == align);
416 disable = !mathcursor->halign();
422 //ret.disabled(true);
423 InsetTabular * tab = view()->cursor().innerInsetTabular();
425 ret = tab->getStatus(ev.argument);
432 static InsetTabular inset(*buf, 1, 1);
434 FuncStatus ret = inset.getStatus(ev.argument);
435 if (ret.onoff(true) || ret.onoff(false))
436 flag.setOnOff(false);
441 case LFUN_VC_REGISTER:
442 disable = buf->lyxvc().inUse();
444 case LFUN_VC_CHECKIN:
445 disable = !buf->lyxvc().inUse() || buf->isReadonly();
447 case LFUN_VC_CHECKOUT:
448 disable = !buf->lyxvc().inUse() || !buf->isReadonly();
452 disable = !buf->lyxvc().inUse();
454 case LFUN_MENURELOAD:
455 disable = buf->isUnnamed() || buf->isClean();
457 case LFUN_BOOKMARK_GOTO:
459 isSavedPosition(strToUnsignedInt(ev.argument));
462 case LFUN_MERGE_CHANGES:
463 case LFUN_ACCEPT_CHANGE:
464 case LFUN_REJECT_CHANGE:
465 case LFUN_ACCEPT_ALL_CHANGES:
466 case LFUN_REJECT_ALL_CHANGES:
467 disable = !buf->params().tracking_changes;
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::WRAP_CODE:
494 disable = ev.argument != "wrap";
496 case InsetOld::NOTE_CODE:
497 disable = ev.argument != "note";
499 case InsetOld::BRANCH_CODE:
500 disable = ev.argument != "branch";
502 case InsetOld::BOX_CODE:
503 disable = ev.argument != "box";
511 case LFUN_MATH_MUTATE:
513 //flag.setOnOff(mathcursor->formula()->hullType() == ev.argument);
514 flag.setOnOff(false);
519 // we just need to be in math mode to enable that
521 case LFUN_MATH_SPACE:
522 case LFUN_MATH_LIMITS:
523 case LFUN_MATH_NONUMBER:
524 case LFUN_MATH_NUMBER:
525 case LFUN_MATH_EXTERN:
526 disable = !mathcursor;
529 case LFUN_DIALOG_SHOW: {
530 string const name = ev.getArg(0);
532 disable = !(name == "aboutlyx" ||
535 name == "preferences" ||
540 if (name == "print") {
541 disable = !Exporter::IsExportable(*buf, "dvi") ||
542 lyxrc.print_command == "none";
543 } else if (name == "character") {
544 UpdatableInset * tli = view()->cursor().innerInset();
545 disable = tli && tli->lyxCode() == InsetOld::ERT_CODE;
546 } else if (name == "vclog") {
547 disable = !buf->lyxvc().inUse();
548 } else if (name == "latexlog") {
549 disable = !IsFileReadable(buf->getLogName().second);
558 // the functions which insert insets
559 InsetOld::Code code = InsetOld::NO_CODE;
561 case LFUN_DIALOG_SHOW_NEW_INSET:
562 if (ev.argument == "bibitem")
563 code = InsetOld::BIBITEM_CODE;
564 else if (ev.argument == "bibtex")
565 code = InsetOld::BIBTEX_CODE;
566 else if (ev.argument == "box")
567 code = InsetOld::BOX_CODE;
568 else if (ev.argument == "branch")
569 code = InsetOld::BRANCH_CODE;
570 else if (ev.argument == "citation")
571 code = InsetOld::CITE_CODE;
572 else if (ev.argument == "ert")
573 code = InsetOld::ERT_CODE;
574 else if (ev.argument == "external")
575 code = InsetOld::EXTERNAL_CODE;
576 else if (ev.argument == "float")
577 code = InsetOld::FLOAT_CODE;
578 else if (ev.argument == "graphics")
579 code = InsetOld::GRAPHICS_CODE;
580 else if (ev.argument == "include")
581 code = InsetOld::INCLUDE_CODE;
582 else if (ev.argument == "index")
583 code = InsetOld::INDEX_CODE;
584 else if (ev.argument == "label")
585 code = InsetOld::LABEL_CODE;
586 else if (ev.argument == "note")
587 code = InsetOld::NOTE_CODE;
588 else if (ev.argument == "ref")
589 code = InsetOld::REF_CODE;
590 else if (ev.argument == "toc")
591 code = InsetOld::TOC_CODE;
592 else if (ev.argument == "url")
593 code = InsetOld::URL_CODE;
594 else if (ev.argument == "vspace")
595 code = InsetOld::VSPACE_CODE;
596 else if (ev.argument == "wrap")
597 code = InsetOld::WRAP_CODE;
601 code = InsetOld::ERT_CODE;
603 case LFUN_INSET_FOOTNOTE:
604 code = InsetOld::FOOT_CODE;
606 case LFUN_TABULAR_INSERT:
607 code = InsetOld::TABULAR_CODE;
609 case LFUN_INSET_MARGINAL:
610 code = InsetOld::MARGIN_CODE;
612 case LFUN_INSET_MINIPAGE:
613 code = InsetOld::BOX_CODE;
615 case LFUN_INSET_FLOAT:
616 case LFUN_INSET_WIDE_FLOAT:
617 code = InsetOld::FLOAT_CODE;
619 case LFUN_INSET_WRAP:
620 code = InsetOld::WRAP_CODE;
622 case LFUN_FLOAT_LIST:
623 code = InsetOld::FLOAT_LIST_CODE;
626 case LFUN_INSET_LIST:
627 code = InsetOld::LIST_CODE;
629 case LFUN_INSET_THEOREM:
630 code = InsetOld::THEOREM_CODE;
633 case LFUN_INSET_CAPTION:
634 code = InsetOld::CAPTION_CODE;
636 case LFUN_INSERT_NOTE:
637 code = InsetOld::NOTE_CODE;
639 case LFUN_INSERT_CHARSTYLE:
640 code = InsetOld::CHARSTYLE_CODE;
641 if (buf->params().getLyXTextClass().charstyles().empty())
644 case LFUN_INSERT_BOX:
645 code = InsetOld::BOX_CODE;
647 case LFUN_INSERT_BRANCH:
648 code = InsetOld::BRANCH_CODE;
649 if (buf->params().branchlist().empty())
652 case LFUN_INSERT_LABEL:
653 code = InsetOld::LABEL_CODE;
655 case LFUN_INSET_OPTARG:
656 code = InsetOld::OPTARG_CODE;
658 case LFUN_ENVIRONMENT_INSERT:
659 code = InsetOld::BOX_CODE;
661 case LFUN_INDEX_INSERT:
662 code = InsetOld::INDEX_CODE;
664 case LFUN_INDEX_PRINT:
665 code = InsetOld::INDEX_PRINT_CODE;
667 case LFUN_TOC_INSERT:
668 code = InsetOld::TOC_CODE;
672 code = InsetOld::URL_CODE;
675 // always allow this, since we will inset a raw quote
676 // if an inset is not allowed.
678 case LFUN_HYPHENATION:
679 case LFUN_LIGATURE_BREAK:
681 case LFUN_MENU_SEPARATOR:
683 case LFUN_END_OF_SENTENCE:
684 code = InsetOld::SPECIALCHAR_CODE;
686 case LFUN_SPACE_INSERT:
687 // slight hack: we know this is allowed in math mode
689 code = InsetOld::SPACE_CODE;
691 case LFUN_INSET_DIALOG_SHOW: {
692 InsetOld * inset = view()->getLyXText()->getInset();
695 code = inset->lyxCode();
696 if (!(code == InsetOld::INCLUDE_CODE
697 || code == InsetOld::BIBTEX_CODE
698 || code == InsetOld::FLOAT_LIST_CODE
699 || code == InsetOld::TOC_CODE))
707 if (code != InsetOld::NO_CODE && tli && !tli->insetAllowed(code))
713 // A few general toggles
715 case LFUN_TOOLTIPS_TOGGLE:
716 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
719 case LFUN_READ_ONLY_TOGGLE:
720 flag.setOnOff(buf->isReadonly());
723 flag.setOnOff(view()->getLyXText()->cursorPar()->params().startOfAppendix());
725 case LFUN_SWITCHBUFFER:
726 // toggle on the current buffer, but do not toggle off
727 // the other ones (is that a good idea?)
728 if (ev.argument == buf->fileName())
731 case LFUN_TRACK_CHANGES:
732 flag.setOnOff(buf->params().tracking_changes);
739 // the font related toggles
741 LyXFont const & font = view()->getLyXText()->real_current_font;
744 flag.setOnOff(font.emph() == LyXFont::ON);
747 flag.setOnOff(font.noun() == LyXFont::ON);
750 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
753 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
756 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
759 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
765 string tc = mathcursor->getLastCode();
768 flag.setOnOff(tc == "mathbf");
771 flag.setOnOff(tc == "mathsf");
774 flag.setOnOff(tc == "mathcal");
777 flag.setOnOff(tc == "mathrm");
780 flag.setOnOff(tc == "mathtt");
783 flag.setOnOff(tc == "mathbb");
786 flag.setOnOff(tc == "mathnormal");
794 // this one is difficult to get right. As a half-baked
795 // solution, we consider only the first action of the sequence
796 if (ev.action == LFUN_SEQUENCE) {
797 // argument contains ';'-terminated commands
798 #warning LyXAction arguments not handled here.
799 flag = getStatus(FuncRequest(lyxaction.lookupFunc(token(ev.argument, ';', 0))));
808 bool ensureBufferClean(BufferView * bv)
810 Buffer & buf = *bv->buffer();
814 string const file = MakeDisplayPath(buf.fileName(), 30);
815 string text = bformat(_("The document %1$s has unsaved "
816 "changes.\n\nDo you want to save "
817 "the document?"), file);
818 int const ret = Alert::prompt(_("Save changed document?"),
819 text, 0, 1, _("&Save"),
823 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
825 return buf.isClean();
831 void LyXFunc::dispatch(FuncRequest const & func, bool verbose)
833 string argument = func.argument;
834 kb_action action = func.action;
836 //lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << func << endl;
837 lyxerr << "LyXFunc::dispatch: cmd: " << func << endl;
839 // we have not done anything wrong yet.
841 dispatch_buffer.erase();
843 #ifdef NEW_DISPATCHER
844 // We try do call the most specific dispatcher first:
845 // 1. the lockinginset's dispatch
846 // 2. the bufferview's dispatch
847 // 3. the lyxview's dispatch
850 selection_possible = false;
852 // We cannot use this function here
853 if (getStatus(func).disabled()) {
854 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
855 << lyxaction.getActionName(action)
856 << " [" << action << "] is disabled at this location"
858 setErrorMessage(getStatusMessage());
862 if (view()->available())
863 view()->hideCursor();
868 if (!view()->available())
870 view()->cursor().pop();
871 // Tell the paragraph dialog that we changed paragraph
872 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
876 case LFUN_WORDFINDFORWARD:
877 case LFUN_WORDFINDBACKWARD: {
878 static string last_search;
879 string searched_string;
881 if (!argument.empty()) {
882 last_search = argument;
883 searched_string = argument;
885 searched_string = last_search;
887 bool fw = (action == LFUN_WORDFINDFORWARD);
888 if (!searched_string.empty())
889 lyx::find::find(view(), searched_string,
895 owner->message(keyseq.printOptions());
898 case LFUN_EXEC_COMMAND:
899 owner->focus_command_buffer();
904 meta_fake_bit = key_modifier::none;
905 if (view()->available())
906 // cancel any selection
907 dispatch(FuncRequest(LFUN_MARK_OFF));
908 setMessage(N_("Cancel"));
912 meta_fake_bit = key_modifier::alt;
913 setMessage(keyseq.print());
916 case LFUN_READ_ONLY_TOGGLE:
917 if (owner->buffer()->lyxvc().inUse())
918 owner->buffer()->lyxvc().toggleReadOnly();
920 owner->buffer()->setReadonly(
921 !owner->buffer()->isReadonly());
924 case LFUN_CENTER: // this is center and redraw.
928 // --- Menus -----------------------------------------------
930 menuNew(argument, false);
933 case LFUN_MENUNEWTMPLT:
934 menuNew(argument, true);
937 case LFUN_CLOSEBUFFER:
942 if (!owner->buffer()->isUnnamed()) {
943 string const str = bformat(_("Saving document %1$s..."),
944 MakeDisplayPath(owner->buffer()->fileName()));
946 MenuWrite(owner->buffer());
947 owner->message(str + _(" done."));
949 WriteAs(owner->buffer());
953 WriteAs(owner->buffer(), argument);
956 case LFUN_MENURELOAD: {
957 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
958 string text = bformat(_("Any changes will be lost. Are you sure "
959 "you want to revert to the saved version of the document %1$s?"), file);
960 int const ret = Alert::prompt(_("Revert to saved document?"),
961 text, 0, 1, _("&Revert"), _("&Cancel"));
969 Exporter::Export(owner->buffer(), argument, true);
970 view()->showErrorList(BufferFormat(*owner->buffer()));
974 Exporter::Preview(owner->buffer(), argument);
975 view()->showErrorList(BufferFormat(*owner->buffer()));
979 Exporter::Export(owner->buffer(), "program", true);
980 view()->showErrorList(_("Build"));
984 owner->buffer()->runChktex();
985 view()->showErrorList(_("ChkTeX"));
989 if (argument == "custom")
990 owner->getDialogs().showSendto();
992 Exporter::Export(owner->buffer(), argument, false);
993 view()->showErrorList(BufferFormat(*owner->buffer()));
1005 case LFUN_TOCVIEW: {
1006 InsetCommandParams p("tableofcontents");
1007 string const data = InsetCommandMailer::params2string("toc", p);
1008 owner->getDialogs().show("toc", data, 0);
1024 case LFUN_RECONFIGURE:
1025 Reconfigure(view());
1028 case LFUN_HELP_OPEN: {
1029 string const arg = argument;
1031 setErrorMessage(N_("Missing argument"));
1034 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1035 if (fname.empty()) {
1036 lyxerr << "LyX: unable to find documentation file `"
1037 << arg << "'. Bad installation?" << endl;
1040 owner->message(bformat(_("Opening help file %1$s..."),
1041 MakeDisplayPath(fname)));
1042 view()->loadLyXFile(fname, false);
1046 // --- version control -------------------------------
1047 case LFUN_VC_REGISTER:
1048 if (!ensureBufferClean(view()))
1050 if (!owner->buffer()->lyxvc().inUse()) {
1051 owner->buffer()->lyxvc().registrer();
1056 case LFUN_VC_CHECKIN:
1057 if (!ensureBufferClean(view()))
1059 if (owner->buffer()->lyxvc().inUse()
1060 && !owner->buffer()->isReadonly()) {
1061 owner->buffer()->lyxvc().checkIn();
1066 case LFUN_VC_CHECKOUT:
1067 if (!ensureBufferClean(view()))
1069 if (owner->buffer()->lyxvc().inUse()
1070 && owner->buffer()->isReadonly()) {
1071 owner->buffer()->lyxvc().checkOut();
1076 case LFUN_VC_REVERT:
1077 owner->buffer()->lyxvc().revert();
1082 owner->buffer()->lyxvc().undoLast();
1086 // --- buffers ----------------------------------------
1087 case LFUN_SWITCHBUFFER:
1088 view()->buffer(bufferlist.getBuffer(argument));
1092 NewFile(view(), argument);
1095 case LFUN_FILE_OPEN:
1099 case LFUN_LAYOUT_TABULAR:
1100 if (InsetTabular * tab = view()->cursor().innerInsetTabular())
1101 tab->openLayoutDialog(view());
1104 case LFUN_DROP_LAYOUTS_CHOICE:
1105 owner->getToolbar().openLayoutList();
1108 case LFUN_MENU_OPEN_BY_NAME:
1109 owner->getMenubar().openByName(argument);
1112 // --- lyxserver commands ----------------------------
1114 setMessage(owner->buffer()->fileName());
1115 lyxerr[Debug::INFO] << "FNAME["
1116 << owner->buffer()->fileName()
1121 dispatch_buffer = keyseq.print();
1122 lyxserver->notifyClient(dispatch_buffer);
1125 case LFUN_GOTOFILEROW: {
1128 istringstream is(argument);
1129 is >> file_name >> row;
1130 if (prefixIs(file_name, getTmpDir())) {
1131 // Needed by inverse dvi search. If it is a file
1132 // in tmpdir, call the apropriated function
1133 view()->buffer(bufferlist.getBufferFromTmp(file_name));
1135 // Must replace extension of the file to be .lyx
1136 // and get full path
1137 string const s = ChangeExtension(file_name, ".lyx");
1138 // Either change buffer or load the file
1139 if (bufferlist.exists(s)) {
1140 view()->buffer(bufferlist.getBuffer(s));
1142 view()->loadLyXFile(s);
1146 view()->setCursorFromRow(row);
1149 // see BufferView_pimpl::center()
1150 view()->updateScrollbar();
1154 case LFUN_GOTO_PARAGRAPH: {
1155 istringstream is(argument);
1158 ParIterator par = owner->buffer()->getParFromID(id);
1159 if (par == owner->buffer()->par_iterator_end()) {
1160 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1161 << id << ']' << endl;
1164 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1165 << " found." << endl;
1168 par.lockPath(view());
1169 LyXText * lt = par.text(*view()->buffer());
1172 lt->setCursor(par.pit(), 0);
1173 view()->switchKeyMap();
1174 owner->view_state_changed();
1177 // see BufferView_pimpl::center()
1178 view()->updateScrollbar();
1182 // --- Mathed stuff. If we are here, there is no locked inset yet.
1183 case LFUN_MATH_EXTERN:
1184 case LFUN_MATH_NUMBER:
1185 case LFUN_MATH_NONUMBER:
1186 case LFUN_MATH_LIMITS:
1187 setErrorMessage(N_("This is only allowed in math mode!"));
1190 case LFUN_DIALOG_SHOW: {
1191 string const name = func.getArg(0);
1192 string data = trim(func.argument.substr(name.size()));
1194 if (name == "character") {
1195 data = freefont2string();
1197 owner->getDialogs().show("character", data);
1199 else if (name == "document")
1200 owner->getDialogs().showDocument();
1201 else if (name == "findreplace")
1202 owner->getDialogs().showSearch();
1203 else if (name == "forks")
1204 owner->getDialogs().showForks();
1205 else if (name == "preamble")
1206 owner->getDialogs().showPreamble();
1207 else if (name == "preferences")
1208 owner->getDialogs().showPreferences();
1209 else if (name == "print")
1210 owner->getDialogs().showPrint();
1211 else if (name == "spellchecker")
1212 owner->getDialogs().showSpellchecker();
1214 else if (name == "latexlog") {
1215 pair<Buffer::LogType, string> const logfile =
1216 owner->buffer()->getLogName();
1217 switch (logfile.first) {
1218 case Buffer::latexlog:
1221 case Buffer::buildlog:
1225 data += logfile.second;
1226 owner->getDialogs().show("log", data);
1228 else if (name == "vclog") {
1229 string const data = "vc " +
1230 owner->buffer()->lyxvc().getLogFile();
1231 owner->getDialogs().show("log", data);
1234 owner->getDialogs().show(name, data);
1238 case LFUN_DIALOG_SHOW_NEW_INSET: {
1239 string const name = func.getArg(0);
1240 string data = trim(func.argument.substr(name.size()));
1241 if (name == "bibitem" ||
1243 name == "include" ||
1249 InsetCommandParams p(name);
1250 data = InsetCommandMailer::params2string(name, p);
1251 } else if (name == "box") {
1252 // \c data == "Boxed" || "Frameless" etc
1253 InsetBoxParams p(data);
1254 data = InsetBoxMailer::params2string(p);
1255 } else if (name == "branch") {
1256 InsetBranchParams p;
1257 data = InsetBranchMailer::params2string(p);
1258 } else if (name == "citation") {
1259 InsetCommandParams p("cite");
1260 data = InsetCommandMailer::params2string(name, p);
1261 } else if (name == "ert") {
1262 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1263 } else if (name == "external") {
1264 InsetExternalParams p;
1265 Buffer const & buffer = *owner->buffer();
1266 data = InsetExternalMailer::params2string(p, buffer);
1267 } else if (name == "float") {
1269 data = InsetFloatMailer::params2string(p);
1270 } else if (name == "graphics") {
1271 InsetGraphicsParams p;
1272 Buffer const & buffer = *owner->buffer();
1273 data = InsetGraphicsMailer::params2string(p, buffer);
1274 } else if (name == "note") {
1276 data = InsetNoteMailer::params2string(p);
1277 } else if (name == "vspace") {
1279 data = InsetVSpaceMailer::params2string(space);
1280 } else if (name == "wrap") {
1282 data = InsetWrapMailer::params2string(p);
1284 owner->getDialogs().show(name, data, 0);
1288 case LFUN_DIALOG_SHOW_NEXT_INSET:
1291 case LFUN_INSET_DIALOG_SHOW: {
1292 InsetOld * inset = view()->getLyXText()->getInset();
1294 inset->dispatch(FuncRequest(view(), LFUN_INSET_DIALOG_SHOW));
1298 case LFUN_DIALOG_UPDATE: {
1299 string const & name = argument;
1300 // Can only update a dialog connected to an existing inset
1301 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1303 FuncRequest fr(view(), LFUN_INSET_DIALOG_UPDATE,
1305 inset->dispatch(fr);
1306 } else if (name == "paragraph") {
1307 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1312 case LFUN_DIALOG_HIDE:
1313 Dialogs::hide(argument, 0);
1316 case LFUN_DIALOG_DISCONNECT_INSET:
1317 owner->getDialogs().disconnect(argument);
1320 case LFUN_CHILDOPEN: {
1321 string const filename =
1322 MakeAbsPath(argument, owner->buffer()->filePath());
1323 setMessage(N_("Opening child document ") +
1324 MakeDisplayPath(filename) + "...");
1325 view()->savePosition(0);
1326 string const parentfilename = owner->buffer()->fileName();
1327 if (bufferlist.exists(filename))
1328 view()->buffer(bufferlist.getBuffer(filename));
1330 view()->loadLyXFile(filename);
1331 // Set the parent name of the child document.
1332 // This makes insertion of citations and references in the child work,
1333 // when the target is in the parent or another child document.
1334 owner->buffer()->setParentName(parentfilename);
1338 case LFUN_TOGGLECURSORFOLLOW:
1339 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1343 owner->getIntl().KeyMapOn(false);
1346 case LFUN_KMAP_PRIM:
1347 owner->getIntl().KeyMapPrim();
1351 owner->getIntl().KeyMapSec();
1354 case LFUN_KMAP_TOGGLE:
1355 owner->getIntl().ToggleKeyMap();
1361 argument = split(argument, countstr, ' ');
1362 istringstream is(countstr);
1365 lyxerr << "repeat: count: " << count << " cmd: " << argument << endl;
1366 for (int i = 0; i < count; ++i)
1367 dispatch(lyxaction.lookupFunc(argument));
1372 // argument contains ';'-terminated commands
1373 while (!argument.empty()) {
1375 argument = split(argument, first, ';');
1376 dispatch(lyxaction.lookupFunc(first));
1380 case LFUN_SAVEPREFERENCES: {
1381 Path p(user_lyxdir());
1382 lyxrc.write("preferences");
1386 case LFUN_SCREEN_FONT_UPDATE:
1387 // handle the screen font changes.
1388 lyxrc.set_font_norm_type();
1389 lyx_gui::update_fonts();
1390 // All visible buffers will need resize
1394 case LFUN_SET_COLOR: {
1396 string const x11_name = split(argument, lyx_name, ' ');
1397 if (lyx_name.empty() || x11_name.empty()) {
1398 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1403 bool const graphicsbg_changed =
1404 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1405 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1407 LColor::color col = lcolor.getFromLyXName(lyx_name);
1408 if (!lcolor.setColor(col, x11_name)) {
1410 bformat(_("Set-color \"%1$s\" failed "
1411 "- color is undefined or "
1412 "may not be redefined"), lyx_name));
1416 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1418 if (graphicsbg_changed) {
1419 #ifdef WITH_WARNINGS
1420 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1423 lyx::graphics::GCache::get().changeDisplay(true);
1430 owner->message(argument);
1433 case LFUN_FORKS_KILL:
1434 if (isStrInt(argument))
1435 ForkedcallsController::get().kill(strToInt(argument));
1438 case LFUN_TOOLTIPS_TOGGLE:
1439 owner->getDialogs().toggleTooltips();
1442 case LFUN_EXTERNAL_EDIT:
1443 InsetExternal().dispatch(FuncRequest(view(), action, argument));
1447 DispatchResult result =
1448 view()->cursor().dispatch(FuncRequest(func, view()));
1449 if (result.dispatched())
1450 lyxerr << "dispatched by Cursor::dispatch()" << endl;
1452 lyxerr << "### NOT DISPATCHED BY Cursor::dispatch() ###" << endl;
1458 view()->owner()->updateLayoutChoice();
1460 if (view()->available()) {
1461 view()->fitCursor();
1463 view()->cursor().updatePos();
1464 // if we executed a mutating lfun, mark the buffer as dirty
1465 if (!getStatus(func).disabled()
1466 && !lyxaction.funcHasFlag(func.action, LyXAction::NoBuffer)
1467 && !lyxaction.funcHasFlag(func.action, LyXAction::ReadOnly))
1468 view()->buffer()->markDirty();
1471 sendDispatchMessage(getMessage(), func, verbose);
1475 void LyXFunc::sendDispatchMessage(string const & msg,
1476 FuncRequest const & func, bool verbose)
1478 owner->updateMenubar();
1479 owner->updateToolbar();
1481 if (func.action == LFUN_SELFINSERT || !verbose) {
1482 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1484 owner->message(msg);
1488 string dispatch_msg = msg;
1489 if (!dispatch_msg.empty())
1490 dispatch_msg += ' ';
1492 string comname = lyxaction.getActionName(func.action);
1494 bool argsadded = false;
1496 if (!func.argument.empty()) {
1497 if (func.action != LFUN_UNKNOWN_ACTION) {
1498 comname += ' ' + func.argument;
1503 string const shortcuts = toplevel_keymap->findbinding(func);
1505 if (!shortcuts.empty()) {
1506 comname += ": " + shortcuts;
1507 } else if (!argsadded && !func.argument.empty()) {
1508 comname += ' ' + func.argument;
1511 if (!comname.empty()) {
1512 comname = rtrim(comname);
1513 dispatch_msg += '(' + comname + ')';
1516 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1517 if (!dispatch_msg.empty())
1518 owner->message(dispatch_msg);
1522 void LyXFunc::setupLocalKeymap()
1524 keyseq.stdmap = toplevel_keymap.get();
1525 keyseq.curmap = toplevel_keymap.get();
1526 cancel_meta_seq.stdmap = toplevel_keymap.get();
1527 cancel_meta_seq.curmap = toplevel_keymap.get();
1531 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1533 string initpath = lyxrc.document_path;
1534 string filename(name);
1536 if (view()->available()) {
1537 string const trypath = owner->buffer()->filePath();
1538 // If directory is writeable, use this as default.
1539 if (IsDirWriteable(trypath))
1543 static int newfile_number;
1545 if (filename.empty()) {
1546 filename = AddName(lyxrc.document_path,
1547 "newfile" + tostr(++newfile_number) + ".lyx");
1548 FileInfo fi(filename);
1549 while (bufferlist.exists(filename) || fi.readable()) {
1551 filename = AddName(lyxrc.document_path,
1552 "newfile" + tostr(newfile_number) +
1554 fi.newFile(filename);
1558 // The template stuff
1561 FileDialog fileDlg(_("Select template file"),
1562 LFUN_SELECT_FILE_SYNC,
1563 make_pair(string(_("Documents|#o#O")),
1564 string(lyxrc.document_path)),
1565 make_pair(string(_("Templates|#T#t")),
1566 string(lyxrc.template_path)));
1568 FileDialog::Result result =
1569 fileDlg.open(lyxrc.template_path,
1570 _("*.lyx| LyX Documents (*.lyx)"));
1572 if (result.first == FileDialog::Later)
1574 if (result.second.empty())
1576 templname = result.second;
1579 view()->newFile(filename, templname, !name.empty());
1583 void LyXFunc::open(string const & fname)
1585 string initpath = lyxrc.document_path;
1587 if (view()->available()) {
1588 string const trypath = owner->buffer()->filePath();
1589 // If directory is writeable, use this as default.
1590 if (IsDirWriteable(trypath))
1596 if (fname.empty()) {
1597 FileDialog fileDlg(_("Select document to open"),
1599 make_pair(string(_("Documents|#o#O")),
1600 string(lyxrc.document_path)),
1601 make_pair(string(_("Examples|#E#e")),
1602 string(AddPath(system_lyxdir(), "examples"))));
1604 FileDialog::Result result =
1605 fileDlg.open(initpath,
1606 _("*.lyx| LyX Documents (*.lyx)"));
1608 if (result.first == FileDialog::Later)
1611 filename = result.second;
1613 // check selected filename
1614 if (filename.empty()) {
1615 owner->message(_("Canceled."));
1621 // get absolute path of file and add ".lyx" to the filename if
1623 string const fullpath = FileSearch(string(), filename, "lyx");
1624 if (!fullpath.empty()) {
1625 filename = fullpath;
1628 string const disp_fn(MakeDisplayPath(filename));
1630 // if the file doesn't exist, let the user create one
1631 FileInfo const f(filename, true);
1633 // the user specifically chose this name. Believe them.
1634 view()->newFile(filename, "", true);
1638 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1641 if (view()->loadLyXFile(filename)) {
1642 str2 = bformat(_("Document %1$s opened."), disp_fn);
1644 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1646 owner->message(str2);
1650 void LyXFunc::doImport(string const & argument)
1653 string filename = split(argument, format, ' ');
1655 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1656 << " file: " << filename << endl;
1658 // need user interaction
1659 if (filename.empty()) {
1660 string initpath = lyxrc.document_path;
1662 if (view()->available()) {
1663 string const trypath = owner->buffer()->filePath();
1664 // If directory is writeable, use this as default.
1665 if (IsDirWriteable(trypath))
1669 string const text = bformat(_("Select %1$s file to import"),
1670 formats.prettyName(format));
1672 FileDialog fileDlg(text,
1674 make_pair(string(_("Documents|#o#O")),
1675 string(lyxrc.document_path)),
1676 make_pair(string(_("Examples|#E#e")),
1677 string(AddPath(system_lyxdir(), "examples"))));
1679 string const extension = "*." + formats.extension(format)
1680 + "| " + formats.prettyName(format)
1681 + " (*." + formats.extension(format) + ')';
1683 FileDialog::Result result = fileDlg.open(initpath,
1686 if (result.first == FileDialog::Later)
1689 filename = result.second;
1691 // check selected filename
1692 if (filename.empty())
1693 owner->message(_("Canceled."));
1696 if (filename.empty())
1699 // get absolute path of file
1700 filename = MakeAbsPath(filename);
1702 string const lyxfile = ChangeExtension(filename, ".lyx");
1704 // Check if the document already is open
1705 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1706 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1707 owner->message(_("Canceled."));
1712 // if the file exists already, and we didn't do
1713 // -i lyx thefile.lyx, warn
1714 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1715 string const file = MakeDisplayPath(lyxfile, 30);
1717 string text = bformat(_("The document %1$s already exists.\n\n"
1718 "Do you want to over-write that document?"), file);
1719 int const ret = Alert::prompt(_("Over-write document?"),
1720 text, 0, 1, _("&Over-write"), _("&Cancel"));
1723 owner->message(_("Canceled."));
1728 Importer::Import(owner, filename, format);
1732 void LyXFunc::closeBuffer()
1734 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1735 if (bufferlist.empty()) {
1736 // need this otherwise SEGV may occur while
1737 // trying to set variables that don't exist
1738 // since there's no current buffer
1739 owner->getDialogs().hideBufferDependent();
1741 view()->buffer(bufferlist.first());
1747 // Each "owner" should have it's own message method. lyxview and
1748 // the minibuffer would use the minibuffer, but lyxserver would
1749 // send an ERROR signal to its client. Alejandro 970603
1750 // This func is bit problematic when it comes to NLS, to make the
1751 // lyx servers client be language indepenent we must not translate
1752 // strings sent to this func.
1753 void LyXFunc::setErrorMessage(string const & m) const
1755 dispatch_buffer = m;
1760 void LyXFunc::setMessage(string const & m) const
1762 dispatch_buffer = m;
1766 void LyXFunc::setStatusMessage(string const & m) const
1772 string const LyXFunc::view_status_message()
1774 // When meta-fake key is pressed, show the key sequence so far + "M-".
1776 return keyseq.print() + "M-";
1779 // Else, when a non-complete key sequence is pressed,
1780 // show the available options.
1781 if (keyseq.length() > 0 && !keyseq.deleted()) {
1782 return keyseq.printOptions();
1785 if (!view()->available())
1786 return _("Welcome to LyX!");
1788 return currentState(view());
1792 BufferView * LyXFunc::view() const
1794 BOOST_ASSERT(owner);
1795 return owner->view().get();
1799 bool LyXFunc::wasMetaKey() const
1801 return (meta_fake_bit != key_modifier::none);