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/InsetGraphics.h"
66 #include "insets/InsetInclude.h"
67 #include "insets/InsetListings.h"
68 #include "insets/InsetNote.h"
69 #include "insets/InsetPhantom.h"
70 #include "insets/InsetSpace.h"
71 #include "insets/InsetTabular.h"
72 #include "insets/InsetVSpace.h"
73 #include "insets/InsetWrap.h"
75 #include "frontends/alert.h"
76 #include "frontends/Application.h"
77 #include "frontends/KeySymbol.h"
78 #include "frontends/LyXView.h"
79 #include "frontends/Selection.h"
81 #include "support/debug.h"
82 #include "support/environment.h"
83 #include "support/FileName.h"
84 #include "support/filetools.h"
85 #include "support/gettext.h"
86 #include "support/lstrings.h"
87 #include "support/Path.h"
88 #include "support/Package.h"
89 #include "support/Systemcall.h"
90 #include "support/convert.h"
91 #include "support/os.h"
97 using namespace lyx::support;
101 using frontend::LyXView;
103 namespace Alert = frontend::Alert;
108 // This function runs "configure" and then rereads lyx.defaults to
109 // reconfigure the automatic settings.
110 void reconfigure(LyXView * lv, string const & option)
112 // emit message signal.
114 lv->message(_("Running configure..."));
116 // Run configure in user lyx directory
117 PathChanger p(package().user_support());
118 string configure_command = package().configure_command();
119 configure_command += option;
121 int ret = one.startscript(Systemcall::Wait, configure_command);
123 // emit message signal.
125 lv->message(_("Reloading configuration..."));
126 lyxrc.read(libFileSearch(string(), "lyxrc.defaults"));
127 // Re-read packages.lst
128 LaTeXFeatures::getAvailable();
131 Alert::information(_("System reconfiguration failed"),
132 _("The system reconfiguration has failed.\n"
133 "Default textclass is used but LyX may "
134 "not be able to work properly.\n"
135 "Please reconfigure again if needed."));
138 Alert::information(_("System reconfigured"),
139 _("The system has been reconfigured.\n"
140 "You need to restart LyX to make use of any\n"
141 "updated document class specifications."));
145 bool getLocalStatus(Cursor cursor, FuncRequest const & cmd, FuncStatus & status)
147 // Try to fix cursor in case it is broken.
148 cursor.fixIfBroken();
150 // This is, of course, a mess. Better create a new doc iterator and use
151 // this in Inset::getStatus. This might require an additional
152 // BufferView * arg, though (which should be avoided)
153 //Cursor safe = *this;
155 for ( ; cursor.depth(); cursor.pop()) {
156 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
157 LASSERT(cursor.idx() <= cursor.lastidx(), /**/);
158 LASSERT(cursor.pit() <= cursor.lastpit(), /**/);
159 LASSERT(cursor.pos() <= cursor.lastpos(), /**/);
161 // The inset's getStatus() will return 'true' if it made
162 // a definitive decision on whether it want to handle the
163 // request or not. The result of this decision is put into
164 // the 'status' parameter.
165 if (cursor.inset().getStatus(cursor, cmd, status)) {
174 /** Return the change status at cursor position, taking in account the
175 * status at each level of the document iterator (a table in a deleted
176 * footnote is deleted).
177 * When \param outer is true, the top slice is not looked at.
179 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
181 size_t const depth = dit.depth() - (outer ? 1 : 0);
183 for (size_t i = 0 ; i < depth ; ++i) {
184 CursorSlice const & slice = dit[i];
185 if (!slice.inset().inMathed()
186 && slice.pos() < slice.paragraph().size()) {
187 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
188 if (ch != Change::UNCHANGED)
192 return Change::UNCHANGED;
199 : lyx_view_(0), encoded_last_key(0), meta_fake_bit(NoModifier)
204 void LyXFunc::initKeySequences(KeyMap * kb)
206 keyseq = KeySequence(kb, kb);
207 cancel_meta_seq = KeySequence(kb, kb);
211 void LyXFunc::setLyXView(LyXView * lv)
213 if (lyx_view_ && lyx_view_->view() && lyx_view_ != lv)
214 // save current selection to the selection buffer to allow
215 // middle-button paste in another window
216 cap::saveSelection(lyx_view_->view()->cursor());
221 void LyXFunc::handleKeyFunc(FuncCode action)
223 char_type c = encoded_last_key;
228 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
229 lyx_view_->view()->getIntl().getTransManager().deadkey(
230 c, get_accent(action).accent, view()->cursor().innerText(), view()->cursor());
231 // Need to clear, in case the minibuffer calls these
234 // copied verbatim from do_accent_char
235 view()->cursor().resetAnchor();
236 view()->processUpdateFlags(Update::FitCursor);
239 //FIXME: bookmark handling is a frontend issue. This code should be transferred
240 // to GuiView and be GuiView and be window dependent.
241 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
243 LASSERT(lyx_view_, /**/);
244 if (!theSession().bookmarks().isValid(idx))
246 BookmarksSection::Bookmark const & bm = theSession().bookmarks().bookmark(idx);
247 LASSERT(!bm.filename.empty(), /**/);
248 string const file = bm.filename.absFilename();
249 // if the file is not opened, open it.
250 if (!theBufferList().exists(bm.filename)) {
252 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
256 // open may fail, so we need to test it again
257 if (!theBufferList().exists(bm.filename))
260 // bm can be changed when saving
261 BookmarksSection::Bookmark tmp = bm;
263 // Special case idx == 0 used for back-from-back jump navigation
265 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
267 // if the current buffer is not that one, switch to it.
268 if (!lyx_view_->buffer() || lyx_view_->buffer()->fileName() != tmp.filename) {
271 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
274 // moveToPosition try paragraph id first and then paragraph (pit, pos).
275 if (!view()->moveToPosition(tmp.bottom_pit, tmp.bottom_pos,
276 tmp.top_id, tmp.top_pos))
283 // Cursor jump succeeded!
284 Cursor const & cur = view()->cursor();
285 pit_type new_pit = cur.pit();
286 pos_type new_pos = cur.pos();
287 int new_id = cur.paragraph().id();
289 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
290 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
291 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
292 || bm.top_id != new_id) {
293 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
294 new_pit, new_pos, new_id);
299 void LyXFunc::processKeySym(KeySymbol const & keysym, KeyModifier state)
301 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
303 // Do nothing if we have nothing (JMarc)
304 if (!keysym.isOK()) {
305 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
306 lyx_view_->restartCursor();
310 if (keysym.isModifier()) {
311 LYXERR(Debug::KEY, "isModifier true");
313 lyx_view_->restartCursor();
317 //Encoding const * encoding = view()->cursor().getEncoding();
318 //encoded_last_key = keysym.getISOEncoded(encoding ? encoding->name() : "");
319 // FIXME: encoded_last_key shadows the member variable of the same
320 // name. Is that intended?
321 char_type encoded_last_key = keysym.getUCSEncoded();
323 // Do a one-deep top-level lookup for
324 // cancel and meta-fake keys. RVDK_PATCH_5
325 cancel_meta_seq.reset();
327 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
328 LYXERR(Debug::KEY, "action first set to [" << func.action << ']');
330 // When not cancel or meta-fake, do the normal lookup.
331 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
332 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
333 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
334 // remove Caps Lock and Mod2 as a modifiers
335 func = keyseq.addkey(keysym, (state | meta_fake_bit));
336 LYXERR(Debug::KEY, "action now set to [" << func.action << ']');
339 // Dont remove this unless you know what you are doing.
340 meta_fake_bit = NoModifier;
342 // Can this happen now ?
343 if (func.action == LFUN_NOACTION)
344 func = FuncRequest(LFUN_COMMAND_PREFIX);
346 LYXERR(Debug::KEY, " Key [action=" << func.action << "]["
347 << keyseq.print(KeySequence::Portable) << ']');
349 // already here we know if it any point in going further
350 // why not return already here if action == -1 and
351 // num_bytes == 0? (Lgb)
353 if (keyseq.length() > 1)
354 lyx_view_->message(keyseq.print(KeySequence::ForGui));
357 // Maybe user can only reach the key via holding down shift.
358 // Let's see. But only if shift is the only modifier
359 if (func.action == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
360 LYXERR(Debug::KEY, "Trying without shift");
361 func = keyseq.addkey(keysym, NoModifier);
362 LYXERR(Debug::KEY, "Action now " << func.action);
365 if (func.action == LFUN_UNKNOWN_ACTION) {
366 // Hmm, we didn't match any of the keysequences. See
367 // if it's normal insertable text not already covered
369 if (keysym.isText() && keyseq.length() == 1) {
370 LYXERR(Debug::KEY, "isText() is true, inserting.");
371 func = FuncRequest(LFUN_SELF_INSERT,
372 FuncRequest::KEYBOARD);
374 LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
375 lyx_view_->message(_("Unknown function."));
376 lyx_view_->restartCursor();
381 if (func.action == LFUN_SELF_INSERT) {
382 if (encoded_last_key != 0) {
383 docstring const arg(1, encoded_last_key);
384 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
385 FuncRequest::KEYBOARD));
386 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
396 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
398 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
401 Buffer * buf = lyx_view_ ? lyx_view_->buffer() : 0;
403 if (cmd.action == LFUN_NOACTION) {
404 flag.message(from_utf8(N_("Nothing to do")));
405 flag.setEnabled(false);
409 switch (cmd.action) {
410 case LFUN_UNKNOWN_ACTION:
412 flag.setEnabled(false);
419 if (flag.unknown()) {
420 flag.message(from_utf8(N_("Unknown action")));
424 if (!flag.enabled()) {
425 if (flag.message().empty())
426 flag.message(from_utf8(N_("Command disabled")));
430 // Check whether we need a buffer
431 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
433 flag.message(from_utf8(N_("Command not allowed with"
434 "out any document open")));
435 flag.setEnabled(false);
439 // I would really like to avoid having this switch and rather try to
440 // encode this in the function itself.
441 // -- And I'd rather let an inset decide which LFUNs it is willing
442 // to handle (Andre')
444 switch (cmd.action) {
446 case LFUN_BUFFER_TOGGLE_READ_ONLY:
447 flag.setOnOff(buf->isReadonly());
450 case LFUN_BUFFER_SWITCH:
451 // toggle on the current buffer, but do not toggle off
452 // the other ones (is that a good idea?)
453 if (buf && to_utf8(cmd.argument()) == buf->absFileName())
457 case LFUN_BUFFER_CHKTEX:
458 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
461 case LFUN_BUILD_PROGRAM:
462 enable = buf->isExportable("program");
465 case LFUN_VC_REGISTER:
466 enable = !buf->lyxvc().inUse();
468 case LFUN_VC_CHECK_IN:
469 enable = buf->lyxvc().checkInEnabled();
471 case LFUN_VC_CHECK_OUT:
472 enable = buf->lyxvc().checkOutEnabled();
474 case LFUN_VC_LOCKING_TOGGLE:
475 enable = !buf->isReadonly() && buf->lyxvc().lockingToggleEnabled();
476 flag.setOnOff(enable && !buf->lyxvc().locker().empty());
479 enable = buf->lyxvc().inUse();
481 case LFUN_VC_UNDO_LAST:
482 enable = buf->lyxvc().undoLastEnabled();
484 case LFUN_BUFFER_RELOAD:
485 enable = !buf->isUnnamed() && buf->fileName().exists()
486 && (!buf->isClean() || buf->isExternallyModified(Buffer::timestamp_method));
489 case LFUN_CITATION_INSERT: {
490 FuncRequest fr(LFUN_INSET_INSERT, "citation");
491 enable = getStatus(fr).enabled();
495 // This could be used for the no-GUI version. The GUI version is handled in
496 // LyXView::getStatus(). See above.
498 case LFUN_BUFFER_WRITE:
499 case LFUN_BUFFER_WRITE_AS: {
500 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
501 enable = b && (b->isUnnamed() || !b->isClean());
506 case LFUN_BUFFER_WRITE_ALL: {
507 // We enable the command only if there are some modified buffers
508 Buffer * first = theBufferList().first();
513 // We cannot use a for loop as the buffer list is a cycle.
519 b = theBufferList().next(b);
520 } while (b != first);
524 case LFUN_BOOKMARK_GOTO: {
525 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
526 enable = theSession().bookmarks().isValid(num);
530 case LFUN_BOOKMARK_CLEAR:
531 enable = theSession().bookmarks().hasValid();
534 // this one is difficult to get right. As a half-baked
535 // solution, we consider only the first action of the sequence
536 case LFUN_COMMAND_SEQUENCE: {
537 // argument contains ';'-terminated commands
538 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
539 FuncRequest func(lyxaction.lookupFunc(firstcmd));
540 func.origin = cmd.origin;
541 flag = getStatus(func);
545 // we want to check if at least one of these is enabled
546 case LFUN_COMMAND_ALTERNATIVES: {
547 // argument contains ';'-terminated commands
548 string arg = to_utf8(cmd.argument());
549 while (!arg.empty()) {
551 arg = split(arg, first, ';');
552 FuncRequest func(lyxaction.lookupFunc(first));
553 func.origin = cmd.origin;
554 flag = getStatus(func);
555 // if this one is enabled, the whole thing is
564 string name = to_utf8(cmd.argument());
565 if (theTopLevelCmdDef().lock(name, func)) {
566 func.origin = cmd.origin;
567 flag = getStatus(func);
568 theTopLevelCmdDef().release(name);
570 // catch recursion or unknown command
571 // definition. all operations until the
572 // recursion or unknown command definition
573 // occurs are performed, so set the state to
580 case LFUN_VC_COMMAND: {
581 if (cmd.argument().empty())
584 if (!buf && contains(cmd.getArg(0), 'D'))
589 case LFUN_MASTER_BUFFER_UPDATE:
590 case LFUN_MASTER_BUFFER_VIEW:
591 if (!buf->parent()) {
595 case LFUN_BUFFER_UPDATE:
596 case LFUN_BUFFER_VIEW: {
597 string format = to_utf8(cmd.argument());
598 if (cmd.argument().empty())
599 format = buf->getDefaultOutputFormat();
600 typedef vector<Format const *> Formats;
602 formats = buf->exportableFormats(true);
603 Formats::const_iterator fit = formats.begin();
604 Formats::const_iterator end = formats.end();
606 for (; fit != end ; ++fit) {
607 if ((*fit)->name() == format)
613 case LFUN_WORD_FIND_FORWARD:
614 case LFUN_WORD_FIND_BACKWARD:
615 case LFUN_WORD_FINDADV:
616 case LFUN_COMMAND_PREFIX:
617 case LFUN_COMMAND_EXECUTE:
619 case LFUN_META_PREFIX:
620 case LFUN_BUFFER_CLOSE:
621 case LFUN_BUFFER_IMPORT:
622 case LFUN_BUFFER_AUTO_SAVE:
623 case LFUN_RECONFIGURE:
625 case LFUN_DROP_LAYOUTS_CHOICE:
627 case LFUN_SERVER_GET_FILENAME:
628 case LFUN_SERVER_NOTIFY:
629 case LFUN_SERVER_GOTO_FILE_ROW:
630 case LFUN_DIALOG_HIDE:
631 case LFUN_DIALOG_DISCONNECT_INSET:
632 case LFUN_BUFFER_CHILD_OPEN:
633 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
634 case LFUN_KEYMAP_OFF:
635 case LFUN_KEYMAP_PRIMARY:
636 case LFUN_KEYMAP_SECONDARY:
637 case LFUN_KEYMAP_TOGGLE:
639 case LFUN_BUFFER_EXPORT_CUSTOM:
640 case LFUN_PREFERENCES_SAVE:
642 case LFUN_INSET_EDIT:
643 case LFUN_BUFFER_LANGUAGE:
644 case LFUN_TEXTCLASS_APPLY:
645 case LFUN_TEXTCLASS_LOAD:
646 case LFUN_BUFFER_SAVE_AS_DEFAULT:
647 case LFUN_BUFFER_PARAMS_APPLY:
648 case LFUN_LAYOUT_MODULES_CLEAR:
649 case LFUN_LAYOUT_MODULE_ADD:
650 case LFUN_LAYOUT_RELOAD:
651 case LFUN_LYXRC_APPLY:
652 case LFUN_BUFFER_NEXT:
653 case LFUN_BUFFER_PREVIOUS:
654 // these are handled in our dispatch()
662 if (theApp()->getStatus(cmd, flag))
665 // Does the view know something?
670 if (lyx_view_->getStatus(cmd, flag))
673 // If we do not have a BufferView, then other functions are disabled
679 // Is this a function that acts on inset at point?
680 Inset * inset = view()->cursor().nextInset();
681 if (lyxaction.funcHasFlag(cmd.action, LyXAction::AtPoint)
682 && inset && inset->getStatus(view()->cursor(), cmd, flag))
685 bool decided = getLocalStatus(view()->cursor(), cmd, flag);
687 // try the BufferView
688 decided = view()->getStatus(cmd, flag);
691 view()->buffer().getStatus(cmd, flag);
695 flag.setEnabled(false);
697 // Can we use a readonly buffer?
698 if (buf && buf->isReadonly()
699 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
700 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
701 flag.message(from_utf8(N_("Document is read-only")));
702 flag.setEnabled(false);
705 // Are we in a DELETED change-tracking region?
707 && lookupChangeType(view()->cursor(), true) == Change::DELETED
708 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
709 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
710 flag.message(from_utf8(N_("This portion of the document is deleted.")));
711 flag.setEnabled(false);
714 // the default error message if we disable the command
715 if (!flag.enabled() && flag.message().empty())
716 flag.message(from_utf8(N_("Command disabled")));
722 bool LyXFunc::ensureBufferClean(BufferView * bv)
724 Buffer & buf = bv->buffer();
725 if (buf.isClean() && !buf.isUnnamed())
728 docstring const file = buf.fileName().displayName(30);
731 if (!buf.isUnnamed()) {
732 text = bformat(_("The document %1$s has unsaved "
733 "changes.\n\nDo you want to save "
734 "the document?"), file);
735 title = _("Save changed document?");
738 text = bformat(_("The document %1$s has not been "
739 "saved yet.\n\nDo you want to save "
740 "the document?"), file);
741 title = _("Save new document?");
743 int const ret = Alert::prompt(title, text, 0, 1, _("&Save"), _("&Cancel"));
746 lyx_view_->dispatch(FuncRequest(LFUN_BUFFER_WRITE));
748 return buf.isClean() && !buf.isUnnamed();
754 bool loadLayoutFile(string const & name, string const & buf_path)
756 if (!LayoutFileList::get().haveClass(name)) {
757 lyxerr << "Document class \"" << name
758 << "\" does not exist."
763 LayoutFile & tc = LayoutFileList::get()[name];
764 if (!tc.load(buf_path)) {
765 docstring s = bformat(_("The document class %1$s "
766 "could not be loaded."), from_utf8(name));
767 Alert::error(_("Could not load class"), s);
774 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
779 void LyXFunc::dispatch(FuncRequest const & cmd)
781 string const argument = to_utf8(cmd.argument());
782 FuncCode const action = cmd.action;
784 LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
785 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
787 // we have not done anything wrong yet.
789 dispatch_buffer.erase();
791 // redraw the screen at the end (first of the two drawing steps).
792 //This is done unless explicitely requested otherwise
793 Update::flags updateFlags = Update::FitCursor;
795 FuncStatus const flag = getStatus(cmd);
796 if (!flag.enabled()) {
797 // We cannot use this function here
798 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
799 << lyxaction.getActionName(action)
800 << " [" << action << "] is disabled at this location");
801 setErrorMessage(flag.message());
803 lyx_view_->restartCursor();
805 Buffer * buffer = lyx_view_ ? lyx_view_->buffer() : 0;
808 case LFUN_WORD_FIND_FORWARD:
809 case LFUN_WORD_FIND_BACKWARD: {
810 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
811 static docstring last_search;
812 docstring searched_string;
814 if (!cmd.argument().empty()) {
815 last_search = cmd.argument();
816 searched_string = cmd.argument();
818 searched_string = last_search;
821 if (searched_string.empty())
824 bool const fw = action == LFUN_WORD_FIND_FORWARD;
825 docstring const data =
826 find2string(searched_string, true, false, fw);
827 find(view(), FuncRequest(LFUN_WORD_FIND, data));
831 case LFUN_COMMAND_PREFIX:
832 LASSERT(lyx_view_, /**/);
833 lyx_view_->message(keyseq.printOptions(true));
837 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
839 meta_fake_bit = NoModifier;
841 // cancel any selection
842 dispatch(FuncRequest(LFUN_MARK_OFF));
843 setMessage(from_ascii(N_("Cancel")));
846 case LFUN_META_PREFIX:
847 meta_fake_bit = AltModifier;
848 setMessage(keyseq.print(KeySequence::ForGui));
851 case LFUN_BUFFER_TOGGLE_READ_ONLY: {
852 LASSERT(lyx_view_ && lyx_view_->view() && buffer, /**/);
853 if (buffer->lyxvc().inUse())
854 buffer->lyxvc().toggleReadOnly();
856 buffer->setReadonly(!buffer->isReadonly());
860 // --- Menus -----------------------------------------------
861 case LFUN_BUFFER_CLOSE:
862 lyx_view_->closeBuffer();
864 updateFlags = Update::None;
867 case LFUN_BUFFER_RELOAD: {
868 LASSERT(lyx_view_ && buffer, /**/);
869 docstring const file = makeDisplayPath(buffer->absFileName(), 20);
870 docstring text = bformat(_("Any changes will be lost. Are you sure "
871 "you want to revert to the saved version of the document %1$s?"), file);
872 int const ret = Alert::prompt(_("Revert to saved document?"),
873 text, 1, 1, _("&Revert"), _("&Cancel"));
880 case LFUN_BUFFER_UPDATE: {
881 LASSERT(lyx_view_ && buffer, /**/);
882 string format = argument;
883 if (argument.empty())
884 format = buffer->getDefaultOutputFormat();
885 buffer->doExport(format, true);
889 case LFUN_BUFFER_VIEW: {
890 LASSERT(lyx_view_ && buffer, /**/);
891 string format = argument;
892 if (argument.empty())
893 format = buffer->getDefaultOutputFormat();
894 buffer->preview(format);
898 case LFUN_MASTER_BUFFER_UPDATE: {
899 LASSERT(lyx_view_ && buffer && buffer->masterBuffer(), /**/);
900 string format = argument;
901 if (argument.empty())
902 format = buffer->masterBuffer()->getDefaultOutputFormat();
903 buffer->masterBuffer()->doExport(format, true);
907 case LFUN_MASTER_BUFFER_VIEW: {
908 LASSERT(lyx_view_ && buffer && buffer->masterBuffer(), /**/);
909 string format = argument;
910 if (argument.empty())
911 format = buffer->masterBuffer()->getDefaultOutputFormat();
912 buffer->masterBuffer()->preview(format);
916 case LFUN_BUILD_PROGRAM:
917 LASSERT(lyx_view_ && buffer, /**/);
918 buffer->doExport("program", true);
921 case LFUN_BUFFER_CHKTEX:
922 LASSERT(lyx_view_ && buffer, /**/);
926 case LFUN_BUFFER_EXPORT:
927 LASSERT(lyx_view_ && buffer, /**/);
928 if (argument == "custom")
929 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"));
931 buffer->doExport(argument, false);
934 case LFUN_BUFFER_EXPORT_CUSTOM: {
935 LASSERT(lyx_view_ && buffer, /**/);
937 string command = split(argument, format_name, ' ');
938 Format const * format = formats.getFormat(format_name);
940 lyxerr << "Format \"" << format_name
941 << "\" not recognized!"
946 // The name of the file created by the conversion process
949 // Output to filename
950 if (format->name() == "lyx") {
951 string const latexname = buffer->latexName(false);
952 filename = changeExtension(latexname,
953 format->extension());
954 filename = addName(buffer->temppath(), filename);
956 if (!buffer->writeFile(FileName(filename)))
960 buffer->doExport(format_name, true, filename);
963 // Substitute $$FName for filename
964 if (!contains(command, "$$FName"))
965 command = "( " + command + " ) < $$FName";
966 command = subst(command, "$$FName", filename);
968 // Execute the command in the background
970 call.startscript(Systemcall::DontWait, command);
974 // FIXME: There is need for a command-line import.
976 case LFUN_BUFFER_IMPORT:
981 case LFUN_BUFFER_AUTO_SAVE:
985 case LFUN_RECONFIGURE:
986 // argument is any additional parameter to the configure.py command
987 reconfigure(lyx_view_, argument);
990 case LFUN_HELP_OPEN: {
992 theApp()->dispatch(FuncRequest(LFUN_WINDOW_NEW));
993 string const arg = argument;
995 setErrorMessage(from_utf8(N_("Missing argument")));
998 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
1000 fname = i18nLibFileSearch("examples", arg, "lyx");
1002 if (fname.empty()) {
1003 lyxerr << "LyX: unable to find documentation file `"
1004 << arg << "'. Bad installation?" << endl;
1007 lyx_view_->message(bformat(_("Opening help file %1$s..."),
1008 makeDisplayPath(fname.absFilename())));
1009 Buffer * buf = lyx_view_->loadDocument(fname, false);
1011 buf->updateLabels();
1012 lyx_view_->setBuffer(buf);
1013 buf->errors("Parse");
1015 updateFlags = Update::None;
1019 // --- version control -------------------------------
1020 case LFUN_VC_REGISTER:
1021 LASSERT(lyx_view_ && buffer, /**/);
1022 if (!ensureBufferClean(view()))
1024 if (!buffer->lyxvc().inUse()) {
1025 if (buffer->lyxvc().registrer())
1028 updateFlags = Update::Force;
1031 case LFUN_VC_CHECK_IN:
1032 LASSERT(lyx_view_ && buffer, /**/);
1033 if (!ensureBufferClean(view()))
1035 if (buffer->lyxvc().inUse()
1036 && !buffer->isReadonly()) {
1037 setMessage(from_utf8(buffer->lyxvc().checkIn()));
1042 case LFUN_VC_CHECK_OUT:
1043 LASSERT(lyx_view_ && buffer, /**/);
1044 if (!ensureBufferClean(view()))
1046 if (buffer->lyxvc().inUse()) {
1047 setMessage(from_utf8(buffer->lyxvc().checkOut()));
1052 case LFUN_VC_LOCKING_TOGGLE:
1053 LASSERT(lyx_view_ && buffer, /**/);
1054 if (!ensureBufferClean(view()) || buffer->isReadonly())
1056 if (buffer->lyxvc().inUse()) {
1057 string res = buffer->lyxvc().lockingToggle();
1059 frontend::Alert::error(_("Revision control error."),
1060 _("Error when setting the locking property."));
1062 setMessage(from_utf8(res));
1068 case LFUN_VC_REVERT:
1069 LASSERT(lyx_view_ && buffer, /**/);
1070 buffer->lyxvc().revert();
1074 case LFUN_VC_UNDO_LAST:
1075 LASSERT(lyx_view_ && buffer, /**/);
1076 buffer->lyxvc().undoLast();
1080 // --- lyxserver commands ----------------------------
1081 case LFUN_SERVER_GET_FILENAME:
1082 LASSERT(lyx_view_ && buffer, /**/);
1083 setMessage(from_utf8(buffer->absFileName()));
1084 LYXERR(Debug::INFO, "FNAME["
1085 << buffer->absFileName() << ']');
1088 case LFUN_SERVER_NOTIFY:
1089 dispatch_buffer = keyseq.print(KeySequence::Portable);
1090 theServer().notifyClient(to_utf8(dispatch_buffer));
1093 case LFUN_SERVER_GOTO_FILE_ROW: {
1094 LASSERT(lyx_view_, /**/);
1097 istringstream is(argument);
1098 is >> file_name >> row;
1100 bool loaded = false;
1101 string const abstmp = package().temp_dir().absFilename();
1102 string const realtmp = package().temp_dir().realPath();
1103 // We have to use os::path_prefix_is() here, instead of
1104 // simply prefixIs(), because the file name comes from
1105 // an external application and may need case adjustment.
1106 if (os::path_prefix_is(file_name, abstmp, os::CASE_ADJUSTED)
1107 || os::path_prefix_is(file_name, realtmp, os::CASE_ADJUSTED)) {
1108 // Needed by inverse dvi search. If it is a file
1109 // in tmpdir, call the apropriated function.
1110 // If tmpdir is a symlink, we may have the real
1111 // path passed back, so we correct for that.
1112 if (!prefixIs(file_name, abstmp))
1113 file_name = subst(file_name, realtmp, abstmp);
1114 buf = theBufferList().getBufferFromTmp(file_name);
1116 // Must replace extension of the file to be .lyx
1117 // and get full path
1118 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1119 // Either change buffer or load the file
1120 if (theBufferList().exists(s))
1121 buf = theBufferList().getBuffer(s);
1122 else if (s.exists()) {
1123 buf = lyx_view_->loadDocument(s);
1126 lyx_view_->message(bformat(
1127 _("File does not exist: %1$s"),
1128 makeDisplayPath(file_name)));
1132 updateFlags = Update::None;
1136 buf->updateLabels();
1137 lyx_view_->setBuffer(buf);
1138 view()->setCursorFromRow(row);
1140 buf->errors("Parse");
1141 updateFlags = Update::FitCursor;
1146 case LFUN_DIALOG_SHOW_NEW_INSET: {
1147 LASSERT(lyx_view_, /**/);
1148 string const name = cmd.getArg(0);
1149 InsetCode code = insetCode(name);
1150 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1151 bool insetCodeOK = true;
1158 case NOMENCL_PRINT_CODE:
1161 case HYPERLINK_CODE: {
1162 InsetCommandParams p(code);
1163 data = InsetCommand::params2string(name, p);
1166 case INCLUDE_CODE: {
1167 // data is the include type: one of "include",
1168 // "input", "verbatiminput" or "verbatiminput*"
1170 // default type is requested
1172 InsetCommandParams p(INCLUDE_CODE, data);
1173 data = InsetCommand::params2string("include", p);
1177 // \c data == "Boxed" || "Frameless" etc
1178 InsetBoxParams p(data);
1179 data = InsetBox::params2string(p);
1183 InsetBranchParams p;
1184 data = InsetBranch::params2string(p);
1188 InsetCommandParams p(CITE_CODE);
1189 data = InsetCommand::params2string(name, p);
1193 data = InsetERT::params2string(InsetCollapsable::Open);
1196 case EXTERNAL_CODE: {
1197 InsetExternalParams p;
1198 data = InsetExternal::params2string(p, *buffer);
1203 data = InsetFloat::params2string(p);
1206 case LISTINGS_CODE: {
1207 InsetListingsParams p;
1208 data = InsetListings::params2string(p);
1211 case GRAPHICS_CODE: {
1212 InsetGraphicsParams p;
1213 data = InsetGraphics::params2string(p, *buffer);
1218 data = InsetNote::params2string(p);
1221 case PHANTOM_CODE: {
1222 InsetPhantomParams p;
1223 data = InsetPhantom::params2string(p);
1228 data = InsetSpace::params2string(p);
1233 data = InsetVSpace::params2string(space);
1238 data = InsetWrap::params2string(p);
1242 lyxerr << "Inset type '" << name <<
1243 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1244 insetCodeOK = false;
1246 } // end switch(code)
1248 dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1252 case LFUN_CITATION_INSERT: {
1253 LASSERT(lyx_view_, /**/);
1254 if (!argument.empty()) {
1255 // we can have one optional argument, delimited by '|'
1256 // citation-insert <key>|<text_before>
1257 // this should be enhanced to also support text_after
1258 // and citation style
1259 string arg = argument;
1261 if (contains(argument, "|")) {
1262 arg = token(argument, '|', 0);
1263 opt1 = token(argument, '|', 1);
1265 InsetCommandParams icp(CITE_CODE);
1266 icp["key"] = from_utf8(arg);
1268 icp["before"] = from_utf8(opt1);
1269 string icstr = InsetCommand::params2string("citation", icp);
1270 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1273 dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1277 case LFUN_BUFFER_CHILD_OPEN: {
1278 LASSERT(lyx_view_ && buffer, /**/);
1279 FileName filename = makeAbsPath(argument, buffer->filePath());
1280 view()->saveBookmark(false);
1282 bool parsed = false;
1283 if (theBufferList().exists(filename)) {
1284 child = theBufferList().getBuffer(filename);
1286 setMessage(bformat(_("Opening child document %1$s..."),
1287 makeDisplayPath(filename.absFilename())));
1288 child = lyx_view_->loadDocument(filename, false);
1292 // Set the parent name of the child document.
1293 // This makes insertion of citations and references in the child work,
1294 // when the target is in the parent or another child document.
1295 child->setParent(buffer);
1296 child->masterBuffer()->updateLabels();
1297 lyx_view_->setBuffer(child);
1299 child->errors("Parse");
1302 // If a screen update is required (in case where auto_open is false),
1303 // setBuffer() would have taken care of it already. Otherwise we shall
1304 // reset the update flag because it can cause a circular problem.
1306 updateFlags = Update::None;
1310 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1311 LASSERT(lyx_view_, /**/);
1312 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1315 case LFUN_KEYMAP_OFF:
1316 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1317 lyx_view_->view()->getIntl().keyMapOn(false);
1320 case LFUN_KEYMAP_PRIMARY:
1321 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1322 lyx_view_->view()->getIntl().keyMapPrim();
1325 case LFUN_KEYMAP_SECONDARY:
1326 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1327 lyx_view_->view()->getIntl().keyMapSec();
1330 case LFUN_KEYMAP_TOGGLE:
1331 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1332 lyx_view_->view()->getIntl().toggleKeyMap();
1338 string rest = split(argument, countstr, ' ');
1339 istringstream is(countstr);
1342 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1343 for (int i = 0; i < count; ++i)
1344 dispatch(lyxaction.lookupFunc(rest));
1348 case LFUN_COMMAND_SEQUENCE: {
1349 // argument contains ';'-terminated commands
1350 string arg = argument;
1351 if (theBufferList().isLoaded(buffer))
1352 buffer->undo().beginUndoGroup();
1353 while (!arg.empty()) {
1355 arg = split(arg, first, ';');
1356 FuncRequest func(lyxaction.lookupFunc(first));
1357 func.origin = cmd.origin;
1360 if (theBufferList().isLoaded(buffer))
1361 buffer->undo().endUndoGroup();
1365 case LFUN_COMMAND_ALTERNATIVES: {
1366 // argument contains ';'-terminated commands
1367 string arg = argument;
1368 while (!arg.empty()) {
1370 arg = split(arg, first, ';');
1371 FuncRequest func(lyxaction.lookupFunc(first));
1372 func.origin = cmd.origin;
1373 FuncStatus stat = getStatus(func);
1374 if (stat.enabled()) {
1384 if (theTopLevelCmdDef().lock(argument, func)) {
1385 func.origin = cmd.origin;
1387 theTopLevelCmdDef().release(argument);
1389 if (func.action == LFUN_UNKNOWN_ACTION) {
1390 // unknown command definition
1391 lyxerr << "Warning: unknown command definition `"
1395 // recursion detected
1396 lyxerr << "Warning: Recursion in the command definition `"
1397 << argument << "' detected"
1404 case LFUN_PREFERENCES_SAVE: {
1405 lyxrc.write(makeAbsPath("preferences",
1406 package().user_support().absFilename()),
1412 LASSERT(lyx_view_, /**/);
1413 lyx_view_->message(from_utf8(argument));
1416 case LFUN_BUFFER_LANGUAGE: {
1417 LASSERT(lyx_view_, /**/);
1418 Language const * oldL = buffer->params().language;
1419 Language const * newL = languages.getLanguage(argument);
1420 if (!newL || oldL == newL)
1423 if (oldL->rightToLeft() == newL->rightToLeft()
1424 && !buffer->isMultiLingual())
1425 buffer->changeLanguage(oldL, newL);
1429 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1430 string const fname =
1431 addName(addPath(package().user_support().absFilename(), "templates/"),
1433 Buffer defaults(fname);
1435 istringstream ss(argument);
1438 int const unknown_tokens = defaults.readHeader(lex);
1440 if (unknown_tokens != 0) {
1441 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1442 << unknown_tokens << " unknown token"
1443 << (unknown_tokens == 1 ? "" : "s")
1447 if (defaults.writeFile(FileName(defaults.absFileName())))
1448 setMessage(bformat(_("Document defaults saved in %1$s"),
1449 makeDisplayPath(fname)));
1451 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
1455 case LFUN_BUFFER_PARAMS_APPLY: {
1456 LASSERT(lyx_view_, /**/);
1458 DocumentClass const * const oldClass = buffer->params().documentClassPtr();
1459 Cursor & cur = view()->cursor();
1460 cur.recordUndoFullDocument();
1462 istringstream ss(argument);
1465 int const unknown_tokens = buffer->readHeader(lex);
1467 if (unknown_tokens != 0) {
1468 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1469 << unknown_tokens << " unknown token"
1470 << (unknown_tokens == 1 ? "" : "s")
1474 updateLayout(oldClass, buffer);
1476 updateFlags = Update::Force | Update::FitCursor;
1477 // We are most certainly here because of a change in the document
1478 // It is then better to make sure that all dialogs are in sync with
1479 // current document settings. LyXView::restartCursor() achieve this.
1480 lyx_view_->restartCursor();
1484 case LFUN_LAYOUT_MODULES_CLEAR: {
1485 LASSERT(lyx_view_, /**/);
1486 DocumentClass const * const oldClass = buffer->params().documentClassPtr();
1487 view()->cursor().recordUndoFullDocument();
1488 buffer->params().clearLayoutModules();
1489 buffer->params().makeDocumentClass();
1490 updateLayout(oldClass, buffer);
1491 updateFlags = Update::Force | Update::FitCursor;
1495 case LFUN_LAYOUT_MODULE_ADD: {
1496 LASSERT(lyx_view_, /**/);
1497 BufferParams const & params = buffer->params();
1498 if (!params.moduleCanBeAdded(argument)) {
1499 LYXERR0("Module `" << argument <<
1500 "' cannot be added due to failed requirements or "
1501 "conflicts with installed modules.");
1504 DocumentClass const * const oldClass = params.documentClassPtr();
1505 view()->cursor().recordUndoFullDocument();
1506 buffer->params().addLayoutModule(argument);
1507 buffer->params().makeDocumentClass();
1508 updateLayout(oldClass, buffer);
1509 updateFlags = Update::Force | Update::FitCursor;
1513 case LFUN_TEXTCLASS_APPLY: {
1514 LASSERT(lyx_view_, /**/);
1516 if (!loadLayoutFile(argument, buffer->temppath()) &&
1517 !loadLayoutFile(argument, buffer->filePath()))
1520 LayoutFile const * old_layout = buffer->params().baseClass();
1521 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1523 if (old_layout == new_layout)
1527 //Save the old, possibly modular, layout for use in conversion.
1528 DocumentClass const * const oldDocClass = buffer->params().documentClassPtr();
1529 view()->cursor().recordUndoFullDocument();
1530 buffer->params().setBaseClass(argument);
1531 buffer->params().makeDocumentClass();
1532 updateLayout(oldDocClass, buffer);
1533 updateFlags = Update::Force | Update::FitCursor;
1537 case LFUN_LAYOUT_RELOAD: {
1538 LASSERT(lyx_view_, /**/);
1539 DocumentClass const * const oldClass = buffer->params().documentClassPtr();
1540 LayoutFileIndex bc = buffer->params().baseClassID();
1541 LayoutFileList::get().reset(bc);
1542 buffer->params().setBaseClass(bc);
1543 buffer->params().makeDocumentClass();
1544 updateLayout(oldClass, buffer);
1545 updateFlags = Update::Force | Update::FitCursor;
1549 case LFUN_TEXTCLASS_LOAD:
1550 loadLayoutFile(argument, buffer->temppath()) ||
1551 loadLayoutFile(argument, buffer->filePath());
1554 case LFUN_LYXRC_APPLY: {
1555 LyXRC const lyxrc_orig = lyxrc;
1557 istringstream ss(argument);
1558 bool const success = lyxrc.read(ss) == 0;
1561 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1562 << "Unable to read lyxrc data"
1567 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1569 theApp()->resetGui();
1571 /// We force the redraw in any case because there might be
1572 /// some screen font changes.
1573 /// FIXME: only the current view will be updated. the Gui
1574 /// class is able to furnish the list of views.
1575 updateFlags = Update::Force;
1579 case LFUN_BOOKMARK_GOTO:
1580 // go to bookmark, open unopened file and switch to buffer if necessary
1581 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1582 updateFlags = Update::FitCursor;
1585 case LFUN_BOOKMARK_CLEAR:
1586 theSession().bookmarks().clear();
1589 case LFUN_VC_COMMAND: {
1590 string flag = cmd.getArg(0);
1591 if (buffer && contains(flag, 'R') && !ensureBufferClean(view()))
1594 if (contains(flag, 'M'))
1595 if (!Alert::askForText(message, _("LyX VC: Log Message")))
1598 string path = cmd.getArg(1);
1599 if (contains(path, "$$p") && buffer)
1600 path = subst(path, "$$p", buffer->filePath());
1601 LYXERR(Debug::LYXVC, "Directory: " << path);
1603 if (!pp.isReadableDirectory()) {
1604 lyxerr << _("Directory is not accessible.") << endl;
1607 support::PathChanger p(pp);
1609 string command = cmd.getArg(2);
1610 if (command.empty())
1613 command = subst(command, "$$i", buffer->absFileName());
1614 command = subst(command, "$$p", buffer->filePath());
1616 command = subst(command, "$$m", to_utf8(message));
1617 LYXERR(Debug::LYXVC, "Command: " << command);
1619 one.startscript(Systemcall::Wait, command);
1623 if (contains(flag, 'I'))
1624 buffer->markDirty();
1625 if (contains(flag, 'R'))
1632 LASSERT(theApp(), /**/);
1633 // Let the frontend dispatch its own actions.
1634 if (theApp()->dispatch(cmd))
1635 // Nothing more to do.
1638 // Everything below is only for active lyx_view_
1642 // Start an undo group. This may be needed for
1643 // some stuff like inset-apply on labels.
1644 if (theBufferList().isLoaded(buffer))
1645 buffer->undo().beginUndoGroup();
1647 // Let the current LyXView dispatch its own actions.
1648 if (lyx_view_->dispatch(cmd)) {
1649 if (lyx_view_->view()) {
1650 updateFlags = lyx_view_->view()->cursor().result().update();
1651 if (theBufferList().isLoaded(buffer))
1652 buffer->undo().endUndoGroup();
1657 LASSERT(lyx_view_->view(), /**/);
1659 // Let the current BufferView dispatch its own actions.
1660 if (view()->dispatch(cmd)) {
1661 // The BufferView took care of its own updates if needed.
1662 updateFlags = Update::None;
1663 if (theBufferList().isLoaded(buffer))
1664 buffer->undo().endUndoGroup();
1668 // OK, so try the Buffer itself
1670 view()->buffer().dispatch(cmd, dr);
1671 if (dr.dispatched()) {
1672 updateFlags = dr.update();
1676 // Is this a function that acts on inset at point?
1677 Inset * inset = view()->cursor().nextInset();
1678 if (lyxaction.funcHasFlag(action, LyXAction::AtPoint)
1680 view()->cursor().result().dispatched(true);
1681 view()->cursor().result().update(Update::FitCursor | Update::Force);
1682 FuncRequest tmpcmd = cmd;
1683 inset->dispatch(view()->cursor(), tmpcmd);
1684 if (view()->cursor().result().dispatched()) {
1685 updateFlags = view()->cursor().result().update();
1690 // Let the current Cursor dispatch its own actions.
1691 Cursor old = view()->cursor();
1692 view()->cursor().getPos(cursorPosBeforeDispatchX_,
1693 cursorPosBeforeDispatchY_);
1694 view()->cursor().dispatch(cmd);
1696 // notify insets we just left
1697 if (view()->cursor() != old) {
1699 bool badcursor = notifyCursorLeavesOrEnters(old, view()->cursor());
1701 view()->cursor().fixIfBroken();
1704 if (theBufferList().isLoaded(buffer))
1705 buffer->undo().endUndoGroup();
1707 // update completion. We do it here and not in
1708 // processKeySym to avoid another redraw just for a
1709 // changed inline completion
1710 if (cmd.origin == FuncRequest::KEYBOARD) {
1711 if (cmd.action == LFUN_SELF_INSERT)
1712 lyx_view_->updateCompletion(view()->cursor(), true, true);
1713 else if (cmd.action == LFUN_CHAR_DELETE_BACKWARD)
1714 lyx_view_->updateCompletion(view()->cursor(), false, true);
1716 lyx_view_->updateCompletion(view()->cursor(), false, false);
1719 updateFlags = view()->cursor().result().update();
1722 // if we executed a mutating lfun, mark the buffer as dirty
1723 if (theBufferList().isLoaded(buffer) && flag.enabled()
1724 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1725 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1726 buffer->markDirty();
1728 if (lyx_view_ && lyx_view_->buffer()) {
1729 // BufferView::update() updates the ViewMetricsInfo and
1730 // also initializes the position cache for all insets in
1731 // (at least partially) visible top-level paragraphs.
1732 // We will redraw the screen only if needed.
1733 view()->processUpdateFlags(updateFlags);
1735 // Do we have a selection?
1736 theSelection().haveSelection(view()->cursor().selection());
1739 lyx_view_->restartCursor();
1743 // Some messages may already be translated, so we cannot use _()
1744 sendDispatchMessage(translateIfPossible(getMessage()), cmd);
1749 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1751 const bool verbose = (cmd.origin == FuncRequest::MENU
1752 || cmd.origin == FuncRequest::TOOLBAR
1753 || cmd.origin == FuncRequest::COMMANDBUFFER);
1755 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1756 LYXERR(Debug::ACTION, "dispatch msg is " << to_utf8(msg));
1758 lyx_view_->message(msg);
1762 docstring dispatch_msg = msg;
1763 if (!dispatch_msg.empty())
1764 dispatch_msg += ' ';
1766 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1768 bool argsadded = false;
1770 if (!cmd.argument().empty()) {
1771 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1772 comname += ' ' + cmd.argument();
1777 docstring const shortcuts = theTopLevelKeymap().printBindings(cmd, KeySequence::ForGui);
1779 if (!shortcuts.empty())
1780 comname += ": " + shortcuts;
1781 else if (!argsadded && !cmd.argument().empty())
1782 comname += ' ' + cmd.argument();
1784 if (!comname.empty()) {
1785 comname = rtrim(comname);
1786 dispatch_msg += '(' + rtrim(comname) + ')';
1789 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1790 if (!dispatch_msg.empty())
1791 lyx_view_->message(dispatch_msg);
1795 void LyXFunc::reloadBuffer()
1797 FileName filename = lyx_view_->buffer()->fileName();
1798 // The user has already confirmed that the changes, if any, should
1799 // be discarded. So we just release the Buffer and don't call closeBuffer();
1800 theBufferList().release(lyx_view_->buffer());
1801 // if the lyx_view_ has been destroyed, create a new one
1803 theApp()->dispatch(FuncRequest(LFUN_WINDOW_NEW));
1804 Buffer * buf = lyx_view_->loadDocument(filename);
1805 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1808 buf->updateLabels();
1809 lyx_view_->setBuffer(buf);
1810 buf->errors("Parse");
1811 str = bformat(_("Document %1$s reloaded."), disp_fn);
1813 str = bformat(_("Could not reload document %1$s"), disp_fn);
1815 lyx_view_->message(str);
1818 // Each "lyx_view_" should have it's own message method. lyxview and
1819 // the minibuffer would use the minibuffer, but lyxserver would
1820 // send an ERROR signal to its client. Alejandro 970603
1821 // This function is bit problematic when it comes to NLS, to make the
1822 // lyx servers client be language indepenent we must not translate
1823 // strings sent to this func.
1824 void LyXFunc::setErrorMessage(docstring const & m) const
1826 dispatch_buffer = m;
1831 void LyXFunc::setMessage(docstring const & m) const
1833 dispatch_buffer = m;
1837 docstring LyXFunc::viewStatusMessage()
1839 // When meta-fake key is pressed, show the key sequence so far + "M-".
1841 return keyseq.print(KeySequence::ForGui) + "M-";
1843 // Else, when a non-complete key sequence is pressed,
1844 // show the available options.
1845 if (keyseq.length() > 0 && !keyseq.deleted())
1846 return keyseq.printOptions(true);
1848 LASSERT(lyx_view_, /**/);
1849 if (!lyx_view_->buffer())
1850 return _("Welcome to LyX!");
1852 return view()->cursor().currentState();
1856 BufferView * LyXFunc::view() const
1858 LASSERT(lyx_view_, /**/);
1859 return lyx_view_->view();
1863 bool LyXFunc::wasMetaKey() const
1865 return (meta_fake_bit != NoModifier);
1869 void LyXFunc::updateLayout(DocumentClass const * const oldlayout, Buffer * buf)
1871 lyx_view_->message(_("Converting document to new document class..."));
1873 StableDocIterator backcur(view()->cursor());
1874 ErrorList & el = buf->errorList("Class Switch");
1875 cap::switchBetweenClasses(
1876 oldlayout, buf->params().documentClassPtr(),
1877 static_cast<InsetText &>(buf->inset()), el);
1879 view()->setCursor(backcur.asDocIterator(buf));
1881 buf->errors("Class Switch");
1882 buf->updateLabels();
1888 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
1890 // Why the switch you might ask. It is a trick to ensure that all
1891 // the elements in the LyXRCTags enum is handled. As you can see
1892 // there are no breaks at all. So it is just a huge fall-through.
1893 // The nice thing is that we will get a warning from the compiler
1894 // if we forget an element.
1895 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
1897 case LyXRC::RC_ACCEPT_COMPOUND:
1898 case LyXRC::RC_ALT_LANG:
1899 case LyXRC::RC_PLAINTEXT_LINELEN:
1900 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
1901 case LyXRC::RC_AUTOCORRECTION_MATH:
1902 case LyXRC::RC_AUTOREGIONDELETE:
1903 case LyXRC::RC_AUTORESET_OPTIONS:
1904 case LyXRC::RC_AUTOSAVE:
1905 case LyXRC::RC_AUTO_NUMBER:
1906 case LyXRC::RC_BACKUPDIR_PATH:
1907 case LyXRC::RC_BIBTEX_ALTERNATIVES:
1908 case LyXRC::RC_BIBTEX_COMMAND:
1909 case LyXRC::RC_BINDFILE:
1910 case LyXRC::RC_CHECKLASTFILES:
1911 case LyXRC::RC_COMPLETION_CURSOR_TEXT:
1912 case LyXRC::RC_COMPLETION_INLINE_DELAY:
1913 case LyXRC::RC_COMPLETION_INLINE_DOTS:
1914 case LyXRC::RC_COMPLETION_INLINE_MATH:
1915 case LyXRC::RC_COMPLETION_INLINE_TEXT:
1916 case LyXRC::RC_COMPLETION_POPUP_AFTER_COMPLETE:
1917 case LyXRC::RC_COMPLETION_POPUP_DELAY:
1918 case LyXRC::RC_COMPLETION_POPUP_MATH:
1919 case LyXRC::RC_COMPLETION_POPUP_TEXT:
1920 case LyXRC::RC_USELASTFILEPOS:
1921 case LyXRC::RC_LOADSESSION:
1922 case LyXRC::RC_CHKTEX_COMMAND:
1923 case LyXRC::RC_CONVERTER:
1924 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
1925 case LyXRC::RC_COPIER:
1926 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
1927 case LyXRC::RC_SCROLL_BELOW_DOCUMENT:
1928 case LyXRC::RC_DATE_INSERT_FORMAT:
1929 case LyXRC::RC_DEFAULT_LANGUAGE:
1930 case LyXRC::RC_GUI_LANGUAGE:
1931 case LyXRC::RC_DEFAULT_PAPERSIZE:
1932 case LyXRC::RC_DEFAULT_VIEW_FORMAT:
1933 case LyXRC::RC_DEFFILE:
1934 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
1935 case LyXRC::RC_DISPLAY_GRAPHICS:
1936 case LyXRC::RC_DOCUMENTPATH:
1937 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
1938 FileName path(lyxrc_new.document_path);
1939 if (path.exists() && path.isDirectory())
1940 package().document_dir() = FileName(lyxrc.document_path);
1942 case LyXRC::RC_ESC_CHARS:
1943 case LyXRC::RC_EXAMPLEPATH:
1944 case LyXRC::RC_FONT_ENCODING:
1945 case LyXRC::RC_FORMAT:
1946 case LyXRC::RC_GROUP_LAYOUTS:
1947 case LyXRC::RC_INDEX_ALTERNATIVES:
1948 case LyXRC::RC_INDEX_COMMAND:
1949 case LyXRC::RC_JBIBTEX_COMMAND:
1950 case LyXRC::RC_JINDEX_COMMAND:
1951 case LyXRC::RC_NOMENCL_COMMAND:
1952 case LyXRC::RC_INPUT:
1953 case LyXRC::RC_KBMAP:
1954 case LyXRC::RC_KBMAP_PRIMARY:
1955 case LyXRC::RC_KBMAP_SECONDARY:
1956 case LyXRC::RC_LABEL_INIT_LENGTH:
1957 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
1958 case LyXRC::RC_LANGUAGE_AUTO_END:
1959 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
1960 case LyXRC::RC_LANGUAGE_COMMAND_END:
1961 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
1962 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
1963 case LyXRC::RC_LANGUAGE_PACKAGE:
1964 case LyXRC::RC_LANGUAGE_USE_BABEL:
1965 case LyXRC::RC_MAC_LIKE_WORD_MOVEMENT:
1966 case LyXRC::RC_MACRO_EDIT_STYLE:
1967 case LyXRC::RC_MAKE_BACKUP:
1968 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
1969 case LyXRC::RC_MOUSE_WHEEL_SPEED:
1970 case LyXRC::RC_NUMLASTFILES:
1971 case LyXRC::RC_PATH_PREFIX:
1972 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
1973 prependEnvPath("PATH", lyxrc.path_prefix);
1975 case LyXRC::RC_PERS_DICT:
1976 case LyXRC::RC_PREVIEW:
1977 case LyXRC::RC_PREVIEW_HASHED_LABELS:
1978 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
1979 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
1980 case LyXRC::RC_PRINTCOPIESFLAG:
1981 case LyXRC::RC_PRINTER:
1982 case LyXRC::RC_PRINTEVENPAGEFLAG:
1983 case LyXRC::RC_PRINTEXSTRAOPTIONS:
1984 case LyXRC::RC_PRINTFILEEXTENSION:
1985 case LyXRC::RC_PRINTLANDSCAPEFLAG:
1986 case LyXRC::RC_PRINTODDPAGEFLAG:
1987 case LyXRC::RC_PRINTPAGERANGEFLAG:
1988 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
1989 case LyXRC::RC_PRINTPAPERFLAG:
1990 case LyXRC::RC_PRINTREVERSEFLAG:
1991 case LyXRC::RC_PRINTSPOOL_COMMAND:
1992 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
1993 case LyXRC::RC_PRINTTOFILE:
1994 case LyXRC::RC_PRINTTOPRINTER:
1995 case LyXRC::RC_PRINT_ADAPTOUTPUT:
1996 case LyXRC::RC_PRINT_COMMAND:
1997 case LyXRC::RC_RTL_SUPPORT:
1998 case LyXRC::RC_SCREEN_DPI:
1999 case LyXRC::RC_SCREEN_FONT_ROMAN:
2000 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
2001 case LyXRC::RC_SCREEN_FONT_SANS:
2002 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
2003 case LyXRC::RC_SCREEN_FONT_SCALABLE:
2004 case LyXRC::RC_SCREEN_FONT_SIZES:
2005 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
2006 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
2007 case LyXRC::RC_GEOMETRY_SESSION:
2008 case LyXRC::RC_SCREEN_ZOOM:
2009 case LyXRC::RC_SERVERPIPE:
2010 case LyXRC::RC_SET_COLOR:
2011 case LyXRC::RC_SHOW_BANNER:
2012 case LyXRC::RC_OPEN_BUFFERS_IN_TABS:
2013 case LyXRC::RC_SPELL_COMMAND:
2014 case LyXRC::RC_SPELLCHECK_CONTINUOUSLY:
2015 case LyXRC::RC_SPLITINDEX_COMMAND:
2016 case LyXRC::RC_TEMPDIRPATH:
2017 case LyXRC::RC_TEMPLATEPATH:
2018 case LyXRC::RC_TEX_ALLOWS_SPACES:
2019 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
2020 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
2021 os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
2023 case LyXRC::RC_THESAURUSDIRPATH:
2024 case LyXRC::RC_UIFILE:
2025 case LyXRC::RC_USER_EMAIL:
2026 case LyXRC::RC_USER_NAME:
2027 case LyXRC::RC_USETEMPDIR:
2028 case LyXRC::RC_USE_ALT_LANG:
2029 case LyXRC::RC_USE_CONVERTER_CACHE:
2030 case LyXRC::RC_USE_ESC_CHARS:
2031 case LyXRC::RC_USE_INP_ENC:
2032 case LyXRC::RC_USE_PERS_DICT:
2033 case LyXRC::RC_USE_TOOLTIP:
2034 case LyXRC::RC_USE_PIXMAP_CACHE:
2035 case LyXRC::RC_USE_SPELL_LIB:
2036 case LyXRC::RC_VIEWDVI_PAPEROPTION:
2037 case LyXRC::RC_SORT_LAYOUTS:
2038 case LyXRC::RC_FULL_SCREEN_LIMIT:
2039 case LyXRC::RC_FULL_SCREEN_SCROLLBAR:
2040 case LyXRC::RC_FULL_SCREEN_MENUBAR:
2041 case LyXRC::RC_FULL_SCREEN_TABBAR:
2042 case LyXRC::RC_FULL_SCREEN_TOOLBARS:
2043 case LyXRC::RC_FULL_SCREEN_WIDTH:
2044 case LyXRC::RC_VISUAL_CURSOR:
2045 case LyXRC::RC_VIEWER:
2046 case LyXRC::RC_LAST: