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_GRAPHICS_EDIT:
487 case LFUN_ALL_INSETS_TOGGLE:
488 case LFUN_LANGUAGE_BUFFER:
489 case LFUN_TEXTCLASS_APPLY:
490 case LFUN_TEXTCLASS_LOAD:
491 case LFUN_SAVE_AS_DEFAULT:
492 case LFUN_BUFFERPARAMS_APPLY:
493 case LFUN_LYXRC_APPLY:
494 // these are handled in our dispatch()
499 cur.getStatus(cmd, flag);
501 flag = view()->getStatus(cmd);
507 // Can we use a readonly buffer?
508 if (buf && buf->isReadonly()
509 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
510 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
511 setStatusMessage(N_("Document is read-only"));
515 //lyxerr << "LyXFunc::getStatus: got: " << flag.enabled() << endl;
522 bool ensureBufferClean(BufferView * bv)
524 Buffer & buf = *bv->buffer();
528 string const file = MakeDisplayPath(buf.fileName(), 30);
529 string text = bformat(_("The document %1$s has unsaved "
530 "changes.\n\nDo you want to save "
531 "the document?"), file);
532 int const ret = Alert::prompt(_("Save changed document?"),
533 text, 0, 1, _("&Save"),
537 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
539 return buf.isClean();
543 void showPrintError(string const & name)
545 string str = bformat(_("Could not print the document %1$s.\n"
546 "Check that your printer is set up correctly."),
547 MakeDisplayPath(name, 50));
548 Alert::error(_("Print document failed"), str);
552 void loadTextclass(string const & name)
554 std::pair<bool, lyx::textclass_type> const tc_pair =
555 textclasslist.NumberOfClass(name);
557 if (!tc_pair.first) {
558 lyxerr << "Document class \"" << name
559 << "\" does not exist."
564 lyx::textclass_type const tc = tc_pair.second;
566 if (!textclasslist[tc].load()) {
567 string s = bformat(_("The document could not be converted\n"
568 "into the document class %1$s."),
569 textclasslist[tc].name());
570 Alert::error(_("Could not change class"), s);
577 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
579 string const argument = cmd.argument;
580 kb_action const action = cmd.action;
582 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
583 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
585 // we have not done anything wrong yet.
587 dispatch_buffer.erase();
588 selection_possible = false;
592 // We cannot use this function here
593 if (!getStatus(cmd).enabled()) {
594 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
595 << lyxaction.getActionName(action)
596 << " [" << action << "] is disabled at this location"
598 setErrorMessage(getStatusMessage());
602 if (view()->available())
603 view()->hideCursor();
607 case LFUN_WORDFINDFORWARD:
608 case LFUN_WORDFINDBACKWARD: {
609 static string last_search;
610 string searched_string;
612 if (!argument.empty()) {
613 last_search = argument;
614 searched_string = argument;
616 searched_string = last_search;
619 if (searched_string.empty())
622 bool const fw = action == LFUN_WORDFINDFORWARD;
624 lyx::find::find2string(searched_string, true, false, fw);
625 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
630 owner->message(keyseq.printOptions());
633 case LFUN_EXEC_COMMAND:
634 owner->focus_command_buffer();
639 meta_fake_bit = key_modifier::none;
640 if (view()->available())
641 // cancel any selection
642 dispatch(FuncRequest(LFUN_MARK_OFF));
643 setMessage(N_("Cancel"));
647 meta_fake_bit = key_modifier::alt;
648 setMessage(keyseq.print());
651 case LFUN_READ_ONLY_TOGGLE:
652 if (owner->buffer()->lyxvc().inUse())
653 owner->buffer()->lyxvc().toggleReadOnly();
655 owner->buffer()->setReadonly(
656 !owner->buffer()->isReadonly());
659 // --- Menus -----------------------------------------------
661 menuNew(argument, false);
664 case LFUN_MENUNEWTMPLT:
665 menuNew(argument, true);
668 case LFUN_CLOSEBUFFER:
673 if (!owner->buffer()->isUnnamed()) {
674 string const str = bformat(_("Saving document %1$s..."),
675 MakeDisplayPath(owner->buffer()->fileName()));
677 MenuWrite(owner->buffer());
678 owner->message(str + _(" done."));
680 WriteAs(owner->buffer());
684 WriteAs(owner->buffer(), argument);
687 case LFUN_MENURELOAD: {
688 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
689 string text = bformat(_("Any changes will be lost. Are you sure "
690 "you want to revert to the saved version of the document %1$s?"), file);
691 int const ret = Alert::prompt(_("Revert to saved document?"),
692 text, 0, 1, _("&Revert"), _("&Cancel"));
700 Exporter::Export(owner->buffer(), argument, true);
701 view()->showErrorList(BufferFormat(*owner->buffer()));
705 Exporter::Preview(owner->buffer(), argument);
706 view()->showErrorList(BufferFormat(*owner->buffer()));
710 Exporter::Export(owner->buffer(), "program", true);
711 view()->showErrorList(_("Build"));
715 owner->buffer()->runChktex();
716 view()->showErrorList(_("ChkTeX"));
720 if (argument == "custom")
721 owner->getDialogs().show("sendto");
723 Exporter::Export(owner->buffer(), argument, false);
724 view()->showErrorList(BufferFormat(*owner->buffer()));
728 case LFUN_EXPORT_CUSTOM: {
730 string command = split(argument, format_name, ' ');
731 Format const * format = formats.getFormat(format_name);
733 lyxerr << "Format \"" << format_name
734 << "\" not recognized!"
739 Buffer * buffer = owner->buffer();
741 // The name of the file created by the conversion process
744 // Output to filename
745 if (format->name() == "lyx") {
746 string const latexname =
747 buffer->getLatexName(false);
748 filename = ChangeExtension(latexname,
749 format->extension());
750 filename = AddName(buffer->temppath(), filename);
752 if (!buffer->writeFile(filename))
756 Exporter::Export(buffer, format_name, true,
760 // Substitute $$FName for filename
761 if (!contains(command, "$$FName"))
762 command = "( " + command + " ) < $$FName";
763 command = subst(command, "$$FName", filename);
765 // Execute the command in the background
767 call.startscript(Systemcall::DontWait, command);
774 string command = split(split(argument, target, ' '),
778 || target_name.empty()
779 || command.empty()) {
780 lyxerr << "Unable to parse \""
781 << argument << '"' << std::endl;
784 if (target != "printer" && target != "file") {
785 lyxerr << "Unrecognized target \""
786 << target << '"' << std::endl;
790 Buffer * buffer = owner->buffer();
792 if (!Exporter::Export(buffer, "dvi", true)) {
793 showPrintError(buffer->fileName());
797 // Push directory path.
798 string const path = buffer->temppath();
801 // there are three cases here:
802 // 1. we print to a file
803 // 2. we print directly to a printer
804 // 3. we print using a spool command (print to file first)
807 string const dviname =
808 ChangeExtension(buffer->getLatexName(true),
811 if (target == "printer") {
812 if (!lyxrc.print_spool_command.empty()) {
813 // case 3: print using a spool
814 string const psname =
815 ChangeExtension(dviname,".ps");
816 command += lyxrc.print_to_file
819 + QuoteName(dviname);
822 lyxrc.print_spool_command +' ';
823 if (target_name != "default") {
824 command2 += lyxrc.print_spool_printerprefix
828 command2 += QuoteName(psname);
830 // If successful, then spool command
831 res = one.startscript(
836 res = one.startscript(
837 Systemcall::DontWait,
840 // case 2: print directly to a printer
841 res = one.startscript(
842 Systemcall::DontWait,
843 command + QuoteName(dviname));
847 // case 1: print to a file
848 command += lyxrc.print_to_file
849 + QuoteName(MakeAbsPath(target_name,
852 + QuoteName(dviname);
853 res = one.startscript(Systemcall::DontWait,
858 showPrintError(buffer->fileName());
871 InsetCommandParams p("tableofcontents");
872 string const data = InsetCommandMailer::params2string("toc", p);
873 owner->getDialogs().show("toc", data, 0);
881 case LFUN_RECONFIGURE:
885 case LFUN_HELP_OPEN: {
886 string const arg = argument;
888 setErrorMessage(N_("Missing argument"));
891 string const fname = i18nLibFileSearch("doc", arg, "lyx");
893 lyxerr << "LyX: unable to find documentation file `"
894 << arg << "'. Bad installation?" << endl;
897 owner->message(bformat(_("Opening help file %1$s..."),
898 MakeDisplayPath(fname)));
899 view()->loadLyXFile(fname, false);
903 // --- version control -------------------------------
904 case LFUN_VC_REGISTER:
905 if (!ensureBufferClean(view()))
907 if (!owner->buffer()->lyxvc().inUse()) {
908 owner->buffer()->lyxvc().registrer();
913 case LFUN_VC_CHECKIN:
914 if (!ensureBufferClean(view()))
916 if (owner->buffer()->lyxvc().inUse()
917 && !owner->buffer()->isReadonly()) {
918 owner->buffer()->lyxvc().checkIn();
923 case LFUN_VC_CHECKOUT:
924 if (!ensureBufferClean(view()))
926 if (owner->buffer()->lyxvc().inUse()
927 && owner->buffer()->isReadonly()) {
928 owner->buffer()->lyxvc().checkOut();
934 owner->buffer()->lyxvc().revert();
939 owner->buffer()->lyxvc().undoLast();
943 // --- buffers ----------------------------------------
944 case LFUN_SWITCHBUFFER:
945 view()->setBuffer(bufferlist.getBuffer(argument));
949 NewFile(view(), argument);
956 case LFUN_DROP_LAYOUTS_CHOICE:
957 owner->getToolbar().openLayoutList();
960 case LFUN_MENU_OPEN_BY_NAME:
961 owner->getMenubar().openByName(argument);
964 // --- lyxserver commands ----------------------------
966 setMessage(owner->buffer()->fileName());
967 lyxerr[Debug::INFO] << "FNAME["
968 << owner->buffer()->fileName()
973 dispatch_buffer = keyseq.print();
974 lyxserver->notifyClient(dispatch_buffer);
977 case LFUN_GOTOFILEROW: {
980 istringstream is(argument);
981 is >> file_name >> row;
982 if (prefixIs(file_name, getTmpDir())) {
983 // Needed by inverse dvi search. If it is a file
984 // in tmpdir, call the apropriated function
985 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
987 // Must replace extension of the file to be .lyx
989 string const s = ChangeExtension(file_name, ".lyx");
990 // Either change buffer or load the file
991 if (bufferlist.exists(s)) {
992 view()->setBuffer(bufferlist.getBuffer(s));
994 view()->loadLyXFile(s);
998 view()->setCursorFromRow(row);
1001 // see BufferView_pimpl::center()
1002 view()->updateScrollbar();
1006 case LFUN_GOTO_PARAGRAPH: {
1007 istringstream is(argument);
1010 ParIterator par = owner->buffer()->getParFromID(id);
1011 if (par == owner->buffer()->par_iterator_end()) {
1012 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1013 << id << ']' << endl;
1016 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1017 << " found." << endl;
1021 view()->setCursor(par, 0);
1023 view()->switchKeyMap();
1024 owner->view_state_changed();
1027 // see BufferView_pimpl::center()
1028 view()->updateScrollbar();
1032 case LFUN_DIALOG_SHOW: {
1033 string const name = cmd.getArg(0);
1034 string data = trim(cmd.argument.substr(name.size()));
1036 if (name == "character") {
1037 data = freefont2string();
1039 owner->getDialogs().show("character", data);
1042 else if (name == "latexlog") {
1043 pair<Buffer::LogType, string> const logfile =
1044 owner->buffer()->getLogName();
1045 switch (logfile.first) {
1046 case Buffer::latexlog:
1049 case Buffer::buildlog:
1053 data += logfile.second;
1054 owner->getDialogs().show("log", data);
1056 else if (name == "vclog") {
1057 string const data = "vc " +
1058 owner->buffer()->lyxvc().getLogFile();
1059 owner->getDialogs().show("log", data);
1062 owner->getDialogs().show(name, data);
1066 case LFUN_DIALOG_SHOW_NEW_INSET: {
1067 string const name = cmd.getArg(0);
1068 string data = trim(cmd.argument.substr(name.size()));
1069 if (name == "bibitem" ||
1071 name == "include" ||
1077 InsetCommandParams p(name);
1078 data = InsetCommandMailer::params2string(name, p);
1079 } else if (name == "box") {
1080 // \c data == "Boxed" || "Frameless" etc
1081 InsetBoxParams p(data);
1082 data = InsetBoxMailer::params2string(p);
1083 } else if (name == "branch") {
1084 InsetBranchParams p;
1085 data = InsetBranchMailer::params2string(p);
1086 } else if (name == "citation") {
1087 InsetCommandParams p("cite");
1088 data = InsetCommandMailer::params2string(name, p);
1089 } else if (name == "ert") {
1090 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1091 } else if (name == "external") {
1092 InsetExternalParams p;
1093 Buffer const & buffer = *owner->buffer();
1094 data = InsetExternalMailer::params2string(p, buffer);
1095 } else if (name == "float") {
1097 data = InsetFloatMailer::params2string(p);
1098 } else if (name == "graphics") {
1099 InsetGraphicsParams p;
1100 Buffer const & buffer = *owner->buffer();
1101 data = InsetGraphicsMailer::params2string(p, buffer);
1102 } else if (name == "note") {
1104 data = InsetNoteMailer::params2string(p);
1105 } else if (name == "vspace") {
1107 data = InsetVSpaceMailer::params2string(space);
1108 } else if (name == "wrap") {
1110 data = InsetWrapMailer::params2string(p);
1112 owner->getDialogs().show(name, data, 0);
1116 case LFUN_DIALOG_SHOW_NEXT_INSET:
1119 case LFUN_DIALOG_UPDATE: {
1120 string const & name = argument;
1121 // Can only update a dialog connected to an existing inset
1122 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1124 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1125 inset->dispatch(view()->cursor(), fr);
1126 } else if (name == "paragraph") {
1127 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1128 } else if (name == "prefs") {
1129 owner->getDialogs().update(name, string());
1134 case LFUN_DIALOG_HIDE:
1135 Dialogs::hide(argument, 0);
1138 case LFUN_DIALOG_DISCONNECT_INSET:
1139 owner->getDialogs().disconnect(argument);
1142 case LFUN_CHILDOPEN: {
1143 string const filename =
1144 MakeAbsPath(argument, owner->buffer()->filePath());
1145 setMessage(N_("Opening child document ") +
1146 MakeDisplayPath(filename) + "...");
1147 view()->savePosition(0);
1148 string const parentfilename = owner->buffer()->fileName();
1149 if (bufferlist.exists(filename))
1150 view()->setBuffer(bufferlist.getBuffer(filename));
1152 view()->loadLyXFile(filename);
1153 // Set the parent name of the child document.
1154 // This makes insertion of citations and references in the child work,
1155 // when the target is in the parent or another child document.
1156 owner->buffer()->setParentName(parentfilename);
1160 case LFUN_TOGGLECURSORFOLLOW:
1161 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1165 owner->getIntl().KeyMapOn(false);
1168 case LFUN_KMAP_PRIM:
1169 owner->getIntl().KeyMapPrim();
1173 owner->getIntl().KeyMapSec();
1176 case LFUN_KMAP_TOGGLE:
1177 owner->getIntl().ToggleKeyMap();
1183 string rest = split(argument, countstr, ' ');
1184 istringstream is(countstr);
1187 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1188 for (int i = 0; i < count; ++i)
1189 dispatch(lyxaction.lookupFunc(rest));
1194 // argument contains ';'-terminated commands
1195 while (!argument.empty()) {
1197 string rest = split(argument, first, ';');
1198 dispatch(lyxaction.lookupFunc(rest));
1202 case LFUN_SAVEPREFERENCES: {
1203 Path p(user_lyxdir());
1204 lyxrc.write("preferences", false);
1208 case LFUN_SCREEN_FONT_UPDATE:
1209 // handle the screen font changes.
1210 lyxrc.set_font_norm_type();
1211 lyx_gui::update_fonts();
1212 // All visible buffers will need resize
1216 case LFUN_SET_COLOR: {
1218 string const x11_name = split(argument, lyx_name, ' ');
1219 if (lyx_name.empty() || x11_name.empty()) {
1220 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1225 bool const graphicsbg_changed =
1226 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1227 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1229 if (!lcolor.setColor(lyx_name, x11_name)) {
1231 bformat(_("Set-color \"%1$s\" failed "
1232 "- color is undefined or "
1233 "may not be redefined"), lyx_name));
1237 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1239 if (graphicsbg_changed) {
1240 #ifdef WITH_WARNINGS
1241 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1244 lyx::graphics::GCache::get().changeDisplay(true);
1251 owner->message(argument);
1254 case LFUN_TOOLTIPS_TOGGLE:
1255 owner->getDialogs().toggleTooltips();
1258 case LFUN_EXTERNAL_EDIT: {
1259 FuncRequest fr(action, argument);
1260 InsetExternal().dispatch(view()->cursor(), fr);
1264 case LFUN_GRAPHICS_EDIT: {
1265 FuncRequest fr(action, argument);
1266 InsetGraphics().dispatch(view()->cursor(), fr);
1270 case LFUN_ALL_INSETS_TOGGLE: {
1272 string const name = split(argument, action, ' ');
1273 InsetBase::Code const inset_code =
1274 InsetBase::translate(name);
1276 LCursor & cur = view()->cursor();
1277 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1279 InsetBase & inset = owner->buffer()->inset();
1280 InsetIterator it = inset_iterator_begin(inset);
1281 InsetIterator const end = inset_iterator_end(inset);
1282 for (; it != end; ++it) {
1283 if (inset_code == InsetBase::NO_CODE
1284 || inset_code == it->lyxCode())
1285 it->dispatch(cur, fr);
1290 case LFUN_LANGUAGE_BUFFER: {
1291 Buffer & buffer = *owner->buffer();
1292 Language const * oldL = buffer.params().language;
1293 Language const * newL = languages.getLanguage(argument);
1294 if (!newL || oldL == newL)
1297 if (oldL->RightToLeft() == newL->RightToLeft()
1298 && !buffer.isMultiLingual())
1299 buffer.changeLanguage(oldL, newL);
1301 buffer.updateDocLang(newL);
1305 case LFUN_BUFFERPARAMS_APPLY: {
1306 istringstream ss(argument);
1309 int const unknown_tokens =
1310 owner->buffer()->readHeader(lex);
1312 if (unknown_tokens != 0) {
1313 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1314 << unknown_tokens << " unknown token"
1315 << (unknown_tokens == 1 ? "" : "s")
1321 case LFUN_TEXTCLASS_APPLY: {
1322 Buffer * buffer = owner->buffer();
1324 lyx::textclass_type const old_class =
1325 buffer->params().textclass;
1327 loadTextclass(argument);
1329 std::pair<bool, lyx::textclass_type> const tc_pair =
1330 textclasslist.NumberOfClass(argument);
1335 lyx::textclass_type const new_class = tc_pair.second;
1336 if (old_class == new_class)
1340 owner->message(_("Converting document to new document class..."));
1342 lyx::cap::SwitchLayoutsBetweenClasses(
1343 old_class, new_class,
1344 buffer->paragraphs(), el);
1346 bufferErrors(*buffer, el);
1347 view()->showErrorList(_("Class switch"));
1351 case LFUN_TEXTCLASS_LOAD:
1352 loadTextclass(argument);
1355 case LFUN_LYXRC_APPLY: {
1356 istringstream ss(argument);
1357 bool const success = lyxrc.read(ss) == 0;
1360 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1361 << "Unable to read lyxrc data"
1369 DispatchResult res = view()->cursor().dispatch(cmd);
1370 if (res.dispatched())
1371 update |= res.update();
1373 update |= view()->dispatch(cmd);
1379 if (view()->available()) {
1380 if (view()->fitCursor() || update)
1382 // if we executed a mutating lfun, mark the buffer as dirty
1383 if (getStatus(cmd).enabled()
1384 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1385 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1386 view()->buffer()->markDirty();
1389 if (view()->cursor().inTexted()) {
1390 view()->owner()->updateLayoutChoice();
1391 sendDispatchMessage(getMessage(), cmd, verbose);
1397 void LyXFunc::sendDispatchMessage(string const & msg,
1398 FuncRequest const & cmd, bool verbose)
1400 owner->updateMenubar();
1401 owner->updateToolbar();
1403 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1404 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1406 owner->message(msg);
1410 string dispatch_msg = msg;
1411 if (!dispatch_msg.empty())
1412 dispatch_msg += ' ';
1414 string comname = lyxaction.getActionName(cmd.action);
1416 bool argsadded = false;
1418 if (!cmd.argument.empty()) {
1419 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1420 comname += ' ' + cmd.argument;
1425 string const shortcuts = toplevel_keymap->findbinding(cmd);
1427 if (!shortcuts.empty()) {
1428 comname += ": " + shortcuts;
1429 } else if (!argsadded && !cmd.argument.empty()) {
1430 comname += ' ' + cmd.argument;
1433 if (!comname.empty()) {
1434 comname = rtrim(comname);
1435 dispatch_msg += '(' + comname + ')';
1438 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1439 if (!dispatch_msg.empty())
1440 owner->message(dispatch_msg);
1444 void LyXFunc::setupLocalKeymap()
1446 keyseq.stdmap = toplevel_keymap.get();
1447 keyseq.curmap = toplevel_keymap.get();
1448 cancel_meta_seq.stdmap = toplevel_keymap.get();
1449 cancel_meta_seq.curmap = toplevel_keymap.get();
1453 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1455 string initpath = lyxrc.document_path;
1456 string filename(name);
1458 if (view()->available()) {
1459 string const trypath = owner->buffer()->filePath();
1460 // If directory is writeable, use this as default.
1461 if (IsDirWriteable(trypath))
1465 static int newfile_number;
1467 if (filename.empty()) {
1468 filename = AddName(lyxrc.document_path,
1469 "newfile" + tostr(++newfile_number) + ".lyx");
1470 FileInfo fi(filename);
1471 while (bufferlist.exists(filename) || fi.readable()) {
1473 filename = AddName(lyxrc.document_path,
1474 "newfile" + tostr(newfile_number) +
1476 fi.newFile(filename);
1480 // The template stuff
1483 FileDialog fileDlg(_("Select template file"),
1484 LFUN_SELECT_FILE_SYNC,
1485 make_pair(string(_("Documents|#o#O")),
1486 string(lyxrc.document_path)),
1487 make_pair(string(_("Templates|#T#t")),
1488 string(lyxrc.template_path)));
1490 FileDialog::Result result =
1491 fileDlg.open(lyxrc.template_path,
1492 FileFilterList(_("LyX Documents (*.lyx)")),
1495 if (result.first == FileDialog::Later)
1497 if (result.second.empty())
1499 templname = result.second;
1502 view()->newFile(filename, templname, !name.empty());
1506 void LyXFunc::open(string const & fname)
1508 string initpath = lyxrc.document_path;
1510 if (view()->available()) {
1511 string const trypath = owner->buffer()->filePath();
1512 // If directory is writeable, use this as default.
1513 if (IsDirWriteable(trypath))
1519 if (fname.empty()) {
1520 FileDialog fileDlg(_("Select document to open"),
1522 make_pair(string(_("Documents|#o#O")),
1523 string(lyxrc.document_path)),
1524 make_pair(string(_("Examples|#E#e")),
1525 string(AddPath(system_lyxdir(), "examples"))));
1527 FileDialog::Result result =
1528 fileDlg.open(initpath,
1529 FileFilterList(_("LyX Documents (*.lyx)")),
1532 if (result.first == FileDialog::Later)
1535 filename = result.second;
1537 // check selected filename
1538 if (filename.empty()) {
1539 owner->message(_("Canceled."));
1545 // get absolute path of file and add ".lyx" to the filename if
1547 string const fullpath = FileSearch(string(), filename, "lyx");
1548 if (!fullpath.empty()) {
1549 filename = fullpath;
1552 string const disp_fn(MakeDisplayPath(filename));
1554 // if the file doesn't exist, let the user create one
1555 FileInfo const f(filename, true);
1557 // the user specifically chose this name. Believe them.
1558 view()->newFile(filename, "", true);
1562 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1565 if (view()->loadLyXFile(filename)) {
1566 str2 = bformat(_("Document %1$s opened."), disp_fn);
1568 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1570 owner->message(str2);
1574 void LyXFunc::doImport(string const & argument)
1577 string filename = split(argument, format, ' ');
1579 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1580 << " file: " << filename << endl;
1582 // need user interaction
1583 if (filename.empty()) {
1584 string initpath = lyxrc.document_path;
1586 if (view()->available()) {
1587 string const trypath = owner->buffer()->filePath();
1588 // If directory is writeable, use this as default.
1589 if (IsDirWriteable(trypath))
1593 string const text = bformat(_("Select %1$s file to import"),
1594 formats.prettyName(format));
1596 FileDialog fileDlg(text,
1598 make_pair(string(_("Documents|#o#O")),
1599 string(lyxrc.document_path)),
1600 make_pair(string(_("Examples|#E#e")),
1601 string(AddPath(system_lyxdir(), "examples"))));
1603 string const filter = formats.prettyName(format)
1604 + " (*." + formats.extension(format) + ')';
1606 FileDialog::Result result =
1607 fileDlg.open(initpath,
1608 FileFilterList(filter),
1611 if (result.first == FileDialog::Later)
1614 filename = result.second;
1616 // check selected filename
1617 if (filename.empty())
1618 owner->message(_("Canceled."));
1621 if (filename.empty())
1624 // get absolute path of file
1625 filename = MakeAbsPath(filename);
1627 string const lyxfile = ChangeExtension(filename, ".lyx");
1629 // Check if the document already is open
1630 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1631 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1632 owner->message(_("Canceled."));
1637 // if the file exists already, and we didn't do
1638 // -i lyx thefile.lyx, warn
1639 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1640 string const file = MakeDisplayPath(lyxfile, 30);
1642 string text = bformat(_("The document %1$s already exists.\n\n"
1643 "Do you want to over-write that document?"), file);
1644 int const ret = Alert::prompt(_("Over-write document?"),
1645 text, 0, 1, _("&Over-write"), _("&Cancel"));
1648 owner->message(_("Canceled."));
1653 Importer::Import(owner, filename, format);
1657 void LyXFunc::closeBuffer()
1659 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1660 if (bufferlist.empty()) {
1661 // need this otherwise SEGV may occur while
1662 // trying to set variables that don't exist
1663 // since there's no current buffer
1664 owner->getDialogs().hideBufferDependent();
1666 view()->setBuffer(bufferlist.first());
1672 // Each "owner" should have it's own message method. lyxview and
1673 // the minibuffer would use the minibuffer, but lyxserver would
1674 // send an ERROR signal to its client. Alejandro 970603
1675 // This function is bit problematic when it comes to NLS, to make the
1676 // lyx servers client be language indepenent we must not translate
1677 // strings sent to this func.
1678 void LyXFunc::setErrorMessage(string const & m) const
1680 dispatch_buffer = m;
1685 void LyXFunc::setMessage(string const & m) const
1687 dispatch_buffer = m;
1691 void LyXFunc::setStatusMessage(string const & m) const
1697 string const LyXFunc::viewStatusMessage()
1699 // When meta-fake key is pressed, show the key sequence so far + "M-".
1701 return keyseq.print() + "M-";
1703 // Else, when a non-complete key sequence is pressed,
1704 // show the available options.
1705 if (keyseq.length() > 0 && !keyseq.deleted())
1706 return keyseq.printOptions();
1708 if (!view()->available())
1709 return _("Welcome to LyX!");
1711 return view()->cursor().currentState();
1715 BufferView * LyXFunc::view() const
1717 BOOST_ASSERT(owner);
1718 return owner->view().get();
1722 bool LyXFunc::wasMetaKey() const
1724 return (meta_fake_bit != key_modifier::none);