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"));
305 // Check whether we need a buffer
306 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
308 setStatusMessage(N_("Command not allowed with"
309 "out any document open"));
314 // I would really like to avoid having this switch and rather try to
315 // encode this in the function itself.
316 // -- And I'd rather let an inset decide which LFUNs it is willing
317 // to handle (Andre')
319 switch (cmd.action) {
320 case LFUN_TOOLTIPS_TOGGLE:
321 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
324 case LFUN_READ_ONLY_TOGGLE:
325 flag.setOnOff(buf->isReadonly());
328 case LFUN_SWITCHBUFFER:
329 // toggle on the current buffer, but do not toggle off
330 // the other ones (is that a good idea?)
331 if (cmd.argument == buf->fileName())
336 enable = cmd.argument == "custom"
337 || Exporter::IsExportable(*buf, cmd.argument);
341 enable = cur.selection();
345 enable = buf->isLatex() && lyxrc.chktex_command != "none";
349 enable = Exporter::IsExportable(*buf, "program");
352 case LFUN_LAYOUT_TABULAR:
353 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
357 case LFUN_LAYOUT_PARAGRAPH:
358 enable = !cur.inset().forceDefaultParagraphs(&cur.inset());
361 case LFUN_VC_REGISTER:
362 enable = !buf->lyxvc().inUse();
364 case LFUN_VC_CHECKIN:
365 enable = buf->lyxvc().inUse() && !buf->isReadonly();
367 case LFUN_VC_CHECKOUT:
368 enable = buf->lyxvc().inUse() && buf->isReadonly();
372 enable = buf->lyxvc().inUse();
374 case LFUN_MENURELOAD:
375 enable = !buf->isUnnamed() && !buf->isClean();
379 case LFUN_INSET_SETTINGS: {
383 UpdatableInset * inset = cur.inset().asUpdatableInset();
384 lyxerr << "inset: " << inset << endl;
388 InsetOld::Code code = inset->lyxCode();
390 case InsetOld::TABULAR_CODE:
391 enable = cmd.argument == "tabular";
393 case InsetOld::ERT_CODE:
394 enable = cmd.argument == "ert";
396 case InsetOld::FLOAT_CODE:
397 enable = cmd.argument == "float";
399 case InsetOld::WRAP_CODE:
400 enable = cmd.argument == "wrap";
402 case InsetOld::NOTE_CODE:
403 enable = cmd.argument == "note";
405 case InsetOld::BRANCH_CODE:
406 enable = cmd.argument == "branch";
408 case InsetOld::BOX_CODE:
409 enable = cmd.argument == "box";
417 case LFUN_DIALOG_SHOW: {
418 string const name = cmd.getArg(0);
420 enable = name == "aboutlyx"
424 || name == "texinfo";
425 else if (name == "print")
426 enable = Exporter::IsExportable(*buf, "dvi")
427 && lyxrc.print_command != "none";
428 else if (name == "character")
429 enable = cur.inset().lyxCode() != InsetOld::ERT_CODE;
430 else if (name == "vclog")
431 enable = buf->lyxvc().inUse();
432 else if (name == "latexlog")
433 enable = IsFileReadable(buf->getLogName().second);
437 case LFUN_DIALOG_UPDATE: {
438 string const name = cmd.getArg(0);
440 enable = name == "prefs";
444 // this one is difficult to get right. As a half-baked
445 // solution, we consider only the first action of the sequence
446 case LFUN_SEQUENCE: {
447 // argument contains ';'-terminated commands
448 string const firstcmd = token(cmd.argument, ';', 0);
449 flag = getStatus(lyxaction.lookupFunc(firstcmd));
453 case LFUN_MENUNEWTMPLT:
454 case LFUN_WORDFINDFORWARD:
455 case LFUN_WORDFINDBACKWARD:
457 case LFUN_EXEC_COMMAND:
460 case LFUN_CLOSEBUFFER:
469 case LFUN_RECONFIGURE:
473 case LFUN_DROP_LAYOUTS_CHOICE:
474 case LFUN_MENU_OPEN_BY_NAME:
477 case LFUN_GOTOFILEROW:
478 case LFUN_GOTO_PARAGRAPH:
479 case LFUN_DIALOG_SHOW_NEW_INSET:
480 case LFUN_DIALOG_SHOW_NEXT_INSET:
481 case LFUN_DIALOG_HIDE:
482 case LFUN_DIALOG_DISCONNECT_INSET:
484 case LFUN_TOGGLECURSORFOLLOW:
488 case LFUN_KMAP_TOGGLE:
490 case LFUN_EXPORT_CUSTOM:
492 case LFUN_SAVEPREFERENCES:
493 case LFUN_SCREEN_FONT_UPDATE:
496 case LFUN_EXTERNAL_EDIT:
497 case LFUN_GRAPHICS_EDIT:
498 case LFUN_ALL_INSETS_TOGGLE:
499 case LFUN_LANGUAGE_BUFFER:
500 case LFUN_TEXTCLASS_APPLY:
501 case LFUN_TEXTCLASS_LOAD:
502 case LFUN_SAVE_AS_DEFAULT:
503 case LFUN_BUFFERPARAMS_APPLY:
504 case LFUN_LYXRC_APPLY:
505 // these are handled in our dispatch()
510 cur.getStatus(cmd, flag);
512 flag = view()->getStatus(cmd);
518 // Can we use a readonly buffer?
519 if (buf && buf->isReadonly()
520 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
521 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
522 setStatusMessage(N_("Document is read-only"));
526 //lyxerr << "LyXFunc::getStatus: got: " << flag.enabled() << endl;
533 bool ensureBufferClean(BufferView * bv)
535 Buffer & buf = *bv->buffer();
539 string const file = MakeDisplayPath(buf.fileName(), 30);
540 string text = bformat(_("The document %1$s has unsaved "
541 "changes.\n\nDo you want to save "
542 "the document?"), file);
543 int const ret = Alert::prompt(_("Save changed document?"),
544 text, 0, 1, _("&Save"),
548 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
550 return buf.isClean();
554 void showPrintError(string const & name)
556 string str = bformat(_("Could not print the document %1$s.\n"
557 "Check that your printer is set up correctly."),
558 MakeDisplayPath(name, 50));
559 Alert::error(_("Print document failed"), str);
563 void loadTextclass(string const & name)
565 std::pair<bool, lyx::textclass_type> const tc_pair =
566 textclasslist.NumberOfClass(name);
568 if (!tc_pair.first) {
569 lyxerr << "Document class \"" << name
570 << "\" does not exist."
575 lyx::textclass_type const tc = tc_pair.second;
577 if (!textclasslist[tc].load()) {
578 string s = bformat(_("The document could not be converted\n"
579 "into the document class %1$s."),
580 textclasslist[tc].name());
581 Alert::error(_("Could not change class"), s);
588 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
590 string const argument = cmd.argument;
591 kb_action const action = cmd.action;
593 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
594 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
596 // we have not done anything wrong yet.
598 dispatch_buffer.erase();
599 selection_possible = false;
603 // We cannot use this function here
604 if (!getStatus(cmd).enabled()) {
605 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
606 << lyxaction.getActionName(action)
607 << " [" << action << "] is disabled at this location"
609 setErrorMessage(getStatusMessage());
613 if (view()->available())
614 view()->hideCursor();
618 case LFUN_WORDFINDFORWARD:
619 case LFUN_WORDFINDBACKWARD: {
620 static string last_search;
621 string searched_string;
623 if (!argument.empty()) {
624 last_search = argument;
625 searched_string = argument;
627 searched_string = last_search;
630 if (searched_string.empty())
633 bool const fw = action == LFUN_WORDFINDFORWARD;
635 lyx::find::find2string(searched_string, true, false, fw);
636 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
641 owner->message(keyseq.printOptions());
644 case LFUN_EXEC_COMMAND:
645 owner->getToolbars().display("minibuffer", true);
646 owner->focus_command_buffer();
651 meta_fake_bit = key_modifier::none;
652 if (view()->available())
653 // cancel any selection
654 dispatch(FuncRequest(LFUN_MARK_OFF));
655 setMessage(N_("Cancel"));
659 meta_fake_bit = key_modifier::alt;
660 setMessage(keyseq.print());
663 case LFUN_READ_ONLY_TOGGLE:
664 if (owner->buffer()->lyxvc().inUse())
665 owner->buffer()->lyxvc().toggleReadOnly();
667 owner->buffer()->setReadonly(
668 !owner->buffer()->isReadonly());
671 // --- Menus -----------------------------------------------
673 menuNew(argument, false);
676 case LFUN_MENUNEWTMPLT:
677 menuNew(argument, true);
680 case LFUN_CLOSEBUFFER:
685 if (!owner->buffer()->isUnnamed()) {
686 string const str = bformat(_("Saving document %1$s..."),
687 MakeDisplayPath(owner->buffer()->fileName()));
689 MenuWrite(owner->buffer());
690 owner->message(str + _(" done."));
692 WriteAs(owner->buffer());
696 WriteAs(owner->buffer(), argument);
699 case LFUN_MENURELOAD: {
700 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
701 string text = bformat(_("Any changes will be lost. Are you sure "
702 "you want to revert to the saved version of the document %1$s?"), file);
703 int const ret = Alert::prompt(_("Revert to saved document?"),
704 text, 0, 1, _("&Revert"), _("&Cancel"));
712 Exporter::Export(owner->buffer(), argument, true);
713 view()->showErrorList(BufferFormat(*owner->buffer()));
717 Exporter::Preview(owner->buffer(), argument);
718 view()->showErrorList(BufferFormat(*owner->buffer()));
722 Exporter::Export(owner->buffer(), "program", true);
723 view()->showErrorList(_("Build"));
727 owner->buffer()->runChktex();
728 view()->showErrorList(_("ChkTeX"));
732 if (argument == "custom")
733 owner->getDialogs().show("sendto");
735 Exporter::Export(owner->buffer(), argument, false);
736 view()->showErrorList(BufferFormat(*owner->buffer()));
740 case LFUN_EXPORT_CUSTOM: {
742 string command = split(argument, format_name, ' ');
743 Format const * format = formats.getFormat(format_name);
745 lyxerr << "Format \"" << format_name
746 << "\" not recognized!"
751 Buffer * buffer = owner->buffer();
753 // The name of the file created by the conversion process
756 // Output to filename
757 if (format->name() == "lyx") {
758 string const latexname =
759 buffer->getLatexName(false);
760 filename = ChangeExtension(latexname,
761 format->extension());
762 filename = AddName(buffer->temppath(), filename);
764 if (!buffer->writeFile(filename))
768 Exporter::Export(buffer, format_name, true,
772 // Substitute $$FName for filename
773 if (!contains(command, "$$FName"))
774 command = "( " + command + " ) < $$FName";
775 command = subst(command, "$$FName", filename);
777 // Execute the command in the background
779 call.startscript(Systemcall::DontWait, command);
786 string command = split(split(argument, target, ' '),
790 || target_name.empty()
791 || command.empty()) {
792 lyxerr << "Unable to parse \""
793 << argument << '"' << std::endl;
796 if (target != "printer" && target != "file") {
797 lyxerr << "Unrecognized target \""
798 << target << '"' << std::endl;
802 Buffer * buffer = owner->buffer();
804 if (!Exporter::Export(buffer, "dvi", true)) {
805 showPrintError(buffer->fileName());
809 // Push directory path.
810 string const path = buffer->temppath();
813 // there are three cases here:
814 // 1. we print to a file
815 // 2. we print directly to a printer
816 // 3. we print using a spool command (print to file first)
819 string const dviname =
820 ChangeExtension(buffer->getLatexName(true),
823 if (target == "printer") {
824 if (!lyxrc.print_spool_command.empty()) {
825 // case 3: print using a spool
826 string const psname =
827 ChangeExtension(dviname,".ps");
828 command += lyxrc.print_to_file
831 + QuoteName(dviname);
834 lyxrc.print_spool_command +' ';
835 if (target_name != "default") {
836 command2 += lyxrc.print_spool_printerprefix
840 command2 += QuoteName(psname);
842 // If successful, then spool command
843 res = one.startscript(
848 res = one.startscript(
849 Systemcall::DontWait,
852 // case 2: print directly to a printer
853 res = one.startscript(
854 Systemcall::DontWait,
855 command + QuoteName(dviname));
859 // case 1: print to a file
860 command += lyxrc.print_to_file
861 + QuoteName(MakeAbsPath(target_name,
864 + QuoteName(dviname);
865 res = one.startscript(Systemcall::DontWait,
870 showPrintError(buffer->fileName());
883 InsetCommandParams p("tableofcontents");
884 string const data = InsetCommandMailer::params2string("toc", p);
885 owner->getDialogs().show("toc", data, 0);
893 case LFUN_RECONFIGURE:
897 case LFUN_HELP_OPEN: {
898 string const arg = argument;
900 setErrorMessage(N_("Missing argument"));
903 string const fname = i18nLibFileSearch("doc", arg, "lyx");
905 lyxerr << "LyX: unable to find documentation file `"
906 << arg << "'. Bad installation?" << endl;
909 owner->message(bformat(_("Opening help file %1$s..."),
910 MakeDisplayPath(fname)));
911 view()->loadLyXFile(fname, false);
915 // --- version control -------------------------------
916 case LFUN_VC_REGISTER:
917 if (!ensureBufferClean(view()))
919 if (!owner->buffer()->lyxvc().inUse()) {
920 owner->buffer()->lyxvc().registrer();
925 case LFUN_VC_CHECKIN:
926 if (!ensureBufferClean(view()))
928 if (owner->buffer()->lyxvc().inUse()
929 && !owner->buffer()->isReadonly()) {
930 owner->buffer()->lyxvc().checkIn();
935 case LFUN_VC_CHECKOUT:
936 if (!ensureBufferClean(view()))
938 if (owner->buffer()->lyxvc().inUse()
939 && owner->buffer()->isReadonly()) {
940 owner->buffer()->lyxvc().checkOut();
946 owner->buffer()->lyxvc().revert();
951 owner->buffer()->lyxvc().undoLast();
955 // --- buffers ----------------------------------------
956 case LFUN_SWITCHBUFFER:
957 view()->setBuffer(bufferlist.getBuffer(argument));
961 NewFile(view(), argument);
968 case LFUN_DROP_LAYOUTS_CHOICE:
969 owner->getToolbars().openLayoutList();
972 case LFUN_MENU_OPEN_BY_NAME:
973 owner->getMenubar().openByName(argument);
976 // --- lyxserver commands ----------------------------
978 setMessage(owner->buffer()->fileName());
979 lyxerr[Debug::INFO] << "FNAME["
980 << owner->buffer()->fileName()
985 dispatch_buffer = keyseq.print();
986 lyxserver->notifyClient(dispatch_buffer);
989 case LFUN_GOTOFILEROW: {
992 istringstream is(argument);
993 is >> file_name >> row;
994 if (prefixIs(file_name, getTmpDir())) {
995 // Needed by inverse dvi search. If it is a file
996 // in tmpdir, call the apropriated function
997 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
999 // Must replace extension of the file to be .lyx
1000 // and get full path
1001 string const s = ChangeExtension(file_name, ".lyx");
1002 // Either change buffer or load the file
1003 if (bufferlist.exists(s)) {
1004 view()->setBuffer(bufferlist.getBuffer(s));
1006 view()->loadLyXFile(s);
1010 view()->setCursorFromRow(row);
1013 // see BufferView_pimpl::center()
1014 view()->updateScrollbar();
1018 case LFUN_GOTO_PARAGRAPH: {
1019 istringstream is(argument);
1022 ParIterator par = owner->buffer()->getParFromID(id);
1023 if (par == owner->buffer()->par_iterator_end()) {
1024 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1025 << id << ']' << endl;
1028 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1029 << " found." << endl;
1033 view()->setCursor(par, 0);
1035 view()->switchKeyMap();
1036 owner->view_state_changed();
1039 // see BufferView_pimpl::center()
1040 view()->updateScrollbar();
1044 case LFUN_DIALOG_SHOW: {
1045 string const name = cmd.getArg(0);
1046 string data = trim(cmd.argument.substr(name.size()));
1048 if (name == "character") {
1049 data = freefont2string();
1051 owner->getDialogs().show("character", data);
1054 else if (name == "latexlog") {
1055 pair<Buffer::LogType, string> const logfile =
1056 owner->buffer()->getLogName();
1057 switch (logfile.first) {
1058 case Buffer::latexlog:
1061 case Buffer::buildlog:
1065 data += logfile.second;
1066 owner->getDialogs().show("log", data);
1068 else if (name == "vclog") {
1069 string const data = "vc " +
1070 owner->buffer()->lyxvc().getLogFile();
1071 owner->getDialogs().show("log", data);
1074 owner->getDialogs().show(name, data);
1078 case LFUN_DIALOG_SHOW_NEW_INSET: {
1079 string const name = cmd.getArg(0);
1080 string data = trim(cmd.argument.substr(name.size()));
1081 if (name == "bibitem" ||
1083 name == "include" ||
1089 InsetCommandParams p(name);
1090 data = InsetCommandMailer::params2string(name, p);
1091 } else if (name == "box") {
1092 // \c data == "Boxed" || "Frameless" etc
1093 InsetBoxParams p(data);
1094 data = InsetBoxMailer::params2string(p);
1095 } else if (name == "branch") {
1096 InsetBranchParams p;
1097 data = InsetBranchMailer::params2string(p);
1098 } else if (name == "citation") {
1099 InsetCommandParams p("cite");
1100 data = InsetCommandMailer::params2string(name, p);
1101 } else if (name == "ert") {
1102 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1103 } else if (name == "external") {
1104 InsetExternalParams p;
1105 Buffer const & buffer = *owner->buffer();
1106 data = InsetExternalMailer::params2string(p, buffer);
1107 } else if (name == "float") {
1109 data = InsetFloatMailer::params2string(p);
1110 } else if (name == "graphics") {
1111 InsetGraphicsParams p;
1112 Buffer const & buffer = *owner->buffer();
1113 data = InsetGraphicsMailer::params2string(p, buffer);
1114 } else if (name == "note") {
1116 data = InsetNoteMailer::params2string(p);
1117 } else if (name == "vspace") {
1119 data = InsetVSpaceMailer::params2string(space);
1120 } else if (name == "wrap") {
1122 data = InsetWrapMailer::params2string(p);
1124 owner->getDialogs().show(name, data, 0);
1128 case LFUN_DIALOG_SHOW_NEXT_INSET:
1131 case LFUN_DIALOG_UPDATE: {
1132 string const & name = argument;
1133 // Can only update a dialog connected to an existing inset
1134 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1136 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1137 inset->dispatch(view()->cursor(), fr);
1138 } else if (name == "paragraph") {
1139 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1140 } else if (name == "prefs") {
1141 owner->getDialogs().update(name, string());
1146 case LFUN_DIALOG_HIDE:
1147 Dialogs::hide(argument, 0);
1150 case LFUN_DIALOG_DISCONNECT_INSET:
1151 owner->getDialogs().disconnect(argument);
1154 case LFUN_CHILDOPEN: {
1155 string const filename =
1156 MakeAbsPath(argument, owner->buffer()->filePath());
1157 setMessage(N_("Opening child document ") +
1158 MakeDisplayPath(filename) + "...");
1159 view()->savePosition(0);
1160 string const parentfilename = owner->buffer()->fileName();
1161 if (bufferlist.exists(filename))
1162 view()->setBuffer(bufferlist.getBuffer(filename));
1164 view()->loadLyXFile(filename);
1165 // Set the parent name of the child document.
1166 // This makes insertion of citations and references in the child work,
1167 // when the target is in the parent or another child document.
1168 owner->buffer()->setParentName(parentfilename);
1172 case LFUN_TOGGLECURSORFOLLOW:
1173 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1177 owner->getIntl().KeyMapOn(false);
1180 case LFUN_KMAP_PRIM:
1181 owner->getIntl().KeyMapPrim();
1185 owner->getIntl().KeyMapSec();
1188 case LFUN_KMAP_TOGGLE:
1189 owner->getIntl().ToggleKeyMap();
1195 string rest = split(argument, countstr, ' ');
1196 istringstream is(countstr);
1199 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1200 for (int i = 0; i < count; ++i)
1201 dispatch(lyxaction.lookupFunc(rest));
1205 case LFUN_SEQUENCE: {
1206 // argument contains ';'-terminated commands
1207 string arg = argument;
1208 while (!arg.empty()) {
1210 arg = split(arg, first, ';');
1211 dispatch(lyxaction.lookupFunc(first));
1216 case LFUN_SAVEPREFERENCES: {
1217 Path p(user_lyxdir());
1218 lyxrc.write("preferences", false);
1222 case LFUN_SCREEN_FONT_UPDATE:
1223 // handle the screen font changes.
1224 lyxrc.set_font_norm_type();
1225 lyx_gui::update_fonts();
1226 // All visible buffers will need resize
1230 case LFUN_SET_COLOR: {
1232 string const x11_name = split(argument, lyx_name, ' ');
1233 if (lyx_name.empty() || x11_name.empty()) {
1234 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1239 bool const graphicsbg_changed =
1240 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1241 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1243 if (!lcolor.setColor(lyx_name, x11_name)) {
1245 bformat(_("Set-color \"%1$s\" failed "
1246 "- color is undefined or "
1247 "may not be redefined"), lyx_name));
1251 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1253 if (graphicsbg_changed) {
1254 #ifdef WITH_WARNINGS
1255 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1258 lyx::graphics::GCache::get().changeDisplay(true);
1265 owner->message(argument);
1268 case LFUN_TOOLTIPS_TOGGLE:
1269 owner->getDialogs().toggleTooltips();
1272 case LFUN_EXTERNAL_EDIT: {
1273 FuncRequest fr(action, argument);
1274 InsetExternal().dispatch(view()->cursor(), fr);
1278 case LFUN_GRAPHICS_EDIT: {
1279 FuncRequest fr(action, argument);
1280 InsetGraphics().dispatch(view()->cursor(), fr);
1284 case LFUN_ALL_INSETS_TOGGLE: {
1286 string const name = split(argument, action, ' ');
1287 InsetBase::Code const inset_code =
1288 InsetBase::translate(name);
1290 LCursor & cur = view()->cursor();
1291 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1293 InsetBase & inset = owner->buffer()->inset();
1294 InsetIterator it = inset_iterator_begin(inset);
1295 InsetIterator const end = inset_iterator_end(inset);
1296 for (; it != end; ++it) {
1297 if (inset_code == InsetBase::NO_CODE
1298 || inset_code == it->lyxCode())
1299 it->dispatch(cur, fr);
1304 case LFUN_LANGUAGE_BUFFER: {
1305 Buffer & buffer = *owner->buffer();
1306 Language const * oldL = buffer.params().language;
1307 Language const * newL = languages.getLanguage(argument);
1308 if (!newL || oldL == newL)
1311 if (oldL->RightToLeft() == newL->RightToLeft()
1312 && !buffer.isMultiLingual())
1313 buffer.changeLanguage(oldL, newL);
1315 buffer.updateDocLang(newL);
1319 case LFUN_BUFFERPARAMS_APPLY: {
1320 biblio::CiteEngine const engine =
1321 owner->buffer()->params().cite_engine;
1323 istringstream ss(argument);
1326 int const unknown_tokens =
1327 owner->buffer()->readHeader(lex);
1329 if (unknown_tokens != 0) {
1330 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1331 << unknown_tokens << " unknown token"
1332 << (unknown_tokens == 1 ? "" : "s")
1335 if (engine == owner->buffer()->params().cite_engine)
1338 LCursor & cur = view()->cursor();
1339 FuncRequest fr(LFUN_INSET_REFRESH);
1341 InsetBase & inset = owner->buffer()->inset();
1342 InsetIterator it = inset_iterator_begin(inset);
1343 InsetIterator const end = inset_iterator_end(inset);
1344 for (; it != end; ++it)
1345 if (it->lyxCode() == InsetBase::CITE_CODE)
1346 it->dispatch(cur, fr);
1350 case LFUN_TEXTCLASS_APPLY: {
1351 Buffer * buffer = owner->buffer();
1353 lyx::textclass_type const old_class =
1354 buffer->params().textclass;
1356 loadTextclass(argument);
1358 std::pair<bool, lyx::textclass_type> const tc_pair =
1359 textclasslist.NumberOfClass(argument);
1364 lyx::textclass_type const new_class = tc_pair.second;
1365 if (old_class == new_class)
1369 owner->message(_("Converting document to new document class..."));
1371 lyx::cap::SwitchLayoutsBetweenClasses(
1372 old_class, new_class,
1373 buffer->paragraphs(), el);
1375 bufferErrors(*buffer, el);
1376 view()->showErrorList(_("Class switch"));
1380 case LFUN_TEXTCLASS_LOAD:
1381 loadTextclass(argument);
1384 case LFUN_LYXRC_APPLY: {
1385 istringstream ss(argument);
1386 bool const success = lyxrc.read(ss) == 0;
1389 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1390 << "Unable to read lyxrc data"
1398 DispatchResult res = view()->cursor().dispatch(cmd);
1399 if (res.dispatched())
1400 update |= res.update();
1402 update |= view()->dispatch(cmd);
1408 if (view()->available()) {
1409 if (view()->fitCursor() || update)
1411 // if we executed a mutating lfun, mark the buffer as dirty
1412 if (getStatus(cmd).enabled()
1413 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1414 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1415 view()->buffer()->markDirty();
1418 if (view()->cursor().inTexted()) {
1419 view()->owner()->updateLayoutChoice();
1420 sendDispatchMessage(getMessage(), cmd, verbose);
1426 void LyXFunc::sendDispatchMessage(string const & msg,
1427 FuncRequest const & cmd, bool verbose)
1429 owner->updateMenubar();
1430 owner->updateToolbars();
1432 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1433 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1435 owner->message(msg);
1439 string dispatch_msg = msg;
1440 if (!dispatch_msg.empty())
1441 dispatch_msg += ' ';
1443 string comname = lyxaction.getActionName(cmd.action);
1445 bool argsadded = false;
1447 if (!cmd.argument.empty()) {
1448 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1449 comname += ' ' + cmd.argument;
1454 string const shortcuts = toplevel_keymap->printbindings(cmd);
1456 if (!shortcuts.empty()) {
1457 comname += ": " + shortcuts;
1458 } else if (!argsadded && !cmd.argument.empty()) {
1459 comname += ' ' + cmd.argument;
1462 if (!comname.empty()) {
1463 comname = rtrim(comname);
1464 dispatch_msg += '(' + comname + ')';
1467 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1468 if (!dispatch_msg.empty())
1469 owner->message(dispatch_msg);
1473 void LyXFunc::setupLocalKeymap()
1475 keyseq.stdmap = toplevel_keymap.get();
1476 keyseq.curmap = toplevel_keymap.get();
1477 cancel_meta_seq.stdmap = toplevel_keymap.get();
1478 cancel_meta_seq.curmap = toplevel_keymap.get();
1482 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1484 string initpath = lyxrc.document_path;
1485 string filename(name);
1487 if (view()->available()) {
1488 string const trypath = owner->buffer()->filePath();
1489 // If directory is writeable, use this as default.
1490 if (IsDirWriteable(trypath))
1494 static int newfile_number;
1496 if (filename.empty()) {
1497 filename = AddName(lyxrc.document_path,
1498 "newfile" + tostr(++newfile_number) + ".lyx");
1499 FileInfo fi(filename);
1500 while (bufferlist.exists(filename) || fi.readable()) {
1502 filename = AddName(lyxrc.document_path,
1503 "newfile" + tostr(newfile_number) +
1505 fi.newFile(filename);
1509 // The template stuff
1512 FileDialog fileDlg(_("Select template file"),
1513 LFUN_SELECT_FILE_SYNC,
1514 make_pair(string(_("Documents|#o#O")),
1515 string(lyxrc.document_path)),
1516 make_pair(string(_("Templates|#T#t")),
1517 string(lyxrc.template_path)));
1519 FileDialog::Result result =
1520 fileDlg.open(lyxrc.template_path,
1521 FileFilterList(_("LyX Documents (*.lyx)")),
1524 if (result.first == FileDialog::Later)
1526 if (result.second.empty())
1528 templname = result.second;
1531 view()->newFile(filename, templname, !name.empty());
1535 void LyXFunc::open(string const & fname)
1537 string initpath = lyxrc.document_path;
1539 if (view()->available()) {
1540 string const trypath = owner->buffer()->filePath();
1541 // If directory is writeable, use this as default.
1542 if (IsDirWriteable(trypath))
1548 if (fname.empty()) {
1549 FileDialog fileDlg(_("Select document to open"),
1551 make_pair(string(_("Documents|#o#O")),
1552 string(lyxrc.document_path)),
1553 make_pair(string(_("Examples|#E#e")),
1554 string(AddPath(system_lyxdir(), "examples"))));
1556 FileDialog::Result result =
1557 fileDlg.open(initpath,
1558 FileFilterList(_("LyX Documents (*.lyx)")),
1561 if (result.first == FileDialog::Later)
1564 filename = result.second;
1566 // check selected filename
1567 if (filename.empty()) {
1568 owner->message(_("Canceled."));
1574 // get absolute path of file and add ".lyx" to the filename if
1576 string const fullpath = FileSearch(string(), filename, "lyx");
1577 if (!fullpath.empty()) {
1578 filename = fullpath;
1581 string const disp_fn(MakeDisplayPath(filename));
1583 // if the file doesn't exist, let the user create one
1584 FileInfo const f(filename, true);
1586 // the user specifically chose this name. Believe them.
1587 view()->newFile(filename, "", true);
1591 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1594 if (view()->loadLyXFile(filename)) {
1595 str2 = bformat(_("Document %1$s opened."), disp_fn);
1597 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1599 owner->message(str2);
1603 void LyXFunc::doImport(string const & argument)
1606 string filename = split(argument, format, ' ');
1608 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1609 << " file: " << filename << endl;
1611 // need user interaction
1612 if (filename.empty()) {
1613 string initpath = lyxrc.document_path;
1615 if (view()->available()) {
1616 string const trypath = owner->buffer()->filePath();
1617 // If directory is writeable, use this as default.
1618 if (IsDirWriteable(trypath))
1622 string const text = bformat(_("Select %1$s file to import"),
1623 formats.prettyName(format));
1625 FileDialog fileDlg(text,
1627 make_pair(string(_("Documents|#o#O")),
1628 string(lyxrc.document_path)),
1629 make_pair(string(_("Examples|#E#e")),
1630 string(AddPath(system_lyxdir(), "examples"))));
1632 string const filter = formats.prettyName(format)
1633 + " (*." + formats.extension(format) + ')';
1635 FileDialog::Result result =
1636 fileDlg.open(initpath,
1637 FileFilterList(filter),
1640 if (result.first == FileDialog::Later)
1643 filename = result.second;
1645 // check selected filename
1646 if (filename.empty())
1647 owner->message(_("Canceled."));
1650 if (filename.empty())
1653 // get absolute path of file
1654 filename = MakeAbsPath(filename);
1656 string const lyxfile = ChangeExtension(filename, ".lyx");
1658 // Check if the document already is open
1659 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1660 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1661 owner->message(_("Canceled."));
1666 // if the file exists already, and we didn't do
1667 // -i lyx thefile.lyx, warn
1668 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1669 string const file = MakeDisplayPath(lyxfile, 30);
1671 string text = bformat(_("The document %1$s already exists.\n\n"
1672 "Do you want to over-write that document?"), file);
1673 int const ret = Alert::prompt(_("Over-write document?"),
1674 text, 0, 1, _("&Over-write"), _("&Cancel"));
1677 owner->message(_("Canceled."));
1682 Importer::Import(owner, filename, format);
1686 void LyXFunc::closeBuffer()
1688 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1689 if (bufferlist.empty()) {
1690 // need this otherwise SEGV may occur while
1691 // trying to set variables that don't exist
1692 // since there's no current buffer
1693 owner->getDialogs().hideBufferDependent();
1695 view()->setBuffer(bufferlist.first());
1701 // Each "owner" should have it's own message method. lyxview and
1702 // the minibuffer would use the minibuffer, but lyxserver would
1703 // send an ERROR signal to its client. Alejandro 970603
1704 // This function is bit problematic when it comes to NLS, to make the
1705 // lyx servers client be language indepenent we must not translate
1706 // strings sent to this func.
1707 void LyXFunc::setErrorMessage(string const & m) const
1709 dispatch_buffer = m;
1714 void LyXFunc::setMessage(string const & m) const
1716 dispatch_buffer = m;
1720 void LyXFunc::setStatusMessage(string const & m) const
1726 string const LyXFunc::viewStatusMessage()
1728 // When meta-fake key is pressed, show the key sequence so far + "M-".
1730 return keyseq.print() + "M-";
1732 // Else, when a non-complete key sequence is pressed,
1733 // show the available options.
1734 if (keyseq.length() > 0 && !keyseq.deleted())
1735 return keyseq.printOptions();
1737 if (!view()->available())
1738 return _("Welcome to LyX!");
1740 return view()->cursor().currentState();
1744 BufferView * LyXFunc::view() const
1746 BOOST_ASSERT(owner);
1747 return owner->view().get();
1751 bool LyXFunc::wasMetaKey() const
1753 return (meta_fake_bit != key_modifier::none);