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"
30 #include "bufferview_funcs.h"
32 #include "CutAndPaste.h"
34 #include "dispatchresult.h"
36 #include "errorlist.h"
39 #include "funcrequest.h"
40 #include "FuncStatus.h"
43 #include "insetiterator.h"
51 #include "LyXAction.h"
56 #include "lyxserver.h"
57 #include "lyxtextclasslist.h"
59 #include "paragraph.h"
60 #include "pariterator.h"
61 #include "ParagraphParameters.h"
64 #include "insets/insetbox.h"
65 #include "insets/insetbranch.h"
66 #include "insets/insetcommand.h"
67 #include "insets/insetert.h"
68 #include "insets/insetexternal.h"
69 #include "insets/insetfloat.h"
70 #include "insets/insetgraphics.h"
71 #include "insets/insetinclude.h"
72 #include "insets/insetnote.h"
73 #include "insets/insettabular.h"
74 #include "insets/insetvspace.h"
75 #include "insets/insetwrap.h"
77 #include "frontends/Application.h"
78 #include "frontends/Alert.h"
79 #include "frontends/Dialogs.h"
80 #include "frontends/FileDialog.h"
81 #include "frontends/FontLoader.h"
82 #include "frontends/Gui.h"
83 #include "frontends/LyXKeySym.h"
84 #include "frontends/LyXView.h"
85 #include "frontends/Menubar.h"
86 #include "frontends/Toolbars.h"
88 #include "support/environment.h"
89 #include "support/filefilterlist.h"
90 #include "support/filetools.h"
91 #include "support/forkedcontr.h"
92 #include "support/fs_extras.h"
93 #include "support/lstrings.h"
94 #include "support/path.h"
95 #include "support/package.h"
96 #include "support/systemcall.h"
97 #include "support/convert.h"
98 #include "support/os.h"
100 #include <boost/current_function.hpp>
101 #include <boost/filesystem/operations.hpp>
108 using bv_funcs::freefont2string;
110 using support::absolutePath;
111 using support::addName;
112 using support::addPath;
113 using support::bformat;
114 using support::changeExtension;
115 using support::contains;
116 using support::FileFilterList;
117 using support::FileName;
118 using support::fileSearch;
119 using support::ForkedcallsController;
120 using support::i18nLibFileSearch;
121 using support::isDirWriteable;
122 using support::isFileReadable;
123 using support::isStrInt;
124 using support::makeAbsPath;
125 using support::makeDisplayPath;
126 using support::package;
127 using support::quoteName;
128 using support::rtrim;
129 using support::split;
130 using support::subst;
131 using support::Systemcall;
132 using support::token;
134 using support::prefixIs;
137 using std::make_pair;
140 using std::istringstream;
141 using std::ostringstream;
143 namespace Alert = frontend::Alert;
144 namespace fs = boost::filesystem;
148 extern tex_accent_struct get_accent(kb_action action);
153 bool getLocalStatus(LCursor cursor,
154 FuncRequest const & cmd, FuncStatus & status)
156 // Try to fix cursor in case it is broken.
157 cursor.fixIfBroken();
159 // This is, of course, a mess. Better create a new doc iterator and use
160 // this in Inset::getStatus. This might require an additional
161 // BufferView * arg, though (which should be avoided)
162 //LCursor safe = *this;
164 for ( ; cursor.depth(); cursor.pop()) {
165 //lyxerr << "\nLCursor::getStatus: cmd: " << cmd << endl << *this << endl;
166 BOOST_ASSERT(cursor.idx() <= cursor.lastidx());
167 BOOST_ASSERT(cursor.pit() <= cursor.lastpit());
168 BOOST_ASSERT(cursor.pos() <= cursor.lastpos());
170 // The inset's getStatus() will return 'true' if it made
171 // a definitive decision on whether it want to handle the
172 // request or not. The result of this decision is put into
173 // the 'status' parameter.
174 if (cursor.inset().getStatus(cursor, cmd, status)) {
183 /** Return the change status at cursor position, taking in account the
184 * status at each level of the document iterator (a table in a deleted
185 * footnote is deleted).
186 * When \param outer is true, the top slice is not looked at.
188 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
190 size_t const depth = dit.depth() - (outer ? 1 : 0);
192 for (size_t i = 0 ; i < depth ; ++i) {
193 CursorSlice const & slice = dit[i];
194 if (!slice.inset().inMathed()
195 && slice.pos() < slice.paragraph().size()) {
196 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
197 if (ch != Change::UNCHANGED)
201 return Change::UNCHANGED;
209 meta_fake_bit(key_modifier::none)
214 void LyXFunc::initKeySequences(kb_keymap * kb)
216 keyseq.reset(new kb_sequence(kb, kb));
217 cancel_meta_seq.reset(new kb_sequence(kb, kb));
221 void LyXFunc::setLyXView(LyXView * lv)
227 void LyXFunc::handleKeyFunc(kb_action action)
229 char_type c = encoded_last_key;
231 if (keyseq->length())
234 lyx_view_->view()->getIntl().getTransManager().deadkey(
235 c, get_accent(action).accent, view()->cursor().innerText(), view()->cursor());
236 // Need to clear, in case the minibuffer calls these
239 // copied verbatim from do_accent_char
240 view()->cursor().resetAnchor();
245 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
247 BOOST_ASSERT(lyx_view_);
248 if (!LyX::ref().session().bookmarks().isValid(idx))
250 BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(idx);
251 BOOST_ASSERT(!bm.filename.empty());
252 string const file = bm.filename.absFilename();
253 // if the file is not opened, open it.
254 if (!theBufferList().exists(file)) {
256 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
260 // open may fail, so we need to test it again
261 if (theBufferList().exists(file)) {
262 // if the current buffer is not that one, switch to it.
263 if (lyx_view_->buffer()->fileName() != file) {
265 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
269 // moveToPosition use par_id, and par_pit and return new par_id.
272 boost::tie(new_pit, new_id) = view()->moveToPosition(bm.par_pit, bm.par_id, bm.par_pos);
273 // if par_id or pit has been changed, reset par_pit and par_id
274 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
275 if (bm.par_pit != new_pit || bm.par_id != new_id)
276 const_cast<BookmarksSection::Bookmark &>(bm).setPos(new_pit, new_id);
281 void LyXFunc::processKeySym(LyXKeySymPtr keysym, key_modifier::state state)
283 lyxerr[Debug::KEY] << "KeySym is " << keysym->getSymbolName() << endl;
285 // Do nothing if we have nothing (JMarc)
286 if (!keysym->isOK()) {
287 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
292 if (keysym->isModifier()) {
293 lyxerr[Debug::KEY] << "isModifier true" << endl;
297 //Encoding const * encoding = view()->cursor().getEncoding();
298 //encoded_last_key = keysym->getISOEncoded(encoding ? encoding->name() : "");
299 // FIXME: encoded_last_key shadows the member variable of the same
300 // name. Is that intended?
301 char_type encoded_last_key = keysym->getUCSEncoded();
303 // Do a one-deep top-level lookup for
304 // cancel and meta-fake keys. RVDK_PATCH_5
305 cancel_meta_seq->reset();
307 FuncRequest func = cancel_meta_seq->addkey(keysym, state);
308 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
309 << " action first set to [" << func.action << ']'
312 // When not cancel or meta-fake, do the normal lookup.
313 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
314 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
315 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
316 // remove Caps Lock and Mod2 as a modifiers
317 func = keyseq->addkey(keysym, (state | meta_fake_bit));
318 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
319 << "action now set to ["
320 << func.action << ']' << endl;
323 // Dont remove this unless you know what you are doing.
324 meta_fake_bit = key_modifier::none;
326 // Can this happen now ?
327 if (func.action == LFUN_NOACTION) {
328 func = FuncRequest(LFUN_COMMAND_PREFIX);
331 if (lyxerr.debugging(Debug::KEY)) {
332 lyxerr << BOOST_CURRENT_FUNCTION
334 << func.action << "]["
335 << to_utf8(keyseq->print(false)) << ']'
339 // already here we know if it any point in going further
340 // why not return already here if action == -1 and
341 // num_bytes == 0? (Lgb)
343 if (keyseq->length() > 1) {
344 lyx_view_->message(keyseq->print(true));
348 // Maybe user can only reach the key via holding down shift.
349 // Let's see. But only if shift is the only modifier
350 if (func.action == LFUN_UNKNOWN_ACTION &&
351 state == key_modifier::shift) {
352 lyxerr[Debug::KEY] << "Trying without shift" << endl;
353 func = keyseq->addkey(keysym, key_modifier::none);
354 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
357 if (func.action == LFUN_UNKNOWN_ACTION) {
358 // Hmm, we didn't match any of the keysequences. See
359 // if it's normal insertable text not already covered
361 if (keysym->isText() && keyseq->length() == 1) {
362 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
363 func = FuncRequest(LFUN_SELF_INSERT,
364 FuncRequest::KEYBOARD);
366 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
367 lyx_view_->message(_("Unknown function."));
372 if (func.action == LFUN_SELF_INSERT) {
373 if (encoded_last_key != 0) {
374 docstring const arg(1, encoded_last_key);
375 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
376 FuncRequest::KEYBOARD));
378 << "SelfInsert arg[`" << to_utf8(arg) << "']" << endl;
386 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
388 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
391 LCursor & cur = view()->cursor();
393 /* In LyX/Mac, when a dialog is open, the menus of the
394 application can still be accessed without giving focus to
395 the main window. In this case, we want to disable the menu
396 entries that are buffer-related.
398 Note that this code is not perfect, as bug 1941 attests:
399 http://bugzilla.lyx.org/show_bug.cgi?id=1941#c4
401 Buffer * buf = lyx_view_? lyx_view_->buffer() : 0;
402 if (lyx_view_ && cmd.origin == FuncRequest::MENU && !lyx_view_->hasFocus())
405 if (cmd.action == LFUN_NOACTION) {
406 flag.message(from_utf8(N_("Nothing to do")));
411 switch (cmd.action) {
412 case LFUN_UNKNOWN_ACTION:
413 #ifndef HAVE_LIBAIKSAURUS
414 case LFUN_THESAURUS_ENTRY:
424 if (flag.unknown()) {
425 flag.message(from_utf8(N_("Unknown action")));
429 if (!flag.enabled()) {
430 if (flag.message().empty())
431 flag.message(from_utf8(N_("Command disabled")));
435 // Check whether we need a buffer
436 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
438 flag.message(from_utf8(N_("Command not allowed with"
439 "out any document open")));
444 // I would really like to avoid having this switch and rather try to
445 // encode this in the function itself.
446 // -- And I'd rather let an inset decide which LFUNs it is willing
447 // to handle (Andre')
449 switch (cmd.action) {
450 case LFUN_BUFFER_TOGGLE_READ_ONLY:
451 flag.setOnOff(buf->isReadonly());
454 case LFUN_BUFFER_SWITCH:
455 // toggle on the current buffer, but do not toggle off
456 // the other ones (is that a good idea?)
457 if (to_utf8(cmd.argument()) == buf->fileName())
461 case LFUN_BUFFER_EXPORT:
462 enable = cmd.argument() == "custom"
463 || Exporter::isExportable(*buf, to_utf8(cmd.argument()));
466 case LFUN_BUFFER_CHKTEX:
467 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
470 case LFUN_BUILD_PROGRAM:
471 enable = Exporter::isExportable(*buf, "program");
474 case LFUN_LAYOUT_TABULAR:
475 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
479 case LFUN_LAYOUT_PARAGRAPH:
480 enable = !cur.inset().forceDefaultParagraphs(cur.idx());
483 case LFUN_VC_REGISTER:
484 enable = !buf->lyxvc().inUse();
486 case LFUN_VC_CHECK_IN:
487 enable = buf->lyxvc().inUse() && !buf->isReadonly();
489 case LFUN_VC_CHECK_OUT:
490 enable = buf->lyxvc().inUse() && buf->isReadonly();
493 case LFUN_VC_UNDO_LAST:
494 enable = buf->lyxvc().inUse();
496 case LFUN_BUFFER_RELOAD:
497 enable = !buf->isUnnamed() && !buf->isClean();
500 case LFUN_INSET_SETTINGS: {
504 InsetBase::Code code = cur.inset().lyxCode();
506 case InsetBase::TABULAR_CODE:
507 enable = cmd.argument() == "tabular";
509 case InsetBase::ERT_CODE:
510 enable = cmd.argument() == "ert";
512 case InsetBase::FLOAT_CODE:
513 enable = cmd.argument() == "float";
515 case InsetBase::WRAP_CODE:
516 enable = cmd.argument() == "wrap";
518 case InsetBase::NOTE_CODE:
519 enable = cmd.argument() == "note";
521 case InsetBase::BRANCH_CODE:
522 enable = cmd.argument() == "branch";
524 case InsetBase::BOX_CODE:
525 enable = cmd.argument() == "box";
533 case LFUN_INSET_APPLY: {
534 string const name = cmd.getArg(0);
535 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
537 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
539 if (!inset->getStatus(cur, fr, fs)) {
540 // Every inset is supposed to handle this
545 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
546 flag |= getStatus(fr);
548 enable = flag.enabled();
552 case LFUN_DIALOG_SHOW: {
553 string const name = cmd.getArg(0);
555 enable = name == "aboutlyx"
559 || name == "texinfo";
560 else if (name == "print")
561 enable = Exporter::isExportable(*buf, "dvi")
562 && lyxrc.print_command != "none";
563 else if (name == "character" || name == "mathpanel")
564 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
565 else if (name == "latexlog")
566 enable = isFileReadable(FileName(buf->getLogName().second));
567 #if !defined (USE_ASPELL) && !defined (USE_ISPELL) && !defined (USE_PSPELL)
568 else if (name == "spellchecker")
571 else if (name == "vclog")
572 enable = buf->lyxvc().inUse();
573 else if (name == "view-source")
578 case LFUN_DIALOG_SHOW_NEW_INSET:
579 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
580 if (cur.inset().lyxCode() == InsetBase::CAPTION_CODE) {
582 if (cur.inset().getStatus(cur, cmd, flag))
587 case LFUN_DIALOG_UPDATE: {
588 string const name = cmd.getArg(0);
590 enable = name == "prefs";
594 case LFUN_CITATION_INSERT: {
595 FuncRequest fr(LFUN_INSET_INSERT, "citation");
596 enable = getStatus(fr).enabled();
600 case LFUN_BUFFER_WRITE: {
601 enable = view()->buffer()->isUnnamed()
602 || !view()->buffer()->isClean();
606 case LFUN_BOOKMARK_GOTO: {
607 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
608 enable = LyX::ref().session().bookmarks().isValid(num);
612 case LFUN_BOOKMARK_CLEAR:
613 enable = LyX::ref().session().bookmarks().size() > 0;
616 case LFUN_TOOLBAR_TOGGLE_STATE: {
617 ToolbarBackend::Flags flags = lyx_view_->getToolbarState(to_utf8(cmd.argument()));
618 if (!(flags & ToolbarBackend::AUTO))
619 flag.setOnOff(flags & ToolbarBackend::ON);
623 // this one is difficult to get right. As a half-baked
624 // solution, we consider only the first action of the sequence
625 case LFUN_COMMAND_SEQUENCE: {
626 // argument contains ';'-terminated commands
627 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
628 FuncRequest func(lyxaction.lookupFunc(firstcmd));
629 func.origin = cmd.origin;
630 flag = getStatus(func);
633 case LFUN_BUFFER_NEW:
634 case LFUN_BUFFER_NEW_TEMPLATE:
635 case LFUN_WORD_FIND_FORWARD:
636 case LFUN_WORD_FIND_BACKWARD:
637 case LFUN_COMMAND_PREFIX:
638 case LFUN_COMMAND_EXECUTE:
640 case LFUN_META_PREFIX:
641 case LFUN_BUFFER_CLOSE:
642 case LFUN_BUFFER_WRITE_AS:
643 case LFUN_BUFFER_UPDATE:
644 case LFUN_BUFFER_VIEW:
645 case LFUN_BUFFER_IMPORT:
647 case LFUN_BUFFER_AUTO_SAVE:
648 case LFUN_RECONFIGURE:
652 case LFUN_DROP_LAYOUTS_CHOICE:
654 case LFUN_SERVER_GET_NAME:
655 case LFUN_SERVER_NOTIFY:
656 case LFUN_SERVER_GOTO_FILE_ROW:
657 case LFUN_DIALOG_HIDE:
658 case LFUN_DIALOG_DISCONNECT_INSET:
659 case LFUN_BUFFER_CHILD_OPEN:
660 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
661 case LFUN_KEYMAP_OFF:
662 case LFUN_KEYMAP_PRIMARY:
663 case LFUN_KEYMAP_SECONDARY:
664 case LFUN_KEYMAP_TOGGLE:
666 case LFUN_BUFFER_EXPORT_CUSTOM:
667 case LFUN_BUFFER_PRINT:
668 case LFUN_PREFERENCES_SAVE:
669 case LFUN_SCREEN_FONT_UPDATE:
672 case LFUN_EXTERNAL_EDIT:
673 case LFUN_GRAPHICS_EDIT:
674 case LFUN_ALL_INSETS_TOGGLE:
675 case LFUN_BUFFER_LANGUAGE:
676 case LFUN_TEXTCLASS_APPLY:
677 case LFUN_TEXTCLASS_LOAD:
678 case LFUN_BUFFER_SAVE_AS_DEFAULT:
679 case LFUN_BUFFER_PARAMS_APPLY:
680 case LFUN_LYXRC_APPLY:
681 case LFUN_BUFFER_NEXT:
682 case LFUN_BUFFER_PREVIOUS:
683 case LFUN_WINDOW_NEW:
684 case LFUN_WINDOW_CLOSE:
686 // these are handled in our dispatch()
690 if (!getLocalStatus(cur, cmd, flag))
691 flag = view()->getStatus(cmd);
697 // Can we use a readonly buffer?
698 if (buf && buf->isReadonly()
699 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
700 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
701 flag.message(from_utf8(N_("Document is read-only")));
705 // Are we in a DELETED change-tracking region?
706 if (buf && lookupChangeType(cur, true) == Change::DELETED
707 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
708 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
709 flag.message(from_utf8(N_("This portion of the document is deleted.")));
713 // the default error message if we disable the command
714 if (!flag.enabled() && flag.message().empty())
715 flag.message(from_utf8(N_("Command disabled")));
721 bool LyXFunc::ensureBufferClean(BufferView * bv)
723 Buffer & buf = *bv->buffer();
727 docstring const file = makeDisplayPath(buf.fileName(), 30);
728 docstring text = bformat(_("The document %1$s has unsaved "
729 "changes.\n\nDo you want to save "
730 "the document?"), file);
731 int const ret = Alert::prompt(_("Save changed document?"),
732 text, 0, 1, _("&Save"),
736 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
738 return buf.isClean();
744 void showPrintError(string const & name)
746 docstring str = bformat(_("Could not print the document %1$s.\n"
747 "Check that your printer is set up correctly."),
748 makeDisplayPath(name, 50));
749 Alert::error(_("Print document failed"), str);
753 void loadTextclass(string const & name)
755 std::pair<bool, textclass_type> const tc_pair =
756 textclasslist.numberOfClass(name);
758 if (!tc_pair.first) {
759 lyxerr << "Document class \"" << name
760 << "\" does not exist."
765 textclass_type const tc = tc_pair.second;
767 if (!textclasslist[tc].load()) {
768 docstring s = bformat(_("The document could not be converted\n"
769 "into the document class %1$s."),
770 from_utf8(textclasslist[tc].name()));
771 Alert::error(_("Could not change class"), s);
776 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
781 void LyXFunc::dispatch(FuncRequest const & cmd)
783 string const argument = to_utf8(cmd.argument());
784 kb_action const action = cmd.action;
786 lyxerr[Debug::ACTION] << endl << "LyXFunc::dispatch: cmd: " << cmd << endl;
787 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
789 // we have not done anything wrong yet.
791 dispatch_buffer.erase();
793 // redraw the screen at the end (first of the two drawing steps).
794 //This is done unless explicitely requested otherwise
795 Update::flags updateFlags = Update::FitCursor;
797 FuncStatus const flag = getStatus(cmd);
798 if (!flag.enabled()) {
799 // We cannot use this function here
800 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
801 << lyxaction.getActionName(action)
802 << " [" << action << "] is disabled at this location"
804 setErrorMessage(flag.message());
808 case LFUN_WORD_FIND_FORWARD:
809 case LFUN_WORD_FIND_BACKWARD: {
810 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
811 static docstring last_search;
812 docstring searched_string;
814 if (!cmd.argument().empty()) {
815 last_search = cmd.argument();
816 searched_string = cmd.argument();
818 searched_string = last_search;
821 if (searched_string.empty())
824 bool const fw = action == LFUN_WORD_FIND_FORWARD;
825 docstring const data =
826 find2string(searched_string, true, false, fw);
827 find(view(), FuncRequest(LFUN_WORD_FIND, data));
831 case LFUN_COMMAND_PREFIX:
832 BOOST_ASSERT(lyx_view_);
833 lyx_view_->message(keyseq->printOptions(true));
836 case LFUN_COMMAND_EXECUTE:
837 BOOST_ASSERT(lyx_view_);
838 lyx_view_->getToolbars().display("minibuffer", true);
839 lyx_view_->focus_command_buffer();
843 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
845 meta_fake_bit = key_modifier::none;
846 if (view()->buffer())
847 // cancel any selection
848 dispatch(FuncRequest(LFUN_MARK_OFF));
849 setMessage(from_ascii(N_("Cancel")));
852 case LFUN_META_PREFIX:
853 meta_fake_bit = key_modifier::alt;
854 setMessage(keyseq->print(true));
857 case LFUN_BUFFER_TOGGLE_READ_ONLY:
858 BOOST_ASSERT(lyx_view_ && lyx_view_->view() && lyx_view_->buffer());
859 if (lyx_view_->buffer()->lyxvc().inUse())
860 lyx_view_->buffer()->lyxvc().toggleReadOnly();
862 lyx_view_->buffer()->setReadonly(
863 !lyx_view_->buffer()->isReadonly());
866 // --- Menus -----------------------------------------------
867 case LFUN_BUFFER_NEW:
868 menuNew(argument, false);
871 case LFUN_BUFFER_NEW_TEMPLATE:
872 menuNew(argument, true);
875 case LFUN_BUFFER_CLOSE:
880 case LFUN_BUFFER_WRITE:
881 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
882 if (!lyx_view_->buffer()->isUnnamed()) {
883 docstring const str = bformat(_("Saving document %1$s..."),
884 makeDisplayPath(lyx_view_->buffer()->fileName()));
885 lyx_view_->message(str);
886 menuWrite(lyx_view_->buffer());
887 lyx_view_->message(str + _(" done."));
889 writeAs(lyx_view_->buffer());
891 updateFlags = Update::None;
894 case LFUN_BUFFER_WRITE_AS:
895 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
896 writeAs(lyx_view_->buffer(), argument);
897 updateFlags = Update::None;
900 case LFUN_BUFFER_RELOAD: {
901 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
902 docstring const file = makeDisplayPath(view()->buffer()->fileName(), 20);
903 docstring text = bformat(_("Any changes will be lost. Are you sure "
904 "you want to revert to the saved version of the document %1$s?"), file);
905 int const ret = Alert::prompt(_("Revert to saved document?"),
906 text, 0, 1, _("&Revert"), _("&Cancel"));
913 case LFUN_BUFFER_UPDATE:
914 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
915 Exporter::Export(lyx_view_->buffer(), argument, true);
918 case LFUN_BUFFER_VIEW:
919 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
920 Exporter::preview(lyx_view_->buffer(), argument);
923 case LFUN_BUILD_PROGRAM:
924 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
925 Exporter::Export(lyx_view_->buffer(), "program", true);
928 case LFUN_BUFFER_CHKTEX:
929 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
930 lyx_view_->buffer()->runChktex();
933 case LFUN_BUFFER_EXPORT:
934 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
935 if (argument == "custom")
936 lyx_view_->getDialogs().show("sendto");
938 Exporter::Export(lyx_view_->buffer(), argument, false);
942 case LFUN_BUFFER_EXPORT_CUSTOM: {
943 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
945 string command = split(argument, format_name, ' ');
946 Format const * format = formats.getFormat(format_name);
948 lyxerr << "Format \"" << format_name
949 << "\" not recognized!"
954 Buffer * buffer = lyx_view_->buffer();
956 // The name of the file created by the conversion process
959 // Output to filename
960 if (format->name() == "lyx") {
961 string const latexname =
962 buffer->getLatexName(false);
963 filename = changeExtension(latexname,
964 format->extension());
965 filename = addName(buffer->temppath(), filename);
967 if (!buffer->writeFile(FileName(filename)))
971 Exporter::Export(buffer, format_name, true, filename);
974 // Substitute $$FName for filename
975 if (!contains(command, "$$FName"))
976 command = "( " + command + " ) < $$FName";
977 command = subst(command, "$$FName", filename);
979 // Execute the command in the background
981 call.startscript(Systemcall::DontWait, command);
985 case LFUN_BUFFER_PRINT: {
986 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
989 string command = split(split(argument, target, ' '),
993 || target_name.empty()
994 || command.empty()) {
995 lyxerr << "Unable to parse \""
996 << argument << '"' << std::endl;
999 if (target != "printer" && target != "file") {
1000 lyxerr << "Unrecognized target \""
1001 << target << '"' << std::endl;
1005 Buffer * buffer = lyx_view_->buffer();
1007 if (!Exporter::Export(buffer, "dvi", true)) {
1008 showPrintError(buffer->fileName());
1012 // Push directory path.
1013 string const path = buffer->temppath();
1014 support::Path p(path);
1016 // there are three cases here:
1017 // 1. we print to a file
1018 // 2. we print directly to a printer
1019 // 3. we print using a spool command (print to file first)
1022 string const dviname =
1023 changeExtension(buffer->getLatexName(true),
1026 if (target == "printer") {
1027 if (!lyxrc.print_spool_command.empty()) {
1028 // case 3: print using a spool
1029 string const psname =
1030 changeExtension(dviname,".ps");
1031 command += lyxrc.print_to_file
1034 + quoteName(dviname);
1037 lyxrc.print_spool_command +' ';
1038 if (target_name != "default") {
1039 command2 += lyxrc.print_spool_printerprefix
1043 command2 += quoteName(psname);
1045 // If successful, then spool command
1046 res = one.startscript(
1051 res = one.startscript(
1052 Systemcall::DontWait,
1055 // case 2: print directly to a printer
1056 res = one.startscript(
1057 Systemcall::DontWait,
1058 command + quoteName(dviname));
1062 // case 1: print to a file
1063 FileName const filename(makeAbsPath(target_name, path));
1064 if (fs::exists(filename.toFilesystemEncoding())) {
1065 docstring text = bformat(
1066 _("The file %1$s already exists.\n\n"
1067 "Do you want to over-write that file?"),
1068 makeDisplayPath(filename.absFilename()));
1069 if (Alert::prompt(_("Over-write file?"),
1070 text, 0, 1, _("&Over-write"), _("&Cancel")) != 0)
1073 command += lyxrc.print_to_file
1074 + quoteName(filename.toFilesystemEncoding())
1076 + quoteName(dviname);
1077 res = one.startscript(Systemcall::DontWait,
1082 showPrintError(buffer->fileName());
1086 case LFUN_BUFFER_IMPORT:
1091 // quitting is triggered by the gui code
1092 // (leaving the event loop).
1093 lyx_view_->message(from_utf8(N_("Exiting.")));
1094 if (theBufferList().quitWriteAll())
1095 theApp()->gui().closeAllViews();
1098 case LFUN_TOC_VIEW: {
1099 BOOST_ASSERT(lyx_view_);
1100 InsetCommandParams p("tableofcontents");
1101 string const data = InsetCommandMailer::params2string("toc", p);
1102 lyx_view_->getDialogs().show("toc", data, 0);
1106 case LFUN_BUFFER_AUTO_SAVE:
1110 case LFUN_RECONFIGURE:
1111 BOOST_ASSERT(lyx_view_);
1112 reconfigure(*lyx_view_);
1115 case LFUN_HELP_OPEN: {
1116 BOOST_ASSERT(lyx_view_);
1117 string const arg = argument;
1119 setErrorMessage(from_ascii(N_("Missing argument")));
1122 FileName const fname = i18nLibFileSearch("doc", arg, "lyx");
1123 if (fname.empty()) {
1124 lyxerr << "LyX: unable to find documentation file `"
1125 << arg << "'. Bad installation?" << endl;
1128 lyx_view_->message(bformat(_("Opening help file %1$s..."),
1129 makeDisplayPath(fname.absFilename())));
1130 lyx_view_->loadLyXFile(fname, false);
1134 // --- version control -------------------------------
1135 case LFUN_VC_REGISTER:
1136 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1137 if (!ensureBufferClean(view()))
1139 if (!lyx_view_->buffer()->lyxvc().inUse()) {
1140 lyx_view_->buffer()->lyxvc().registrer();
1143 updateFlags = Update::Force;
1146 case LFUN_VC_CHECK_IN:
1147 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1148 if (!ensureBufferClean(view()))
1150 if (lyx_view_->buffer()->lyxvc().inUse()
1151 && !lyx_view_->buffer()->isReadonly()) {
1152 lyx_view_->buffer()->lyxvc().checkIn();
1157 case LFUN_VC_CHECK_OUT:
1158 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1159 if (!ensureBufferClean(view()))
1161 if (lyx_view_->buffer()->lyxvc().inUse()
1162 && lyx_view_->buffer()->isReadonly()) {
1163 lyx_view_->buffer()->lyxvc().checkOut();
1168 case LFUN_VC_REVERT:
1169 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1170 lyx_view_->buffer()->lyxvc().revert();
1174 case LFUN_VC_UNDO_LAST:
1175 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1176 lyx_view_->buffer()->lyxvc().undoLast();
1180 // --- buffers ----------------------------------------
1181 case LFUN_BUFFER_SWITCH:
1182 BOOST_ASSERT(lyx_view_);
1183 lyx_view_->setBuffer(theBufferList().getBuffer(argument));
1186 case LFUN_BUFFER_NEXT:
1187 BOOST_ASSERT(lyx_view_);
1188 lyx_view_->setBuffer(theBufferList().next(view()->buffer()));
1191 case LFUN_BUFFER_PREVIOUS:
1192 BOOST_ASSERT(lyx_view_);
1193 lyx_view_->setBuffer(theBufferList().previous(view()->buffer()));
1197 BOOST_ASSERT(lyx_view_);
1198 newFile(view(), argument);
1201 case LFUN_FILE_OPEN:
1202 BOOST_ASSERT(lyx_view_);
1206 case LFUN_DROP_LAYOUTS_CHOICE:
1207 BOOST_ASSERT(lyx_view_);
1208 lyx_view_->getToolbars().openLayoutList();
1211 case LFUN_MENU_OPEN:
1212 BOOST_ASSERT(lyx_view_);
1213 lyx_view_->getMenubar().openByName(from_utf8(argument));
1216 // --- lyxserver commands ----------------------------
1217 case LFUN_SERVER_GET_NAME:
1218 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1219 setMessage(from_utf8(lyx_view_->buffer()->fileName()));
1220 lyxerr[Debug::INFO] << "FNAME["
1221 << lyx_view_->buffer()->fileName()
1225 case LFUN_SERVER_NOTIFY:
1226 dispatch_buffer = keyseq->print(false);
1227 theLyXServer().notifyClient(to_utf8(dispatch_buffer));
1230 case LFUN_SERVER_GOTO_FILE_ROW: {
1231 BOOST_ASSERT(lyx_view_);
1234 istringstream is(argument);
1235 is >> file_name >> row;
1236 if (prefixIs(file_name, package().temp_dir())) {
1237 // Needed by inverse dvi search. If it is a file
1238 // in tmpdir, call the apropriated function
1239 lyx_view_->setBuffer(theBufferList().getBufferFromTmp(file_name));
1241 // Must replace extension of the file to be .lyx
1242 // and get full path
1243 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1244 // Either change buffer or load the file
1245 if (theBufferList().exists(s.absFilename())) {
1246 lyx_view_->setBuffer(theBufferList().getBuffer(s.absFilename()));
1248 lyx_view_->loadLyXFile(s);
1252 view()->setCursorFromRow(row);
1254 updateFlags = Update::FitCursor;
1258 case LFUN_DIALOG_SHOW: {
1259 BOOST_ASSERT(lyx_view_);
1260 string const name = cmd.getArg(0);
1261 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1263 if (name == "character") {
1264 data = freefont2string();
1266 lyx_view_->getDialogs().show("character", data);
1267 } else if (name == "latexlog") {
1268 pair<Buffer::LogType, string> const logfile =
1269 lyx_view_->buffer()->getLogName();
1270 switch (logfile.first) {
1271 case Buffer::latexlog:
1274 case Buffer::buildlog:
1278 data += LyXLex::quoteString(logfile.second);
1279 lyx_view_->getDialogs().show("log", data);
1280 } else if (name == "vclog") {
1281 string const data = "vc " +
1282 LyXLex::quoteString(lyx_view_->buffer()->lyxvc().getLogFile());
1283 lyx_view_->getDialogs().show("log", data);
1285 lyx_view_->getDialogs().show(name, data);
1289 case LFUN_DIALOG_SHOW_NEW_INSET: {
1290 BOOST_ASSERT(lyx_view_);
1291 string const name = cmd.getArg(0);
1292 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1293 if (name == "bibitem" ||
1297 name == "nomenclature" ||
1301 InsetCommandParams p(name);
1302 data = InsetCommandMailer::params2string(name, p);
1303 } else if (name == "include") {
1304 // data is the include type: one of "include",
1305 // "input", "verbatiminput" or "verbatiminput*"
1307 // default type is requested
1309 InsetCommandParams p(data);
1310 data = InsetIncludeMailer::params2string(p);
1311 } else if (name == "box") {
1312 // \c data == "Boxed" || "Frameless" etc
1313 InsetBoxParams p(data);
1314 data = InsetBoxMailer::params2string(p);
1315 } else if (name == "branch") {
1316 InsetBranchParams p;
1317 data = InsetBranchMailer::params2string(p);
1318 } else if (name == "citation") {
1319 InsetCommandParams p("cite");
1320 data = InsetCommandMailer::params2string(name, p);
1321 } else if (name == "ert") {
1322 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1323 } else if (name == "external") {
1324 InsetExternalParams p;
1325 Buffer const & buffer = *lyx_view_->buffer();
1326 data = InsetExternalMailer::params2string(p, buffer);
1327 } else if (name == "float") {
1329 data = InsetFloatMailer::params2string(p);
1330 } else if (name == "graphics") {
1331 InsetGraphicsParams p;
1332 Buffer const & buffer = *lyx_view_->buffer();
1333 data = InsetGraphicsMailer::params2string(p, buffer);
1334 } else if (name == "note") {
1336 data = InsetNoteMailer::params2string(p);
1337 } else if (name == "vspace") {
1339 data = InsetVSpaceMailer::params2string(space);
1340 } else if (name == "wrap") {
1342 data = InsetWrapMailer::params2string(p);
1344 lyx_view_->getDialogs().show(name, data, 0);
1348 case LFUN_DIALOG_UPDATE: {
1349 BOOST_ASSERT(lyx_view_);
1350 string const & name = argument;
1351 // Can only update a dialog connected to an existing inset
1352 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1354 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument());
1355 inset->dispatch(view()->cursor(), fr);
1356 } else if (name == "paragraph") {
1357 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1358 } else if (name == "prefs") {
1359 lyx_view_->getDialogs().update(name, string());
1364 case LFUN_DIALOG_HIDE:
1365 Dialogs::hide(argument, 0);
1368 case LFUN_DIALOG_DISCONNECT_INSET:
1369 BOOST_ASSERT(lyx_view_);
1370 lyx_view_->getDialogs().disconnect(argument);
1374 case LFUN_CITATION_INSERT: {
1375 BOOST_ASSERT(lyx_view_);
1376 if (!argument.empty()) {
1377 // we can have one optional argument, delimited by '|'
1378 // citation-insert <key>|<text_before>
1379 // this should be enhanced to also support text_after
1380 // and citation style
1381 string arg = argument;
1383 if (contains(argument, "|")) {
1384 arg = token(argument, '|', 0);
1385 opt1 = '[' + token(argument, '|', 1) + ']';
1387 std::ostringstream os;
1388 os << "citation LatexCommand\n"
1389 << "\\cite" << opt1 << "{" << arg << "}\n"
1391 FuncRequest fr(LFUN_INSET_INSERT, os.str());
1394 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "citation"));
1398 case LFUN_BUFFER_CHILD_OPEN: {
1399 BOOST_ASSERT(lyx_view_);
1400 FileName const filename =
1401 makeAbsPath(argument, lyx_view_->buffer()->filePath());
1402 setMessage(bformat(_("Opening child document %1$s..."),
1403 makeDisplayPath(filename.absFilename())));
1404 view()->saveBookmark(false);
1405 string const parentfilename = lyx_view_->buffer()->fileName();
1406 if (theBufferList().exists(filename.absFilename()))
1407 lyx_view_->setBuffer(theBufferList().getBuffer(filename.absFilename()));
1409 lyx_view_->loadLyXFile(filename);
1410 // Set the parent name of the child document.
1411 // This makes insertion of citations and references in the child work,
1412 // when the target is in the parent or another child document.
1413 lyx_view_->buffer()->setParentName(parentfilename);
1417 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
1418 BOOST_ASSERT(lyx_view_);
1419 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1422 case LFUN_KEYMAP_OFF:
1423 BOOST_ASSERT(lyx_view_);
1424 lyx_view_->view()->getIntl().keyMapOn(false);
1427 case LFUN_KEYMAP_PRIMARY:
1428 BOOST_ASSERT(lyx_view_);
1429 lyx_view_->view()->getIntl().keyMapPrim();
1432 case LFUN_KEYMAP_SECONDARY:
1433 BOOST_ASSERT(lyx_view_);
1434 lyx_view_->view()->getIntl().keyMapSec();
1437 case LFUN_KEYMAP_TOGGLE:
1438 BOOST_ASSERT(lyx_view_);
1439 lyx_view_->view()->getIntl().toggleKeyMap();
1445 string rest = split(argument, countstr, ' ');
1446 istringstream is(countstr);
1449 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1450 for (int i = 0; i < count; ++i)
1451 dispatch(lyxaction.lookupFunc(rest));
1455 case LFUN_COMMAND_SEQUENCE: {
1456 // argument contains ';'-terminated commands
1457 string arg = argument;
1458 while (!arg.empty()) {
1460 arg = split(arg, first, ';');
1461 FuncRequest func(lyxaction.lookupFunc(first));
1462 func.origin = cmd.origin;
1468 case LFUN_PREFERENCES_SAVE: {
1469 lyxrc.write(makeAbsPath("preferences",
1470 package().user_support()),
1475 case LFUN_SCREEN_FONT_UPDATE:
1476 BOOST_ASSERT(lyx_view_);
1477 // handle the screen font changes.
1478 theFontLoader().update();
1479 /// FIXME: only the current view will be updated. the Gui
1480 /// class is able to furnish the list of views.
1481 updateFlags = Update::Force;
1484 case LFUN_SET_COLOR: {
1486 string const x11_name = split(argument, lyx_name, ' ');
1487 if (lyx_name.empty() || x11_name.empty()) {
1488 setErrorMessage(from_ascii(N_(
1489 "Syntax: set-color <lyx_name>"
1494 bool const graphicsbg_changed =
1495 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1496 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1498 if (!lcolor.setColor(lyx_name, x11_name)) {
1500 bformat(_("Set-color \"%1$s\" failed "
1501 "- color is undefined or "
1502 "may not be redefined"),
1503 from_utf8(lyx_name)));
1507 theApp()->updateColor(lcolor.getFromLyXName(lyx_name));
1509 if (graphicsbg_changed) {
1510 #ifdef WITH_WARNINGS
1511 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1514 graphics::GCache::get().changeDisplay(true);
1521 BOOST_ASSERT(lyx_view_);
1522 lyx_view_->message(from_utf8(argument));
1525 case LFUN_EXTERNAL_EDIT: {
1526 BOOST_ASSERT(lyx_view_);
1527 FuncRequest fr(action, argument);
1528 InsetExternal().dispatch(view()->cursor(), fr);
1532 case LFUN_GRAPHICS_EDIT: {
1533 FuncRequest fr(action, argument);
1534 InsetGraphics().dispatch(view()->cursor(), fr);
1538 case LFUN_INSET_APPLY: {
1539 BOOST_ASSERT(lyx_view_);
1540 string const name = cmd.getArg(0);
1541 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1543 FuncRequest fr(LFUN_INSET_MODIFY, argument);
1544 inset->dispatch(view()->cursor(), fr);
1546 FuncRequest fr(LFUN_INSET_INSERT, argument);
1549 // ideally, the update flag should be set by the insets,
1550 // but this is not possible currently
1551 updateFlags = Update::Force | Update::FitCursor;
1555 case LFUN_ALL_INSETS_TOGGLE: {
1556 BOOST_ASSERT(lyx_view_);
1558 string const name = split(argument, action, ' ');
1559 InsetBase::Code const inset_code =
1560 InsetBase::translate(name);
1562 LCursor & cur = view()->cursor();
1563 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1565 InsetBase & inset = lyx_view_->buffer()->inset();
1566 InsetIterator it = inset_iterator_begin(inset);
1567 InsetIterator const end = inset_iterator_end(inset);
1568 for (; it != end; ++it) {
1569 if (inset_code == InsetBase::NO_CODE
1570 || inset_code == it->lyxCode()) {
1571 LCursor tmpcur = cur;
1572 tmpcur.pushLeft(*it);
1573 it->dispatch(tmpcur, fr);
1576 updateFlags = Update::Force | Update::FitCursor;
1580 case LFUN_BUFFER_LANGUAGE: {
1581 BOOST_ASSERT(lyx_view_);
1582 Buffer & buffer = *lyx_view_->buffer();
1583 Language const * oldL = buffer.params().language;
1584 Language const * newL = languages.getLanguage(argument);
1585 if (!newL || oldL == newL)
1588 if (oldL->rightToLeft() == newL->rightToLeft()
1589 && !buffer.isMultiLingual())
1590 buffer.changeLanguage(oldL, newL);
1592 buffer.updateDocLang(newL);
1596 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1597 string const fname =
1598 addName(addPath(package().user_support(), "templates/"),
1600 Buffer defaults(fname);
1602 istringstream ss(argument);
1605 int const unknown_tokens = defaults.readHeader(lex);
1607 if (unknown_tokens != 0) {
1608 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1609 << unknown_tokens << " unknown token"
1610 << (unknown_tokens == 1 ? "" : "s")
1614 if (defaults.writeFile(FileName(defaults.fileName())))
1615 setMessage(bformat(_("Document defaults saved in %1$s"),
1616 makeDisplayPath(fname)));
1618 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
1622 case LFUN_BUFFER_PARAMS_APPLY: {
1623 BOOST_ASSERT(lyx_view_);
1624 biblio::CiteEngine const engine =
1625 lyx_view_->buffer()->params().getEngine();
1627 istringstream ss(argument);
1630 int const unknown_tokens =
1631 lyx_view_->buffer()->readHeader(lex);
1633 if (unknown_tokens != 0) {
1634 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1635 << unknown_tokens << " unknown token"
1636 << (unknown_tokens == 1 ? "" : "s")
1639 if (engine == lyx_view_->buffer()->params().getEngine())
1642 LCursor & cur = view()->cursor();
1643 FuncRequest fr(LFUN_INSET_REFRESH);
1645 InsetBase & inset = lyx_view_->buffer()->inset();
1646 InsetIterator it = inset_iterator_begin(inset);
1647 InsetIterator const end = inset_iterator_end(inset);
1648 for (; it != end; ++it)
1649 if (it->lyxCode() == InsetBase::CITE_CODE)
1650 it->dispatch(cur, fr);
1654 case LFUN_TEXTCLASS_APPLY: {
1655 BOOST_ASSERT(lyx_view_);
1656 Buffer * buffer = lyx_view_->buffer();
1658 textclass_type const old_class =
1659 buffer->params().textclass;
1661 loadTextclass(argument);
1663 std::pair<bool, textclass_type> const tc_pair =
1664 textclasslist.numberOfClass(argument);
1669 textclass_type const new_class = tc_pair.second;
1670 if (old_class == new_class)
1674 lyx_view_->message(_("Converting document to new document class..."));
1675 recordUndoFullDocument(view());
1676 buffer->params().textclass = new_class;
1677 StableDocIterator backcur(view()->cursor());
1678 ErrorList & el = buffer->errorList("Class Switch");
1679 cap::switchBetweenClasses(
1680 old_class, new_class,
1681 static_cast<InsetText &>(buffer->inset()), el);
1683 view()->setCursor(backcur.asDocIterator(&(buffer->inset())));
1685 buffer->errors("Class Switch");
1686 updateLabels(*buffer);
1687 updateFlags = Update::Force | Update::FitCursor;
1691 case LFUN_TEXTCLASS_LOAD:
1692 loadTextclass(argument);
1695 case LFUN_LYXRC_APPLY: {
1696 LyXRC const lyxrc_orig = lyxrc;
1698 istringstream ss(argument);
1699 bool const success = lyxrc.read(ss) == 0;
1702 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1703 << "Unable to read lyxrc data"
1708 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1710 /// We force the redraw in any case because there might be
1711 /// some screen font changes.
1712 /// FIXME: only the current view will be updated. the Gui
1713 /// class is able to furnish the list of views.
1714 updateFlags = Update::Force;
1718 case LFUN_WINDOW_NEW:
1719 LyX::ref().newLyXView();
1722 case LFUN_WINDOW_CLOSE:
1723 BOOST_ASSERT(lyx_view_);
1724 BOOST_ASSERT(theApp());
1725 // update bookmark pit of the current buffer before window close
1726 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
1727 gotoBookmark(i+1, false, false);
1728 // ask the user for saving changes or cancel quit
1729 if (!theBufferList().quitWriteAll())
1734 case LFUN_BOOKMARK_GOTO:
1735 // go to bookmark, open unopened file and switch to buffer if necessary
1736 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1739 case LFUN_BOOKMARK_CLEAR:
1740 LyX::ref().session().bookmarks().clear();
1743 case LFUN_TOOLBAR_TOGGLE_STATE:
1744 lyx_view_->toggleToolbarState(argument);
1748 BOOST_ASSERT(lyx_view_);
1749 view()->cursor().dispatch(cmd);
1750 updateFlags = view()->cursor().result().update();
1751 if (!view()->cursor().result().dispatched())
1752 updateFlags = view()->dispatch(cmd);
1757 if (lyx_view_ && view()->buffer()) {
1758 // BufferView::update() updates the ViewMetricsInfo and
1759 // also initializes the position cache for all insets in
1760 // (at least partially) visible top-level paragraphs.
1761 // We will redraw the screen only if needed.
1762 if (view()->update(updateFlags)) {
1763 // Buffer::changed() signals that a repaint is needed.
1764 // The frontend (WorkArea) knows which area to repaint
1765 // thanks to the ViewMetricsInfo updated above.
1766 view()->buffer()->changed();
1769 lyx_view_->updateStatusBar();
1771 // if we executed a mutating lfun, mark the buffer as dirty
1773 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1774 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1775 view()->buffer()->markDirty();
1777 if (view()->cursor().inTexted()) {
1778 lyx_view_->updateLayoutChoice();
1783 lyx_view_->updateMenubar();
1784 lyx_view_->updateToolbars();
1785 // Some messages may already be translated, so we cannot use _()
1786 sendDispatchMessage(translateIfPossible(getMessage()), cmd);
1791 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1793 const bool verbose = (cmd.origin == FuncRequest::MENU
1794 || cmd.origin == FuncRequest::TOOLBAR
1795 || cmd.origin == FuncRequest::COMMANDBUFFER);
1797 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1798 lyxerr[Debug::ACTION] << "dispatch msg is " << to_utf8(msg) << endl;
1800 lyx_view_->message(msg);
1804 docstring dispatch_msg = msg;
1805 if (!dispatch_msg.empty())
1806 dispatch_msg += ' ';
1808 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1810 bool argsadded = false;
1812 if (!cmd.argument().empty()) {
1813 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1814 comname += ' ' + cmd.argument();
1819 docstring const shortcuts = theTopLevelKeymap().printbindings(cmd);
1821 if (!shortcuts.empty())
1822 comname += ": " + shortcuts;
1823 else if (!argsadded && !cmd.argument().empty())
1824 comname += ' ' + cmd.argument();
1826 if (!comname.empty()) {
1827 comname = rtrim(comname);
1828 dispatch_msg += '(' + rtrim(comname) + ')';
1831 lyxerr[Debug::ACTION] << "verbose dispatch msg "
1832 << to_utf8(dispatch_msg) << endl;
1833 if (!dispatch_msg.empty())
1834 lyx_view_->message(dispatch_msg);
1838 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1840 // FIXME: initpath is not used. What to do?
1841 string initpath = lyxrc.document_path;
1842 string filename(name);
1844 if (view()->buffer()) {
1845 string const trypath = lyx_view_->buffer()->filePath();
1846 // If directory is writeable, use this as default.
1847 if (isDirWriteable(FileName(trypath)))
1851 static int newfile_number;
1853 if (filename.empty()) {
1854 filename = addName(lyxrc.document_path,
1855 "newfile" + convert<string>(++newfile_number) + ".lyx");
1856 while (theBufferList().exists(filename) ||
1857 fs::is_readable(FileName(filename).toFilesystemEncoding())) {
1859 filename = addName(lyxrc.document_path,
1860 "newfile" + convert<string>(newfile_number) +
1865 // The template stuff
1868 FileDialog fileDlg(_("Select template file"),
1869 LFUN_SELECT_FILE_SYNC,
1870 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1871 make_pair(_("Templates|#T#t"), from_utf8(lyxrc.template_path)));
1873 FileDialog::Result result =
1874 fileDlg.open(from_utf8(lyxrc.template_path),
1875 FileFilterList(_("LyX Documents (*.lyx)")),
1878 if (result.first == FileDialog::Later)
1880 if (result.second.empty())
1882 templname = to_utf8(result.second);
1885 Buffer * const b = newFile(filename, templname, !name.empty());
1888 lyx_view_->setBuffer(b);
1893 void LyXFunc::open(string const & fname)
1895 string initpath = lyxrc.document_path;
1897 if (view()->buffer()) {
1898 string const trypath = lyx_view_->buffer()->filePath();
1899 // If directory is writeable, use this as default.
1900 if (isDirWriteable(FileName(trypath)))
1906 if (fname.empty()) {
1907 FileDialog fileDlg(_("Select document to open"),
1909 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1910 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1912 FileDialog::Result result =
1913 fileDlg.open(from_utf8(initpath),
1914 FileFilterList(_("LyX Documents (*.lyx)")),
1917 if (result.first == FileDialog::Later)
1920 filename = to_utf8(result.second);
1922 // check selected filename
1923 if (filename.empty()) {
1924 lyx_view_->message(_("Canceled."));
1930 // get absolute path of file and add ".lyx" to the filename if
1932 FileName const fullname = fileSearch(string(), filename, "lyx");
1933 if (!fullname.empty())
1934 filename = fullname.absFilename();
1936 // if the file doesn't exist, let the user create one
1937 if (!fs::exists(fullname.toFilesystemEncoding())) {
1938 // the user specifically chose this name. Believe him.
1939 Buffer * const b = newFile(filename, string(), true);
1941 lyx_view_->setBuffer(b);
1945 docstring const disp_fn = makeDisplayPath(filename);
1946 lyx_view_->message(bformat(_("Opening document %1$s..."), disp_fn));
1949 if (lyx_view_->loadLyXFile(fullname)) {
1950 str2 = bformat(_("Document %1$s opened."), disp_fn);
1952 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1954 lyx_view_->message(str2);
1958 void LyXFunc::doImport(string const & argument)
1961 string filename = split(argument, format, ' ');
1963 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1964 << " file: " << filename << endl;
1966 // need user interaction
1967 if (filename.empty()) {
1968 string initpath = lyxrc.document_path;
1970 if (view()->buffer()) {
1971 string const trypath = lyx_view_->buffer()->filePath();
1972 // If directory is writeable, use this as default.
1973 if (isDirWriteable(FileName(trypath)))
1977 docstring const text = bformat(_("Select %1$s file to import"),
1978 formats.prettyName(format));
1980 FileDialog fileDlg(text,
1982 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1983 make_pair(_("Examples|#E#e"),
1984 from_utf8(addPath(package().system_support(), "examples"))));
1986 docstring filter = formats.prettyName(format);
1989 filter += from_utf8(formats.extension(format));
1992 FileDialog::Result result =
1993 fileDlg.open(from_utf8(initpath),
1994 FileFilterList(filter),
1997 if (result.first == FileDialog::Later)
2000 filename = to_utf8(result.second);
2002 // check selected filename
2003 if (filename.empty())
2004 lyx_view_->message(_("Canceled."));
2007 if (filename.empty())
2010 // get absolute path of file
2011 FileName const fullname(makeAbsPath(filename));
2013 FileName const lyxfile(changeExtension(fullname.absFilename(), ".lyx"));
2015 // Check if the document already is open
2016 if (use_gui && theBufferList().exists(lyxfile.absFilename())) {
2017 if (!theBufferList().close(theBufferList().getBuffer(lyxfile.absFilename()), true)) {
2018 lyx_view_->message(_("Canceled."));
2023 // if the file exists already, and we didn't do
2024 // -i lyx thefile.lyx, warn
2025 if (fs::exists(lyxfile.toFilesystemEncoding()) && fullname != lyxfile) {
2026 docstring const file = makeDisplayPath(lyxfile.absFilename(), 30);
2028 docstring text = bformat(_("The document %1$s already exists.\n\n"
2029 "Do you want to over-write that document?"), file);
2030 int const ret = Alert::prompt(_("Over-write document?"),
2031 text, 0, 1, _("&Over-write"), _("&Cancel"));
2034 lyx_view_->message(_("Canceled."));
2039 ErrorList errorList;
2040 Importer::Import(lyx_view_, fullname, format, errorList);
2041 // FIXME (Abdel 12/08/06): Is there a need to display the error list here?
2045 void LyXFunc::closeBuffer()
2047 // save current cursor position
2048 LyX::ref().session().lastFilePos().save(FileName(lyx_view_->buffer()->fileName()),
2049 boost::tie(view()->cursor().pit(), view()->cursor().pos()) );
2050 // goto bookmark to update bookmark pit.
2051 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
2052 gotoBookmark(i+1, false, false);
2053 if (theBufferList().close(lyx_view_->buffer(), true) && !quitting) {
2054 if (theBufferList().empty()) {
2055 // need this otherwise SEGV may occur while
2056 // trying to set variables that don't exist
2057 // since there's no current buffer
2058 lyx_view_->getDialogs().hideBufferDependent();
2060 lyx_view_->setBuffer(theBufferList().first());
2066 void LyXFunc::reloadBuffer()
2068 FileName filename(lyx_view_->buffer()->fileName());
2070 lyx_view_->loadLyXFile(filename);
2073 // Each "lyx_view_" should have it's own message method. lyxview and
2074 // the minibuffer would use the minibuffer, but lyxserver would
2075 // send an ERROR signal to its client. Alejandro 970603
2076 // This function is bit problematic when it comes to NLS, to make the
2077 // lyx servers client be language indepenent we must not translate
2078 // strings sent to this func.
2079 void LyXFunc::setErrorMessage(docstring const & m) const
2081 dispatch_buffer = m;
2086 void LyXFunc::setMessage(docstring const & m) const
2088 dispatch_buffer = m;
2092 docstring const LyXFunc::viewStatusMessage()
2094 // When meta-fake key is pressed, show the key sequence so far + "M-".
2096 return keyseq->print(true) + "M-";
2098 // Else, when a non-complete key sequence is pressed,
2099 // show the available options.
2100 if (keyseq->length() > 0 && !keyseq->deleted())
2101 return keyseq->printOptions(true);
2103 if (!view()->buffer())
2104 return _("Welcome to LyX!");
2106 return view()->cursor().currentState();
2110 BufferView * LyXFunc::view() const
2112 BOOST_ASSERT(lyx_view_);
2113 return lyx_view_->view();
2117 bool LyXFunc::wasMetaKey() const
2119 return (meta_fake_bit != key_modifier::none);
2125 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
2127 // Why the switch you might ask. It is a trick to ensure that all
2128 // the elements in the LyXRCTags enum is handled. As you can see
2129 // there are no breaks at all. So it is just a huge fall-through.
2130 // The nice thing is that we will get a warning from the compiler
2131 // if we forget an element.
2132 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
2134 case LyXRC::RC_ACCEPT_COMPOUND:
2135 case LyXRC::RC_ALT_LANG:
2136 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
2137 case LyXRC::RC_PLAINTEXT_LINELEN:
2138 case LyXRC::RC_AUTOREGIONDELETE:
2139 case LyXRC::RC_AUTORESET_OPTIONS:
2140 case LyXRC::RC_AUTOSAVE:
2141 case LyXRC::RC_AUTO_NUMBER:
2142 case LyXRC::RC_BACKUPDIR_PATH:
2143 case LyXRC::RC_BIBTEX_COMMAND:
2144 case LyXRC::RC_BINDFILE:
2145 case LyXRC::RC_CHECKLASTFILES:
2146 case LyXRC::RC_USELASTFILEPOS:
2147 case LyXRC::RC_LOADSESSION:
2148 case LyXRC::RC_CHKTEX_COMMAND:
2149 case LyXRC::RC_CONVERTER:
2150 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
2151 case LyXRC::RC_COPIER:
2152 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
2153 case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
2154 case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
2155 case LyXRC::RC_DATE_INSERT_FORMAT:
2156 case LyXRC::RC_DEFAULT_LANGUAGE:
2157 case LyXRC::RC_DEFAULT_PAPERSIZE:
2158 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
2159 case LyXRC::RC_DISPLAY_GRAPHICS:
2160 case LyXRC::RC_DOCUMENTPATH:
2161 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
2162 string const encoded = FileName(
2163 lyxrc_new.document_path).toFilesystemEncoding();
2164 if (fs::exists(encoded) && fs::is_directory(encoded))
2165 support::package().document_dir() = lyxrc.document_path;
2167 case LyXRC::RC_ESC_CHARS:
2168 case LyXRC::RC_FONT_ENCODING:
2169 case LyXRC::RC_FORMAT:
2170 case LyXRC::RC_INDEX_COMMAND:
2171 case LyXRC::RC_INPUT:
2172 case LyXRC::RC_KBMAP:
2173 case LyXRC::RC_KBMAP_PRIMARY:
2174 case LyXRC::RC_KBMAP_SECONDARY:
2175 case LyXRC::RC_LABEL_INIT_LENGTH:
2176 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
2177 case LyXRC::RC_LANGUAGE_AUTO_END:
2178 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
2179 case LyXRC::RC_LANGUAGE_COMMAND_END:
2180 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
2181 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
2182 case LyXRC::RC_LANGUAGE_PACKAGE:
2183 case LyXRC::RC_LANGUAGE_USE_BABEL:
2184 case LyXRC::RC_MAKE_BACKUP:
2185 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
2186 case LyXRC::RC_NUMLASTFILES:
2187 case LyXRC::RC_PATH_PREFIX:
2188 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
2189 support::prependEnvPath("PATH", lyxrc.path_prefix);
2191 case LyXRC::RC_PERS_DICT:
2192 case LyXRC::RC_PREVIEW:
2193 case LyXRC::RC_PREVIEW_HASHED_LABELS:
2194 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
2195 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
2196 case LyXRC::RC_PRINTCOPIESFLAG:
2197 case LyXRC::RC_PRINTER:
2198 case LyXRC::RC_PRINTEVENPAGEFLAG:
2199 case LyXRC::RC_PRINTEXSTRAOPTIONS:
2200 case LyXRC::RC_PRINTFILEEXTENSION:
2201 case LyXRC::RC_PRINTLANDSCAPEFLAG:
2202 case LyXRC::RC_PRINTODDPAGEFLAG:
2203 case LyXRC::RC_PRINTPAGERANGEFLAG:
2204 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
2205 case LyXRC::RC_PRINTPAPERFLAG:
2206 case LyXRC::RC_PRINTREVERSEFLAG:
2207 case LyXRC::RC_PRINTSPOOL_COMMAND:
2208 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
2209 case LyXRC::RC_PRINTTOFILE:
2210 case LyXRC::RC_PRINTTOPRINTER:
2211 case LyXRC::RC_PRINT_ADAPTOUTPUT:
2212 case LyXRC::RC_PRINT_COMMAND:
2213 case LyXRC::RC_RTL_SUPPORT:
2214 case LyXRC::RC_SCREEN_DPI:
2215 case LyXRC::RC_SCREEN_FONT_ENCODING:
2216 case LyXRC::RC_SCREEN_FONT_ROMAN:
2217 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
2218 case LyXRC::RC_SCREEN_FONT_SANS:
2219 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
2220 case LyXRC::RC_SCREEN_FONT_SCALABLE:
2221 case LyXRC::RC_SCREEN_FONT_SIZES:
2222 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
2223 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
2224 case LyXRC::RC_SCREEN_GEOMETRY_HEIGHT:
2225 case LyXRC::RC_SCREEN_GEOMETRY_WIDTH:
2226 case LyXRC::RC_SCREEN_GEOMETRY_XYSAVED:
2227 case LyXRC::RC_SCREEN_ZOOM:
2228 case LyXRC::RC_SERVERPIPE:
2229 case LyXRC::RC_SET_COLOR:
2230 case LyXRC::RC_SHOW_BANNER:
2231 case LyXRC::RC_SPELL_COMMAND:
2232 case LyXRC::RC_TEMPDIRPATH:
2233 case LyXRC::RC_TEMPLATEPATH:
2234 case LyXRC::RC_TEX_ALLOWS_SPACES:
2235 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
2236 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
2237 support::os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
2239 case LyXRC::RC_UIFILE:
2240 case LyXRC::RC_USER_EMAIL:
2241 case LyXRC::RC_USER_NAME:
2242 case LyXRC::RC_USETEMPDIR:
2243 case LyXRC::RC_USE_ALT_LANG:
2244 case LyXRC::RC_USE_CONVERTER_CACHE:
2245 case LyXRC::RC_USE_ESC_CHARS:
2246 case LyXRC::RC_USE_INP_ENC:
2247 case LyXRC::RC_USE_PERS_DICT:
2248 case LyXRC::RC_USE_SPELL_LIB:
2249 case LyXRC::RC_VIEWDVI_PAPEROPTION:
2250 case LyXRC::RC_VIEWER:
2251 case LyXRC::RC_LAST: