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"
41 #include "insetiterator.h"
47 #include "LyXAction.h"
52 #include "lyxserver.h"
53 #include "lyxtextclasslist.h"
55 #include "paragraph.h"
56 #include "pariterator.h"
57 #include "ParagraphParameters.h"
60 #include "insets/insetbox.h"
61 #include "insets/insetbranch.h"
62 #include "insets/insetcommand.h"
63 #include "insets/insetert.h"
64 #include "insets/insetexternal.h"
65 #include "insets/insetfloat.h"
66 #include "insets/insetgraphics.h"
67 #include "insets/insetnote.h"
68 #include "insets/insettabular.h"
69 #include "insets/insetvspace.h"
70 #include "insets/insetwrap.h"
72 #include "frontends/Alert.h"
73 #include "frontends/Dialogs.h"
74 #include "frontends/FileDialog.h"
75 #include "frontends/lyx_gui.h"
76 #include "frontends/LyXKeySym.h"
77 #include "frontends/LyXView.h"
78 #include "frontends/Menubar.h"
79 #include "frontends/Toolbars.h"
81 #include "support/FileInfo.h"
82 #include "support/filetools.h"
83 #include "support/forkedcontr.h"
84 #include "support/globbing.h"
85 #include "support/lstrings.h"
86 #include "support/path.h"
87 #include "support/path_defines.h"
88 #include "support/systemcall.h"
89 #include "support/tostr.h"
90 #include "support/std_sstream.h"
91 #include "support/os.h"
93 using bv_funcs::freefont2string;
95 using lyx::support::AddName;
96 using lyx::support::AddPath;
97 using lyx::support::bformat;
98 using lyx::support::ChangeExtension;
99 using lyx::support::contains;
100 using lyx::support::FileFilterList;
101 using lyx::support::FileInfo;
102 using lyx::support::FileSearch;
103 using lyx::support::ForkedcallsController;
104 using lyx::support::i18nLibFileSearch;
105 using lyx::support::IsDirWriteable;
106 using lyx::support::IsFileReadable;
107 using lyx::support::isStrInt;
108 using lyx::support::MakeAbsPath;
109 using lyx::support::MakeDisplayPath;
110 using lyx::support::Path;
111 using lyx::support::QuoteName;
112 using lyx::support::rtrim;
113 using lyx::support::split;
114 using lyx::support::strToInt;
115 using lyx::support::strToUnsignedInt;
116 using lyx::support::subst;
117 using lyx::support::system_lyxdir;
118 using lyx::support::Systemcall;
119 using lyx::support::token;
120 using lyx::support::trim;
121 using lyx::support::user_lyxdir;
122 using lyx::support::prefixIs;
123 using lyx::support::os::getTmpDir;
126 using std::make_pair;
129 using std::istringstream;
131 namespace biblio = lyx::biblio;
134 extern BufferList bufferlist;
135 extern LyXServer * lyxserver;
136 extern bool selection_possible;
138 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
141 extern tex_accent_struct get_accent(kb_action action);
144 LyXFunc::LyXFunc(LyXView * lv)
147 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
148 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
149 meta_fake_bit(key_modifier::none)
154 void LyXFunc::handleKeyFunc(kb_action action)
156 char c = encoded_last_key;
158 if (keyseq.length()) {
162 owner->getIntl().getTransManager()
163 .deadkey(c, get_accent(action).accent, view()->getLyXText());
164 // Need to clear, in case the minibuffer calls these
167 // copied verbatim from do_accent_char
168 view()->cursor().resetAnchor();
173 void LyXFunc::processKeySym(LyXKeySymPtr keysym, key_modifier::state state)
175 lyxerr[Debug::KEY] << "KeySym is " << keysym->getSymbolName() << endl;
177 // Do nothing if we have nothing (JMarc)
178 if (!keysym->isOK()) {
179 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
184 if (keysym->isModifier()) {
185 lyxerr[Debug::KEY] << "isModifier true" << endl;
189 Encoding const * encoding = view()->cursor().getEncoding();
191 encoded_last_key = keysym->getISOEncoded(encoding ? encoding->Name() : "");
193 // Do a one-deep top-level lookup for
194 // cancel and meta-fake keys. RVDK_PATCH_5
195 cancel_meta_seq.reset();
197 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
198 lyxerr[Debug::KEY] << "action first set to [" << func.action << ']' << endl;
200 // When not cancel or meta-fake, do the normal lookup.
201 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
202 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
203 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_FAKE)) {
204 // remove Caps Lock and Mod2 as a modifiers
205 func = keyseq.addkey(keysym, (state | meta_fake_bit));
206 lyxerr[Debug::KEY] << "action now set to ["
207 << func.action << ']' << endl;
210 // Dont remove this unless you know what you are doing.
211 meta_fake_bit = key_modifier::none;
213 // can this happen now ?
214 if (func.action == LFUN_NOACTION) {
215 func = FuncRequest(LFUN_PREFIX);
218 if (lyxerr.debugging(Debug::KEY)) {
219 lyxerr << "Key [action="
220 << func.action << "]["
221 << keyseq.print() << ']'
225 // already here we know if it any point in going further
226 // why not return already here if action == -1 and
227 // num_bytes == 0? (Lgb)
229 if (keyseq.length() > 1) {
230 owner->message(keyseq.print());
234 // Maybe user can only reach the key via holding down shift.
235 // Let's see. But only if shift is the only modifier
236 if (func.action == LFUN_UNKNOWN_ACTION &&
237 state == key_modifier::shift) {
238 lyxerr[Debug::KEY] << "Trying without shift" << endl;
239 func = keyseq.addkey(keysym, key_modifier::none);
240 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
243 if (func.action == LFUN_UNKNOWN_ACTION) {
244 // Hmm, we didn't match any of the keysequences. See
245 // if it's normal insertable text not already covered
247 if (keysym->isText() && keyseq.length() == 1) {
248 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
249 func = FuncRequest(LFUN_SELFINSERT);
251 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
252 owner->message(_("Unknown function."));
257 if (func.action == LFUN_SELFINSERT) {
258 if (encoded_last_key != 0) {
259 string arg(1, encoded_last_key);
260 dispatch(FuncRequest(LFUN_SELFINSERT, arg));
262 << "SelfInsert arg[`" << arg << "']" << endl;
270 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
272 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
274 Buffer * buf = owner->buffer();
275 LCursor & cur = view()->cursor();
277 if (cmd.action == LFUN_NOACTION) {
278 setStatusMessage(N_("Nothing to do"));
283 switch (cmd.action) {
284 case LFUN_UNKNOWN_ACTION:
285 #ifndef HAVE_LIBAIKSAURUS
286 case LFUN_THESAURUS_ENTRY:
292 flag |= lyx_gui::getStatus(cmd);
295 if (flag.unknown()) {
296 setStatusMessage(N_("Unknown action"));
300 // the default error message if we disable the command
301 setStatusMessage(N_("Command disabled"));
303 // Check whether we need a buffer
304 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
306 setStatusMessage(N_("Command not allowed with"
307 "out any document open"));
312 // I would really like to avoid having this switch and rather try to
313 // encode this in the function itself.
314 // -- And I'd rather let an inset decide which LFUNs it is willing
315 // to handle (Andre')
317 switch (cmd.action) {
318 case LFUN_TOOLTIPS_TOGGLE:
319 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
322 case LFUN_READ_ONLY_TOGGLE:
323 flag.setOnOff(buf->isReadonly());
326 case LFUN_SWITCHBUFFER:
327 // toggle on the current buffer, but do not toggle off
328 // the other ones (is that a good idea?)
329 if (cmd.argument == buf->fileName())
334 enable = cmd.argument == "custom"
335 || Exporter::IsExportable(*buf, cmd.argument);
339 enable = cur.selection();
343 enable = buf->isLatex() && lyxrc.chktex_command != "none";
347 enable = Exporter::IsExportable(*buf, "program");
350 case LFUN_LAYOUT_TABULAR:
351 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
355 case LFUN_LAYOUT_PARAGRAPH:
356 enable = !cur.inset().forceDefaultParagraphs(&cur.inset());
359 case LFUN_VC_REGISTER:
360 enable = !buf->lyxvc().inUse();
362 case LFUN_VC_CHECKIN:
363 enable = buf->lyxvc().inUse() && !buf->isReadonly();
365 case LFUN_VC_CHECKOUT:
366 enable = buf->lyxvc().inUse() && buf->isReadonly();
370 enable = buf->lyxvc().inUse();
372 case LFUN_MENURELOAD:
373 enable = !buf->isUnnamed() && !buf->isClean();
377 case LFUN_INSET_SETTINGS: {
381 UpdatableInset * inset = cur.inset().asUpdatableInset();
382 lyxerr << "inset: " << inset << endl;
386 InsetOld::Code code = inset->lyxCode();
388 case InsetOld::TABULAR_CODE:
389 enable = cmd.argument == "tabular";
391 case InsetOld::ERT_CODE:
392 enable = cmd.argument == "ert";
394 case InsetOld::FLOAT_CODE:
395 enable = cmd.argument == "float";
397 case InsetOld::WRAP_CODE:
398 enable = cmd.argument == "wrap";
400 case InsetOld::NOTE_CODE:
401 enable = cmd.argument == "note";
403 case InsetOld::BRANCH_CODE:
404 enable = cmd.argument == "branch";
406 case InsetOld::BOX_CODE:
407 enable = cmd.argument == "box";
415 case LFUN_DIALOG_SHOW: {
416 string const name = cmd.getArg(0);
418 enable = name == "aboutlyx"
422 || name == "texinfo";
423 else if (name == "print")
424 enable = Exporter::IsExportable(*buf, "dvi")
425 && lyxrc.print_command != "none";
426 else if (name == "character")
427 enable = cur.inset().lyxCode() != InsetOld::ERT_CODE;
428 else if (name == "vclog")
429 enable = buf->lyxvc().inUse();
430 else if (name == "latexlog")
431 enable = IsFileReadable(buf->getLogName().second);
435 case LFUN_DIALOG_UPDATE: {
436 string const name = cmd.getArg(0);
438 enable = name == "prefs";
442 // this one is difficult to get right. As a half-baked
443 // solution, we consider only the first action of the sequence
444 case LFUN_SEQUENCE: {
445 // argument contains ';'-terminated commands
446 string const firstcmd = token(cmd.argument, ';', 0);
447 flag = getStatus(lyxaction.lookupFunc(firstcmd));
451 case LFUN_MENUNEWTMPLT:
452 case LFUN_WORDFINDFORWARD:
453 case LFUN_WORDFINDBACKWARD:
455 case LFUN_EXEC_COMMAND:
458 case LFUN_CLOSEBUFFER:
467 case LFUN_RECONFIGURE:
471 case LFUN_DROP_LAYOUTS_CHOICE:
472 case LFUN_MENU_OPEN_BY_NAME:
475 case LFUN_GOTOFILEROW:
476 case LFUN_GOTO_PARAGRAPH:
477 case LFUN_DIALOG_SHOW_NEW_INSET:
478 case LFUN_DIALOG_SHOW_NEXT_INSET:
479 case LFUN_DIALOG_HIDE:
480 case LFUN_DIALOG_DISCONNECT_INSET:
482 case LFUN_TOGGLECURSORFOLLOW:
486 case LFUN_KMAP_TOGGLE:
488 case LFUN_EXPORT_CUSTOM:
490 case LFUN_SAVEPREFERENCES:
491 case LFUN_SCREEN_FONT_UPDATE:
494 case LFUN_EXTERNAL_EDIT:
495 case LFUN_GRAPHICS_EDIT:
496 case LFUN_ALL_INSETS_TOGGLE:
497 case LFUN_LANGUAGE_BUFFER:
498 case LFUN_TEXTCLASS_APPLY:
499 case LFUN_TEXTCLASS_LOAD:
500 case LFUN_SAVE_AS_DEFAULT:
501 case LFUN_BUFFERPARAMS_APPLY:
502 case LFUN_LYXRC_APPLY:
503 // these are handled in our dispatch()
508 cur.getStatus(cmd, flag);
510 flag = view()->getStatus(cmd);
516 // Can we use a readonly buffer?
517 if (buf && buf->isReadonly()
518 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
519 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
520 setStatusMessage(N_("Document is read-only"));
524 //lyxerr << "LyXFunc::getStatus: got: " << flag.enabled() << endl;
531 bool ensureBufferClean(BufferView * bv)
533 Buffer & buf = *bv->buffer();
537 string const file = MakeDisplayPath(buf.fileName(), 30);
538 string text = bformat(_("The document %1$s has unsaved "
539 "changes.\n\nDo you want to save "
540 "the document?"), file);
541 int const ret = Alert::prompt(_("Save changed document?"),
542 text, 0, 1, _("&Save"),
546 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
548 return buf.isClean();
552 void showPrintError(string const & name)
554 string str = bformat(_("Could not print the document %1$s.\n"
555 "Check that your printer is set up correctly."),
556 MakeDisplayPath(name, 50));
557 Alert::error(_("Print document failed"), str);
561 void loadTextclass(string const & name)
563 std::pair<bool, lyx::textclass_type> const tc_pair =
564 textclasslist.NumberOfClass(name);
566 if (!tc_pair.first) {
567 lyxerr << "Document class \"" << name
568 << "\" does not exist."
573 lyx::textclass_type const tc = tc_pair.second;
575 if (!textclasslist[tc].load()) {
576 string s = bformat(_("The document could not be converted\n"
577 "into the document class %1$s."),
578 textclasslist[tc].name());
579 Alert::error(_("Could not change class"), s);
586 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
588 string const argument = cmd.argument;
589 kb_action const action = cmd.action;
591 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
592 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
594 // we have not done anything wrong yet.
596 dispatch_buffer.erase();
597 selection_possible = false;
601 // We cannot use this function here
602 if (!getStatus(cmd).enabled()) {
603 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
604 << lyxaction.getActionName(action)
605 << " [" << action << "] is disabled at this location"
607 setErrorMessage(getStatusMessage());
611 if (view()->available())
612 view()->hideCursor();
616 case LFUN_WORDFINDFORWARD:
617 case LFUN_WORDFINDBACKWARD: {
618 static string last_search;
619 string searched_string;
621 if (!argument.empty()) {
622 last_search = argument;
623 searched_string = argument;
625 searched_string = last_search;
628 if (searched_string.empty())
631 bool const fw = action == LFUN_WORDFINDFORWARD;
633 lyx::find::find2string(searched_string, true, false, fw);
634 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
639 owner->message(keyseq.printOptions());
642 case LFUN_EXEC_COMMAND:
643 owner->getToolbars().display("minibuffer", true);
644 owner->focus_command_buffer();
649 meta_fake_bit = key_modifier::none;
650 if (view()->available())
651 // cancel any selection
652 dispatch(FuncRequest(LFUN_MARK_OFF));
653 setMessage(N_("Cancel"));
657 meta_fake_bit = key_modifier::alt;
658 setMessage(keyseq.print());
661 case LFUN_READ_ONLY_TOGGLE:
662 if (owner->buffer()->lyxvc().inUse())
663 owner->buffer()->lyxvc().toggleReadOnly();
665 owner->buffer()->setReadonly(
666 !owner->buffer()->isReadonly());
669 // --- Menus -----------------------------------------------
671 menuNew(argument, false);
674 case LFUN_MENUNEWTMPLT:
675 menuNew(argument, true);
678 case LFUN_CLOSEBUFFER:
683 if (!owner->buffer()->isUnnamed()) {
684 string const str = bformat(_("Saving document %1$s..."),
685 MakeDisplayPath(owner->buffer()->fileName()));
687 MenuWrite(owner->buffer());
688 owner->message(str + _(" done."));
690 WriteAs(owner->buffer());
694 WriteAs(owner->buffer(), argument);
697 case LFUN_MENURELOAD: {
698 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
699 string text = bformat(_("Any changes will be lost. Are you sure "
700 "you want to revert to the saved version of the document %1$s?"), file);
701 int const ret = Alert::prompt(_("Revert to saved document?"),
702 text, 0, 1, _("&Revert"), _("&Cancel"));
710 Exporter::Export(owner->buffer(), argument, true);
711 view()->showErrorList(BufferFormat(*owner->buffer()));
715 Exporter::Preview(owner->buffer(), argument);
716 view()->showErrorList(BufferFormat(*owner->buffer()));
720 Exporter::Export(owner->buffer(), "program", true);
721 view()->showErrorList(_("Build"));
725 owner->buffer()->runChktex();
726 view()->showErrorList(_("ChkTeX"));
730 if (argument == "custom")
731 owner->getDialogs().show("sendto");
733 Exporter::Export(owner->buffer(), argument, false);
734 view()->showErrorList(BufferFormat(*owner->buffer()));
738 case LFUN_EXPORT_CUSTOM: {
740 string command = split(argument, format_name, ' ');
741 Format const * format = formats.getFormat(format_name);
743 lyxerr << "Format \"" << format_name
744 << "\" not recognized!"
749 Buffer * buffer = owner->buffer();
751 // The name of the file created by the conversion process
754 // Output to filename
755 if (format->name() == "lyx") {
756 string const latexname =
757 buffer->getLatexName(false);
758 filename = ChangeExtension(latexname,
759 format->extension());
760 filename = AddName(buffer->temppath(), filename);
762 if (!buffer->writeFile(filename))
766 Exporter::Export(buffer, format_name, true,
770 // Substitute $$FName for filename
771 if (!contains(command, "$$FName"))
772 command = "( " + command + " ) < $$FName";
773 command = subst(command, "$$FName", filename);
775 // Execute the command in the background
777 call.startscript(Systemcall::DontWait, command);
784 string command = split(split(argument, target, ' '),
788 || target_name.empty()
789 || command.empty()) {
790 lyxerr << "Unable to parse \""
791 << argument << '"' << std::endl;
794 if (target != "printer" && target != "file") {
795 lyxerr << "Unrecognized target \""
796 << target << '"' << std::endl;
800 Buffer * buffer = owner->buffer();
802 if (!Exporter::Export(buffer, "dvi", true)) {
803 showPrintError(buffer->fileName());
807 // Push directory path.
808 string const path = buffer->temppath();
811 // there are three cases here:
812 // 1. we print to a file
813 // 2. we print directly to a printer
814 // 3. we print using a spool command (print to file first)
817 string const dviname =
818 ChangeExtension(buffer->getLatexName(true),
821 if (target == "printer") {
822 if (!lyxrc.print_spool_command.empty()) {
823 // case 3: print using a spool
824 string const psname =
825 ChangeExtension(dviname,".ps");
826 command += lyxrc.print_to_file
829 + QuoteName(dviname);
832 lyxrc.print_spool_command +' ';
833 if (target_name != "default") {
834 command2 += lyxrc.print_spool_printerprefix
838 command2 += QuoteName(psname);
840 // If successful, then spool command
841 res = one.startscript(
846 res = one.startscript(
847 Systemcall::DontWait,
850 // case 2: print directly to a printer
851 res = one.startscript(
852 Systemcall::DontWait,
853 command + QuoteName(dviname));
857 // case 1: print to a file
858 command += lyxrc.print_to_file
859 + QuoteName(MakeAbsPath(target_name,
862 + QuoteName(dviname);
863 res = one.startscript(Systemcall::DontWait,
868 showPrintError(buffer->fileName());
881 InsetCommandParams p("tableofcontents");
882 string const data = InsetCommandMailer::params2string("toc", p);
883 owner->getDialogs().show("toc", data, 0);
891 case LFUN_RECONFIGURE:
895 case LFUN_HELP_OPEN: {
896 string const arg = argument;
898 setErrorMessage(N_("Missing argument"));
901 string const fname = i18nLibFileSearch("doc", arg, "lyx");
903 lyxerr << "LyX: unable to find documentation file `"
904 << arg << "'. Bad installation?" << endl;
907 owner->message(bformat(_("Opening help file %1$s..."),
908 MakeDisplayPath(fname)));
909 view()->loadLyXFile(fname, false);
913 // --- version control -------------------------------
914 case LFUN_VC_REGISTER:
915 if (!ensureBufferClean(view()))
917 if (!owner->buffer()->lyxvc().inUse()) {
918 owner->buffer()->lyxvc().registrer();
923 case LFUN_VC_CHECKIN:
924 if (!ensureBufferClean(view()))
926 if (owner->buffer()->lyxvc().inUse()
927 && !owner->buffer()->isReadonly()) {
928 owner->buffer()->lyxvc().checkIn();
933 case LFUN_VC_CHECKOUT:
934 if (!ensureBufferClean(view()))
936 if (owner->buffer()->lyxvc().inUse()
937 && owner->buffer()->isReadonly()) {
938 owner->buffer()->lyxvc().checkOut();
944 owner->buffer()->lyxvc().revert();
949 owner->buffer()->lyxvc().undoLast();
953 // --- buffers ----------------------------------------
954 case LFUN_SWITCHBUFFER:
955 view()->setBuffer(bufferlist.getBuffer(argument));
959 NewFile(view(), argument);
966 case LFUN_DROP_LAYOUTS_CHOICE:
967 owner->getToolbars().openLayoutList();
970 case LFUN_MENU_OPEN_BY_NAME:
971 owner->getMenubar().openByName(argument);
974 // --- lyxserver commands ----------------------------
976 setMessage(owner->buffer()->fileName());
977 lyxerr[Debug::INFO] << "FNAME["
978 << owner->buffer()->fileName()
983 dispatch_buffer = keyseq.print();
984 lyxserver->notifyClient(dispatch_buffer);
987 case LFUN_GOTOFILEROW: {
990 istringstream is(argument);
991 is >> file_name >> row;
992 if (prefixIs(file_name, getTmpDir())) {
993 // Needed by inverse dvi search. If it is a file
994 // in tmpdir, call the apropriated function
995 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
997 // Must replace extension of the file to be .lyx
999 string const s = ChangeExtension(file_name, ".lyx");
1000 // Either change buffer or load the file
1001 if (bufferlist.exists(s)) {
1002 view()->setBuffer(bufferlist.getBuffer(s));
1004 view()->loadLyXFile(s);
1008 view()->setCursorFromRow(row);
1011 // see BufferView_pimpl::center()
1012 view()->updateScrollbar();
1016 case LFUN_GOTO_PARAGRAPH: {
1017 istringstream is(argument);
1020 ParIterator par = owner->buffer()->getParFromID(id);
1021 if (par == owner->buffer()->par_iterator_end()) {
1022 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1023 << id << ']' << endl;
1026 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1027 << " found." << endl;
1031 view()->setCursor(par, 0);
1033 view()->switchKeyMap();
1034 owner->view_state_changed();
1037 // see BufferView_pimpl::center()
1038 view()->updateScrollbar();
1042 case LFUN_DIALOG_SHOW: {
1043 string const name = cmd.getArg(0);
1044 string data = trim(cmd.argument.substr(name.size()));
1046 if (name == "character") {
1047 data = freefont2string();
1049 owner->getDialogs().show("character", data);
1052 else if (name == "latexlog") {
1053 pair<Buffer::LogType, string> const logfile =
1054 owner->buffer()->getLogName();
1055 switch (logfile.first) {
1056 case Buffer::latexlog:
1059 case Buffer::buildlog:
1063 data += logfile.second;
1064 owner->getDialogs().show("log", data);
1066 else if (name == "vclog") {
1067 string const data = "vc " +
1068 owner->buffer()->lyxvc().getLogFile();
1069 owner->getDialogs().show("log", data);
1072 owner->getDialogs().show(name, data);
1076 case LFUN_DIALOG_SHOW_NEW_INSET: {
1077 string const name = cmd.getArg(0);
1078 string data = trim(cmd.argument.substr(name.size()));
1079 if (name == "bibitem" ||
1081 name == "include" ||
1087 InsetCommandParams p(name);
1088 data = InsetCommandMailer::params2string(name, p);
1089 } else if (name == "box") {
1090 // \c data == "Boxed" || "Frameless" etc
1091 InsetBoxParams p(data);
1092 data = InsetBoxMailer::params2string(p);
1093 } else if (name == "branch") {
1094 InsetBranchParams p;
1095 data = InsetBranchMailer::params2string(p);
1096 } else if (name == "citation") {
1097 InsetCommandParams p("cite");
1098 data = InsetCommandMailer::params2string(name, p);
1099 } else if (name == "ert") {
1100 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1101 } else if (name == "external") {
1102 InsetExternalParams p;
1103 Buffer const & buffer = *owner->buffer();
1104 data = InsetExternalMailer::params2string(p, buffer);
1105 } else if (name == "float") {
1107 data = InsetFloatMailer::params2string(p);
1108 } else if (name == "graphics") {
1109 InsetGraphicsParams p;
1110 Buffer const & buffer = *owner->buffer();
1111 data = InsetGraphicsMailer::params2string(p, buffer);
1112 } else if (name == "note") {
1114 data = InsetNoteMailer::params2string(p);
1115 } else if (name == "vspace") {
1117 data = InsetVSpaceMailer::params2string(space);
1118 } else if (name == "wrap") {
1120 data = InsetWrapMailer::params2string(p);
1122 owner->getDialogs().show(name, data, 0);
1126 case LFUN_DIALOG_SHOW_NEXT_INSET:
1129 case LFUN_DIALOG_UPDATE: {
1130 string const & name = argument;
1131 // Can only update a dialog connected to an existing inset
1132 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1134 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1135 inset->dispatch(view()->cursor(), fr);
1136 } else if (name == "paragraph") {
1137 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1138 } else if (name == "prefs") {
1139 owner->getDialogs().update(name, string());
1144 case LFUN_DIALOG_HIDE:
1145 Dialogs::hide(argument, 0);
1148 case LFUN_DIALOG_DISCONNECT_INSET:
1149 owner->getDialogs().disconnect(argument);
1152 case LFUN_CHILDOPEN: {
1153 string const filename =
1154 MakeAbsPath(argument, owner->buffer()->filePath());
1155 setMessage(N_("Opening child document ") +
1156 MakeDisplayPath(filename) + "...");
1157 view()->savePosition(0);
1158 string const parentfilename = owner->buffer()->fileName();
1159 if (bufferlist.exists(filename))
1160 view()->setBuffer(bufferlist.getBuffer(filename));
1162 view()->loadLyXFile(filename);
1163 // Set the parent name of the child document.
1164 // This makes insertion of citations and references in the child work,
1165 // when the target is in the parent or another child document.
1166 owner->buffer()->setParentName(parentfilename);
1170 case LFUN_TOGGLECURSORFOLLOW:
1171 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1175 owner->getIntl().KeyMapOn(false);
1178 case LFUN_KMAP_PRIM:
1179 owner->getIntl().KeyMapPrim();
1183 owner->getIntl().KeyMapSec();
1186 case LFUN_KMAP_TOGGLE:
1187 owner->getIntl().ToggleKeyMap();
1193 string rest = split(argument, countstr, ' ');
1194 istringstream is(countstr);
1197 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1198 for (int i = 0; i < count; ++i)
1199 dispatch(lyxaction.lookupFunc(rest));
1203 case LFUN_SEQUENCE: {
1204 // argument contains ';'-terminated commands
1205 string arg = argument;
1206 while (!arg.empty()) {
1208 arg = split(arg, first, ';');
1209 dispatch(lyxaction.lookupFunc(first));
1214 case LFUN_SAVEPREFERENCES: {
1215 Path p(user_lyxdir());
1216 lyxrc.write("preferences", false);
1220 case LFUN_SCREEN_FONT_UPDATE:
1221 // handle the screen font changes.
1222 lyxrc.set_font_norm_type();
1223 lyx_gui::update_fonts();
1224 // All visible buffers will need resize
1228 case LFUN_SET_COLOR: {
1230 string const x11_name = split(argument, lyx_name, ' ');
1231 if (lyx_name.empty() || x11_name.empty()) {
1232 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1237 bool const graphicsbg_changed =
1238 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1239 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1241 if (!lcolor.setColor(lyx_name, x11_name)) {
1243 bformat(_("Set-color \"%1$s\" failed "
1244 "- color is undefined or "
1245 "may not be redefined"), lyx_name));
1249 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1251 if (graphicsbg_changed) {
1252 #ifdef WITH_WARNINGS
1253 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1256 lyx::graphics::GCache::get().changeDisplay(true);
1263 owner->message(argument);
1266 case LFUN_TOOLTIPS_TOGGLE:
1267 owner->getDialogs().toggleTooltips();
1270 case LFUN_EXTERNAL_EDIT: {
1271 FuncRequest fr(action, argument);
1272 InsetExternal().dispatch(view()->cursor(), fr);
1276 case LFUN_GRAPHICS_EDIT: {
1277 FuncRequest fr(action, argument);
1278 InsetGraphics().dispatch(view()->cursor(), fr);
1282 case LFUN_ALL_INSETS_TOGGLE: {
1284 string const name = split(argument, action, ' ');
1285 InsetBase::Code const inset_code =
1286 InsetBase::translate(name);
1288 LCursor & cur = view()->cursor();
1289 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1291 InsetBase & inset = owner->buffer()->inset();
1292 InsetIterator it = inset_iterator_begin(inset);
1293 InsetIterator const end = inset_iterator_end(inset);
1294 for (; it != end; ++it) {
1295 if (inset_code == InsetBase::NO_CODE
1296 || inset_code == it->lyxCode())
1297 it->dispatch(cur, fr);
1302 case LFUN_LANGUAGE_BUFFER: {
1303 Buffer & buffer = *owner->buffer();
1304 Language const * oldL = buffer.params().language;
1305 Language const * newL = languages.getLanguage(argument);
1306 if (!newL || oldL == newL)
1309 if (oldL->RightToLeft() == newL->RightToLeft()
1310 && !buffer.isMultiLingual())
1311 buffer.changeLanguage(oldL, newL);
1313 buffer.updateDocLang(newL);
1317 case LFUN_BUFFERPARAMS_APPLY: {
1318 biblio::CiteEngine const engine =
1319 owner->buffer()->params().cite_engine;
1321 istringstream ss(argument);
1324 int const unknown_tokens =
1325 owner->buffer()->readHeader(lex);
1327 if (unknown_tokens != 0) {
1328 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1329 << unknown_tokens << " unknown token"
1330 << (unknown_tokens == 1 ? "" : "s")
1333 if (engine == owner->buffer()->params().cite_engine)
1336 LCursor & cur = view()->cursor();
1337 FuncRequest fr(LFUN_INSET_REFRESH);
1339 InsetBase & inset = owner->buffer()->inset();
1340 InsetIterator it = inset_iterator_begin(inset);
1341 InsetIterator const end = inset_iterator_end(inset);
1342 for (; it != end; ++it)
1343 if (it->lyxCode() == InsetBase::CITE_CODE)
1344 it->dispatch(cur, fr);
1348 case LFUN_TEXTCLASS_APPLY: {
1349 Buffer * buffer = owner->buffer();
1351 lyx::textclass_type const old_class =
1352 buffer->params().textclass;
1354 loadTextclass(argument);
1356 std::pair<bool, lyx::textclass_type> const tc_pair =
1357 textclasslist.NumberOfClass(argument);
1362 lyx::textclass_type const new_class = tc_pair.second;
1363 if (old_class == new_class)
1367 owner->message(_("Converting document to new document class..."));
1369 lyx::cap::SwitchLayoutsBetweenClasses(
1370 old_class, new_class,
1371 buffer->paragraphs(), el);
1373 bufferErrors(*buffer, el);
1374 view()->showErrorList(_("Class switch"));
1378 case LFUN_TEXTCLASS_LOAD:
1379 loadTextclass(argument);
1382 case LFUN_LYXRC_APPLY: {
1383 istringstream ss(argument);
1384 bool const success = lyxrc.read(ss) == 0;
1387 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1388 << "Unable to read lyxrc data"
1396 DispatchResult res = view()->cursor().dispatch(cmd);
1397 if (res.dispatched())
1398 update |= res.update();
1400 update |= view()->dispatch(cmd);
1406 if (view()->available()) {
1407 if (view()->fitCursor() || update)
1409 // if we executed a mutating lfun, mark the buffer as dirty
1410 if (getStatus(cmd).enabled()
1411 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1412 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1413 view()->buffer()->markDirty();
1416 if (view()->cursor().inTexted()) {
1417 view()->owner()->updateLayoutChoice();
1418 sendDispatchMessage(getMessage(), cmd, verbose);
1424 void LyXFunc::sendDispatchMessage(string const & msg,
1425 FuncRequest const & cmd, bool verbose)
1427 owner->updateMenubar();
1428 owner->updateToolbars();
1430 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1431 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1433 owner->message(msg);
1437 string dispatch_msg = msg;
1438 if (!dispatch_msg.empty())
1439 dispatch_msg += ' ';
1441 string comname = lyxaction.getActionName(cmd.action);
1443 bool argsadded = false;
1445 if (!cmd.argument.empty()) {
1446 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1447 comname += ' ' + cmd.argument;
1452 string const shortcuts = toplevel_keymap->findbinding(cmd);
1454 if (!shortcuts.empty()) {
1455 comname += ": " + shortcuts;
1456 } else if (!argsadded && !cmd.argument.empty()) {
1457 comname += ' ' + cmd.argument;
1460 if (!comname.empty()) {
1461 comname = rtrim(comname);
1462 dispatch_msg += '(' + comname + ')';
1465 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1466 if (!dispatch_msg.empty())
1467 owner->message(dispatch_msg);
1471 void LyXFunc::setupLocalKeymap()
1473 keyseq.stdmap = toplevel_keymap.get();
1474 keyseq.curmap = toplevel_keymap.get();
1475 cancel_meta_seq.stdmap = toplevel_keymap.get();
1476 cancel_meta_seq.curmap = toplevel_keymap.get();
1480 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1482 string initpath = lyxrc.document_path;
1483 string filename(name);
1485 if (view()->available()) {
1486 string const trypath = owner->buffer()->filePath();
1487 // If directory is writeable, use this as default.
1488 if (IsDirWriteable(trypath))
1492 static int newfile_number;
1494 if (filename.empty()) {
1495 filename = AddName(lyxrc.document_path,
1496 "newfile" + tostr(++newfile_number) + ".lyx");
1497 FileInfo fi(filename);
1498 while (bufferlist.exists(filename) || fi.readable()) {
1500 filename = AddName(lyxrc.document_path,
1501 "newfile" + tostr(newfile_number) +
1503 fi.newFile(filename);
1507 // The template stuff
1510 FileDialog fileDlg(_("Select template file"),
1511 LFUN_SELECT_FILE_SYNC,
1512 make_pair(string(_("Documents|#o#O")),
1513 string(lyxrc.document_path)),
1514 make_pair(string(_("Templates|#T#t")),
1515 string(lyxrc.template_path)));
1517 FileDialog::Result result =
1518 fileDlg.open(lyxrc.template_path,
1519 FileFilterList(_("LyX Documents (*.lyx)")),
1522 if (result.first == FileDialog::Later)
1524 if (result.second.empty())
1526 templname = result.second;
1529 view()->newFile(filename, templname, !name.empty());
1533 void LyXFunc::open(string const & fname)
1535 string initpath = lyxrc.document_path;
1537 if (view()->available()) {
1538 string const trypath = owner->buffer()->filePath();
1539 // If directory is writeable, use this as default.
1540 if (IsDirWriteable(trypath))
1546 if (fname.empty()) {
1547 FileDialog fileDlg(_("Select document to open"),
1549 make_pair(string(_("Documents|#o#O")),
1550 string(lyxrc.document_path)),
1551 make_pair(string(_("Examples|#E#e")),
1552 string(AddPath(system_lyxdir(), "examples"))));
1554 FileDialog::Result result =
1555 fileDlg.open(initpath,
1556 FileFilterList(_("LyX Documents (*.lyx)")),
1559 if (result.first == FileDialog::Later)
1562 filename = result.second;
1564 // check selected filename
1565 if (filename.empty()) {
1566 owner->message(_("Canceled."));
1572 // get absolute path of file and add ".lyx" to the filename if
1574 string const fullpath = FileSearch(string(), filename, "lyx");
1575 if (!fullpath.empty()) {
1576 filename = fullpath;
1579 string const disp_fn(MakeDisplayPath(filename));
1581 // if the file doesn't exist, let the user create one
1582 FileInfo const f(filename, true);
1584 // the user specifically chose this name. Believe them.
1585 view()->newFile(filename, "", true);
1589 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1592 if (view()->loadLyXFile(filename)) {
1593 str2 = bformat(_("Document %1$s opened."), disp_fn);
1595 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1597 owner->message(str2);
1601 void LyXFunc::doImport(string const & argument)
1604 string filename = split(argument, format, ' ');
1606 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1607 << " file: " << filename << endl;
1609 // need user interaction
1610 if (filename.empty()) {
1611 string initpath = lyxrc.document_path;
1613 if (view()->available()) {
1614 string const trypath = owner->buffer()->filePath();
1615 // If directory is writeable, use this as default.
1616 if (IsDirWriteable(trypath))
1620 string const text = bformat(_("Select %1$s file to import"),
1621 formats.prettyName(format));
1623 FileDialog fileDlg(text,
1625 make_pair(string(_("Documents|#o#O")),
1626 string(lyxrc.document_path)),
1627 make_pair(string(_("Examples|#E#e")),
1628 string(AddPath(system_lyxdir(), "examples"))));
1630 string const filter = formats.prettyName(format)
1631 + " (*." + formats.extension(format) + ')';
1633 FileDialog::Result result =
1634 fileDlg.open(initpath,
1635 FileFilterList(filter),
1638 if (result.first == FileDialog::Later)
1641 filename = result.second;
1643 // check selected filename
1644 if (filename.empty())
1645 owner->message(_("Canceled."));
1648 if (filename.empty())
1651 // get absolute path of file
1652 filename = MakeAbsPath(filename);
1654 string const lyxfile = ChangeExtension(filename, ".lyx");
1656 // Check if the document already is open
1657 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1658 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1659 owner->message(_("Canceled."));
1664 // if the file exists already, and we didn't do
1665 // -i lyx thefile.lyx, warn
1666 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1667 string const file = MakeDisplayPath(lyxfile, 30);
1669 string text = bformat(_("The document %1$s already exists.\n\n"
1670 "Do you want to over-write that document?"), file);
1671 int const ret = Alert::prompt(_("Over-write document?"),
1672 text, 0, 1, _("&Over-write"), _("&Cancel"));
1675 owner->message(_("Canceled."));
1680 Importer::Import(owner, filename, format);
1684 void LyXFunc::closeBuffer()
1686 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1687 if (bufferlist.empty()) {
1688 // need this otherwise SEGV may occur while
1689 // trying to set variables that don't exist
1690 // since there's no current buffer
1691 owner->getDialogs().hideBufferDependent();
1693 view()->setBuffer(bufferlist.first());
1699 // Each "owner" should have it's own message method. lyxview and
1700 // the minibuffer would use the minibuffer, but lyxserver would
1701 // send an ERROR signal to its client. Alejandro 970603
1702 // This function is bit problematic when it comes to NLS, to make the
1703 // lyx servers client be language indepenent we must not translate
1704 // strings sent to this func.
1705 void LyXFunc::setErrorMessage(string const & m) const
1707 dispatch_buffer = m;
1712 void LyXFunc::setMessage(string const & m) const
1714 dispatch_buffer = m;
1718 void LyXFunc::setStatusMessage(string const & m) const
1724 string const LyXFunc::viewStatusMessage()
1726 // When meta-fake key is pressed, show the key sequence so far + "M-".
1728 return keyseq.print() + "M-";
1730 // Else, when a non-complete key sequence is pressed,
1731 // show the available options.
1732 if (keyseq.length() > 0 && !keyseq.deleted())
1733 return keyseq.printOptions();
1735 if (!view()->available())
1736 return _("Welcome to LyX!");
1738 return view()->cursor().currentState();
1742 BufferView * LyXFunc::view() const
1744 BOOST_ASSERT(owner);
1745 return owner->view().get();
1749 bool LyXFunc::wasMetaKey() const
1751 return (meta_fake_bit != key_modifier::none);