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"));
520 bool ensureBufferClean(BufferView * bv)
522 Buffer & buf = *bv->buffer();
526 string const file = MakeDisplayPath(buf.fileName(), 30);
527 string text = bformat(_("The document %1$s has unsaved "
528 "changes.\n\nDo you want to save "
529 "the document?"), file);
530 int const ret = Alert::prompt(_("Save changed document?"),
531 text, 0, 1, _("&Save"),
535 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
537 return buf.isClean();
541 void showPrintError(string const & name)
543 string str = bformat(_("Could not print the document %1$s.\n"
544 "Check that your printer is set up correctly."),
545 MakeDisplayPath(name, 50));
546 Alert::error(_("Print document failed"), str);
550 void loadTextclass(string const & name)
552 std::pair<bool, lyx::textclass_type> const tc_pair =
553 textclasslist.NumberOfClass(name);
555 if (!tc_pair.first) {
556 lyxerr << "Document class \"" << name
557 << "\" does not exist."
562 lyx::textclass_type const tc = tc_pair.second;
564 if (!textclasslist[tc].load()) {
565 string s = bformat(_("The document could not be converted\n"
566 "into the document class %1$s."),
567 textclasslist[tc].name());
568 Alert::error(_("Could not change class"), s);
575 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
577 string const argument = cmd.argument;
578 kb_action const action = cmd.action;
580 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
581 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
583 // we have not done anything wrong yet.
585 dispatch_buffer.erase();
586 selection_possible = false;
588 // We cannot use this function here
589 if (!getStatus(cmd).enabled()) {
590 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
591 << lyxaction.getActionName(action)
592 << " [" << action << "] is disabled at this location"
594 setErrorMessage(getStatusMessage());
598 if (view()->available())
599 view()->hideCursor();
603 case LFUN_WORDFINDFORWARD:
604 case LFUN_WORDFINDBACKWARD: {
605 static string last_search;
606 string searched_string;
608 if (!argument.empty()) {
609 last_search = argument;
610 searched_string = argument;
612 searched_string = last_search;
615 if (searched_string.empty())
618 bool const fw = action == LFUN_WORDFINDFORWARD;
620 lyx::find::find2string(searched_string, true, false, fw);
621 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
626 owner->message(keyseq.printOptions());
629 case LFUN_EXEC_COMMAND:
630 owner->focus_command_buffer();
635 meta_fake_bit = key_modifier::none;
636 if (view()->available())
637 // cancel any selection
638 dispatch(FuncRequest(LFUN_MARK_OFF));
639 setMessage(N_("Cancel"));
643 meta_fake_bit = key_modifier::alt;
644 setMessage(keyseq.print());
647 case LFUN_READ_ONLY_TOGGLE:
648 if (owner->buffer()->lyxvc().inUse())
649 owner->buffer()->lyxvc().toggleReadOnly();
651 owner->buffer()->setReadonly(
652 !owner->buffer()->isReadonly());
655 // --- Menus -----------------------------------------------
657 menuNew(argument, false);
660 case LFUN_MENUNEWTMPLT:
661 menuNew(argument, true);
664 case LFUN_CLOSEBUFFER:
669 if (!owner->buffer()->isUnnamed()) {
670 string const str = bformat(_("Saving document %1$s..."),
671 MakeDisplayPath(owner->buffer()->fileName()));
673 MenuWrite(owner->buffer());
674 owner->message(str + _(" done."));
676 WriteAs(owner->buffer());
680 WriteAs(owner->buffer(), argument);
683 case LFUN_MENURELOAD: {
684 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
685 string text = bformat(_("Any changes will be lost. Are you sure "
686 "you want to revert to the saved version of the document %1$s?"), file);
687 int const ret = Alert::prompt(_("Revert to saved document?"),
688 text, 0, 1, _("&Revert"), _("&Cancel"));
696 Exporter::Export(owner->buffer(), argument, true);
697 view()->showErrorList(BufferFormat(*owner->buffer()));
701 Exporter::Preview(owner->buffer(), argument);
702 view()->showErrorList(BufferFormat(*owner->buffer()));
706 Exporter::Export(owner->buffer(), "program", true);
707 view()->showErrorList(_("Build"));
711 owner->buffer()->runChktex();
712 view()->showErrorList(_("ChkTeX"));
716 if (argument == "custom")
717 owner->getDialogs().show("sendto");
719 Exporter::Export(owner->buffer(), argument, false);
720 view()->showErrorList(BufferFormat(*owner->buffer()));
724 case LFUN_EXPORT_CUSTOM: {
726 string command = split(argument, format_name, ' ');
727 Format const * format = formats.getFormat(format_name);
729 lyxerr << "Format \"" << format_name
730 << "\" not recognized!"
735 Buffer * buffer = owner->buffer();
737 // The name of the file created by the conversion process
740 // Output to filename
741 if (format->name() == "lyx") {
742 string const latexname =
743 buffer->getLatexName(false);
744 filename = ChangeExtension(latexname,
745 format->extension());
746 filename = AddName(buffer->temppath(), filename);
748 if (!buffer->writeFile(filename))
752 Exporter::Export(buffer, format_name, true,
756 // Substitute $$FName for filename
757 if (!contains(command, "$$FName"))
758 command = "( " + command + " ) < $$FName";
759 command = subst(command, "$$FName", filename);
761 // Execute the command in the background
763 call.startscript(Systemcall::DontWait, command);
770 string command = split(split(argument, target, ' '),
774 || target_name.empty()
775 || command.empty()) {
776 lyxerr << "Unable to parse \""
777 << argument << '"' << std::endl;
780 if (target != "printer" && target != "file") {
781 lyxerr << "Unrecognized target \""
782 << target << '"' << std::endl;
786 Buffer * buffer = owner->buffer();
788 if (!Exporter::Export(buffer, "dvi", true)) {
789 showPrintError(buffer->fileName());
793 // Push directory path.
794 string const path = buffer->temppath();
797 // there are three cases here:
798 // 1. we print to a file
799 // 2. we print directly to a printer
800 // 3. we print using a spool command (print to file first)
803 string const dviname =
804 ChangeExtension(buffer->getLatexName(true),
807 if (target == "printer") {
808 if (!lyxrc.print_spool_command.empty()) {
809 // case 3: print using a spool
810 string const psname =
811 ChangeExtension(dviname,".ps");
812 command += lyxrc.print_to_file
815 + QuoteName(dviname);
818 lyxrc.print_spool_command +' ';
819 if (target_name != "default") {
820 command2 += lyxrc.print_spool_printerprefix
824 command2 += QuoteName(psname);
826 // If successful, then spool command
827 res = one.startscript(
832 res = one.startscript(
833 Systemcall::DontWait,
836 // case 2: print directly to a printer
837 res = one.startscript(
838 Systemcall::DontWait,
839 command + QuoteName(dviname));
843 // case 1: print to a file
844 command += lyxrc.print_to_file
845 + QuoteName(MakeAbsPath(target_name,
848 + QuoteName(dviname);
849 res = one.startscript(Systemcall::DontWait,
854 showPrintError(buffer->fileName());
867 InsetCommandParams p("tableofcontents");
868 string const data = InsetCommandMailer::params2string("toc", p);
869 owner->getDialogs().show("toc", data, 0);
877 case LFUN_RECONFIGURE:
881 case LFUN_HELP_OPEN: {
882 string const arg = argument;
884 setErrorMessage(N_("Missing argument"));
887 string const fname = i18nLibFileSearch("doc", arg, "lyx");
889 lyxerr << "LyX: unable to find documentation file `"
890 << arg << "'. Bad installation?" << endl;
893 owner->message(bformat(_("Opening help file %1$s..."),
894 MakeDisplayPath(fname)));
895 view()->loadLyXFile(fname, false);
899 // --- version control -------------------------------
900 case LFUN_VC_REGISTER:
901 if (!ensureBufferClean(view()))
903 if (!owner->buffer()->lyxvc().inUse()) {
904 owner->buffer()->lyxvc().registrer();
909 case LFUN_VC_CHECKIN:
910 if (!ensureBufferClean(view()))
912 if (owner->buffer()->lyxvc().inUse()
913 && !owner->buffer()->isReadonly()) {
914 owner->buffer()->lyxvc().checkIn();
919 case LFUN_VC_CHECKOUT:
920 if (!ensureBufferClean(view()))
922 if (owner->buffer()->lyxvc().inUse()
923 && owner->buffer()->isReadonly()) {
924 owner->buffer()->lyxvc().checkOut();
930 owner->buffer()->lyxvc().revert();
935 owner->buffer()->lyxvc().undoLast();
939 // --- buffers ----------------------------------------
940 case LFUN_SWITCHBUFFER:
941 view()->setBuffer(bufferlist.getBuffer(argument));
945 NewFile(view(), argument);
952 case LFUN_DROP_LAYOUTS_CHOICE:
953 owner->getToolbar().openLayoutList();
956 case LFUN_MENU_OPEN_BY_NAME:
957 owner->getMenubar().openByName(argument);
960 // --- lyxserver commands ----------------------------
962 setMessage(owner->buffer()->fileName());
963 lyxerr[Debug::INFO] << "FNAME["
964 << owner->buffer()->fileName()
969 dispatch_buffer = keyseq.print();
970 lyxserver->notifyClient(dispatch_buffer);
973 case LFUN_GOTOFILEROW: {
976 istringstream is(argument);
977 is >> file_name >> row;
978 if (prefixIs(file_name, getTmpDir())) {
979 // Needed by inverse dvi search. If it is a file
980 // in tmpdir, call the apropriated function
981 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
983 // Must replace extension of the file to be .lyx
985 string const s = ChangeExtension(file_name, ".lyx");
986 // Either change buffer or load the file
987 if (bufferlist.exists(s)) {
988 view()->setBuffer(bufferlist.getBuffer(s));
990 view()->loadLyXFile(s);
994 view()->setCursorFromRow(row);
997 // see BufferView_pimpl::center()
998 view()->updateScrollbar();
1002 case LFUN_GOTO_PARAGRAPH: {
1003 istringstream is(argument);
1006 ParIterator par = owner->buffer()->getParFromID(id);
1007 if (par == owner->buffer()->par_iterator_end()) {
1008 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1009 << id << ']' << endl;
1012 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1013 << " found." << endl;
1017 view()->setCursor(par, 0);
1019 view()->switchKeyMap();
1020 owner->view_state_changed();
1023 // see BufferView_pimpl::center()
1024 view()->updateScrollbar();
1028 case LFUN_DIALOG_SHOW: {
1029 string const name = cmd.getArg(0);
1030 string data = trim(cmd.argument.substr(name.size()));
1032 if (name == "character") {
1033 data = freefont2string();
1035 owner->getDialogs().show("character", data);
1038 else if (name == "latexlog") {
1039 pair<Buffer::LogType, string> const logfile =
1040 owner->buffer()->getLogName();
1041 switch (logfile.first) {
1042 case Buffer::latexlog:
1045 case Buffer::buildlog:
1049 data += logfile.second;
1050 owner->getDialogs().show("log", data);
1052 else if (name == "vclog") {
1053 string const data = "vc " +
1054 owner->buffer()->lyxvc().getLogFile();
1055 owner->getDialogs().show("log", data);
1058 owner->getDialogs().show(name, data);
1062 case LFUN_DIALOG_SHOW_NEW_INSET: {
1063 string const name = cmd.getArg(0);
1064 string data = trim(cmd.argument.substr(name.size()));
1065 if (name == "bibitem" ||
1067 name == "include" ||
1073 InsetCommandParams p(name);
1074 data = InsetCommandMailer::params2string(name, p);
1075 } else if (name == "box") {
1076 // \c data == "Boxed" || "Frameless" etc
1077 InsetBoxParams p(data);
1078 data = InsetBoxMailer::params2string(p);
1079 } else if (name == "branch") {
1080 InsetBranchParams p;
1081 data = InsetBranchMailer::params2string(p);
1082 } else if (name == "citation") {
1083 InsetCommandParams p("cite");
1084 data = InsetCommandMailer::params2string(name, p);
1085 } else if (name == "ert") {
1086 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1087 } else if (name == "external") {
1088 InsetExternalParams p;
1089 Buffer const & buffer = *owner->buffer();
1090 data = InsetExternalMailer::params2string(p, buffer);
1091 } else if (name == "float") {
1093 data = InsetFloatMailer::params2string(p);
1094 } else if (name == "graphics") {
1095 InsetGraphicsParams p;
1096 Buffer const & buffer = *owner->buffer();
1097 data = InsetGraphicsMailer::params2string(p, buffer);
1098 } else if (name == "note") {
1100 data = InsetNoteMailer::params2string(p);
1101 } else if (name == "vspace") {
1103 data = InsetVSpaceMailer::params2string(space);
1104 } else if (name == "wrap") {
1106 data = InsetWrapMailer::params2string(p);
1108 owner->getDialogs().show(name, data, 0);
1112 case LFUN_DIALOG_SHOW_NEXT_INSET:
1115 case LFUN_DIALOG_UPDATE: {
1116 string const & name = argument;
1117 // Can only update a dialog connected to an existing inset
1118 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1120 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1121 inset->dispatch(view()->cursor(), fr);
1122 } else if (name == "paragraph") {
1123 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1124 } else if (name == "prefs") {
1125 owner->getDialogs().update(name, string());
1130 case LFUN_DIALOG_HIDE:
1131 Dialogs::hide(argument, 0);
1134 case LFUN_DIALOG_DISCONNECT_INSET:
1135 owner->getDialogs().disconnect(argument);
1138 case LFUN_CHILDOPEN: {
1139 string const filename =
1140 MakeAbsPath(argument, owner->buffer()->filePath());
1141 setMessage(N_("Opening child document ") +
1142 MakeDisplayPath(filename) + "...");
1143 view()->savePosition(0);
1144 string const parentfilename = owner->buffer()->fileName();
1145 if (bufferlist.exists(filename))
1146 view()->setBuffer(bufferlist.getBuffer(filename));
1148 view()->loadLyXFile(filename);
1149 // Set the parent name of the child document.
1150 // This makes insertion of citations and references in the child work,
1151 // when the target is in the parent or another child document.
1152 owner->buffer()->setParentName(parentfilename);
1156 case LFUN_TOGGLECURSORFOLLOW:
1157 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1161 owner->getIntl().KeyMapOn(false);
1164 case LFUN_KMAP_PRIM:
1165 owner->getIntl().KeyMapPrim();
1169 owner->getIntl().KeyMapSec();
1172 case LFUN_KMAP_TOGGLE:
1173 owner->getIntl().ToggleKeyMap();
1179 string rest = split(argument, countstr, ' ');
1180 istringstream is(countstr);
1183 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1184 for (int i = 0; i < count; ++i)
1185 dispatch(lyxaction.lookupFunc(rest));
1190 // argument contains ';'-terminated commands
1191 while (!argument.empty()) {
1193 string rest = split(argument, first, ';');
1194 dispatch(lyxaction.lookupFunc(rest));
1198 case LFUN_SAVEPREFERENCES: {
1199 Path p(user_lyxdir());
1200 lyxrc.write("preferences", false);
1204 case LFUN_SCREEN_FONT_UPDATE:
1205 // handle the screen font changes.
1206 lyxrc.set_font_norm_type();
1207 lyx_gui::update_fonts();
1208 // All visible buffers will need resize
1212 case LFUN_SET_COLOR: {
1214 string const x11_name = split(argument, lyx_name, ' ');
1215 if (lyx_name.empty() || x11_name.empty()) {
1216 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1221 bool const graphicsbg_changed =
1222 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1223 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1225 if (!lcolor.setColor(lyx_name, x11_name)) {
1227 bformat(_("Set-color \"%1$s\" failed "
1228 "- color is undefined or "
1229 "may not be redefined"), lyx_name));
1233 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1235 if (graphicsbg_changed) {
1236 #ifdef WITH_WARNINGS
1237 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1240 lyx::graphics::GCache::get().changeDisplay(true);
1247 owner->message(argument);
1250 case LFUN_TOOLTIPS_TOGGLE:
1251 owner->getDialogs().toggleTooltips();
1254 case LFUN_EXTERNAL_EDIT: {
1255 FuncRequest fr(action, argument);
1256 InsetExternal().dispatch(view()->cursor(), fr);
1260 case LFUN_BREAKLINE: {
1261 #ifdef WITH_WARNINGS
1262 #warning swallow 'Return' if the minibuffer is focused. But how?
1267 case LFUN_ALL_INSETS_TOGGLE: {
1269 string const name = split(argument, action, ' ');
1270 InsetBase::Code const inset_code =
1271 InsetBase::translate(name);
1273 LCursor & cur = view()->cursor();
1274 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1276 InsetBase & inset = owner->buffer()->inset();
1277 InsetIterator it = inset_iterator_begin(inset);
1278 InsetIterator const end = inset_iterator_end(inset);
1279 for (; it != end; ++it) {
1280 if (inset_code == InsetBase::NO_CODE
1281 || inset_code == it->lyxCode())
1282 it->dispatch(cur, fr);
1287 case LFUN_LANGUAGE_BUFFER: {
1288 Buffer & buffer = *owner->buffer();
1289 Language const * oldL = buffer.params().language;
1290 Language const * newL = languages.getLanguage(argument);
1291 if (!newL || oldL == newL)
1294 if (oldL->RightToLeft() == newL->RightToLeft()
1295 && !buffer.isMultiLingual())
1296 buffer.changeLanguage(oldL, newL);
1298 buffer.updateDocLang(newL);
1302 case LFUN_BUFFERPARAMS_APPLY: {
1303 istringstream ss(argument);
1306 int const unknown_tokens =
1307 owner->buffer()->readHeader(lex);
1309 if (unknown_tokens != 0) {
1310 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1311 << unknown_tokens << " unknown token"
1312 << (unknown_tokens == 1 ? "" : "s")
1318 case LFUN_TEXTCLASS_APPLY: {
1319 Buffer * buffer = owner->buffer();
1321 lyx::textclass_type const old_class =
1322 buffer->params().textclass;
1324 loadTextclass(argument);
1326 std::pair<bool, lyx::textclass_type> const tc_pair =
1327 textclasslist.NumberOfClass(argument);
1332 lyx::textclass_type const new_class = tc_pair.second;
1333 if (old_class == new_class)
1337 owner->message(_("Converting document to new document class..."));
1339 lyx::cap::SwitchLayoutsBetweenClasses(
1340 old_class, new_class,
1341 buffer->paragraphs(), el);
1343 bufferErrors(*buffer, el);
1344 view()->showErrorList(_("Class switch"));
1348 case LFUN_TEXTCLASS_LOAD:
1349 loadTextclass(argument);
1352 case LFUN_LYXRC_APPLY: {
1353 istringstream ss(argument);
1354 bool const success = lyxrc.read(ss) == 0;
1357 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1358 << "Unable to read lyxrc data"
1365 DispatchResult res = view()->cursor().dispatch(cmd);
1366 if (!res.dispatched());
1367 view()->dispatch(cmd);
1372 if (view()->available()) {
1373 view()->fitCursor();
1375 view()->cursor().updatePos();
1376 // if we executed a mutating lfun, mark the buffer as dirty
1377 if (getStatus(cmd).enabled()
1378 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1379 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1380 view()->buffer()->markDirty();
1383 if (view()->cursor().inTexted()) {
1384 view()->owner()->updateLayoutChoice();
1385 sendDispatchMessage(getMessage(), cmd, verbose);
1391 void LyXFunc::sendDispatchMessage(string const & msg,
1392 FuncRequest const & cmd, bool verbose)
1394 owner->updateMenubar();
1395 owner->updateToolbar();
1397 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1398 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1400 owner->message(msg);
1404 string dispatch_msg = msg;
1405 if (!dispatch_msg.empty())
1406 dispatch_msg += ' ';
1408 string comname = lyxaction.getActionName(cmd.action);
1410 bool argsadded = false;
1412 if (!cmd.argument.empty()) {
1413 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1414 comname += ' ' + cmd.argument;
1419 string const shortcuts = toplevel_keymap->findbinding(cmd);
1421 if (!shortcuts.empty()) {
1422 comname += ": " + shortcuts;
1423 } else if (!argsadded && !cmd.argument.empty()) {
1424 comname += ' ' + cmd.argument;
1427 if (!comname.empty()) {
1428 comname = rtrim(comname);
1429 dispatch_msg += '(' + comname + ')';
1432 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1433 if (!dispatch_msg.empty())
1434 owner->message(dispatch_msg);
1438 void LyXFunc::setupLocalKeymap()
1440 keyseq.stdmap = toplevel_keymap.get();
1441 keyseq.curmap = toplevel_keymap.get();
1442 cancel_meta_seq.stdmap = toplevel_keymap.get();
1443 cancel_meta_seq.curmap = toplevel_keymap.get();
1447 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1449 string initpath = lyxrc.document_path;
1450 string filename(name);
1452 if (view()->available()) {
1453 string const trypath = owner->buffer()->filePath();
1454 // If directory is writeable, use this as default.
1455 if (IsDirWriteable(trypath))
1459 static int newfile_number;
1461 if (filename.empty()) {
1462 filename = AddName(lyxrc.document_path,
1463 "newfile" + tostr(++newfile_number) + ".lyx");
1464 FileInfo fi(filename);
1465 while (bufferlist.exists(filename) || fi.readable()) {
1467 filename = AddName(lyxrc.document_path,
1468 "newfile" + tostr(newfile_number) +
1470 fi.newFile(filename);
1474 // The template stuff
1477 FileDialog fileDlg(_("Select template file"),
1478 LFUN_SELECT_FILE_SYNC,
1479 make_pair(string(_("Documents|#o#O")),
1480 string(lyxrc.document_path)),
1481 make_pair(string(_("Templates|#T#t")),
1482 string(lyxrc.template_path)));
1484 FileDialog::Result result =
1485 fileDlg.open(lyxrc.template_path,
1486 FileFilterList(_("LyX Documents (*.lyx)")),
1489 if (result.first == FileDialog::Later)
1491 if (result.second.empty())
1493 templname = result.second;
1496 view()->newFile(filename, templname, !name.empty());
1500 void LyXFunc::open(string const & fname)
1502 string initpath = lyxrc.document_path;
1504 if (view()->available()) {
1505 string const trypath = owner->buffer()->filePath();
1506 // If directory is writeable, use this as default.
1507 if (IsDirWriteable(trypath))
1513 if (fname.empty()) {
1514 FileDialog fileDlg(_("Select document to open"),
1516 make_pair(string(_("Documents|#o#O")),
1517 string(lyxrc.document_path)),
1518 make_pair(string(_("Examples|#E#e")),
1519 string(AddPath(system_lyxdir(), "examples"))));
1521 FileDialog::Result result =
1522 fileDlg.open(initpath,
1523 FileFilterList(_("LyX Documents (*.lyx)")),
1526 if (result.first == FileDialog::Later)
1529 filename = result.second;
1531 // check selected filename
1532 if (filename.empty()) {
1533 owner->message(_("Canceled."));
1539 // get absolute path of file and add ".lyx" to the filename if
1541 string const fullpath = FileSearch(string(), filename, "lyx");
1542 if (!fullpath.empty()) {
1543 filename = fullpath;
1546 string const disp_fn(MakeDisplayPath(filename));
1548 // if the file doesn't exist, let the user create one
1549 FileInfo const f(filename, true);
1551 // the user specifically chose this name. Believe them.
1552 view()->newFile(filename, "", true);
1556 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1559 if (view()->loadLyXFile(filename)) {
1560 str2 = bformat(_("Document %1$s opened."), disp_fn);
1562 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1564 owner->message(str2);
1568 void LyXFunc::doImport(string const & argument)
1571 string filename = split(argument, format, ' ');
1573 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1574 << " file: " << filename << endl;
1576 // need user interaction
1577 if (filename.empty()) {
1578 string initpath = lyxrc.document_path;
1580 if (view()->available()) {
1581 string const trypath = owner->buffer()->filePath();
1582 // If directory is writeable, use this as default.
1583 if (IsDirWriteable(trypath))
1587 string const text = bformat(_("Select %1$s file to import"),
1588 formats.prettyName(format));
1590 FileDialog fileDlg(text,
1592 make_pair(string(_("Documents|#o#O")),
1593 string(lyxrc.document_path)),
1594 make_pair(string(_("Examples|#E#e")),
1595 string(AddPath(system_lyxdir(), "examples"))));
1597 string const filter = formats.prettyName(format)
1598 + " (*." + formats.extension(format) + ')';
1600 FileDialog::Result result =
1601 fileDlg.open(initpath,
1602 FileFilterList(filter),
1605 if (result.first == FileDialog::Later)
1608 filename = result.second;
1610 // check selected filename
1611 if (filename.empty())
1612 owner->message(_("Canceled."));
1615 if (filename.empty())
1618 // get absolute path of file
1619 filename = MakeAbsPath(filename);
1621 string const lyxfile = ChangeExtension(filename, ".lyx");
1623 // Check if the document already is open
1624 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1625 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1626 owner->message(_("Canceled."));
1631 // if the file exists already, and we didn't do
1632 // -i lyx thefile.lyx, warn
1633 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1634 string const file = MakeDisplayPath(lyxfile, 30);
1636 string text = bformat(_("The document %1$s already exists.\n\n"
1637 "Do you want to over-write that document?"), file);
1638 int const ret = Alert::prompt(_("Over-write document?"),
1639 text, 0, 1, _("&Over-write"), _("&Cancel"));
1642 owner->message(_("Canceled."));
1647 Importer::Import(owner, filename, format);
1651 void LyXFunc::closeBuffer()
1653 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1654 if (bufferlist.empty()) {
1655 // need this otherwise SEGV may occur while
1656 // trying to set variables that don't exist
1657 // since there's no current buffer
1658 owner->getDialogs().hideBufferDependent();
1660 view()->setBuffer(bufferlist.first());
1666 // Each "owner" should have it's own message method. lyxview and
1667 // the minibuffer would use the minibuffer, but lyxserver would
1668 // send an ERROR signal to its client. Alejandro 970603
1669 // This function is bit problematic when it comes to NLS, to make the
1670 // lyx servers client be language indepenent we must not translate
1671 // strings sent to this func.
1672 void LyXFunc::setErrorMessage(string const & m) const
1674 dispatch_buffer = m;
1679 void LyXFunc::setMessage(string const & m) const
1681 dispatch_buffer = m;
1685 void LyXFunc::setStatusMessage(string const & m) const
1691 string const LyXFunc::viewStatusMessage()
1693 // When meta-fake key is pressed, show the key sequence so far + "M-".
1695 return keyseq.print() + "M-";
1697 // Else, when a non-complete key sequence is pressed,
1698 // show the available options.
1699 if (keyseq.length() > 0 && !keyseq.deleted())
1700 return keyseq.printOptions();
1702 if (!view()->available())
1703 return _("Welcome to LyX!");
1705 return view()->cursor().currentState();
1709 BufferView * LyXFunc::view() const
1711 BOOST_ASSERT(owner);
1712 return owner->view().get();
1716 bool LyXFunc::wasMetaKey() const
1718 return (meta_fake_bit != key_modifier::none);