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())
332 enable = cmd.argument == "custom"
333 || Exporter::IsExportable(*buf, cmd.argument);
337 enable = cur.selection();
341 enable = buf->isLatex() && lyxrc.chktex_command != "none";
345 enable = Exporter::IsExportable(*buf, "program");
348 case LFUN_LAYOUT_TABULAR:
349 enable = cur.innerInsetOfType(InsetBase::TABULAR_CODE);
353 case LFUN_LAYOUT_PARAGRAPH:
354 enable = !cur.inset().forceDefaultParagraphs(&cur.inset());
357 case LFUN_VC_REGISTER:
358 enable = !buf->lyxvc().inUse();
360 case LFUN_VC_CHECKIN:
361 enable = buf->lyxvc().inUse() && !buf->isReadonly();
363 case LFUN_VC_CHECKOUT:
364 enable = buf->lyxvc().inUse() && buf->isReadonly();
368 enable = buf->lyxvc().inUse();
370 case LFUN_MENURELOAD:
371 enable = !buf->isUnnamed() && !buf->isClean();
375 case LFUN_INSET_SETTINGS: {
379 UpdatableInset * inset = cur.inset().asUpdatableInset();
380 lyxerr << "inset: " << inset << endl;
384 InsetOld::Code code = inset->lyxCode();
386 case InsetOld::TABULAR_CODE:
387 enable = cmd.argument == "tabular";
389 case InsetOld::ERT_CODE:
390 enable = cmd.argument == "ert";
392 case InsetOld::FLOAT_CODE:
393 enable = cmd.argument == "float";
395 case InsetOld::WRAP_CODE:
396 enable = cmd.argument == "wrap";
398 case InsetOld::NOTE_CODE:
399 enable = cmd.argument == "note";
401 case InsetOld::BRANCH_CODE:
402 enable = cmd.argument == "branch";
404 case InsetOld::BOX_CODE:
405 enable = cmd.argument == "box";
413 case LFUN_DIALOG_SHOW: {
414 string const name = cmd.getArg(0);
416 enable = name == "aboutlyx"
420 || name == "texinfo";
421 else if (name == "print")
422 enable = Exporter::IsExportable(*buf, "dvi")
423 && lyxrc.print_command != "none";
424 else if (name == "character")
425 enable = cur.inset().lyxCode() != InsetOld::ERT_CODE;
426 else if (name == "vclog")
427 enable = buf->lyxvc().inUse();
428 else if (name == "latexlog")
429 enable = IsFileReadable(buf->getLogName().second);
433 case LFUN_DIALOG_UPDATE: {
434 string const name = cmd.getArg(0);
436 enable = name == "prefs";
441 case LFUN_MENUNEWTMPLT:
442 case LFUN_WORDFINDFORWARD:
443 case LFUN_WORDFINDBACKWARD:
445 case LFUN_EXEC_COMMAND:
448 case LFUN_CLOSEBUFFER:
457 case LFUN_RECONFIGURE:
461 case LFUN_DROP_LAYOUTS_CHOICE:
462 case LFUN_MENU_OPEN_BY_NAME:
465 case LFUN_GOTOFILEROW:
466 case LFUN_GOTO_PARAGRAPH:
467 case LFUN_DIALOG_SHOW_NEW_INSET:
468 case LFUN_DIALOG_SHOW_NEXT_INSET:
469 case LFUN_DIALOG_HIDE:
470 case LFUN_DIALOG_DISCONNECT_INSET:
472 case LFUN_TOGGLECURSORFOLLOW:
476 case LFUN_KMAP_TOGGLE:
478 case LFUN_EXPORT_CUSTOM:
481 case LFUN_SAVEPREFERENCES:
482 case LFUN_SCREEN_FONT_UPDATE:
485 case LFUN_EXTERNAL_EDIT:
486 case LFUN_ALL_INSETS_TOGGLE:
487 case LFUN_LANGUAGE_BUFFER:
488 case LFUN_TEXTCLASS_APPLY:
489 case LFUN_TEXTCLASS_LOAD:
490 case LFUN_SAVE_AS_DEFAULT:
491 case LFUN_BUFFERPARAMS_APPLY:
492 case LFUN_LYXRC_APPLY:
493 // these are handled in our dispatch()
498 cur.getStatus(cmd, flag);
500 flag = view()->getStatus(cmd);
506 // Can we use a readonly buffer?
507 if (buf && buf->isReadonly()
508 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
509 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
510 setStatusMessage(N_("Document is read-only"));
514 //lyxerr << "LyXFunc::getStatus: got: " << flag.enabled() << endl;
521 bool ensureBufferClean(BufferView * bv)
523 Buffer & buf = *bv->buffer();
527 string const file = MakeDisplayPath(buf.fileName(), 30);
528 string text = bformat(_("The document %1$s has unsaved "
529 "changes.\n\nDo you want to save "
530 "the document?"), file);
531 int const ret = Alert::prompt(_("Save changed document?"),
532 text, 0, 1, _("&Save"),
536 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
538 return buf.isClean();
542 void showPrintError(string const & name)
544 string str = bformat(_("Could not print the document %1$s.\n"
545 "Check that your printer is set up correctly."),
546 MakeDisplayPath(name, 50));
547 Alert::error(_("Print document failed"), str);
551 void loadTextclass(string const & name)
553 std::pair<bool, lyx::textclass_type> const tc_pair =
554 textclasslist.NumberOfClass(name);
556 if (!tc_pair.first) {
557 lyxerr << "Document class \"" << name
558 << "\" does not exist."
563 lyx::textclass_type const tc = tc_pair.second;
565 if (!textclasslist[tc].load()) {
566 string s = bformat(_("The document could not be converted\n"
567 "into the document class %1$s."),
568 textclasslist[tc].name());
569 Alert::error(_("Could not change class"), s);
576 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
578 string const argument = cmd.argument;
579 kb_action const action = cmd.action;
581 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
582 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
584 // we have not done anything wrong yet.
586 dispatch_buffer.erase();
587 selection_possible = false;
591 // We cannot use this function here
592 if (!getStatus(cmd).enabled()) {
593 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
594 << lyxaction.getActionName(action)
595 << " [" << action << "] is disabled at this location"
597 setErrorMessage(getStatusMessage());
601 if (view()->available())
602 view()->hideCursor();
606 case LFUN_WORDFINDFORWARD:
607 case LFUN_WORDFINDBACKWARD: {
608 static string last_search;
609 string searched_string;
611 if (!argument.empty()) {
612 last_search = argument;
613 searched_string = argument;
615 searched_string = last_search;
618 if (searched_string.empty())
621 bool const fw = action == LFUN_WORDFINDFORWARD;
623 lyx::find::find2string(searched_string, true, false, fw);
624 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
629 owner->message(keyseq.printOptions());
632 case LFUN_EXEC_COMMAND:
633 owner->focus_command_buffer();
638 meta_fake_bit = key_modifier::none;
639 if (view()->available())
640 // cancel any selection
641 dispatch(FuncRequest(LFUN_MARK_OFF));
642 setMessage(N_("Cancel"));
646 meta_fake_bit = key_modifier::alt;
647 setMessage(keyseq.print());
650 case LFUN_READ_ONLY_TOGGLE:
651 if (owner->buffer()->lyxvc().inUse())
652 owner->buffer()->lyxvc().toggleReadOnly();
654 owner->buffer()->setReadonly(
655 !owner->buffer()->isReadonly());
658 // --- Menus -----------------------------------------------
660 menuNew(argument, false);
663 case LFUN_MENUNEWTMPLT:
664 menuNew(argument, true);
667 case LFUN_CLOSEBUFFER:
672 if (!owner->buffer()->isUnnamed()) {
673 string const str = bformat(_("Saving document %1$s..."),
674 MakeDisplayPath(owner->buffer()->fileName()));
676 MenuWrite(owner->buffer());
677 owner->message(str + _(" done."));
679 WriteAs(owner->buffer());
683 WriteAs(owner->buffer(), argument);
686 case LFUN_MENURELOAD: {
687 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
688 string text = bformat(_("Any changes will be lost. Are you sure "
689 "you want to revert to the saved version of the document %1$s?"), file);
690 int const ret = Alert::prompt(_("Revert to saved document?"),
691 text, 0, 1, _("&Revert"), _("&Cancel"));
699 Exporter::Export(owner->buffer(), argument, true);
700 view()->showErrorList(BufferFormat(*owner->buffer()));
704 Exporter::Preview(owner->buffer(), argument);
705 view()->showErrorList(BufferFormat(*owner->buffer()));
709 Exporter::Export(owner->buffer(), "program", true);
710 view()->showErrorList(_("Build"));
714 owner->buffer()->runChktex();
715 view()->showErrorList(_("ChkTeX"));
719 if (argument == "custom")
720 owner->getDialogs().show("sendto");
722 Exporter::Export(owner->buffer(), argument, false);
723 view()->showErrorList(BufferFormat(*owner->buffer()));
727 case LFUN_EXPORT_CUSTOM: {
729 string command = split(argument, format_name, ' ');
730 Format const * format = formats.getFormat(format_name);
732 lyxerr << "Format \"" << format_name
733 << "\" not recognized!"
738 Buffer * buffer = owner->buffer();
740 // The name of the file created by the conversion process
743 // Output to filename
744 if (format->name() == "lyx") {
745 string const latexname =
746 buffer->getLatexName(false);
747 filename = ChangeExtension(latexname,
748 format->extension());
749 filename = AddName(buffer->temppath(), filename);
751 if (!buffer->writeFile(filename))
755 Exporter::Export(buffer, format_name, true,
759 // Substitute $$FName for filename
760 if (!contains(command, "$$FName"))
761 command = "( " + command + " ) < $$FName";
762 command = subst(command, "$$FName", filename);
764 // Execute the command in the background
766 call.startscript(Systemcall::DontWait, command);
773 string command = split(split(argument, target, ' '),
777 || target_name.empty()
778 || command.empty()) {
779 lyxerr << "Unable to parse \""
780 << argument << '"' << std::endl;
783 if (target != "printer" && target != "file") {
784 lyxerr << "Unrecognized target \""
785 << target << '"' << std::endl;
789 Buffer * buffer = owner->buffer();
791 if (!Exporter::Export(buffer, "dvi", true)) {
792 showPrintError(buffer->fileName());
796 // Push directory path.
797 string const path = buffer->temppath();
800 // there are three cases here:
801 // 1. we print to a file
802 // 2. we print directly to a printer
803 // 3. we print using a spool command (print to file first)
806 string const dviname =
807 ChangeExtension(buffer->getLatexName(true),
810 if (target == "printer") {
811 if (!lyxrc.print_spool_command.empty()) {
812 // case 3: print using a spool
813 string const psname =
814 ChangeExtension(dviname,".ps");
815 command += lyxrc.print_to_file
818 + QuoteName(dviname);
821 lyxrc.print_spool_command +' ';
822 if (target_name != "default") {
823 command2 += lyxrc.print_spool_printerprefix
827 command2 += QuoteName(psname);
829 // If successful, then spool command
830 res = one.startscript(
835 res = one.startscript(
836 Systemcall::DontWait,
839 // case 2: print directly to a printer
840 res = one.startscript(
841 Systemcall::DontWait,
842 command + QuoteName(dviname));
846 // case 1: print to a file
847 command += lyxrc.print_to_file
848 + QuoteName(MakeAbsPath(target_name,
851 + QuoteName(dviname);
852 res = one.startscript(Systemcall::DontWait,
857 showPrintError(buffer->fileName());
870 InsetCommandParams p("tableofcontents");
871 string const data = InsetCommandMailer::params2string("toc", p);
872 owner->getDialogs().show("toc", data, 0);
880 case LFUN_RECONFIGURE:
884 case LFUN_HELP_OPEN: {
885 string const arg = argument;
887 setErrorMessage(N_("Missing argument"));
890 string const fname = i18nLibFileSearch("doc", arg, "lyx");
892 lyxerr << "LyX: unable to find documentation file `"
893 << arg << "'. Bad installation?" << endl;
896 owner->message(bformat(_("Opening help file %1$s..."),
897 MakeDisplayPath(fname)));
898 view()->loadLyXFile(fname, false);
902 // --- version control -------------------------------
903 case LFUN_VC_REGISTER:
904 if (!ensureBufferClean(view()))
906 if (!owner->buffer()->lyxvc().inUse()) {
907 owner->buffer()->lyxvc().registrer();
912 case LFUN_VC_CHECKIN:
913 if (!ensureBufferClean(view()))
915 if (owner->buffer()->lyxvc().inUse()
916 && !owner->buffer()->isReadonly()) {
917 owner->buffer()->lyxvc().checkIn();
922 case LFUN_VC_CHECKOUT:
923 if (!ensureBufferClean(view()))
925 if (owner->buffer()->lyxvc().inUse()
926 && owner->buffer()->isReadonly()) {
927 owner->buffer()->lyxvc().checkOut();
933 owner->buffer()->lyxvc().revert();
938 owner->buffer()->lyxvc().undoLast();
942 // --- buffers ----------------------------------------
943 case LFUN_SWITCHBUFFER:
944 view()->setBuffer(bufferlist.getBuffer(argument));
948 NewFile(view(), argument);
955 case LFUN_DROP_LAYOUTS_CHOICE:
956 owner->getToolbar().openLayoutList();
959 case LFUN_MENU_OPEN_BY_NAME:
960 owner->getMenubar().openByName(argument);
963 // --- lyxserver commands ----------------------------
965 setMessage(owner->buffer()->fileName());
966 lyxerr[Debug::INFO] << "FNAME["
967 << owner->buffer()->fileName()
972 dispatch_buffer = keyseq.print();
973 lyxserver->notifyClient(dispatch_buffer);
976 case LFUN_GOTOFILEROW: {
979 istringstream is(argument);
980 is >> file_name >> row;
981 if (prefixIs(file_name, getTmpDir())) {
982 // Needed by inverse dvi search. If it is a file
983 // in tmpdir, call the apropriated function
984 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
986 // Must replace extension of the file to be .lyx
988 string const s = ChangeExtension(file_name, ".lyx");
989 // Either change buffer or load the file
990 if (bufferlist.exists(s)) {
991 view()->setBuffer(bufferlist.getBuffer(s));
993 view()->loadLyXFile(s);
997 view()->setCursorFromRow(row);
1000 // see BufferView_pimpl::center()
1001 view()->updateScrollbar();
1005 case LFUN_GOTO_PARAGRAPH: {
1006 istringstream is(argument);
1009 ParIterator par = owner->buffer()->getParFromID(id);
1010 if (par == owner->buffer()->par_iterator_end()) {
1011 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1012 << id << ']' << endl;
1015 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1016 << " found." << endl;
1020 view()->setCursor(par, 0);
1022 view()->switchKeyMap();
1023 owner->view_state_changed();
1026 // see BufferView_pimpl::center()
1027 view()->updateScrollbar();
1031 case LFUN_DIALOG_SHOW: {
1032 string const name = cmd.getArg(0);
1033 string data = trim(cmd.argument.substr(name.size()));
1035 if (name == "character") {
1036 data = freefont2string();
1038 owner->getDialogs().show("character", data);
1041 else if (name == "latexlog") {
1042 pair<Buffer::LogType, string> const logfile =
1043 owner->buffer()->getLogName();
1044 switch (logfile.first) {
1045 case Buffer::latexlog:
1048 case Buffer::buildlog:
1052 data += logfile.second;
1053 owner->getDialogs().show("log", data);
1055 else if (name == "vclog") {
1056 string const data = "vc " +
1057 owner->buffer()->lyxvc().getLogFile();
1058 owner->getDialogs().show("log", data);
1061 owner->getDialogs().show(name, data);
1065 case LFUN_DIALOG_SHOW_NEW_INSET: {
1066 string const name = cmd.getArg(0);
1067 string data = trim(cmd.argument.substr(name.size()));
1068 if (name == "bibitem" ||
1070 name == "include" ||
1076 InsetCommandParams p(name);
1077 data = InsetCommandMailer::params2string(name, p);
1078 } else if (name == "box") {
1079 // \c data == "Boxed" || "Frameless" etc
1080 InsetBoxParams p(data);
1081 data = InsetBoxMailer::params2string(p);
1082 } else if (name == "branch") {
1083 InsetBranchParams p;
1084 data = InsetBranchMailer::params2string(p);
1085 } else if (name == "citation") {
1086 InsetCommandParams p("cite");
1087 data = InsetCommandMailer::params2string(name, p);
1088 } else if (name == "ert") {
1089 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1090 } else if (name == "external") {
1091 InsetExternalParams p;
1092 Buffer const & buffer = *owner->buffer();
1093 data = InsetExternalMailer::params2string(p, buffer);
1094 } else if (name == "float") {
1096 data = InsetFloatMailer::params2string(p);
1097 } else if (name == "graphics") {
1098 InsetGraphicsParams p;
1099 Buffer const & buffer = *owner->buffer();
1100 data = InsetGraphicsMailer::params2string(p, buffer);
1101 } else if (name == "note") {
1103 data = InsetNoteMailer::params2string(p);
1104 } else if (name == "vspace") {
1106 data = InsetVSpaceMailer::params2string(space);
1107 } else if (name == "wrap") {
1109 data = InsetWrapMailer::params2string(p);
1111 owner->getDialogs().show(name, data, 0);
1115 case LFUN_DIALOG_SHOW_NEXT_INSET:
1118 case LFUN_DIALOG_UPDATE: {
1119 string const & name = argument;
1120 // Can only update a dialog connected to an existing inset
1121 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1123 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1124 inset->dispatch(view()->cursor(), fr);
1125 } else if (name == "paragraph") {
1126 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1127 } else if (name == "prefs") {
1128 owner->getDialogs().update(name, string());
1133 case LFUN_DIALOG_HIDE:
1134 Dialogs::hide(argument, 0);
1137 case LFUN_DIALOG_DISCONNECT_INSET:
1138 owner->getDialogs().disconnect(argument);
1141 case LFUN_CHILDOPEN: {
1142 string const filename =
1143 MakeAbsPath(argument, owner->buffer()->filePath());
1144 setMessage(N_("Opening child document ") +
1145 MakeDisplayPath(filename) + "...");
1146 view()->savePosition(0);
1147 string const parentfilename = owner->buffer()->fileName();
1148 if (bufferlist.exists(filename))
1149 view()->setBuffer(bufferlist.getBuffer(filename));
1151 view()->loadLyXFile(filename);
1152 // Set the parent name of the child document.
1153 // This makes insertion of citations and references in the child work,
1154 // when the target is in the parent or another child document.
1155 owner->buffer()->setParentName(parentfilename);
1159 case LFUN_TOGGLECURSORFOLLOW:
1160 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1164 owner->getIntl().KeyMapOn(false);
1167 case LFUN_KMAP_PRIM:
1168 owner->getIntl().KeyMapPrim();
1172 owner->getIntl().KeyMapSec();
1175 case LFUN_KMAP_TOGGLE:
1176 owner->getIntl().ToggleKeyMap();
1182 string rest = split(argument, countstr, ' ');
1183 istringstream is(countstr);
1186 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1187 for (int i = 0; i < count; ++i)
1188 dispatch(lyxaction.lookupFunc(rest));
1193 // argument contains ';'-terminated commands
1194 while (!argument.empty()) {
1196 string rest = split(argument, first, ';');
1197 dispatch(lyxaction.lookupFunc(rest));
1201 case LFUN_SAVEPREFERENCES: {
1202 Path p(user_lyxdir());
1203 lyxrc.write("preferences", false);
1207 case LFUN_SCREEN_FONT_UPDATE:
1208 // handle the screen font changes.
1209 lyxrc.set_font_norm_type();
1210 lyx_gui::update_fonts();
1211 // All visible buffers will need resize
1215 case LFUN_SET_COLOR: {
1217 string const x11_name = split(argument, lyx_name, ' ');
1218 if (lyx_name.empty() || x11_name.empty()) {
1219 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1224 bool const graphicsbg_changed =
1225 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1226 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1228 if (!lcolor.setColor(lyx_name, x11_name)) {
1230 bformat(_("Set-color \"%1$s\" failed "
1231 "- color is undefined or "
1232 "may not be redefined"), lyx_name));
1236 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1238 if (graphicsbg_changed) {
1239 #ifdef WITH_WARNINGS
1240 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1243 lyx::graphics::GCache::get().changeDisplay(true);
1250 owner->message(argument);
1253 case LFUN_TOOLTIPS_TOGGLE:
1254 owner->getDialogs().toggleTooltips();
1257 case LFUN_EXTERNAL_EDIT: {
1258 FuncRequest fr(action, argument);
1259 InsetExternal().dispatch(view()->cursor(), fr);
1263 case LFUN_ALL_INSETS_TOGGLE: {
1265 string const name = split(argument, action, ' ');
1266 InsetBase::Code const inset_code =
1267 InsetBase::translate(name);
1269 LCursor & cur = view()->cursor();
1270 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1272 InsetBase & inset = owner->buffer()->inset();
1273 InsetIterator it = inset_iterator_begin(inset);
1274 InsetIterator const end = inset_iterator_end(inset);
1275 for (; it != end; ++it) {
1276 if (inset_code == InsetBase::NO_CODE
1277 || inset_code == it->lyxCode())
1278 it->dispatch(cur, fr);
1283 case LFUN_LANGUAGE_BUFFER: {
1284 Buffer & buffer = *owner->buffer();
1285 Language const * oldL = buffer.params().language;
1286 Language const * newL = languages.getLanguage(argument);
1287 if (!newL || oldL == newL)
1290 if (oldL->RightToLeft() == newL->RightToLeft()
1291 && !buffer.isMultiLingual())
1292 buffer.changeLanguage(oldL, newL);
1294 buffer.updateDocLang(newL);
1298 case LFUN_BUFFERPARAMS_APPLY: {
1299 istringstream ss(argument);
1302 int const unknown_tokens =
1303 owner->buffer()->readHeader(lex);
1305 if (unknown_tokens != 0) {
1306 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1307 << unknown_tokens << " unknown token"
1308 << (unknown_tokens == 1 ? "" : "s")
1314 case LFUN_TEXTCLASS_APPLY: {
1315 Buffer * buffer = owner->buffer();
1317 lyx::textclass_type const old_class =
1318 buffer->params().textclass;
1320 loadTextclass(argument);
1322 std::pair<bool, lyx::textclass_type> const tc_pair =
1323 textclasslist.NumberOfClass(argument);
1328 lyx::textclass_type const new_class = tc_pair.second;
1329 if (old_class == new_class)
1333 owner->message(_("Converting document to new document class..."));
1335 lyx::cap::SwitchLayoutsBetweenClasses(
1336 old_class, new_class,
1337 buffer->paragraphs(), el);
1339 bufferErrors(*buffer, el);
1340 view()->showErrorList(_("Class switch"));
1344 case LFUN_TEXTCLASS_LOAD:
1345 loadTextclass(argument);
1348 case LFUN_LYXRC_APPLY: {
1349 istringstream ss(argument);
1350 bool const success = lyxrc.read(ss) == 0;
1353 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1354 << "Unable to read lyxrc data"
1362 DispatchResult res = view()->cursor().dispatch(cmd);
1363 if (res.dispatched())
1364 update |= res.update();
1366 update |= view()->dispatch(cmd);
1372 if (view()->available()) {
1373 if (view()->fitCursor() || update)
1375 // if we executed a mutating lfun, mark the buffer as dirty
1376 if (getStatus(cmd).enabled()
1377 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1378 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1379 view()->buffer()->markDirty();
1382 if (view()->cursor().inTexted()) {
1383 view()->owner()->updateLayoutChoice();
1384 sendDispatchMessage(getMessage(), cmd, verbose);
1390 void LyXFunc::sendDispatchMessage(string const & msg,
1391 FuncRequest const & cmd, bool verbose)
1393 owner->updateMenubar();
1394 owner->updateToolbar();
1396 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1397 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1399 owner->message(msg);
1403 string dispatch_msg = msg;
1404 if (!dispatch_msg.empty())
1405 dispatch_msg += ' ';
1407 string comname = lyxaction.getActionName(cmd.action);
1409 bool argsadded = false;
1411 if (!cmd.argument.empty()) {
1412 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1413 comname += ' ' + cmd.argument;
1418 string const shortcuts = toplevel_keymap->findbinding(cmd);
1420 if (!shortcuts.empty()) {
1421 comname += ": " + shortcuts;
1422 } else if (!argsadded && !cmd.argument.empty()) {
1423 comname += ' ' + cmd.argument;
1426 if (!comname.empty()) {
1427 comname = rtrim(comname);
1428 dispatch_msg += '(' + comname + ')';
1431 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1432 if (!dispatch_msg.empty())
1433 owner->message(dispatch_msg);
1437 void LyXFunc::setupLocalKeymap()
1439 keyseq.stdmap = toplevel_keymap.get();
1440 keyseq.curmap = toplevel_keymap.get();
1441 cancel_meta_seq.stdmap = toplevel_keymap.get();
1442 cancel_meta_seq.curmap = toplevel_keymap.get();
1446 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1448 string initpath = lyxrc.document_path;
1449 string filename(name);
1451 if (view()->available()) {
1452 string const trypath = owner->buffer()->filePath();
1453 // If directory is writeable, use this as default.
1454 if (IsDirWriteable(trypath))
1458 static int newfile_number;
1460 if (filename.empty()) {
1461 filename = AddName(lyxrc.document_path,
1462 "newfile" + tostr(++newfile_number) + ".lyx");
1463 FileInfo fi(filename);
1464 while (bufferlist.exists(filename) || fi.readable()) {
1466 filename = AddName(lyxrc.document_path,
1467 "newfile" + tostr(newfile_number) +
1469 fi.newFile(filename);
1473 // The template stuff
1476 FileDialog fileDlg(_("Select template file"),
1477 LFUN_SELECT_FILE_SYNC,
1478 make_pair(string(_("Documents|#o#O")),
1479 string(lyxrc.document_path)),
1480 make_pair(string(_("Templates|#T#t")),
1481 string(lyxrc.template_path)));
1483 FileDialog::Result result =
1484 fileDlg.open(lyxrc.template_path,
1485 FileFilterList(_("LyX Documents (*.lyx)")),
1488 if (result.first == FileDialog::Later)
1490 if (result.second.empty())
1492 templname = result.second;
1495 view()->newFile(filename, templname, !name.empty());
1499 void LyXFunc::open(string const & fname)
1501 string initpath = lyxrc.document_path;
1503 if (view()->available()) {
1504 string const trypath = owner->buffer()->filePath();
1505 // If directory is writeable, use this as default.
1506 if (IsDirWriteable(trypath))
1512 if (fname.empty()) {
1513 FileDialog fileDlg(_("Select document to open"),
1515 make_pair(string(_("Documents|#o#O")),
1516 string(lyxrc.document_path)),
1517 make_pair(string(_("Examples|#E#e")),
1518 string(AddPath(system_lyxdir(), "examples"))));
1520 FileDialog::Result result =
1521 fileDlg.open(initpath,
1522 FileFilterList(_("LyX Documents (*.lyx)")),
1525 if (result.first == FileDialog::Later)
1528 filename = result.second;
1530 // check selected filename
1531 if (filename.empty()) {
1532 owner->message(_("Canceled."));
1538 // get absolute path of file and add ".lyx" to the filename if
1540 string const fullpath = FileSearch(string(), filename, "lyx");
1541 if (!fullpath.empty()) {
1542 filename = fullpath;
1545 string const disp_fn(MakeDisplayPath(filename));
1547 // if the file doesn't exist, let the user create one
1548 FileInfo const f(filename, true);
1550 // the user specifically chose this name. Believe them.
1551 view()->newFile(filename, "", true);
1555 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1558 if (view()->loadLyXFile(filename)) {
1559 str2 = bformat(_("Document %1$s opened."), disp_fn);
1561 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1563 owner->message(str2);
1567 void LyXFunc::doImport(string const & argument)
1570 string filename = split(argument, format, ' ');
1572 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1573 << " file: " << filename << endl;
1575 // need user interaction
1576 if (filename.empty()) {
1577 string initpath = lyxrc.document_path;
1579 if (view()->available()) {
1580 string const trypath = owner->buffer()->filePath();
1581 // If directory is writeable, use this as default.
1582 if (IsDirWriteable(trypath))
1586 string const text = bformat(_("Select %1$s file to import"),
1587 formats.prettyName(format));
1589 FileDialog fileDlg(text,
1591 make_pair(string(_("Documents|#o#O")),
1592 string(lyxrc.document_path)),
1593 make_pair(string(_("Examples|#E#e")),
1594 string(AddPath(system_lyxdir(), "examples"))));
1596 string const filter = formats.prettyName(format)
1597 + " (*." + formats.extension(format) + ')';
1599 FileDialog::Result result =
1600 fileDlg.open(initpath,
1601 FileFilterList(filter),
1604 if (result.first == FileDialog::Later)
1607 filename = result.second;
1609 // check selected filename
1610 if (filename.empty())
1611 owner->message(_("Canceled."));
1614 if (filename.empty())
1617 // get absolute path of file
1618 filename = MakeAbsPath(filename);
1620 string const lyxfile = ChangeExtension(filename, ".lyx");
1622 // Check if the document already is open
1623 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1624 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1625 owner->message(_("Canceled."));
1630 // if the file exists already, and we didn't do
1631 // -i lyx thefile.lyx, warn
1632 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1633 string const file = MakeDisplayPath(lyxfile, 30);
1635 string text = bformat(_("The document %1$s already exists.\n\n"
1636 "Do you want to over-write that document?"), file);
1637 int const ret = Alert::prompt(_("Over-write document?"),
1638 text, 0, 1, _("&Over-write"), _("&Cancel"));
1641 owner->message(_("Canceled."));
1646 Importer::Import(owner, filename, format);
1650 void LyXFunc::closeBuffer()
1652 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1653 if (bufferlist.empty()) {
1654 // need this otherwise SEGV may occur while
1655 // trying to set variables that don't exist
1656 // since there's no current buffer
1657 owner->getDialogs().hideBufferDependent();
1659 view()->setBuffer(bufferlist.first());
1665 // Each "owner" should have it's own message method. lyxview and
1666 // the minibuffer would use the minibuffer, but lyxserver would
1667 // send an ERROR signal to its client. Alejandro 970603
1668 // This function is bit problematic when it comes to NLS, to make the
1669 // lyx servers client be language indepenent we must not translate
1670 // strings sent to this func.
1671 void LyXFunc::setErrorMessage(string const & m) const
1673 dispatch_buffer = m;
1678 void LyXFunc::setMessage(string const & m) const
1680 dispatch_buffer = m;
1684 void LyXFunc::setStatusMessage(string const & m) const
1690 string const LyXFunc::viewStatusMessage()
1692 // When meta-fake key is pressed, show the key sequence so far + "M-".
1694 return keyseq.print() + "M-";
1696 // Else, when a non-complete key sequence is pressed,
1697 // show the available options.
1698 if (keyseq.length() > 0 && !keyseq.deleted())
1699 return keyseq.printOptions();
1701 if (!view()->available())
1702 return _("Welcome to LyX!");
1704 return view()->cursor().currentState();
1708 BufferView * LyXFunc::view() const
1710 BOOST_ASSERT(owner);
1711 return owner->view().get();
1715 bool LyXFunc::wasMetaKey() const
1717 return (meta_fake_bit != key_modifier::none);