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"
30 #include "bufferview_funcs.h"
32 #include "CutAndPaste.h"
34 #include "dispatchresult.h"
36 #include "errorlist.h"
39 #include "funcrequest.h"
40 #include "FuncStatus.h"
43 #include "insetiterator.h"
51 #include "LyXAction.h"
56 #include "lyxserver.h"
57 #include "lyxtextclasslist.h"
59 #include "paragraph.h"
60 #include "pariterator.h"
61 #include "ParagraphParameters.h"
64 #include "insets/insetbox.h"
65 #include "insets/insetbranch.h"
66 #include "insets/insetcommand.h"
67 #include "insets/insetert.h"
68 #include "insets/insetexternal.h"
69 #include "insets/insetfloat.h"
70 #include "insets/insetgraphics.h"
71 #include "insets/insetinclude.h"
72 #include "insets/insetnote.h"
73 #include "insets/insettabular.h"
74 #include "insets/insetvspace.h"
75 #include "insets/insetwrap.h"
77 #include "frontends/Application.h"
78 #include "frontends/Alert.h"
79 #include "frontends/Dialogs.h"
80 #include "frontends/FileDialog.h"
81 #include "frontends/FontLoader.h"
82 #include "frontends/Gui.h"
83 #include "frontends/LyXKeySym.h"
84 #include "frontends/LyXView.h"
85 #include "frontends/Menubar.h"
86 #include "frontends/Toolbars.h"
88 #include "support/environment.h"
89 #include "support/filefilterlist.h"
90 #include "support/filetools.h"
91 #include "support/forkedcontr.h"
92 #include "support/fs_extras.h"
93 #include "support/lstrings.h"
94 #include "support/path.h"
95 #include "support/package.h"
96 #include "support/systemcall.h"
97 #include "support/convert.h"
98 #include "support/os.h"
100 #include <boost/current_function.hpp>
101 #include <boost/filesystem/operations.hpp>
108 using bv_funcs::freefont2string;
110 using support::absolutePath;
111 using support::addName;
112 using support::addPath;
113 using support::bformat;
114 using support::changeExtension;
115 using support::contains;
116 using support::FileFilterList;
117 using support::FileName;
118 using support::fileSearch;
119 using support::ForkedcallsController;
120 using support::i18nLibFileSearch;
121 using support::isDirWriteable;
122 using support::isFileReadable;
123 using support::isStrInt;
124 using support::makeAbsPath;
125 using support::makeDisplayPath;
126 using support::package;
127 using support::quoteName;
128 using support::rtrim;
129 using support::split;
130 using support::subst;
131 using support::Systemcall;
132 using support::token;
134 using support::prefixIs;
137 using std::make_pair;
140 using std::istringstream;
141 using std::ostringstream;
143 namespace Alert = frontend::Alert;
144 namespace fs = boost::filesystem;
148 extern tex_accent_struct get_accent(kb_action action);
153 bool getLocalStatus(LCursor cursor,
154 FuncRequest const & cmd, FuncStatus & status)
156 // Try to fix cursor in case it is broken.
157 cursor.fixIfBroken();
159 // This is, of course, a mess. Better create a new doc iterator and use
160 // this in Inset::getStatus. This might require an additional
161 // BufferView * arg, though (which should be avoided)
162 //LCursor safe = *this;
164 for ( ; cursor.depth(); cursor.pop()) {
165 //lyxerr << "\nLCursor::getStatus: cmd: " << cmd << endl << *this << endl;
166 BOOST_ASSERT(cursor.idx() <= cursor.lastidx());
167 BOOST_ASSERT(cursor.pit() <= cursor.lastpit());
168 BOOST_ASSERT(cursor.pos() <= cursor.lastpos());
170 // The inset's getStatus() will return 'true' if it made
171 // a definitive decision on whether it want to handle the
172 // request or not. The result of this decision is put into
173 // the 'status' parameter.
174 if (cursor.inset().getStatus(cursor, cmd, status)) {
183 /** Return the change status at cursor position, taking in account the
184 * status at each level of the document iterator (a table in a deleted
185 * footnote is deleted).
186 * When \param outer is true, the top slice is not looked at.
188 Change::Type lookupChangeType(DocIterator const & dit, bool outer = false)
190 size_t const depth = dit.depth() - (outer ? 1 : 0);
192 for (size_t i = 0 ; i < depth ; ++i) {
193 CursorSlice const & slice = dit[i];
194 if (!slice.inset().inMathed()
195 && slice.pos() < slice.paragraph().size()) {
196 Change::Type const ch = slice.paragraph().lookupChange(slice.pos()).type;
197 if (ch != Change::UNCHANGED)
201 return Change::UNCHANGED;
209 meta_fake_bit(key_modifier::none)
214 void LyXFunc::initKeySequences(kb_keymap * kb)
216 keyseq.reset(new kb_sequence(kb, kb));
217 cancel_meta_seq.reset(new kb_sequence(kb, kb));
221 void LyXFunc::setLyXView(LyXView * lv)
227 void LyXFunc::handleKeyFunc(kb_action action)
229 char_type c = encoded_last_key;
231 if (keyseq->length())
234 lyx_view_->view()->getIntl().getTransManager().deadkey(
235 c, get_accent(action).accent, view()->getLyXText(), view()->cursor());
236 // Need to clear, in case the minibuffer calls these
239 // copied verbatim from do_accent_char
240 view()->cursor().resetAnchor();
245 void LyXFunc::gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer)
247 BOOST_ASSERT(lyx_view_);
248 if (!LyX::ref().session().bookmarks().isValid(idx))
250 BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(idx);
251 BOOST_ASSERT(!bm.filename.empty());
252 string const file = bm.filename.absFilename();
253 // if the file is not opened, open it.
254 if (!theBufferList().exists(file)) {
256 dispatch(FuncRequest(LFUN_FILE_OPEN, file));
260 // open may fail, so we need to test it again
261 if (theBufferList().exists(file)) {
262 // if the current buffer is not that one, switch to it.
263 if (lyx_view_->buffer()->fileName() != file) {
265 dispatch(FuncRequest(LFUN_BUFFER_SWITCH, file));
269 // moveToPosition use par_id, and par_pit and return new par_id.
272 boost::tie(new_pit, new_id) = view()->moveToPosition(bm.par_pit, bm.par_id, bm.par_pos);
273 // if par_id or pit has been changed, reset par_pit and par_id
274 // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
275 if (bm.par_pit != new_pit || bm.par_id != new_id)
276 const_cast<BookmarksSection::Bookmark &>(bm).setPos(new_pit, new_id);
281 void LyXFunc::processKeySym(LyXKeySymPtr keysym, key_modifier::state state)
283 lyxerr[Debug::KEY] << "KeySym is " << keysym->getSymbolName() << endl;
285 // Do nothing if we have nothing (JMarc)
286 if (!keysym->isOK()) {
287 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
292 if (keysym->isModifier()) {
293 lyxerr[Debug::KEY] << "isModifier true" << endl;
297 //Encoding const * encoding = view()->cursor().getEncoding();
298 //encoded_last_key = keysym->getISOEncoded(encoding ? encoding->name() : "");
299 // FIXME: encoded_last_key shadows the member variable of the same
300 // name. Is that intended?
301 char_type encoded_last_key = keysym->getUCSEncoded();
303 // Do a one-deep top-level lookup for
304 // cancel and meta-fake keys. RVDK_PATCH_5
305 cancel_meta_seq->reset();
307 FuncRequest func = cancel_meta_seq->addkey(keysym, state);
308 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
309 << " action first set to [" << func.action << ']'
312 // When not cancel or meta-fake, do the normal lookup.
313 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
314 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
315 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_PREFIX)) {
316 // remove Caps Lock and Mod2 as a modifiers
317 func = keyseq->addkey(keysym, (state | meta_fake_bit));
318 lyxerr[Debug::KEY] << BOOST_CURRENT_FUNCTION
319 << "action now set to ["
320 << func.action << ']' << endl;
323 // Dont remove this unless you know what you are doing.
324 meta_fake_bit = key_modifier::none;
326 // Can this happen now ?
327 if (func.action == LFUN_NOACTION) {
328 func = FuncRequest(LFUN_COMMAND_PREFIX);
331 if (lyxerr.debugging(Debug::KEY)) {
332 lyxerr << BOOST_CURRENT_FUNCTION
334 << func.action << "]["
335 << to_utf8(keyseq->print(false)) << ']'
339 // already here we know if it any point in going further
340 // why not return already here if action == -1 and
341 // num_bytes == 0? (Lgb)
343 if (keyseq->length() > 1) {
344 lyx_view_->message(keyseq->print(true));
348 // Maybe user can only reach the key via holding down shift.
349 // Let's see. But only if shift is the only modifier
350 if (func.action == LFUN_UNKNOWN_ACTION &&
351 state == key_modifier::shift) {
352 lyxerr[Debug::KEY] << "Trying without shift" << endl;
353 func = keyseq->addkey(keysym, key_modifier::none);
354 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
357 if (func.action == LFUN_UNKNOWN_ACTION) {
358 // Hmm, we didn't match any of the keysequences. See
359 // if it's normal insertable text not already covered
361 if (keysym->isText() && keyseq->length() == 1) {
362 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
363 func = FuncRequest(LFUN_SELF_INSERT,
364 FuncRequest::KEYBOARD);
366 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
367 lyx_view_->message(_("Unknown function."));
372 if (func.action == LFUN_SELF_INSERT) {
373 if (encoded_last_key != 0) {
374 docstring const arg(1, encoded_last_key);
375 dispatch(FuncRequest(LFUN_SELF_INSERT, arg,
376 FuncRequest::KEYBOARD));
378 << "SelfInsert arg[`" << to_utf8(arg) << "']" << endl;
386 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
388 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
391 LCursor & cur = view()->cursor();
393 /* In LyX/Mac, when a dialog is open, the menus of the
394 application can still be accessed without giving focus to
395 the main window. In this case, we want to disable the menu
396 entries that are buffer-related.
398 Note that this code is not perfect, as bug 1941 attests:
399 http://bugzilla.lyx.org/show_bug.cgi?id=1941#c4
401 Buffer * buf = lyx_view_? lyx_view_->buffer() : 0;
402 if (lyx_view_ && cmd.origin == FuncRequest::MENU && !lyx_view_->hasFocus())
405 if (cmd.action == LFUN_NOACTION) {
406 flag.message(from_utf8(N_("Nothing to do")));
411 switch (cmd.action) {
412 case LFUN_UNKNOWN_ACTION:
413 #ifndef HAVE_LIBAIKSAURUS
414 case LFUN_THESAURUS_ENTRY:
424 if (flag.unknown()) {
425 flag.message(from_utf8(N_("Unknown action")));
429 if (!flag.enabled()) {
430 if (flag.message().empty())
431 flag.message(from_utf8(N_("Command disabled")));
435 // Check whether we need a buffer
436 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
438 flag.message(from_utf8(N_("Command not allowed with"
439 "out any document open")));
444 // I would really like to avoid having this switch and rather try to
445 // encode this in the function itself.
446 // -- And I'd rather let an inset decide which LFUNs it is willing
447 // to handle (Andre')
449 switch (cmd.action) {
450 case LFUN_BUFFER_TOGGLE_READ_ONLY:
451 flag.setOnOff(buf->isReadonly());
454 case LFUN_BUFFER_SWITCH:
455 // toggle on the current buffer, but do not toggle off
456 // the other ones (is that a good idea?)
457 if (to_utf8(cmd.argument()) == buf->fileName())
461 case LFUN_BUFFER_EXPORT:
462 enable = cmd.argument() == "custom"
463 || Exporter::isExportable(*buf, to_utf8(cmd.argument()));
466 case LFUN_BUFFER_CHKTEX:
467 enable = buf->isLatex() && !lyxrc.chktex_command.empty();
470 case LFUN_BUILD_PROGRAM:
471 enable = Exporter::isExportable(*buf, "program");
474 case LFUN_LAYOUT_TABULAR:
475 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
479 case LFUN_LAYOUT_PARAGRAPH:
480 enable = !cur.inset().forceDefaultParagraphs(cur.idx());
483 case LFUN_VC_REGISTER:
484 enable = !buf->lyxvc().inUse();
486 case LFUN_VC_CHECK_IN:
487 enable = buf->lyxvc().inUse() && !buf->isReadonly();
489 case LFUN_VC_CHECK_OUT:
490 enable = buf->lyxvc().inUse() && buf->isReadonly();
493 case LFUN_VC_UNDO_LAST:
494 enable = buf->lyxvc().inUse();
496 case LFUN_BUFFER_RELOAD:
497 enable = !buf->isUnnamed() && !buf->isClean();
500 case LFUN_INSET_SETTINGS: {
504 InsetBase::Code code = cur.inset().lyxCode();
506 case InsetBase::TABULAR_CODE:
507 enable = cmd.argument() == "tabular";
509 case InsetBase::ERT_CODE:
510 enable = cmd.argument() == "ert";
512 case InsetBase::FLOAT_CODE:
513 enable = cmd.argument() == "float";
515 case InsetBase::WRAP_CODE:
516 enable = cmd.argument() == "wrap";
518 case InsetBase::NOTE_CODE:
519 enable = cmd.argument() == "note";
521 case InsetBase::BRANCH_CODE:
522 enable = cmd.argument() == "branch";
524 case InsetBase::BOX_CODE:
525 enable = cmd.argument() == "box";
533 case LFUN_INSET_APPLY: {
534 string const name = cmd.getArg(0);
535 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
537 FuncRequest fr(LFUN_INSET_MODIFY, cmd.argument());
539 if (!inset->getStatus(cur, fr, fs)) {
540 // Every inset is supposed to handle this
545 FuncRequest fr(LFUN_INSET_INSERT, cmd.argument());
546 flag |= getStatus(fr);
548 enable = flag.enabled();
552 case LFUN_DIALOG_SHOW: {
553 string const name = cmd.getArg(0);
555 enable = name == "aboutlyx"
559 || name == "texinfo";
560 else if (name == "print")
561 enable = Exporter::isExportable(*buf, "dvi")
562 && lyxrc.print_command != "none";
563 else if (name == "character" || name == "mathpanel")
564 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
565 else if (name == "latexlog")
566 enable = isFileReadable(FileName(buf->getLogName().second));
567 #if !defined (USE_ASPELL) && !defined (USE_ISPELL) && !defined (USE_PSPELL)
568 else if (name == "spellchecker")
571 else if (name == "vclog")
572 enable = buf->lyxvc().inUse();
573 else if (name == "view-source")
578 case LFUN_DIALOG_SHOW_NEW_INSET:
579 enable = cur.inset().lyxCode() != InsetBase::ERT_CODE;
582 case LFUN_DIALOG_UPDATE: {
583 string const name = cmd.getArg(0);
585 enable = name == "prefs";
589 case LFUN_CITATION_INSERT: {
590 FuncRequest fr(LFUN_INSET_INSERT, "citation");
591 enable = getStatus(fr).enabled();
595 case LFUN_BUFFER_WRITE: {
596 enable = view()->buffer()->isUnnamed()
597 || !view()->buffer()->isClean();
601 case LFUN_BOOKMARK_GOTO: {
602 const unsigned int num = convert<unsigned int>(to_utf8(cmd.argument()));
603 enable = LyX::ref().session().bookmarks().isValid(num);
607 case LFUN_BOOKMARK_CLEAR:
608 enable = LyX::ref().session().bookmarks().size() > 0;
611 case LFUN_TOOLBAR_TOGGLE_STATE: {
612 ToolbarBackend::Flags flags = lyx_view_->getToolbarState(to_utf8(cmd.argument()));
613 if (!(flags & ToolbarBackend::AUTO))
614 flag.setOnOff(flags & ToolbarBackend::ON);
618 // this one is difficult to get right. As a half-baked
619 // solution, we consider only the first action of the sequence
620 case LFUN_COMMAND_SEQUENCE: {
621 // argument contains ';'-terminated commands
622 string const firstcmd = token(to_utf8(cmd.argument()), ';', 0);
623 FuncRequest func(lyxaction.lookupFunc(firstcmd));
624 func.origin = cmd.origin;
625 flag = getStatus(func);
628 case LFUN_BUFFER_NEW:
629 case LFUN_BUFFER_NEW_TEMPLATE:
630 case LFUN_WORD_FIND_FORWARD:
631 case LFUN_WORD_FIND_BACKWARD:
632 case LFUN_COMMAND_PREFIX:
633 case LFUN_COMMAND_EXECUTE:
635 case LFUN_META_PREFIX:
636 case LFUN_BUFFER_CLOSE:
637 case LFUN_BUFFER_WRITE_AS:
638 case LFUN_BUFFER_UPDATE:
639 case LFUN_BUFFER_VIEW:
640 case LFUN_BUFFER_IMPORT:
642 case LFUN_BUFFER_AUTO_SAVE:
643 case LFUN_RECONFIGURE:
647 case LFUN_DROP_LAYOUTS_CHOICE:
649 case LFUN_SERVER_GET_NAME:
650 case LFUN_SERVER_NOTIFY:
651 case LFUN_SERVER_GOTO_FILE_ROW:
652 case LFUN_DIALOG_HIDE:
653 case LFUN_DIALOG_DISCONNECT_INSET:
654 case LFUN_BUFFER_CHILD_OPEN:
655 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
656 case LFUN_KEYMAP_OFF:
657 case LFUN_KEYMAP_PRIMARY:
658 case LFUN_KEYMAP_SECONDARY:
659 case LFUN_KEYMAP_TOGGLE:
661 case LFUN_BUFFER_EXPORT_CUSTOM:
662 case LFUN_BUFFER_PRINT:
663 case LFUN_PREFERENCES_SAVE:
664 case LFUN_SCREEN_FONT_UPDATE:
667 case LFUN_EXTERNAL_EDIT:
668 case LFUN_GRAPHICS_EDIT:
669 case LFUN_ALL_INSETS_TOGGLE:
670 case LFUN_BUFFER_LANGUAGE:
671 case LFUN_TEXTCLASS_APPLY:
672 case LFUN_TEXTCLASS_LOAD:
673 case LFUN_BUFFER_SAVE_AS_DEFAULT:
674 case LFUN_BUFFER_PARAMS_APPLY:
675 case LFUN_LYXRC_APPLY:
676 case LFUN_BUFFER_NEXT:
677 case LFUN_BUFFER_PREVIOUS:
678 case LFUN_WINDOW_NEW:
679 case LFUN_WINDOW_CLOSE:
681 // these are handled in our dispatch()
685 if (!getLocalStatus(cur, cmd, flag))
686 flag = view()->getStatus(cmd);
692 // Can we use a readonly buffer?
693 if (buf && buf->isReadonly()
694 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
695 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
696 flag.message(from_utf8(N_("Document is read-only")));
700 // Are we in a DELETED change-tracking region?
701 if (buf && lookupChangeType(cur, true) == Change::DELETED
702 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
703 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
704 flag.message(from_utf8(N_("This portion of the document is deleted.")));
708 // the default error message if we disable the command
709 if (!flag.enabled() && flag.message().empty())
710 flag.message(from_utf8(N_("Command disabled")));
716 bool LyXFunc::ensureBufferClean(BufferView * bv)
718 Buffer & buf = *bv->buffer();
722 docstring const file = makeDisplayPath(buf.fileName(), 30);
723 docstring text = bformat(_("The document %1$s has unsaved "
724 "changes.\n\nDo you want to save "
725 "the document?"), file);
726 int const ret = Alert::prompt(_("Save changed document?"),
727 text, 0, 1, _("&Save"),
731 dispatch(FuncRequest(LFUN_BUFFER_WRITE));
733 return buf.isClean();
739 void showPrintError(string const & name)
741 docstring str = bformat(_("Could not print the document %1$s.\n"
742 "Check that your printer is set up correctly."),
743 makeDisplayPath(name, 50));
744 Alert::error(_("Print document failed"), str);
748 void loadTextclass(string const & name)
750 std::pair<bool, textclass_type> const tc_pair =
751 textclasslist.numberOfClass(name);
753 if (!tc_pair.first) {
754 lyxerr << "Document class \"" << name
755 << "\" does not exist."
760 textclass_type const tc = tc_pair.second;
762 if (!textclasslist[tc].load()) {
763 docstring s = bformat(_("The document could not be converted\n"
764 "into the document class %1$s."),
765 from_utf8(textclasslist[tc].name()));
766 Alert::error(_("Could not change class"), s);
771 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new);
776 void LyXFunc::dispatch(FuncRequest const & cmd)
778 string const argument = to_utf8(cmd.argument());
779 kb_action const action = cmd.action;
781 lyxerr[Debug::ACTION] << endl << "LyXFunc::dispatch: cmd: " << cmd << endl;
782 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
784 // we have not done anything wrong yet.
786 dispatch_buffer.erase();
788 // redraw the screen at the end (first of the two drawing steps).
789 //This is done unless explicitely requested otherwise
790 Update::flags updateFlags = Update::FitCursor;
792 FuncStatus const flag = getStatus(cmd);
793 if (!flag.enabled()) {
794 // We cannot use this function here
795 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
796 << lyxaction.getActionName(action)
797 << " [" << action << "] is disabled at this location"
799 setErrorMessage(flag.message());
803 case LFUN_WORD_FIND_FORWARD:
804 case LFUN_WORD_FIND_BACKWARD: {
805 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
806 static docstring last_search;
807 docstring searched_string;
809 if (!cmd.argument().empty()) {
810 last_search = cmd.argument();
811 searched_string = cmd.argument();
813 searched_string = last_search;
816 if (searched_string.empty())
819 bool const fw = action == LFUN_WORD_FIND_FORWARD;
820 docstring const data =
821 find2string(searched_string, true, false, fw);
822 find(view(), FuncRequest(LFUN_WORD_FIND, data));
826 case LFUN_COMMAND_PREFIX:
827 BOOST_ASSERT(lyx_view_);
828 lyx_view_->message(keyseq->printOptions(true));
831 case LFUN_COMMAND_EXECUTE:
832 BOOST_ASSERT(lyx_view_);
833 lyx_view_->getToolbars().display("minibuffer", true);
834 lyx_view_->focus_command_buffer();
838 BOOST_ASSERT(lyx_view_ && lyx_view_->view());
840 meta_fake_bit = key_modifier::none;
841 if (view()->buffer())
842 // cancel any selection
843 dispatch(FuncRequest(LFUN_MARK_OFF));
844 setMessage(_("Cancel"));
847 case LFUN_META_PREFIX:
848 meta_fake_bit = key_modifier::alt;
849 setMessage(keyseq->print(true));
852 case LFUN_BUFFER_TOGGLE_READ_ONLY:
853 BOOST_ASSERT(lyx_view_ && lyx_view_->view() && lyx_view_->buffer());
854 if (lyx_view_->buffer()->lyxvc().inUse())
855 lyx_view_->buffer()->lyxvc().toggleReadOnly();
857 lyx_view_->buffer()->setReadonly(
858 !lyx_view_->buffer()->isReadonly());
861 // --- Menus -----------------------------------------------
862 case LFUN_BUFFER_NEW:
863 menuNew(argument, false);
866 case LFUN_BUFFER_NEW_TEMPLATE:
867 menuNew(argument, true);
870 case LFUN_BUFFER_CLOSE:
875 case LFUN_BUFFER_WRITE:
876 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
877 if (!lyx_view_->buffer()->isUnnamed()) {
878 docstring const str = bformat(_("Saving document %1$s..."),
879 makeDisplayPath(lyx_view_->buffer()->fileName()));
880 lyx_view_->message(str);
881 menuWrite(lyx_view_->buffer());
882 lyx_view_->message(str + _(" done."));
884 writeAs(lyx_view_->buffer());
886 updateFlags = Update::None;
889 case LFUN_BUFFER_WRITE_AS:
890 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
891 writeAs(lyx_view_->buffer(), argument);
892 updateFlags = Update::None;
895 case LFUN_BUFFER_RELOAD: {
896 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
897 docstring const file = makeDisplayPath(view()->buffer()->fileName(), 20);
898 docstring text = bformat(_("Any changes will be lost. Are you sure "
899 "you want to revert to the saved version of the document %1$s?"), file);
900 int const ret = Alert::prompt(_("Revert to saved document?"),
901 text, 0, 1, _("&Revert"), _("&Cancel"));
908 case LFUN_BUFFER_UPDATE:
909 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
910 Exporter::Export(lyx_view_->buffer(), argument, true);
913 case LFUN_BUFFER_VIEW:
914 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
915 Exporter::preview(lyx_view_->buffer(), argument);
918 case LFUN_BUILD_PROGRAM:
919 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
920 Exporter::Export(lyx_view_->buffer(), "program", true);
923 case LFUN_BUFFER_CHKTEX:
924 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
925 lyx_view_->buffer()->runChktex();
928 case LFUN_BUFFER_EXPORT:
929 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
930 if (argument == "custom")
931 lyx_view_->getDialogs().show("sendto");
933 Exporter::Export(lyx_view_->buffer(), argument, false);
937 case LFUN_BUFFER_EXPORT_CUSTOM: {
938 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
940 string command = split(argument, format_name, ' ');
941 Format const * format = formats.getFormat(format_name);
943 lyxerr << "Format \"" << format_name
944 << "\" not recognized!"
949 Buffer * buffer = lyx_view_->buffer();
951 // The name of the file created by the conversion process
954 // Output to filename
955 if (format->name() == "lyx") {
956 string const latexname =
957 buffer->getLatexName(false);
958 filename = changeExtension(latexname,
959 format->extension());
960 filename = addName(buffer->temppath(), filename);
962 if (!buffer->writeFile(FileName(filename)))
966 Exporter::Export(buffer, format_name, true, filename);
969 // Substitute $$FName for filename
970 if (!contains(command, "$$FName"))
971 command = "( " + command + " ) < $$FName";
972 command = subst(command, "$$FName", filename);
974 // Execute the command in the background
976 call.startscript(Systemcall::DontWait, command);
980 case LFUN_BUFFER_PRINT: {
981 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
984 string command = split(split(argument, target, ' '),
988 || target_name.empty()
989 || command.empty()) {
990 lyxerr << "Unable to parse \""
991 << argument << '"' << std::endl;
994 if (target != "printer" && target != "file") {
995 lyxerr << "Unrecognized target \""
996 << target << '"' << std::endl;
1000 Buffer * buffer = lyx_view_->buffer();
1002 if (!Exporter::Export(buffer, "dvi", true)) {
1003 showPrintError(buffer->fileName());
1007 // Push directory path.
1008 string const path = buffer->temppath();
1009 support::Path p(path);
1011 // there are three cases here:
1012 // 1. we print to a file
1013 // 2. we print directly to a printer
1014 // 3. we print using a spool command (print to file first)
1017 string const dviname =
1018 changeExtension(buffer->getLatexName(true),
1021 if (target == "printer") {
1022 if (!lyxrc.print_spool_command.empty()) {
1023 // case 3: print using a spool
1024 string const psname =
1025 changeExtension(dviname,".ps");
1026 command += lyxrc.print_to_file
1029 + quoteName(dviname);
1032 lyxrc.print_spool_command +' ';
1033 if (target_name != "default") {
1034 command2 += lyxrc.print_spool_printerprefix
1038 command2 += quoteName(psname);
1040 // If successful, then spool command
1041 res = one.startscript(
1046 res = one.startscript(
1047 Systemcall::DontWait,
1050 // case 2: print directly to a printer
1051 res = one.startscript(
1052 Systemcall::DontWait,
1053 command + quoteName(dviname));
1057 // case 1: print to a file
1058 command += lyxrc.print_to_file
1059 + quoteName(makeAbsPath(target_name,
1060 path).toFilesystemEncoding())
1062 + quoteName(dviname);
1063 res = one.startscript(Systemcall::DontWait,
1068 showPrintError(buffer->fileName());
1072 case LFUN_BUFFER_IMPORT:
1077 // quitting is triggered by the gui code
1078 // (leaving the event loop).
1079 lyx_view_->message(from_utf8(N_("Exiting.")));
1080 if (theBufferList().quitWriteAll())
1081 theApp()->gui().closeAllViews();
1084 case LFUN_TOC_VIEW: {
1085 BOOST_ASSERT(lyx_view_);
1086 InsetCommandParams p("tableofcontents");
1087 string const data = InsetCommandMailer::params2string("toc", p);
1088 lyx_view_->getDialogs().show("toc", data, 0);
1092 case LFUN_BUFFER_AUTO_SAVE:
1096 case LFUN_RECONFIGURE:
1097 BOOST_ASSERT(lyx_view_);
1098 reconfigure(*lyx_view_);
1101 case LFUN_HELP_OPEN: {
1102 BOOST_ASSERT(lyx_view_);
1103 string const arg = argument;
1105 setErrorMessage(_("Missing argument"));
1108 FileName const fname = i18nLibFileSearch("doc", arg, "lyx");
1109 if (fname.empty()) {
1110 lyxerr << "LyX: unable to find documentation file `"
1111 << arg << "'. Bad installation?" << endl;
1114 lyx_view_->message(bformat(_("Opening help file %1$s..."),
1115 makeDisplayPath(fname.absFilename())));
1116 lyx_view_->loadLyXFile(fname, false);
1120 // --- version control -------------------------------
1121 case LFUN_VC_REGISTER:
1122 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1123 if (!ensureBufferClean(view()))
1125 if (!lyx_view_->buffer()->lyxvc().inUse()) {
1126 lyx_view_->buffer()->lyxvc().registrer();
1129 updateFlags = Update::Force;
1132 case LFUN_VC_CHECK_IN:
1133 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1134 if (!ensureBufferClean(view()))
1136 if (lyx_view_->buffer()->lyxvc().inUse()
1137 && !lyx_view_->buffer()->isReadonly()) {
1138 lyx_view_->buffer()->lyxvc().checkIn();
1143 case LFUN_VC_CHECK_OUT:
1144 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1145 if (!ensureBufferClean(view()))
1147 if (lyx_view_->buffer()->lyxvc().inUse()
1148 && lyx_view_->buffer()->isReadonly()) {
1149 lyx_view_->buffer()->lyxvc().checkOut();
1154 case LFUN_VC_REVERT:
1155 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1156 lyx_view_->buffer()->lyxvc().revert();
1160 case LFUN_VC_UNDO_LAST:
1161 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1162 lyx_view_->buffer()->lyxvc().undoLast();
1166 // --- buffers ----------------------------------------
1167 case LFUN_BUFFER_SWITCH:
1168 BOOST_ASSERT(lyx_view_);
1169 lyx_view_->setBuffer(theBufferList().getBuffer(argument));
1172 case LFUN_BUFFER_NEXT:
1173 BOOST_ASSERT(lyx_view_);
1174 lyx_view_->setBuffer(theBufferList().next(view()->buffer()));
1177 case LFUN_BUFFER_PREVIOUS:
1178 BOOST_ASSERT(lyx_view_);
1179 lyx_view_->setBuffer(theBufferList().previous(view()->buffer()));
1183 BOOST_ASSERT(lyx_view_);
1184 newFile(view(), argument);
1187 case LFUN_FILE_OPEN:
1188 BOOST_ASSERT(lyx_view_);
1192 case LFUN_DROP_LAYOUTS_CHOICE:
1193 BOOST_ASSERT(lyx_view_);
1194 lyx_view_->getToolbars().openLayoutList();
1197 case LFUN_MENU_OPEN:
1198 BOOST_ASSERT(lyx_view_);
1199 lyx_view_->getMenubar().openByName(from_utf8(argument));
1202 // --- lyxserver commands ----------------------------
1203 case LFUN_SERVER_GET_NAME:
1204 BOOST_ASSERT(lyx_view_ && lyx_view_->buffer());
1205 setMessage(from_utf8(lyx_view_->buffer()->fileName()));
1206 lyxerr[Debug::INFO] << "FNAME["
1207 << lyx_view_->buffer()->fileName()
1211 case LFUN_SERVER_NOTIFY:
1212 dispatch_buffer = keyseq->print(false);
1213 theLyXServer().notifyClient(to_utf8(dispatch_buffer));
1216 case LFUN_SERVER_GOTO_FILE_ROW: {
1217 BOOST_ASSERT(lyx_view_);
1220 istringstream is(argument);
1221 is >> file_name >> row;
1222 if (prefixIs(file_name, package().temp_dir())) {
1223 // Needed by inverse dvi search. If it is a file
1224 // in tmpdir, call the apropriated function
1225 lyx_view_->setBuffer(theBufferList().getBufferFromTmp(file_name));
1227 // Must replace extension of the file to be .lyx
1228 // and get full path
1229 FileName const s = fileSearch(string(), changeExtension(file_name, ".lyx"), "lyx");
1230 // Either change buffer or load the file
1231 if (theBufferList().exists(s.absFilename())) {
1232 lyx_view_->setBuffer(theBufferList().getBuffer(s.absFilename()));
1234 lyx_view_->loadLyXFile(s);
1238 view()->setCursorFromRow(row);
1240 updateFlags = Update::FitCursor;
1244 case LFUN_DIALOG_SHOW: {
1245 BOOST_ASSERT(lyx_view_);
1246 string const name = cmd.getArg(0);
1247 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1249 if (name == "character") {
1250 data = freefont2string();
1252 lyx_view_->getDialogs().show("character", data);
1253 } else if (name == "latexlog") {
1254 pair<Buffer::LogType, string> const logfile =
1255 lyx_view_->buffer()->getLogName();
1256 switch (logfile.first) {
1257 case Buffer::latexlog:
1260 case Buffer::buildlog:
1264 data += LyXLex::quoteString(logfile.second);
1265 lyx_view_->getDialogs().show("log", data);
1266 } else if (name == "vclog") {
1267 string const data = "vc " +
1268 LyXLex::quoteString(lyx_view_->buffer()->lyxvc().getLogFile());
1269 lyx_view_->getDialogs().show("log", data);
1271 lyx_view_->getDialogs().show(name, data);
1275 case LFUN_DIALOG_SHOW_NEW_INSET: {
1276 BOOST_ASSERT(lyx_view_);
1277 string const name = cmd.getArg(0);
1278 string data = trim(to_utf8(cmd.argument()).substr(name.size()));
1279 if (name == "bibitem" ||
1283 name == "nomenclature" ||
1287 InsetCommandParams p(name);
1288 data = InsetCommandMailer::params2string(name, p);
1289 } else if (name == "include") {
1290 // data is the include type: one of "include",
1291 // "input", "verbatiminput" or "verbatiminput*"
1293 // default type is requested
1295 InsetCommandParams p(data);
1296 data = InsetIncludeMailer::params2string(p);
1297 } else if (name == "box") {
1298 // \c data == "Boxed" || "Frameless" etc
1299 InsetBoxParams p(data);
1300 data = InsetBoxMailer::params2string(p);
1301 } else if (name == "branch") {
1302 InsetBranchParams p;
1303 data = InsetBranchMailer::params2string(p);
1304 } else if (name == "citation") {
1305 InsetCommandParams p("cite");
1306 data = InsetCommandMailer::params2string(name, p);
1307 } else if (name == "ert") {
1308 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1309 } else if (name == "external") {
1310 InsetExternalParams p;
1311 Buffer const & buffer = *lyx_view_->buffer();
1312 data = InsetExternalMailer::params2string(p, buffer);
1313 } else if (name == "float") {
1315 data = InsetFloatMailer::params2string(p);
1316 } else if (name == "graphics") {
1317 InsetGraphicsParams p;
1318 Buffer const & buffer = *lyx_view_->buffer();
1319 data = InsetGraphicsMailer::params2string(p, buffer);
1320 } else if (name == "note") {
1322 data = InsetNoteMailer::params2string(p);
1323 } else if (name == "vspace") {
1325 data = InsetVSpaceMailer::params2string(space);
1326 } else if (name == "wrap") {
1328 data = InsetWrapMailer::params2string(p);
1330 lyx_view_->getDialogs().show(name, data, 0);
1334 case LFUN_DIALOG_UPDATE: {
1335 BOOST_ASSERT(lyx_view_);
1336 string const & name = argument;
1337 // Can only update a dialog connected to an existing inset
1338 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1340 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument());
1341 inset->dispatch(view()->cursor(), fr);
1342 } else if (name == "paragraph") {
1343 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1344 } else if (name == "prefs") {
1345 lyx_view_->getDialogs().update(name, string());
1350 case LFUN_DIALOG_HIDE:
1351 Dialogs::hide(argument, 0);
1354 case LFUN_DIALOG_DISCONNECT_INSET:
1355 BOOST_ASSERT(lyx_view_);
1356 lyx_view_->getDialogs().disconnect(argument);
1360 case LFUN_CITATION_INSERT: {
1361 BOOST_ASSERT(lyx_view_);
1362 if (!argument.empty()) {
1363 // we can have one optional argument, delimited by '|'
1364 // citation-insert <key>|<text_before>
1365 // this should be enhanced to also support text_after
1366 // and citation style
1367 string arg = argument;
1369 if (contains(argument, "|")) {
1370 arg = token(argument, '|', 0);
1371 opt1 = '[' + token(argument, '|', 1) + ']';
1373 std::ostringstream os;
1374 os << "citation LatexCommand\n"
1375 << "\\cite" << opt1 << "{" << arg << "}\n"
1377 FuncRequest fr(LFUN_INSET_INSERT, os.str());
1380 dispatch(FuncRequest(LFUN_DIALOG_SHOW, "citation"));
1384 case LFUN_BUFFER_CHILD_OPEN: {
1385 BOOST_ASSERT(lyx_view_);
1386 FileName const filename =
1387 makeAbsPath(argument, lyx_view_->buffer()->filePath());
1388 // FIXME Should use bformat
1389 setMessage(_("Opening child document ") +
1390 makeDisplayPath(filename.absFilename()) + "...");
1391 view()->saveBookmark(false);
1392 string const parentfilename = lyx_view_->buffer()->fileName();
1393 if (theBufferList().exists(filename.absFilename()))
1394 lyx_view_->setBuffer(theBufferList().getBuffer(filename.absFilename()));
1396 lyx_view_->loadLyXFile(filename);
1397 // Set the parent name of the child document.
1398 // This makes insertion of citations and references in the child work,
1399 // when the target is in the parent or another child document.
1400 lyx_view_->buffer()->setParentName(parentfilename);
1404 case LFUN_TOGGLE_CURSOR_FOLLOWS_SCROLLBAR:
1405 BOOST_ASSERT(lyx_view_);
1406 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1409 case LFUN_KEYMAP_OFF:
1410 BOOST_ASSERT(lyx_view_);
1411 lyx_view_->view()->getIntl().keyMapOn(false);
1414 case LFUN_KEYMAP_PRIMARY:
1415 BOOST_ASSERT(lyx_view_);
1416 lyx_view_->view()->getIntl().keyMapPrim();
1419 case LFUN_KEYMAP_SECONDARY:
1420 BOOST_ASSERT(lyx_view_);
1421 lyx_view_->view()->getIntl().keyMapSec();
1424 case LFUN_KEYMAP_TOGGLE:
1425 BOOST_ASSERT(lyx_view_);
1426 lyx_view_->view()->getIntl().toggleKeyMap();
1432 string rest = split(argument, countstr, ' ');
1433 istringstream is(countstr);
1436 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1437 for (int i = 0; i < count; ++i)
1438 dispatch(lyxaction.lookupFunc(rest));
1442 case LFUN_COMMAND_SEQUENCE: {
1443 // argument contains ';'-terminated commands
1444 string arg = argument;
1445 while (!arg.empty()) {
1447 arg = split(arg, first, ';');
1448 FuncRequest func(lyxaction.lookupFunc(first));
1449 func.origin = cmd.origin;
1455 case LFUN_PREFERENCES_SAVE: {
1456 lyxrc.write(makeAbsPath("preferences",
1457 package().user_support()),
1462 case LFUN_SCREEN_FONT_UPDATE:
1463 BOOST_ASSERT(lyx_view_);
1464 // handle the screen font changes.
1465 lyxrc.set_font_norm_type();
1466 theFontLoader().update();
1467 /// FIXME: only the current view will be updated. the Gui
1468 /// class is able to furnish the list of views.
1469 updateFlags = Update::Force;
1472 case LFUN_SET_COLOR: {
1474 string const x11_name = split(argument, lyx_name, ' ');
1475 if (lyx_name.empty() || x11_name.empty()) {
1476 setErrorMessage(_("Syntax: set-color <lyx_name>"
1481 bool const graphicsbg_changed =
1482 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1483 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1485 if (!lcolor.setColor(lyx_name, x11_name)) {
1487 bformat(_("Set-color \"%1$s\" failed "
1488 "- color is undefined or "
1489 "may not be redefined"),
1490 from_utf8(lyx_name)));
1494 theApp()->updateColor(lcolor.getFromLyXName(lyx_name));
1496 if (graphicsbg_changed) {
1497 #ifdef WITH_WARNINGS
1498 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1501 graphics::GCache::get().changeDisplay(true);
1508 BOOST_ASSERT(lyx_view_);
1509 lyx_view_->message(from_utf8(argument));
1512 case LFUN_EXTERNAL_EDIT: {
1513 BOOST_ASSERT(lyx_view_);
1514 FuncRequest fr(action, argument);
1515 InsetExternal().dispatch(view()->cursor(), fr);
1519 case LFUN_GRAPHICS_EDIT: {
1520 FuncRequest fr(action, argument);
1521 InsetGraphics().dispatch(view()->cursor(), fr);
1525 case LFUN_INSET_APPLY: {
1526 BOOST_ASSERT(lyx_view_);
1527 string const name = cmd.getArg(0);
1528 InsetBase * inset = lyx_view_->getDialogs().getOpenInset(name);
1530 FuncRequest fr(LFUN_INSET_MODIFY, argument);
1531 inset->dispatch(view()->cursor(), fr);
1533 FuncRequest fr(LFUN_INSET_INSERT, argument);
1536 // ideally, the update flag should be set by the insets,
1537 // but this is not possible currently
1538 updateFlags = Update::Force | Update::FitCursor;
1542 case LFUN_ALL_INSETS_TOGGLE: {
1543 BOOST_ASSERT(lyx_view_);
1545 string const name = split(argument, action, ' ');
1546 InsetBase::Code const inset_code =
1547 InsetBase::translate(name);
1549 LCursor & cur = view()->cursor();
1550 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1552 InsetBase & inset = lyx_view_->buffer()->inset();
1553 InsetIterator it = inset_iterator_begin(inset);
1554 InsetIterator const end = inset_iterator_end(inset);
1555 for (; it != end; ++it) {
1556 if (inset_code == InsetBase::NO_CODE
1557 || inset_code == it->lyxCode()) {
1558 LCursor tmpcur = cur;
1559 tmpcur.pushLeft(*it);
1560 it->dispatch(tmpcur, fr);
1563 updateFlags = Update::Force | Update::FitCursor;
1567 case LFUN_BUFFER_LANGUAGE: {
1568 BOOST_ASSERT(lyx_view_);
1569 Buffer & buffer = *lyx_view_->buffer();
1570 Language const * oldL = buffer.params().language;
1571 Language const * newL = languages.getLanguage(argument);
1572 if (!newL || oldL == newL)
1575 if (oldL->rightToLeft() == newL->rightToLeft()
1576 && !buffer.isMultiLingual())
1577 buffer.changeLanguage(oldL, newL);
1579 buffer.updateDocLang(newL);
1583 case LFUN_BUFFER_SAVE_AS_DEFAULT: {
1584 string const fname =
1585 addName(addPath(package().user_support(), "templates/"),
1587 Buffer defaults(fname);
1589 istringstream ss(argument);
1592 int const unknown_tokens = defaults.readHeader(lex);
1594 if (unknown_tokens != 0) {
1595 lyxerr << "Warning in LFUN_BUFFER_SAVE_AS_DEFAULT!\n"
1596 << unknown_tokens << " unknown token"
1597 << (unknown_tokens == 1 ? "" : "s")
1601 if (defaults.writeFile(FileName(defaults.fileName())))
1602 // FIXME Should use bformat
1603 setMessage(_("Document defaults saved in ")
1604 + makeDisplayPath(fname));
1606 setErrorMessage(_("Unable to save document defaults"));
1610 case LFUN_BUFFER_PARAMS_APPLY: {
1611 BOOST_ASSERT(lyx_view_);
1612 biblio::CiteEngine const engine =
1613 lyx_view_->buffer()->params().cite_engine;
1615 istringstream ss(argument);
1618 int const unknown_tokens =
1619 lyx_view_->buffer()->readHeader(lex);
1621 if (unknown_tokens != 0) {
1622 lyxerr << "Warning in LFUN_BUFFER_PARAMS_APPLY!\n"
1623 << unknown_tokens << " unknown token"
1624 << (unknown_tokens == 1 ? "" : "s")
1627 if (engine == lyx_view_->buffer()->params().cite_engine)
1630 LCursor & cur = view()->cursor();
1631 FuncRequest fr(LFUN_INSET_REFRESH);
1633 InsetBase & inset = lyx_view_->buffer()->inset();
1634 InsetIterator it = inset_iterator_begin(inset);
1635 InsetIterator const end = inset_iterator_end(inset);
1636 for (; it != end; ++it)
1637 if (it->lyxCode() == InsetBase::CITE_CODE)
1638 it->dispatch(cur, fr);
1642 case LFUN_TEXTCLASS_APPLY: {
1643 BOOST_ASSERT(lyx_view_);
1644 Buffer * buffer = lyx_view_->buffer();
1646 textclass_type const old_class =
1647 buffer->params().textclass;
1649 loadTextclass(argument);
1651 std::pair<bool, textclass_type> const tc_pair =
1652 textclasslist.numberOfClass(argument);
1657 textclass_type const new_class = tc_pair.second;
1658 if (old_class == new_class)
1662 lyx_view_->message(_("Converting document to new document class..."));
1663 recordUndoFullDocument(view());
1664 buffer->params().textclass = new_class;
1665 StableDocIterator backcur(view()->cursor());
1666 ErrorList & el = buffer->errorList("Class Switch");
1667 cap::switchBetweenClasses(
1668 old_class, new_class,
1669 static_cast<InsetText &>(buffer->inset()), el);
1671 view()->setCursor(backcur.asDocIterator(&(buffer->inset())));
1673 buffer->errors("Class Switch");
1674 updateLabels(*buffer);
1675 updateFlags = Update::Force | Update::FitCursor;
1679 case LFUN_TEXTCLASS_LOAD:
1680 loadTextclass(argument);
1683 case LFUN_LYXRC_APPLY: {
1684 LyXRC const lyxrc_orig = lyxrc;
1686 istringstream ss(argument);
1687 bool const success = lyxrc.read(ss) == 0;
1690 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1691 << "Unable to read lyxrc data"
1696 actOnUpdatedPrefs(lyxrc_orig, lyxrc);
1698 /// We force the redraw in any case because there might be
1699 /// some screen font changes.
1700 /// FIXME: only the current view will be updated. the Gui
1701 /// class is able to furnish the list of views.
1702 updateFlags = Update::Force;
1706 case LFUN_WINDOW_NEW:
1707 LyX::ref().newLyXView();
1710 case LFUN_WINDOW_CLOSE:
1711 BOOST_ASSERT(lyx_view_);
1712 BOOST_ASSERT(theApp());
1713 // update bookmark pit of the current buffer before window close
1714 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
1715 gotoBookmark(i+1, false, false);
1716 // ask the user for saving changes or cancel quit
1717 if (!theBufferList().quitWriteAll())
1722 case LFUN_BOOKMARK_GOTO:
1723 // go to bookmark, open unopened file and switch to buffer if necessary
1724 gotoBookmark(convert<unsigned int>(to_utf8(cmd.argument())), true, true);
1727 case LFUN_BOOKMARK_CLEAR:
1728 LyX::ref().session().bookmarks().clear();
1731 case LFUN_TOOLBAR_TOGGLE_STATE:
1732 lyx_view_->toggleToolbarState(argument);
1736 BOOST_ASSERT(lyx_view_);
1737 view()->cursor().dispatch(cmd);
1738 updateFlags = view()->cursor().result().update();
1739 if (!view()->cursor().result().dispatched())
1740 updateFlags = view()->dispatch(cmd);
1745 if (lyx_view_ && view()->buffer()) {
1746 // BufferView::update() updates the ViewMetricsInfo and
1747 // also initializes the position cache for all insets in
1748 // (at least partially) visible top-level paragraphs.
1749 // We will redraw the screen only if needed.
1750 if (view()->update(updateFlags)) {
1751 // Buffer::changed() signals that a repaint is needed.
1752 // The frontend (WorkArea) knows which area to repaint
1753 // thanks to the ViewMetricsInfo updated above.
1754 view()->buffer()->changed();
1757 lyx_view_->updateStatusBar();
1759 // if we executed a mutating lfun, mark the buffer as dirty
1761 && !lyxaction.funcHasFlag(action, LyXAction::NoBuffer)
1762 && !lyxaction.funcHasFlag(action, LyXAction::ReadOnly))
1763 view()->buffer()->markDirty();
1765 if (view()->cursor().inTexted()) {
1766 lyx_view_->updateLayoutChoice();
1771 lyx_view_->updateMenubar();
1772 lyx_view_->updateToolbars();
1773 sendDispatchMessage(getMessage(), cmd);
1778 void LyXFunc::sendDispatchMessage(docstring const & msg, FuncRequest const & cmd)
1780 const bool verbose = (cmd.origin == FuncRequest::MENU
1781 || cmd.origin == FuncRequest::TOOLBAR
1782 || cmd.origin == FuncRequest::COMMANDBUFFER);
1784 if (cmd.action == LFUN_SELF_INSERT || !verbose) {
1785 lyxerr[Debug::ACTION] << "dispatch msg is " << to_utf8(msg) << endl;
1787 lyx_view_->message(msg);
1791 docstring dispatch_msg = msg;
1792 if (!dispatch_msg.empty())
1793 dispatch_msg += ' ';
1795 docstring comname = from_utf8(lyxaction.getActionName(cmd.action));
1797 bool argsadded = false;
1799 if (!cmd.argument().empty()) {
1800 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1801 comname += ' ' + cmd.argument();
1806 docstring const shortcuts = theTopLevelKeymap().printbindings(cmd);
1808 if (!shortcuts.empty())
1809 comname += ": " + shortcuts;
1810 else if (!argsadded && !cmd.argument().empty())
1811 comname += ' ' + cmd.argument();
1813 if (!comname.empty()) {
1814 comname = rtrim(comname);
1815 dispatch_msg += '(' + rtrim(comname) + ')';
1818 lyxerr[Debug::ACTION] << "verbose dispatch msg "
1819 << to_utf8(dispatch_msg) << endl;
1820 if (!dispatch_msg.empty())
1821 lyx_view_->message(dispatch_msg);
1825 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1827 // FIXME: initpath is not used. What to do?
1828 string initpath = lyxrc.document_path;
1829 string filename(name);
1831 if (view()->buffer()) {
1832 string const trypath = lyx_view_->buffer()->filePath();
1833 // If directory is writeable, use this as default.
1834 if (isDirWriteable(FileName(trypath)))
1838 static int newfile_number;
1840 if (filename.empty()) {
1841 filename = addName(lyxrc.document_path,
1842 "newfile" + convert<string>(++newfile_number) + ".lyx");
1843 while (theBufferList().exists(filename) ||
1844 fs::is_readable(FileName(filename).toFilesystemEncoding())) {
1846 filename = addName(lyxrc.document_path,
1847 "newfile" + convert<string>(newfile_number) +
1852 // The template stuff
1855 FileDialog fileDlg(_("Select template file"),
1856 LFUN_SELECT_FILE_SYNC,
1857 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1858 make_pair(_("Templates|#T#t"), from_utf8(lyxrc.template_path)));
1860 FileDialog::Result result =
1861 fileDlg.open(from_utf8(lyxrc.template_path),
1862 FileFilterList(_("LyX Documents (*.lyx)")),
1865 if (result.first == FileDialog::Later)
1867 if (result.second.empty())
1869 templname = to_utf8(result.second);
1872 Buffer * const b = newFile(filename, templname, !name.empty());
1874 lyx_view_->setBuffer(b);
1878 void LyXFunc::open(string const & fname)
1880 string initpath = lyxrc.document_path;
1882 if (view()->buffer()) {
1883 string const trypath = lyx_view_->buffer()->filePath();
1884 // If directory is writeable, use this as default.
1885 if (isDirWriteable(FileName(trypath)))
1891 if (fname.empty()) {
1892 FileDialog fileDlg(_("Select document to open"),
1894 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1895 make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
1897 FileDialog::Result result =
1898 fileDlg.open(from_utf8(initpath),
1899 FileFilterList(_("LyX Documents (*.lyx)")),
1902 if (result.first == FileDialog::Later)
1905 filename = to_utf8(result.second);
1907 // check selected filename
1908 if (filename.empty()) {
1909 lyx_view_->message(_("Canceled."));
1915 // get absolute path of file and add ".lyx" to the filename if
1917 FileName const fullname = fileSearch(string(), filename, "lyx");
1918 if (!fullname.empty())
1919 filename = fullname.absFilename();
1921 // if the file doesn't exist, let the user create one
1922 if (!fs::exists(fullname.toFilesystemEncoding())) {
1923 // the user specifically chose this name. Believe him.
1924 Buffer * const b = newFile(filename, string(), true);
1926 lyx_view_->setBuffer(b);
1930 docstring const disp_fn = makeDisplayPath(filename);
1931 lyx_view_->message(bformat(_("Opening document %1$s..."), disp_fn));
1934 if (lyx_view_->loadLyXFile(fullname)) {
1935 str2 = bformat(_("Document %1$s opened."), disp_fn);
1937 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1939 lyx_view_->message(str2);
1943 void LyXFunc::doImport(string const & argument)
1946 string filename = split(argument, format, ' ');
1948 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1949 << " file: " << filename << endl;
1951 // need user interaction
1952 if (filename.empty()) {
1953 string initpath = lyxrc.document_path;
1955 if (view()->buffer()) {
1956 string const trypath = lyx_view_->buffer()->filePath();
1957 // If directory is writeable, use this as default.
1958 if (isDirWriteable(FileName(trypath)))
1962 docstring const text = bformat(_("Select %1$s file to import"),
1963 formats.prettyName(format));
1965 FileDialog fileDlg(text,
1967 make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
1968 make_pair(_("Examples|#E#e"),
1969 from_utf8(addPath(package().system_support(), "examples"))));
1971 docstring filter = formats.prettyName(format);
1974 filter += from_utf8(formats.extension(format));
1977 FileDialog::Result result =
1978 fileDlg.open(from_utf8(initpath),
1979 FileFilterList(filter),
1982 if (result.first == FileDialog::Later)
1985 filename = to_utf8(result.second);
1987 // check selected filename
1988 if (filename.empty())
1989 lyx_view_->message(_("Canceled."));
1992 if (filename.empty())
1995 // get absolute path of file
1996 FileName const fullname(makeAbsPath(filename));
1998 FileName const lyxfile(changeExtension(fullname.absFilename(), ".lyx"));
2000 // Check if the document already is open
2001 if (use_gui && theBufferList().exists(lyxfile.absFilename())) {
2002 if (!theBufferList().close(theBufferList().getBuffer(lyxfile.absFilename()), true)) {
2003 lyx_view_->message(_("Canceled."));
2008 // if the file exists already, and we didn't do
2009 // -i lyx thefile.lyx, warn
2010 if (fs::exists(lyxfile.toFilesystemEncoding()) && fullname != lyxfile) {
2011 docstring const file = makeDisplayPath(lyxfile.absFilename(), 30);
2013 docstring text = bformat(_("The document %1$s already exists.\n\n"
2014 "Do you want to over-write that document?"), file);
2015 int const ret = Alert::prompt(_("Over-write document?"),
2016 text, 0, 1, _("&Over-write"), _("&Cancel"));
2019 lyx_view_->message(_("Canceled."));
2024 ErrorList errorList;
2025 Importer::Import(lyx_view_, fullname, format, errorList);
2026 // FIXME (Abdel 12/08/06): Is there a need to display the error list here?
2030 void LyXFunc::closeBuffer()
2032 // save current cursor position
2033 LyX::ref().session().lastFilePos().save(FileName(lyx_view_->buffer()->fileName()),
2034 boost::tie(view()->cursor().pit(), view()->cursor().pos()) );
2035 // goto bookmark to update bookmark pit.
2036 for (size_t i = 0; i < LyX::ref().session().bookmarks().size(); ++i)
2037 gotoBookmark(i+1, false, false);
2038 if (theBufferList().close(lyx_view_->buffer(), true) && !quitting) {
2039 if (theBufferList().empty()) {
2040 // need this otherwise SEGV may occur while
2041 // trying to set variables that don't exist
2042 // since there's no current buffer
2043 lyx_view_->getDialogs().hideBufferDependent();
2045 lyx_view_->setBuffer(theBufferList().first());
2051 void LyXFunc::reloadBuffer()
2053 FileName filename(lyx_view_->buffer()->fileName());
2055 lyx_view_->loadLyXFile(filename);
2058 // Each "lyx_view_" should have it's own message method. lyxview and
2059 // the minibuffer would use the minibuffer, but lyxserver would
2060 // send an ERROR signal to its client. Alejandro 970603
2061 // This function is bit problematic when it comes to NLS, to make the
2062 // lyx servers client be language indepenent we must not translate
2063 // strings sent to this func.
2064 void LyXFunc::setErrorMessage(docstring const & m) const
2066 dispatch_buffer = m;
2071 void LyXFunc::setMessage(docstring const & m) const
2073 dispatch_buffer = m;
2077 docstring const LyXFunc::viewStatusMessage()
2079 // When meta-fake key is pressed, show the key sequence so far + "M-".
2081 return keyseq->print(true) + "M-";
2083 // Else, when a non-complete key sequence is pressed,
2084 // show the available options.
2085 if (keyseq->length() > 0 && !keyseq->deleted())
2086 return keyseq->printOptions(true);
2088 if (!view()->buffer())
2089 return _("Welcome to LyX!");
2091 return view()->cursor().currentState();
2095 BufferView * LyXFunc::view() const
2097 BOOST_ASSERT(lyx_view_);
2098 return lyx_view_->view();
2102 bool LyXFunc::wasMetaKey() const
2104 return (meta_fake_bit != key_modifier::none);
2110 void actOnUpdatedPrefs(LyXRC const & lyxrc_orig, LyXRC const & lyxrc_new)
2112 // Why the switch you might ask. It is a trick to ensure that all
2113 // the elements in the LyXRCTags enum is handled. As you can see
2114 // there are no breaks at all. So it is just a huge fall-through.
2115 // The nice thing is that we will get a warning from the compiler
2116 // if we forget an element.
2117 LyXRC::LyXRCTags tag = LyXRC::RC_LAST;
2119 case LyXRC::RC_ACCEPT_COMPOUND:
2120 case LyXRC::RC_ALT_LANG:
2121 case LyXRC::RC_PLAINTEXT_ROFF_COMMAND:
2122 case LyXRC::RC_PLAINTEXT_LINELEN:
2123 case LyXRC::RC_AUTOREGIONDELETE:
2124 case LyXRC::RC_AUTORESET_OPTIONS:
2125 case LyXRC::RC_AUTOSAVE:
2126 case LyXRC::RC_AUTO_NUMBER:
2127 case LyXRC::RC_BACKUPDIR_PATH:
2128 case LyXRC::RC_BIBTEX_COMMAND:
2129 case LyXRC::RC_BINDFILE:
2130 case LyXRC::RC_CHECKLASTFILES:
2131 case LyXRC::RC_USELASTFILEPOS:
2132 case LyXRC::RC_LOADSESSION:
2133 case LyXRC::RC_CHKTEX_COMMAND:
2134 case LyXRC::RC_CONVERTER:
2135 case LyXRC::RC_CONVERTER_CACHE_MAXAGE:
2136 case LyXRC::RC_COPIER:
2137 case LyXRC::RC_CURSOR_FOLLOWS_SCROLLBAR:
2138 case LyXRC::RC_CUSTOM_EXPORT_COMMAND:
2139 case LyXRC::RC_CUSTOM_EXPORT_FORMAT:
2140 case LyXRC::RC_DATE_INSERT_FORMAT:
2141 case LyXRC::RC_DEFAULT_LANGUAGE:
2142 case LyXRC::RC_DEFAULT_PAPERSIZE:
2143 case LyXRC::RC_DIALOGS_ICONIFY_WITH_MAIN:
2144 case LyXRC::RC_DISPLAY_GRAPHICS:
2145 case LyXRC::RC_DOCUMENTPATH:
2146 if (lyxrc_orig.document_path != lyxrc_new.document_path) {
2147 string const encoded = FileName(
2148 lyxrc_new.document_path).toFilesystemEncoding();
2149 if (fs::exists(encoded) && fs::is_directory(encoded))
2150 support::package().document_dir() = lyxrc.document_path;
2152 case LyXRC::RC_ESC_CHARS:
2153 case LyXRC::RC_FONT_ENCODING:
2154 case LyXRC::RC_FORMAT:
2155 case LyXRC::RC_INDEX_COMMAND:
2156 case LyXRC::RC_INPUT:
2157 case LyXRC::RC_KBMAP:
2158 case LyXRC::RC_KBMAP_PRIMARY:
2159 case LyXRC::RC_KBMAP_SECONDARY:
2160 case LyXRC::RC_LABEL_INIT_LENGTH:
2161 case LyXRC::RC_LANGUAGE_AUTO_BEGIN:
2162 case LyXRC::RC_LANGUAGE_AUTO_END:
2163 case LyXRC::RC_LANGUAGE_COMMAND_BEGIN:
2164 case LyXRC::RC_LANGUAGE_COMMAND_END:
2165 case LyXRC::RC_LANGUAGE_COMMAND_LOCAL:
2166 case LyXRC::RC_LANGUAGE_GLOBAL_OPTIONS:
2167 case LyXRC::RC_LANGUAGE_PACKAGE:
2168 case LyXRC::RC_LANGUAGE_USE_BABEL:
2169 case LyXRC::RC_MAKE_BACKUP:
2170 case LyXRC::RC_MARK_FOREIGN_LANGUAGE:
2171 case LyXRC::RC_NUMLASTFILES:
2172 case LyXRC::RC_PATH_PREFIX:
2173 if (lyxrc_orig.path_prefix != lyxrc_new.path_prefix) {
2174 support::prependEnvPath("PATH", lyxrc.path_prefix);
2176 case LyXRC::RC_PERS_DICT:
2177 case LyXRC::RC_POPUP_BOLD_FONT:
2178 case LyXRC::RC_POPUP_FONT_ENCODING:
2179 case LyXRC::RC_POPUP_NORMAL_FONT:
2180 case LyXRC::RC_PREVIEW:
2181 case LyXRC::RC_PREVIEW_HASHED_LABELS:
2182 case LyXRC::RC_PREVIEW_SCALE_FACTOR:
2183 case LyXRC::RC_PRINTCOLLCOPIESFLAG:
2184 case LyXRC::RC_PRINTCOPIESFLAG:
2185 case LyXRC::RC_PRINTER:
2186 case LyXRC::RC_PRINTEVENPAGEFLAG:
2187 case LyXRC::RC_PRINTEXSTRAOPTIONS:
2188 case LyXRC::RC_PRINTFILEEXTENSION:
2189 case LyXRC::RC_PRINTLANDSCAPEFLAG:
2190 case LyXRC::RC_PRINTODDPAGEFLAG:
2191 case LyXRC::RC_PRINTPAGERANGEFLAG:
2192 case LyXRC::RC_PRINTPAPERDIMENSIONFLAG:
2193 case LyXRC::RC_PRINTPAPERFLAG:
2194 case LyXRC::RC_PRINTREVERSEFLAG:
2195 case LyXRC::RC_PRINTSPOOL_COMMAND:
2196 case LyXRC::RC_PRINTSPOOL_PRINTERPREFIX:
2197 case LyXRC::RC_PRINTTOFILE:
2198 case LyXRC::RC_PRINTTOPRINTER:
2199 case LyXRC::RC_PRINT_ADAPTOUTPUT:
2200 case LyXRC::RC_PRINT_COMMAND:
2201 case LyXRC::RC_RTL_SUPPORT:
2202 case LyXRC::RC_SCREEN_DPI:
2203 case LyXRC::RC_SCREEN_FONT_ENCODING:
2204 case LyXRC::RC_SCREEN_FONT_ROMAN:
2205 case LyXRC::RC_SCREEN_FONT_ROMAN_FOUNDRY:
2206 case LyXRC::RC_SCREEN_FONT_SANS:
2207 case LyXRC::RC_SCREEN_FONT_SANS_FOUNDRY:
2208 case LyXRC::RC_SCREEN_FONT_SCALABLE:
2209 case LyXRC::RC_SCREEN_FONT_SIZES:
2210 case LyXRC::RC_SCREEN_FONT_TYPEWRITER:
2211 case LyXRC::RC_SCREEN_FONT_TYPEWRITER_FOUNDRY:
2212 case LyXRC::RC_SCREEN_GEOMETRY_HEIGHT:
2213 case LyXRC::RC_SCREEN_GEOMETRY_WIDTH:
2214 case LyXRC::RC_SCREEN_GEOMETRY_XYSAVED:
2215 case LyXRC::RC_SCREEN_ZOOM:
2216 case LyXRC::RC_SERVERPIPE:
2217 case LyXRC::RC_SET_COLOR:
2218 case LyXRC::RC_SHOW_BANNER:
2219 case LyXRC::RC_SPELL_COMMAND:
2220 case LyXRC::RC_TEMPDIRPATH:
2221 case LyXRC::RC_TEMPLATEPATH:
2222 case LyXRC::RC_TEX_ALLOWS_SPACES:
2223 case LyXRC::RC_TEX_EXPECTS_WINDOWS_PATHS:
2224 if (lyxrc_orig.windows_style_tex_paths != lyxrc_new.windows_style_tex_paths) {
2225 support::os::windows_style_tex_paths(lyxrc_new.windows_style_tex_paths);
2227 case LyXRC::RC_UIFILE:
2228 case LyXRC::RC_USER_EMAIL:
2229 case LyXRC::RC_USER_NAME:
2230 case LyXRC::RC_USETEMPDIR:
2231 case LyXRC::RC_USE_ALT_LANG:
2232 case LyXRC::RC_USE_CONVERTER_CACHE:
2233 case LyXRC::RC_USE_ESC_CHARS:
2234 case LyXRC::RC_USE_INP_ENC:
2235 case LyXRC::RC_USE_PERS_DICT:
2236 case LyXRC::RC_USE_SPELL_LIB:
2237 case LyXRC::RC_VIEWDVI_PAPEROPTION:
2238 case LyXRC::RC_VIEWER:
2239 case LyXRC::RC_LAST: