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"
25 #include "buffer_funcs.h"
27 #include "BufferList.h"
28 #include "BufferParams.h"
29 #include "BufferView.h"
32 #include "Converter.h"
34 #include "CutAndPaste.h"
35 #include "DispatchResult.h"
37 #include "ErrorList.h"
39 #include "FuncRequest.h"
40 #include "FuncStatus.h"
41 #include "InsetIterator.h"
46 #include "LyXAction.h"
51 #include "Paragraph.h"
52 #include "ParagraphParameters.h"
53 #include "ParIterator.h"
57 #include "TextClassList.h"
59 #include "insets/InsetBox.h"
60 #include "insets/InsetBranch.h"
61 #include "insets/InsetCommand.h"
62 #include "insets/InsetERT.h"
63 #include "insets/InsetExternal.h"
64 #include "insets/InsetFloat.h"
65 #include "insets/InsetListings.h"
66 #include "insets/InsetGraphics.h"
67 #include "insets/InsetInclude.h"
68 #include "insets/InsetNote.h"
69 #include "insets/InsetTabular.h"
70 #include "insets/InsetVSpace.h"
71 #include "insets/InsetWrap.h"
73 #include "frontends/alert.h"
74 #include "frontends/Application.h"
75 #include "frontends/KeySymbol.h"
76 #include "frontends/LyXView.h"
77 #include "frontends/Selection.h"
79 #include "support/debug.h"
80 #include "support/environment.h"
81 #include "support/FileName.h"
82 #include "support/filetools.h"
83 #include "support/gettext.h"
84 #include "support/lstrings.h"
85 #include "support/Path.h"
86 #include "support/Package.h"
87 #include "support/Systemcall.h"
88 #include "support/convert.h"
89 #include "support/os.h"
95 using namespace lyx::support;
99 using frontend::LyXView;
101 namespace Alert = frontend::Alert;
106 // This function runs "configure" and then rereads lyx.defaults to
107 // reconfigure the automatic settings.
108 void reconfigure(LyXView & lv, string const & option)
110 // emit message signal.
111 lv.message(_("Running configure..."));
113 // Run configure in user lyx directory
114 PathChanger p(package().user_support());
115 string configure_command = package().configure_command();
116 configure_command += option;
118 int ret = one.startscript(Systemcall::Wait, configure_command);
120 // emit message signal.
121 lv.message(_("Reloading configuration..."));
122 lyxrc.read(libFileSearch(string(), "lyxrc.defaults"));
123 // Re-read packages.lst
124 LaTeXFeatures::getAvailable();
127 Alert::information(_("System reconfiguration failed"),
128 _("The system reconfiguration has failed.\n"
129 "Default textclass is used but LyX may "
130 "not be able to work properly.\n"
131 "Please reconfigure again if needed."));
134 Alert::information(_("System reconfigured"),
135 _("The system has been reconfigured.\n"
136 "You need to restart LyX to make use of any\n"
137 "updated document class specifications."));
141 bool getLocalStatus(Cursor cursor, FuncRequest const & cmd, FuncStatus & status)
143 // Try to fix cursor in case it is broken.
144 cursor.fixIfBroken();
146 // This is, of course, a mess. Better create a new doc iterator and use
147 // this in Inset::getStatus. This might require an additional
148 // BufferView * arg, though (which should be avoided)
149 //Cursor safe = *this;
151 for ( ; cursor.depth(); cursor.pop()) {
152 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
153 BOOST_ASSERT(cursor.idx() <= cursor.lastidx());
154 BOOST_ASSERT(cursor.pit() <= cursor.lastpit());
155 BOOST_ASSERT(cursor.pos() <= cursor.lastpos());
157 // The inset's getStatus() will return 'true' if it made
158 // a definitive decision on whether it want to handle the
159 // request or not. The result of this decision is put into
160 // the 'status' parameter.
161 if (cursor.inset().getStatus(cursor, cmd, status)) {
170 /** Return the change status at cursor position, taking in account the
171 * status at each level of the document iterator (a table in a deleted
172 * footnote is deleted).
173 * When \param outer is true, the top slice is not looked at.
175 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
177 size_t const depth = dit.depth() - (outer ? 1 : 0);
179 for (size_t i = 0 ; i < depth ; ++i) {
180 CursorSlice const & slice = dit[i];
181 if (!slice.inset().inMathed()
182 && slice.pos() < slice.paragraph().size()) {
183 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
184 if (ch != Change::UNCHANGED)
188 return Change::UNCHANGED;
195 : lyx_view_(0), encoded_last_key(0), meta_fake_bit(NoModifier)
200 void LyXFunc::initKeySequences(KeyMap * kb)
202 keyseq = KeySequence(kb, kb);
203 cancel_meta_seq = KeySequence(kb, kb);
207 void LyXFunc::setLyXView(LyXView * lv)
209 if (!quitting && lyx_view_ && lyx_view_->view() && lyx_view_ != lv)
210 // save current selection to the selection buffer to allow
211 // middle-button paste in another window
212 cap::saveSelection(lyx_view_->view()->cursor());
217 void LyXFunc::handleKeyFunc(kb_action action)
219 char_type c = encoded_last_key;
224 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
225 lyx_view_->view()->getIntl().getTransManager().deadkey(
226 c, get_accent(action).accent, view()->cursor().innerText(), view()->cursor());
227 // Need to clear, in case the minibuffer calls these
230 // copied verbatim from do_accent_char
231 view()->cursor().resetAnchor();
232 view()->processUpdateFlags(Update::FitCursor);
236 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
238 BOOST_ASSERT(lyx_view_);
239 if (!LyX::ref().session().bookmarks().isValid(idx))
241 BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(idx);
242 BOOST_ASSERT(!bm.filename.empty());
243 string const file = bm.filename.absFilename();
244 // if the file is not opened, open it.
245 if (!theBufferList().exists(file)) {
247 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
251 // open may fail, so we need to test it again
252 if (!theBufferList().exists(file))
255 // if the current buffer is not that one, switch to it.
256 if (lyx_view_->buffer()->absFileName() != file) {
259 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
261 // moveToPosition try paragraph id first and then paragraph (pit, pos).
262 if (!view()->moveToPosition(bm.bottom_pit, bm.bottom_pos,
263 bm.top_id, bm.top_pos))
266 // Cursor jump succeeded!
267 Cursor const & cur = view()->cursor();
268 pit_type new_pit = cur.pit();
269 pos_type new_pos = cur.pos();
270 int new_id = cur.paragraph().id();
272 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
273 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
274 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
275 || bm.top_id != new_id) {
276 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
277 new_pit, new_pos, new_id);
282 void LyXFunc::processKeySym(KeySymbol const & keysym, KeyModifier state)
284 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
286 // Do nothing if we have nothing (JMarc)
287 if (!keysym.isOK()) {
288 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
289 lyx_view_->restartCursor();
293 if (keysym.isModifier()) {
294 LYXERR(Debug::KEY, "isModifier true");
295 lyx_view_->restartCursor();
299 //Encoding const * encoding = view()->cursor().getEncoding();
300 //encoded_last_key = keysym.getISOEncoded(encoding ? encoding->name() : "");
301 // FIXME: encoded_last_key shadows the member variable of the same
302 // name. Is that intended?
303 char_type encoded_last_key = keysym.getUCSEncoded();
305 // Do a one-deep top-level lookup for
306 // cancel and meta-fake keys. RVDK_PATCH_5
307 cancel_meta_seq.reset();
309 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
310 LYXERR(Debug::KEY, "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 = NoModifier. 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, "action now set to [" << func.action << ']');
321 // Dont remove this unless you know what you are doing.
322 meta_fake_bit = NoModifier;
324 // Can this happen now ?
325 if (func.action == LFUN_NOACTION)
326 func = FuncRequest(LFUN_COMMAND_PREFIX);
328 LYXERR(Debug::KEY, " Key [action=" << func.action << "]["
329 << keyseq.print(KeySequence::Portable) << ']');
331 // already here we know if it any point in going further
332 // why not return already here if action == -1 and
333 // num_bytes == 0? (Lgb)
335 if (keyseq.length() > 1)
336 lyx_view_->message(keyseq.print(KeySequence::ForGui));
339 // Maybe user can only reach the key via holding down shift.
340 // Let's see. But only if shift is the only modifier
341 if (func.action == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
342 LYXERR(Debug::KEY, "Trying without shift");
343 func = keyseq.addkey(keysym, NoModifier);
344 LYXERR(Debug::KEY, "Action now " << func.action);
347 if (func.action == LFUN_UNKNOWN_ACTION) {
348 // Hmm, we didn't match any of the keysequences. See
349 // if it's normal insertable text not already covered
351 if (keysym.isText() && keyseq.length() == 1) {
352 LYXERR(Debug::KEY, "isText() is true, inserting.");
353 func = FuncRequest(LFUN_SELF_INSERT,
354 FuncRequest::KEYBOARD);
356 LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
357 lyx_view_->message(_("Unknown function."));
358 lyx_view_->restartCursor();
363 if (func.action == LFUN_SELF_INSERT) {
364 if (encoded_last_key != 0) {
365 docstring const arg(1, encoded_last_key);
366 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
367 FuncRequest::KEYBOARD));
368 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
369 lyx_view_->updateCompletion(true, true);
373 if (func.action == LFUN_CHAR_DELETE_BACKWARD)
374 // backspace is not a self-insertion. But it
375 // still should not hide the completion popup.
376 // FIXME: more clever way to detect those movements
377 lyx_view_->updateCompletion(false, true);
379 lyx_view_->updateCompletion(false, false);
382 lyx_view_->restartCursor();
386 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
388 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
391 Buffer * buf = lyx_view_? lyx_view_->buffer() : 0;
393 if (cmd.action == LFUN_NOACTION) {
394 flag.message(from_utf8(N_("Nothing to do")));
399 switch (cmd.action) {
400 case LFUN_UNKNOWN_ACTION:
401 #ifndef HAVE_LIBAIKSAURUS
402 case LFUN_THESAURUS_ENTRY:
412 if (flag.unknown()) {
413 flag.message(from_utf8(N_("Unknown action")));
417 if (!flag.enabled()) {
418 if (flag.message().empty())
419 flag.message(from_utf8(N_("Command disabled")));
423 // Check whether we need a buffer
424 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
426 flag.message(from_utf8(N_("Command not allowed with"
427 "out any document open")));
432 // I would really like to avoid having this switch and rather try to
433 // encode this in the function itself.
434 // -- And I'd rather let an inset decide which LFUNs it is willing
435 // to handle (Andre')
437 switch (cmd.action) {
439 // FIXME: these cases should be hidden in GuiApplication::getStatus().
440 case LFUN_WINDOW_CLOSE:
442 return theApp()->getStatus(cmd);
446 // FIXME: these cases should be hidden in GuiView::getStatus().
447 case LFUN_DIALOG_TOGGLE:
448 case LFUN_DIALOG_SHOW:
449 case LFUN_DIALOG_UPDATE:
450 if (cmd.argument() == "prefs"
451 || cmd.argument() == "aboutlyx")
454 return lyx_view_->getStatus(cmd);
459 case LFUN_TOOLBAR_TOGGLE:
460 case LFUN_INSET_APPLY:
461 case LFUN_BUFFER_WRITE:
462 case LFUN_BUFFER_WRITE_AS:
463 case LFUN_SPLIT_VIEW:
464 case LFUN_CLOSE_TAB_GROUP:
465 case LFUN_COMPLETION_POPUP:
466 case LFUN_COMPLETION_INLINE:
467 case LFUN_COMPLETION_COMPLETE:
469 return lyx_view_->getStatus(cmd);
473 case LFUN_BUFFER_TOGGLE_READ_ONLY:
474 flag.setOnOff(buf->isReadonly());
477 case LFUN_BUFFER_SWITCH:
478 // toggle on the current buffer, but do not toggle off
479 // the other ones (is that a good idea?)
480 if (buf && to_utf8(cmd.argument()) == buf->absFileName())
484 case LFUN_BUFFER_EXPORT:
485 enable = cmd.argument() == "custom"
486 || buf->isExportable(to_utf8(cmd.argument()));
489 case LFUN_BUFFER_CHKTEX:
490 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
493 case LFUN_BUILD_PROGRAM:
494 enable = buf->isExportable("program");
497 case LFUN_VC_REGISTER:
498 enable = !buf->lyxvc().inUse();
500 case LFUN_VC_CHECK_IN:
501 enable = buf->lyxvc().inUse() && !buf->isReadonly();
503 case LFUN_VC_CHECK_OUT:
504 enable = buf->lyxvc().inUse() && buf->isReadonly();
507 case LFUN_VC_UNDO_LAST:
508 enable = buf->lyxvc().inUse();
510 case LFUN_BUFFER_RELOAD:
511 enable = !buf->isUnnamed() && buf->fileName().exists()
512 && (!buf->isClean() || buf->isExternallyModified(Buffer::timestamp_method));
515 case LFUN_CITATION_INSERT: {
516 FuncRequest fr(LFUN_INSET_INSERT, "citation");
517 enable = getStatus(fr).enabled();
521 // This could be used for the no-GUI version. The GUI version is handled in
522 // LyXView::getStatus(). See above.
524 case LFUN_BUFFER_WRITE:
525 case LFUN_BUFFER_WRITE_AS: {
526 Buffer * b = theBufferList().getBuffer(cmd.getArg(0));
527 enable = b && (b->isUnnamed() || !b->isClean());
532 case LFUN_BUFFER_WRITE_ALL: {
533 // We enable the command only if there are some modified buffers
534 Buffer * first = theBufferList().first();
539 // We cannot use a for loop as the buffer list is a cycle.
545 b = theBufferList().next(b);
546 } while (b != first);
550 case LFUN_BOOKMARK_GOTO: {
551 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
552 enable = LyX::ref().session().bookmarks().isValid(num);
556 case LFUN_BOOKMARK_CLEAR:
557 enable = LyX::ref().session().bookmarks().size() > 0;
560 // this one is difficult to get right. As a half-baked
561 // solution, we consider only the first action of the sequence
562 case LFUN_COMMAND_SEQUENCE: {
563 // argument contains ';'-terminated commands
564 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
565 FuncRequest func(lyxaction.lookupFunc(firstcmd));
566 func.origin = cmd.origin;
567 flag = getStatus(func);
573 string name = to_utf8(cmd.argument());
574 if (LyX::ref().topLevelCmdDef().lock(name, func)) {
575 func.origin = cmd.origin;
576 flag = getStatus(func);
577 LyX::ref().topLevelCmdDef().release(name);
579 // catch recursion or unknown command definiton
580 // all operations until the recursion or unknown command
581 // definiton occures are performed, so set the state to enabled
587 case LFUN_BUFFER_NEW:
588 case LFUN_BUFFER_NEW_TEMPLATE:
589 case LFUN_WORD_FIND_FORWARD:
590 case LFUN_WORD_FIND_BACKWARD:
591 case LFUN_COMMAND_PREFIX:
592 case LFUN_COMMAND_EXECUTE:
594 case LFUN_META_PREFIX:
595 case LFUN_BUFFER_CLOSE:
596 case LFUN_BUFFER_UPDATE:
597 case LFUN_BUFFER_VIEW:
598 case LFUN_MASTER_BUFFER_UPDATE:
599 case LFUN_MASTER_BUFFER_VIEW:
600 case LFUN_BUFFER_IMPORT:
601 case LFUN_BUFFER_AUTO_SAVE:
602 case LFUN_RECONFIGURE:
605 case LFUN_DROP_LAYOUTS_CHOICE:
607 case LFUN_SERVER_GET_NAME:
608 case LFUN_SERVER_NOTIFY:
609 case LFUN_SERVER_GOTO_FILE_ROW:
610 case LFUN_DIALOG_HIDE:
611 case LFUN_DIALOG_DISCONNECT_INSET:
612 case LFUN_BUFFER_CHILD_OPEN:
614 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
615 case LFUN_KEYMAP_OFF:
616 case LFUN_KEYMAP_PRIMARY:
617 case LFUN_KEYMAP_SECONDARY:
618 case LFUN_KEYMAP_TOGGLE:
620 case LFUN_BUFFER_EXPORT_CUSTOM:
621 case LFUN_BUFFER_PRINT:
622 case LFUN_PREFERENCES_SAVE:
623 case LFUN_SCREEN_FONT_UPDATE:
626 case LFUN_EXTERNAL_EDIT:
627 case LFUN_GRAPHICS_EDIT:
628 case LFUN_ALL_INSETS_TOGGLE:
629 case LFUN_BUFFER_LANGUAGE:
630 case LFUN_TEXTCLASS_APPLY:
631 case LFUN_TEXTCLASS_LOAD:
632 case LFUN_BUFFER_SAVE_AS_DEFAULT:
633 case LFUN_BUFFER_PARAMS_APPLY:
634 case LFUN_LAYOUT_MODULES_CLEAR:
635 case LFUN_LAYOUT_MODULE_ADD:
636 case LFUN_LAYOUT_RELOAD:
637 case LFUN_LYXRC_APPLY:
638 case LFUN_BUFFER_NEXT:
639 case LFUN_BUFFER_PREVIOUS:
640 case LFUN_WINDOW_NEW:
642 // these are handled in our dispatch()
650 if (!getLocalStatus(view()->cursor(), cmd, flag))
651 flag = view()->getStatus(cmd);
657 // Can we use a readonly buffer?
658 if (buf && buf->isReadonly()
659 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
660 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
661 flag.message(from_utf8(N_("Document is read-only")));
665 // Are we in a DELETED change-tracking region?
667 && lookupChangeType(view()->cursor(), true) == Change::DELETED
668 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
669 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
670 flag.message(from_utf8(N_("This portion of the document is deleted.")));
674 // the default error message if we disable the command
675 if (!flag.enabled() && flag.message().empty())
676 flag.message(from_utf8(N_("Command disabled")));
682 bool LyXFunc::ensureBufferClean(BufferView * bv)
684 Buffer & buf = bv->buffer();
688 docstring const file = buf.fileName().displayName(30);
689 docstring text = bformat(_("The document %1$s has unsaved "
690 "changes.\n\nDo you want to save "
691 "the document?"), file);
692 int const ret = Alert::prompt(_("Save changed document?"),
693 text, 0, 1, _("&Save"),
697 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
699 return buf.isClean();
705 void showPrintError(string const & name)
707 docstring str = bformat(_("Could not print the document %1$s.\n"
708 "Check that your printer is set up correctly."),
709 makeDisplayPath(name, 50));
710 Alert::error(_("Print document failed"), str);
714 void loadTextClass(string const & name)
716 pair<bool, TextClassIndex> const tc_pair =
717 textclasslist.numberOfClass(name);
719 if (!tc_pair.first) {
720 lyxerr << "Document class \"" << name
721 << "\" does not exist."
726 TextClassIndex const tc = tc_pair.second;
728 if (!textclasslist[tc].load()) {
729 docstring s = bformat(_("The document class %1$s."
730 "could not be loaded."),
731 from_utf8(textclasslist[tc].name()));
732 Alert::error(_("Could not load class"), s);
737 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
742 void LyXFunc::dispatch(FuncRequest const & cmd)
744 string const argument = to_utf8(cmd.argument());
745 kb_action const action = cmd.action;
747 LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
748 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
750 // we have not done anything wrong yet.
752 dispatch_buffer.erase();
754 // redraw the screen at the end (first of the two drawing steps).
755 //This is done unless explicitely requested otherwise
756 Update::flags updateFlags = Update::FitCursor;
758 FuncStatus const flag = getStatus(cmd);
759 if (!flag.enabled()) {
760 // We cannot use this function here
761 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
762 << lyxaction.getActionName(action)
763 << " [" << action << "] is disabled at this location");
764 setErrorMessage(flag.message());
768 case LFUN_WORD_FIND_FORWARD:
769 case LFUN_WORD_FIND_BACKWARD: {
770 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
771 static docstring last_search;
772 docstring searched_string;
774 if (!cmd.argument().empty()) {
775 last_search = cmd.argument();
776 searched_string = cmd.argument();
778 searched_string = last_search;
781 if (searched_string.empty())
784 bool const fw = action == LFUN_WORD_FIND_FORWARD;
785 docstring const data =
786 find2string(searched_string, true, false, fw);
787 find(view(), FuncRequest(LFUN_WORD_FIND, data));
791 case LFUN_COMMAND_PREFIX:
792 BOOST_ASSERT(lyx_view_);
793 lyx_view_->message(keyseq.printOptions(true));
797 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
799 meta_fake_bit = NoModifier;
800 if (lyx_view_->buffer())
801 // cancel any selection
802 dispatch(FuncRequest(LFUN_MARK_OFF));
803 setMessage(from_ascii(N_("Cancel")));
806 case LFUN_META_PREFIX:
807 meta_fake_bit = AltModifier;
808 setMessage(keyseq.print(KeySequence::ForGui));
811 case LFUN_BUFFER_TOGGLE_READ_ONLY: {
812 BOOST_ASSERT(lyx_view_ && lyx_view_->view() && lyx_view_->buffer());
813 Buffer * buf = lyx_view_->buffer();
814 if (buf->lyxvc().inUse())
815 buf->lyxvc().toggleReadOnly();
817 buf->setReadonly(!lyx_view_->buffer()->isReadonly());
821 // --- Menus -----------------------------------------------
822 case LFUN_BUFFER_NEW:
823 lyx_view_->newDocument(argument, false);
824 updateFlags = Update::None;
827 case LFUN_BUFFER_NEW_TEMPLATE:
828 lyx_view_->newDocument(argument, true);
829 updateFlags = Update::None;
832 case LFUN_BUFFER_CLOSE:
834 updateFlags = Update::None;
837 case LFUN_BUFFER_RELOAD: {
838 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
839 docstring const file = makeDisplayPath(lyx_view_->buffer()->absFileName(), 20);
840 docstring text = bformat(_("Any changes will be lost. Are you sure "
841 "you want to revert to the saved version of the document %1$s?"), file);
842 int const ret = Alert::prompt(_("Revert to saved document?"),
843 text, 1, 1, _("&Revert"), _("&Cancel"));
850 case LFUN_BUFFER_UPDATE:
851 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
852 lyx_view_->buffer()->doExport(argument, true);
855 case LFUN_BUFFER_VIEW:
856 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
857 lyx_view_->buffer()->preview(argument);
860 case LFUN_MASTER_BUFFER_UPDATE:
861 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer() && lyx_view_->buffer()->masterBuffer());
862 lyx_view_->buffer()->masterBuffer()->doExport(argument, true);
865 case LFUN_MASTER_BUFFER_VIEW:
866 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer() && lyx_view_->buffer()->masterBuffer());
867 lyx_view_->buffer()->masterBuffer()->preview(argument);
870 case LFUN_BUILD_PROGRAM:
871 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
872 lyx_view_->buffer()->doExport("program", true);
875 case LFUN_BUFFER_CHKTEX:
876 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
877 lyx_view_->buffer()->runChktex();
880 case LFUN_BUFFER_EXPORT:
881 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
882 if (argument == "custom")
883 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"));
885 lyx_view_->buffer()->doExport(argument, false);
888 case LFUN_BUFFER_EXPORT_CUSTOM: {
889 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
891 string command = split(argument, format_name, ' ');
892 Format const * format = formats.getFormat(format_name);
894 lyxerr << "Format \"" << format_name
895 << "\" not recognized!"
900 Buffer * buffer = lyx_view_->buffer();
902 // The name of the file created by the conversion process
905 // Output to filename
906 if (format->name() == "lyx") {
907 string const latexname = buffer->latexName(false);
908 filename = changeExtension(latexname,
909 format->extension());
910 filename = addName(buffer->temppath(), filename);
912 if (!buffer->writeFile(FileName(filename)))
916 buffer->doExport(format_name, true, filename);
919 // Substitute $$FName for filename
920 if (!contains(command, "$$FName"))
921 command = "( " + command + " ) < $$FName";
922 command = subst(command, "$$FName", filename);
924 // Execute the command in the background
926 call.startscript(Systemcall::DontWait, command);
930 case LFUN_BUFFER_PRINT: {
931 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
932 // FIXME: cmd.getArg() might fail if one of the arguments
933 // contains double quotes
934 string target = cmd.getArg(0);
935 string target_name = cmd.getArg(1);
936 string command = cmd.getArg(2);
939 || target_name.empty()
940 || command.empty()) {
941 lyxerr << "Unable to parse \""
942 << argument << '"' << endl;
945 if (target != "printer" && target != "file") {
946 lyxerr << "Unrecognized target \""
947 << target << '"' << endl;
951 Buffer * buffer = lyx_view_->buffer();
953 if (!buffer->doExport("dvi", true)) {
954 showPrintError(buffer->absFileName());
958 // Push directory path.
959 string const path = buffer->temppath();
960 // Prevent the compiler from optimizing away p
964 // there are three cases here:
965 // 1. we print to a file
966 // 2. we print directly to a printer
967 // 3. we print using a spool command (print to file first)
970 string const dviname =
971 changeExtension(buffer->latexName(true), "dvi");
973 if (target == "printer") {
974 if (!lyxrc.print_spool_command.empty()) {
975 // case 3: print using a spool
976 string const psname =
977 changeExtension(dviname,".ps");
978 command += ' ' + lyxrc.print_to_file
981 + quoteName(dviname);
984 lyxrc.print_spool_command + ' ';
985 if (target_name != "default") {
986 command2 += lyxrc.print_spool_printerprefix
990 command2 += quoteName(psname);
992 // If successful, then spool command
993 res = one.startscript(
998 res = one.startscript(
999 Systemcall::DontWait,
1002 // case 2: print directly to a printer
1003 if (target_name != "default")
1004 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
1005 res = one.startscript(
1006 Systemcall::DontWait,
1007 command + quoteName(dviname));
1011 // case 1: print to a file
1012 FileName const filename(makeAbsPath(target_name,
1013 lyx_view_->buffer()->filePath()));
1014 FileName const dvifile(makeAbsPath(dviname, path));
1015 if (filename.exists()) {
1016 docstring text = bformat(
1017 _("The file %1$s already exists.\n\n"
1018 "Do you want to overwrite that file?"),
1019 makeDisplayPath(filename.absFilename()));
1020 if (Alert::prompt(_("Overwrite file?"),
1021 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
1024 command += ' ' + lyxrc.print_to_file
1025 + quoteName(filename.toFilesystemEncoding())
1027 + quoteName(dvifile.toFilesystemEncoding());
1028 res = one.startscript(Systemcall::DontWait,
1033 showPrintError(buffer->absFileName());
1037 // FIXME: There is need for a command-line import.
1039 case LFUN_BUFFER_IMPORT:
1044 case LFUN_BUFFER_AUTO_SAVE:
1045 lyx_view_->buffer()->autoSave();
1048 case LFUN_RECONFIGURE:
1049 BOOST_ASSERT(lyx_view_);
1050 // argument is any additional parameter to the configure.py command
1051 reconfigure(*lyx_view_, argument);
1054 case LFUN_HELP_OPEN: {
1055 BOOST_ASSERT(lyx_view_);
1056 string const arg = argument;
1058 setErrorMessage(from_ascii(N_("Missing argument")));
1061 FileName const fname = i18nLibFileSearch("doc", arg, "lyx");
1062 if (fname.empty()) {
1063 lyxerr << "LyX: unable to find documentation file `"
1064 << arg << "'. Bad installation?" << endl;
1067 lyx_view_->message(bformat(_("Opening help file %1$s..."),
1068 makeDisplayPath(fname.absFilename())));
1069 Buffer * buf = lyx_view_->loadDocument(fname, false);
1072 lyx_view_->setBuffer(buf);
1073 buf->errors("Parse");
1075 updateFlags = Update::None;
1079 // --- version control -------------------------------
1080 case LFUN_VC_REGISTER:
1081 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1082 if (!ensureBufferClean(view()))
1084 if (!lyx_view_->buffer()->lyxvc().inUse()) {
1085 lyx_view_->buffer()->lyxvc().registrer();
1088 updateFlags = Update::Force;
1091 case LFUN_VC_CHECK_IN:
1092 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1093 if (!ensureBufferClean(view()))
1095 if (lyx_view_->buffer()->lyxvc().inUse()
1096 && !lyx_view_->buffer()->isReadonly()) {
1097 lyx_view_->buffer()->lyxvc().checkIn();
1102 case LFUN_VC_CHECK_OUT:
1103 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1104 if (!ensureBufferClean(view()))
1106 if (lyx_view_->buffer()->lyxvc().inUse()
1107 && lyx_view_->buffer()->isReadonly()) {
1108 lyx_view_->buffer()->lyxvc().checkOut();
1113 case LFUN_VC_REVERT:
1114 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1115 lyx_view_->buffer()->lyxvc().revert();
1119 case LFUN_VC_UNDO_LAST:
1120 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1121 lyx_view_->buffer()->lyxvc().undoLast();
1125 // --- lyxserver commands ----------------------------
1126 case LFUN_SERVER_GET_NAME:
1127 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1128 setMessage(from_utf8(lyx_view_->buffer()->absFileName()));
1129 LYXERR(Debug::INFO, "FNAME["
1130 << lyx_view_->buffer()->absFileName() << ']');
1133 case LFUN_SERVER_NOTIFY:
1134 dispatch_buffer = keyseq.print(KeySequence::Portable);
1135 theServer().notifyClient(to_utf8(dispatch_buffer));
1138 case LFUN_SERVER_GOTO_FILE_ROW: {
1139 BOOST_ASSERT(lyx_view_);
1142 istringstream is(argument);
1143 is >> file_name >> row;
1145 bool loaded = false;
1146 if (prefixIs(file_name, package().temp_dir().absFilename()))
1147 // Needed by inverse dvi search. If it is a file
1148 // in tmpdir, call the apropriated function
1149 buf = theBufferList().getBufferFromTmp(file_name);
1151 // Must replace extension of the file to be .lyx
1152 // and get full path
1153 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1154 // Either change buffer or load the file
1155 if (theBufferList().exists(s.absFilename()))
1156 buf = theBufferList().getBuffer(s.absFilename());
1158 buf = lyx_view_->loadDocument(s);
1164 updateFlags = Update::None;
1169 lyx_view_->setBuffer(buf);
1170 view()->setCursorFromRow(row);
1172 buf->errors("Parse");
1173 updateFlags = Update::FitCursor;
1178 case LFUN_DIALOG_SHOW_NEW_INSET: {
1179 BOOST_ASSERT(lyx_view_);
1180 string const name = cmd.getArg(0);
1181 InsetCode code = insetCode(name);
1182 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1183 bool insetCodeOK = true;
1192 case HYPERLINK_CODE: {
1193 InsetCommandParams p(code);
1194 data = InsetCommandMailer::params2string(name, p);
1197 case INCLUDE_CODE: {
1198 // data is the include type: one of "include",
1199 // "input", "verbatiminput" or "verbatiminput*"
1201 // default type is requested
1203 InsetCommandParams p(INCLUDE_CODE, data);
1204 data = InsetCommandMailer::params2string("include", p);
1208 // \c data == "Boxed" || "Frameless" etc
1209 InsetBoxParams p(data);
1210 data = InsetBoxMailer::params2string(p);
1214 InsetBranchParams p;
1215 data = InsetBranchMailer::params2string(p);
1219 InsetCommandParams p(CITE_CODE);
1220 data = InsetCommandMailer::params2string(name, p);
1224 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1227 case EXTERNAL_CODE: {
1228 InsetExternalParams p;
1229 Buffer const & buffer = *lyx_view_->buffer();
1230 data = InsetExternalMailer::params2string(p, buffer);
1235 data = InsetFloatMailer::params2string(p);
1238 case LISTINGS_CODE: {
1239 InsetListingsParams p;
1240 data = InsetListingsMailer::params2string(p);
1243 case GRAPHICS_CODE: {
1244 InsetGraphicsParams p;
1245 Buffer const & buffer = *lyx_view_->buffer();
1246 data = InsetGraphicsMailer::params2string(p, buffer);
1251 data = InsetNoteMailer::params2string(p);
1256 data = InsetVSpaceMailer::params2string(space);
1261 data = InsetWrapMailer::params2string(p);
1265 lyxerr << "Inset type '" << name <<
1266 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1267 insetCodeOK = false;
1269 } // end switch(code)
1271 dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1275 case LFUN_CITATION_INSERT: {
1276 BOOST_ASSERT(lyx_view_);
1277 if (!argument.empty()) {
1278 // we can have one optional argument, delimited by '|'
1279 // citation-insert <key>|<text_before>
1280 // this should be enhanced to also support text_after
1281 // and citation style
1282 string arg = argument;
1284 if (contains(argument, "|")) {
1285 arg = token(argument, '|', 0);
1286 opt1 = token(argument, '|', 1);
1288 InsetCommandParams icp(CITE_CODE);
1289 icp["key"] = from_utf8(arg);
1291 icp["before"] = from_utf8(opt1);
1292 string icstr = InsetCommandMailer::params2string("citation", icp);
1293 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1296 dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1300 case LFUN_BUFFER_CHILD_OPEN: {
1301 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1302 Buffer * parent = lyx_view_->buffer();
1303 FileName filename = makeAbsPath(argument, parent->filePath());
1304 view()->saveBookmark(false);
1306 bool parsed = false;
1307 if (theBufferList().exists(filename.absFilename())) {
1308 child = theBufferList().getBuffer(filename.absFilename());
1310 setMessage(bformat(_("Opening child document %1$s..."),
1311 makeDisplayPath(filename.absFilename())));
1312 child = lyx_view_->loadDocument(filename, false);
1316 // Set the parent name of the child document.
1317 // This makes insertion of citations and references in the child work,
1318 // when the target is in the parent or another child document.
1319 child->setParent(parent);
1320 updateLabels(*child->masterBuffer());
1321 lyx_view_->setBuffer(child);
1323 child->errors("Parse");
1326 // If a screen update is required (in case where auto_open is false),
1327 // setBuffer() would have taken care of it already. Otherwise we shall
1328 // reset the update flag because it can cause a circular problem.
1330 updateFlags = Update::None;
1334 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
1335 BOOST_ASSERT(lyx_view_);
1336 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1339 case LFUN_KEYMAP_OFF:
1340 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1341 lyx_view_->view()->getIntl().keyMapOn(false);
1344 case LFUN_KEYMAP_PRIMARY:
1345 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1346 lyx_view_->view()->getIntl().keyMapPrim();
1349 case LFUN_KEYMAP_SECONDARY:
1350 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1351 lyx_view_->view()->getIntl().keyMapSec();
1354 case LFUN_KEYMAP_TOGGLE:
1355 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1356 lyx_view_->view()->getIntl().toggleKeyMap();
1362 string rest = split(argument, countstr, ' ');
1363 istringstream is(countstr);
1366 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1367 for (int i = 0; i < count; ++i)
1368 dispatch(lyxaction.lookupFunc(rest));
1372 case LFUN_COMMAND_SEQUENCE: {
1373 // argument contains ';'-terminated commands
1374 string arg = argument;
1375 while (!arg.empty()) {
1377 arg = split(arg, first, ';');
1378 FuncRequest func(lyxaction.lookupFunc(first));
1379 func.origin = cmd.origin;
1387 if (LyX::ref().topLevelCmdDef().lock(argument, func)) {
1388 func.origin = cmd.origin;
1390 LyX::ref().topLevelCmdDef().release(argument);
1392 if (func.action == LFUN_UNKNOWN_ACTION) {
1393 // unknown command definition
1394 lyxerr << "Warning: unknown command definition `"
1398 // recursion detected
1399 lyxerr << "Warning: Recursion in the command definition `"
1400 << argument << "' detected"
1407 case LFUN_PREFERENCES_SAVE: {
1408 lyxrc.write(makeAbsPath("preferences",
1409 package().user_support().absFilename()),
1414 case LFUN_SET_COLOR: {
1416 string const x11_name = split(argument, lyx_name, ' ');
1417 if (lyx_name.empty() || x11_name.empty()) {
1418 setErrorMessage(from_ascii(N_(
1419 "Syntax: set-color <lyx_name>"
1424 bool const graphicsbg_changed =
1425 (lyx_name == lcolor.getLyXName(Color_graphicsbg) &&
1426 x11_name != lcolor.getX11Name(Color_graphicsbg));
1428 if (!lcolor.setColor(lyx_name, x11_name)) {
1430 bformat(_("Set-color \"%1$s\" failed "
1431 "- color is undefined or "
1432 "may not be redefined"),
1433 from_utf8(lyx_name)));
1437 theApp()->updateColor(lcolor.getFromLyXName(lyx_name));
1439 if (graphicsbg_changed) {
1440 // FIXME: The graphics cache no longer has a changeDisplay method.
1442 graphics::GCache::get().changeDisplay(true);
1449 BOOST_ASSERT(lyx_view_);
1450 lyx_view_->message(from_utf8(argument));
1453 case LFUN_EXTERNAL_EDIT: {
1454 BOOST_ASSERT(lyx_view_);
1455 FuncRequest fr(action, argument);
1456 InsetExternal().dispatch(view()->cursor(), fr);
1460 case LFUN_GRAPHICS_EDIT: {
1461 FuncRequest fr(action, argument);
1462 InsetGraphics().dispatch(view()->cursor(), fr);
1466 case LFUN_ALL_INSETS_TOGGLE: {
1467 BOOST_ASSERT(lyx_view_);
1469 string const name = split(argument, action, ' ');
1470 InsetCode const inset_code = insetCode(name);
1472 Cursor & cur = view()->cursor();
1473 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1475 Inset & inset = lyx_view_->buffer()->inset();
1476 InsetIterator it = inset_iterator_begin(inset);
1477 InsetIterator const end = inset_iterator_end(inset);
1478 for (; it != end; ++it) {
1479 if (!it->asInsetMath()
1480 && (inset_code == NO_CODE
1481 || inset_code == it->lyxCode())) {
1482 Cursor tmpcur = cur;
1483 tmpcur.pushBackward(*it);
1484 it->dispatch(tmpcur, fr);
1487 updateFlags = Update::Force | Update::FitCursor;
1491 case LFUN_BUFFER_LANGUAGE: {
1492 BOOST_ASSERT(lyx_view_);
1493 Buffer & buffer = *lyx_view_->buffer();
1494 Language const * oldL = buffer.params().language;
1495 Language const * newL = languages.getLanguage(argument);
1496 if (!newL || oldL == newL)
1499 if (oldL->rightToLeft() == newL->rightToLeft()
1500 && !buffer.isMultiLingual())
1501 buffer.changeLanguage(oldL, newL);
1505 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1506 string const fname =
1507 addName(addPath(package().user_support().absFilename(), "templates/"),
1509 Buffer defaults(fname);
1511 istringstream ss(argument);
1514 int const unknown_tokens = defaults.readHeader(lex);
1516 if (unknown_tokens != 0) {
1517 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1518 << unknown_tokens << " unknown token"
1519 << (unknown_tokens == 1 ? "" : "s")
1523 if (defaults.writeFile(FileName(defaults.absFileName())))
1524 setMessage(bformat(_("Document defaults saved in %1$s"),
1525 makeDisplayPath(fname)));
1527 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
1531 case LFUN_BUFFER_PARAMS_APPLY: {
1532 BOOST_ASSERT(lyx_view_);
1533 biblio::CiteEngine const oldEngine =
1534 lyx_view_->buffer()->params().getEngine();
1536 Buffer * buffer = lyx_view_->buffer();
1538 TextClassIndex oldClass = buffer->params().textClassIndex();
1540 Cursor & cur = view()->cursor();
1541 cur.recordUndoFullDocument();
1543 istringstream ss(argument);
1546 int const unknown_tokens = buffer->readHeader(lex);
1548 if (unknown_tokens != 0) {
1549 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1550 << unknown_tokens << " unknown token"
1551 << (unknown_tokens == 1 ? "" : "s")
1555 updateLayout(oldClass, buffer);
1557 biblio::CiteEngine const newEngine =
1558 lyx_view_->buffer()->params().getEngine();
1560 if (oldEngine != newEngine) {
1561 FuncRequest fr(LFUN_INSET_REFRESH);
1563 Inset & inset = lyx_view_->buffer()->inset();
1564 InsetIterator it = inset_iterator_begin(inset);
1565 InsetIterator const end = inset_iterator_end(inset);
1566 for (; it != end; ++it)
1567 if (it->lyxCode() == CITE_CODE)
1568 it->dispatch(cur, fr);
1571 updateFlags = Update::Force | Update::FitCursor;
1572 // We are here most certainaly because of a change in the document
1573 // It is then better to make sure that all dialogs are in sync
1574 // with current document settings. LyXView::restartCursor() achieve this.
1575 lyx_view_->restartCursor();
1579 case LFUN_LAYOUT_MODULES_CLEAR: {
1580 BOOST_ASSERT(lyx_view_);
1581 Buffer * buffer = lyx_view_->buffer();
1582 TextClassIndex oldClass = buffer->params().textClassIndex();
1583 view()->cursor().recordUndoFullDocument();
1584 buffer->params().clearLayoutModules();
1585 buffer->params().makeTextClass();
1586 updateLayout(oldClass, buffer);
1587 updateFlags = Update::Force | Update::FitCursor;
1591 case LFUN_LAYOUT_MODULE_ADD: {
1592 BOOST_ASSERT(lyx_view_);
1593 Buffer * buffer = lyx_view_->buffer();
1594 TextClassIndex oldClass = buffer->params().textClassIndex();
1595 view()->cursor().recordUndoFullDocument();
1596 buffer->params().addLayoutModule(argument);
1597 buffer->params().makeTextClass();
1598 updateLayout(oldClass, buffer);
1599 updateFlags = Update::Force | Update::FitCursor;
1603 case LFUN_TEXTCLASS_APPLY: {
1604 BOOST_ASSERT(lyx_view_);
1605 Buffer * buffer = lyx_view_->buffer();
1607 loadTextClass(argument);
1609 pair<bool, TextClassIndex> const tc_pair =
1610 textclasslist.numberOfClass(argument);
1615 TextClassIndex const old_class = buffer->params().baseClass();
1616 TextClassIndex const new_class = tc_pair.second;
1618 if (old_class == new_class)
1622 //Save the old, possibly modular, layout for use in conversion.
1623 TextClassIndex oldClass = buffer->params().textClassIndex();
1624 view()->cursor().recordUndoFullDocument();
1625 buffer->params().setBaseClass(new_class);
1626 buffer->params().makeTextClass();
1627 updateLayout(oldClass, buffer);
1628 updateFlags = Update::Force | Update::FitCursor;
1632 case LFUN_LAYOUT_RELOAD: {
1633 BOOST_ASSERT(lyx_view_);
1634 Buffer * buffer = lyx_view_->buffer();
1635 TextClassIndex oldClass = buffer->params().textClassIndex();
1636 TextClassIndex const tc = buffer->params().baseClass();
1637 textclasslist.reset(tc);
1638 buffer->params().setBaseClass(tc);
1639 buffer->params().makeTextClass();
1640 updateLayout(oldClass, buffer);
1641 updateFlags = Update::Force | Update::FitCursor;
1645 case LFUN_TEXTCLASS_LOAD:
1646 loadTextClass(argument);
1649 case LFUN_LYXRC_APPLY: {
1650 LyXRC const lyxrc_orig = lyxrc;
1652 istringstream ss(argument);
1653 bool const success = lyxrc.read(ss) == 0;
1656 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1657 << "Unable to read lyxrc data"
1662 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1664 theApp()->resetGui();
1666 /// We force the redraw in any case because there might be
1667 /// some screen font changes.
1668 /// FIXME: only the current view will be updated. the Gui
1669 /// class is able to furnish the list of views.
1670 updateFlags = Update::Force;
1674 case LFUN_BOOKMARK_GOTO:
1675 // go to bookmark, open unopened file and switch to buffer if necessary
1676 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1677 updateFlags = Update::FitCursor;
1680 case LFUN_BOOKMARK_CLEAR:
1681 LyX::ref().session().bookmarks().clear();
1685 BOOST_ASSERT(theApp());
1686 // Let the frontend dispatch its own actions.
1687 if (theApp()->dispatch(cmd))
1688 // Nothing more to do.
1691 // Let the current LyXView dispatch its own actions.
1692 BOOST_ASSERT(lyx_view_);
1693 if (lyx_view_->dispatch(cmd)) {
1694 if (lyx_view_->view())
1695 updateFlags = lyx_view_->view()->cursor().result().update();
1699 BOOST_ASSERT(lyx_view_->view());
1700 // Let the current BufferView dispatch its own actions.
1701 if (view()->dispatch(cmd)) {
1702 // The BufferView took care of its own updates if needed.
1703 updateFlags = Update::None;
1707 // Let the current Cursor dispatch its own actions.
1708 Cursor old = view()->cursor();
1709 view()->cursor().getPos(cursorPosBeforeDispatchX_,
1710 cursorPosBeforeDispatchY_);
1711 view()->cursor().dispatch(cmd);
1713 // notify insets we just left
1714 if (view()->cursor() != old) {
1716 bool badcursor = notifyCursorLeaves(old, view()->cursor());
1718 view()->cursor().fixIfBroken();
1721 updateFlags = view()->cursor().result().update();
1724 if (lyx_view_ && lyx_view_->buffer()) {
1725 // BufferView::update() updates the ViewMetricsInfo and
1726 // also initializes the position cache for all insets in
1727 // (at least partially) visible top-level paragraphs.
1728 // We will redraw the screen only if needed.
1729 view()->processUpdateFlags(updateFlags);
1731 // if we executed a mutating lfun, mark the buffer as dirty
1733 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1734 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1735 lyx_view_->buffer()->markDirty();
1737 //Do we have a selection?
1738 theSelection().haveSelection(view()->cursor().selection());
1741 if (!quitting && lyx_view_) {
1742 // Some messages may already be translated, so we cannot use _()
1743 sendDispatchMessage(translateIfPossible(getMessage()), cmd);
1748 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1750 const bool verbose = (cmd.origin == FuncRequest::MENU
1751 || cmd.origin == FuncRequest::TOOLBAR
1752 || cmd.origin == FuncRequest::COMMANDBUFFER);
1754 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1755 LYXERR(Debug::ACTION, "dispatch msg is " << to_utf8(msg));
1757 lyx_view_->message(msg);
1761 docstring dispatch_msg = msg;
1762 if (!dispatch_msg.empty())
1763 dispatch_msg += ' ';
1765 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1767 bool argsadded = false;
1769 if (!cmd.argument().empty()) {
1770 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1771 comname += ' ' + cmd.argument();
1776 docstring const shortcuts = theTopLevelKeymap().printBindings(cmd);
1778 if (!shortcuts.empty())
1779 comname += ": " + shortcuts;
1780 else if (!argsadded && !cmd.argument().empty())
1781 comname += ' ' + cmd.argument();
1783 if (!comname.empty()) {
1784 comname = rtrim(comname);
1785 dispatch_msg += '(' + rtrim(comname) + ')';
1788 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1789 if (!dispatch_msg.empty())
1790 lyx_view_->message(dispatch_msg);
1794 void LyXFunc::closeBuffer()
1796 // goto bookmark to update bookmark pit.
1797 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
1798 gotoBookmark(i+1, false, false);
1800 lyx_view_->closeBuffer();
1804 void LyXFunc::reloadBuffer()
1806 FileName filename = lyx_view_->buffer()->fileName();
1807 // The user has already confirmed that the changes, if any, should
1808 // be discarded. So we just release the Buffer and don't call closeBuffer();
1809 theBufferList().release(lyx_view_->buffer());
1810 Buffer * buf = lyx_view_->loadDocument(filename);
1811 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1815 lyx_view_->setBuffer(buf);
1816 buf->errors("Parse");
1817 str = bformat(_("Document %1$s reloaded."), disp_fn);
1819 str = bformat(_("Could not reload document %1$s"), disp_fn);
1821 lyx_view_->message(str);
1824 // Each "lyx_view_" should have it's own message method. lyxview and
1825 // the minibuffer would use the minibuffer, but lyxserver would
1826 // send an ERROR signal to its client. Alejandro 970603
1827 // This function is bit problematic when it comes to NLS, to make the
1828 // lyx servers client be language indepenent we must not translate
1829 // strings sent to this func.
1830 void LyXFunc::setErrorMessage(docstring const & m) const
1832 dispatch_buffer = m;
1837 void LyXFunc::setMessage(docstring const & m) const
1839 dispatch_buffer = m;
1843 docstring const LyXFunc::viewStatusMessage()
1845 // When meta-fake key is pressed, show the key sequence so far + "M-".
1847 return keyseq.print(KeySequence::ForGui) + "M-";
1849 // Else, when a non-complete key sequence is pressed,
1850 // show the available options.
1851 if (keyseq.length() > 0 && !keyseq.deleted())
1852 return keyseq.printOptions(true);
1854 BOOST_ASSERT(lyx_view_);
1855 if (!lyx_view_->buffer())
1856 return _("Welcome to LyX!");
1858 return view()->cursor().currentState();
1862 BufferView * LyXFunc::view() const
1864 BOOST_ASSERT(lyx_view_);
1865 return lyx_view_->view();
1869 bool LyXFunc::wasMetaKey() const
1871 return (meta_fake_bit != NoModifier);
1875 void LyXFunc::updateLayout(TextClassIndex const & oldlayout,
1878 lyx_view_->message(_("Converting document to new document class..."));
1880 StableDocIterator backcur(view()->cursor());
1881 ErrorList & el = buffer->errorList("Class Switch");
1882 cap::switchBetweenClasses(
1883 oldlayout, buffer->params().textClassIndex(),
1884 static_cast<InsetText &>(buffer->inset()), el);
1886 view()->setCursor(backcur.asDocIterator(&(buffer->inset())));
1888 buffer->errors("Class Switch");
1889 updateLabels(*buffer);
1895 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
1897 // Why the switch you might ask. It is a trick to ensure that all
1898 // the elements in the LyXRCTags enum is handled. As you can see
1899 // there are no breaks at all. So it is just a huge fall-through.
1900 // The nice thing is that we will get a warning from the compiler
1901 // if we forget an element.
1902 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
1904 case LyXRC::RC_ACCEPT_COMPOUND:
1905 case LyXRC::RC_ALT_LANG:
1906 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
1907 case LyXRC::RC_PLAINTEXT_LINELEN:
1908 case LyXRC::RC_AUTOREGIONDELETE:
1909 case LyXRC::RC_AUTORESET_OPTIONS:
1910 case LyXRC::RC_AUTOSAVE:
1911 case LyXRC::RC_AUTO_NUMBER:
1912 case LyXRC::RC_BACKUPDIR_PATH:
1913 case LyXRC::RC_BIBTEX_COMMAND:
1914 case LyXRC::RC_BINDFILE:
1915 case LyXRC::RC_CHECKLASTFILES:
1916 case LyXRC::RC_COMPLETION_INLINE_DELAY:
1917 case LyXRC::RC_COMPLETION_INLINE_DOTS:
1918 case LyXRC::RC_COMPLETION_INLINE_MATH:
1919 case LyXRC::RC_COMPLETION_INLINE_TEXT:
1920 case LyXRC::RC_COMPLETION_POPUP_AFTER_COMPLETE:
1921 case LyXRC::RC_COMPLETION_POPUP_DELAY:
1922 case LyXRC::RC_COMPLETION_POPUP_MATH:
1923 case LyXRC::RC_COMPLETION_POPUP_TEXT:
1924 case LyXRC::RC_USELASTFILEPOS:
1925 case LyXRC::RC_LOADSESSION:
1926 case LyXRC::RC_CHKTEX_COMMAND:
1927 case LyXRC::RC_CONVERTER:
1928 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
1929 case LyXRC::RC_COPIER:
1930 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
1931 case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
1932 case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
1933 case LyXRC::RC_DATE_INSERT_FORMAT:
1934 case LyXRC::RC_DEFAULT_LANGUAGE:
1935 case LyXRC::RC_DEFAULT_PAPERSIZE:
1936 case LyXRC::RC_DEFFILE:
1937 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
1938 case LyXRC::RC_DISPLAY_GRAPHICS:
1939 case LyXRC::RC_DOCUMENTPATH:
1940 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
1941 FileName path(lyxrc_new.document_path);
1942 if (path.exists() && path.isDirectory())
1943 package().document_dir() = FileName(lyxrc.document_path);
1945 case LyXRC::RC_ESC_CHARS:
1946 case LyXRC::RC_EXAMPLEPATH:
1947 case LyXRC::RC_FONT_ENCODING:
1948 case LyXRC::RC_FORMAT:
1949 case LyXRC::RC_INDEX_COMMAND:
1950 case LyXRC::RC_INPUT:
1951 case LyXRC::RC_KBMAP:
1952 case LyXRC::RC_KBMAP_PRIMARY:
1953 case LyXRC::RC_KBMAP_SECONDARY:
1954 case LyXRC::RC_LABEL_INIT_LENGTH:
1955 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
1956 case LyXRC::RC_LANGUAGE_AUTO_END:
1957 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
1958 case LyXRC::RC_LANGUAGE_COMMAND_END:
1959 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
1960 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
1961 case LyXRC::RC_LANGUAGE_PACKAGE:
1962 case LyXRC::RC_LANGUAGE_USE_BABEL:
1963 case LyXRC::RC_MACRO_EDIT_STYLE:
1964 case LyXRC::RC_MAKE_BACKUP:
1965 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
1966 case LyXRC::RC_MOUSE_WHEEL_SPEED:
1967 case LyXRC::RC_NUMLASTFILES:
1968 case LyXRC::RC_PATH_PREFIX:
1969 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
1970 prependEnvPath("PATH", lyxrc.path_prefix);
1972 case LyXRC::RC_PERS_DICT:
1973 case LyXRC::RC_PREVIEW:
1974 case LyXRC::RC_PREVIEW_HASHED_LABELS:
1975 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
1976 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
1977 case LyXRC::RC_PRINTCOPIESFLAG:
1978 case LyXRC::RC_PRINTER:
1979 case LyXRC::RC_PRINTEVENPAGEFLAG:
1980 case LyXRC::RC_PRINTEXSTRAOPTIONS:
1981 case LyXRC::RC_PRINTFILEEXTENSION:
1982 case LyXRC::RC_PRINTLANDSCAPEFLAG:
1983 case LyXRC::RC_PRINTODDPAGEFLAG:
1984 case LyXRC::RC_PRINTPAGERANGEFLAG:
1985 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
1986 case LyXRC::RC_PRINTPAPERFLAG:
1987 case LyXRC::RC_PRINTREVERSEFLAG:
1988 case LyXRC::RC_PRINTSPOOL_COMMAND:
1989 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
1990 case LyXRC::RC_PRINTTOFILE:
1991 case LyXRC::RC_PRINTTOPRINTER:
1992 case LyXRC::RC_PRINT_ADAPTOUTPUT:
1993 case LyXRC::RC_PRINT_COMMAND:
1994 case LyXRC::RC_RTL_SUPPORT:
1995 case LyXRC::RC_SCREEN_DPI:
1996 case LyXRC::RC_SCREEN_FONT_ROMAN:
1997 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
1998 case LyXRC::RC_SCREEN_FONT_SANS:
1999 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
2000 case LyXRC::RC_SCREEN_FONT_SCALABLE:
2001 case LyXRC::RC_SCREEN_FONT_SIZES:
2002 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
2003 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
2004 case LyXRC::RC_GEOMETRY_SESSION:
2005 case LyXRC::RC_SCREEN_ZOOM:
2006 case LyXRC::RC_SERVERPIPE:
2007 case LyXRC::RC_SET_COLOR:
2008 case LyXRC::RC_SHOW_BANNER:
2009 case LyXRC::RC_SPELL_COMMAND:
2010 case LyXRC::RC_TEMPDIRPATH:
2011 case LyXRC::RC_TEMPLATEPATH:
2012 case LyXRC::RC_TEX_ALLOWS_SPACES:
2013 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
2014 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
2015 os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
2017 case LyXRC::RC_UIFILE:
2018 case LyXRC::RC_USER_EMAIL:
2019 case LyXRC::RC_USER_NAME:
2020 case LyXRC::RC_USETEMPDIR:
2021 case LyXRC::RC_USE_ALT_LANG:
2022 case LyXRC::RC_USE_CONVERTER_CACHE:
2023 case LyXRC::RC_USE_ESC_CHARS:
2024 case LyXRC::RC_USE_INP_ENC:
2025 case LyXRC::RC_USE_PERS_DICT:
2026 case LyXRC::RC_USE_TOOLTIP:
2027 case LyXRC::RC_USE_PIXMAP_CACHE:
2028 case LyXRC::RC_USE_SPELL_LIB:
2029 case LyXRC::RC_VIEWDVI_PAPEROPTION:
2030 case LyXRC::RC_SORT_LAYOUTS:
2031 case LyXRC::RC_FULL_SCREEN_LIMIT:
2032 case LyXRC::RC_FULL_SCREEN_SCROLLBAR:
2033 case LyXRC::RC_FULL_SCREEN_TABBAR:
2034 case LyXRC::RC_FULL_SCREEN_TOOLBARS:
2035 case LyXRC::RC_FULL_SCREEN_WIDTH:
2036 case LyXRC::RC_VISUAL_CURSOR:
2037 case LyXRC::RC_VIEWER:
2038 case LyXRC::RC_LAST: