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 "LayoutFile.h"
25 #include "BranchList.h"
26 #include "buffer_funcs.h"
28 #include "BufferList.h"
29 #include "BufferParams.h"
30 #include "BufferView.h"
33 #include "Converter.h"
35 #include "CutAndPaste.h"
36 #include "DispatchResult.h"
38 #include "ErrorList.h"
40 #include "FuncRequest.h"
41 #include "FuncStatus.h"
42 #include "InsetIterator.h"
47 #include "LyXAction.h"
52 #include "Paragraph.h"
53 #include "ParagraphParameters.h"
54 #include "ParIterator.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.
112 lv->message(_("Running configure..."));
114 // Run configure in user lyx directory
115 PathChanger p(package().user_support());
116 string configure_command = package().configure_command();
117 configure_command += option;
119 int ret = one.startscript(Systemcall::Wait, configure_command);
121 // emit message signal.
123 lv->message(_("Reloading configuration..."));
124 lyxrc.read(libFileSearch(string(), "lyxrc.defaults"));
125 // Re-read packages.lst
126 LaTeXFeatures::getAvailable();
129 Alert::information(_("System reconfiguration failed"),
130 _("The system reconfiguration has failed.\n"
131 "Default textclass is used but LyX may "
132 "not be able to work properly.\n"
133 "Please reconfigure again if needed."));
136 Alert::information(_("System reconfigured"),
137 _("The system has been reconfigured.\n"
138 "You need to restart LyX to make use of any\n"
139 "updated document class specifications."));
143 bool getLocalStatus(Cursor cursor, FuncRequest const & cmd, FuncStatus & status)
145 // Try to fix cursor in case it is broken.
146 cursor.fixIfBroken();
148 // This is, of course, a mess. Better create a new doc iterator and use
149 // this in Inset::getStatus. This might require an additional
150 // BufferView * arg, though (which should be avoided)
151 //Cursor safe = *this;
153 for ( ; cursor.depth(); cursor.pop()) {
154 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
155 BOOST_ASSERT(cursor.idx() <= cursor.lastidx());
156 BOOST_ASSERT(cursor.pit() <= cursor.lastpit());
157 BOOST_ASSERT(cursor.pos() <= cursor.lastpos());
159 // The inset's getStatus() will return 'true' if it made
160 // a definitive decision on whether it want to handle the
161 // request or not. The result of this decision is put into
162 // the 'status' parameter.
163 if (cursor.inset().getStatus(cursor, cmd, status)) {
172 /** Return the change status at cursor position, taking in account the
173 * status at each level of the document iterator (a table in a deleted
174 * footnote is deleted).
175 * When \param outer is true, the top slice is not looked at.
177 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
179 size_t const depth = dit.depth() - (outer ? 1 : 0);
181 for (size_t i = 0 ; i < depth ; ++i) {
182 CursorSlice const & slice = dit[i];
183 if (!slice.inset().inMathed()
184 && slice.pos() < slice.paragraph().size()) {
185 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
186 if (ch != Change::UNCHANGED)
190 return Change::UNCHANGED;
197 : lyx_view_(0), encoded_last_key(0), meta_fake_bit(NoModifier)
202 void LyXFunc::initKeySequences(KeyMap * kb)
204 keyseq = KeySequence(kb, kb);
205 cancel_meta_seq = KeySequence(kb, kb);
209 void LyXFunc::setLyXView(LyXView * lv)
211 if (lyx_view_ && lyx_view_->view() && lyx_view_ != lv)
212 // save current selection to the selection buffer to allow
213 // middle-button paste in another window
214 cap::saveSelection(lyx_view_->view()->cursor());
219 void LyXFunc::handleKeyFunc(kb_action action)
221 char_type c = encoded_last_key;
226 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
227 lyx_view_->view()->getIntl().getTransManager().deadkey(
228 c, get_accent(action).accent, view()->cursor().innerText(), view()->cursor());
229 // Need to clear, in case the minibuffer calls these
232 // copied verbatim from do_accent_char
233 view()->cursor().resetAnchor();
234 view()->processUpdateFlags(Update::FitCursor);
237 //FIXME: bookmark handling is a frontend issue. This code should be transferred
238 // to GuiView and be GuiView and be window dependent.
239 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
241 BOOST_ASSERT(lyx_view_);
242 if (!LyX::ref().session().bookmarks().isValid(idx))
244 BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(idx);
245 BOOST_ASSERT(!bm.filename.empty());
246 string const file = bm.filename.absFilename();
247 // if the file is not opened, open it.
248 if (!theBufferList().exists(file)) {
250 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
254 // open may fail, so we need to test it again
255 if (!theBufferList().exists(file))
258 // if the current buffer is not that one, switch to it.
259 if (lyx_view_->buffer()->absFileName() != file) {
262 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
264 // moveToPosition try paragraph id first and then paragraph (pit, pos).
265 if (!view()->moveToPosition(bm.bottom_pit, bm.bottom_pos,
266 bm.top_id, bm.top_pos))
269 // Cursor jump succeeded!
270 Cursor const & cur = view()->cursor();
271 pit_type new_pit = cur.pit();
272 pos_type new_pos = cur.pos();
273 int new_id = cur.paragraph().id();
275 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
276 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
277 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
278 || bm.top_id != new_id) {
279 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
280 new_pit, new_pos, new_id);
285 void LyXFunc::processKeySym(KeySymbol const & keysym, KeyModifier state)
287 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
289 // Do nothing if we have nothing (JMarc)
290 if (!keysym.isOK()) {
291 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
292 lyx_view_->restartCursor();
296 if (keysym.isModifier()) {
297 LYXERR(Debug::KEY, "isModifier true");
299 lyx_view_->restartCursor();
303 //Encoding const * encoding = view()->cursor().getEncoding();
304 //encoded_last_key = keysym.getISOEncoded(encoding ? encoding->name() : "");
305 // FIXME: encoded_last_key shadows the member variable of the same
306 // name. Is that intended?
307 char_type encoded_last_key = keysym.getUCSEncoded();
309 // Do a one-deep top-level lookup for
310 // cancel and meta-fake keys. RVDK_PATCH_5
311 cancel_meta_seq.reset();
313 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
314 LYXERR(Debug::KEY, "action first set to [" << func.action << ']');
316 // When not cancel or meta-fake, do the normal lookup.
317 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
318 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
319 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
320 // remove Caps Lock and Mod2 as a modifiers
321 func = keyseq.addkey(keysym, (state | meta_fake_bit));
322 LYXERR(Debug::KEY, "action now set to [" << func.action << ']');
325 // Dont remove this unless you know what you are doing.
326 meta_fake_bit = NoModifier;
328 // Can this happen now ?
329 if (func.action == LFUN_NOACTION)
330 func = FuncRequest(LFUN_COMMAND_PREFIX);
332 LYXERR(Debug::KEY, " Key [action=" << func.action << "]["
333 << keyseq.print(KeySequence::Portable) << ']');
335 // already here we know if it any point in going further
336 // why not return already here if action == -1 and
337 // num_bytes == 0? (Lgb)
339 if (keyseq.length() > 1)
340 lyx_view_->message(keyseq.print(KeySequence::ForGui));
343 // Maybe user can only reach the key via holding down shift.
344 // Let's see. But only if shift is the only modifier
345 if (func.action == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
346 LYXERR(Debug::KEY, "Trying without shift");
347 func = keyseq.addkey(keysym, NoModifier);
348 LYXERR(Debug::KEY, "Action now " << func.action);
351 if (func.action == LFUN_UNKNOWN_ACTION) {
352 // Hmm, we didn't match any of the keysequences. See
353 // if it's normal insertable text not already covered
355 if (keysym.isText() && keyseq.length() == 1) {
356 LYXERR(Debug::KEY, "isText() is true, inserting.");
357 func = FuncRequest(LFUN_SELF_INSERT,
358 FuncRequest::KEYBOARD);
360 LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
361 lyx_view_->message(_("Unknown function."));
362 lyx_view_->restartCursor();
367 if (func.action == LFUN_SELF_INSERT) {
368 if (encoded_last_key != 0) {
369 docstring const arg(1, encoded_last_key);
370 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
371 FuncRequest::KEYBOARD));
372 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
381 lyx_view_->restartCursor();
385 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
387 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
390 Buffer * buf = lyx_view_ ? lyx_view_->buffer() : 0;
392 if (cmd.action == LFUN_NOACTION) {
393 flag.message(from_utf8(N_("Nothing to do")));
398 switch (cmd.action) {
399 case LFUN_UNKNOWN_ACTION:
400 #ifndef HAVE_LIBAIKSAURUS
401 case LFUN_THESAURUS_ENTRY:
411 if (flag.unknown()) {
412 flag.message(from_utf8(N_("Unknown action")));
416 if (!flag.enabled()) {
417 if (flag.message().empty())
418 flag.message(from_utf8(N_("Command disabled")));
422 // Check whether we need a buffer
423 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
425 flag.message(from_utf8(N_("Command not allowed with"
426 "out any document open")));
431 // I would really like to avoid having this switch and rather try to
432 // encode this in the function itself.
433 // -- And I'd rather let an inset decide which LFUNs it is willing
434 // to handle (Andre')
436 switch (cmd.action) {
438 // FIXME: these cases should be hidden in GuiApplication::getStatus().
439 case LFUN_WINDOW_CLOSE:
441 return theApp()->getStatus(cmd);
445 // FIXME: these cases should be hidden in GuiView::getStatus().
446 case LFUN_DIALOG_TOGGLE:
447 case LFUN_DIALOG_SHOW:
448 case LFUN_DIALOG_UPDATE:
449 // FIXME: add special handling for about and prefs dialogs here
450 // which do not depend on GuiView.
452 return lyx_view_->getStatus(cmd);
457 case LFUN_TOOLBAR_TOGGLE:
458 case LFUN_INSET_APPLY:
459 case LFUN_BUFFER_WRITE:
460 case LFUN_BUFFER_WRITE_AS:
461 case LFUN_SPLIT_VIEW:
462 case LFUN_CLOSE_TAB_GROUP:
463 case LFUN_COMPLETION_POPUP:
464 case LFUN_COMPLETION_INLINE:
465 case LFUN_COMPLETION_COMPLETE:
467 return lyx_view_->getStatus(cmd);
471 case LFUN_BUFFER_TOGGLE_READ_ONLY:
472 flag.setOnOff(buf->isReadonly());
475 case LFUN_BUFFER_SWITCH:
476 // toggle on the current buffer, but do not toggle off
477 // the other ones (is that a good idea?)
478 if (buf && to_utf8(cmd.argument()) == buf->absFileName())
482 case LFUN_BUFFER_EXPORT:
483 enable = cmd.argument() == "custom"
484 || buf->isExportable(to_utf8(cmd.argument()));
487 case LFUN_BUFFER_CHKTEX:
488 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
491 case LFUN_BUILD_PROGRAM:
492 enable = buf->isExportable("program");
495 case LFUN_VC_REGISTER:
496 enable = !buf->lyxvc().inUse();
498 case LFUN_VC_CHECK_IN:
499 enable = buf->lyxvc().inUse() && !buf->isReadonly();
501 case LFUN_VC_CHECK_OUT:
502 enable = buf->lyxvc().inUse() && buf->isReadonly();
505 case LFUN_VC_UNDO_LAST:
506 enable = buf->lyxvc().inUse();
508 case LFUN_BUFFER_RELOAD:
509 enable = !buf->isUnnamed() && buf->fileName().exists()
510 && (!buf->isClean() || buf->isExternallyModified(Buffer::timestamp_method));
513 case LFUN_CITATION_INSERT: {
514 FuncRequest fr(LFUN_INSET_INSERT, "citation");
515 enable = getStatus(fr).enabled();
519 // This could be used for the no-GUI version. The GUI version is handled in
520 // LyXView::getStatus(). See above.
522 case LFUN_BUFFER_WRITE:
523 case LFUN_BUFFER_WRITE_AS: {
524 Buffer * b = theBufferList().getBuffer(cmd.getArg(0));
525 enable = b && (b->isUnnamed() || !b->isClean());
530 case LFUN_BUFFER_WRITE_ALL: {
531 // We enable the command only if there are some modified buffers
532 Buffer * first = theBufferList().first();
537 // We cannot use a for loop as the buffer list is a cycle.
543 b = theBufferList().next(b);
544 } while (b != first);
548 case LFUN_BOOKMARK_GOTO: {
549 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
550 enable = LyX::ref().session().bookmarks().isValid(num);
554 case LFUN_BOOKMARK_CLEAR:
555 enable = LyX::ref().session().bookmarks().size() > 0;
558 // this one is difficult to get right. As a half-baked
559 // solution, we consider only the first action of the sequence
560 case LFUN_COMMAND_SEQUENCE: {
561 // argument contains ';'-terminated commands
562 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
563 FuncRequest func(lyxaction.lookupFunc(firstcmd));
564 func.origin = cmd.origin;
565 flag = getStatus(func);
571 string name = to_utf8(cmd.argument());
572 if (LyX::ref().topLevelCmdDef().lock(name, func)) {
573 func.origin = cmd.origin;
574 flag = getStatus(func);
575 LyX::ref().topLevelCmdDef().release(name);
577 // catch recursion or unknown command definiton
578 // all operations until the recursion or unknown command
579 // definiton occures are performed, so set the state to enabled
585 case LFUN_BUFFER_NEW:
586 case LFUN_BUFFER_NEW_TEMPLATE:
587 case LFUN_WORD_FIND_FORWARD:
588 case LFUN_WORD_FIND_BACKWARD:
589 case LFUN_COMMAND_PREFIX:
590 case LFUN_COMMAND_EXECUTE:
592 case LFUN_META_PREFIX:
593 case LFUN_BUFFER_CLOSE:
594 case LFUN_BUFFER_UPDATE:
595 case LFUN_BUFFER_VIEW:
596 case LFUN_MASTER_BUFFER_UPDATE:
597 case LFUN_MASTER_BUFFER_VIEW:
598 case LFUN_BUFFER_IMPORT:
599 case LFUN_BUFFER_AUTO_SAVE:
600 case LFUN_RECONFIGURE:
603 case LFUN_DROP_LAYOUTS_CHOICE:
605 case LFUN_SERVER_GET_NAME:
606 case LFUN_SERVER_NOTIFY:
607 case LFUN_SERVER_GOTO_FILE_ROW:
608 case LFUN_DIALOG_HIDE:
609 case LFUN_DIALOG_DISCONNECT_INSET:
610 case LFUN_BUFFER_CHILD_OPEN:
612 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
613 case LFUN_KEYMAP_OFF:
614 case LFUN_KEYMAP_PRIMARY:
615 case LFUN_KEYMAP_SECONDARY:
616 case LFUN_KEYMAP_TOGGLE:
618 case LFUN_BUFFER_EXPORT_CUSTOM:
619 case LFUN_BUFFER_PRINT:
620 case LFUN_PREFERENCES_SAVE:
621 case LFUN_SCREEN_FONT_UPDATE:
624 case LFUN_EXTERNAL_EDIT:
625 case LFUN_GRAPHICS_EDIT:
626 case LFUN_ALL_INSETS_TOGGLE:
627 case LFUN_BUFFER_LANGUAGE:
628 case LFUN_TEXTCLASS_APPLY:
629 case LFUN_TEXTCLASS_LOAD:
630 case LFUN_BUFFER_SAVE_AS_DEFAULT:
631 case LFUN_BUFFER_PARAMS_APPLY:
632 case LFUN_LAYOUT_MODULES_CLEAR:
633 case LFUN_LAYOUT_MODULE_ADD:
634 case LFUN_LAYOUT_RELOAD:
635 case LFUN_LYXRC_APPLY:
636 case LFUN_BUFFER_NEXT:
637 case LFUN_BUFFER_PREVIOUS:
638 case LFUN_WINDOW_NEW:
640 // these are handled in our dispatch()
648 if (!getLocalStatus(view()->cursor(), cmd, flag))
649 flag = view()->getStatus(cmd);
655 // Can we use a readonly buffer?
656 if (buf && buf->isReadonly()
657 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
658 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
659 flag.message(from_utf8(N_("Document is read-only")));
663 // Are we in a DELETED change-tracking region?
665 && lookupChangeType(view()->cursor(), true) == Change::DELETED
666 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
667 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
668 flag.message(from_utf8(N_("This portion of the document is deleted.")));
672 // the default error message if we disable the command
673 if (!flag.enabled() && flag.message().empty())
674 flag.message(from_utf8(N_("Command disabled")));
680 bool LyXFunc::ensureBufferClean(BufferView * bv)
682 Buffer & buf = bv->buffer();
686 docstring const file = buf.fileName().displayName(30);
687 docstring text = bformat(_("The document %1$s has unsaved "
688 "changes.\n\nDo you want to save "
689 "the document?"), file);
690 int const ret = Alert::prompt(_("Save changed document?"),
691 text, 0, 1, _("&Save"),
695 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
697 return buf.isClean();
703 void showPrintError(string const & name)
705 docstring str = bformat(_("Could not print the document %1$s.\n"
706 "Check that your printer is set up correctly."),
707 makeDisplayPath(name, 50));
708 Alert::error(_("Print document failed"), str);
712 bool loadLayoutFile(string const & name, string const & buf_path)
714 if (!LayoutFileList::get().haveClass(name)) {
715 lyxerr << "Document class \"" << name
716 << "\" does not exist."
721 LayoutFile & tc = LayoutFileList::get()[name];
722 if (!tc.load(buf_path)) {
723 docstring s = bformat(_("The document class %1$s."
724 "could not be loaded."), from_utf8(name));
725 Alert::error(_("Could not load class"), s);
732 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
737 void LyXFunc::dispatch(FuncRequest const & cmd)
739 string const argument = to_utf8(cmd.argument());
740 kb_action const action = cmd.action;
742 LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
743 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
745 // we have not done anything wrong yet.
747 dispatch_buffer.erase();
749 // redraw the screen at the end (first of the two drawing steps).
750 //This is done unless explicitely requested otherwise
751 Update::flags updateFlags = Update::FitCursor;
753 FuncStatus const flag = getStatus(cmd);
754 if (!flag.enabled()) {
755 // We cannot use this function here
756 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
757 << lyxaction.getActionName(action)
758 << " [" << action << "] is disabled at this location");
759 setErrorMessage(flag.message());
763 case LFUN_WORD_FIND_FORWARD:
764 case LFUN_WORD_FIND_BACKWARD: {
765 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
766 static docstring last_search;
767 docstring searched_string;
769 if (!cmd.argument().empty()) {
770 last_search = cmd.argument();
771 searched_string = cmd.argument();
773 searched_string = last_search;
776 if (searched_string.empty())
779 bool const fw = action == LFUN_WORD_FIND_FORWARD;
780 docstring const data =
781 find2string(searched_string, true, false, fw);
782 find(view(), FuncRequest(LFUN_WORD_FIND, data));
786 case LFUN_COMMAND_PREFIX:
787 BOOST_ASSERT(lyx_view_);
788 lyx_view_->message(keyseq.printOptions(true));
792 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
794 meta_fake_bit = NoModifier;
795 if (lyx_view_->buffer())
796 // cancel any selection
797 dispatch(FuncRequest(LFUN_MARK_OFF));
798 setMessage(from_ascii(N_("Cancel")));
801 case LFUN_META_PREFIX:
802 meta_fake_bit = AltModifier;
803 setMessage(keyseq.print(KeySequence::ForGui));
806 case LFUN_BUFFER_TOGGLE_READ_ONLY: {
807 BOOST_ASSERT(lyx_view_ && lyx_view_->view() && lyx_view_->buffer());
808 Buffer * buf = lyx_view_->buffer();
809 if (buf->lyxvc().inUse())
810 buf->lyxvc().toggleReadOnly();
812 buf->setReadonly(!lyx_view_->buffer()->isReadonly());
816 // --- Menus -----------------------------------------------
817 case LFUN_BUFFER_CLOSE:
818 lyx_view_->closeBuffer();
819 updateFlags = Update::None;
822 case LFUN_BUFFER_RELOAD: {
823 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
824 docstring const file = makeDisplayPath(lyx_view_->buffer()->absFileName(), 20);
825 docstring text = bformat(_("Any changes will be lost. Are you sure "
826 "you want to revert to the saved version of the document %1$s?"), file);
827 int const ret = Alert::prompt(_("Revert to saved document?"),
828 text, 1, 1, _("&Revert"), _("&Cancel"));
835 case LFUN_BUFFER_UPDATE:
836 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
837 lyx_view_->buffer()->doExport(argument, true);
840 case LFUN_BUFFER_VIEW:
841 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
842 lyx_view_->buffer()->preview(argument);
845 case LFUN_MASTER_BUFFER_UPDATE:
846 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer() && lyx_view_->buffer()->masterBuffer());
847 lyx_view_->buffer()->masterBuffer()->doExport(argument, true);
850 case LFUN_MASTER_BUFFER_VIEW:
851 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer() && lyx_view_->buffer()->masterBuffer());
852 lyx_view_->buffer()->masterBuffer()->preview(argument);
855 case LFUN_BUILD_PROGRAM:
856 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
857 lyx_view_->buffer()->doExport("program", true);
860 case LFUN_BUFFER_CHKTEX:
861 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
862 lyx_view_->buffer()->runChktex();
865 case LFUN_BUFFER_EXPORT:
866 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
867 if (argument == "custom")
868 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"));
870 lyx_view_->buffer()->doExport(argument, false);
873 case LFUN_BUFFER_EXPORT_CUSTOM: {
874 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
876 string command = split(argument, format_name, ' ');
877 Format const * format = formats.getFormat(format_name);
879 lyxerr << "Format \"" << format_name
880 << "\" not recognized!"
885 Buffer * buffer = lyx_view_->buffer();
887 // The name of the file created by the conversion process
890 // Output to filename
891 if (format->name() == "lyx") {
892 string const latexname = buffer->latexName(false);
893 filename = changeExtension(latexname,
894 format->extension());
895 filename = addName(buffer->temppath(), filename);
897 if (!buffer->writeFile(FileName(filename)))
901 buffer->doExport(format_name, true, filename);
904 // Substitute $$FName for filename
905 if (!contains(command, "$$FName"))
906 command = "( " + command + " ) < $$FName";
907 command = subst(command, "$$FName", filename);
909 // Execute the command in the background
911 call.startscript(Systemcall::DontWait, command);
915 case LFUN_BUFFER_PRINT: {
916 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
917 // FIXME: cmd.getArg() might fail if one of the arguments
918 // contains double quotes
919 string target = cmd.getArg(0);
920 string target_name = cmd.getArg(1);
921 string command = cmd.getArg(2);
924 || target_name.empty()
925 || command.empty()) {
926 lyxerr << "Unable to parse \""
927 << argument << '"' << endl;
930 if (target != "printer" && target != "file") {
931 lyxerr << "Unrecognized target \""
932 << target << '"' << endl;
936 Buffer * buffer = lyx_view_->buffer();
938 if (!buffer->doExport("dvi", true)) {
939 showPrintError(buffer->absFileName());
943 // Push directory path.
944 string const path = buffer->temppath();
945 // Prevent the compiler from optimizing away p
949 // there are three cases here:
950 // 1. we print to a file
951 // 2. we print directly to a printer
952 // 3. we print using a spool command (print to file first)
955 string const dviname =
956 changeExtension(buffer->latexName(true), "dvi");
958 if (target == "printer") {
959 if (!lyxrc.print_spool_command.empty()) {
960 // case 3: print using a spool
961 string const psname =
962 changeExtension(dviname,".ps");
963 command += ' ' + lyxrc.print_to_file
966 + quoteName(dviname);
969 lyxrc.print_spool_command + ' ';
970 if (target_name != "default") {
971 command2 += lyxrc.print_spool_printerprefix
975 command2 += quoteName(psname);
977 // If successful, then spool command
978 res = one.startscript(
983 res = one.startscript(
984 Systemcall::DontWait,
987 // case 2: print directly to a printer
988 if (target_name != "default")
989 command += ' ' + lyxrc.print_to_printer + target_name + ' ';
990 res = one.startscript(
991 Systemcall::DontWait,
992 command + quoteName(dviname));
996 // case 1: print to a file
997 FileName const filename(makeAbsPath(target_name,
998 lyx_view_->buffer()->filePath()));
999 FileName const dvifile(makeAbsPath(dviname, path));
1000 if (filename.exists()) {
1001 docstring text = bformat(
1002 _("The file %1$s already exists.\n\n"
1003 "Do you want to overwrite that file?"),
1004 makeDisplayPath(filename.absFilename()));
1005 if (Alert::prompt(_("Overwrite file?"),
1006 text, 0, 1, _("&Overwrite"), _("&Cancel")) != 0)
1009 command += ' ' + lyxrc.print_to_file
1010 + quoteName(filename.toFilesystemEncoding())
1012 + quoteName(dvifile.toFilesystemEncoding());
1013 res = one.startscript(Systemcall::DontWait,
1018 showPrintError(buffer->absFileName());
1022 // FIXME: There is need for a command-line import.
1024 case LFUN_BUFFER_IMPORT:
1029 case LFUN_BUFFER_AUTO_SAVE:
1030 lyx_view_->buffer()->autoSave();
1033 case LFUN_RECONFIGURE:
1034 // argument is any additional parameter to the configure.py command
1035 reconfigure(lyx_view_, argument);
1038 case LFUN_HELP_OPEN: {
1039 BOOST_ASSERT(lyx_view_);
1040 string const arg = argument;
1042 setErrorMessage(from_ascii(N_("Missing argument")));
1045 FileName const fname = i18nLibFileSearch("doc", arg, "lyx");
1046 if (fname.empty()) {
1047 lyxerr << "LyX: unable to find documentation file `"
1048 << arg << "'. Bad installation?" << endl;
1051 lyx_view_->message(bformat(_("Opening help file %1$s..."),
1052 makeDisplayPath(fname.absFilename())));
1053 Buffer * buf = lyx_view_->loadDocument(fname, false);
1056 lyx_view_->setBuffer(buf);
1057 buf->errors("Parse");
1059 updateFlags = Update::None;
1063 // --- version control -------------------------------
1064 case LFUN_VC_REGISTER:
1065 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1066 if (!ensureBufferClean(view()))
1068 if (!lyx_view_->buffer()->lyxvc().inUse()) {
1069 lyx_view_->buffer()->lyxvc().registrer();
1072 updateFlags = Update::Force;
1075 case LFUN_VC_CHECK_IN:
1076 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1077 if (!ensureBufferClean(view()))
1079 if (lyx_view_->buffer()->lyxvc().inUse()
1080 && !lyx_view_->buffer()->isReadonly()) {
1081 lyx_view_->buffer()->lyxvc().checkIn();
1086 case LFUN_VC_CHECK_OUT:
1087 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1088 if (!ensureBufferClean(view()))
1090 if (lyx_view_->buffer()->lyxvc().inUse()
1091 && lyx_view_->buffer()->isReadonly()) {
1092 lyx_view_->buffer()->lyxvc().checkOut();
1097 case LFUN_VC_REVERT:
1098 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1099 lyx_view_->buffer()->lyxvc().revert();
1103 case LFUN_VC_UNDO_LAST:
1104 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1105 lyx_view_->buffer()->lyxvc().undoLast();
1109 // --- lyxserver commands ----------------------------
1110 case LFUN_SERVER_GET_NAME:
1111 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1112 setMessage(from_utf8(lyx_view_->buffer()->absFileName()));
1113 LYXERR(Debug::INFO, "FNAME["
1114 << lyx_view_->buffer()->absFileName() << ']');
1117 case LFUN_SERVER_NOTIFY:
1118 dispatch_buffer = keyseq.print(KeySequence::Portable);
1119 theServer().notifyClient(to_utf8(dispatch_buffer));
1122 case LFUN_SERVER_GOTO_FILE_ROW: {
1123 BOOST_ASSERT(lyx_view_);
1126 istringstream is(argument);
1127 is >> file_name >> row;
1129 bool loaded = false;
1130 if (prefixIs(file_name, package().temp_dir().absFilename()))
1131 // Needed by inverse dvi search. If it is a file
1132 // in tmpdir, call the apropriated function
1133 buf = theBufferList().getBufferFromTmp(file_name);
1135 // Must replace extension of the file to be .lyx
1136 // and get full path
1137 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1138 // Either change buffer or load the file
1139 if (theBufferList().exists(s.absFilename()))
1140 buf = theBufferList().getBuffer(s.absFilename());
1142 buf = lyx_view_->loadDocument(s);
1148 updateFlags = Update::None;
1153 lyx_view_->setBuffer(buf);
1154 view()->setCursorFromRow(row);
1156 buf->errors("Parse");
1157 updateFlags = Update::FitCursor;
1162 case LFUN_DIALOG_SHOW_NEW_INSET: {
1163 BOOST_ASSERT(lyx_view_);
1164 string const name = cmd.getArg(0);
1165 InsetCode code = insetCode(name);
1166 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1167 bool insetCodeOK = true;
1176 case HYPERLINK_CODE: {
1177 InsetCommandParams p(code);
1178 data = InsetCommandMailer::params2string(name, p);
1181 case INCLUDE_CODE: {
1182 // data is the include type: one of "include",
1183 // "input", "verbatiminput" or "verbatiminput*"
1185 // default type is requested
1187 InsetCommandParams p(INCLUDE_CODE, data);
1188 data = InsetCommandMailer::params2string("include", p);
1192 // \c data == "Boxed" || "Frameless" etc
1193 InsetBoxParams p(data);
1194 data = InsetBoxMailer::params2string(p);
1198 InsetBranchParams p;
1199 data = InsetBranchMailer::params2string(p);
1203 InsetCommandParams p(CITE_CODE);
1204 data = InsetCommandMailer::params2string(name, p);
1208 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1211 case EXTERNAL_CODE: {
1212 InsetExternalParams p;
1213 Buffer const & buffer = *lyx_view_->buffer();
1214 data = InsetExternalMailer::params2string(p, buffer);
1219 data = InsetFloatMailer::params2string(p);
1222 case LISTINGS_CODE: {
1223 InsetListingsParams p;
1224 data = InsetListingsMailer::params2string(p);
1227 case GRAPHICS_CODE: {
1228 InsetGraphicsParams p;
1229 Buffer const & buffer = *lyx_view_->buffer();
1230 data = InsetGraphicsMailer::params2string(p, buffer);
1235 data = InsetNoteMailer::params2string(p);
1240 data = InsetVSpaceMailer::params2string(space);
1245 data = InsetWrapMailer::params2string(p);
1249 lyxerr << "Inset type '" << name <<
1250 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1251 insetCodeOK = false;
1253 } // end switch(code)
1255 dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1259 case LFUN_CITATION_INSERT: {
1260 BOOST_ASSERT(lyx_view_);
1261 if (!argument.empty()) {
1262 // we can have one optional argument, delimited by '|'
1263 // citation-insert <key>|<text_before>
1264 // this should be enhanced to also support text_after
1265 // and citation style
1266 string arg = argument;
1268 if (contains(argument, "|")) {
1269 arg = token(argument, '|', 0);
1270 opt1 = token(argument, '|', 1);
1272 InsetCommandParams icp(CITE_CODE);
1273 icp["key"] = from_utf8(arg);
1275 icp["before"] = from_utf8(opt1);
1276 string icstr = InsetCommandMailer::params2string("citation", icp);
1277 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1280 dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1284 case LFUN_BUFFER_CHILD_OPEN: {
1285 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1286 Buffer * parent = lyx_view_->buffer();
1287 FileName filename = makeAbsPath(argument, parent->filePath());
1288 view()->saveBookmark(false);
1290 bool parsed = false;
1291 if (theBufferList().exists(filename.absFilename())) {
1292 child = theBufferList().getBuffer(filename.absFilename());
1294 setMessage(bformat(_("Opening child document %1$s..."),
1295 makeDisplayPath(filename.absFilename())));
1296 child = lyx_view_->loadDocument(filename, false);
1300 // Set the parent name of the child document.
1301 // This makes insertion of citations and references in the child work,
1302 // when the target is in the parent or another child document.
1303 child->setParent(parent);
1304 updateLabels(*child->masterBuffer());
1305 lyx_view_->setBuffer(child);
1307 child->errors("Parse");
1310 // If a screen update is required (in case where auto_open is false),
1311 // setBuffer() would have taken care of it already. Otherwise we shall
1312 // reset the update flag because it can cause a circular problem.
1314 updateFlags = Update::None;
1318 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1319 BOOST_ASSERT(lyx_view_);
1320 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1323 case LFUN_KEYMAP_OFF:
1324 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1325 lyx_view_->view()->getIntl().keyMapOn(false);
1328 case LFUN_KEYMAP_PRIMARY:
1329 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1330 lyx_view_->view()->getIntl().keyMapPrim();
1333 case LFUN_KEYMAP_SECONDARY:
1334 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1335 lyx_view_->view()->getIntl().keyMapSec();
1338 case LFUN_KEYMAP_TOGGLE:
1339 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
1340 lyx_view_->view()->getIntl().toggleKeyMap();
1346 string rest = split(argument, countstr, ' ');
1347 istringstream is(countstr);
1350 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1351 for (int i = 0; i < count; ++i)
1352 dispatch(lyxaction.lookupFunc(rest));
1356 case LFUN_COMMAND_SEQUENCE: {
1357 // argument contains ';'-terminated commands
1358 string arg = argument;
1359 while (!arg.empty()) {
1361 arg = split(arg, first, ';');
1362 FuncRequest func(lyxaction.lookupFunc(first));
1363 func.origin = cmd.origin;
1371 if (LyX::ref().topLevelCmdDef().lock(argument, func)) {
1372 func.origin = cmd.origin;
1374 LyX::ref().topLevelCmdDef().release(argument);
1376 if (func.action == LFUN_UNKNOWN_ACTION) {
1377 // unknown command definition
1378 lyxerr << "Warning: unknown command definition `"
1382 // recursion detected
1383 lyxerr << "Warning: Recursion in the command definition `"
1384 << argument << "' detected"
1391 case LFUN_PREFERENCES_SAVE: {
1392 lyxrc.write(makeAbsPath("preferences",
1393 package().user_support().absFilename()),
1398 case LFUN_SET_COLOR: {
1400 string const x11_name = split(argument, lyx_name, ' ');
1401 if (lyx_name.empty() || x11_name.empty()) {
1402 setErrorMessage(from_ascii(N_(
1403 "Syntax: set-color <lyx_name>"
1408 bool const graphicsbg_changed =
1409 (lyx_name == lcolor.getLyXName(Color_graphicsbg) &&
1410 x11_name != lcolor.getX11Name(Color_graphicsbg));
1412 if (!lcolor.setColor(lyx_name, x11_name)) {
1414 bformat(_("Set-color \"%1$s\" failed "
1415 "- color is undefined or "
1416 "may not be redefined"),
1417 from_utf8(lyx_name)));
1421 theApp()->updateColor(lcolor.getFromLyXName(lyx_name));
1423 if (graphicsbg_changed) {
1424 // FIXME: The graphics cache no longer has a changeDisplay method.
1426 graphics::GCache::get().changeDisplay(true);
1433 BOOST_ASSERT(lyx_view_);
1434 lyx_view_->message(from_utf8(argument));
1437 case LFUN_EXTERNAL_EDIT: {
1438 BOOST_ASSERT(lyx_view_);
1439 FuncRequest fr(action, argument);
1440 InsetExternal().dispatch(view()->cursor(), fr);
1444 case LFUN_GRAPHICS_EDIT: {
1445 FuncRequest fr(action, argument);
1446 InsetGraphics().dispatch(view()->cursor(), fr);
1450 case LFUN_ALL_INSETS_TOGGLE: {
1451 BOOST_ASSERT(lyx_view_);
1453 string const name = split(argument, action, ' ');
1454 InsetCode const inset_code = insetCode(name);
1456 Cursor & cur = view()->cursor();
1457 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1459 Inset & inset = lyx_view_->buffer()->inset();
1460 InsetIterator it = inset_iterator_begin(inset);
1461 InsetIterator const end = inset_iterator_end(inset);
1462 for (; it != end; ++it) {
1463 if (!it->asInsetMath()
1464 && (inset_code == NO_CODE
1465 || inset_code == it->lyxCode())) {
1466 Cursor tmpcur = cur;
1467 tmpcur.pushBackward(*it);
1468 it->dispatch(tmpcur, fr);
1471 updateFlags = Update::Force | Update::FitCursor;
1475 case LFUN_BUFFER_LANGUAGE: {
1476 BOOST_ASSERT(lyx_view_);
1477 Buffer & buffer = *lyx_view_->buffer();
1478 Language const * oldL = buffer.params().language;
1479 Language const * newL = languages.getLanguage(argument);
1480 if (!newL || oldL == newL)
1483 if (oldL->rightToLeft() == newL->rightToLeft()
1484 && !buffer.isMultiLingual())
1485 buffer.changeLanguage(oldL, newL);
1489 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1490 string const fname =
1491 addName(addPath(package().user_support().absFilename(), "templates/"),
1493 Buffer defaults(fname);
1495 istringstream ss(argument);
1498 int const unknown_tokens = defaults.readHeader(lex);
1500 if (unknown_tokens != 0) {
1501 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1502 << unknown_tokens << " unknown token"
1503 << (unknown_tokens == 1 ? "" : "s")
1507 if (defaults.writeFile(FileName(defaults.absFileName())))
1508 setMessage(bformat(_("Document defaults saved in %1$s"),
1509 makeDisplayPath(fname)));
1511 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
1515 case LFUN_BUFFER_PARAMS_APPLY: {
1516 BOOST_ASSERT(lyx_view_);
1518 Buffer * buffer = lyx_view_->buffer();
1519 DocumentClass * oldClass = buffer->params().documentClassPtr();
1520 Cursor & cur = view()->cursor();
1521 cur.recordUndoFullDocument();
1523 istringstream ss(argument);
1526 int const unknown_tokens = buffer->readHeader(lex);
1528 if (unknown_tokens != 0) {
1529 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1530 << unknown_tokens << " unknown token"
1531 << (unknown_tokens == 1 ? "" : "s")
1535 updateLayout(oldClass, buffer);
1537 updateFlags = Update::Force | Update::FitCursor;
1538 // We are most certainly here because of a change in the document
1539 // It is then better to make sure that all dialogs are in sync with
1540 // current document settings. LyXView::restartCursor() achieve this.
1541 lyx_view_->restartCursor();
1545 case LFUN_LAYOUT_MODULES_CLEAR: {
1546 BOOST_ASSERT(lyx_view_);
1547 Buffer * buffer = lyx_view_->buffer();
1548 DocumentClass * oldClass = buffer->params().documentClassPtr();
1549 view()->cursor().recordUndoFullDocument();
1550 buffer->params().clearLayoutModules();
1551 buffer->params().makeDocumentClass();
1552 updateLayout(oldClass, buffer);
1553 updateFlags = Update::Force | Update::FitCursor;
1557 case LFUN_LAYOUT_MODULE_ADD: {
1558 BOOST_ASSERT(lyx_view_);
1559 Buffer * buffer = lyx_view_->buffer();
1560 DocumentClass * oldClass = buffer->params().documentClassPtr();
1561 view()->cursor().recordUndoFullDocument();
1562 buffer->params().addLayoutModule(argument);
1563 buffer->params().makeDocumentClass();
1564 updateLayout(oldClass, buffer);
1565 updateFlags = Update::Force | Update::FitCursor;
1569 case LFUN_TEXTCLASS_APPLY: {
1570 BOOST_ASSERT(lyx_view_);
1571 Buffer * buffer = lyx_view_->buffer();
1573 if (!loadLayoutFile(argument, buffer->temppath()) &&
1574 !loadLayoutFile(argument, buffer->filePath()))
1577 LayoutFile const * old_layout = buffer->params().baseClass();
1578 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1580 if (old_layout == new_layout)
1584 //Save the old, possibly modular, layout for use in conversion.
1585 DocumentClass * oldDocClass = buffer->params().documentClassPtr();
1586 view()->cursor().recordUndoFullDocument();
1587 buffer->params().setBaseClass(argument);
1588 buffer->params().makeDocumentClass();
1589 updateLayout(oldDocClass, buffer);
1590 updateFlags = Update::Force | Update::FitCursor;
1594 case LFUN_LAYOUT_RELOAD: {
1595 BOOST_ASSERT(lyx_view_);
1596 Buffer * buffer = lyx_view_->buffer();
1597 DocumentClass * oldClass = buffer->params().documentClassPtr();
1598 LayoutFileIndex bc = buffer->params().baseClassID();
1599 LayoutFileList::get().reset(bc);
1600 buffer->params().makeDocumentClass();
1601 updateLayout(oldClass, buffer);
1602 updateFlags = Update::Force | Update::FitCursor;
1606 case LFUN_TEXTCLASS_LOAD:
1607 loadLayoutFile(argument, lyx_view_->buffer()->temppath()) ||
1608 loadLayoutFile(argument, lyx_view_->buffer()->filePath());
1611 case LFUN_LYXRC_APPLY: {
1612 LyXRC const lyxrc_orig = lyxrc;
1614 istringstream ss(argument);
1615 bool const success = lyxrc.read(ss) == 0;
1618 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1619 << "Unable to read lyxrc data"
1624 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1626 theApp()->resetGui();
1628 /// We force the redraw in any case because there might be
1629 /// some screen font changes.
1630 /// FIXME: only the current view will be updated. the Gui
1631 /// class is able to furnish the list of views.
1632 updateFlags = Update::Force;
1636 case LFUN_BOOKMARK_GOTO:
1637 // go to bookmark, open unopened file and switch to buffer if necessary
1638 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1639 updateFlags = Update::FitCursor;
1642 case LFUN_BOOKMARK_CLEAR:
1643 LyX::ref().session().bookmarks().clear();
1647 BOOST_ASSERT(theApp());
1648 // Let the frontend dispatch its own actions.
1649 if (theApp()->dispatch(cmd))
1650 // Nothing more to do.
1653 // Everything below is only for active lyx_view_
1657 // Let the current LyXView dispatch its own actions.
1658 if (lyx_view_->dispatch(cmd)) {
1659 if (lyx_view_->view())
1660 updateFlags = lyx_view_->view()->cursor().result().update();
1664 BOOST_ASSERT(lyx_view_->view());
1665 // Let the current BufferView dispatch its own actions.
1666 if (view()->dispatch(cmd)) {
1667 // The BufferView took care of its own updates if needed.
1668 updateFlags = Update::None;
1672 // Let the current Cursor dispatch its own actions.
1673 Cursor old = view()->cursor();
1674 view()->cursor().getPos(cursorPosBeforeDispatchX_,
1675 cursorPosBeforeDispatchY_);
1676 view()->cursor().dispatch(cmd);
1678 // notify insets we just left
1679 if (view()->cursor() != old) {
1681 bool badcursor = notifyCursorLeaves(old, view()->cursor());
1683 view()->cursor().fixIfBroken();
1686 // update completion. We do it here and not in
1687 // processKeySym to avoid another redraw just for a
1688 // changed inline completion
1689 if (cmd.origin == FuncRequest::KEYBOARD) {
1690 if (cmd.action == LFUN_SELF_INSERT)
1691 lyx_view_->updateCompletion(view()->cursor(), true, true);
1692 else if (cmd.action == LFUN_CHAR_DELETE_BACKWARD)
1693 lyx_view_->updateCompletion(view()->cursor(), false, true);
1695 lyx_view_->updateCompletion(view()->cursor(), false, false);
1698 updateFlags = view()->cursor().result().update();
1701 if (lyx_view_ && lyx_view_->buffer()) {
1702 // BufferView::update() updates the ViewMetricsInfo and
1703 // also initializes the position cache for all insets in
1704 // (at least partially) visible top-level paragraphs.
1705 // We will redraw the screen only if needed.
1706 view()->processUpdateFlags(updateFlags);
1708 // if we executed a mutating lfun, mark the buffer as dirty
1710 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1711 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1712 lyx_view_->buffer()->markDirty();
1714 // Do we have a selection?
1715 theSelection().haveSelection(view()->cursor().selection());
1718 lyx_view_->restartCursor();
1722 // Some messages may already be translated, so we cannot use _()
1723 sendDispatchMessage(translateIfPossible(getMessage()), cmd);
1728 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1730 const bool verbose = (cmd.origin == FuncRequest::MENU
1731 || cmd.origin == FuncRequest::TOOLBAR
1732 || cmd.origin == FuncRequest::COMMANDBUFFER);
1734 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1735 LYXERR(Debug::ACTION, "dispatch msg is " << to_utf8(msg));
1737 lyx_view_->message(msg);
1741 docstring dispatch_msg = msg;
1742 if (!dispatch_msg.empty())
1743 dispatch_msg += ' ';
1745 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1747 bool argsadded = false;
1749 if (!cmd.argument().empty()) {
1750 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1751 comname += ' ' + cmd.argument();
1756 docstring const shortcuts = theTopLevelKeymap().printBindings(cmd);
1758 if (!shortcuts.empty())
1759 comname += ": " + shortcuts;
1760 else if (!argsadded && !cmd.argument().empty())
1761 comname += ' ' + cmd.argument();
1763 if (!comname.empty()) {
1764 comname = rtrim(comname);
1765 dispatch_msg += '(' + rtrim(comname) + ')';
1768 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1769 if (!dispatch_msg.empty())
1770 lyx_view_->message(dispatch_msg);
1774 void LyXFunc::reloadBuffer()
1776 FileName filename = lyx_view_->buffer()->fileName();
1777 // The user has already confirmed that the changes, if any, should
1778 // be discarded. So we just release the Buffer and don't call closeBuffer();
1779 theBufferList().release(lyx_view_->buffer());
1780 Buffer * buf = lyx_view_->loadDocument(filename);
1781 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1785 lyx_view_->setBuffer(buf);
1786 buf->errors("Parse");
1787 str = bformat(_("Document %1$s reloaded."), disp_fn);
1789 str = bformat(_("Could not reload document %1$s"), disp_fn);
1791 lyx_view_->message(str);
1794 // Each "lyx_view_" should have it's own message method. lyxview and
1795 // the minibuffer would use the minibuffer, but lyxserver would
1796 // send an ERROR signal to its client. Alejandro 970603
1797 // This function is bit problematic when it comes to NLS, to make the
1798 // lyx servers client be language indepenent we must not translate
1799 // strings sent to this func.
1800 void LyXFunc::setErrorMessage(docstring const & m) const
1802 dispatch_buffer = m;
1807 void LyXFunc::setMessage(docstring const & m) const
1809 dispatch_buffer = m;
1813 docstring const LyXFunc::viewStatusMessage()
1815 // When meta-fake key is pressed, show the key sequence so far + "M-".
1817 return keyseq.print(KeySequence::ForGui) + "M-";
1819 // Else, when a non-complete key sequence is pressed,
1820 // show the available options.
1821 if (keyseq.length() > 0 && !keyseq.deleted())
1822 return keyseq.printOptions(true);
1824 BOOST_ASSERT(lyx_view_);
1825 if (!lyx_view_->buffer())
1826 return _("Welcome to LyX!");
1828 return view()->cursor().currentState();
1832 BufferView * LyXFunc::view() const
1834 BOOST_ASSERT(lyx_view_);
1835 return lyx_view_->view();
1839 bool LyXFunc::wasMetaKey() const
1841 return (meta_fake_bit != NoModifier);
1845 void LyXFunc::updateLayout(DocumentClass * oldlayout,Buffer * buffer)
1847 lyx_view_->message(_("Converting document to new document class..."));
1849 StableDocIterator backcur(view()->cursor());
1850 ErrorList & el = buffer->errorList("Class Switch");
1851 cap::switchBetweenClasses(
1852 oldlayout, buffer->params().documentClassPtr(),
1853 static_cast<InsetText &>(buffer->inset()), el);
1855 view()->setCursor(backcur.asDocIterator(&(buffer->inset())));
1857 buffer->errors("Class Switch");
1858 updateLabels(*buffer);
1864 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
1866 // Why the switch you might ask. It is a trick to ensure that all
1867 // the elements in the LyXRCTags enum is handled. As you can see
1868 // there are no breaks at all. So it is just a huge fall-through.
1869 // The nice thing is that we will get a warning from the compiler
1870 // if we forget an element.
1871 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
1873 case LyXRC::RC_ACCEPT_COMPOUND:
1874 case LyXRC::RC_ALT_LANG:
1875 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
1876 case LyXRC::RC_PLAINTEXT_LINELEN:
1877 case LyXRC::RC_AUTOREGIONDELETE:
1878 case LyXRC::RC_AUTORESET_OPTIONS:
1879 case LyXRC::RC_AUTOSAVE:
1880 case LyXRC::RC_AUTO_NUMBER:
1881 case LyXRC::RC_BACKUPDIR_PATH:
1882 case LyXRC::RC_BIBTEX_COMMAND:
1883 case LyXRC::RC_BINDFILE:
1884 case LyXRC::RC_CHECKLASTFILES:
1885 case LyXRC::RC_COMPLETION_INLINE_DELAY:
1886 case LyXRC::RC_COMPLETION_INLINE_DOTS:
1887 case LyXRC::RC_COMPLETION_INLINE_MATH:
1888 case LyXRC::RC_COMPLETION_INLINE_TEXT:
1889 case LyXRC::RC_COMPLETION_POPUP_AFTER_COMPLETE:
1890 case LyXRC::RC_COMPLETION_POPUP_DELAY:
1891 case LyXRC::RC_COMPLETION_POPUP_MATH:
1892 case LyXRC::RC_COMPLETION_POPUP_TEXT:
1893 case LyXRC::RC_USELASTFILEPOS:
1894 case LyXRC::RC_LOADSESSION:
1895 case LyXRC::RC_CHKTEX_COMMAND:
1896 case LyXRC::RC_CONVERTER:
1897 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
1898 case LyXRC::RC_COPIER:
1899 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
1900 case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
1901 case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
1902 case LyXRC::RC_DATE_INSERT_FORMAT:
1903 case LyXRC::RC_DEFAULT_LANGUAGE:
1904 case LyXRC::RC_DEFAULT_PAPERSIZE:
1905 case LyXRC::RC_DEFFILE:
1906 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
1907 case LyXRC::RC_DISPLAY_GRAPHICS:
1908 case LyXRC::RC_DOCUMENTPATH:
1909 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
1910 FileName path(lyxrc_new.document_path);
1911 if (path.exists() && path.isDirectory())
1912 package().document_dir() = FileName(lyxrc.document_path);
1914 case LyXRC::RC_ESC_CHARS:
1915 case LyXRC::RC_EXAMPLEPATH:
1916 case LyXRC::RC_FONT_ENCODING:
1917 case LyXRC::RC_FORMAT:
1918 case LyXRC::RC_GROUP_LAYOUTS:
1919 case LyXRC::RC_INDEX_COMMAND:
1920 case LyXRC::RC_INPUT:
1921 case LyXRC::RC_KBMAP:
1922 case LyXRC::RC_KBMAP_PRIMARY:
1923 case LyXRC::RC_KBMAP_SECONDARY:
1924 case LyXRC::RC_LABEL_INIT_LENGTH:
1925 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
1926 case LyXRC::RC_LANGUAGE_AUTO_END:
1927 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
1928 case LyXRC::RC_LANGUAGE_COMMAND_END:
1929 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
1930 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
1931 case LyXRC::RC_LANGUAGE_PACKAGE:
1932 case LyXRC::RC_LANGUAGE_USE_BABEL:
1933 case LyXRC::RC_MACRO_EDIT_STYLE:
1934 case LyXRC::RC_MAKE_BACKUP:
1935 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
1936 case LyXRC::RC_MOUSE_WHEEL_SPEED:
1937 case LyXRC::RC_NUMLASTFILES:
1938 case LyXRC::RC_PATH_PREFIX:
1939 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
1940 prependEnvPath("PATH", lyxrc.path_prefix);
1942 case LyXRC::RC_PERS_DICT:
1943 case LyXRC::RC_PREVIEW:
1944 case LyXRC::RC_PREVIEW_HASHED_LABELS:
1945 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
1946 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
1947 case LyXRC::RC_PRINTCOPIESFLAG:
1948 case LyXRC::RC_PRINTER:
1949 case LyXRC::RC_PRINTEVENPAGEFLAG:
1950 case LyXRC::RC_PRINTEXSTRAOPTIONS:
1951 case LyXRC::RC_PRINTFILEEXTENSION:
1952 case LyXRC::RC_PRINTLANDSCAPEFLAG:
1953 case LyXRC::RC_PRINTODDPAGEFLAG:
1954 case LyXRC::RC_PRINTPAGERANGEFLAG:
1955 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
1956 case LyXRC::RC_PRINTPAPERFLAG:
1957 case LyXRC::RC_PRINTREVERSEFLAG:
1958 case LyXRC::RC_PRINTSPOOL_COMMAND:
1959 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
1960 case LyXRC::RC_PRINTTOFILE:
1961 case LyXRC::RC_PRINTTOPRINTER:
1962 case LyXRC::RC_PRINT_ADAPTOUTPUT:
1963 case LyXRC::RC_PRINT_COMMAND:
1964 case LyXRC::RC_RTL_SUPPORT:
1965 case LyXRC::RC_SCREEN_DPI:
1966 case LyXRC::RC_SCREEN_FONT_ROMAN:
1967 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
1968 case LyXRC::RC_SCREEN_FONT_SANS:
1969 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
1970 case LyXRC::RC_SCREEN_FONT_SCALABLE:
1971 case LyXRC::RC_SCREEN_FONT_SIZES:
1972 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
1973 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
1974 case LyXRC::RC_GEOMETRY_SESSION:
1975 case LyXRC::RC_SCREEN_ZOOM:
1976 case LyXRC::RC_SERVERPIPE:
1977 case LyXRC::RC_SET_COLOR:
1978 case LyXRC::RC_SHOW_BANNER:
1979 case LyXRC::RC_OPEN_BUFFERS_IN_TABS:
1980 case LyXRC::RC_SPELL_COMMAND:
1981 case LyXRC::RC_TEMPDIRPATH:
1982 case LyXRC::RC_TEMPLATEPATH:
1983 case LyXRC::RC_TEX_ALLOWS_SPACES:
1984 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
1985 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
1986 os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
1988 case LyXRC::RC_UIFILE:
1989 case LyXRC::RC_USER_EMAIL:
1990 case LyXRC::RC_USER_NAME:
1991 case LyXRC::RC_USETEMPDIR:
1992 case LyXRC::RC_USE_ALT_LANG:
1993 case LyXRC::RC_USE_CONVERTER_CACHE:
1994 case LyXRC::RC_USE_ESC_CHARS:
1995 case LyXRC::RC_USE_INP_ENC:
1996 case LyXRC::RC_USE_PERS_DICT:
1997 case LyXRC::RC_USE_TOOLTIP:
1998 case LyXRC::RC_USE_PIXMAP_CACHE:
1999 case LyXRC::RC_USE_SPELL_LIB:
2000 case LyXRC::RC_VIEWDVI_PAPEROPTION:
2001 case LyXRC::RC_SORT_LAYOUTS:
2002 case LyXRC::RC_FULL_SCREEN_LIMIT:
2003 case LyXRC::RC_FULL_SCREEN_SCROLLBAR:
2004 case LyXRC::RC_FULL_SCREEN_TABBAR:
2005 case LyXRC::RC_FULL_SCREEN_TOOLBARS:
2006 case LyXRC::RC_FULL_SCREEN_WIDTH:
2007 case LyXRC::RC_VISUAL_CURSOR:
2008 case LyXRC::RC_VIEWER:
2009 case LyXRC::RC_LAST: