3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alfredo Braunstein
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
9 * \author Angus Leeming
11 * \author André Pönitz
14 * \author Martin Vermeer
15 * \author Jürgen Vigna
17 * Full author contact details are available in file CREDITS.
24 #include "BranchList.h"
26 #include "buffer_funcs.h"
27 #include "bufferlist.h"
28 #include "bufferparams.h"
29 #include "BufferView.h"
31 #include "CutAndPaste.h"
33 #include "dispatchresult.h"
35 #include "errorlist.h"
38 #include "funcrequest.h"
39 #include "FuncStatus.h"
42 #include "insetiterator.h"
50 #include "LyXAction.h"
55 #include "lyxserver.h"
56 #include "lyxtextclasslist.h"
58 #include "paragraph.h"
59 #include "pariterator.h"
60 #include "ParagraphParameters.h"
63 #include "insets/insetbox.h"
64 #include "insets/insetbranch.h"
65 #include "insets/insetcommand.h"
66 #include "insets/insetert.h"
67 #include "insets/insetexternal.h"
68 #include "insets/insetfloat.h"
69 #include "insets/insetgraphics.h"
70 #include "insets/insetinclude.h"
71 #include "insets/insetnote.h"
72 #include "insets/insettabular.h"
73 #include "insets/insetvspace.h"
74 #include "insets/insetwrap.h"
76 #include "frontends/Application.h"
77 #include "frontends/Alert.h"
78 #include "frontends/Dialogs.h"
79 #include "frontends/FileDialog.h"
80 #include "frontends/FontLoader.h"
81 #include "frontends/Gui.h"
82 #include "frontends/LyXKeySym.h"
83 #include "frontends/LyXView.h"
84 #include "frontends/Menubar.h"
85 #include "frontends/Toolbars.h"
87 #include "support/environment.h"
88 #include "support/filefilterlist.h"
89 #include "support/filetools.h"
90 #include "support/forkedcontr.h"
91 #include "support/fs_extras.h"
92 #include "support/lstrings.h"
93 #include "support/path.h"
94 #include "support/package.h"
95 #include "support/systemcall.h"
96 #include "support/convert.h"
97 #include "support/os.h"
99 #include <boost/current_function.hpp>
100 #include <boost/filesystem/operations.hpp>
107 using bv_funcs::freefont2string;
109 using support::absolutePath;
110 using support::addName;
111 using support::addPath;
112 using support::bformat;
113 using support::changeExtension;
114 using support::contains;
115 using support::FileFilterList;
116 using support::fileSearch;
117 using support::ForkedcallsController;
118 using support::i18nLibFileSearch;
119 using support::isDirWriteable;
120 using support::isFileReadable;
121 using support::isStrInt;
122 using support::makeAbsPath;
123 using support::makeDisplayPath;
124 using support::package;
125 using support::quoteName;
126 using support::rtrim;
127 using support::split;
128 using support::subst;
129 using support::Systemcall;
130 using support::token;
132 using support::prefixIs;
135 using std::make_pair;
138 using std::istringstream;
139 using std::ostringstream;
141 namespace Alert = frontend::Alert;
142 namespace fs = boost::filesystem;
146 extern tex_accent_struct get_accent(kb_action action);
151 bool getLocalStatus(LCursor cursor,
152 FuncRequest const & cmd, FuncStatus & status)
154 // Try to fix cursor in case it is broken.
155 cursor.fixIfBroken();
157 // This is, of course, a mess. Better create a new doc iterator and use
158 // this in Inset::getStatus. This might require an additional
159 // BufferView * arg, though (which should be avoided)
160 //LCursor safe = *this;
162 for ( ; cursor.depth(); cursor.pop()) {
163 //lyxerr << "\nLCursor::getStatus: cmd: " << cmd << endl << *this << endl;
164 BOOST_ASSERT(cursor.idx() <= cursor.lastidx());
165 BOOST_ASSERT(cursor.pit() <= cursor.lastpit());
166 BOOST_ASSERT(cursor.pos() <= cursor.lastpos());
168 // The inset's getStatus() will return 'true' if it made
169 // a definitive decision on whether it want to handle the
170 // request or not. The result of this decision is put into
171 // the 'status' parameter.
172 if (cursor.inset().getStatus(cursor, cmd, status)) {
181 /** Return the change status at cursor position, taking in account the
182 * status at each level of the document iterator (a table in a deleted
183 * footnote is deleted).
184 * When \param outer is true, the top slice is not looked at.
186 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
188 size_t const depth = dit.depth() - (outer ? 1 : 0);
190 for (size_t i = 0 ; i < depth ; ++i) {
191 CursorSlice const & slice = dit[i];
192 if (!slice.inset().inMathed()
193 && slice.pos() < slice.paragraph().size()) {
194 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
195 if (ch != Change::UNCHANGED)
199 return Change::UNCHANGED;
207 meta_fake_bit(key_modifier::none)
212 void LyXFunc::initKeySequences(kb_keymap * kb)
214 keyseq.reset(new kb_sequence(kb, kb));
215 cancel_meta_seq.reset(new kb_sequence(kb, kb));
219 void LyXFunc::setLyXView(LyXView * lv)
225 void LyXFunc::handleKeyFunc(kb_action action)
227 char_type c = encoded_last_key;
229 if (keyseq->length())
232 lyx_view_->view()->getIntl().getTransManager().deadkey(
233 c, get_accent(action).accent, view()->getLyXText(), view()->cursor());
234 // Need to clear, in case the minibuffer calls these
237 // copied verbatim from do_accent_char
238 view()->cursor().resetAnchor();
243 void LyXFunc::processKeySym(LyXKeySymPtr keysym, key_modifier::state state)
245 lyxerr[Debug::KEY] << "KeySym is " << keysym->getSymbolName() << endl;
247 // Do nothing if we have nothing (JMarc)
248 if (!keysym->isOK()) {
249 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
254 if (keysym->isModifier()) {
255 lyxerr[Debug::KEY] << "isModifier true" << endl;
259 //Encoding const * encoding = view()->cursor().getEncoding();
260 //encoded_last_key = keysym->getISOEncoded(encoding ? encoding->name() : "");
261 size_t encoded_last_key = keysym->getUCSEncoded();
263 // Do a one-deep top-level lookup for
264 // cancel and meta-fake keys. RVDK_PATCH_5
265 cancel_meta_seq->reset();
267 FuncRequest func = cancel_meta_seq->addkey(keysym, state);
268 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
269 << " action first set to [" << func.action << ']'
272 // When not cancel or meta-fake, do the normal lookup.
273 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
274 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
275 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
276 // remove Caps Lock and Mod2 as a modifiers
277 func = keyseq->addkey(keysym, (state | meta_fake_bit));
278 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
279 << "action now set to ["
280 << func.action << ']' << endl;
283 // Dont remove this unless you know what you are doing.
284 meta_fake_bit = key_modifier::none;
286 // Can this happen now ?
287 if (func.action == LFUN_NOACTION) {
288 func = FuncRequest(LFUN_COMMAND_PREFIX);
291 if (lyxerr.debugging(Debug::KEY)) {
292 lyxerr << BOOST_CURRENT_FUNCTION
294 << func.action << "]["
295 << keyseq->print() << ']'
299 // already here we know if it any point in going further
300 // why not return already here if action == -1 and
301 // num_bytes == 0? (Lgb)
303 if (keyseq->length() > 1) {
304 lyx_view_->message(from_utf8(keyseq->print()));
308 // Maybe user can only reach the key via holding down shift.
309 // Let's see. But only if shift is the only modifier
310 if (func.action == LFUN_UNKNOWN_ACTION &&
311 state == key_modifier::shift) {
312 lyxerr[Debug::KEY] << "Trying without shift" << endl;
313 func = keyseq->addkey(keysym, key_modifier::none);
314 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
317 if (func.action == LFUN_UNKNOWN_ACTION) {
318 // Hmm, we didn't match any of the keysequences. See
319 // if it's normal insertable text not already covered
321 if (keysym->isText() && keyseq->length() == 1) {
322 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
323 func = FuncRequest(LFUN_SELF_INSERT,
324 FuncRequest::KEYBOARD);
326 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
327 lyx_view_->message(_("Unknown function."));
332 if (func.action == LFUN_SELF_INSERT) {
333 if (encoded_last_key != 0) {
334 docstring const arg(1, encoded_last_key);
335 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
336 FuncRequest::KEYBOARD));
338 << "SelfInsert arg[`" << to_utf8(arg) << "']" << endl;
346 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
348 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
351 if (cmd.action == LFUN_LYX_QUIT) {
352 flag.message(from_utf8(N_("Exiting")));
357 LCursor & cur = view()->cursor();
359 /* In LyX/Mac, when a dialog is open, the menus of the
360 application can still be accessed without giving focus to
361 the main window. In this case, we want to disable the menu
362 entries that are buffer-related.
364 Note that this code is not perfect, as bug 1941 attests:
365 http://bugzilla.lyx.org/show_bug.cgi?id=1941#c4
368 if (cmd.origin == FuncRequest::UI && !lyx_view_->hasFocus())
371 buf = lyx_view_->buffer();
373 if (cmd.action == LFUN_NOACTION) {
374 flag.message(from_utf8(N_("Nothing to do")));
379 switch (cmd.action) {
380 case LFUN_UNKNOWN_ACTION:
381 #ifndef HAVE_LIBAIKSAURUS
382 case LFUN_THESAURUS_ENTRY:
392 if (flag.unknown()) {
393 flag.message(from_utf8(N_("Unknown action")));
397 if (!flag.enabled()) {
398 if (flag.message().empty())
399 flag.message(from_utf8(N_("Command disabled")));
403 // Check whether we need a buffer
404 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
406 flag.message(from_utf8(N_("Command not allowed with"
407 "out any document open")));
412 // I would really like to avoid having this switch and rather try to
413 // encode this in the function itself.
414 // -- And I'd rather let an inset decide which LFUNs it is willing
415 // to handle (Andre')
417 switch (cmd.action) {
418 case LFUN_BUFFER_TOGGLE_READ_ONLY:
419 flag.setOnOff(buf->isReadonly());
422 case LFUN_BUFFER_SWITCH:
423 // toggle on the current buffer, but do not toggle off
424 // the other ones (is that a good idea?)
425 if (to_utf8(cmd.argument()) == buf->fileName())
429 case LFUN_BUFFER_EXPORT:
430 enable = cmd.argument() == "custom"
431 || Exporter::isExportable(*buf, to_utf8(cmd.argument()));
434 case LFUN_BUFFER_CHKTEX:
435 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
438 case LFUN_BUILD_PROGRAM:
439 enable = Exporter::isExportable(*buf, "program");
442 case LFUN_LAYOUT_TABULAR:
443 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
447 case LFUN_LAYOUT_PARAGRAPH:
448 enable = !cur.inset().forceDefaultParagraphs(cur.idx());
451 case LFUN_VC_REGISTER:
452 enable = !buf->lyxvc().inUse();
454 case LFUN_VC_CHECK_IN:
455 enable = buf->lyxvc().inUse() && !buf->isReadonly();
457 case LFUN_VC_CHECK_OUT:
458 enable = buf->lyxvc().inUse() && buf->isReadonly();
461 case LFUN_VC_UNDO_LAST:
462 enable = buf->lyxvc().inUse();
464 case LFUN_BUFFER_RELOAD:
465 enable = !buf->isUnnamed() && !buf->isClean();
468 case LFUN_INSET_SETTINGS: {
472 InsetBase::Code code = cur.inset().lyxCode();
474 case InsetBase::TABULAR_CODE:
475 enable = cmd.argument() == "tabular";
477 case InsetBase::ERT_CODE:
478 enable = cmd.argument() == "ert";
480 case InsetBase::FLOAT_CODE:
481 enable = cmd.argument() == "float";
483 case InsetBase::WRAP_CODE:
484 enable = cmd.argument() == "wrap";
486 case InsetBase::NOTE_CODE:
487 enable = cmd.argument() == "note";
489 case InsetBase::BRANCH_CODE:
490 enable = cmd.argument() == "branch";
492 case InsetBase::BOX_CODE:
493 enable = cmd.argument() == "box";
501 case LFUN_INSET_APPLY: {
502 string const name = cmd.getArg(0);
503 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
505 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
507 bool const success = inset->getStatus(cur, fr, fs);
508 // Every inset is supposed to handle this
509 BOOST_ASSERT(success);
512 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
513 flag |= getStatus(fr);
515 enable = flag.enabled();
519 case LFUN_DIALOG_SHOW: {
520 string const name = cmd.getArg(0);
522 enable = name == "aboutlyx"
526 || name == "texinfo";
527 else if (name == "print")
528 enable = Exporter::isExportable(*buf, "dvi")
529 && lyxrc.print_command != "none";
530 else if (name == "character" || name == "mathpanel")
531 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
532 else if (name == "latexlog")
533 enable = isFileReadable(buf->getLogName().second);
534 #if !defined (USE_ASPELL) && !defined (USE_ISPELL) && !defined (USE_PSPELL)
535 else if (name == "spellchecker")
538 else if (name == "vclog")
539 enable = buf->lyxvc().inUse();
540 else if (name == "view-source")
545 case LFUN_DIALOG_SHOW_NEW_INSET:
546 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
549 case LFUN_DIALOG_UPDATE: {
550 string const name = cmd.getArg(0);
552 enable = name == "prefs";
556 case LFUN_CITATION_INSERT: {
557 FuncRequest fr(LFUN_INSET_INSERT, "citation");
558 enable = getStatus(fr).enabled();
562 case LFUN_BUFFER_WRITE: {
563 enable = view()->buffer()->isUnnamed()
564 || !view()->buffer()->isClean();
568 // this one is difficult to get right. As a half-baked
569 // solution, we consider only the first action of the sequence
570 case LFUN_COMMAND_SEQUENCE: {
571 // argument contains ';'-terminated commands
572 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
573 FuncRequest func(lyxaction.lookupFunc(firstcmd));
574 func.origin = cmd.origin;
575 flag = getStatus(func);
578 case LFUN_BUFFER_NEW:
579 case LFUN_BUFFER_NEW_TEMPLATE:
580 case LFUN_WORD_FIND_FORWARD:
581 case LFUN_WORD_FIND_BACKWARD:
582 case LFUN_COMMAND_PREFIX:
583 case LFUN_COMMAND_EXECUTE:
585 case LFUN_META_PREFIX:
586 case LFUN_BUFFER_CLOSE:
587 case LFUN_BUFFER_WRITE_AS:
588 case LFUN_BUFFER_UPDATE:
589 case LFUN_BUFFER_VIEW:
590 case LFUN_BUFFER_IMPORT:
592 case LFUN_BUFFER_AUTO_SAVE:
593 case LFUN_RECONFIGURE:
597 case LFUN_DROP_LAYOUTS_CHOICE:
599 case LFUN_SERVER_GET_NAME:
600 case LFUN_SERVER_NOTIFY:
601 case LFUN_SERVER_GOTO_FILE_ROW:
602 case LFUN_DIALOG_HIDE:
603 case LFUN_DIALOG_DISCONNECT_INSET:
604 case LFUN_BUFFER_CHILD_OPEN:
605 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
606 case LFUN_KEYMAP_OFF:
607 case LFUN_KEYMAP_PRIMARY:
608 case LFUN_KEYMAP_SECONDARY:
609 case LFUN_KEYMAP_TOGGLE:
611 case LFUN_BUFFER_EXPORT_CUSTOM:
612 case LFUN_BUFFER_PRINT:
613 case LFUN_PREFERENCES_SAVE:
614 case LFUN_SCREEN_FONT_UPDATE:
617 case LFUN_EXTERNAL_EDIT:
618 case LFUN_GRAPHICS_EDIT:
619 case LFUN_ALL_INSETS_TOGGLE:
620 case LFUN_BUFFER_LANGUAGE:
621 case LFUN_TEXTCLASS_APPLY:
622 case LFUN_TEXTCLASS_LOAD:
623 case LFUN_BUFFER_SAVE_AS_DEFAULT:
624 case LFUN_BUFFER_PARAMS_APPLY:
625 case LFUN_LYXRC_APPLY:
626 case LFUN_BUFFER_NEXT:
627 case LFUN_BUFFER_PREVIOUS:
628 case LFUN_WINDOW_NEW:
629 case LFUN_WINDOW_CLOSE:
630 // these are handled in our dispatch()
633 // FIXME: will move to the front of this function when SWITCH_TO_BUFFER
634 // is valid for a newly created window
635 case LFUN_BOOKMARK_GOTO:
636 // bookmarks can be valid even if there is no opened buffer
637 flag.enabled(LyX::ref().session().bookmarks().isValid(convert<unsigned int>(to_utf8(cmd.argument()))));
640 // FIXME: will move to the front of this function when SWITCH_TO_BUFFER
641 // is valid for a newly created window
642 case LFUN_BOOKMARK_CLEAR:
643 flag.enabled(LyX::ref().session().bookmarks().size() > 0);
647 if (!getLocalStatus(cur, cmd, flag))
648 flag = view()->getStatus(cmd);
654 // Can we use a readonly buffer?
655 if (buf && buf->isReadonly()
656 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
657 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
658 flag.message(from_utf8(N_("Document is read-only")));
662 // Are we in a DELETED change-tracking region?
663 if (buf && lookupChangeType(cur, true) == Change::DELETED
664 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
665 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
666 flag.message(from_utf8(N_("This portion of the document is deleted.")));
670 // the default error message if we disable the command
671 if (!flag.enabled() && flag.message().empty())
672 flag.message(from_utf8(N_("Command disabled")));
678 bool LyXFunc::ensureBufferClean(BufferView * bv)
680 Buffer & buf = *bv->buffer();
684 docstring const file = makeDisplayPath(buf.fileName(), 30);
685 docstring text = bformat(_("The document %1$s has unsaved "
686 "changes.\n\nDo you want to save "
687 "the document?"), file);
688 int const ret = Alert::prompt(_("Save changed document?"),
689 text, 0, 1, _("&Save"),
693 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
695 return buf.isClean();
701 void showPrintError(string const & name)
703 docstring str = bformat(_("Could not print the document %1$s.\n"
704 "Check that your printer is set up correctly."),
705 makeDisplayPath(name, 50));
706 Alert::error(_("Print document failed"), str);
710 void loadTextclass(string const & name)
712 std::pair<bool, textclass_type> const tc_pair =
713 textclasslist.numberOfClass(name);
715 if (!tc_pair.first) {
716 lyxerr << "Document class \"" << name
717 << "\" does not exist."
722 textclass_type const tc = tc_pair.second;
724 if (!textclasslist[tc].load()) {
725 docstring s = bformat(_("The document could not be converted\n"
726 "into the document class %1$s."),
727 from_utf8(textclasslist[tc].name()));
728 Alert::error(_("Could not change class"), s);
733 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
738 void LyXFunc::dispatch(FuncRequest const & cmd)
740 string const argument = to_utf8(cmd.argument());
741 kb_action const action = cmd.action;
743 lyxerr[Debug::ACTION] << endl << "LyXFunc::dispatch: cmd: " << cmd << endl;
744 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
746 // we have not done anything wrong yet.
748 dispatch_buffer.erase();
750 // redraw the screen at the end (first of the two drawing steps).
751 //This is done unless explicitely requested otherwise
752 Update::flags updateFlags = Update::FitCursor;
754 FuncStatus const flag = getStatus(cmd);
755 if (!flag.enabled()) {
756 // We cannot use this function here
757 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
758 << lyxaction.getActionName(action)
759 << " [" << action << "] is disabled at this location"
761 setErrorMessage(flag.message());
765 case LFUN_WORD_FIND_FORWARD:
766 case LFUN_WORD_FIND_BACKWARD: {
767 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
768 static string last_search;
769 string searched_string;
771 if (!argument.empty()) {
772 last_search = argument;
773 searched_string = argument;
775 searched_string = last_search;
778 if (searched_string.empty())
781 bool const fw = action == LFUN_WORD_FIND_FORWARD;
783 find2string(searched_string, true, false, fw);
784 find(view(), FuncRequest(LFUN_WORD_FIND, data));
788 case LFUN_COMMAND_PREFIX:
789 BOOST_ASSERT(lyx_view_);
790 lyx_view_->message(from_utf8(keyseq->printOptions()));
793 case LFUN_COMMAND_EXECUTE:
794 BOOST_ASSERT(lyx_view_);
795 lyx_view_->getToolbars().display("minibuffer", true);
796 lyx_view_->focus_command_buffer();
800 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
802 meta_fake_bit = key_modifier::none;
803 if (view()->buffer())
804 // cancel any selection
805 dispatch(FuncRequest(LFUN_MARK_OFF));
806 setMessage(_("Cancel"));
809 case LFUN_META_PREFIX:
810 meta_fake_bit = key_modifier::alt;
811 setMessage(from_utf8(keyseq->print()));
814 case LFUN_BUFFER_TOGGLE_READ_ONLY:
815 BOOST_ASSERT(lyx_view_ && lyx_view_->view() && lyx_view_->buffer());
816 if (lyx_view_->buffer()->lyxvc().inUse())
817 lyx_view_->buffer()->lyxvc().toggleReadOnly();
819 lyx_view_->buffer()->setReadonly(
820 !lyx_view_->buffer()->isReadonly());
823 // --- Menus -----------------------------------------------
824 case LFUN_BUFFER_NEW:
825 menuNew(argument, false);
828 case LFUN_BUFFER_NEW_TEMPLATE:
829 menuNew(argument, true);
832 case LFUN_BUFFER_CLOSE:
837 case LFUN_BUFFER_WRITE:
838 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
839 if (!lyx_view_->buffer()->isUnnamed()) {
840 docstring const str = bformat(_("Saving document %1$s..."),
841 makeDisplayPath(lyx_view_->buffer()->fileName()));
842 lyx_view_->message(str);
843 menuWrite(lyx_view_->buffer());
844 lyx_view_->message(str + _(" done."));
846 writeAs(lyx_view_->buffer());
847 updateFlags = Update::None;
850 case LFUN_BUFFER_WRITE_AS:
851 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
852 writeAs(lyx_view_->buffer(), argument);
853 updateFlags = Update::None;
856 case LFUN_BUFFER_RELOAD: {
857 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
858 docstring const file = makeDisplayPath(view()->buffer()->fileName(), 20);
859 docstring text = bformat(_("Any changes will be lost. Are you sure "
860 "you want to revert to the saved version of the document %1$s?"), file);
861 int const ret = Alert::prompt(_("Revert to saved document?"),
862 text, 0, 1, _("&Revert"), _("&Cancel"));
869 case LFUN_BUFFER_UPDATE:
870 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
871 Exporter::Export(lyx_view_->buffer(), argument, true);
874 case LFUN_BUFFER_VIEW:
875 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
876 Exporter::preview(lyx_view_->buffer(), argument);
879 case LFUN_BUILD_PROGRAM:
880 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
881 Exporter::Export(lyx_view_->buffer(), "program", true);
884 case LFUN_BUFFER_CHKTEX:
885 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
886 lyx_view_->buffer()->runChktex();
889 case LFUN_BUFFER_EXPORT:
890 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
891 if (argument == "custom")
892 lyx_view_->getDialogs().show("sendto");
894 Exporter::Export(lyx_view_->buffer(), argument, false);
898 case LFUN_BUFFER_EXPORT_CUSTOM: {
899 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
901 string command = split(argument, format_name, ' ');
902 Format const * format = formats.getFormat(format_name);
904 lyxerr << "Format \"" << format_name
905 << "\" not recognized!"
910 Buffer * buffer = lyx_view_->buffer();
912 // The name of the file created by the conversion process
915 // Output to filename
916 if (format->name() == "lyx") {
917 string const latexname =
918 buffer->getLatexName(false);
919 filename = changeExtension(latexname,
920 format->extension());
921 filename = addName(buffer->temppath(), filename);
923 if (!buffer->writeFile(filename))
927 Exporter::Export(buffer, format_name, true, filename);
930 // Substitute $$FName for filename
931 if (!contains(command, "$$FName"))
932 command = "( " + command + " ) < $$FName";
933 command = subst(command, "$$FName", filename);
935 // Execute the command in the background
937 call.startscript(Systemcall::DontWait, command);
941 case LFUN_BUFFER_PRINT: {
942 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
945 string command = split(split(argument, target, ' '),
949 || target_name.empty()
950 || command.empty()) {
951 lyxerr << "Unable to parse \""
952 << argument << '"' << std::endl;
955 if (target != "printer" && target != "file") {
956 lyxerr << "Unrecognized target \""
957 << target << '"' << std::endl;
961 Buffer * buffer = lyx_view_->buffer();
963 if (!Exporter::Export(buffer, "dvi", true)) {
964 showPrintError(buffer->fileName());
968 // Push directory path.
969 string const path = buffer->temppath();
970 support::Path p(path);
972 // there are three cases here:
973 // 1. we print to a file
974 // 2. we print directly to a printer
975 // 3. we print using a spool command (print to file first)
978 string const dviname =
979 changeExtension(buffer->getLatexName(true),
982 if (target == "printer") {
983 if (!lyxrc.print_spool_command.empty()) {
984 // case 3: print using a spool
985 string const psname =
986 changeExtension(dviname,".ps");
987 command += lyxrc.print_to_file
990 + quoteName(dviname);
993 lyxrc.print_spool_command +' ';
994 if (target_name != "default") {
995 command2 += lyxrc.print_spool_printerprefix
999 command2 += quoteName(psname);
1001 // If successful, then spool command
1002 res = one.startscript(
1007 res = one.startscript(
1008 Systemcall::DontWait,
1011 // case 2: print directly to a printer
1012 res = one.startscript(
1013 Systemcall::DontWait,
1014 command + quoteName(dviname));
1018 // case 1: print to a file
1019 command += lyxrc.print_to_file
1020 + quoteName(makeAbsPath(target_name,
1023 + quoteName(dviname);
1024 res = one.startscript(Systemcall::DontWait,
1029 showPrintError(buffer->fileName());
1033 case LFUN_BUFFER_IMPORT:
1038 if (argument != "force") {
1039 if (!theApp->gui().closeAll())
1044 // FIXME: this code needs to be transfered somewhere else
1045 // as lyx_view_ will most certainly be null and a same buffer
1046 // might be visible in more than one LyXView.
1047 if (lyx_view_ && lyx_view_->view()->buffer()) {
1048 // save cursor Position for opened files to .lyx/session
1049 LyX::ref().session().lastFilePos().save(lyx_view_->buffer()->fileName(),
1050 boost::tie(view()->cursor().pit(), view()->cursor().pos()) );
1056 case LFUN_TOC_VIEW: {
1057 BOOST_ASSERT(lyx_view_);
1058 InsetCommandParams p("tableofcontents");
1059 string const data = InsetCommandMailer::params2string("toc", p);
1060 lyx_view_->getDialogs().show("toc", data, 0);
1064 case LFUN_BUFFER_AUTO_SAVE:
1068 case LFUN_RECONFIGURE:
1069 BOOST_ASSERT(lyx_view_);
1070 reconfigure(*lyx_view_);
1073 case LFUN_HELP_OPEN: {
1074 BOOST_ASSERT(lyx_view_);
1075 string const arg = argument;
1077 setErrorMessage(_("Missing argument"));
1080 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1081 if (fname.empty()) {
1082 lyxerr << "LyX: unable to find documentation file `"
1083 << arg << "'. Bad installation?" << endl;
1086 lyx_view_->message(bformat(_("Opening help file %1$s..."),
1087 makeDisplayPath(fname)));
1088 lyx_view_->loadLyXFile(fname, false);
1092 // --- version control -------------------------------
1093 case LFUN_VC_REGISTER:
1094 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1095 if (!ensureBufferClean(view()))
1097 if (!lyx_view_->buffer()->lyxvc().inUse()) {
1098 lyx_view_->buffer()->lyxvc().registrer();
1103 case LFUN_VC_CHECK_IN:
1104 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1105 if (!ensureBufferClean(view()))
1107 if (lyx_view_->buffer()->lyxvc().inUse()
1108 && !lyx_view_->buffer()->isReadonly()) {
1109 lyx_view_->buffer()->lyxvc().checkIn();
1114 case LFUN_VC_CHECK_OUT:
1115 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1116 if (!ensureBufferClean(view()))
1118 if (lyx_view_->buffer()->lyxvc().inUse()
1119 && lyx_view_->buffer()->isReadonly()) {
1120 lyx_view_->buffer()->lyxvc().checkOut();
1125 case LFUN_VC_REVERT:
1126 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1127 lyx_view_->buffer()->lyxvc().revert();
1131 case LFUN_VC_UNDO_LAST:
1132 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1133 lyx_view_->buffer()->lyxvc().undoLast();
1137 // --- buffers ----------------------------------------
1138 case LFUN_BUFFER_SWITCH:
1139 BOOST_ASSERT(lyx_view_);
1140 lyx_view_->setBuffer(theBufferList().getBuffer(argument));
1143 case LFUN_BUFFER_NEXT:
1144 BOOST_ASSERT(lyx_view_);
1145 lyx_view_->setBuffer(theBufferList().next(view()->buffer()));
1148 case LFUN_BUFFER_PREVIOUS:
1149 BOOST_ASSERT(lyx_view_);
1150 lyx_view_->setBuffer(theBufferList().previous(view()->buffer()));
1154 BOOST_ASSERT(lyx_view_);
1155 newFile(view(), argument);
1158 case LFUN_FILE_OPEN:
1159 BOOST_ASSERT(lyx_view_);
1163 case LFUN_DROP_LAYOUTS_CHOICE:
1164 BOOST_ASSERT(lyx_view_);
1165 lyx_view_->getToolbars().openLayoutList();
1168 case LFUN_MENU_OPEN:
1169 BOOST_ASSERT(lyx_view_);
1170 lyx_view_->getMenubar().openByName(from_utf8(argument));
1173 // --- lyxserver commands ----------------------------
1174 case LFUN_SERVER_GET_NAME:
1175 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1176 setMessage(from_utf8(lyx_view_->buffer()->fileName()));
1177 lyxerr[Debug::INFO] << "FNAME["
1178 << lyx_view_->buffer()->fileName()
1182 case LFUN_SERVER_NOTIFY:
1183 dispatch_buffer = from_utf8(keyseq->print());
1184 theLyXServer().notifyClient(to_utf8(dispatch_buffer));
1187 case LFUN_SERVER_GOTO_FILE_ROW: {
1188 BOOST_ASSERT(lyx_view_);
1191 istringstream is(argument);
1192 is >> file_name >> row;
1193 if (prefixIs(file_name, package().temp_dir())) {
1194 // Needed by inverse dvi search. If it is a file
1195 // in tmpdir, call the apropriated function
1196 lyx_view_->setBuffer(theBufferList().getBufferFromTmp(file_name));
1198 // Must replace extension of the file to be .lyx
1199 // and get full path
1200 string const s = changeExtension(file_name, ".lyx");
1201 // Either change buffer or load the file
1202 if (theBufferList().exists(s)) {
1203 lyx_view_->setBuffer(theBufferList().getBuffer(s));
1205 lyx_view_->loadLyXFile(s);
1209 view()->setCursorFromRow(row);
1212 // see BufferView::center()
1216 case LFUN_DIALOG_SHOW: {
1217 BOOST_ASSERT(lyx_view_);
1218 string const name = cmd.getArg(0);
1219 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1221 if (name == "character") {
1222 data = freefont2string();
1224 lyx_view_->getDialogs().show("character", data);
1225 } else if (name == "latexlog") {
1226 pair<Buffer::LogType, string> const logfile =
1227 lyx_view_->buffer()->getLogName();
1228 switch (logfile.first) {
1229 case Buffer::latexlog:
1232 case Buffer::buildlog:
1236 data += LyXLex::quoteString(logfile.second);
1237 lyx_view_->getDialogs().show("log", data);
1238 } else if (name == "vclog") {
1239 string const data = "vc " +
1240 LyXLex::quoteString(lyx_view_->buffer()->lyxvc().getLogFile());
1241 lyx_view_->getDialogs().show("log", data);
1243 lyx_view_->getDialogs().show(name, data);
1247 case LFUN_DIALOG_SHOW_NEW_INSET: {
1248 BOOST_ASSERT(lyx_view_);
1249 string const name = cmd.getArg(0);
1250 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1251 if (name == "bibitem" ||
1258 InsetCommandParams p(name);
1259 data = InsetCommandMailer::params2string(name, p);
1260 } else if (name == "include") {
1261 InsetCommandParams p(data);
1262 data = InsetIncludeMailer::params2string(p);
1263 } else if (name == "box") {
1264 // \c data == "Boxed" || "Frameless" etc
1265 InsetBoxParams p(data);
1266 data = InsetBoxMailer::params2string(p);
1267 } else if (name == "branch") {
1268 InsetBranchParams p;
1269 data = InsetBranchMailer::params2string(p);
1270 } else if (name == "citation") {
1271 InsetCommandParams p("cite");
1272 data = InsetCommandMailer::params2string(name, p);
1273 } else if (name == "ert") {
1274 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1275 } else if (name == "external") {
1276 InsetExternalParams p;
1277 Buffer const & buffer = *lyx_view_->buffer();
1278 data = InsetExternalMailer::params2string(p, buffer);
1279 } else if (name == "float") {
1281 data = InsetFloatMailer::params2string(p);
1282 } else if (name == "graphics") {
1283 InsetGraphicsParams p;
1284 Buffer const & buffer = *lyx_view_->buffer();
1285 data = InsetGraphicsMailer::params2string(p, buffer);
1286 } else if (name == "note") {
1288 data = InsetNoteMailer::params2string(p);
1289 } else if (name == "vspace") {
1291 data = InsetVSpaceMailer::params2string(space);
1292 } else if (name == "wrap") {
1294 data = InsetWrapMailer::params2string(p);
1296 lyx_view_->getDialogs().show(name, data, 0);
1300 case LFUN_DIALOG_UPDATE: {
1301 BOOST_ASSERT(lyx_view_);
1302 string const & name = argument;
1303 // Can only update a dialog connected to an existing inset
1304 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1306 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument());
1307 inset->dispatch(view()->cursor(), fr);
1308 } else if (name == "paragraph") {
1309 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1310 } else if (name == "prefs") {
1311 lyx_view_->getDialogs().update(name, string());
1316 case LFUN_DIALOG_HIDE:
1317 Dialogs::hide(argument, 0);
1320 case LFUN_DIALOG_DISCONNECT_INSET:
1321 BOOST_ASSERT(lyx_view_);
1322 lyx_view_->getDialogs().disconnect(argument);
1326 case LFUN_CITATION_INSERT: {
1327 BOOST_ASSERT(lyx_view_);
1328 if (!argument.empty()) {
1329 // we can have one optional argument, delimited by '|'
1330 // citation-insert <key>|<text_before>
1331 // this should be enhanced to also support text_after
1332 // and citation style
1333 string arg = argument;
1335 if (contains(argument, "|")) {
1336 arg = token(argument, '|', 0);
1337 opt1 = '[' + token(argument, '|', 1) + ']';
1339 std::ostringstream os;
1340 os << "citation LatexCommand\n"
1341 << "\\cite" << opt1 << "{" << arg << "}\n"
1343 FuncRequest fr(LFUN_INSET_INSERT, os.str());
1346 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "citation"));
1350 case LFUN_BUFFER_CHILD_OPEN: {
1351 BOOST_ASSERT(lyx_view_);
1352 string const filename =
1353 makeAbsPath(argument, lyx_view_->buffer()->filePath());
1354 // FIXME Should use bformat
1355 setMessage(_("Opening child document ") +
1356 makeDisplayPath(filename) + "...");
1357 view()->saveBookmark(false);
1358 string const parentfilename = lyx_view_->buffer()->fileName();
1359 if (theBufferList().exists(filename))
1360 lyx_view_->setBuffer(theBufferList().getBuffer(filename));
1362 lyx_view_->loadLyXFile(filename);
1363 // Set the parent name of the child document.
1364 // This makes insertion of citations and references in the child work,
1365 // when the target is in the parent or another child document.
1366 lyx_view_->buffer()->setParentName(parentfilename);
1370 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
1371 BOOST_ASSERT(lyx_view_);
1372 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1375 case LFUN_KEYMAP_OFF:
1376 BOOST_ASSERT(lyx_view_);
1377 lyx_view_->view()->getIntl().keyMapOn(false);
1380 case LFUN_KEYMAP_PRIMARY:
1381 BOOST_ASSERT(lyx_view_);
1382 lyx_view_->view()->getIntl().keyMapPrim();
1385 case LFUN_KEYMAP_SECONDARY:
1386 BOOST_ASSERT(lyx_view_);
1387 lyx_view_->view()->getIntl().keyMapSec();
1390 case LFUN_KEYMAP_TOGGLE:
1391 BOOST_ASSERT(lyx_view_);
1392 lyx_view_->view()->getIntl().toggleKeyMap();
1398 string rest = split(argument, countstr, ' ');
1399 istringstream is(countstr);
1402 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1403 for (int i = 0; i < count; ++i)
1404 dispatch(lyxaction.lookupFunc(rest));
1408 case LFUN_COMMAND_SEQUENCE: {
1409 // argument contains ';'-terminated commands
1410 string arg = argument;
1411 while (!arg.empty()) {
1413 arg = split(arg, first, ';');
1414 FuncRequest func(lyxaction.lookupFunc(first));
1415 func.origin = cmd.origin;
1421 case LFUN_PREFERENCES_SAVE: {
1422 support::Path p(package().user_support());
1423 lyxrc.write("preferences", false);
1427 case LFUN_SCREEN_FONT_UPDATE:
1428 BOOST_ASSERT(lyx_view_);
1429 // handle the screen font changes.
1430 lyxrc.set_font_norm_type();
1431 theFontLoader().update();
1432 // All visible buffers will need resize
1436 case LFUN_SET_COLOR: {
1438 string const x11_name = split(argument, lyx_name, ' ');
1439 if (lyx_name.empty() || x11_name.empty()) {
1440 setErrorMessage(_("Syntax: set-color <lyx_name>"
1445 bool const graphicsbg_changed =
1446 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1447 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1449 if (!lcolor.setColor(lyx_name, x11_name)) {
1451 bformat(_("Set-color \"%1$s\" failed "
1452 "- color is undefined or "
1453 "may not be redefined"),
1454 from_utf8(lyx_name)));
1458 theApp->updateColor(lcolor.getFromLyXName(lyx_name));
1460 if (graphicsbg_changed) {
1461 #ifdef WITH_WARNINGS
1462 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1465 graphics::GCache::get().changeDisplay(true);
1472 BOOST_ASSERT(lyx_view_);
1473 lyx_view_->message(from_utf8(argument));
1476 case LFUN_EXTERNAL_EDIT: {
1477 BOOST_ASSERT(lyx_view_);
1478 FuncRequest fr(action, argument);
1479 InsetExternal().dispatch(view()->cursor(), fr);
1483 case LFUN_GRAPHICS_EDIT: {
1484 FuncRequest fr(action, argument);
1485 InsetGraphics().dispatch(view()->cursor(), fr);
1489 case LFUN_INSET_APPLY: {
1490 BOOST_ASSERT(lyx_view_);
1491 string const name = cmd.getArg(0);
1492 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1494 FuncRequest fr(LFUN_INSET_MODIFY, argument);
1495 inset->dispatch(view()->cursor(), fr);
1497 FuncRequest fr(LFUN_INSET_INSERT, argument);
1500 // ideally, the update flag should be set by the insets,
1501 // but this is not possible currently
1502 updateFlags = Update::Force | Update::FitCursor;
1506 case LFUN_ALL_INSETS_TOGGLE: {
1507 BOOST_ASSERT(lyx_view_);
1509 string const name = split(argument, action, ' ');
1510 InsetBase::Code const inset_code =
1511 InsetBase::translate(name);
1513 LCursor & cur = view()->cursor();
1514 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1516 InsetBase & inset = lyx_view_->buffer()->inset();
1517 InsetIterator it = inset_iterator_begin(inset);
1518 InsetIterator const end = inset_iterator_end(inset);
1519 for (; it != end; ++it) {
1520 if (inset_code == InsetBase::NO_CODE
1521 || inset_code == it->lyxCode()) {
1522 LCursor tmpcur = cur;
1523 tmpcur.pushLeft(*it);
1524 it->dispatch(tmpcur, fr);
1527 updateFlags = Update::Force | Update::FitCursor;
1531 case LFUN_BUFFER_LANGUAGE: {
1532 BOOST_ASSERT(lyx_view_);
1533 Buffer & buffer = *lyx_view_->buffer();
1534 Language const * oldL = buffer.params().language;
1535 Language const * newL = languages.getLanguage(argument);
1536 if (!newL || oldL == newL)
1539 if (oldL->rightToLeft() == newL->rightToLeft()
1540 && !buffer.isMultiLingual())
1541 buffer.changeLanguage(oldL, newL);
1543 buffer.updateDocLang(newL);
1547 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1548 string const fname =
1549 addName(addPath(package().user_support(), "templates/"),
1551 Buffer defaults(fname);
1553 istringstream ss(argument);
1556 int const unknown_tokens = defaults.readHeader(lex);
1558 if (unknown_tokens != 0) {
1559 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1560 << unknown_tokens << " unknown token"
1561 << (unknown_tokens == 1 ? "" : "s")
1565 if (defaults.writeFile(defaults.fileName()))
1566 // FIXME Should use bformat
1567 setMessage(_("Document defaults saved in ")
1568 + makeDisplayPath(fname));
1570 setErrorMessage(_("Unable to save document defaults"));
1574 case LFUN_BUFFER_PARAMS_APPLY: {
1575 BOOST_ASSERT(lyx_view_);
1576 biblio::CiteEngine const engine =
1577 lyx_view_->buffer()->params().cite_engine;
1579 istringstream ss(argument);
1582 int const unknown_tokens =
1583 lyx_view_->buffer()->readHeader(lex);
1585 if (unknown_tokens != 0) {
1586 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1587 << unknown_tokens << " unknown token"
1588 << (unknown_tokens == 1 ? "" : "s")
1591 if (engine == lyx_view_->buffer()->params().cite_engine)
1594 LCursor & cur = view()->cursor();
1595 FuncRequest fr(LFUN_INSET_REFRESH);
1597 InsetBase & inset = lyx_view_->buffer()->inset();
1598 InsetIterator it = inset_iterator_begin(inset);
1599 InsetIterator const end = inset_iterator_end(inset);
1600 for (; it != end; ++it)
1601 if (it->lyxCode() == InsetBase::CITE_CODE)
1602 it->dispatch(cur, fr);
1606 case LFUN_TEXTCLASS_APPLY: {
1607 BOOST_ASSERT(lyx_view_);
1608 Buffer * buffer = lyx_view_->buffer();
1610 textclass_type const old_class =
1611 buffer->params().textclass;
1613 loadTextclass(argument);
1615 std::pair<bool, textclass_type> const tc_pair =
1616 textclasslist.numberOfClass(argument);
1621 textclass_type const new_class = tc_pair.second;
1622 if (old_class == new_class)
1626 lyx_view_->message(_("Converting document to new document class..."));
1627 recordUndoFullDocument(view());
1628 buffer->params().textclass = new_class;
1629 StableDocIterator backcur(view()->cursor());
1630 ErrorList & el = buffer->errorList("Class Switch");
1631 cap::switchBetweenClasses(
1632 old_class, new_class,
1633 static_cast<InsetText &>(buffer->inset()), el);
1635 view()->setCursor(backcur.asDocIterator(&(buffer->inset())));
1637 buffer->errors("Class Switch");
1638 updateLabels(*buffer);
1639 updateFlags = Update::Force | Update::FitCursor;
1643 case LFUN_TEXTCLASS_LOAD:
1644 loadTextclass(argument);
1647 case LFUN_LYXRC_APPLY: {
1648 LyXRC const lyxrc_orig = lyxrc;
1650 istringstream ss(argument);
1651 bool const success = lyxrc.read(ss) == 0;
1654 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1655 << "Unable to read lyxrc data"
1660 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1664 case LFUN_WINDOW_NEW:
1665 LyX::ref().newLyXView();
1668 case LFUN_WINDOW_CLOSE:
1669 BOOST_ASSERT(lyx_view_);
1670 BOOST_ASSERT(theApp);
1672 // We return here because lyx_view does not exists anymore.
1675 case LFUN_BOOKMARK_GOTO: {
1676 BOOST_ASSERT(lyx_view_);
1677 unsigned int idx = convert<unsigned int>(to_utf8(cmd.argument()));
1678 BookmarksSection::Bookmark const bm = LyX::ref().session().bookmarks().bookmark(idx);
1679 BOOST_ASSERT(!bm.filename.empty());
1680 // if the file is not opened, open it.
1681 if (!theBufferList().exists(bm.filename))
1682 dispatch(FuncRequest(LFUN_FILE_OPEN, bm.filename));
1683 // open may fail, so we need to test it again
1684 if (theBufferList().exists(bm.filename)) {
1685 // if the current buffer is not that one, switch to it.
1686 // FIXME: swtich buffer to a newly created window will crash lyx
1687 // because of invalid view.
1688 if (lyx_view_->buffer()->fileName() != bm.filename)
1689 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, bm.filename));
1690 // BOOST_ASSERT(lyx_view_->buffer()->fileName() != bm.filename);
1691 view()->moveToPosition(bm.par_id, bm.par_pos);
1696 case LFUN_BOOKMARK_CLEAR:
1697 LyX::ref().session().bookmarks().clear();
1701 BOOST_ASSERT(lyx_view_);
1702 view()->cursor().dispatch(cmd);
1703 updateFlags = view()->cursor().result().update();
1704 if (!view()->cursor().result().dispatched())
1705 if (view()->dispatch(cmd))
1706 updateFlags = Update::Force | Update::FitCursor;
1711 if (lyx_view_ && view()->buffer()) {
1712 // Redraw screen unless explicitly told otherwise.
1713 // This also initializes the position cache for all insets
1714 // in (at least partially) visible top-level paragraphs.
1715 bool needSecondUpdate = false;
1716 if (updateFlags != Update::None)
1717 view()->update(updateFlags);
1719 needSecondUpdate = view()->fitCursor();
1721 if (needSecondUpdate || updateFlags != Update::None) {
1722 view()->buffer()->changed();
1724 lyx_view_->updateStatusBar();
1726 // if we executed a mutating lfun, mark the buffer as dirty
1728 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1729 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1730 view()->buffer()->markDirty();
1732 if (view()->cursor().inTexted()) {
1733 lyx_view_->updateLayoutChoice();
1738 // FIXME UNICODE: _() does not support anything but ascii.
1739 // Do we need a to_ascii() method?
1740 sendDispatchMessage(getMessage(), cmd);
1744 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1746 /* When an action did not originate from the UI/kbd, it makes
1747 * sense to avoid updating the GUI. It turns out that this
1748 * fixes bug 1941, for reasons that are described here:
1749 * http://bugzilla.lyx.org/show_bug.cgi?id=1941#c4
1751 if (cmd.origin != FuncRequest::INTERNAL) {
1752 lyx_view_->updateMenubar();
1753 lyx_view_->updateToolbars();
1756 const bool verbose = (cmd.origin == FuncRequest::UI
1757 || cmd.origin == FuncRequest::COMMANDBUFFER);
1759 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1760 lyxerr[Debug::ACTION] << "dispatch msg is " << to_utf8(msg) << endl;
1762 lyx_view_->message(msg);
1766 docstring dispatch_msg = msg;
1767 if (!dispatch_msg.empty())
1768 dispatch_msg += ' ';
1770 string comname = lyxaction.getActionName(cmd.action);
1772 bool argsadded = false;
1774 if (!cmd.argument().empty()) {
1775 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1776 comname += ' ' + to_utf8(cmd.argument());
1781 string const shortcuts = theTopLevelKeymap().printbindings(cmd);
1783 if (!shortcuts.empty())
1784 comname += ": " + shortcuts;
1785 else if (!argsadded && !cmd.argument().empty())
1786 comname += ' ' + to_utf8(cmd.argument());
1788 if (!comname.empty()) {
1789 comname = rtrim(comname);
1790 dispatch_msg += from_utf8('(' + rtrim(comname) + ')');
1793 lyxerr[Debug::ACTION] << "verbose dispatch msg "
1794 << to_utf8(dispatch_msg) << endl;
1795 if (!dispatch_msg.empty())
1796 lyx_view_->message(dispatch_msg);
1800 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1802 string initpath = lyxrc.document_path;
1803 string filename(name);
1805 if (view()->buffer()) {
1806 string const trypath = lyx_view_->buffer()->filePath();
1807 // If directory is writeable, use this as default.
1808 if (isDirWriteable(trypath))
1812 static int newfile_number;
1814 if (filename.empty()) {
1815 filename = addName(lyxrc.document_path,
1816 "newfile" + convert<string>(++newfile_number) + ".lyx");
1817 while (theBufferList().exists(filename) || fs::is_readable(filename)) {
1819 filename = addName(lyxrc.document_path,
1820 "newfile" + convert<string>(newfile_number) +
1825 // The template stuff
1828 FileDialog fileDlg(_("Select template file"),
1829 LFUN_SELECT_FILE_SYNC,
1830 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1831 make_pair(_("Templates|#T#t"), from_utf8(lyxrc.template_path)));
1833 FileDialog::Result result =
1834 fileDlg.open(from_utf8(lyxrc.template_path),
1835 FileFilterList(_("LyX Documents (*.lyx)")),
1838 if (result.first == FileDialog::Later)
1840 if (result.second.empty())
1842 templname = to_utf8(result.second);
1845 Buffer * const b = newFile(filename, templname, !name.empty());
1847 lyx_view_->setBuffer(b);
1851 void LyXFunc::open(string const & fname)
1853 string initpath = lyxrc.document_path;
1855 if (view()->buffer()) {
1856 string const trypath = lyx_view_->buffer()->filePath();
1857 // If directory is writeable, use this as default.
1858 if (isDirWriteable(trypath))
1864 if (fname.empty()) {
1865 FileDialog fileDlg(_("Select document to open"),
1867 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1868 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1870 FileDialog::Result result =
1871 fileDlg.open(from_utf8(initpath),
1872 FileFilterList(_("LyX Documents (*.lyx)")),
1875 if (result.first == FileDialog::Later)
1878 filename = to_utf8(result.second);
1880 // check selected filename
1881 if (filename.empty()) {
1882 lyx_view_->message(_("Canceled."));
1888 // get absolute path of file and add ".lyx" to the filename if
1890 string const fullpath = fileSearch(string(), filename, "lyx");
1891 if (!fullpath.empty()) {
1892 filename = fullpath;
1895 docstring const disp_fn = makeDisplayPath(filename);
1897 // if the file doesn't exist, let the user create one
1898 if (!fs::exists(filename)) {
1899 // the user specifically chose this name. Believe him.
1900 Buffer * const b = newFile(filename, string(), true);
1902 lyx_view_->setBuffer(b);
1906 lyx_view_->message(bformat(_("Opening document %1$s..."), disp_fn));
1909 if (lyx_view_->loadLyXFile(filename)) {
1910 str2 = bformat(_("Document %1$s opened."), disp_fn);
1912 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1914 lyx_view_->message(str2);
1918 void LyXFunc::doImport(string const & argument)
1921 string filename = split(argument, format, ' ');
1923 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1924 << " file: " << filename << endl;
1926 // need user interaction
1927 if (filename.empty()) {
1928 string initpath = lyxrc.document_path;
1930 if (view()->buffer()) {
1931 string const trypath = lyx_view_->buffer()->filePath();
1932 // If directory is writeable, use this as default.
1933 if (isDirWriteable(trypath))
1937 docstring const text = bformat(_("Select %1$s file to import"),
1938 formats.prettyName(format));
1940 FileDialog fileDlg(text,
1942 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1943 make_pair(_("Examples|#E#e"),
1944 from_utf8(addPath(package().system_support(), "examples"))));
1946 docstring filter = formats.prettyName(format);
1949 filter += from_utf8(formats.extension(format));
1952 FileDialog::Result result =
1953 fileDlg.open(from_utf8(initpath),
1954 FileFilterList(filter),
1957 if (result.first == FileDialog::Later)
1960 filename = to_utf8(result.second);
1962 // check selected filename
1963 if (filename.empty())
1964 lyx_view_->message(_("Canceled."));
1967 if (filename.empty())
1970 // get absolute path of file
1971 filename = makeAbsPath(filename);
1973 string const lyxfile = changeExtension(filename, ".lyx");
1975 // Check if the document already is open
1976 if (use_gui && theBufferList().exists(lyxfile)) {
1977 if (!theBufferList().close(theBufferList().getBuffer(lyxfile), true)) {
1978 lyx_view_->message(_("Canceled."));
1983 // if the file exists already, and we didn't do
1984 // -i lyx thefile.lyx, warn
1985 if (fs::exists(lyxfile) && filename != lyxfile) {
1986 docstring const file = makeDisplayPath(lyxfile, 30);
1988 docstring text = bformat(_("The document %1$s already exists.\n\n"
1989 "Do you want to over-write that document?"), file);
1990 int const ret = Alert::prompt(_("Over-write document?"),
1991 text, 0, 1, _("&Over-write"), _("&Cancel"));
1994 lyx_view_->message(_("Canceled."));
1999 ErrorList errorList;
2000 Importer::Import(lyx_view_, filename, format, errorList);
2001 // FIXME (Abdel 12/08/06): Is there a need to display the error list here?
2005 void LyXFunc::closeBuffer()
2007 // save current cursor position
2008 LyX::ref().session().lastFilePos().save(lyx_view_->buffer()->fileName(),
2009 boost::tie(view()->cursor().pit(), view()->cursor().pos()) );
2010 if (theBufferList().close(lyx_view_->buffer(), true) && !quitting) {
2011 if (theBufferList().empty()) {
2012 // need this otherwise SEGV may occur while
2013 // trying to set variables that don't exist
2014 // since there's no current buffer
2015 lyx_view_->getDialogs().hideBufferDependent();
2017 lyx_view_->setBuffer(theBufferList().first());
2023 // Each "lyx_view_" should have it's own message method. lyxview and
2024 // the minibuffer would use the minibuffer, but lyxserver would
2025 // send an ERROR signal to its client. Alejandro 970603
2026 // This function is bit problematic when it comes to NLS, to make the
2027 // lyx servers client be language indepenent we must not translate
2028 // strings sent to this func.
2029 void LyXFunc::setErrorMessage(docstring const & m) const
2031 dispatch_buffer = m;
2036 void LyXFunc::setMessage(docstring const & m) const
2038 dispatch_buffer = m;
2042 string const LyXFunc::viewStatusMessage()
2044 // When meta-fake key is pressed, show the key sequence so far + "M-".
2046 return keyseq->print() + "M-";
2048 // Else, when a non-complete key sequence is pressed,
2049 // show the available options.
2050 if (keyseq->length() > 0 && !keyseq->deleted())
2051 return keyseq->printOptions();
2053 if (!view()->buffer())
2054 return to_utf8(_("Welcome to LyX!"));
2056 return view()->cursor().currentState();
2060 BufferView * LyXFunc::view() const
2062 BOOST_ASSERT(lyx_view_);
2063 return lyx_view_->view();
2067 bool LyXFunc::wasMetaKey() const
2069 return (meta_fake_bit != key_modifier::none);
2075 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
2077 // Why the switch you might ask. It is a trick to ensure that all
2078 // the elements in the LyXRCTags enum is handled. As you can see
2079 // there are no breaks at all. So it is just a huge fall-through.
2080 // The nice thing is that we will get a warning from the compiler
2081 // if we forget an element.
2082 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
2084 case LyXRC::RC_ACCEPT_COMPOUND:
2085 case LyXRC::RC_ALT_LANG:
2086 case LyXRC::RC_ASCIIROFF_COMMAND:
2087 case LyXRC::RC_ASCII_LINELEN:
2088 case LyXRC::RC_AUTOREGIONDELETE:
2089 case LyXRC::RC_AUTORESET_OPTIONS:
2090 case LyXRC::RC_AUTOSAVE:
2091 case LyXRC::RC_AUTO_NUMBER:
2092 case LyXRC::RC_BACKUPDIR_PATH:
2093 case LyXRC::RC_BIBTEX_COMMAND:
2094 case LyXRC::RC_BINDFILE:
2095 case LyXRC::RC_CHECKLASTFILES:
2096 case LyXRC::RC_USELASTFILEPOS:
2097 case LyXRC::RC_LOADSESSION:
2098 case LyXRC::RC_CHKTEX_COMMAND:
2099 case LyXRC::RC_CONVERTER:
2100 case LyXRC::RC_COPIER:
2101 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
2102 case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
2103 case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
2104 case LyXRC::RC_DATE_INSERT_FORMAT:
2105 case LyXRC::RC_DEFAULT_LANGUAGE:
2106 case LyXRC::RC_DEFAULT_PAPERSIZE:
2107 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
2108 case LyXRC::RC_DISPLAY_GRAPHICS:
2109 case LyXRC::RC_DOCUMENTPATH:
2110 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
2111 if (fs::exists(lyxrc_new.document_path) &&
2112 fs::is_directory(lyxrc_new.document_path)) {
2113 support::package().document_dir() = lyxrc.document_path;
2116 case LyXRC::RC_ESC_CHARS:
2117 case LyXRC::RC_FONT_ENCODING:
2118 case LyXRC::RC_FORMAT:
2119 case LyXRC::RC_INDEX_COMMAND:
2120 case LyXRC::RC_INPUT:
2121 case LyXRC::RC_KBMAP:
2122 case LyXRC::RC_KBMAP_PRIMARY:
2123 case LyXRC::RC_KBMAP_SECONDARY:
2124 case LyXRC::RC_LABEL_INIT_LENGTH:
2125 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
2126 case LyXRC::RC_LANGUAGE_AUTO_END:
2127 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
2128 case LyXRC::RC_LANGUAGE_COMMAND_END:
2129 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
2130 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
2131 case LyXRC::RC_LANGUAGE_PACKAGE:
2132 case LyXRC::RC_LANGUAGE_USE_BABEL:
2133 case LyXRC::RC_MAKE_BACKUP:
2134 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
2135 case LyXRC::RC_NUMLASTFILES:
2136 case LyXRC::RC_PATH_PREFIX:
2137 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
2138 support::prependEnvPath("PATH", lyxrc.path_prefix);
2140 case LyXRC::RC_PERS_DICT:
2141 case LyXRC::RC_POPUP_BOLD_FONT:
2142 case LyXRC::RC_POPUP_FONT_ENCODING:
2143 case LyXRC::RC_POPUP_NORMAL_FONT:
2144 case LyXRC::RC_PREVIEW:
2145 case LyXRC::RC_PREVIEW_HASHED_LABELS:
2146 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
2147 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
2148 case LyXRC::RC_PRINTCOPIESFLAG:
2149 case LyXRC::RC_PRINTER:
2150 case LyXRC::RC_PRINTEVENPAGEFLAG:
2151 case LyXRC::RC_PRINTEXSTRAOPTIONS:
2152 case LyXRC::RC_PRINTFILEEXTENSION:
2153 case LyXRC::RC_PRINTLANDSCAPEFLAG:
2154 case LyXRC::RC_PRINTODDPAGEFLAG:
2155 case LyXRC::RC_PRINTPAGERANGEFLAG:
2156 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
2157 case LyXRC::RC_PRINTPAPERFLAG:
2158 case LyXRC::RC_PRINTREVERSEFLAG:
2159 case LyXRC::RC_PRINTSPOOL_COMMAND:
2160 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
2161 case LyXRC::RC_PRINTTOFILE:
2162 case LyXRC::RC_PRINTTOPRINTER:
2163 case LyXRC::RC_PRINT_ADAPTOUTPUT:
2164 case LyXRC::RC_PRINT_COMMAND:
2165 case LyXRC::RC_RTL_SUPPORT:
2166 case LyXRC::RC_SCREEN_DPI:
2167 case LyXRC::RC_SCREEN_FONT_ENCODING:
2168 case LyXRC::RC_SCREEN_FONT_ROMAN:
2169 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
2170 case LyXRC::RC_SCREEN_FONT_SANS:
2171 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
2172 case LyXRC::RC_SCREEN_FONT_SCALABLE:
2173 case LyXRC::RC_SCREEN_FONT_SIZES:
2174 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
2175 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
2176 case LyXRC::RC_SCREEN_GEOMETRY_HEIGHT:
2177 case LyXRC::RC_SCREEN_GEOMETRY_WIDTH:
2178 case LyXRC::RC_SCREEN_GEOMETRY_XYSAVED:
2179 case LyXRC::RC_SCREEN_ZOOM:
2180 case LyXRC::RC_SERVERPIPE:
2181 case LyXRC::RC_SET_COLOR:
2182 case LyXRC::RC_SHOW_BANNER:
2183 case LyXRC::RC_SPELL_COMMAND:
2184 case LyXRC::RC_TEMPDIRPATH:
2185 case LyXRC::RC_TEMPLATEPATH:
2186 case LyXRC::RC_TEX_ALLOWS_SPACES:
2187 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
2188 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
2189 support::os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
2191 case LyXRC::RC_UIFILE:
2192 case LyXRC::RC_USER_EMAIL:
2193 case LyXRC::RC_USER_NAME:
2194 case LyXRC::RC_USETEMPDIR:
2195 case LyXRC::RC_USE_ALT_LANG:
2196 case LyXRC::RC_USE_ESC_CHARS:
2197 case LyXRC::RC_USE_INP_ENC:
2198 case LyXRC::RC_USE_PERS_DICT:
2199 case LyXRC::RC_USE_SPELL_LIB:
2200 case LyXRC::RC_VIEWDVI_PAPEROPTION:
2201 case LyXRC::RC_VIEWER:
2202 case LyXRC::RC_LAST: