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);
434 case LFUN_MENUNEWTMPLT:
435 case LFUN_WORDFINDFORWARD:
436 case LFUN_WORDFINDBACKWARD:
438 case LFUN_EXEC_COMMAND:
441 case LFUN_CLOSEBUFFER:
450 case LFUN_RECONFIGURE:
454 case LFUN_DROP_LAYOUTS_CHOICE:
455 case LFUN_MENU_OPEN_BY_NAME:
458 case LFUN_GOTOFILEROW:
459 case LFUN_GOTO_PARAGRAPH:
460 case LFUN_DIALOG_SHOW_NEW_INSET:
461 case LFUN_DIALOG_SHOW_NEXT_INSET:
462 case LFUN_DIALOG_UPDATE:
463 case LFUN_DIALOG_HIDE:
464 case LFUN_DIALOG_DISCONNECT_INSET:
466 case LFUN_TOGGLECURSORFOLLOW:
470 case LFUN_KMAP_TOGGLE:
472 case LFUN_EXPORT_CUSTOM:
475 case LFUN_SAVEPREFERENCES:
476 case LFUN_SCREEN_FONT_UPDATE:
479 case LFUN_EXTERNAL_EDIT:
480 case LFUN_ALL_INSETS_TOGGLE:
481 case LFUN_LANGUAGE_BUFFER:
482 case LFUN_TEXTCLASS_APPLY:
483 case LFUN_TEXTCLASS_LOAD:
484 case LFUN_SAVE_AS_DEFAULT:
485 case LFUN_BUFFERPARAMS_APPLY:
486 case LFUN_LYXRC_APPLY:
487 // these are handled in our dispatch()
492 cur.getStatus(cmd, flag);
494 flag = view()->getStatus(cmd);
500 // Can we use a readonly buffer?
501 if (buf && buf->isReadonly()
502 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly)
503 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)) {
504 setStatusMessage(N_("Document is read-only"));
514 bool ensureBufferClean(BufferView * bv)
516 Buffer & buf = *bv->buffer();
520 string const file = MakeDisplayPath(buf.fileName(), 30);
521 string text = bformat(_("The document %1$s has unsaved "
522 "changes.\n\nDo you want to save "
523 "the document?"), file);
524 int const ret = Alert::prompt(_("Save changed document?"),
525 text, 0, 1, _("&Save"),
529 bv->owner()->dispatch(FuncRequest(LFUN_MENUWRITE));
531 return buf.isClean();
535 void showPrintError(string const & name)
537 string str = bformat(_("Could not print the document %1$s.\n"
538 "Check that your printer is set up correctly."),
539 MakeDisplayPath(name, 50));
540 Alert::error(_("Print document failed"), str);
544 void loadTextclass(string const & name)
546 std::pair<bool, lyx::textclass_type> const tc_pair =
547 textclasslist.NumberOfClass(name);
549 if (!tc_pair.first) {
550 lyxerr << "Document class \"" << name
551 << "\" does not exist."
556 lyx::textclass_type const tc = tc_pair.second;
558 if (!textclasslist[tc].load()) {
559 string s = bformat(_("The document could not be converted\n"
560 "into the document class %1$s."),
561 textclasslist[tc].name());
562 Alert::error(_("Could not change class"), s);
569 void LyXFunc::dispatch(FuncRequest const & cmd, bool verbose)
571 string const argument = cmd.argument;
572 kb_action const action = cmd.action;
574 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: cmd: " << cmd << endl;
575 //lyxerr << "LyXFunc::dispatch: cmd: " << cmd << endl;
577 // we have not done anything wrong yet.
579 dispatch_buffer.erase();
580 selection_possible = false;
582 // We cannot use this function here
583 if (!getStatus(cmd).enabled()) {
584 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
585 << lyxaction.getActionName(action)
586 << " [" << action << "] is disabled at this location"
588 setErrorMessage(getStatusMessage());
592 if (view()->available())
593 view()->hideCursor();
597 case LFUN_WORDFINDFORWARD:
598 case LFUN_WORDFINDBACKWARD: {
599 static string last_search;
600 string searched_string;
602 if (!argument.empty()) {
603 last_search = argument;
604 searched_string = argument;
606 searched_string = last_search;
609 if (searched_string.empty())
612 bool const fw = action == LFUN_WORDFINDFORWARD;
614 lyx::find::find2string(searched_string, true, false, fw);
615 lyx::find::find(view(), FuncRequest(LFUN_WORD_FIND, data));
620 owner->message(keyseq.printOptions());
623 case LFUN_EXEC_COMMAND:
624 owner->focus_command_buffer();
629 meta_fake_bit = key_modifier::none;
630 if (view()->available())
631 // cancel any selection
632 dispatch(FuncRequest(LFUN_MARK_OFF));
633 setMessage(N_("Cancel"));
637 meta_fake_bit = key_modifier::alt;
638 setMessage(keyseq.print());
641 case LFUN_READ_ONLY_TOGGLE:
642 if (owner->buffer()->lyxvc().inUse())
643 owner->buffer()->lyxvc().toggleReadOnly();
645 owner->buffer()->setReadonly(
646 !owner->buffer()->isReadonly());
649 // --- Menus -----------------------------------------------
651 menuNew(argument, false);
654 case LFUN_MENUNEWTMPLT:
655 menuNew(argument, true);
658 case LFUN_CLOSEBUFFER:
663 if (!owner->buffer()->isUnnamed()) {
664 string const str = bformat(_("Saving document %1$s..."),
665 MakeDisplayPath(owner->buffer()->fileName()));
667 MenuWrite(owner->buffer());
668 owner->message(str + _(" done."));
670 WriteAs(owner->buffer());
674 WriteAs(owner->buffer(), argument);
677 case LFUN_MENURELOAD: {
678 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
679 string text = bformat(_("Any changes will be lost. Are you sure "
680 "you want to revert to the saved version of the document %1$s?"), file);
681 int const ret = Alert::prompt(_("Revert to saved document?"),
682 text, 0, 1, _("&Revert"), _("&Cancel"));
690 Exporter::Export(owner->buffer(), argument, true);
691 view()->showErrorList(BufferFormat(*owner->buffer()));
695 Exporter::Preview(owner->buffer(), argument);
696 view()->showErrorList(BufferFormat(*owner->buffer()));
700 Exporter::Export(owner->buffer(), "program", true);
701 view()->showErrorList(_("Build"));
705 owner->buffer()->runChktex();
706 view()->showErrorList(_("ChkTeX"));
710 if (argument == "custom")
711 owner->getDialogs().show("sendto");
713 Exporter::Export(owner->buffer(), argument, false);
714 view()->showErrorList(BufferFormat(*owner->buffer()));
718 case LFUN_EXPORT_CUSTOM: {
720 string command = split(argument, format_name, ' ');
721 Format const * format = formats.getFormat(format_name);
723 lyxerr << "Format \"" << format_name
724 << "\" not recognized!"
729 Buffer * buffer = owner->buffer();
731 // The name of the file created by the conversion process
734 // Output to filename
735 if (format->name() == "lyx") {
736 string const latexname =
737 buffer->getLatexName(false);
738 filename = ChangeExtension(latexname,
739 format->extension());
740 filename = AddName(buffer->temppath(), filename);
742 if (!buffer->writeFile(filename))
746 Exporter::Export(buffer, format_name, true,
750 // Substitute $$FName for filename
751 if (!contains(command, "$$FName"))
752 command = "( " + command + " ) < $$FName";
753 command = subst(command, "$$FName", filename);
755 // Execute the command in the background
757 call.startscript(Systemcall::DontWait, command);
764 string command = split(split(argument, target, ' '),
768 || target_name.empty()
769 || command.empty()) {
770 lyxerr << "Unable to parse \""
771 << argument << '"' << std::endl;
774 if (target != "printer" && target != "file") {
775 lyxerr << "Unrecognized target \""
776 << target << '"' << std::endl;
780 Buffer * buffer = owner->buffer();
782 if (!Exporter::Export(buffer, "dvi", true)) {
783 showPrintError(buffer->fileName());
787 // Push directory path.
788 string const path = buffer->temppath();
791 // there are three cases here:
792 // 1. we print to a file
793 // 2. we print directly to a printer
794 // 3. we print using a spool command (print to file first)
797 string const dviname =
798 ChangeExtension(buffer->getLatexName(true),
801 if (target == "printer") {
802 if (!lyxrc.print_spool_command.empty()) {
803 // case 3: print using a spool
804 string const psname =
805 ChangeExtension(dviname,".ps");
806 command += lyxrc.print_to_file
809 + QuoteName(dviname);
812 lyxrc.print_spool_command +' ';
813 if (target_name != "default") {
814 command2 += lyxrc.print_spool_printerprefix
818 command2 += QuoteName(psname);
820 // If successful, then spool command
821 res = one.startscript(
826 res = one.startscript(
827 Systemcall::DontWait,
830 // case 2: print directly to a printer
831 res = one.startscript(
832 Systemcall::DontWait,
833 command + QuoteName(dviname));
837 // case 1: print to a file
838 command += lyxrc.print_to_file
839 + QuoteName(MakeAbsPath(target_name,
842 + QuoteName(dviname);
843 res = one.startscript(Systemcall::DontWait,
848 showPrintError(buffer->fileName());
861 InsetCommandParams p("tableofcontents");
862 string const data = InsetCommandMailer::params2string("toc", p);
863 owner->getDialogs().show("toc", data, 0);
871 case LFUN_RECONFIGURE:
875 case LFUN_HELP_OPEN: {
876 string const arg = argument;
878 setErrorMessage(N_("Missing argument"));
881 string const fname = i18nLibFileSearch("doc", arg, "lyx");
883 lyxerr << "LyX: unable to find documentation file `"
884 << arg << "'. Bad installation?" << endl;
887 owner->message(bformat(_("Opening help file %1$s..."),
888 MakeDisplayPath(fname)));
889 view()->loadLyXFile(fname, false);
893 // --- version control -------------------------------
894 case LFUN_VC_REGISTER:
895 if (!ensureBufferClean(view()))
897 if (!owner->buffer()->lyxvc().inUse()) {
898 owner->buffer()->lyxvc().registrer();
903 case LFUN_VC_CHECKIN:
904 if (!ensureBufferClean(view()))
906 if (owner->buffer()->lyxvc().inUse()
907 && !owner->buffer()->isReadonly()) {
908 owner->buffer()->lyxvc().checkIn();
913 case LFUN_VC_CHECKOUT:
914 if (!ensureBufferClean(view()))
916 if (owner->buffer()->lyxvc().inUse()
917 && owner->buffer()->isReadonly()) {
918 owner->buffer()->lyxvc().checkOut();
924 owner->buffer()->lyxvc().revert();
929 owner->buffer()->lyxvc().undoLast();
933 // --- buffers ----------------------------------------
934 case LFUN_SWITCHBUFFER:
935 view()->setBuffer(bufferlist.getBuffer(argument));
939 NewFile(view(), argument);
946 case LFUN_DROP_LAYOUTS_CHOICE:
947 owner->getToolbar().openLayoutList();
950 case LFUN_MENU_OPEN_BY_NAME:
951 owner->getMenubar().openByName(argument);
954 // --- lyxserver commands ----------------------------
956 setMessage(owner->buffer()->fileName());
957 lyxerr[Debug::INFO] << "FNAME["
958 << owner->buffer()->fileName()
963 dispatch_buffer = keyseq.print();
964 lyxserver->notifyClient(dispatch_buffer);
967 case LFUN_GOTOFILEROW: {
970 istringstream is(argument);
971 is >> file_name >> row;
972 if (prefixIs(file_name, getTmpDir())) {
973 // Needed by inverse dvi search. If it is a file
974 // in tmpdir, call the apropriated function
975 view()->setBuffer(bufferlist.getBufferFromTmp(file_name));
977 // Must replace extension of the file to be .lyx
979 string const s = ChangeExtension(file_name, ".lyx");
980 // Either change buffer or load the file
981 if (bufferlist.exists(s)) {
982 view()->setBuffer(bufferlist.getBuffer(s));
984 view()->loadLyXFile(s);
988 view()->setCursorFromRow(row);
991 // see BufferView_pimpl::center()
992 view()->updateScrollbar();
996 case LFUN_GOTO_PARAGRAPH: {
997 istringstream is(argument);
1000 ParIterator par = owner->buffer()->getParFromID(id);
1001 if (par == owner->buffer()->par_iterator_end()) {
1002 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1003 << id << ']' << endl;
1006 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1007 << " found." << endl;
1011 view()->setCursor(par, 0);
1013 view()->switchKeyMap();
1014 owner->view_state_changed();
1017 // see BufferView_pimpl::center()
1018 view()->updateScrollbar();
1022 case LFUN_DIALOG_SHOW: {
1023 string const name = cmd.getArg(0);
1024 string data = trim(cmd.argument.substr(name.size()));
1026 if (name == "character") {
1027 data = freefont2string();
1029 owner->getDialogs().show("character", data);
1032 else if (name == "latexlog") {
1033 pair<Buffer::LogType, string> const logfile =
1034 owner->buffer()->getLogName();
1035 switch (logfile.first) {
1036 case Buffer::latexlog:
1039 case Buffer::buildlog:
1043 data += logfile.second;
1044 owner->getDialogs().show("log", data);
1046 else if (name == "vclog") {
1047 string const data = "vc " +
1048 owner->buffer()->lyxvc().getLogFile();
1049 owner->getDialogs().show("log", data);
1052 owner->getDialogs().show(name, data);
1056 case LFUN_DIALOG_SHOW_NEW_INSET: {
1057 string const name = cmd.getArg(0);
1058 string data = trim(cmd.argument.substr(name.size()));
1059 if (name == "bibitem" ||
1061 name == "include" ||
1067 InsetCommandParams p(name);
1068 data = InsetCommandMailer::params2string(name, p);
1069 } else if (name == "box") {
1070 // \c data == "Boxed" || "Frameless" etc
1071 InsetBoxParams p(data);
1072 data = InsetBoxMailer::params2string(p);
1073 } else if (name == "branch") {
1074 InsetBranchParams p;
1075 data = InsetBranchMailer::params2string(p);
1076 } else if (name == "citation") {
1077 InsetCommandParams p("cite");
1078 data = InsetCommandMailer::params2string(name, p);
1079 } else if (name == "ert") {
1080 data = InsetERTMailer::params2string(InsetCollapsable::Open);
1081 } else if (name == "external") {
1082 InsetExternalParams p;
1083 Buffer const & buffer = *owner->buffer();
1084 data = InsetExternalMailer::params2string(p, buffer);
1085 } else if (name == "float") {
1087 data = InsetFloatMailer::params2string(p);
1088 } else if (name == "graphics") {
1089 InsetGraphicsParams p;
1090 Buffer const & buffer = *owner->buffer();
1091 data = InsetGraphicsMailer::params2string(p, buffer);
1092 } else if (name == "note") {
1094 data = InsetNoteMailer::params2string(p);
1095 } else if (name == "vspace") {
1097 data = InsetVSpaceMailer::params2string(space);
1098 } else if (name == "wrap") {
1100 data = InsetWrapMailer::params2string(p);
1102 owner->getDialogs().show(name, data, 0);
1106 case LFUN_DIALOG_SHOW_NEXT_INSET:
1109 case LFUN_DIALOG_UPDATE: {
1110 string const & name = argument;
1111 // Can only update a dialog connected to an existing inset
1112 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1114 FuncRequest fr(LFUN_INSET_DIALOG_UPDATE, cmd.argument);
1115 inset->dispatch(view()->cursor(), fr);
1116 } else if (name == "paragraph") {
1117 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1122 case LFUN_DIALOG_HIDE:
1123 Dialogs::hide(argument, 0);
1126 case LFUN_DIALOG_DISCONNECT_INSET:
1127 owner->getDialogs().disconnect(argument);
1130 case LFUN_CHILDOPEN: {
1131 string const filename =
1132 MakeAbsPath(argument, owner->buffer()->filePath());
1133 setMessage(N_("Opening child document ") +
1134 MakeDisplayPath(filename) + "...");
1135 view()->savePosition(0);
1136 string const parentfilename = owner->buffer()->fileName();
1137 if (bufferlist.exists(filename))
1138 view()->setBuffer(bufferlist.getBuffer(filename));
1140 view()->loadLyXFile(filename);
1141 // Set the parent name of the child document.
1142 // This makes insertion of citations and references in the child work,
1143 // when the target is in the parent or another child document.
1144 owner->buffer()->setParentName(parentfilename);
1148 case LFUN_TOGGLECURSORFOLLOW:
1149 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1153 owner->getIntl().KeyMapOn(false);
1156 case LFUN_KMAP_PRIM:
1157 owner->getIntl().KeyMapPrim();
1161 owner->getIntl().KeyMapSec();
1164 case LFUN_KMAP_TOGGLE:
1165 owner->getIntl().ToggleKeyMap();
1171 string rest = split(argument, countstr, ' ');
1172 istringstream is(countstr);
1175 lyxerr << "repeat: count: " << count << " cmd: " << rest << endl;
1176 for (int i = 0; i < count; ++i)
1177 dispatch(lyxaction.lookupFunc(rest));
1182 // argument contains ';'-terminated commands
1183 while (!argument.empty()) {
1185 string rest = split(argument, first, ';');
1186 dispatch(lyxaction.lookupFunc(rest));
1190 case LFUN_SAVEPREFERENCES: {
1191 Path p(user_lyxdir());
1192 lyxrc.write("preferences");
1196 case LFUN_SCREEN_FONT_UPDATE:
1197 // handle the screen font changes.
1198 lyxrc.set_font_norm_type();
1199 lyx_gui::update_fonts();
1200 // All visible buffers will need resize
1204 case LFUN_SET_COLOR: {
1206 string const x11_name = split(argument, lyx_name, ' ');
1207 if (lyx_name.empty() || x11_name.empty()) {
1208 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1213 bool const graphicsbg_changed =
1214 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1215 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1217 if (!lcolor.setColor(lyx_name, x11_name)) {
1219 bformat(_("Set-color \"%1$s\" failed "
1220 "- color is undefined or "
1221 "may not be redefined"), lyx_name));
1225 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1227 if (graphicsbg_changed) {
1228 #ifdef WITH_WARNINGS
1229 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1232 lyx::graphics::GCache::get().changeDisplay(true);
1239 owner->message(argument);
1242 case LFUN_TOOLTIPS_TOGGLE:
1243 owner->getDialogs().toggleTooltips();
1246 case LFUN_EXTERNAL_EDIT: {
1247 FuncRequest fr(action, argument);
1248 InsetExternal().dispatch(view()->cursor(), fr);
1252 case LFUN_BREAKLINE: {
1253 #warning swallow 'Return' if the minibuffer is focused. But how?
1257 case LFUN_ALL_INSETS_TOGGLE: {
1259 string const name = split(argument, action, ' ');
1260 InsetBase::Code const inset_code =
1261 InsetBase::translate(name);
1263 LCursor & cur = view()->cursor();
1264 FuncRequest fr(LFUN_INSET_TOGGLE, action);
1266 InsetBase & inset = owner->buffer()->inset();
1267 InsetIterator it = inset_iterator_begin(inset);
1268 InsetIterator const end = inset_iterator_end(inset);
1269 for (; it != end; ++it) {
1270 if (inset_code == InsetBase::NO_CODE
1271 || inset_code == it->lyxCode())
1272 it->dispatch(cur, fr);
1277 case LFUN_LANGUAGE_BUFFER: {
1278 Buffer & buffer = *owner->buffer();
1279 Language const * oldL = buffer.params().language;
1280 Language const * newL = languages.getLanguage(argument);
1281 if (!newL || oldL == newL)
1284 if (oldL->RightToLeft() == newL->RightToLeft()
1285 && !buffer.isMultiLingual())
1286 buffer.changeLanguage(oldL, newL);
1288 buffer.updateDocLang(newL);
1292 case LFUN_BUFFERPARAMS_APPLY: {
1293 istringstream ss(argument);
1296 int const unknown_tokens =
1297 owner->buffer()->readHeader(lex);
1299 if (unknown_tokens != 0) {
1300 lyxerr << "Warning in LFUN_BUFFERPARAMS_APPLY!\n"
1301 << unknown_tokens << " unknown token"
1302 << (unknown_tokens == 1 ? "" : "s")
1308 case LFUN_TEXTCLASS_APPLY: {
1309 Buffer * buffer = owner->buffer();
1311 lyx::textclass_type const old_class =
1312 buffer->params().textclass;
1314 loadTextclass(argument);
1316 std::pair<bool, lyx::textclass_type> const tc_pair =
1317 textclasslist.NumberOfClass(argument);
1322 lyx::textclass_type const new_class = tc_pair.second;
1323 if (old_class == new_class)
1327 owner->message(_("Converting document to new document class..."));
1329 lyx::cap::SwitchLayoutsBetweenClasses(
1330 old_class, new_class,
1331 buffer->paragraphs(), el);
1333 bufferErrors(*buffer, el);
1334 view()->showErrorList(_("Class switch"));
1338 case LFUN_TEXTCLASS_LOAD:
1339 loadTextclass(argument);
1342 case LFUN_LYXRC_APPLY: {
1343 istringstream ss(argument);
1344 bool const success = lyxrc.read(ss) == 0;
1347 lyxerr << "Warning in LFUN_LYXRC_APPLY!\n"
1348 << "Unable to read lyxrc data"
1355 DispatchResult res = view()->cursor().dispatch(cmd);
1356 if (!res.dispatched());
1357 view()->dispatch(cmd);
1362 if (view()->available()) {
1363 view()->fitCursor();
1365 view()->cursor().updatePos();
1366 // if we executed a mutating lfun, mark the buffer as dirty
1367 if (getStatus(cmd).enabled()
1368 && !lyxaction.funcHasFlag(cmd.action, LyXAction::NoBuffer)
1369 && !lyxaction.funcHasFlag(cmd.action, LyXAction::ReadOnly))
1370 view()->buffer()->markDirty();
1373 if (view()->cursor().inTexted()) {
1374 view()->owner()->updateLayoutChoice();
1375 sendDispatchMessage(getMessage(), cmd, verbose);
1381 void LyXFunc::sendDispatchMessage(string const & msg,
1382 FuncRequest const & cmd, bool verbose)
1384 owner->updateMenubar();
1385 owner->updateToolbar();
1387 if (cmd.action == LFUN_SELFINSERT || !verbose) {
1388 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1390 owner->message(msg);
1394 string dispatch_msg = msg;
1395 if (!dispatch_msg.empty())
1396 dispatch_msg += ' ';
1398 string comname = lyxaction.getActionName(cmd.action);
1400 bool argsadded = false;
1402 if (!cmd.argument.empty()) {
1403 if (cmd.action != LFUN_UNKNOWN_ACTION) {
1404 comname += ' ' + cmd.argument;
1409 string const shortcuts = toplevel_keymap->findbinding(cmd);
1411 if (!shortcuts.empty()) {
1412 comname += ": " + shortcuts;
1413 } else if (!argsadded && !cmd.argument.empty()) {
1414 comname += ' ' + cmd.argument;
1417 if (!comname.empty()) {
1418 comname = rtrim(comname);
1419 dispatch_msg += '(' + comname + ')';
1422 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1423 if (!dispatch_msg.empty())
1424 owner->message(dispatch_msg);
1428 void LyXFunc::setupLocalKeymap()
1430 keyseq.stdmap = toplevel_keymap.get();
1431 keyseq.curmap = toplevel_keymap.get();
1432 cancel_meta_seq.stdmap = toplevel_keymap.get();
1433 cancel_meta_seq.curmap = toplevel_keymap.get();
1437 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1439 string initpath = lyxrc.document_path;
1440 string filename(name);
1442 if (view()->available()) {
1443 string const trypath = owner->buffer()->filePath();
1444 // If directory is writeable, use this as default.
1445 if (IsDirWriteable(trypath))
1449 static int newfile_number;
1451 if (filename.empty()) {
1452 filename = AddName(lyxrc.document_path,
1453 "newfile" + tostr(++newfile_number) + ".lyx");
1454 FileInfo fi(filename);
1455 while (bufferlist.exists(filename) || fi.readable()) {
1457 filename = AddName(lyxrc.document_path,
1458 "newfile" + tostr(newfile_number) +
1460 fi.newFile(filename);
1464 // The template stuff
1467 FileDialog fileDlg(_("Select template file"),
1468 LFUN_SELECT_FILE_SYNC,
1469 make_pair(string(_("Documents|#o#O")),
1470 string(lyxrc.document_path)),
1471 make_pair(string(_("Templates|#T#t")),
1472 string(lyxrc.template_path)));
1474 FileDialog::Result result =
1475 fileDlg.open(lyxrc.template_path,
1476 FileFilterList(_("LyX Documents (*.lyx)")),
1479 if (result.first == FileDialog::Later)
1481 if (result.second.empty())
1483 templname = result.second;
1486 view()->newFile(filename, templname, !name.empty());
1490 void LyXFunc::open(string const & fname)
1492 string initpath = lyxrc.document_path;
1494 if (view()->available()) {
1495 string const trypath = owner->buffer()->filePath();
1496 // If directory is writeable, use this as default.
1497 if (IsDirWriteable(trypath))
1503 if (fname.empty()) {
1504 FileDialog fileDlg(_("Select document to open"),
1506 make_pair(string(_("Documents|#o#O")),
1507 string(lyxrc.document_path)),
1508 make_pair(string(_("Examples|#E#e")),
1509 string(AddPath(system_lyxdir(), "examples"))));
1511 FileDialog::Result result =
1512 fileDlg.open(initpath,
1513 FileFilterList(_("LyX Documents (*.lyx)")),
1516 if (result.first == FileDialog::Later)
1519 filename = result.second;
1521 // check selected filename
1522 if (filename.empty()) {
1523 owner->message(_("Canceled."));
1529 // get absolute path of file and add ".lyx" to the filename if
1531 string const fullpath = FileSearch(string(), filename, "lyx");
1532 if (!fullpath.empty()) {
1533 filename = fullpath;
1536 string const disp_fn(MakeDisplayPath(filename));
1538 // if the file doesn't exist, let the user create one
1539 FileInfo const f(filename, true);
1541 // the user specifically chose this name. Believe them.
1542 view()->newFile(filename, "", true);
1546 owner->message(bformat(_("Opening document %1$s..."), disp_fn));
1549 if (view()->loadLyXFile(filename)) {
1550 str2 = bformat(_("Document %1$s opened."), disp_fn);
1552 str2 = bformat(_("Could not open document %1$s"), disp_fn);
1554 owner->message(str2);
1558 void LyXFunc::doImport(string const & argument)
1561 string filename = split(argument, format, ' ');
1563 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1564 << " file: " << filename << endl;
1566 // need user interaction
1567 if (filename.empty()) {
1568 string initpath = lyxrc.document_path;
1570 if (view()->available()) {
1571 string const trypath = owner->buffer()->filePath();
1572 // If directory is writeable, use this as default.
1573 if (IsDirWriteable(trypath))
1577 string const text = bformat(_("Select %1$s file to import"),
1578 formats.prettyName(format));
1580 FileDialog fileDlg(text,
1582 make_pair(string(_("Documents|#o#O")),
1583 string(lyxrc.document_path)),
1584 make_pair(string(_("Examples|#E#e")),
1585 string(AddPath(system_lyxdir(), "examples"))));
1587 string const filter = formats.prettyName(format)
1588 + " (*." + formats.extension(format) + ')';
1590 FileDialog::Result result =
1591 fileDlg.open(initpath,
1592 FileFilterList(filter),
1595 if (result.first == FileDialog::Later)
1598 filename = result.second;
1600 // check selected filename
1601 if (filename.empty())
1602 owner->message(_("Canceled."));
1605 if (filename.empty())
1608 // get absolute path of file
1609 filename = MakeAbsPath(filename);
1611 string const lyxfile = ChangeExtension(filename, ".lyx");
1613 // Check if the document already is open
1614 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1615 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1616 owner->message(_("Canceled."));
1621 // if the file exists already, and we didn't do
1622 // -i lyx thefile.lyx, warn
1623 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1624 string const file = MakeDisplayPath(lyxfile, 30);
1626 string text = bformat(_("The document %1$s already exists.\n\n"
1627 "Do you want to over-write that document?"), file);
1628 int const ret = Alert::prompt(_("Over-write document?"),
1629 text, 0, 1, _("&Over-write"), _("&Cancel"));
1632 owner->message(_("Canceled."));
1637 Importer::Import(owner, filename, format);
1641 void LyXFunc::closeBuffer()
1643 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1644 if (bufferlist.empty()) {
1645 // need this otherwise SEGV may occur while
1646 // trying to set variables that don't exist
1647 // since there's no current buffer
1648 owner->getDialogs().hideBufferDependent();
1650 view()->setBuffer(bufferlist.first());
1656 // Each "owner" should have it's own message method. lyxview and
1657 // the minibuffer would use the minibuffer, but lyxserver would
1658 // send an ERROR signal to its client. Alejandro 970603
1659 // This function is bit problematic when it comes to NLS, to make the
1660 // lyx servers client be language indepenent we must not translate
1661 // strings sent to this func.
1662 void LyXFunc::setErrorMessage(string const & m) const
1664 dispatch_buffer = m;
1669 void LyXFunc::setMessage(string const & m) const
1671 dispatch_buffer = m;
1675 void LyXFunc::setStatusMessage(string const & m) const
1681 string const LyXFunc::viewStatusMessage()
1683 // When meta-fake key is pressed, show the key sequence so far + "M-".
1685 return keyseq.print() + "M-";
1687 // Else, when a non-complete key sequence is pressed,
1688 // show the available options.
1689 if (keyseq.length() > 0 && !keyseq.deleted())
1690 return keyseq.printOptions();
1692 if (!view()->available())
1693 return _("Welcome to LyX!");
1695 return view()->cursor().currentState();
1699 BufferView * LyXFunc::view() const
1701 BOOST_ASSERT(owner);
1702 return owner->view().get();
1706 bool LyXFunc::wasMetaKey() const
1708 return (meta_fake_bit != key_modifier::none);