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()->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:
411 #if !defined(HAVE_LIBMYTHES) && !defined(HAVE_LIBAIKSAURUS)
412 case LFUN_THESAURUS_ENTRY:
415 flag.setEnabled(false);
422 if (flag.unknown()) {
423 flag.message(from_utf8(N_("Unknown action")));
427 if (!flag.enabled()) {
428 if (flag.message().empty())
429 flag.message(from_utf8(N_("Command disabled")));
433 // Check whether we need a buffer
434 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
436 flag.message(from_utf8(N_("Command not allowed with"
437 "out any document open")));
438 flag.setEnabled(false);
442 // I would really like to avoid having this switch and rather try to
443 // encode this in the function itself.
444 // -- And I'd rather let an inset decide which LFUNs it is willing
445 // to handle (Andre')
447 switch (cmd.action) {
449 case LFUN_BUFFER_TOGGLE_READ_ONLY:
450 flag.setOnOff(buf->isReadonly());
453 case LFUN_BUFFER_SWITCH:
454 // toggle on the current buffer, but do not toggle off
455 // the other ones (is that a good idea?)
456 if (buf && to_utf8(cmd.argument()) == buf->absFileName())
460 case LFUN_BUFFER_CHKTEX:
461 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
464 case LFUN_BUILD_PROGRAM:
465 enable = buf->isExportable("program");
468 case LFUN_VC_REGISTER:
469 enable = !buf->lyxvc().inUse();
471 case LFUN_VC_CHECK_IN:
472 enable = buf->lyxvc().checkInEnabled();
474 case LFUN_VC_CHECK_OUT:
475 enable = buf->lyxvc().checkOutEnabled();
478 enable = buf->lyxvc().inUse();
480 case LFUN_VC_UNDO_LAST:
481 enable = buf->lyxvc().undoLastEnabled();
483 case LFUN_BUFFER_RELOAD:
484 enable = !buf->isUnnamed() && buf->fileName().exists()
485 && (!buf->isClean() || buf->isExternallyModified(Buffer::timestamp_method));
488 case LFUN_CITATION_INSERT: {
489 FuncRequest fr(LFUN_INSET_INSERT, "citation");
490 enable = getStatus(fr).enabled();
494 // This could be used for the no-GUI version. The GUI version is handled in
495 // LyXView::getStatus(). See above.
497 case LFUN_BUFFER_WRITE:
498 case LFUN_BUFFER_WRITE_AS: {
499 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
500 enable = b && (b->isUnnamed() || !b->isClean());
505 case LFUN_BUFFER_WRITE_ALL: {
506 // We enable the command only if there are some modified buffers
507 Buffer * first = theBufferList().first();
512 // We cannot use a for loop as the buffer list is a cycle.
518 b = theBufferList().next(b);
519 } while (b != first);
523 case LFUN_BOOKMARK_GOTO: {
524 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
525 enable = theSession().bookmarks().isValid(num);
529 case LFUN_BOOKMARK_CLEAR:
530 enable = theSession().bookmarks().hasValid();
533 // this one is difficult to get right. As a half-baked
534 // solution, we consider only the first action of the sequence
535 case LFUN_COMMAND_SEQUENCE: {
536 // argument contains ';'-terminated commands
537 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
538 FuncRequest func(lyxaction.lookupFunc(firstcmd));
539 func.origin = cmd.origin;
540 flag = getStatus(func);
544 // we want to check if at least one of these is enabled
545 case LFUN_COMMAND_ALTERNATIVES: {
546 // argument contains ';'-terminated commands
547 string arg = to_utf8(cmd.argument());
548 while (!arg.empty()) {
550 arg = split(arg, first, ';');
551 FuncRequest func(lyxaction.lookupFunc(first));
552 func.origin = cmd.origin;
553 flag = getStatus(func);
554 // if this one is enabled, the whole thing is
563 string name = to_utf8(cmd.argument());
564 if (theTopLevelCmdDef().lock(name, func)) {
565 func.origin = cmd.origin;
566 flag = getStatus(func);
567 theTopLevelCmdDef().release(name);
569 // catch recursion or unknown command definiton
570 // all operations until the recursion or unknown command
571 // definiton occures are performed, so set the state to enabled
577 case LFUN_VC_COMMAND: {
578 if (cmd.argument().empty())
581 if (!buf && contains(cmd.getArg(0), 'D'))
586 case LFUN_BUFFER_UPDATE:
587 case LFUN_BUFFER_VIEW:
588 case LFUN_MASTER_BUFFER_UPDATE:
589 case LFUN_MASTER_BUFFER_VIEW: {
590 typedef vector<Format const *> Formats;
592 formats = buf->exportableFormats(true);
593 Formats::const_iterator fit = formats.begin();
594 Formats::const_iterator end = formats.end();
596 for (; fit != end ; ++fit) {
597 if ((*fit)->name() == to_utf8(cmd.argument()))
603 case LFUN_WORD_FIND_FORWARD:
604 case LFUN_WORD_FIND_BACKWARD:
605 case LFUN_WORD_FINDADV:
606 case LFUN_COMMAND_PREFIX:
607 case LFUN_COMMAND_EXECUTE:
609 case LFUN_META_PREFIX:
610 case LFUN_BUFFER_CLOSE:
611 case LFUN_BUFFER_IMPORT:
612 case LFUN_BUFFER_AUTO_SAVE:
613 case LFUN_RECONFIGURE:
615 case LFUN_DROP_LAYOUTS_CHOICE:
617 case LFUN_SERVER_GET_FILENAME:
618 case LFUN_SERVER_NOTIFY:
619 case LFUN_SERVER_GOTO_FILE_ROW:
620 case LFUN_DIALOG_HIDE:
621 case LFUN_DIALOG_DISCONNECT_INSET:
622 case LFUN_BUFFER_CHILD_OPEN:
623 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
624 case LFUN_KEYMAP_OFF:
625 case LFUN_KEYMAP_PRIMARY:
626 case LFUN_KEYMAP_SECONDARY:
627 case LFUN_KEYMAP_TOGGLE:
629 case LFUN_BUFFER_EXPORT_CUSTOM:
630 case LFUN_PREFERENCES_SAVE:
632 case LFUN_INSET_EDIT:
633 case LFUN_BUFFER_LANGUAGE:
634 case LFUN_TEXTCLASS_APPLY:
635 case LFUN_TEXTCLASS_LOAD:
636 case LFUN_BUFFER_SAVE_AS_DEFAULT:
637 case LFUN_BUFFER_PARAMS_APPLY:
638 case LFUN_LAYOUT_MODULES_CLEAR:
639 case LFUN_LAYOUT_MODULE_ADD:
640 case LFUN_LAYOUT_RELOAD:
641 case LFUN_LYXRC_APPLY:
642 case LFUN_BUFFER_NEXT:
643 case LFUN_BUFFER_PREVIOUS:
644 // these are handled in our dispatch()
652 if (theApp()->getStatus(cmd, flag))
655 // Does the view know something?
660 if (lyx_view_->getStatus(cmd, flag))
663 // If we do not have a BufferView, then other functions are disabled
669 // Is this a function that acts on inset at point?
670 Inset * inset = view()->cursor().nextInset();
671 if (lyxaction.funcHasFlag(cmd.action, LyXAction::AtPoint)
672 && inset && inset->getStatus(view()->cursor(), cmd, flag))
675 bool decided = getLocalStatus(view()->cursor(), cmd, flag);
677 // try the BufferView
678 decided = view()->getStatus(cmd, flag);
681 view()->buffer().getStatus(cmd, flag);
685 flag.setEnabled(false);
687 // Can we use a readonly buffer?
688 if (buf && buf->isReadonly()
689 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
690 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
691 flag.message(from_utf8(N_("Document is read-only")));
692 flag.setEnabled(false);
695 // Are we in a DELETED change-tracking region?
697 && lookupChangeType(view()->cursor(), true) == Change::DELETED
698 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
699 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
700 flag.message(from_utf8(N_("This portion of the document is deleted.")));
701 flag.setEnabled(false);
704 // the default error message if we disable the command
705 if (!flag.enabled() && flag.message().empty())
706 flag.message(from_utf8(N_("Command disabled")));
712 bool LyXFunc::ensureBufferClean(BufferView * bv)
714 Buffer & buf = bv->buffer();
715 if (buf.isClean() && !buf.isUnnamed())
718 docstring const file = buf.fileName().displayName(30);
721 if (!buf.isUnnamed()) {
722 text = bformat(_("The document %1$s has unsaved "
723 "changes.\n\nDo you want to save "
724 "the document?"), file);
725 title = _("Save changed document?");
728 text = bformat(_("The document %1$s has not been "
729 "saved yet.\n\nDo you want to save "
730 "the document?"), file);
731 title = _("Save new document?");
733 int const ret = Alert::prompt(title, text, 0, 1, _("&Save"), _("&Cancel"));
736 lyx_view_->dispatch(FuncRequest(LFUN_BUFFER_WRITE));
738 return buf.isClean() && !buf.isUnnamed();
744 bool loadLayoutFile(string const & name, string const & buf_path)
746 if (!LayoutFileList::get().haveClass(name)) {
747 lyxerr << "Document class \"" << name
748 << "\" does not exist."
753 LayoutFile & tc = LayoutFileList::get()[name];
754 if (!tc.load(buf_path)) {
755 docstring s = bformat(_("The document class %1$s "
756 "could not be loaded."), from_utf8(name));
757 Alert::error(_("Could not load class"), s);
764 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
769 void LyXFunc::dispatch(FuncRequest const & cmd)
771 string const argument = to_utf8(cmd.argument());
772 FuncCode const action = cmd.action;
774 LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
775 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
777 // we have not done anything wrong yet.
779 dispatch_buffer.erase();
781 // redraw the screen at the end (first of the two drawing steps).
782 //This is done unless explicitely requested otherwise
783 Update::flags updateFlags = Update::FitCursor;
785 FuncStatus const flag = getStatus(cmd);
786 if (!flag.enabled()) {
787 // We cannot use this function here
788 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
789 << lyxaction.getActionName(action)
790 << " [" << action << "] is disabled at this location");
791 setErrorMessage(flag.message());
793 lyx_view_->restartCursor();
795 Buffer * buffer = lyx_view_ ? lyx_view_->buffer() : 0;
798 case LFUN_WORD_FIND_FORWARD:
799 case LFUN_WORD_FIND_BACKWARD: {
800 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
801 static docstring last_search;
802 docstring searched_string;
804 if (!cmd.argument().empty()) {
805 last_search = cmd.argument();
806 searched_string = cmd.argument();
808 searched_string = last_search;
811 if (searched_string.empty())
814 bool const fw = action == LFUN_WORD_FIND_FORWARD;
815 docstring const data =
816 find2string(searched_string, true, false, fw);
817 find(view(), FuncRequest(LFUN_WORD_FIND, data));
821 case LFUN_COMMAND_PREFIX:
822 LASSERT(lyx_view_, /**/);
823 lyx_view_->message(keyseq.printOptions(true));
827 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
829 meta_fake_bit = NoModifier;
831 // cancel any selection
832 dispatch(FuncRequest(LFUN_MARK_OFF));
833 setMessage(from_ascii(N_("Cancel")));
836 case LFUN_META_PREFIX:
837 meta_fake_bit = AltModifier;
838 setMessage(keyseq.print(KeySequence::ForGui));
841 case LFUN_BUFFER_TOGGLE_READ_ONLY: {
842 LASSERT(lyx_view_ && lyx_view_->view() && buffer, /**/);
843 if (buffer->lyxvc().inUse())
844 buffer->lyxvc().toggleReadOnly();
846 buffer->setReadonly(!buffer->isReadonly());
850 // --- Menus -----------------------------------------------
851 case LFUN_BUFFER_CLOSE:
852 lyx_view_->closeBuffer();
854 updateFlags = Update::None;
857 case LFUN_BUFFER_RELOAD: {
858 LASSERT(lyx_view_ && buffer, /**/);
859 docstring const file = makeDisplayPath(buffer->absFileName(), 20);
860 docstring text = bformat(_("Any changes will be lost. Are you sure "
861 "you want to revert to the saved version of the document %1$s?"), file);
862 int const ret = Alert::prompt(_("Revert to saved document?"),
863 text, 1, 1, _("&Revert"), _("&Cancel"));
870 case LFUN_BUFFER_UPDATE:
871 LASSERT(lyx_view_ && buffer, /**/);
872 buffer->doExport(argument, true);
875 case LFUN_BUFFER_VIEW:
876 LASSERT(lyx_view_ && buffer, /**/);
877 buffer->preview(argument);
880 case LFUN_MASTER_BUFFER_UPDATE:
881 LASSERT(lyx_view_ && buffer && buffer->masterBuffer(), /**/);
882 buffer->masterBuffer()->doExport(argument, true);
885 case LFUN_MASTER_BUFFER_VIEW:
886 LASSERT(lyx_view_ && buffer && buffer->masterBuffer(), /**/);
887 buffer->masterBuffer()->preview(argument);
890 case LFUN_BUILD_PROGRAM:
891 LASSERT(lyx_view_ && buffer, /**/);
892 buffer->doExport("program", true);
895 case LFUN_BUFFER_CHKTEX:
896 LASSERT(lyx_view_ && buffer, /**/);
900 case LFUN_BUFFER_EXPORT:
901 LASSERT(lyx_view_ && buffer, /**/);
902 if (argument == "custom")
903 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "sendto"));
905 buffer->doExport(argument, false);
908 case LFUN_BUFFER_EXPORT_CUSTOM: {
909 LASSERT(lyx_view_ && buffer, /**/);
911 string command = split(argument, format_name, ' ');
912 Format const * format = formats.getFormat(format_name);
914 lyxerr << "Format \"" << format_name
915 << "\" not recognized!"
920 // The name of the file created by the conversion process
923 // Output to filename
924 if (format->name() == "lyx") {
925 string const latexname = buffer->latexName(false);
926 filename = changeExtension(latexname,
927 format->extension());
928 filename = addName(buffer->temppath(), filename);
930 if (!buffer->writeFile(FileName(filename)))
934 buffer->doExport(format_name, true, filename);
937 // Substitute $$FName for filename
938 if (!contains(command, "$$FName"))
939 command = "( " + command + " ) < $$FName";
940 command = subst(command, "$$FName", filename);
942 // Execute the command in the background
944 call.startscript(Systemcall::DontWait, command);
948 // FIXME: There is need for a command-line import.
950 case LFUN_BUFFER_IMPORT:
955 case LFUN_BUFFER_AUTO_SAVE:
959 case LFUN_RECONFIGURE:
960 // argument is any additional parameter to the configure.py command
961 reconfigure(lyx_view_, argument);
964 case LFUN_HELP_OPEN: {
966 theApp()->dispatch(FuncRequest(LFUN_WINDOW_NEW));
967 string const arg = argument;
969 setErrorMessage(from_utf8(N_("Missing argument")));
972 FileName fname = i18nLibFileSearch("doc", arg, "lyx");
974 fname = i18nLibFileSearch("examples", arg, "lyx");
977 lyxerr << "LyX: unable to find documentation file `"
978 << arg << "'. Bad installation?" << endl;
981 lyx_view_->message(bformat(_("Opening help file %1$s..."),
982 makeDisplayPath(fname.absFilename())));
983 Buffer * buf = lyx_view_->loadDocument(fname, false);
986 lyx_view_->setBuffer(buf);
987 buf->errors("Parse");
989 updateFlags = Update::None;
993 // --- version control -------------------------------
994 case LFUN_VC_REGISTER:
995 LASSERT(lyx_view_ && buffer, /**/);
996 if (!ensureBufferClean(view()))
998 if (!buffer->lyxvc().inUse()) {
999 if (buffer->lyxvc().registrer())
1002 updateFlags = Update::Force;
1005 case LFUN_VC_CHECK_IN:
1006 LASSERT(lyx_view_ && buffer, /**/);
1007 if (!ensureBufferClean(view()))
1009 if (buffer->lyxvc().inUse()
1010 && !buffer->isReadonly()) {
1011 setMessage(from_utf8(buffer->lyxvc().checkIn()));
1016 case LFUN_VC_CHECK_OUT:
1017 LASSERT(lyx_view_ && buffer, /**/);
1018 if (!ensureBufferClean(view()))
1020 if (buffer->lyxvc().inUse()) {
1021 setMessage(from_utf8(buffer->lyxvc().checkOut()));
1026 case LFUN_VC_REVERT:
1027 LASSERT(lyx_view_ && buffer, /**/);
1028 buffer->lyxvc().revert();
1032 case LFUN_VC_UNDO_LAST:
1033 LASSERT(lyx_view_ && buffer, /**/);
1034 buffer->lyxvc().undoLast();
1038 // --- lyxserver commands ----------------------------
1039 case LFUN_SERVER_GET_FILENAME:
1040 LASSERT(lyx_view_ && buffer, /**/);
1041 setMessage(from_utf8(buffer->absFileName()));
1042 LYXERR(Debug::INFO, "FNAME["
1043 << buffer->absFileName() << ']');
1046 case LFUN_SERVER_NOTIFY:
1047 dispatch_buffer = keyseq.print(KeySequence::Portable);
1048 theServer().notifyClient(to_utf8(dispatch_buffer));
1051 case LFUN_SERVER_GOTO_FILE_ROW: {
1052 LASSERT(lyx_view_, /**/);
1055 istringstream is(argument);
1056 is >> file_name >> row;
1058 bool loaded = false;
1059 if (prefixIs(file_name, package().temp_dir().absFilename()))
1060 // Needed by inverse dvi search. If it is a file
1061 // in tmpdir, call the apropriated function
1062 buf = theBufferList().getBufferFromTmp(file_name);
1064 // Must replace extension of the file to be .lyx
1065 // and get full path
1066 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1067 // Either change buffer or load the file
1068 if (theBufferList().exists(s))
1069 buf = theBufferList().getBuffer(s);
1071 buf = lyx_view_->loadDocument(s);
1077 updateFlags = Update::None;
1081 buf->updateLabels();
1082 lyx_view_->setBuffer(buf);
1083 view()->setCursorFromRow(row);
1085 buf->errors("Parse");
1086 updateFlags = Update::FitCursor;
1091 case LFUN_DIALOG_SHOW_NEW_INSET: {
1092 LASSERT(lyx_view_, /**/);
1093 string const name = cmd.getArg(0);
1094 InsetCode code = insetCode(name);
1095 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1096 bool insetCodeOK = true;
1105 case HYPERLINK_CODE: {
1106 InsetCommandParams p(code);
1107 data = InsetCommand::params2string(name, p);
1110 case INCLUDE_CODE: {
1111 // data is the include type: one of "include",
1112 // "input", "verbatiminput" or "verbatiminput*"
1114 // default type is requested
1116 InsetCommandParams p(INCLUDE_CODE, data);
1117 data = InsetCommand::params2string("include", p);
1121 // \c data == "Boxed" || "Frameless" etc
1122 InsetBoxParams p(data);
1123 data = InsetBox::params2string(p);
1127 InsetBranchParams p;
1128 data = InsetBranch::params2string(p);
1132 InsetCommandParams p(CITE_CODE);
1133 data = InsetCommand::params2string(name, p);
1137 data = InsetERT::params2string(InsetCollapsable::Open);
1140 case EXTERNAL_CODE: {
1141 InsetExternalParams p;
1142 data = InsetExternal::params2string(p, *buffer);
1147 data = InsetFloat::params2string(p);
1150 case LISTINGS_CODE: {
1151 InsetListingsParams p;
1152 data = InsetListings::params2string(p);
1155 case GRAPHICS_CODE: {
1156 InsetGraphicsParams p;
1157 data = InsetGraphics::params2string(p, *buffer);
1162 data = InsetNote::params2string(p);
1165 case PHANTOM_CODE: {
1166 InsetPhantomParams p;
1167 data = InsetPhantom::params2string(p);
1172 data = InsetSpace::params2string(p);
1177 data = InsetVSpace::params2string(space);
1182 data = InsetWrap::params2string(p);
1186 lyxerr << "Inset type '" << name <<
1187 "' not recognized in LFUN_DIALOG_SHOW_NEW_INSET" << endl;
1188 insetCodeOK = false;
1190 } // end switch(code)
1192 dispatch(FuncRequest(LFUN_DIALOG_SHOW, name + " " + data));
1196 case LFUN_CITATION_INSERT: {
1197 LASSERT(lyx_view_, /**/);
1198 if (!argument.empty()) {
1199 // we can have one optional argument, delimited by '|'
1200 // citation-insert <key>|<text_before>
1201 // this should be enhanced to also support text_after
1202 // and citation style
1203 string arg = argument;
1205 if (contains(argument, "|")) {
1206 arg = token(argument, '|', 0);
1207 opt1 = token(argument, '|', 1);
1209 InsetCommandParams icp(CITE_CODE);
1210 icp["key"] = from_utf8(arg);
1212 icp["before"] = from_utf8(opt1);
1213 string icstr = InsetCommand::params2string("citation", icp);
1214 FuncRequest fr(LFUN_INSET_INSERT, icstr);
1217 dispatch(FuncRequest(LFUN_DIALOG_SHOW_NEW_INSET, "citation"));
1221 case LFUN_BUFFER_CHILD_OPEN: {
1222 LASSERT(lyx_view_ && buffer, /**/);
1223 FileName filename = makeAbsPath(argument, buffer->filePath());
1224 view()->saveBookmark(false);
1226 bool parsed = false;
1227 if (theBufferList().exists(filename)) {
1228 child = theBufferList().getBuffer(filename);
1230 setMessage(bformat(_("Opening child document %1$s..."),
1231 makeDisplayPath(filename.absFilename())));
1232 child = lyx_view_->loadDocument(filename, false);
1236 // Set the parent name of the child document.
1237 // This makes insertion of citations and references in the child work,
1238 // when the target is in the parent or another child document.
1239 child->setParent(buffer);
1240 child->masterBuffer()->updateLabels();
1241 lyx_view_->setBuffer(child);
1243 child->errors("Parse");
1246 // If a screen update is required (in case where auto_open is false),
1247 // setBuffer() would have taken care of it already. Otherwise we shall
1248 // reset the update flag because it can cause a circular problem.
1250 updateFlags = Update::None;
1254 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
1255 LASSERT(lyx_view_, /**/);
1256 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1259 case LFUN_KEYMAP_OFF:
1260 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1261 lyx_view_->view()->getIntl().keyMapOn(false);
1264 case LFUN_KEYMAP_PRIMARY:
1265 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1266 lyx_view_->view()->getIntl().keyMapPrim();
1269 case LFUN_KEYMAP_SECONDARY:
1270 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1271 lyx_view_->view()->getIntl().keyMapSec();
1274 case LFUN_KEYMAP_TOGGLE:
1275 LASSERT(lyx_view_ && lyx_view_->view(), /**/);
1276 lyx_view_->view()->getIntl().toggleKeyMap();
1282 string rest = split(argument, countstr, ' ');
1283 istringstream is(countstr);
1286 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1287 for (int i = 0; i < count; ++i)
1288 dispatch(lyxaction.lookupFunc(rest));
1292 case LFUN_COMMAND_SEQUENCE: {
1293 // argument contains ';'-terminated commands
1294 string arg = argument;
1295 if (theBufferList().isLoaded(buffer))
1296 buffer->undo().beginUndoGroup();
1297 while (!arg.empty()) {
1299 arg = split(arg, first, ';');
1300 FuncRequest func(lyxaction.lookupFunc(first));
1301 func.origin = cmd.origin;
1304 if (theBufferList().isLoaded(buffer))
1305 buffer->undo().endUndoGroup();
1309 case LFUN_COMMAND_ALTERNATIVES: {
1310 // argument contains ';'-terminated commands
1311 string arg = argument;
1312 while (!arg.empty()) {
1314 arg = split(arg, first, ';');
1315 FuncRequest func(lyxaction.lookupFunc(first));
1316 func.origin = cmd.origin;
1317 FuncStatus stat = getStatus(func);
1318 if (stat.enabled()) {
1328 if (theTopLevelCmdDef().lock(argument, func)) {
1329 func.origin = cmd.origin;
1331 theTopLevelCmdDef().release(argument);
1333 if (func.action == LFUN_UNKNOWN_ACTION) {
1334 // unknown command definition
1335 lyxerr << "Warning: unknown command definition `"
1339 // recursion detected
1340 lyxerr << "Warning: Recursion in the command definition `"
1341 << argument << "' detected"
1348 case LFUN_PREFERENCES_SAVE: {
1349 lyxrc.write(makeAbsPath("preferences",
1350 package().user_support().absFilename()),
1356 LASSERT(lyx_view_, /**/);
1357 lyx_view_->message(from_utf8(argument));
1360 case LFUN_BUFFER_LANGUAGE: {
1361 LASSERT(lyx_view_, /**/);
1362 Language const * oldL = buffer->params().language;
1363 Language const * newL = languages.getLanguage(argument);
1364 if (!newL || oldL == newL)
1367 if (oldL->rightToLeft() == newL->rightToLeft()
1368 && !buffer->isMultiLingual())
1369 buffer->changeLanguage(oldL, newL);
1373 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1374 string const fname =
1375 addName(addPath(package().user_support().absFilename(), "templates/"),
1377 Buffer defaults(fname);
1379 istringstream ss(argument);
1382 int const unknown_tokens = defaults.readHeader(lex);
1384 if (unknown_tokens != 0) {
1385 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1386 << unknown_tokens << " unknown token"
1387 << (unknown_tokens == 1 ? "" : "s")
1391 if (defaults.writeFile(FileName(defaults.absFileName())))
1392 setMessage(bformat(_("Document defaults saved in %1$s"),
1393 makeDisplayPath(fname)));
1395 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
1399 case LFUN_BUFFER_PARAMS_APPLY: {
1400 LASSERT(lyx_view_, /**/);
1402 DocumentClass const * const oldClass = buffer->params().documentClassPtr();
1403 Cursor & cur = view()->cursor();
1404 cur.recordUndoFullDocument();
1406 istringstream ss(argument);
1409 int const unknown_tokens = buffer->readHeader(lex);
1411 if (unknown_tokens != 0) {
1412 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1413 << unknown_tokens << " unknown token"
1414 << (unknown_tokens == 1 ? "" : "s")
1418 updateLayout(oldClass, buffer);
1420 updateFlags = Update::Force | Update::FitCursor;
1421 // We are most certainly here because of a change in the document
1422 // It is then better to make sure that all dialogs are in sync with
1423 // current document settings. LyXView::restartCursor() achieve this.
1424 lyx_view_->restartCursor();
1428 case LFUN_LAYOUT_MODULES_CLEAR: {
1429 LASSERT(lyx_view_, /**/);
1430 DocumentClass const * const oldClass = buffer->params().documentClassPtr();
1431 view()->cursor().recordUndoFullDocument();
1432 buffer->params().clearLayoutModules();
1433 buffer->params().makeDocumentClass();
1434 updateLayout(oldClass, buffer);
1435 updateFlags = Update::Force | Update::FitCursor;
1439 case LFUN_LAYOUT_MODULE_ADD: {
1440 LASSERT(lyx_view_, /**/);
1441 BufferParams const & params = buffer->params();
1442 if (!params.moduleCanBeAdded(argument)) {
1443 LYXERR0("Module `" << argument <<
1444 "' cannot be added due to failed requirements or "
1445 "conflicts with installed modules.");
1448 DocumentClass const * const oldClass = params.documentClassPtr();
1449 view()->cursor().recordUndoFullDocument();
1450 buffer->params().addLayoutModule(argument);
1451 buffer->params().makeDocumentClass();
1452 updateLayout(oldClass, buffer);
1453 updateFlags = Update::Force | Update::FitCursor;
1457 case LFUN_TEXTCLASS_APPLY: {
1458 LASSERT(lyx_view_, /**/);
1460 if (!loadLayoutFile(argument, buffer->temppath()) &&
1461 !loadLayoutFile(argument, buffer->filePath()))
1464 LayoutFile const * old_layout = buffer->params().baseClass();
1465 LayoutFile const * new_layout = &(LayoutFileList::get()[argument]);
1467 if (old_layout == new_layout)
1471 //Save the old, possibly modular, layout for use in conversion.
1472 DocumentClass const * const oldDocClass = buffer->params().documentClassPtr();
1473 view()->cursor().recordUndoFullDocument();
1474 buffer->params().setBaseClass(argument);
1475 buffer->params().makeDocumentClass();
1476 updateLayout(oldDocClass, buffer);
1477 updateFlags = Update::Force | Update::FitCursor;
1481 case LFUN_LAYOUT_RELOAD: {
1482 LASSERT(lyx_view_, /**/);
1483 DocumentClass const * const oldClass = buffer->params().documentClassPtr();
1484 LayoutFileIndex bc = buffer->params().baseClassID();
1485 LayoutFileList::get().reset(bc);
1486 buffer->params().setBaseClass(bc);
1487 buffer->params().makeDocumentClass();
1488 updateLayout(oldClass, buffer);
1489 updateFlags = Update::Force | Update::FitCursor;
1493 case LFUN_TEXTCLASS_LOAD:
1494 loadLayoutFile(argument, buffer->temppath()) ||
1495 loadLayoutFile(argument, buffer->filePath());
1498 case LFUN_LYXRC_APPLY: {
1499 LyXRC const lyxrc_orig = lyxrc;
1501 istringstream ss(argument);
1502 bool const success = lyxrc.read(ss) == 0;
1505 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1506 << "Unable to read lyxrc data"
1511 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1513 theApp()->resetGui();
1515 /// We force the redraw in any case because there might be
1516 /// some screen font changes.
1517 /// FIXME: only the current view will be updated. the Gui
1518 /// class is able to furnish the list of views.
1519 updateFlags = Update::Force;
1523 case LFUN_BOOKMARK_GOTO:
1524 // go to bookmark, open unopened file and switch to buffer if necessary
1525 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1526 updateFlags = Update::FitCursor;
1529 case LFUN_BOOKMARK_CLEAR:
1530 theSession().bookmarks().clear();
1533 case LFUN_VC_COMMAND: {
1534 string flag = cmd.getArg(0);
1535 if (buffer && contains(flag, 'R') && !ensureBufferClean(view()))
1538 if (contains(flag, 'M'))
1539 if (!Alert::askForText(message, _("LyX VC: Log Message")))
1542 string path = cmd.getArg(1);
1543 if (contains(path, "$$p") && buffer)
1544 path = subst(path, "$$p", buffer->filePath());
1545 LYXERR(Debug::LYXVC, "Directory: " << path);
1547 if (!pp.isReadableDirectory()) {
1548 lyxerr << _("Directory is not accessible.") << endl;
1551 support::PathChanger p(pp);
1553 string command = cmd.getArg(2);
1554 if (command.empty())
1557 command = subst(command, "$$i", buffer->absFileName());
1558 command = subst(command, "$$p", buffer->filePath());
1560 command = subst(command, "$$m", to_utf8(message));
1561 LYXERR(Debug::LYXVC, "Command: " << command);
1563 one.startscript(Systemcall::Wait, command);
1567 if (contains(flag, 'I'))
1568 buffer->markDirty();
1569 if (contains(flag, 'R'))
1576 LASSERT(theApp(), /**/);
1577 // Let the frontend dispatch its own actions.
1578 if (theApp()->dispatch(cmd))
1579 // Nothing more to do.
1582 // Everything below is only for active lyx_view_
1586 // Start an undo group. This may be needed for
1587 // some stuff like inset-apply on labels.
1588 if (theBufferList().isLoaded(buffer))
1589 buffer->undo().beginUndoGroup();
1591 // Let the current LyXView dispatch its own actions.
1592 if (lyx_view_->dispatch(cmd)) {
1593 if (lyx_view_->view()) {
1594 updateFlags = lyx_view_->view()->cursor().result().update();
1595 if (theBufferList().isLoaded(buffer))
1596 buffer->undo().endUndoGroup();
1601 LASSERT(lyx_view_->view(), /**/);
1603 // Let the current BufferView dispatch its own actions.
1604 if (view()->dispatch(cmd)) {
1605 // The BufferView took care of its own updates if needed.
1606 updateFlags = Update::None;
1607 if (theBufferList().isLoaded(buffer))
1608 buffer->undo().endUndoGroup();
1612 // OK, so try the Buffer itself
1614 view()->buffer().dispatch(cmd, dr);
1615 if (dr.dispatched()) {
1616 updateFlags = dr.update();
1620 // Is this a function that acts on inset at point?
1621 Inset * inset = view()->cursor().nextInset();
1622 if (lyxaction.funcHasFlag(action, LyXAction::AtPoint)
1624 view()->cursor().result().dispatched(true);
1625 view()->cursor().result().update(Update::FitCursor | Update::Force);
1626 FuncRequest tmpcmd = cmd;
1627 inset->dispatch(view()->cursor(), tmpcmd);
1628 if (view()->cursor().result().dispatched()) {
1629 updateFlags = view()->cursor().result().update();
1634 // Let the current Cursor dispatch its own actions.
1635 Cursor old = view()->cursor();
1636 view()->cursor().getPos(cursorPosBeforeDispatchX_,
1637 cursorPosBeforeDispatchY_);
1638 view()->cursor().dispatch(cmd);
1640 // notify insets we just left
1641 if (view()->cursor() != old) {
1643 bool badcursor = notifyCursorLeavesOrEnters(old, view()->cursor());
1645 view()->cursor().fixIfBroken();
1648 if (theBufferList().isLoaded(buffer))
1649 buffer->undo().endUndoGroup();
1651 // update completion. We do it here and not in
1652 // processKeySym to avoid another redraw just for a
1653 // changed inline completion
1654 if (cmd.origin == FuncRequest::KEYBOARD) {
1655 if (cmd.action == LFUN_SELF_INSERT)
1656 lyx_view_->updateCompletion(view()->cursor(), true, true);
1657 else if (cmd.action == LFUN_CHAR_DELETE_BACKWARD)
1658 lyx_view_->updateCompletion(view()->cursor(), false, true);
1660 lyx_view_->updateCompletion(view()->cursor(), false, false);
1663 updateFlags = view()->cursor().result().update();
1666 // if we executed a mutating lfun, mark the buffer as dirty
1667 if (theBufferList().isLoaded(buffer) && flag.enabled()
1668 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1669 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1670 buffer->markDirty();
1672 if (lyx_view_ && lyx_view_->buffer()) {
1673 // BufferView::update() updates the ViewMetricsInfo and
1674 // also initializes the position cache for all insets in
1675 // (at least partially) visible top-level paragraphs.
1676 // We will redraw the screen only if needed.
1677 view()->processUpdateFlags(updateFlags);
1679 // Do we have a selection?
1680 theSelection().haveSelection(view()->cursor().selection());
1683 lyx_view_->restartCursor();
1687 // Some messages may already be translated, so we cannot use _()
1688 sendDispatchMessage(translateIfPossible(getMessage()), cmd);
1693 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1695 const bool verbose = (cmd.origin == FuncRequest::MENU
1696 || cmd.origin == FuncRequest::TOOLBAR
1697 || cmd.origin == FuncRequest::COMMANDBUFFER);
1699 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1700 LYXERR(Debug::ACTION, "dispatch msg is " << to_utf8(msg));
1702 lyx_view_->message(msg);
1706 docstring dispatch_msg = msg;
1707 if (!dispatch_msg.empty())
1708 dispatch_msg += ' ';
1710 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1712 bool argsadded = false;
1714 if (!cmd.argument().empty()) {
1715 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1716 comname += ' ' + cmd.argument();
1721 docstring const shortcuts = theTopLevelKeymap().printBindings(cmd, KeySequence::ForGui);
1723 if (!shortcuts.empty())
1724 comname += ": " + shortcuts;
1725 else if (!argsadded && !cmd.argument().empty())
1726 comname += ' ' + cmd.argument();
1728 if (!comname.empty()) {
1729 comname = rtrim(comname);
1730 dispatch_msg += '(' + rtrim(comname) + ')';
1733 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
1734 if (!dispatch_msg.empty())
1735 lyx_view_->message(dispatch_msg);
1739 void LyXFunc::reloadBuffer()
1741 FileName filename = lyx_view_->buffer()->fileName();
1742 // The user has already confirmed that the changes, if any, should
1743 // be discarded. So we just release the Buffer and don't call closeBuffer();
1744 theBufferList().release(lyx_view_->buffer());
1745 // if the lyx_view_ has been destroyed, create a new one
1747 theApp()->dispatch(FuncRequest(LFUN_WINDOW_NEW));
1748 Buffer * buf = lyx_view_->loadDocument(filename);
1749 docstring const disp_fn = makeDisplayPath(filename.absFilename());
1752 buf->updateLabels();
1753 lyx_view_->setBuffer(buf);
1754 buf->errors("Parse");
1755 str = bformat(_("Document %1$s reloaded."), disp_fn);
1757 str = bformat(_("Could not reload document %1$s"), disp_fn);
1759 lyx_view_->message(str);
1762 // Each "lyx_view_" should have it's own message method. lyxview and
1763 // the minibuffer would use the minibuffer, but lyxserver would
1764 // send an ERROR signal to its client. Alejandro 970603
1765 // This function is bit problematic when it comes to NLS, to make the
1766 // lyx servers client be language indepenent we must not translate
1767 // strings sent to this func.
1768 void LyXFunc::setErrorMessage(docstring const & m) const
1770 dispatch_buffer = m;
1775 void LyXFunc::setMessage(docstring const & m) const
1777 dispatch_buffer = m;
1781 docstring LyXFunc::viewStatusMessage()
1783 // When meta-fake key is pressed, show the key sequence so far + "M-".
1785 return keyseq.print(KeySequence::ForGui) + "M-";
1787 // Else, when a non-complete key sequence is pressed,
1788 // show the available options.
1789 if (keyseq.length() > 0 && !keyseq.deleted())
1790 return keyseq.printOptions(true);
1792 LASSERT(lyx_view_, /**/);
1793 if (!lyx_view_->buffer())
1794 return _("Welcome to LyX!");
1796 return view()->cursor().currentState();
1800 BufferView * LyXFunc::view() const
1802 LASSERT(lyx_view_, /**/);
1803 return lyx_view_->view();
1807 bool LyXFunc::wasMetaKey() const
1809 return (meta_fake_bit != NoModifier);
1813 void LyXFunc::updateLayout(DocumentClass const * const oldlayout, Buffer * buf)
1815 lyx_view_->message(_("Converting document to new document class..."));
1817 StableDocIterator backcur(view()->cursor());
1818 ErrorList & el = buf->errorList("Class Switch");
1819 cap::switchBetweenClasses(
1820 oldlayout, buf->params().documentClassPtr(),
1821 static_cast<InsetText &>(buf->inset()), el);
1823 view()->setCursor(backcur.asDocIterator(buf));
1825 buf->errors("Class Switch");
1826 buf->updateLabels();
1832 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
1834 // Why the switch you might ask. It is a trick to ensure that all
1835 // the elements in the LyXRCTags enum is handled. As you can see
1836 // there are no breaks at all. So it is just a huge fall-through.
1837 // The nice thing is that we will get a warning from the compiler
1838 // if we forget an element.
1839 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
1841 case LyXRC::RC_ACCEPT_COMPOUND:
1842 case LyXRC::RC_ALT_LANG:
1843 case LyXRC::RC_PLAINTEXT_LINELEN:
1844 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
1845 case LyXRC::RC_AUTOCORRECTION_MATH:
1846 case LyXRC::RC_AUTOREGIONDELETE:
1847 case LyXRC::RC_AUTORESET_OPTIONS:
1848 case LyXRC::RC_AUTOSAVE:
1849 case LyXRC::RC_AUTO_NUMBER:
1850 case LyXRC::RC_BACKUPDIR_PATH:
1851 case LyXRC::RC_BIBTEX_COMMAND:
1852 case LyXRC::RC_BINDFILE:
1853 case LyXRC::RC_CHECKLASTFILES:
1854 case LyXRC::RC_COMPLETION_CURSOR_TEXT:
1855 case LyXRC::RC_COMPLETION_INLINE_DELAY:
1856 case LyXRC::RC_COMPLETION_INLINE_DOTS:
1857 case LyXRC::RC_COMPLETION_INLINE_MATH:
1858 case LyXRC::RC_COMPLETION_INLINE_TEXT:
1859 case LyXRC::RC_COMPLETION_POPUP_AFTER_COMPLETE:
1860 case LyXRC::RC_COMPLETION_POPUP_DELAY:
1861 case LyXRC::RC_COMPLETION_POPUP_MATH:
1862 case LyXRC::RC_COMPLETION_POPUP_TEXT:
1863 case LyXRC::RC_USELASTFILEPOS:
1864 case LyXRC::RC_LOADSESSION:
1865 case LyXRC::RC_CHKTEX_COMMAND:
1866 case LyXRC::RC_CONVERTER:
1867 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
1868 case LyXRC::RC_COPIER:
1869 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
1870 case LyXRC::RC_SCROLL_BELOW_DOCUMENT:
1871 case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
1872 case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
1873 case LyXRC::RC_DATE_INSERT_FORMAT:
1874 case LyXRC::RC_DEFAULT_LANGUAGE:
1875 case LyXRC::RC_GUI_LANGUAGE:
1876 case LyXRC::RC_DEFAULT_PAPERSIZE:
1877 case LyXRC::RC_DEFFILE:
1878 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
1879 case LyXRC::RC_DISPLAY_GRAPHICS:
1880 case LyXRC::RC_DOCUMENTPATH:
1881 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
1882 FileName path(lyxrc_new.document_path);
1883 if (path.exists() && path.isDirectory())
1884 package().document_dir() = FileName(lyxrc.document_path);
1886 case LyXRC::RC_ESC_CHARS:
1887 case LyXRC::RC_EXAMPLEPATH:
1888 case LyXRC::RC_FONT_ENCODING:
1889 case LyXRC::RC_FORMAT:
1890 case LyXRC::RC_GROUP_LAYOUTS:
1891 case LyXRC::RC_INDEX_COMMAND:
1892 case LyXRC::RC_NOMENCL_COMMAND:
1893 case LyXRC::RC_INPUT:
1894 case LyXRC::RC_KBMAP:
1895 case LyXRC::RC_KBMAP_PRIMARY:
1896 case LyXRC::RC_KBMAP_SECONDARY:
1897 case LyXRC::RC_LABEL_INIT_LENGTH:
1898 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
1899 case LyXRC::RC_LANGUAGE_AUTO_END:
1900 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
1901 case LyXRC::RC_LANGUAGE_COMMAND_END:
1902 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
1903 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
1904 case LyXRC::RC_LANGUAGE_PACKAGE:
1905 case LyXRC::RC_LANGUAGE_USE_BABEL:
1906 case LyXRC::RC_MAC_LIKE_WORD_MOVEMENT:
1907 case LyXRC::RC_MACRO_EDIT_STYLE:
1908 case LyXRC::RC_MAKE_BACKUP:
1909 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
1910 case LyXRC::RC_MOUSE_WHEEL_SPEED:
1911 case LyXRC::RC_NUMLASTFILES:
1912 case LyXRC::RC_PATH_PREFIX:
1913 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
1914 prependEnvPath("PATH", lyxrc.path_prefix);
1916 case LyXRC::RC_PERS_DICT:
1917 case LyXRC::RC_PREVIEW:
1918 case LyXRC::RC_PREVIEW_HASHED_LABELS:
1919 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
1920 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
1921 case LyXRC::RC_PRINTCOPIESFLAG:
1922 case LyXRC::RC_PRINTER:
1923 case LyXRC::RC_PRINTEVENPAGEFLAG:
1924 case LyXRC::RC_PRINTEXSTRAOPTIONS:
1925 case LyXRC::RC_PRINTFILEEXTENSION:
1926 case LyXRC::RC_PRINTLANDSCAPEFLAG:
1927 case LyXRC::RC_PRINTODDPAGEFLAG:
1928 case LyXRC::RC_PRINTPAGERANGEFLAG:
1929 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
1930 case LyXRC::RC_PRINTPAPERFLAG:
1931 case LyXRC::RC_PRINTREVERSEFLAG:
1932 case LyXRC::RC_PRINTSPOOL_COMMAND:
1933 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
1934 case LyXRC::RC_PRINTTOFILE:
1935 case LyXRC::RC_PRINTTOPRINTER:
1936 case LyXRC::RC_PRINT_ADAPTOUTPUT:
1937 case LyXRC::RC_PRINT_COMMAND:
1938 case LyXRC::RC_RTL_SUPPORT:
1939 case LyXRC::RC_SCREEN_DPI:
1940 case LyXRC::RC_SCREEN_FONT_ROMAN:
1941 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
1942 case LyXRC::RC_SCREEN_FONT_SANS:
1943 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
1944 case LyXRC::RC_SCREEN_FONT_SCALABLE:
1945 case LyXRC::RC_SCREEN_FONT_SIZES:
1946 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
1947 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
1948 case LyXRC::RC_GEOMETRY_SESSION:
1949 case LyXRC::RC_SCREEN_ZOOM:
1950 case LyXRC::RC_SERVERPIPE:
1951 case LyXRC::RC_SET_COLOR:
1952 case LyXRC::RC_SHOW_BANNER:
1953 case LyXRC::RC_OPEN_BUFFERS_IN_TABS:
1954 case LyXRC::RC_SPELL_COMMAND:
1955 case LyXRC::RC_SPELLCHECK_CONTINUOUSLY:
1956 case LyXRC::RC_TEMPDIRPATH:
1957 case LyXRC::RC_TEMPLATEPATH:
1958 case LyXRC::RC_TEX_ALLOWS_SPACES:
1959 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
1960 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
1961 os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
1963 case LyXRC::RC_THESAURUSDIRPATH:
1964 case LyXRC::RC_UIFILE:
1965 case LyXRC::RC_USER_EMAIL:
1966 case LyXRC::RC_USER_NAME:
1967 case LyXRC::RC_USETEMPDIR:
1968 case LyXRC::RC_USE_ALT_LANG:
1969 case LyXRC::RC_USE_CONVERTER_CACHE:
1970 case LyXRC::RC_USE_ESC_CHARS:
1971 case LyXRC::RC_USE_INP_ENC:
1972 case LyXRC::RC_USE_PERS_DICT:
1973 case LyXRC::RC_USE_TOOLTIP:
1974 case LyXRC::RC_USE_PIXMAP_CACHE:
1975 case LyXRC::RC_USE_SPELL_LIB:
1976 case LyXRC::RC_VIEWDVI_PAPEROPTION:
1977 case LyXRC::RC_SORT_LAYOUTS:
1978 case LyXRC::RC_FULL_SCREEN_LIMIT:
1979 case LyXRC::RC_FULL_SCREEN_SCROLLBAR:
1980 case LyXRC::RC_FULL_SCREEN_TABBAR:
1981 case LyXRC::RC_FULL_SCREEN_TOOLBARS:
1982 case LyXRC::RC_FULL_SCREEN_WIDTH:
1983 case LyXRC::RC_VISUAL_CURSOR:
1984 case LyXRC::RC_VIEWER:
1985 case LyXRC::RC_LAST: