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"
46 #include "LaTeXFeatures.h"
48 #include "LyXAction.h"
53 #include "Paragraph.h"
54 #include "ParagraphParameters.h"
55 #include "ParIterator.h"
59 #include "SpellChecker.h"
61 #include "frontends/alert.h"
62 #include "frontends/Application.h"
63 #include "frontends/KeySymbol.h"
64 #include "frontends/LyXView.h"
65 #include "frontends/Selection.h"
67 #include "support/debug.h"
68 #include "support/environment.h"
69 #include "support/FileName.h"
70 #include "support/filetools.h"
71 #include "support/gettext.h"
72 #include "support/lassert.h"
73 #include "support/lstrings.h"
74 #include "support/Path.h"
75 #include "support/Package.h"
76 #include "support/Systemcall.h"
77 #include "support/convert.h"
78 #include "support/os.h"
84 using namespace lyx::support;
88 using frontend::LyXView;
90 namespace Alert = frontend::Alert;
95 // This function runs "configure" and then rereads lyx.defaults to
96 // reconfigure the automatic settings.
97 void reconfigure(LyXView * lv, string const & option)
99 // emit message signal.
101 lv->message(_("Running configure..."));
103 // Run configure in user lyx directory
104 PathChanger p(package().user_support());
105 string configure_command = package().configure_command();
106 configure_command += option;
108 int ret = one.startscript(Systemcall::Wait, configure_command);
110 // emit message signal.
112 lv->message(_("Reloading configuration..."));
113 lyxrc.read(libFileSearch(string(), "lyxrc.defaults"));
114 // Re-read packages.lst
115 LaTeXFeatures::getAvailable();
118 Alert::information(_("System reconfiguration failed"),
119 _("The system reconfiguration has failed.\n"
120 "Default textclass is used but LyX may "
121 "not be able to work properly.\n"
122 "Please reconfigure again if needed."));
125 Alert::information(_("System reconfigured"),
126 _("The system has been reconfigured.\n"
127 "You need to restart LyX to make use of any\n"
128 "updated document class specifications."));
135 : encoded_last_key(0), meta_fake_bit(NoModifier)
140 void LyXFunc::initKeySequences(KeyMap * kb)
142 keyseq = KeySequence(kb, kb);
143 cancel_meta_seq = KeySequence(kb, kb);
147 void LyXFunc::handleKeyFunc(FuncCode action)
149 char_type c = encoded_last_key;
153 LyXView * lv = theApp()->currentWindow();
154 LASSERT(lv && lv->currentBufferView(), /**/);
155 BufferView * bv = lv->currentBufferView();
156 bv->getIntl().getTransManager().deadkey(
157 c, get_accent(action).accent, bv->cursor().innerText(),
159 // Need to clear, in case the minibuffer calls these
162 // copied verbatim from do_accent_char
163 bv->cursor().resetAnchor();
164 bv->processUpdateFlags(Update::FitCursor);
167 //FIXME: bookmark handling is a frontend issue. This code should be transferred
168 // to GuiView and be GuiView and be window dependent.
169 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
171 LyXView * lv = theApp()->currentWindow();
173 if (!theSession().bookmarks().isValid(idx))
175 BookmarksSection::Bookmark const & bm = theSession().bookmarks().bookmark(idx);
176 LASSERT(!bm.filename.empty(), /**/);
177 string const file = bm.filename.absFilename();
178 // if the file is not opened, open it.
179 if (!theBufferList().exists(bm.filename)) {
181 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
185 // open may fail, so we need to test it again
186 if (!theBufferList().exists(bm.filename))
189 // bm can be changed when saving
190 BookmarksSection::Bookmark tmp = bm;
192 // Special case idx == 0 used for back-from-back jump navigation
194 dispatch(FuncRequest(LFUN_BOOKMARK_SAVE, "0"));
196 // if the current buffer is not that one, switch to it.
197 if (!lv->documentBufferView()
198 || lv->documentBufferView()->buffer().fileName() != tmp.filename) {
201 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
204 // moveToPosition try paragraph id first and then paragraph (pit, pos).
205 if (!lv->documentBufferView()->moveToPosition(
206 tmp.bottom_pit, tmp.bottom_pos, tmp.top_id, tmp.top_pos))
213 // Cursor jump succeeded!
214 Cursor const & cur = lv->documentBufferView()->cursor();
215 pit_type new_pit = cur.pit();
216 pos_type new_pos = cur.pos();
217 int new_id = cur.paragraph().id();
219 // if bottom_pit, bottom_pos or top_id has been changed, update bookmark
220 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
221 if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos
222 || bm.top_id != new_id) {
223 const_cast<BookmarksSection::Bookmark &>(bm).updatePos(
224 new_pit, new_pos, new_id);
229 void LyXFunc::processKeySym(KeySymbol const & keysym, KeyModifier state)
231 LYXERR(Debug::KEY, "KeySym is " << keysym.getSymbolName());
233 LyXView * lv = theApp()->currentWindow();
235 // Do nothing if we have nothing (JMarc)
236 if (!keysym.isOK()) {
237 LYXERR(Debug::KEY, "Empty kbd action (probably composing)");
242 if (keysym.isModifier()) {
243 LYXERR(Debug::KEY, "isModifier true");
249 //Encoding const * encoding = lv->documentBufferView()->cursor().getEncoding();
250 //encoded_last_key = keysym.getISOEncoded(encoding ? encoding->name() : "");
251 // FIXME: encoded_last_key shadows the member variable of the same
252 // name. Is that intended?
253 char_type encoded_last_key = keysym.getUCSEncoded();
255 // Do a one-deep top-level lookup for
256 // cancel and meta-fake keys. RVDK_PATCH_5
257 cancel_meta_seq.reset();
259 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
260 LYXERR(Debug::KEY, "action first set to [" << func.action << ']');
262 // When not cancel or meta-fake, do the normal lookup.
263 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
264 // Mostly, meta_fake_bit = NoModifier. RVDK_PATCH_5.
265 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
266 // remove Caps Lock and Mod2 as a modifiers
267 func = keyseq.addkey(keysym, (state | meta_fake_bit));
268 LYXERR(Debug::KEY, "action now set to [" << func.action << ']');
271 // Dont remove this unless you know what you are doing.
272 meta_fake_bit = NoModifier;
274 // Can this happen now ?
275 if (func.action == LFUN_NOACTION)
276 func = FuncRequest(LFUN_COMMAND_PREFIX);
278 LYXERR(Debug::KEY, " Key [action=" << func.action << "]["
279 << keyseq.print(KeySequence::Portable) << ']');
281 // already here we know if it any point in going further
282 // why not return already here if action == -1 and
283 // num_bytes == 0? (Lgb)
285 if (keyseq.length() > 1)
286 lv->message(keyseq.print(KeySequence::ForGui));
289 // Maybe user can only reach the key via holding down shift.
290 // Let's see. But only if shift is the only modifier
291 if (func.action == LFUN_UNKNOWN_ACTION && state == ShiftModifier) {
292 LYXERR(Debug::KEY, "Trying without shift");
293 func = keyseq.addkey(keysym, NoModifier);
294 LYXERR(Debug::KEY, "Action now " << func.action);
297 if (func.action == LFUN_UNKNOWN_ACTION) {
298 // Hmm, we didn't match any of the keysequences. See
299 // if it's normal insertable text not already covered
301 if (keysym.isText() && keyseq.length() == 1) {
302 LYXERR(Debug::KEY, "isText() is true, inserting.");
303 func = FuncRequest(LFUN_SELF_INSERT,
304 FuncRequest::KEYBOARD);
306 LYXERR(Debug::KEY, "Unknown, !isText() - giving up");
307 lv->message(_("Unknown function."));
313 if (func.action == LFUN_SELF_INSERT) {
314 if (encoded_last_key != 0) {
315 docstring const arg(1, encoded_last_key);
316 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
317 FuncRequest::KEYBOARD));
318 LYXERR(Debug::KEY, "SelfInsert arg[`" << to_utf8(arg) << "']");
328 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
330 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
333 if (cmd.action == LFUN_NOACTION) {
334 flag.message(from_utf8(N_("Nothing to do")));
335 flag.setEnabled(false);
339 switch (cmd.action) {
340 case LFUN_UNKNOWN_ACTION:
342 flag.setEnabled(false);
349 if (flag.unknown()) {
350 flag.message(from_utf8(N_("Unknown action")));
354 if (!flag.enabled()) {
355 if (flag.message().empty())
356 flag.message(from_utf8(N_("Command disabled")));
360 // I would really like to avoid having this switch and rather try to
361 // encode this in the function itself.
362 // -- And I'd rather let an inset decide which LFUNs it is willing
363 // to handle (Andre')
365 switch (cmd.action) {
367 // This could be used for the no-GUI version. The GUI version is handled in
368 // LyXView::getStatus(). See above.
370 case LFUN_BUFFER_WRITE:
371 case LFUN_BUFFER_WRITE_AS: {
372 Buffer * b = theBufferList().getBuffer(FileName(cmd.getArg(0)));
373 enable = b && (b->isUnnamed() || !b->isClean());
378 case LFUN_BOOKMARK_GOTO: {
379 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
380 enable = theSession().bookmarks().isValid(num);
384 case LFUN_BOOKMARK_CLEAR:
385 enable = theSession().bookmarks().hasValid();
388 // this one is difficult to get right. As a half-baked
389 // solution, we consider only the first action of the sequence
390 case LFUN_COMMAND_SEQUENCE: {
391 // argument contains ';'-terminated commands
392 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
393 FuncRequest func(lyxaction.lookupFunc(firstcmd));
394 func.origin = cmd.origin;
395 flag = getStatus(func);
399 // we want to check if at least one of these is enabled
400 case LFUN_COMMAND_ALTERNATIVES: {
401 // argument contains ';'-terminated commands
402 string arg = to_utf8(cmd.argument());
403 while (!arg.empty()) {
405 arg = split(arg, first, ';');
406 FuncRequest func(lyxaction.lookupFunc(first));
407 func.origin = cmd.origin;
408 flag = getStatus(func);
409 // if this one is enabled, the whole thing is
418 string name = to_utf8(cmd.argument());
419 if (theTopLevelCmdDef().lock(name, func)) {
420 func.origin = cmd.origin;
421 flag = getStatus(func);
422 theTopLevelCmdDef().release(name);
424 // catch recursion or unknown command
425 // definition. all operations until the
426 // recursion or unknown command definition
427 // occurs are performed, so set the state to
434 case LFUN_COMMAND_PREFIX:
436 case LFUN_META_PREFIX:
437 case LFUN_RECONFIGURE:
438 case LFUN_DROP_LAYOUTS_CHOICE:
439 case LFUN_SERVER_GET_FILENAME:
440 case LFUN_SERVER_NOTIFY:
441 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
443 case LFUN_PREFERENCES_SAVE:
444 case LFUN_INSET_EDIT:
445 case LFUN_BUFFER_SAVE_AS_DEFAULT:
446 case LFUN_LYXRC_APPLY:
447 // these are handled in our dispatch()
455 if (theApp()->getStatus(cmd, flag))
458 // Does the view know something?
459 LyXView * lv = theApp()->currentWindow();
464 if (lv->getStatus(cmd, flag))
467 BufferView * bv = lv->currentBufferView();
468 BufferView * doc_bv = lv->documentBufferView();
469 // If we do not have a BufferView, then other functions are disabled
474 // try the BufferView
475 bool decided = bv->getStatus(cmd, flag);
478 decided = bv->buffer().getStatus(cmd, flag);
479 if (!decided && doc_bv)
480 // try the Document Buffer
481 decided = doc_bv->buffer().getStatus(cmd, flag);
485 flag.setEnabled(false);
487 // the default error message if we disable the command
488 if (!flag.enabled() && flag.message().empty())
489 flag.message(from_utf8(N_("Command disabled")));
497 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
502 void LyXFunc::dispatch(FuncRequest const & cmd)
504 string const argument = to_utf8(cmd.argument());
505 FuncCode const action = cmd.action;
507 LYXERR(Debug::ACTION, "\nLyXFunc::dispatch: cmd: " << cmd);
508 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
510 // we have not done anything wrong yet.
512 dispatch_buffer.erase();
514 // redraw the screen at the end (first of the two drawing steps).
515 //This is done unless explicitely requested otherwise
516 Update::flags updateFlags = Update::FitCursor;
518 LyXView * lv = theApp()->currentWindow();
520 FuncStatus const flag = getStatus(cmd);
521 if (!flag.enabled()) {
522 // We cannot use this function here
523 LYXERR(Debug::ACTION, "LyXFunc::dispatch: "
524 << lyxaction.getActionName(action)
525 << " [" << action << "] is disabled at this location");
526 setErrorMessage(flag.message());
531 if (lv && lv->currentBufferView())
532 buffer = &lv->currentBufferView()->buffer();
535 case LFUN_COMMAND_PREFIX:
537 lv->message(keyseq.printOptions(true));
541 LASSERT(lv && lv->currentBufferView(), /**/);
543 meta_fake_bit = NoModifier;
545 // cancel any selection
546 dispatch(FuncRequest(LFUN_MARK_OFF));
547 setMessage(from_ascii(N_("Cancel")));
550 case LFUN_META_PREFIX:
551 meta_fake_bit = AltModifier;
552 setMessage(keyseq.print(KeySequence::ForGui));
555 // --- Menus -----------------------------------------------
556 case LFUN_RECONFIGURE:
557 // argument is any additional parameter to the configure.py command
558 reconfigure(lv, argument);
561 // --- lyxserver commands ----------------------------
562 case LFUN_SERVER_GET_FILENAME:
563 LASSERT(lv && buffer, /**/);
564 setMessage(from_utf8(buffer->absFileName()));
565 LYXERR(Debug::INFO, "FNAME["
566 << buffer->absFileName() << ']');
569 case LFUN_SERVER_NOTIFY:
570 dispatch_buffer = keyseq.print(KeySequence::Portable);
571 theServer().notifyClient(to_utf8(dispatch_buffer));
574 case LFUN_CURSOR_FOLLOWS_SCROLLBAR_TOGGLE:
576 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
582 string rest = split(argument, countstr, ' ');
583 istringstream is(countstr);
586 //lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
587 for (int i = 0; i < count; ++i)
588 dispatch(lyxaction.lookupFunc(rest));
592 case LFUN_COMMAND_SEQUENCE: {
593 // argument contains ';'-terminated commands
594 string arg = argument;
595 if (theBufferList().isLoaded(buffer))
596 buffer->undo().beginUndoGroup();
597 while (!arg.empty()) {
599 arg = split(arg, first, ';');
600 FuncRequest func(lyxaction.lookupFunc(first));
601 func.origin = cmd.origin;
604 if (theBufferList().isLoaded(buffer))
605 buffer->undo().endUndoGroup();
609 case LFUN_COMMAND_ALTERNATIVES: {
610 // argument contains ';'-terminated commands
611 string arg = argument;
612 while (!arg.empty()) {
614 arg = split(arg, first, ';');
615 FuncRequest func(lyxaction.lookupFunc(first));
616 func.origin = cmd.origin;
617 FuncStatus stat = getStatus(func);
618 if (stat.enabled()) {
628 if (theTopLevelCmdDef().lock(argument, func)) {
629 func.origin = cmd.origin;
631 theTopLevelCmdDef().release(argument);
633 if (func.action == LFUN_UNKNOWN_ACTION) {
634 // unknown command definition
635 lyxerr << "Warning: unknown command definition `"
639 // recursion detected
640 lyxerr << "Warning: Recursion in the command definition `"
641 << argument << "' detected"
648 case LFUN_PREFERENCES_SAVE: {
649 lyxrc.write(makeAbsPath("preferences",
650 package().user_support().absFilename()),
655 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
657 addName(addPath(package().user_support().absFilename(), "templates/"),
659 Buffer defaults(fname);
661 istringstream ss(argument);
664 int const unknown_tokens = defaults.readHeader(lex);
666 if (unknown_tokens != 0) {
667 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
668 << unknown_tokens << " unknown token"
669 << (unknown_tokens == 1 ? "" : "s")
673 if (defaults.writeFile(FileName(defaults.absFileName())))
674 setMessage(bformat(_("Document defaults saved in %1$s"),
675 makeDisplayPath(fname)));
677 setErrorMessage(from_ascii(N_("Unable to save document defaults")));
681 case LFUN_LYXRC_APPLY: {
682 // reset active key sequences, since the bindings
683 // are updated (bug 6064)
685 LyXRC const lyxrc_orig = lyxrc;
687 istringstream ss(argument);
688 bool const success = lyxrc.read(ss) == 0;
691 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
692 << "Unable to read lyxrc data"
697 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
701 theApp()->resetGui();
703 /// We force the redraw in any case because there might be
704 /// some screen font changes.
705 /// FIXME: only the current view will be updated. the Gui
706 /// class is able to furnish the list of views.
707 updateFlags = Update::Force;
711 case LFUN_BOOKMARK_GOTO:
712 // go to bookmark, open unopened file and switch to buffer if necessary
713 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
714 updateFlags = Update::FitCursor;
717 case LFUN_BOOKMARK_CLEAR:
718 theSession().bookmarks().clear();
722 LASSERT(theApp(), /**/);
723 // Let the frontend dispatch its own actions.
724 if (theApp()->dispatch(cmd))
725 // Nothing more to do.
728 // Everything below is only for active window
732 // Start an undo group. This may be needed for
733 // some stuff like inset-apply on labels.
734 if (theBufferList().isLoaded(buffer))
735 buffer->undo().beginUndoGroup();
737 // Let the current LyXView dispatch its own actions.
738 if (lv->dispatch(cmd)) {
739 BufferView * bv = lv->currentBufferView();
741 buffer = &(bv->buffer());
742 updateFlags = bv->cursor().result().update();
743 if (theBufferList().isLoaded(buffer))
744 buffer->undo().endUndoGroup();
749 BufferView * bv = lv->currentBufferView();
752 // Let the current BufferView dispatch its own actions.
753 if (bv->dispatch(cmd)) {
754 // The BufferView took care of its own updates if needed.
755 buffer = &(bv->buffer());
756 updateFlags = Update::None;
757 if (theBufferList().isLoaded(buffer))
758 buffer->undo().endUndoGroup();
762 BufferView * doc_bv = lv->documentBufferView();
763 // Try with the document BufferView dispatch if any.
764 if (doc_bv && doc_bv->dispatch(cmd)) {
765 // The BufferView took care of its own updates if needed.
766 buffer = &(doc_bv->buffer());
767 updateFlags = Update::None;
768 if (theBufferList().isLoaded(buffer))
769 buffer->undo().endUndoGroup();
773 // OK, so try the current Buffer itself...
775 bv->buffer().dispatch(cmd, dr);
776 if (dr.dispatched()) {
777 updateFlags = dr.update();
780 // and with the document Buffer.
782 doc_bv->buffer().dispatch(cmd, dr);
783 if (dr.dispatched()) {
784 updateFlags = dr.update();
789 // Is this a function that acts on inset at point?
790 Inset * inset = bv->cursor().nextInset();
791 if (lyxaction.funcHasFlag(action, LyXAction::AtPoint)
793 bv->cursor().result().dispatched(true);
794 bv->cursor().result().update(Update::FitCursor | Update::Force);
795 FuncRequest tmpcmd = cmd;
796 inset->dispatch(bv->cursor(), tmpcmd);
797 if (bv->cursor().result().dispatched()) {
798 updateFlags = bv->cursor().result().update();
803 // Let the current Cursor dispatch its own actions.
804 Cursor old = bv->cursor();
805 bv->cursor().getPos(cursorPosBeforeDispatchX_,
806 cursorPosBeforeDispatchY_);
807 bv->cursor().dispatch(cmd);
809 // notify insets we just left
810 if (bv->cursor() != old) {
812 bool badcursor = notifyCursorLeavesOrEnters(old, bv->cursor());
814 bv->cursor().fixIfBroken();
817 if (theBufferList().isLoaded(buffer))
818 buffer->undo().endUndoGroup();
820 // update completion. We do it here and not in
821 // processKeySym to avoid another redraw just for a
822 // changed inline completion
823 if (cmd.origin == FuncRequest::KEYBOARD) {
824 if (cmd.action == LFUN_SELF_INSERT
825 || (cmd.action == LFUN_ERT_INSERT && bv->cursor().inMathed()))
826 lv->updateCompletion(bv->cursor(), true, true);
827 else if (cmd.action == LFUN_CHAR_DELETE_BACKWARD)
828 lv->updateCompletion(bv->cursor(), false, true);
830 lv->updateCompletion(bv->cursor(), false, false);
833 updateFlags = bv->cursor().result().update();
836 // if we executed a mutating lfun, mark the buffer as dirty
837 if (theBufferList().isLoaded(buffer) && flag.enabled()
838 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
839 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
842 if (lv && lv->currentBufferView()) {
843 // BufferView::update() updates the ViewMetricsInfo and
844 // also initializes the position cache for all insets in
845 // (at least partially) visible top-level paragraphs.
846 // We will redraw the screen only if needed.
847 lv->currentBufferView()->processUpdateFlags(updateFlags);
849 // Do we have a selection?
850 theSelection().haveSelection(
851 lv->currentBufferView()->cursor().selection());
858 // Some messages may already be translated, so we cannot use _()
859 sendDispatchMessage(translateIfPossible(getMessage()), cmd);
864 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
866 const bool verbose = (cmd.origin == FuncRequest::MENU
867 || cmd.origin == FuncRequest::TOOLBAR
868 || cmd.origin == FuncRequest::COMMANDBUFFER);
870 LyXView * lv = theApp()->currentWindow();
871 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
872 LYXERR(Debug::ACTION, "dispatch msg is " << to_utf8(msg));
878 docstring dispatch_msg = msg;
879 if (!dispatch_msg.empty())
882 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
884 bool argsadded = false;
886 if (!cmd.argument().empty()) {
887 if (cmd.action != LFUN_UNKNOWN_ACTION) {
888 comname += ' ' + cmd.argument();
893 docstring const shortcuts = theTopLevelKeymap().printBindings(cmd, KeySequence::ForGui);
895 if (!shortcuts.empty())
896 comname += ": " + shortcuts;
897 else if (!argsadded && !cmd.argument().empty())
898 comname += ' ' + cmd.argument();
900 if (!comname.empty()) {
901 comname = rtrim(comname);
902 dispatch_msg += '(' + rtrim(comname) + ')';
905 LYXERR(Debug::ACTION, "verbose dispatch msg " << to_utf8(dispatch_msg));
906 if (!dispatch_msg.empty())
907 lv->message(dispatch_msg);
911 // Each LyXView should have it's own message method. lyxview and
912 // the minibuffer would use the minibuffer, but lyxserver would
913 // send an ERROR signal to its client. Alejandro 970603
914 // This function is bit problematic when it comes to NLS, to make the
915 // lyx servers client be language indepenent we must not translate
916 // strings sent to this func.
917 void LyXFunc::setErrorMessage(docstring const & m) const
924 void LyXFunc::setMessage(docstring const & m) const
930 docstring LyXFunc::viewStatusMessage()
932 // When meta-fake key is pressed, show the key sequence so far + "M-".
934 return keyseq.print(KeySequence::ForGui) + "M-";
936 // Else, when a non-complete key sequence is pressed,
937 // show the available options.
938 if (keyseq.length() > 0 && !keyseq.deleted())
939 return keyseq.printOptions(true);
941 LyXView * lv = theApp()->currentWindow();
943 if (!lv->currentBufferView())
944 return _("Welcome to LyX!");
946 return lv->currentBufferView()->cursor().currentState();
950 bool LyXFunc::wasMetaKey() const
952 return (meta_fake_bit != NoModifier);
958 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
960 // Why the switch you might ask. It is a trick to ensure that all
961 // the elements in the LyXRCTags enum is handled. As you can see
962 // there are no breaks at all. So it is just a huge fall-through.
963 // The nice thing is that we will get a warning from the compiler
964 // if we forget an element.
965 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
967 case LyXRC::RC_ACCEPT_COMPOUND:
968 case LyXRC::RC_ALT_LANG:
969 case LyXRC::RC_PLAINTEXT_LINELEN:
970 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
971 case LyXRC::RC_AUTOCORRECTION_MATH:
972 case LyXRC::RC_AUTOREGIONDELETE:
973 case LyXRC::RC_AUTORESET_OPTIONS:
974 case LyXRC::RC_AUTOSAVE:
975 case LyXRC::RC_AUTO_NUMBER:
976 case LyXRC::RC_BACKUPDIR_PATH:
977 case LyXRC::RC_BIBTEX_ALTERNATIVES:
978 case LyXRC::RC_BIBTEX_COMMAND:
979 case LyXRC::RC_BINDFILE:
980 case LyXRC::RC_CHECKLASTFILES:
981 case LyXRC::RC_COMPLETION_CURSOR_TEXT:
982 case LyXRC::RC_COMPLETION_INLINE_DELAY:
983 case LyXRC::RC_COMPLETION_INLINE_DOTS:
984 case LyXRC::RC_COMPLETION_INLINE_MATH:
985 case LyXRC::RC_COMPLETION_INLINE_TEXT:
986 case LyXRC::RC_COMPLETION_POPUP_AFTER_COMPLETE:
987 case LyXRC::RC_COMPLETION_POPUP_DELAY:
988 case LyXRC::RC_COMPLETION_POPUP_MATH:
989 case LyXRC::RC_COMPLETION_POPUP_TEXT:
990 case LyXRC::RC_USELASTFILEPOS:
991 case LyXRC::RC_LOADSESSION:
992 case LyXRC::RC_CHKTEX_COMMAND:
993 case LyXRC::RC_CONVERTER:
994 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
995 case LyXRC::RC_COPIER:
996 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
997 case LyXRC::RC_SCROLL_BELOW_DOCUMENT:
998 case LyXRC::RC_DATE_INSERT_FORMAT:
999 case LyXRC::RC_DEFAULT_LANGUAGE:
1000 case LyXRC::RC_GUI_LANGUAGE:
1001 case LyXRC::RC_DEFAULT_PAPERSIZE:
1002 case LyXRC::RC_DEFAULT_VIEW_FORMAT:
1003 case LyXRC::RC_DEFFILE:
1004 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
1005 case LyXRC::RC_DISPLAY_GRAPHICS:
1006 case LyXRC::RC_DOCUMENTPATH:
1007 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
1008 FileName path(lyxrc_new.document_path);
1009 if (path.exists() && path.isDirectory())
1010 package().document_dir() = FileName(lyxrc.document_path);
1012 case LyXRC::RC_EDITOR_ALTERNATIVES:
1013 case LyXRC::RC_ESC_CHARS:
1014 case LyXRC::RC_EXAMPLEPATH:
1015 case LyXRC::RC_FONT_ENCODING:
1016 case LyXRC::RC_FORMAT:
1017 case LyXRC::RC_GROUP_LAYOUTS:
1018 case LyXRC::RC_HUNSPELLDIR_PATH:
1019 case LyXRC::RC_INDEX_ALTERNATIVES:
1020 case LyXRC::RC_INDEX_COMMAND:
1021 case LyXRC::RC_JBIBTEX_COMMAND:
1022 case LyXRC::RC_JINDEX_COMMAND:
1023 case LyXRC::RC_NOMENCL_COMMAND:
1024 case LyXRC::RC_INPUT:
1025 case LyXRC::RC_KBMAP:
1026 case LyXRC::RC_KBMAP_PRIMARY:
1027 case LyXRC::RC_KBMAP_SECONDARY:
1028 case LyXRC::RC_LABEL_INIT_LENGTH:
1029 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
1030 case LyXRC::RC_LANGUAGE_AUTO_END:
1031 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
1032 case LyXRC::RC_LANGUAGE_COMMAND_END:
1033 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
1034 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
1035 case LyXRC::RC_LANGUAGE_PACKAGE:
1036 case LyXRC::RC_LANGUAGE_USE_BABEL:
1037 case LyXRC::RC_MAC_LIKE_WORD_MOVEMENT:
1038 case LyXRC::RC_MACRO_EDIT_STYLE:
1039 case LyXRC::RC_MAKE_BACKUP:
1040 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
1041 case LyXRC::RC_MOUSE_WHEEL_SPEED:
1042 case LyXRC::RC_NUMLASTFILES:
1043 case LyXRC::RC_PARAGRAPH_MARKERS:
1044 case LyXRC::RC_PATH_PREFIX:
1045 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
1046 prependEnvPath("PATH", lyxrc.path_prefix);
1048 case LyXRC::RC_PERS_DICT:
1049 case LyXRC::RC_PREVIEW:
1050 case LyXRC::RC_PREVIEW_HASHED_LABELS:
1051 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
1052 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
1053 case LyXRC::RC_PRINTCOPIESFLAG:
1054 case LyXRC::RC_PRINTER:
1055 case LyXRC::RC_PRINTEVENPAGEFLAG:
1056 case LyXRC::RC_PRINTEXSTRAOPTIONS:
1057 case LyXRC::RC_PRINTFILEEXTENSION:
1058 case LyXRC::RC_PRINTLANDSCAPEFLAG:
1059 case LyXRC::RC_PRINTODDPAGEFLAG:
1060 case LyXRC::RC_PRINTPAGERANGEFLAG:
1061 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
1062 case LyXRC::RC_PRINTPAPERFLAG:
1063 case LyXRC::RC_PRINTREVERSEFLAG:
1064 case LyXRC::RC_PRINTSPOOL_COMMAND:
1065 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
1066 case LyXRC::RC_PRINTTOFILE:
1067 case LyXRC::RC_PRINTTOPRINTER:
1068 case LyXRC::RC_PRINT_ADAPTOUTPUT:
1069 case LyXRC::RC_PRINT_COMMAND:
1070 case LyXRC::RC_RTL_SUPPORT:
1071 case LyXRC::RC_SCREEN_DPI:
1072 case LyXRC::RC_SCREEN_FONT_ROMAN:
1073 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
1074 case LyXRC::RC_SCREEN_FONT_SANS:
1075 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
1076 case LyXRC::RC_SCREEN_FONT_SCALABLE:
1077 case LyXRC::RC_SCREEN_FONT_SIZES:
1078 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
1079 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
1080 case LyXRC::RC_GEOMETRY_SESSION:
1081 case LyXRC::RC_SCREEN_ZOOM:
1082 case LyXRC::RC_SERVERPIPE:
1083 case LyXRC::RC_SET_COLOR:
1084 case LyXRC::RC_SHOW_BANNER:
1085 case LyXRC::RC_OPEN_BUFFERS_IN_TABS:
1086 case LyXRC::RC_SPELL_COMMAND:
1087 case LyXRC::RC_SPELLCHECKER:
1088 case LyXRC::RC_SPELLCHECK_CONTINUOUSLY:
1089 case LyXRC::RC_SPLITINDEX_COMMAND:
1090 case LyXRC::RC_TEMPDIRPATH:
1091 case LyXRC::RC_TEMPLATEPATH:
1092 case LyXRC::RC_TEX_ALLOWS_SPACES:
1093 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
1094 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
1095 os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
1097 case LyXRC::RC_THESAURUSDIRPATH:
1098 case LyXRC::RC_UIFILE:
1099 case LyXRC::RC_USER_EMAIL:
1100 case LyXRC::RC_USER_NAME:
1101 case LyXRC::RC_USETEMPDIR:
1102 case LyXRC::RC_USE_ALT_LANG:
1103 case LyXRC::RC_USE_CONVERTER_CACHE:
1104 case LyXRC::RC_USE_ESC_CHARS:
1105 case LyXRC::RC_USE_INP_ENC:
1106 case LyXRC::RC_USE_PERS_DICT:
1107 case LyXRC::RC_USE_TOOLTIP:
1108 case LyXRC::RC_USE_PIXMAP_CACHE:
1109 case LyXRC::RC_USE_SPELL_LIB:
1110 case LyXRC::RC_VIEWDVI_PAPEROPTION:
1111 case LyXRC::RC_SORT_LAYOUTS:
1112 case LyXRC::RC_FULL_SCREEN_LIMIT:
1113 case LyXRC::RC_FULL_SCREEN_SCROLLBAR:
1114 case LyXRC::RC_FULL_SCREEN_MENUBAR:
1115 case LyXRC::RC_FULL_SCREEN_TABBAR:
1116 case LyXRC::RC_FULL_SCREEN_TOOLBARS:
1117 case LyXRC::RC_FULL_SCREEN_WIDTH:
1118 case LyXRC::RC_VISUAL_CURSOR:
1119 case LyXRC::RC_VIEWER:
1120 case LyXRC::RC_VIEWER_ALTERNATIVES:
1121 case LyXRC::RC_LAST: