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/Toolbar.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;
132 extern BufferList bufferlist;
133 extern LyXServer * lyxserver;
134 extern bool selection_possible;
136 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
139 extern tex_accent_struct get_accent(kb_action action);
142 LyXFunc::LyXFunc(LyXView * lv)
145 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
146 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
147 meta_fake_bit(key_modifier::none)
152 void LyXFunc::handleKeyFunc(kb_action action)
154 char c = encoded_last_key;
156 if (keyseq.length()) {
160 owner->getIntl().getTransManager()
161 .deadkey(c, get_accent(action).accent, view()->getLyXText());
162 // Need to clear, in case the minibuffer calls these
165 // copied verbatim from do_accent_char
166 view()->cursor().resetAnchor();
171 void LyXFunc::processKeySym(LyXKeySymPtr keysym, key_modifier::state state)
173 lyxerr[Debug::KEY] << "KeySym is " << keysym->getSymbolName() << endl;
175 // Do nothing if we have nothing (JMarc)
176 if (!keysym->isOK()) {
177 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
182 if (keysym->isModifier()) {
183 lyxerr[Debug::KEY] << "isModifier true" << endl;
187 Encoding const * encoding = view()->cursor().getEncoding();
189 encoded_last_key = keysym->getISOEncoded(encoding ? encoding->Name() : "");
191 // Do a one-deep top-level lookup for
192 // cancel and meta-fake keys. RVDK_PATCH_5
193 cancel_meta_seq.reset();
195 FuncRequest func = cancel_meta_seq.addkey(keysym, state);
196 lyxerr[Debug::KEY] << "action first set to [" << func.action << ']' << endl;
198 // When not cancel or meta-fake, do the normal lookup.
199 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
200 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
201 if ((func.action != LFUN_CANCEL) && (func.action != LFUN_META_FAKE)) {
202 // remove Caps Lock and Mod2 as a modifiers
203 func = keyseq.addkey(keysym, (state | meta_fake_bit));
204 lyxerr[Debug::KEY] << "action now set to ["
205 << func.action << ']' << endl;
208 // Dont remove this unless you know what you are doing.
209 meta_fake_bit = key_modifier::none;
211 // can this happen now ?
212 if (func.action == LFUN_NOACTION) {
213 func = FuncRequest(LFUN_PREFIX);
216 if (lyxerr.debugging(Debug::KEY)) {
217 lyxerr << "Key [action="
218 << func.action << "]["
219 << keyseq.print() << ']'
223 // already here we know if it any point in going further
224 // why not return already here if action == -1 and
225 // num_bytes == 0? (Lgb)
227 if (keyseq.length() > 1) {
228 owner->message(keyseq.print());
232 // Maybe user can only reach the key via holding down shift.
233 // Let's see. But only if shift is the only modifier
234 if (func.action == LFUN_UNKNOWN_ACTION &&
235 state == key_modifier::shift) {
236 lyxerr[Debug::KEY] << "Trying without shift" << endl;
237 func = keyseq.addkey(keysym, key_modifier::none);
238 lyxerr[Debug::KEY] << "Action now " << func.action << endl;
241 if (func.action == LFUN_UNKNOWN_ACTION) {
242 // Hmm, we didn't match any of the keysequences. See
243 // if it's normal insertable text not already covered
245 if (keysym->isText() && keyseq.length() == 1) {
246 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
247 func = FuncRequest(LFUN_SELFINSERT);
249 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
250 owner->message(_("Unknown function."));
255 if (func.action == LFUN_SELFINSERT) {
256 if (encoded_last_key != 0) {
257 string arg(1, encoded_last_key);
258 dispatch(FuncRequest(LFUN_SELFINSERT, arg));
260 << "SelfInsert arg[`" << arg << "']" << endl;
268 FuncStatus LyXFunc::getStatus(FuncRequest const & cmd) const
270 //lyxerr << "LyXFunc::getStatus: cmd: " << cmd << endl;
272 Buffer * buf = owner->buffer();
273 LCursor & cur = view()->cursor();
275 if (cmd.action == LFUN_NOACTION) {
276 setStatusMessage(N_("Nothing to do"));
281 switch (cmd.action) {
282 case LFUN_UNKNOWN_ACTION:
283 #ifndef HAVE_LIBAIKSAURUS
284 case LFUN_THESAURUS_ENTRY:
290 flag |= lyx_gui::getStatus(cmd);
293 if (flag.unknown()) {
294 setStatusMessage(N_("Unknown action"));
298 // the default error message if we disable the command
299 setStatusMessage(N_("Command disabled"));
301 // Check whether we need a buffer
302 if (!lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer) && !buf) {
304 setStatusMessage(N_("Command not allowed with"
305 "out any document open"));
310 // I would really like to avoid having this switch and rather try to
311 // encode this in the function itself.
312 // -- And I'd rather let an inset decide which LFUNs it is willing
313 // to handle (Andre')
315 switch (cmd.action) {
316 case LFUN_TOOLTIPS_TOGGLE:
317 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
320 case LFUN_READ_ONLY_TOGGLE:
321 flag.setOnOff(buf->isReadonly());
324 case LFUN_SWITCHBUFFER:
325 // toggle on the current buffer, but do not toggle off
326 // the other ones (is that a good idea?)
327 if (cmd.argument == buf->fileName())
331 case LFUN_TRACK_CHANGES:
332 flag.setOnOff(buf->params().tracking_changes);
336 enable = cmd.argument == "custom"
337 || Exporter::IsExportable(*buf, cmd.argument);
340 enable = !buf->undostack().empty();
343 enable = !buf->redostack().empty();
347 enable = cur.selection();
351 enable = buf->isLatex() && lyxrc.chktex_command != "none";
355 enable = Exporter::IsExportable(*buf, "program");
358 case LFUN_LAYOUT_TABULAR:
359 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
363 case LFUN_LAYOUT_PARAGRAPH:
364 enable = !cur.inset().forceDefaultParagraphs(&cur.inset());
367 case LFUN_VC_REGISTER:
368 enable = !buf->lyxvc().inUse();
370 case LFUN_VC_CHECKIN:
371 enable = buf->lyxvc().inUse() && !buf->isReadonly();
373 case LFUN_VC_CHECKOUT:
374 enable = buf->lyxvc().inUse() && buf->isReadonly();
378 enable = buf->lyxvc().inUse();
380 case LFUN_MENURELOAD:
381 enable = !buf->isUnnamed() && !buf->isClean();
383 case LFUN_BOOKMARK_GOTO:
384 enable = view()->isSavedPosition(strToUnsignedInt(cmd.argument));
387 case LFUN_MERGE_CHANGES:
388 case LFUN_ACCEPT_CHANGE:
389 case LFUN_REJECT_CHANGE:
390 case LFUN_ACCEPT_ALL_CHANGES:
391 case LFUN_REJECT_ALL_CHANGES:
392 enable = buf && buf->params().tracking_changes;
395 case LFUN_INSET_SETTINGS: {
399 UpdatableInset * inset = cur.inset().asUpdatableInset();
400 lyxerr << "inset: " << inset << endl;
404 InsetOld::Code code = inset->lyxCode();
406 case InsetOld::TABULAR_CODE:
407 enable = cmd.argument == "tabular";
409 case InsetOld::ERT_CODE:
410 enable = cmd.argument == "ert";
412 case InsetOld::FLOAT_CODE:
413 enable = cmd.argument == "float";
415 case InsetOld::WRAP_CODE:
416 enable = cmd.argument == "wrap";
418 case InsetOld::NOTE_CODE:
419 enable = cmd.argument == "note";
421 case InsetOld::BRANCH_CODE:
422 enable = cmd.argument == "branch";
424 case InsetOld::BOX_CODE:
425 enable = cmd.argument == "box";
433 case LFUN_DIALOG_SHOW: {
434 string const name = cmd.getArg(0);
436 enable = name == "aboutlyx"
439 || name == "preferences"
440 || name == "texinfo";
441 else if (name == "print")
442 enable = Exporter::IsExportable(*buf, "dvi")
443 && lyxrc.print_command != "none";
444 else if (name == "character")
445 enable = cur.inset().lyxCode() != InsetOld::ERT_CODE;
446 else if (name == "vclog")
447 enable = buf->lyxvc().inUse();
448 else if (name == "latexlog")
449 enable = IsFileReadable(buf->getLogName().second);
454 case LFUN_MENUNEWTMPLT:
455 case LFUN_WORDFINDFORWARD:
456 case LFUN_WORDFINDBACKWARD:
458 case LFUN_EXEC_COMMAND:
461 case LFUN_CLOSEBUFFER:
470 case LFUN_RECONFIGURE:
474 case LFUN_DROP_LAYOUTS_CHOICE:
475 case LFUN_MENU_OPEN_BY_NAME:
478 case LFUN_GOTOFILEROW:
479 case LFUN_GOTO_PARAGRAPH:
480 case LFUN_DIALOG_SHOW_NEW_INSET:
481 case LFUN_DIALOG_SHOW_NEXT_INSET:
482 case LFUN_DIALOG_UPDATE:
483 case LFUN_DIALOG_HIDE:
484 case LFUN_DIALOG_DISCONNECT_INSET:
486 case LFUN_TOGGLECURSORFOLLOW:
490 case LFUN_KMAP_TOGGLE:
492 case LFUN_EXPORT_CUSTOM:
495 case LFUN_SAVEPREFERENCES:
496 case LFUN_SCREEN_FONT_UPDATE:
499 case LFUN_EXTERNAL_EDIT:
500 case LFUN_FILE_INSERT:
501 case LFUN_FILE_INSERT_ASCII:
502 case LFUN_FILE_INSERT_ASCII_PARA:
503 case LFUN_ALL_INSETS_TOGGLE:
504 case LFUN_LANGUAGE_BUFFER:
505 case LFUN_TEXTCLASS_APPLY:
506 case LFUN_TEXTCLASS_LOAD:
507 case LFUN_SAVE_AS_DEFAULT:
508 case LFUN_BUFFERPARAMS_APPLY:
510 // these are handled in our dispatch()
514 cur.getStatus(cmd, flag);
520 // Can we use a readonly buffer?
521 if (buf && buf->isReadonly()
522 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
523 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
524 setStatusMessage(N_("Document is read-only"));
534 bool ensureBufferClean(BufferView * bv)
536 Buffer & buf = *bv->buffer();
540 string const file = MakeDisplayPath(buf.fileName(), 30);
541 string text = bformat(_("The document %1$s has unsaved "
542 "changes.\n\nDo you want to save "
543 "the document?"), file);
544 int const ret = Alert::prompt(_("Save changed document?"),
545 text, 0, 1, _("&Save"),
549 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
551 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);
565 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
567 string const argument = cmd.argument;
568 kb_action const action = cmd.action;
570 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
571 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
573 // we have not done anything wrong yet.
575 dispatch_buffer.erase();
576 selection_possible = false;
578 // We cannot use this function here
579 if (!getStatus(cmd).enabled()) {
580 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
581 << lyxaction.getActionName(action)
582 << " [" << action << "] is disabled at this location"
584 setErrorMessage(getStatusMessage());
588 if (view()->available())
589 view()->hideCursor();
593 case LFUN_WORDFINDFORWARD:
594 case LFUN_WORDFINDBACKWARD: {
595 static string last_search;
596 string searched_string;
598 if (!argument.empty()) {
599 last_search = argument;
600 searched_string = argument;
602 searched_string = last_search;
605 if (searched_string.empty())
608 bool const fw = action == LFUN_WORDFINDFORWARD;
610 lyx::find::find2string(searched_string, true, false, fw);
611 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
616 owner->message(keyseq.printOptions());
619 case LFUN_EXEC_COMMAND:
620 owner->focus_command_buffer();
625 meta_fake_bit = key_modifier::none;
626 if (view()->available())
627 // cancel any selection
628 dispatch(FuncRequest(LFUN_MARK_OFF));
629 setMessage(N_("Cancel"));
633 meta_fake_bit = key_modifier::alt;
634 setMessage(keyseq.print());
637 case LFUN_READ_ONLY_TOGGLE:
638 if (owner->buffer()->lyxvc().inUse())
639 owner->buffer()->lyxvc().toggleReadOnly();
641 owner->buffer()->setReadonly(
642 !owner->buffer()->isReadonly());
645 // --- Menus -----------------------------------------------
647 menuNew(argument, false);
650 case LFUN_MENUNEWTMPLT:
651 menuNew(argument, true);
654 case LFUN_CLOSEBUFFER:
659 if (!owner->buffer()->isUnnamed()) {
660 string const str = bformat(_("Saving document %1$s..."),
661 MakeDisplayPath(owner->buffer()->fileName()));
663 MenuWrite(owner->buffer());
664 owner->message(str + _(" done."));
666 WriteAs(owner->buffer());
670 WriteAs(owner->buffer(), argument);
673 case LFUN_MENURELOAD: {
674 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
675 string text = bformat(_("Any changes will be lost. Are you sure "
676 "you want to revert to the saved version of the document %1$s?"), file);
677 int const ret = Alert::prompt(_("Revert to saved document?"),
678 text, 0, 1, _("&Revert"), _("&Cancel"));
686 Exporter::Export(owner->buffer(), argument, true);
687 view()->showErrorList(BufferFormat(*owner->buffer()));
691 Exporter::Preview(owner->buffer(), argument);
692 view()->showErrorList(BufferFormat(*owner->buffer()));
696 Exporter::Export(owner->buffer(), "program", true);
697 view()->showErrorList(_("Build"));
701 owner->buffer()->runChktex();
702 view()->showErrorList(_("ChkTeX"));
706 if (argument == "custom")
707 owner->getDialogs().show("sendto");
709 Exporter::Export(owner->buffer(), argument, false);
710 view()->showErrorList(BufferFormat(*owner->buffer()));
714 case LFUN_EXPORT_CUSTOM: {
716 string command = split(argument, format_name, ' ');
717 Format const * format = formats.getFormat(format_name);
719 lyxerr << "Format \"" << format_name
720 << "\" not recognized!"
725 Buffer * buffer = owner->buffer();
727 // The name of the file created by the conversion process
730 // Output to filename
731 if (format->name() == "lyx") {
732 string const latexname =
733 buffer->getLatexName(false);
734 filename = ChangeExtension(latexname,
735 format->extension());
736 filename = AddName(buffer->temppath(), filename);
738 if (!buffer->writeFile(filename))
742 Exporter::Export(buffer, format_name, true,
746 // Substitute $$FName for filename
747 if (!contains(command, "$$FName"))
748 command = "( " + command + " ) < $$FName";
749 command = subst(command, "$$FName", filename);
751 // Execute the command in the background
753 call.startscript(Systemcall::DontWait, command);
760 string command = split(split(argument, target, ' '),
764 || target_name.empty()
765 || command.empty()) {
766 lyxerr << "Unable to parse \""
767 << argument << '"' << std::endl;
770 if (target != "printer" && target != "file") {
771 lyxerr << "Unrecognized target \""
772 << target << '"' << std::endl;
776 Buffer * buffer = owner->buffer();
778 if (!Exporter::Export(buffer, "dvi", true)) {
779 showPrintError(buffer->fileName());
783 // Push directory path.
784 string const path = buffer->temppath();
787 // there are three cases here:
788 // 1. we print to a file
789 // 2. we print directly to a printer
790 // 3. we print using a spool command (print to file first)
793 string const dviname =
794 ChangeExtension(buffer->getLatexName(true),
797 if (target == "printer") {
798 if (!lyxrc.print_spool_command.empty()) {
799 // case 3: print using a spool
800 string const psname =
801 ChangeExtension(dviname,".ps");
802 command += lyxrc.print_to_file
805 + QuoteName(dviname);
808 lyxrc.print_spool_command +' ';
809 if (target_name != "default") {
810 command2 += lyxrc.print_spool_printerprefix
814 command2 += QuoteName(psname);
816 // If successful, then spool command
817 res = one.startscript(
822 res = one.startscript(
823 Systemcall::DontWait,
826 // case 2: print directly to a printer
827 res = one.startscript(
828 Systemcall::DontWait,
829 command + QuoteName(dviname));
833 // case 1: print to a file
834 command += lyxrc.print_to_file
835 + QuoteName(MakeAbsPath(target_name,
838 + QuoteName(dviname);
839 res = one.startscript(Systemcall::DontWait,
844 showPrintError(buffer->fileName());
857 InsetCommandParams p("tableofcontents");
858 string const data = InsetCommandMailer::params2string("toc", p);
859 owner->getDialogs().show("toc", data, 0);
867 case LFUN_RECONFIGURE:
871 case LFUN_HELP_OPEN: {
872 string const arg = argument;
874 setErrorMessage(N_("Missing argument"));
877 string const fname = i18nLibFileSearch("doc", arg, "lyx");
879 lyxerr << "LyX: unable to find documentation file `"
880 << arg << "'. Bad installation?" << endl;
883 owner->message(bformat(_("Opening help file %1$s..."),
884 MakeDisplayPath(fname)));
885 view()->loadLyXFile(fname, false);
889 // --- version control -------------------------------
890 case LFUN_VC_REGISTER:
891 if (!ensureBufferClean(view()))
893 if (!owner->buffer()->lyxvc().inUse()) {
894 owner->buffer()->lyxvc().registrer();
899 case LFUN_VC_CHECKIN:
900 if (!ensureBufferClean(view()))
902 if (owner->buffer()->lyxvc().inUse()
903 && !owner->buffer()->isReadonly()) {
904 owner->buffer()->lyxvc().checkIn();
909 case LFUN_VC_CHECKOUT:
910 if (!ensureBufferClean(view()))
912 if (owner->buffer()->lyxvc().inUse()
913 && owner->buffer()->isReadonly()) {
914 owner->buffer()->lyxvc().checkOut();
920 owner->buffer()->lyxvc().revert();
925 owner->buffer()->lyxvc().undoLast();
929 // --- buffers ----------------------------------------
930 case LFUN_SWITCHBUFFER:
931 view()->setBuffer(bufferlist.getBuffer(argument));
935 NewFile(view(), argument);
942 case LFUN_DROP_LAYOUTS_CHOICE:
943 owner->getToolbar().openLayoutList();
946 case LFUN_MENU_OPEN_BY_NAME:
947 owner->getMenubar().openByName(argument);
950 // --- lyxserver commands ----------------------------
952 setMessage(owner->buffer()->fileName());
953 lyxerr[Debug::INFO] << "FNAME["
954 << owner->buffer()->fileName()
959 dispatch_buffer = keyseq.print();
960 lyxserver->notifyClient(dispatch_buffer);
963 case LFUN_GOTOFILEROW: {
966 istringstream is(argument);
967 is >> file_name >> row;
968 if (prefixIs(file_name, getTmpDir())) {
969 // Needed by inverse dvi search. If it is a file
970 // in tmpdir, call the apropriated function
971 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
973 // Must replace extension of the file to be .lyx
975 string const s = ChangeExtension(file_name, ".lyx");
976 // Either change buffer or load the file
977 if (bufferlist.exists(s)) {
978 view()->setBuffer(bufferlist.getBuffer(s));
980 view()->loadLyXFile(s);
984 view()->setCursorFromRow(row);
987 // see BufferView_pimpl::center()
988 view()->updateScrollbar();
992 case LFUN_GOTO_PARAGRAPH: {
993 istringstream is(argument);
996 ParIterator par = owner->buffer()->getParFromID(id);
997 if (par == owner->buffer()->par_iterator_end()) {
998 lyxerr[Debug::INFO] << "No matching paragraph found! ["
999 << id << ']' << endl;
1002 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1003 << " found." << endl;
1007 view()->setCursor(par, 0);
1009 view()->switchKeyMap();
1010 owner->view_state_changed();
1013 // see BufferView_pimpl::center()
1014 view()->updateScrollbar();
1018 case LFUN_DIALOG_SHOW: {
1019 string const name = cmd.getArg(0);
1020 string data = trim(cmd.argument.substr(name.size()));
1022 if (name == "character") {
1023 data = freefont2string();
1025 owner->getDialogs().show("character", data);
1027 else if (name == "preamble")
1028 owner->getDialogs().showPreamble();
1029 else if (name == "preferences")
1030 owner->getDialogs().showPreferences();
1031 else if (name == "spellchecker")
1032 owner->getDialogs().showSpellchecker();
1034 else if (name == "latexlog") {
1035 pair<Buffer::LogType, string> const logfile =
1036 owner->buffer()->getLogName();
1037 switch (logfile.first) {
1038 case Buffer::latexlog:
1041 case Buffer::buildlog:
1045 data += logfile.second;
1046 owner->getDialogs().show("log", data);
1048 else if (name == "vclog") {
1049 string const data = "vc " +
1050 owner->buffer()->lyxvc().getLogFile();
1051 owner->getDialogs().show("log", data);
1054 owner->getDialogs().show(name, data);
1058 case LFUN_DIALOG_SHOW_NEW_INSET: {
1059 string const name = cmd.getArg(0);
1060 string data = trim(cmd.argument.substr(name.size()));
1061 if (name == "bibitem" ||
1063 name == "include" ||
1069 InsetCommandParams p(name);
1070 data = InsetCommandMailer::params2string(name, p);
1071 } else if (name == "box") {
1072 // \c data == "Boxed" || "Frameless" etc
1073 InsetBoxParams p(data);
1074 data = InsetBoxMailer::params2string(p);
1075 } else if (name == "branch") {
1076 InsetBranchParams p;
1077 data = InsetBranchMailer::params2string(p);
1078 } else if (name == "citation") {
1079 InsetCommandParams p("cite");
1080 data = InsetCommandMailer::params2string(name, p);
1081 } else if (name == "ert") {
1082 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1083 } else if (name == "external") {
1084 InsetExternalParams p;
1085 Buffer const & buffer = *owner->buffer();
1086 data = InsetExternalMailer::params2string(p, buffer);
1087 } else if (name == "float") {
1089 data = InsetFloatMailer::params2string(p);
1090 } else if (name == "graphics") {
1091 InsetGraphicsParams p;
1092 Buffer const & buffer = *owner->buffer();
1093 data = InsetGraphicsMailer::params2string(p, buffer);
1094 } else if (name == "note") {
1096 data = InsetNoteMailer::params2string(p);
1097 } else if (name == "vspace") {
1099 data = InsetVSpaceMailer::params2string(space);
1100 } else if (name == "wrap") {
1102 data = InsetWrapMailer::params2string(p);
1104 owner->getDialogs().show(name, data, 0);
1108 case LFUN_DIALOG_SHOW_NEXT_INSET:
1111 case LFUN_DIALOG_UPDATE: {
1112 string const & name = argument;
1113 // Can only update a dialog connected to an existing inset
1114 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1116 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1117 inset->dispatch(view()->cursor(), fr);
1118 } else if (name == "paragraph") {
1119 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1124 case LFUN_DIALOG_HIDE:
1125 Dialogs::hide(argument, 0);
1128 case LFUN_DIALOG_DISCONNECT_INSET:
1129 owner->getDialogs().disconnect(argument);
1132 case LFUN_CHILDOPEN: {
1133 string const filename =
1134 MakeAbsPath(argument, owner->buffer()->filePath());
1135 setMessage(N_("Opening child document ") +
1136 MakeDisplayPath(filename) + "...");
1137 view()->savePosition(0);
1138 string const parentfilename = owner->buffer()->fileName();
1139 if (bufferlist.exists(filename))
1140 view()->setBuffer(bufferlist.getBuffer(filename));
1142 view()->loadLyXFile(filename);
1143 // Set the parent name of the child document.
1144 // This makes insertion of citations and references in the child work,
1145 // when the target is in the parent or another child document.
1146 owner->buffer()->setParentName(parentfilename);
1150 case LFUN_TOGGLECURSORFOLLOW:
1151 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1155 owner->getIntl().KeyMapOn(false);
1158 case LFUN_KMAP_PRIM:
1159 owner->getIntl().KeyMapPrim();
1163 owner->getIntl().KeyMapSec();
1166 case LFUN_KMAP_TOGGLE:
1167 owner->getIntl().ToggleKeyMap();
1173 string rest = split(argument, countstr, ' ');
1174 istringstream is(countstr);
1177 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1178 for (int i = 0; i < count; ++i)
1179 dispatch(lyxaction.lookupFunc(rest));
1184 // argument contains ';'-terminated commands
1185 while (!argument.empty()) {
1187 string rest = split(argument, first, ';');
1188 dispatch(lyxaction.lookupFunc(rest));
1192 case LFUN_SAVEPREFERENCES: {
1193 Path p(user_lyxdir());
1194 lyxrc.write("preferences");
1198 case LFUN_SCREEN_FONT_UPDATE:
1199 // handle the screen font changes.
1200 lyxrc.set_font_norm_type();
1201 lyx_gui::update_fonts();
1202 // All visible buffers will need resize
1206 case LFUN_SET_COLOR: {
1208 string const x11_name = split(argument, lyx_name, ' ');
1209 if (lyx_name.empty() || x11_name.empty()) {
1210 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1215 bool const graphicsbg_changed =
1216 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1217 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1219 if (!lcolor.setColor(lyx_name, x11_name)) {
1221 bformat(_("Set-color \"%1$s\" failed "
1222 "- color is undefined or "
1223 "may not be redefined"), lyx_name));
1227 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1229 if (graphicsbg_changed) {
1230 #ifdef WITH_WARNINGS
1231 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1234 lyx::graphics::GCache::get().changeDisplay(true);
1241 owner->message(argument);
1244 case LFUN_TOOLTIPS_TOGGLE:
1245 owner->getDialogs().toggleTooltips();
1248 case LFUN_EXTERNAL_EDIT: {
1249 FuncRequest fr(action, argument);
1250 InsetExternal().dispatch(view()->cursor(), fr);
1254 case LFUN_BREAKLINE: {
1255 #warning swallow 'Return' if the minibuffer is focused. But how?
1259 case LFUN_ALL_INSETS_TOGGLE: {
1261 string const name = split(argument, action, ' ');
1262 InsetBase::Code const inset_code =
1263 InsetBase::translate(name);
1265 LCursor & cur = view()->cursor();
1266 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1268 InsetBase & inset = owner->buffer()->inset();
1269 InsetIterator it = inset_iterator_begin(inset);
1270 InsetIterator const end = inset_iterator_end(inset);
1271 for (; it != end; ++it) {
1272 if (inset_code == InsetBase::NO_CODE
1273 || inset_code == it->lyxCode())
1274 it->dispatch(cur, fr);
1279 case LFUN_LANGUAGE_BUFFER: {
1280 Buffer & buffer = *owner->buffer();
1281 Language const * oldL = buffer.params().language;
1282 Language const * newL = languages.getLanguage(argument);
1283 if (!newL || oldL == newL)
1286 if (oldL->RightToLeft() == newL->RightToLeft()
1287 && !buffer.isMultiLingual())
1288 buffer.changeLanguage(oldL, newL);
1290 buffer.updateDocLang(newL);
1294 case LFUN_BUFFERPARAMS_APPLY: {
1295 istringstream ss(argument);
1298 int const unknown_tokens =
1299 owner->buffer()->readHeader(lex);
1301 if (unknown_tokens != 0) {
1302 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1303 << unknown_tokens << " unknown token"
1304 << (unknown_tokens == 1 ? "" : "s")
1310 case LFUN_TEXTCLASS_APPLY: {
1311 Buffer * buffer = owner->buffer();
1313 lyx::textclass_type const old_class =
1314 buffer->params().textclass;
1316 dispatch(FuncRequest(LFUN_TEXTCLASS_LOAD, argument));
1318 std::pair<bool, lyx::textclass_type> const tc_pair =
1319 textclasslist.NumberOfClass(argument);
1324 lyx::textclass_type const new_class = tc_pair.second;
1325 if (old_class == new_class)
1330 _("Converting document to new document class..."));
1333 lyx::cap::SwitchLayoutsBetweenClasses(
1334 old_class, new_class,
1335 buffer->paragraphs(), el);
1337 bufferErrors(*buffer, el);
1338 view()->showErrorList(_("Class switch"));
1342 case LFUN_TEXTCLASS_LOAD: {
1343 std::pair<bool, lyx::textclass_type> const tc_pair =
1344 textclasslist.NumberOfClass(argument);
1346 if (!tc_pair.first) {
1347 lyxerr << "Document class \"" << argument
1348 << "\" does not exist."
1353 lyx::textclass_type const tc = tc_pair.second;
1355 bool const success = textclasslist[tc].load();
1359 string s = bformat(_("The document could not be converted\n"
1360 "into the document class %1$s."),
1361 textclasslist[tc].name());
1362 Alert::error(_("Could not change class"), s);
1368 DispatchResult res = view()->cursor().dispatch(cmd);
1369 if (!res.dispatched());
1370 view()->dispatch(cmd);
1375 if (view()->available()) {
1376 view()->fitCursor();
1378 view()->cursor().updatePos();
1379 // if we executed a mutating lfun, mark the buffer as dirty
1380 if (getStatus(cmd).enabled()
1381 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1382 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1383 view()->buffer()->markDirty();
1386 if (view()->cursor().inTexted()) {
1387 view()->owner()->updateLayoutChoice();
1388 sendDispatchMessage(getMessage(), cmd, verbose);
1394 void LyXFunc::sendDispatchMessage(string const & msg,
1395 FuncRequest const & cmd, bool verbose)
1397 owner->updateMenubar();
1398 owner->updateToolbar();
1400 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1401 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1403 owner->message(msg);
1407 string dispatch_msg = msg;
1408 if (!dispatch_msg.empty())
1409 dispatch_msg += ' ';
1411 string comname = lyxaction.getActionName(cmd.action);
1413 bool argsadded = false;
1415 if (!cmd.argument.empty()) {
1416 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1417 comname += ' ' + cmd.argument;
1422 string const shortcuts = toplevel_keymap->findbinding(cmd);
1424 if (!shortcuts.empty()) {
1425 comname += ": " + shortcuts;
1426 } else if (!argsadded && !cmd.argument.empty()) {
1427 comname += ' ' + cmd.argument;
1430 if (!comname.empty()) {
1431 comname = rtrim(comname);
1432 dispatch_msg += '(' + comname + ')';
1435 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1436 if (!dispatch_msg.empty())
1437 owner->message(dispatch_msg);
1441 void LyXFunc::setupLocalKeymap()
1443 keyseq.stdmap = toplevel_keymap.get();
1444 keyseq.curmap = toplevel_keymap.get();
1445 cancel_meta_seq.stdmap = toplevel_keymap.get();
1446 cancel_meta_seq.curmap = toplevel_keymap.get();
1450 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1452 string initpath = lyxrc.document_path;
1453 string filename(name);
1455 if (view()->available()) {
1456 string const trypath = owner->buffer()->filePath();
1457 // If directory is writeable, use this as default.
1458 if (IsDirWriteable(trypath))
1462 static int newfile_number;
1464 if (filename.empty()) {
1465 filename = AddName(lyxrc.document_path,
1466 "newfile" + tostr(++newfile_number) + ".lyx");
1467 FileInfo fi(filename);
1468 while (bufferlist.exists(filename) || fi.readable()) {
1470 filename = AddName(lyxrc.document_path,
1471 "newfile" + tostr(newfile_number) +
1473 fi.newFile(filename);
1477 // The template stuff
1480 FileDialog fileDlg(_("Select template file"),
1481 LFUN_SELECT_FILE_SYNC,
1482 make_pair(string(_("Documents|#o#O")),
1483 string(lyxrc.document_path)),
1484 make_pair(string(_("Templates|#T#t")),
1485 string(lyxrc.template_path)));
1487 FileDialog::Result result =
1488 fileDlg.open(lyxrc.template_path,
1489 FileFilterList(_("LyX Documents (*.lyx)")),
1492 if (result.first == FileDialog::Later)
1494 if (result.second.empty())
1496 templname = result.second;
1499 view()->newFile(filename, templname, !name.empty());
1503 void LyXFunc::open(string const & fname)
1505 string initpath = lyxrc.document_path;
1507 if (view()->available()) {
1508 string const trypath = owner->buffer()->filePath();
1509 // If directory is writeable, use this as default.
1510 if (IsDirWriteable(trypath))
1516 if (fname.empty()) {
1517 FileDialog fileDlg(_("Select document to open"),
1519 make_pair(string(_("Documents|#o#O")),
1520 string(lyxrc.document_path)),
1521 make_pair(string(_("Examples|#E#e")),
1522 string(AddPath(system_lyxdir(), "examples"))));
1524 FileDialog::Result result =
1525 fileDlg.open(initpath,
1526 FileFilterList(_("LyX Documents (*.lyx)")),
1529 if (result.first == FileDialog::Later)
1532 filename = result.second;
1534 // check selected filename
1535 if (filename.empty()) {
1536 owner->message(_("Canceled."));
1542 // get absolute path of file and add ".lyx" to the filename if
1544 string const fullpath = FileSearch(string(), filename, "lyx");
1545 if (!fullpath.empty()) {
1546 filename = fullpath;
1549 string const disp_fn(MakeDisplayPath(filename));
1551 // if the file doesn't exist, let the user create one
1552 FileInfo const f(filename, true);
1554 // the user specifically chose this name. Believe them.
1555 view()->newFile(filename, "", true);
1559 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1562 if (view()->loadLyXFile(filename)) {
1563 str2 = bformat(_("Document %1$s opened."), disp_fn);
1565 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1567 owner->message(str2);
1571 void LyXFunc::doImport(string const & argument)
1574 string filename = split(argument, format, ' ');
1576 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1577 << " file: " << filename << endl;
1579 // need user interaction
1580 if (filename.empty()) {
1581 string initpath = lyxrc.document_path;
1583 if (view()->available()) {
1584 string const trypath = owner->buffer()->filePath();
1585 // If directory is writeable, use this as default.
1586 if (IsDirWriteable(trypath))
1590 string const text = bformat(_("Select %1$s file to import"),
1591 formats.prettyName(format));
1593 FileDialog fileDlg(text,
1595 make_pair(string(_("Documents|#o#O")),
1596 string(lyxrc.document_path)),
1597 make_pair(string(_("Examples|#E#e")),
1598 string(AddPath(system_lyxdir(), "examples"))));
1600 string const filter = formats.prettyName(format)
1601 + " (*." + formats.extension(format) + ')';
1603 FileDialog::Result result =
1604 fileDlg.open(initpath,
1605 FileFilterList(filter),
1608 if (result.first == FileDialog::Later)
1611 filename = result.second;
1613 // check selected filename
1614 if (filename.empty())
1615 owner->message(_("Canceled."));
1618 if (filename.empty())
1621 // get absolute path of file
1622 filename = MakeAbsPath(filename);
1624 string const lyxfile = ChangeExtension(filename, ".lyx");
1626 // Check if the document already is open
1627 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1628 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1629 owner->message(_("Canceled."));
1634 // if the file exists already, and we didn't do
1635 // -i lyx thefile.lyx, warn
1636 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1637 string const file = MakeDisplayPath(lyxfile, 30);
1639 string text = bformat(_("The document %1$s already exists.\n\n"
1640 "Do you want to over-write that document?"), file);
1641 int const ret = Alert::prompt(_("Over-write document?"),
1642 text, 0, 1, _("&Over-write"), _("&Cancel"));
1645 owner->message(_("Canceled."));
1650 Importer::Import(owner, filename, format);
1654 void LyXFunc::closeBuffer()
1656 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1657 if (bufferlist.empty()) {
1658 // need this otherwise SEGV may occur while
1659 // trying to set variables that don't exist
1660 // since there's no current buffer
1661 owner->getDialogs().hideBufferDependent();
1663 view()->setBuffer(bufferlist.first());
1669 // Each "owner" should have it's own message method. lyxview and
1670 // the minibuffer would use the minibuffer, but lyxserver would
1671 // send an ERROR signal to its client. Alejandro 970603
1672 // This function is bit problematic when it comes to NLS, to make the
1673 // lyx servers client be language indepenent we must not translate
1674 // strings sent to this func.
1675 void LyXFunc::setErrorMessage(string const & m) const
1677 dispatch_buffer = m;
1682 void LyXFunc::setMessage(string const & m) const
1684 dispatch_buffer = m;
1688 void LyXFunc::setStatusMessage(string const & m) const
1694 string const LyXFunc::viewStatusMessage()
1696 // When meta-fake key is pressed, show the key sequence so far + "M-".
1698 return keyseq.print() + "M-";
1700 // Else, when a non-complete key sequence is pressed,
1701 // show the available options.
1702 if (keyseq.length() > 0 && !keyseq.deleted())
1703 return keyseq.printOptions();
1705 if (!view()->available())
1706 return _("Welcome to LyX!");
1708 return view()->cursor().currentState();
1712 BufferView * LyXFunc::view() const
1714 BOOST_ASSERT(owner);
1715 return owner->view().get();
1719 bool LyXFunc::wasMetaKey() const
1721 return (meta_fake_bit != key_modifier::none);