1 /* This file is part of
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * ====================================================== */
17 #include "bufferlist.h"
18 #include "BufferView.h"
19 #include "lyxserver.h"
23 #include "LyXAction.h"
29 #include "trans_mgr.h"
32 #include "bufferview_funcs.h"
33 #include "frontends/LyXView.h"
34 #include "frontends/lyx_gui.h"
36 #include "FloatList.h"
37 #include "converter.h"
40 #include "TextCache.h"
42 #include "undo_funcs.h"
43 #include "ParagraphParameters.h"
45 #include "insets/insetcommand.h"
46 #include "insets/insettabular.h"
48 #include "mathed/formulamacro.h"
49 #include "mathed/math_cursor.h"
50 #include "mathed/math_inset.h"
52 #include "frontends/FileDialog.h"
53 #include "frontends/Dialogs.h"
54 #include "frontends/Toolbar.h"
55 #include "frontends/Menubar.h"
56 #include "frontends/Alert.h"
58 #include "graphics/GraphicsCache.h"
60 #include "support/lyxalgo.h"
61 #include "support/LAssert.h"
62 #include "support/filetools.h"
63 #include "support/FileInfo.h"
64 #include "support/forkedcontr.h"
65 #include "support/lstrings.h"
66 #include "support/path.h"
67 #include "support/lyxfunctional.h"
69 #include "BoostFormat.h"
85 using std::back_inserter;
87 extern BufferList bufferlist;
88 extern LyXServer * lyxserver;
89 extern bool selection_possible;
91 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
94 extern tex_accent_struct get_accent(kb_action action);
96 extern void ShowLatexLog();
99 LyXFunc::LyXFunc(LyXView * o)
102 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
103 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
104 meta_fake_bit(key_modifier::none)
110 LyXText * LyXFunc::TEXT(bool flag = true) const
114 return view()->getLyXText();
119 void LyXFunc::moveCursorUpdate(bool flag, bool selecting)
121 if (selecting || TEXT(flag)->selection.mark()) {
122 TEXT(flag)->setSelection(view());
123 if (TEXT(flag)->bv_owner)
124 view()->toggleToggle();
126 view()->update(TEXT(flag), BufferView::SELECT|BufferView::FITCUR);
127 view()->showCursor();
129 view()->switchKeyMap();
133 void LyXFunc::handleKeyFunc(kb_action action)
135 char c = encoded_last_key;
137 if (keyseq.length()) {
141 owner->getIntl().getTransManager()
142 .deadkey(c, get_accent(action).accent, TEXT(false));
143 // Need to clear, in case the minibuffer calls these
146 // copied verbatim from do_accent_char
147 view()->update(TEXT(false),
148 BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
149 TEXT(false)->selection.cursor = TEXT(false)->cursor;
153 void LyXFunc::processKeySym(LyXKeySymPtr keysym,
154 key_modifier::state state)
158 if (lyxerr.debugging(Debug::KEY)) {
159 lyxerr << "KeySym is "
160 << keysym->getSymbolName()
164 // Do nothing if we have nothing (JMarc)
165 if (!keysym->isOK()) {
166 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
171 if (keysym->isModifier()) {
172 lyxerr[Debug::KEY] << "isModifier true" << endl;
176 Encoding const * encoding = view()->getEncoding();
178 encoded_last_key = keysym->getISOEncoded(encoding ? encoding->Name() : "");
180 // Do a one-deep top-level lookup for
181 // cancel and meta-fake keys. RVDK_PATCH_5
182 cancel_meta_seq.reset();
184 int action = cancel_meta_seq.addkey(keysym, state);
185 lyxerr[Debug::KEY] << "action first set to [" << action << ']' << endl;
187 // When not cancel or meta-fake, do the normal lookup.
188 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
189 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
190 if ((action != LFUN_CANCEL) && (action != LFUN_META_FAKE)) {
191 // remove Caps Lock and Mod2 as a modifiers
192 action = keyseq.addkey(keysym, (state | meta_fake_bit));
193 lyxerr[Debug::KEY] << "action now set to ["
194 << action << ']' << endl;
197 // Dont remove this unless you know what you are doing.
198 meta_fake_bit = key_modifier::none;
200 // can this happen now ?
201 if (action == LFUN_NOACTION) {
202 action = LFUN_PREFIX;
205 if (lyxerr.debugging(Debug::KEY)) {
206 lyxerr << "Key [action="
208 << keyseq.print() << ']'
212 // already here we know if it any point in going further
213 // why not return already here if action == -1 and
214 // num_bytes == 0? (Lgb)
216 if (keyseq.length() > 1) {
217 owner->message(keyseq.print());
221 // Maybe user can only reach the key via holding down shift.
222 // Let's see. But only if shift is the only modifier
223 if (action == LFUN_UNKNOWN_ACTION && state == key_modifier::shift) {
224 lyxerr[Debug::KEY] << "Trying without shift" << endl;
225 action = keyseq.addkey(keysym, key_modifier::none);
226 lyxerr[Debug::KEY] << "Action now " << action << endl;
229 if (action == LFUN_UNKNOWN_ACTION) {
230 // Hmm, we didn't match any of the keysequences. See
231 // if it's normal insertable text not already covered
233 if (keysym->isText() && keyseq.length() == 1) {
234 lyxerr[Debug::KEY] << "isText() is true, inserting." << endl;
235 action = LFUN_SELFINSERT;
237 lyxerr[Debug::KEY] << "Unknown, !isText() - giving up" << endl;
238 owner->message(_("Unknown function."));
243 if (action == LFUN_SELFINSERT) {
244 if (encoded_last_key != 0) {
246 arg += encoded_last_key;
248 dispatch(FuncRequest(view(), LFUN_SELFINSERT, arg));
250 lyxerr[Debug::KEY] << "SelfInsert arg[`"
251 << argument << "']" << endl;
259 FuncStatus LyXFunc::getStatus(int ac) const
261 return getStatus(lyxaction.retrieveActionArg(ac));
265 FuncStatus LyXFunc::getStatus(FuncRequest const & ev) const
268 Buffer * buf = owner->buffer();
270 if (ev.action == LFUN_NOACTION) {
271 setStatusMessage(N_("Nothing to do"));
272 return flag.disabled(true);
276 case LFUN_UNKNOWN_ACTION:
277 #ifndef HAVE_LIBAIKSAURUS
278 case LFUN_THESAURUS_ENTRY:
283 flag |= lyx_gui::getStatus(ev);
286 if (flag.unknown()) {
287 setStatusMessage(N_("Unknown action"));
291 // the default error message if we disable the command
292 setStatusMessage(N_("Command disabled"));
294 // Check whether we need a buffer
295 if (!lyxaction.funcHasFlag(ev.action, LyXAction::NoBuffer)) {
296 // Yes we need a buffer, do we have one?
299 // Can we use a readonly buffer?
300 if (buf->isReadonly() &&
301 !lyxaction.funcHasFlag(ev.action,
302 LyXAction::ReadOnly)) {
304 setStatusMessage(N_("Document is read-only"));
309 setStatusMessage(N_("Command not allowed with"
310 "out any document open"));
311 return flag.disabled(true);
315 UpdatableInset * tli = view()->theLockingInset();
317 // I would really like to avoid having this switch and rather try to
318 // encode this in the function itself.
319 bool disable = false;
322 disable = !Exporter::IsExportable(buf, "dvi")
323 || lyxrc.print_command == "none";
326 disable = ev.argument != "custom"
327 && !Exporter::IsExportable(buf, ev.argument);
330 disable = buf->undostack.empty();
333 disable = buf->redostack.empty();
338 UpdatableInset * in = tli;
339 if (in->lyxCode() != Inset::TABULAR_CODE) {
340 in = tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE);
342 if (in && static_cast<InsetTabular*>(in)->hasSelection()) {
347 disable = !mathcursor && !view()->getLyXText()->selection.set();
350 disable = lyxrc.chktex_command == "none";
353 disable = !Exporter::IsExportable(buf, "program");
356 case LFUN_LAYOUT_CHARACTER:
357 disable = tli && tli->lyxCode() == Inset::ERT_CODE;
360 case LFUN_LAYOUT_TABULAR:
362 || (tli->lyxCode() != Inset::TABULAR_CODE
363 && !tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
367 case LFUN_LAYOUT_PARAGRAPH: {
368 Inset * inset = TEXT(false)->cursor.par()->inInset();
369 disable = inset && inset->forceDefaultParagraphs(inset);
373 case LFUN_INSET_OPTARG:
374 disable = (TEXT(false)->cursor.par()->layout()->optionalargs == 0);
377 case LFUN_TABULAR_FEATURE:
380 // FIXME: check temporarily disabled
382 char align = mathcursor->valign();
387 if (ev.argument.empty()) {
391 if (!contains("tcb", ev.argument[0])) {
395 flag.setOnOff(ev.argument[0] == align);
399 char align = mathcursor->halign();
404 if (ev.argument.empty()) {
408 if (!contains("lcr", ev.argument[0])) {
412 flag.setOnOff(ev.argument[0] == align);
415 disable = !mathcursor->halign();
421 //ret.disabled(true);
422 if (tli->lyxCode() == Inset::TABULAR_CODE) {
423 ret = static_cast<InsetTabular *>(tli)
424 ->getStatus(ev.argument);
425 } else if (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE)) {
426 ret = static_cast<InsetTabular *>
427 (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE))
428 ->getStatus(ev.argument);
433 static InsetTabular inset(*owner->buffer(), 1, 1);
437 ret = inset.getStatus(ev.argument);
438 if (ret.onoff(true) || ret.onoff(false))
439 flag.setOnOff(false);
443 case LFUN_VC_REGISTER:
444 disable = buf->lyxvc.inUse();
446 case LFUN_VC_CHECKIN:
447 disable = !buf->lyxvc.inUse() || buf->isReadonly();
449 case LFUN_VC_CHECKOUT:
450 disable = !buf->lyxvc.inUse() || !buf->isReadonly();
454 case LFUN_VC_HISTORY:
455 disable = !buf->lyxvc.inUse();
457 case LFUN_BOOKMARK_GOTO:
459 isSavedPosition(strToUnsignedInt(ev.argument));
461 case LFUN_MERGE_CHANGES:
462 case LFUN_ACCEPT_CHANGE:
463 case LFUN_REJECT_CHANGE:
464 case LFUN_ACCEPT_ALL_CHANGES:
465 case LFUN_REJECT_ALL_CHANGES:
466 disable = !buf->params.tracking_changes;
468 case LFUN_INSET_TOGGLE: {
469 LyXText * lt = view()->getLyXText();
470 disable = !(isEditableInset(lt->getInset())
472 && lt->inset_owner->owner()
473 && lt->inset_owner->owner()->isOpen()));
477 disable = !IsFileReadable(buf->getLogName().second);
480 case LFUN_MATH_MUTATE:
482 //flag.setOnOff(mathcursor->formula()->hullType() == ev.argument);
483 flag.setOnOff(false);
488 // we just need to be in math mode to enable that
490 case LFUN_MATH_SPACE:
491 case LFUN_MATH_LIMITS:
492 case LFUN_MATH_NONUMBER:
493 case LFUN_MATH_NUMBER:
494 case LFUN_MATH_EXTERN:
495 disable = !mathcursor;
502 // the functions which insert insets
503 Inset::Code code = Inset::NO_CODE;
506 code = Inset::ERT_CODE;
508 case LFUN_INSET_GRAPHICS:
509 code = Inset::GRAPHICS_CODE;
511 case LFUN_INSET_FOOTNOTE:
512 code = Inset::FOOT_CODE;
514 case LFUN_TABULAR_INSERT:
515 code = Inset::TABULAR_CODE;
517 case LFUN_INSET_EXTERNAL:
518 code = Inset::EXTERNAL_CODE;
520 case LFUN_INSET_MARGINAL:
521 code = Inset::MARGIN_CODE;
523 case LFUN_INSET_MINIPAGE:
524 code = Inset::MINIPAGE_CODE;
526 case LFUN_INSET_FLOAT:
527 case LFUN_INSET_WIDE_FLOAT:
528 code = Inset::FLOAT_CODE;
530 case LFUN_INSET_WRAP:
531 code = Inset::WRAP_CODE;
533 case LFUN_FLOAT_LIST:
534 code = Inset::FLOAT_LIST_CODE;
537 case LFUN_INSET_LIST:
538 code = Inset::LIST_CODE;
540 case LFUN_INSET_THEOREM:
541 code = Inset::THEOREM_CODE;
544 case LFUN_INSET_CAPTION:
545 code = Inset::CAPTION_CODE;
547 case LFUN_INSERT_NOTE:
548 code = Inset::NOTE_CODE;
550 case LFUN_INSERT_LABEL:
551 code = Inset::LABEL_CODE;
553 case LFUN_INSET_OPTARG:
554 code = Inset::OPTARG_CODE;
556 case LFUN_REF_INSERT:
557 code = Inset::REF_CODE;
559 case LFUN_CITATION_CREATE:
560 case LFUN_CITATION_INSERT:
561 code = Inset::CITE_CODE;
563 case LFUN_INSERT_BIBTEX:
564 code = Inset::BIBTEX_CODE;
566 case LFUN_INDEX_INSERT:
567 code = Inset::INDEX_CODE;
569 case LFUN_INDEX_PRINT:
570 code = Inset::INDEX_PRINT_CODE;
572 case LFUN_CHILD_INSERT:
573 code = Inset::INCLUDE_CODE;
575 case LFUN_TOC_INSERT:
576 code = Inset::TOC_CODE;
578 case LFUN_PARENTINSERT:
579 code = Inset::PARENT_CODE;
583 case LFUN_INSERT_URL:
584 code = Inset::URL_CODE;
587 // always allow this, since we will inset a raw quote
588 // if an inset is not allowed.
590 case LFUN_HYPHENATION:
591 case LFUN_LIGATURE_BREAK:
593 case LFUN_MENU_SEPARATOR:
595 case LFUN_END_OF_SENTENCE:
596 code = Inset::SPECIALCHAR_CODE;
598 case LFUN_PROTECTEDSPACE:
599 // slight hack: we know this is allowed in math mode
601 code = Inset::SPECIALCHAR_CODE;
606 if (code != Inset::NO_CODE && tli && !tli->insetAllowed(code))
612 // A few general toggles
614 case LFUN_TOOLTIPS_TOGGLE:
615 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
618 case LFUN_READ_ONLY_TOGGLE:
619 flag.setOnOff(buf->isReadonly());
622 flag.setOnOff(TEXT(false)->cursor.par()->params().startOfAppendix());
624 case LFUN_SWITCHBUFFER:
625 // toggle on the current buffer, but do not toggle off
626 // the other ones (is that a good idea?)
627 if (ev.argument == buf->fileName())
630 case LFUN_TRACK_CHANGES:
631 flag.setOnOff(buf->params.tracking_changes);
637 // the font related toggles
639 LyXFont const & font = TEXT(false)->real_current_font;
642 flag.setOnOff(font.emph() == LyXFont::ON);
645 flag.setOnOff(font.noun() == LyXFont::ON);
648 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
651 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
654 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
657 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
663 string tc = mathcursor->getLastCode();
666 flag.setOnOff(tc == "mathbf");
669 flag.setOnOff(tc == "mathsf");
672 flag.setOnOff(tc == "mathcal");
675 flag.setOnOff(tc == "mathrm");
678 flag.setOnOff(tc == "mathtt");
681 flag.setOnOff(tc == "mathbb");
684 flag.setOnOff(tc == "mathnormal");
691 // this one is difficult to get right. As a half-baked
692 // solution, we consider only the first action of the sequence
693 if (ev.action == LFUN_SEQUENCE) {
694 // argument contains ';'-terminated commands
695 flag = getStatus(lyxaction.LookupFunc(token(ev.argument, ';', 0)));
702 void LyXFunc::dispatch(string const & s, bool verbose)
704 int const action = lyxaction.LookupFunc(s);
706 if (action == LFUN_UNKNOWN_ACTION) {
708 boost::format fmt(_("Unknown function (%1$s)"));
710 owner->message(fmt.str());
712 string const msg = string(_("Unknown function ("))
719 dispatch(action, verbose);
723 void LyXFunc::dispatch(int ac, bool verbose)
725 dispatch(lyxaction.retrieveActionArg(ac), verbose);
730 void LyXFunc::dispatch(FuncRequest const & ev, bool verbose)
732 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: action[" << ev.action
733 <<"] arg[" << ev.argument << ']' << endl;
735 // we have not done anything wrong yet.
737 dispatch_buffer.erase();
739 #ifdef NEW_DISPATCHER
740 // We try do call the most specific dispatcher first:
741 // 1. the lockinginset's dispatch
742 // 2. the bufferview's dispatch
743 // 3. the lyxview's dispatch
746 selection_possible = false;
748 if (view()->available())
749 view()->hideCursor();
751 string argument = ev.argument;
752 kb_action action = ev.action;
754 // We cannot use this function here
755 if (getStatus(ev).disabled()) {
756 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
757 << lyxaction.getActionName(action)
758 << " [" << action << "] is disabled at this location"
760 setErrorMessage(getStatusMessage());
761 goto exit_with_message;
764 if (view()->available() && view()->theLockingInset()) {
765 Inset::RESULT result;
766 if ((action > 1) || ((action == LFUN_UNKNOWN_ACTION) &&
767 (!keyseq.deleted())))
769 UpdatableInset * inset = view()->theLockingInset();
773 inset->getCursorPos(view(), inset_x, dummy_y);
775 if ((action == LFUN_UNKNOWN_ACTION)
776 && argument.empty()) {
777 argument = encoded_last_key;
779 // Undo/Redo is a bit tricky for insets.
780 if (action == LFUN_UNDO) {
782 goto exit_with_message;
783 } else if (action == LFUN_REDO) {
785 goto exit_with_message;
786 } else if (((result=inset->
787 // Hand-over to inset's own dispatch:
788 localDispatch(FuncRequest(view(), action, argument))) ==
789 UpdatableInset::DISPATCHED) ||
790 (result == UpdatableInset::DISPATCHED_NOUPDATE))
791 goto exit_with_message;
792 // If UNDISPATCHED, just soldier on
793 else if (result == UpdatableInset::FINISHED) {
794 goto exit_with_message;
795 // We do not need special RTL handling here:
796 // FINISHED means that the cursor should be
797 // one position after the inset.
798 } else if (result == UpdatableInset::FINISHED_RIGHT) {
799 TEXT()->cursorRight(view());
800 moveCursorUpdate(true, false);
801 owner->view_state_changed();
802 goto exit_with_message;
803 } else if (result == UpdatableInset::FINISHED_UP) {
804 if (TEXT()->cursor.irow()->previous()) {
806 TEXT()->setCursorFromCoordinates(
807 view(), TEXT()->cursor.ix() + inset_x,
808 TEXT()->cursor.iy() -
809 TEXT()->cursor.irow()->baseline() - 1);
810 TEXT()->cursor.x_fix(TEXT()->cursor.x());
812 TEXT()->cursorUp(view());
814 moveCursorUpdate(true, false);
815 owner->view_state_changed();
817 view()->update(TEXT(), BufferView::SELECT|BufferView::FITCUR);
819 goto exit_with_message;
820 } else if (result == UpdatableInset::FINISHED_DOWN) {
821 if (TEXT()->cursor.irow()->next()) {
823 TEXT()->setCursorFromCoordinates(
824 view(), TEXT()->cursor.ix() + inset_x,
825 TEXT()->cursor.iy() -
826 TEXT()->cursor.irow()->baseline() +
827 TEXT()->cursor.irow()->height() + 1);
828 TEXT()->cursor.x_fix(TEXT()->cursor.x());
830 TEXT()->cursorDown(view());
833 TEXT()->cursorRight(view());
835 moveCursorUpdate(true, false);
836 owner->view_state_changed();
837 goto exit_with_message;
839 #warning I am not sure this is still right, please have a look! (Jug 20020417)
840 else { // result == UNDISPATCHED
841 //setMessage(N_("Text mode"));
843 case LFUN_UNKNOWN_ACTION:
844 case LFUN_BREAKPARAGRAPH:
846 TEXT()->cursorRight(view());
847 view()->switchKeyMap();
848 owner->view_state_changed();
851 if (!TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
852 TEXT()->cursorRight(view());
853 moveCursorUpdate(true, false);
854 owner->view_state_changed();
856 goto exit_with_message;
858 if (TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
859 TEXT()->cursorRight(view());
860 moveCursorUpdate(true, false);
861 owner->view_state_changed();
863 goto exit_with_message;
865 if (TEXT()->cursor.row()->next())
866 TEXT()->cursorDown(view());
868 TEXT()->cursorRight(view());
869 moveCursorUpdate(true, false);
870 owner->view_state_changed();
871 goto exit_with_message;
883 if (!view()->available()) break;
884 // this function should be used always [asierra060396]
885 UpdatableInset * tli =
886 view()->theLockingInset();
888 UpdatableInset * lock = tli->getLockingInset();
891 view()->unlockInset(tli);
892 TEXT()->cursorRight(view());
893 moveCursorUpdate(true, false);
894 owner->view_state_changed();
896 tli->unlockInsetInInset(view(),
901 // Tell the paragraph dialog that we changed paragraph
902 owner->getDialogs().updateParagraph();
907 // --- Misc -------------------------------------------
908 case LFUN_WORDFINDFORWARD :
909 case LFUN_WORDFINDBACKWARD : {
910 static string last_search;
911 string searched_string;
913 if (!argument.empty()) {
914 last_search = argument;
915 searched_string = argument;
917 searched_string = last_search;
919 bool fw = (action == LFUN_WORDFINDFORWARD);
920 if (!searched_string.empty()) {
921 lyxfind::LyXFind(view(), searched_string, fw);
923 // view()->showCursor();
929 if (view()->available() && !view()->theLockingInset()) {
930 view()->update(TEXT(),
931 BufferView::SELECT|BufferView::FITCUR);
933 owner->message(keyseq.printOptions());
937 // --- Misc -------------------------------------------
938 case LFUN_EXEC_COMMAND:
939 owner->focus_command_buffer();
942 case LFUN_CANCEL: // RVDK_PATCH_5
944 meta_fake_bit = key_modifier::none;
945 if (view()->available())
946 // cancel any selection
947 dispatch(LFUN_MARK_OFF);
948 setMessage(N_("Cancel"));
951 case LFUN_META_FAKE: // RVDK_PATCH_5
953 meta_fake_bit = key_modifier::alt;
954 setMessage(keyseq.print());
958 case LFUN_READ_ONLY_TOGGLE:
959 if (owner->buffer()->lyxvc.inUse()) {
960 owner->buffer()->lyxvc.toggleReadOnly();
962 owner->buffer()->setReadonly(
963 !owner->buffer()->isReadonly());
967 case LFUN_CENTER: // this is center and redraw.
971 // --- Menus -----------------------------------------------
973 menuNew(argument, false);
976 case LFUN_MENUNEWTMPLT:
977 menuNew(argument, true);
980 case LFUN_CLOSEBUFFER:
985 if (!owner->buffer()->isUnnamed()) {
988 s1 << boost::format(_("Saving document %1$s..."))
989 % MakeDisplayPath(owner->buffer()->fileName());
991 s1 << _("Saving document ")
992 << MakeDisplayPath(owner->buffer()->fileName())
995 owner->message(STRCONV(s1.str()));
996 MenuWrite(view(), owner->buffer());
998 owner->message(STRCONV(s1.str()));
1000 WriteAs(view(), owner->buffer());
1004 WriteAs(view(), owner->buffer(), argument);
1007 case LFUN_MENURELOAD:
1012 Exporter::Export(owner->buffer(), argument, true);
1016 Exporter::Preview(owner->buffer(), argument);
1019 case LFUN_BUILDPROG:
1020 Exporter::Export(owner->buffer(), "program", true);
1023 case LFUN_RUNCHKTEX:
1024 MenuRunChktex(owner->buffer());
1027 case LFUN_MENUPRINT:
1028 owner->getDialogs().showPrint();
1032 if (argument == "custom")
1033 owner->getDialogs().showSendto();
1035 Exporter::Export(owner->buffer(), argument, false);
1053 InsetCommandParams p;
1056 if (action == LFUN_TOCVIEW)
1058 p.setCmdName("tableofcontents");
1060 else if (action == LFUN_LOAVIEW)
1061 p.setCmdName("listof{algorithm}{List of Algorithms}");
1062 else if (action == LFUN_LOFVIEW)
1063 p.setCmdName("listoffigures");
1065 p.setCmdName("listoftables");
1067 owner->getDialogs().createTOC(p.getAsString());
1083 case LFUN_MENUSEARCH:
1084 owner->getDialogs().showSearch();
1087 case LFUN_REMOVEERRORS:
1088 if (view()->removeAutoInsets()) {
1089 #warning repaint() or update() or nothing ?
1091 view()->fitCursor();
1095 case LFUN_DEPTH_MIN:
1096 changeDepth(view(), TEXT(false), -1);
1099 case LFUN_DEPTH_PLUS:
1100 changeDepth(view(), TEXT(false), 1);
1104 owner->getDialogs().setUserFreeFont();
1107 case LFUN_RECONFIGURE:
1108 Reconfigure(view());
1112 case LFUN_FLOATSOPERATE:
1113 if (argument == "openfoot")
1114 view()->allFloats(1,0);
1115 else if (argument == "closefoot")
1116 view()->allFloats(0,0);
1117 else if (argument == "openfig")
1118 view()->allFloats(1,1);
1119 else if (argument == "closefig")
1120 view()->allFloats(0,1);
1123 #ifdef WITH_WARNINGS
1124 //#warning Find another implementation here (or another lyxfunc)!
1127 case LFUN_HELP_ABOUTLYX:
1128 owner->getDialogs().showAboutlyx();
1131 case LFUN_HELP_TEXINFO:
1132 owner->getDialogs().showTexinfo();
1135 case LFUN_HELP_OPEN:
1137 string const arg = argument;
1139 setErrorMessage(N_("Missing argument"));
1142 owner->prohibitInput();
1143 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1144 if (fname.empty()) {
1145 lyxerr << "LyX: unable to find documentation file `"
1146 << arg << "'. Bad installation?" << endl;
1147 owner->allowInput();
1151 #if USE_BOOST_FORMAT
1152 str << boost::format(_("Opening help file %1$s..."))
1153 % MakeDisplayPath(fname);
1155 str << _("Opening help file ")
1156 << MakeDisplayPath(fname) << _("...");
1158 owner->message(STRCONV(str.str()));
1159 view()->buffer(bufferlist.loadLyXFile(fname, false));
1160 owner->allowInput();
1164 // --- version control -------------------------------
1165 case LFUN_VC_REGISTER:
1167 if (!owner->buffer()->lyxvc.inUse())
1168 owner->buffer()->lyxvc.registrer();
1172 case LFUN_VC_CHECKIN:
1174 if (owner->buffer()->lyxvc.inUse()
1175 && !owner->buffer()->isReadonly())
1176 owner->buffer()->lyxvc.checkIn();
1180 case LFUN_VC_CHECKOUT:
1182 if (owner->buffer()->lyxvc.inUse()
1183 && owner->buffer()->isReadonly())
1184 owner->buffer()->lyxvc.checkOut();
1188 case LFUN_VC_REVERT:
1190 owner->buffer()->lyxvc.revert();
1196 owner->buffer()->lyxvc.undoLast();
1200 case LFUN_VC_HISTORY:
1202 owner->getDialogs().showVCLogFile();
1206 // --- buffers ----------------------------------------
1208 case LFUN_SWITCHBUFFER:
1209 view()->buffer(bufferlist.getBuffer(argument));
1214 // servercmd: argument must be <file>:<template>
1215 Buffer * tmpbuf = NewFile(argument);
1217 view()->buffer(tmpbuf);
1221 case LFUN_FILE_OPEN:
1225 case LFUN_LATEX_LOG:
1226 owner->getDialogs().showLogFile();
1229 case LFUN_LAYOUT_DOCUMENT:
1230 owner->getDialogs().showDocument();
1233 case LFUN_LAYOUT_PARAGRAPH:
1234 owner->getDialogs().showParagraph();
1237 case LFUN_LAYOUT_CHARACTER:
1238 owner->getDialogs().showCharacter();
1241 case LFUN_LAYOUT_TABULAR:
1242 if (view()->theLockingInset()) {
1243 if (view()->theLockingInset()->lyxCode()==Inset::TABULAR_CODE) {
1244 InsetTabular * inset = static_cast<InsetTabular *>
1245 (view()->theLockingInset());
1246 inset->openLayoutDialog(view());
1247 } else if (view()->theLockingInset()->
1248 getFirstLockingInsetOfType(Inset::TABULAR_CODE)!=0) {
1249 InsetTabular * inset = static_cast<InsetTabular *>(
1250 view()->theLockingInset()->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
1251 inset->openLayoutDialog(view());
1256 case LFUN_LAYOUT_PREAMBLE:
1257 owner->getDialogs().showPreamble();
1260 case LFUN_DROP_LAYOUTS_CHOICE:
1261 owner->getToolbar().openLayoutList();
1264 case LFUN_MENU_OPEN_BY_NAME:
1265 owner->getMenubar().openByName(argument);
1266 break; // RVDK_PATCH_5
1268 case LFUN_SPELLCHECK:
1269 owner->getDialogs().showSpellchecker();
1272 // --- lyxserver commands ----------------------------
1276 setMessage(owner->buffer()->fileName());
1277 lyxerr[Debug::INFO] << "FNAME["
1278 << owner->buffer()->fileName()
1284 dispatch_buffer = keyseq.print();
1285 lyxserver->notifyClient(dispatch_buffer);
1289 case LFUN_GOTOFILEROW:
1293 istringstream istr(argument.c_str());
1294 istr >> file_name >> row;
1295 // Must replace extension of the file to be .lyx and get full path
1296 string const s(ChangeExtension(file_name, ".lyx"));
1298 // Either change buffer or load the file
1299 if (bufferlist.exists(s)) {
1300 view()->buffer(bufferlist.getBuffer(s));
1302 view()->buffer(bufferlist.loadLyXFile(s));
1305 view()->setCursorFromRow(row);
1308 // see BufferView_pimpl::center()
1309 view()->updateScrollbar();
1313 case LFUN_GOTO_PARAGRAPH:
1315 istringstream istr(argument.c_str());
1319 Paragraph * par = owner->buffer()->getParFromID(id);
1321 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1322 << id << ']' << endl;
1325 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1326 << " found." << endl;
1329 if (view()->theLockingInset())
1330 view()->unlockInset(view()->theLockingInset());
1331 if (par->inInset()) {
1332 par->inInset()->edit(view());
1335 view()->getLyXText()->setCursor(view(), par, 0);
1336 view()->switchKeyMap();
1337 owner->view_state_changed();
1340 // see BufferView_pimpl::center()
1341 view()->updateScrollbar();
1348 int const qa = lyxaction.LookupFunc(argument);
1349 setMessage(lyxaction.helpText(static_cast<kb_action>(qa)));
1353 // --- insert characters ----------------------------------------
1355 // --- Mathed stuff. If we are here, there is no locked inset yet.
1356 case LFUN_MATH_EXTERN:
1357 case LFUN_MATH_NUMBER:
1358 case LFUN_MATH_NONUMBER:
1359 case LFUN_MATH_LIMITS:
1361 setErrorMessage(N_("This is only allowed in math mode!"));
1365 // passthrough hat and underscore outside mathed:
1366 case LFUN_SUBSCRIPT:
1367 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "_"));
1369 case LFUN_SUPERSCRIPT:
1370 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "^"));
1373 case LFUN_MATH_PANEL:
1374 owner->getDialogs().showMathPanel();
1377 case LFUN_CITATION_CREATE:
1379 InsetCommandParams p("cite");
1381 if (!argument.empty()) {
1382 // This should be set at source, ie when typing
1383 // "citation-insert foo" in the minibuffer.
1384 // Question: would pybibliographer also need to be
1385 // changed. Suspect so. Leave as-is therefore.
1386 if (contains(argument, "|")) {
1387 p.setContents(token(argument, '|', 0));
1388 p.setOptions(token(argument, '|', 1));
1390 p.setContents(argument);
1392 dispatch(FuncRequest(view(), LFUN_CITATION_INSERT, p.getAsString()));
1394 owner->getDialogs().createCitation(p.getAsString());
1398 case LFUN_CHILDOPEN:
1400 string const filename =
1401 MakeAbsPath(argument,
1402 owner->buffer()->filePath());
1403 setMessage(N_("Opening child document ") +
1404 MakeDisplayPath(filename) + "...");
1405 view()->savePosition(0);
1406 if (bufferlist.exists(filename))
1407 view()->buffer(bufferlist.getBuffer(filename));
1409 view()->buffer(bufferlist.loadLyXFile(filename));
1413 case LFUN_TOGGLECURSORFOLLOW:
1414 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1418 owner->getIntl().KeyMapOn(false);
1421 case LFUN_KMAP_PRIM:
1422 owner->getIntl().KeyMapPrim();
1426 owner->getIntl().KeyMapSec();
1429 case LFUN_KMAP_TOGGLE:
1430 owner->getIntl().ToggleKeyMap();
1435 // argument contains ';'-terminated commands
1436 while (!argument.empty()) {
1438 argument = split(argument, first, ';');
1444 case LFUN_DIALOG_PREFERENCES:
1445 owner->getDialogs().showPreferences();
1448 case LFUN_SAVEPREFERENCES:
1450 Path p(user_lyxdir);
1451 lyxrc.write("preferences");
1455 case LFUN_SCREEN_FONT_UPDATE:
1457 // handle the screen font changes.
1458 lyxrc.set_font_norm_type();
1459 lyx_gui::update_fonts();
1460 // We also need to empty the textcache so that
1461 // the buffer will be formatted correctly after
1464 // Of course we should only do the resize and the textcache.clear
1465 // if values really changed...but not very important right now. (Lgb)
1466 // All visible buffers will need resize
1472 case LFUN_SET_COLOR:
1475 string const x11_name = split(argument, lyx_name, ' ');
1476 if (lyx_name.empty() || x11_name.empty()) {
1477 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1482 bool const graphicsbg_changed =
1483 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1484 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1486 if (!lcolor.setColor(lyx_name, x11_name)) {
1487 #if USE_BOOST_FORMAT
1491 _("Set-color \"%1$s\" failed "
1492 "- color is undefined or "
1493 "may not be redefined"))
1496 setErrorMessage(_("Set-color ") + lyx_name
1497 + _(" failed - color is undefined"
1498 " or may not be redefined"));
1504 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1506 if (graphicsbg_changed) {
1507 #ifdef WITH_WARNINGS
1508 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1511 grfx::GCache & gc = grfx::GCache::get();
1512 gc.changeDisplay(true);
1521 owner->message(argument);
1524 case LFUN_FORKS_SHOW:
1525 owner->getDialogs().showForks();
1528 case LFUN_FORKS_KILL:
1530 if (!isStrInt(argument))
1533 pid_t const pid = strToInt(argument);
1534 ForkedcallsController & fcc = ForkedcallsController::get();
1539 case LFUN_TOOLTIPS_TOGGLE:
1540 owner->getDialogs().toggleTooltips();
1544 // Then if it was none of the above
1545 // Trying the BufferView::pimpl dispatch:
1546 if (!view()->dispatch(ev))
1547 lyxerr << "A truly unknown func ["
1548 << lyxaction.getActionName(ev.action) << "]!"
1554 sendDispatchMessage(getMessage(), ev, verbose);
1558 void LyXFunc::sendDispatchMessage(string const & msg, FuncRequest const & ev, bool verbose)
1560 owner->updateMenubar();
1561 owner->updateToolbar();
1563 if (ev.action == LFUN_SELFINSERT || !verbose) {
1564 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1566 owner->message(msg);
1570 string dispatch_msg = msg;
1571 if (!dispatch_msg.empty())
1572 dispatch_msg += ' ';
1574 string comname = lyxaction.getActionName(ev.action);
1576 int pseudoaction = ev.action;
1577 bool argsadded = false;
1579 if (!ev.argument.empty()) {
1580 // the pseudoaction is useful for the bindings
1581 pseudoaction = lyxaction.searchActionArg(ev.action, ev.argument);
1583 if (pseudoaction == LFUN_UNKNOWN_ACTION) {
1584 pseudoaction = ev.action;
1586 comname += ' ' + ev.argument;
1591 string const shortcuts = toplevel_keymap->findbinding(pseudoaction);
1593 if (!shortcuts.empty()) {
1594 comname += ": " + shortcuts;
1595 } else if (!argsadded && !ev.argument.empty()) {
1596 comname += ' ' + ev.argument;
1599 if (!comname.empty()) {
1600 comname = rtrim(comname);
1601 dispatch_msg += '(' + comname + ')';
1604 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1605 if (!dispatch_msg.empty())
1606 owner->message(dispatch_msg);
1610 void LyXFunc::setupLocalKeymap()
1612 keyseq.stdmap = keyseq.curmap = toplevel_keymap.get();
1613 cancel_meta_seq.stdmap = cancel_meta_seq.curmap = toplevel_keymap.get();
1617 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1619 string initpath = lyxrc.document_path;
1620 string filename(name);
1622 if (view()->available()) {
1623 string const trypath = owner->buffer()->filePath();
1624 // If directory is writeable, use this as default.
1625 if (IsDirWriteable(trypath))
1629 static int newfile_number;
1631 if (filename.empty()) {
1632 filename = AddName(lyxrc.document_path,
1633 "newfile" + tostr(++newfile_number) + ".lyx");
1634 FileInfo fi(filename);
1635 while (bufferlist.exists(filename) || fi.readable()) {
1637 filename = AddName(lyxrc.document_path,
1638 "newfile" + tostr(newfile_number) +
1640 fi.newFile(filename);
1644 // The template stuff
1647 FileDialog fileDlg(owner, _("Select template file"),
1648 LFUN_SELECT_FILE_SYNC,
1649 make_pair(string(_("Documents|#o#O")),
1650 string(lyxrc.document_path)),
1651 make_pair(string(_("Templates|#T#t")),
1652 string(lyxrc.template_path)));
1654 FileDialog::Result result =
1655 fileDlg.open(lyxrc.template_path,
1656 _("*.lyx| LyX Documents (*.lyx)"));
1658 if (result.first == FileDialog::Later)
1661 string const fname = result.second;
1668 view()->buffer(bufferlist.newFile(filename, templname, !name.empty()));
1672 void LyXFunc::open(string const & fname)
1674 string initpath = lyxrc.document_path;
1676 if (view()->available()) {
1677 string const trypath = owner->buffer()->filePath();
1678 // If directory is writeable, use this as default.
1679 if (IsDirWriteable(trypath))
1685 if (fname.empty()) {
1686 FileDialog fileDlg(owner, _("Select document to open"),
1688 make_pair(string(_("Documents|#o#O")),
1689 string(lyxrc.document_path)),
1690 make_pair(string(_("Examples|#E#e")),
1691 string(AddPath(system_lyxdir, "examples"))));
1693 FileDialog::Result result =
1694 fileDlg.open(initpath,
1695 _("*.lyx| LyX Documents (*.lyx)"));
1697 if (result.first == FileDialog::Later)
1700 filename = result.second;
1702 // check selected filename
1703 if (filename.empty()) {
1704 owner->message(_("Canceled."));
1710 // get absolute path of file and add ".lyx" to the filename if
1712 string const fullpath = FileSearch(string(), filename, "lyx");
1713 if (!fullpath.empty()) {
1714 filename = fullpath;
1717 string const disp_fn(MakeDisplayPath(filename));
1719 // if the file doesn't exist, let the user create one
1720 FileInfo const f(filename, true);
1722 if (!Alert::askQuestion(_("No such file"), disp_fn,
1723 _("Start a new document with this filename ?"))) {
1724 owner->message(_("Canceled."));
1727 // the user specifically chose this name. Believe them.
1728 Buffer * buffer = bufferlist.newFile(filename, "", true);
1729 view()->buffer(buffer);
1734 #if USE_BOOST_FORMAT
1735 str << boost::format(_("Opening document %1$s...")) % disp_fn;
1737 str << _("Opening document ") << disp_fn << _("...");
1740 owner->message(STRCONV(str.str()));
1742 Buffer * openbuf = bufferlist.loadLyXFile(filename);
1745 view()->buffer(openbuf);
1746 #if USE_BOOST_FORMAT
1747 str2 << boost::format(_("Document %1$s opened.")) % disp_fn;
1749 str2 << _("Document ") << disp_fn << _(" opened.");
1752 #if USE_BOOST_FORMAT
1753 str2 << boost::format(_("Could not open document %1$s"))
1756 str2 << _("Could not open document ") << disp_fn;
1759 owner->message(STRCONV(str2.str()));
1763 void LyXFunc::doImport(string const & argument)
1766 string filename = split(argument, format, ' ');
1768 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1769 << " file: " << filename << endl;
1771 // need user interaction
1772 if (filename.empty()) {
1773 string initpath = lyxrc.document_path;
1775 if (view()->available()) {
1776 string const trypath = owner->buffer()->filePath();
1777 // If directory is writeable, use this as default.
1778 if (IsDirWriteable(trypath))
1782 #if USE_BOOST_FORMAT
1783 boost::format fmt(_("Select %1$s file to import"));
1784 fmt % formats.prettyName(format);
1785 string const text = fmt.str();
1787 string const text = _("Select ") + formats.prettyName(format)
1788 + _(" file to import");;
1791 FileDialog fileDlg(owner, text,
1793 make_pair(string(_("Documents|#o#O")),
1794 string(lyxrc.document_path)),
1795 make_pair(string(_("Examples|#E#e")),
1796 string(AddPath(system_lyxdir, "examples"))));
1798 string const extension = "*." + formats.extension(format)
1799 + "| " + formats.prettyName(format)
1800 + " (*." + formats.extension(format) + ')';
1802 FileDialog::Result result = fileDlg.open(initpath,
1805 if (result.first == FileDialog::Later)
1808 filename = result.second;
1810 // check selected filename
1811 if (filename.empty())
1812 owner->message(_("Canceled."));
1815 if (filename.empty())
1818 // get absolute path of file
1819 filename = MakeAbsPath(filename);
1821 string const lyxfile = ChangeExtension(filename, ".lyx");
1823 // Check if the document already is open
1824 if (lyxrc.use_gui && bufferlist.exists(lyxfile)) {
1825 switch (Alert::askConfirmation(_("Document is already open:"),
1826 MakeDisplayPath(lyxfile, 50),
1827 _("Do you want to close that document now?\n"
1828 "('No' will just switch to the open version)")))
1831 // If close is canceled, we cancel here too.
1832 if (!bufferlist.close(bufferlist.getBuffer(lyxfile)))
1836 view()->buffer(bufferlist.getBuffer(lyxfile));
1839 owner->message(_("Canceled."));
1844 // if the file exists already, and we didn't do
1845 // -i lyx thefile.lyx, warn
1846 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1847 if (!Alert::askQuestion(_("A document by the name"),
1848 MakeDisplayPath(lyxfile), _("already exists. Overwrite?"))) {
1849 owner->message(_("Canceled."));
1854 Importer::Import(owner, filename, format);
1858 void LyXFunc::reloadBuffer()
1860 string const fn = owner->buffer()->fileName();
1861 if (bufferlist.close(owner->buffer()))
1862 view()->buffer(bufferlist.loadLyXFile(fn));
1866 void LyXFunc::closeBuffer()
1868 if (bufferlist.close(owner->buffer()) && !quitting) {
1869 if (bufferlist.empty()) {
1870 // need this otherwise SEGV may occur while trying to
1871 // set variables that don't exist
1872 // since there's no current buffer
1873 owner->getDialogs().hideBufferDependent();
1875 view()->buffer(bufferlist.first());
1881 // Each "owner" should have it's own message method. lyxview and
1882 // the minibuffer would use the minibuffer, but lyxserver would
1883 // send an ERROR signal to its client. Alejandro 970603
1884 // This func is bit problematic when it comes to NLS, to make the
1885 // lyx servers client be language indepenent we must not translate
1886 // strings sent to this func.
1887 void LyXFunc::setErrorMessage(string const & m) const
1889 dispatch_buffer = m;
1894 void LyXFunc::setMessage(string const & m) const
1896 dispatch_buffer = m;
1900 void LyXFunc::setStatusMessage(string const & m) const
1906 string const LyXFunc::view_status_message()
1908 // When meta-fake key is pressed, show the key sequence so far + "M-".
1910 return keyseq.print() + "M-";
1913 // Else, when a non-complete key sequence is pressed,
1914 // show the available options.
1915 if (keyseq.length() > 0 && !keyseq.deleted()) {
1916 return keyseq.printOptions();
1919 if (!view()->available())
1920 return _("Welcome to LyX!");
1922 return currentState(view());
1926 BufferView * LyXFunc::view() const
1929 return owner->view().get();