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"
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 "support/BoostFormat.h"
85 using std::back_inserter;
86 using namespace bv_funcs;
88 extern BufferList bufferlist;
89 extern LyXServer * lyxserver;
90 extern bool selection_possible;
92 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
95 extern tex_accent_struct get_accent(kb_action action);
97 extern void ShowLatexLog();
100 LyXFunc::LyXFunc(LyXView * o)
103 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
104 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get()),
105 meta_fake_bit(key_modifier::none)
111 LyXText * LyXFunc::TEXT(bool flag = true) const
115 return view()->getLyXText();
120 void LyXFunc::moveCursorUpdate(bool flag, bool selecting)
122 if (selecting || TEXT(flag)->selection.mark()) {
123 TEXT(flag)->setSelection();
124 if (!TEXT(flag)->isInInset())
125 view()->toggleToggle();
127 view()->update(TEXT(flag), BufferView::SELECT);
128 view()->showCursor();
130 view()->switchKeyMap();
134 void LyXFunc::handleKeyFunc(kb_action action)
136 char c = encoded_last_key;
138 if (keyseq.length()) {
142 owner->getIntl().getTransManager()
143 .deadkey(c, get_accent(action).accent, TEXT(false));
144 // Need to clear, in case the minibuffer calls these
147 // copied verbatim from do_accent_char
148 view()->update(TEXT(false), BufferView::SELECT);
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 = !buf->isLatex() || 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 disable = !changeDepth(view(), TEXT(false), DEC_DEPTH, true);
370 case LFUN_DEPTH_PLUS:
371 disable = !changeDepth(view(), TEXT(false), INC_DEPTH, true);
375 case LFUN_LAYOUT_PARAGRAPH: {
376 Inset * inset = TEXT(false)->cursor.par()->inInset();
377 disable = inset && inset->forceDefaultParagraphs(inset);
381 case LFUN_INSET_OPTARG:
382 disable = (TEXT(false)->cursor.par()->layout()->optionalargs == 0);
385 case LFUN_TABULAR_FEATURE:
388 // FIXME: check temporarily disabled
390 char align = mathcursor->valign();
395 if (ev.argument.empty()) {
399 if (!contains("tcb", ev.argument[0])) {
403 flag.setOnOff(ev.argument[0] == align);
407 char align = mathcursor->halign();
412 if (ev.argument.empty()) {
416 if (!contains("lcr", ev.argument[0])) {
420 flag.setOnOff(ev.argument[0] == align);
423 disable = !mathcursor->halign();
429 //ret.disabled(true);
430 if (tli->lyxCode() == Inset::TABULAR_CODE) {
431 ret = static_cast<InsetTabular *>(tli)
432 ->getStatus(ev.argument);
433 } else if (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE)) {
434 ret = static_cast<InsetTabular *>
435 (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE))
436 ->getStatus(ev.argument);
441 static InsetTabular inset(*owner->buffer(), 1, 1);
445 ret = inset.getStatus(ev.argument);
446 if (ret.onoff(true) || ret.onoff(false))
447 flag.setOnOff(false);
451 case LFUN_VC_REGISTER:
452 disable = buf->lyxvc.inUse();
454 case LFUN_VC_CHECKIN:
455 disable = !buf->lyxvc.inUse() || buf->isReadonly();
457 case LFUN_VC_CHECKOUT:
458 disable = !buf->lyxvc.inUse() || !buf->isReadonly();
462 case LFUN_VC_HISTORY:
463 disable = !buf->lyxvc.inUse();
465 case LFUN_MENURELOAD:
466 disable = buf->isUnnamed() || buf->isClean();
468 case LFUN_BOOKMARK_GOTO:
470 isSavedPosition(strToUnsignedInt(ev.argument));
472 case LFUN_MERGE_CHANGES:
473 case LFUN_ACCEPT_CHANGE:
474 case LFUN_REJECT_CHANGE:
475 case LFUN_ACCEPT_ALL_CHANGES:
476 case LFUN_REJECT_ALL_CHANGES:
477 disable = !buf->params.tracking_changes;
479 case LFUN_INSET_TOGGLE: {
480 LyXText * lt = view()->getLyXText();
481 disable = !(isEditableInset(lt->getInset())
483 && lt->inset_owner->owner()
484 && lt->inset_owner->owner()->isOpen()));
488 disable = !IsFileReadable(buf->getLogName().second);
491 case LFUN_MATH_MUTATE:
493 //flag.setOnOff(mathcursor->formula()->hullType() == ev.argument);
494 flag.setOnOff(false);
499 // we just need to be in math mode to enable that
501 case LFUN_MATH_SPACE:
502 case LFUN_MATH_LIMITS:
503 case LFUN_MATH_NONUMBER:
504 case LFUN_MATH_NUMBER:
505 case LFUN_MATH_EXTERN:
506 disable = !mathcursor;
513 // the functions which insert insets
514 Inset::Code code = Inset::NO_CODE;
516 case LFUN_DIALOG_SHOW_NEW_INSET:
517 if (ev.argument == "bibitem")
518 code = Inset::BIBITEM_CODE;
519 else if (ev.argument == "bibtex")
520 code = Inset::BIBTEX_CODE;
521 else if (ev.argument == "citation")
522 code = Inset::CITE_CODE;
523 else if (ev.argument == "ert")
524 code = Inset::ERT_CODE;
525 else if (ev.argument == "external")
526 code = Inset::EXTERNAL_CODE;
527 else if (ev.argument == "float")
528 code = Inset::FLOAT_CODE;
529 else if (ev.argument == "graphics")
530 code = Inset::GRAPHICS_CODE;
531 else if (ev.argument == "include")
532 code = Inset::INCLUDE_CODE;
533 else if (ev.argument == "index")
534 code = Inset::INDEX_CODE;
535 else if (ev.argument == "label")
536 code = Inset::LABEL_CODE;
537 else if (ev.argument == "minipage")
538 code = Inset::MINIPAGE_CODE;
539 else if (ev.argument == "ref")
540 code = Inset::REF_CODE;
541 else if (ev.argument == "toc")
542 code = Inset::TOC_CODE;
543 else if (ev.argument == "url")
544 code = Inset::URL_CODE;
545 else if (ev.argument == "wrap")
546 code = Inset::WRAP_CODE;
550 code = Inset::ERT_CODE;
552 case LFUN_INSET_FOOTNOTE:
553 code = Inset::FOOT_CODE;
555 case LFUN_TABULAR_INSERT:
556 code = Inset::TABULAR_CODE;
558 case LFUN_INSET_MARGINAL:
559 code = Inset::MARGIN_CODE;
561 case LFUN_INSET_MINIPAGE:
562 code = Inset::MINIPAGE_CODE;
564 case LFUN_INSET_FLOAT:
565 case LFUN_INSET_WIDE_FLOAT:
566 code = Inset::FLOAT_CODE;
568 case LFUN_INSET_WRAP:
569 code = Inset::WRAP_CODE;
571 case LFUN_FLOAT_LIST:
572 code = Inset::FLOAT_LIST_CODE;
575 case LFUN_INSET_LIST:
576 code = Inset::LIST_CODE;
578 case LFUN_INSET_THEOREM:
579 code = Inset::THEOREM_CODE;
582 case LFUN_INSET_CAPTION:
583 code = Inset::CAPTION_CODE;
585 case LFUN_INSERT_NOTE:
586 code = Inset::NOTE_CODE;
588 case LFUN_INSERT_LABEL:
589 code = Inset::LABEL_CODE;
591 case LFUN_INSET_OPTARG:
592 code = Inset::OPTARG_CODE;
594 case LFUN_ENVIRONMENT_INSERT:
595 code = Inset::MINIPAGE_CODE;
597 case LFUN_INDEX_INSERT:
598 code = Inset::INDEX_CODE;
600 case LFUN_INDEX_PRINT:
601 code = Inset::INDEX_PRINT_CODE;
603 case LFUN_TOC_INSERT:
604 code = Inset::TOC_CODE;
606 case LFUN_PARENTINSERT:
607 code = Inset::PARENT_CODE;
611 code = Inset::URL_CODE;
614 // always allow this, since we will inset a raw quote
615 // if an inset is not allowed.
617 case LFUN_HYPHENATION:
618 case LFUN_LIGATURE_BREAK:
620 case LFUN_MENU_SEPARATOR:
622 case LFUN_END_OF_SENTENCE:
623 code = Inset::SPECIALCHAR_CODE;
625 case LFUN_PROTECTEDSPACE:
626 // slight hack: we know this is allowed in math mode
628 code = Inset::SPECIALCHAR_CODE;
633 if (code != Inset::NO_CODE && tli && !tli->insetAllowed(code))
639 // A few general toggles
641 case LFUN_TOOLTIPS_TOGGLE:
642 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
645 case LFUN_READ_ONLY_TOGGLE:
646 flag.setOnOff(buf->isReadonly());
649 flag.setOnOff(TEXT(false)->cursor.par()->params().startOfAppendix());
651 case LFUN_SWITCHBUFFER:
652 // toggle on the current buffer, but do not toggle off
653 // the other ones (is that a good idea?)
654 if (ev.argument == buf->fileName())
657 case LFUN_TRACK_CHANGES:
658 flag.setOnOff(buf->params.tracking_changes);
664 // the font related toggles
666 LyXFont const & font = TEXT(false)->real_current_font;
669 flag.setOnOff(font.emph() == LyXFont::ON);
672 flag.setOnOff(font.noun() == LyXFont::ON);
675 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
678 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
681 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
684 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
690 string tc = mathcursor->getLastCode();
693 flag.setOnOff(tc == "mathbf");
696 flag.setOnOff(tc == "mathsf");
699 flag.setOnOff(tc == "mathcal");
702 flag.setOnOff(tc == "mathrm");
705 flag.setOnOff(tc == "mathtt");
708 flag.setOnOff(tc == "mathbb");
711 flag.setOnOff(tc == "mathnormal");
718 // this one is difficult to get right. As a half-baked
719 // solution, we consider only the first action of the sequence
720 if (ev.action == LFUN_SEQUENCE) {
721 // argument contains ';'-terminated commands
722 flag = getStatus(lyxaction.LookupFunc(token(ev.argument, ';', 0)));
729 void LyXFunc::dispatch(string const & s, bool verbose)
731 int const action = lyxaction.LookupFunc(s);
733 if (action == LFUN_UNKNOWN_ACTION) {
735 boost::format fmt(_("Unknown function (%1$s)"));
737 owner->message(fmt.str());
739 string const msg = string(_("Unknown function ("))
746 dispatch(action, verbose);
750 void LyXFunc::dispatch(int ac, bool verbose)
752 dispatch(lyxaction.retrieveActionArg(ac), verbose);
757 void LyXFunc::dispatch(FuncRequest const & ev, bool verbose)
759 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: action[" << ev.action
760 <<"] arg[" << ev.argument << ']' << endl;
762 // we have not done anything wrong yet.
764 dispatch_buffer.erase();
766 #ifdef NEW_DISPATCHER
767 // We try do call the most specific dispatcher first:
768 // 1. the lockinginset's dispatch
769 // 2. the bufferview's dispatch
770 // 3. the lyxview's dispatch
773 selection_possible = false;
775 if (view()->available())
776 view()->hideCursor();
778 string argument = ev.argument;
779 kb_action action = ev.action;
781 // We cannot use this function here
782 if (getStatus(ev).disabled()) {
783 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
784 << lyxaction.getActionName(action)
785 << " [" << action << "] is disabled at this location"
787 setErrorMessage(getStatusMessage());
788 goto exit_with_message;
791 if (view()->available() && view()->theLockingInset()) {
792 Inset::RESULT result;
793 if ((action > 1) || ((action == LFUN_UNKNOWN_ACTION) &&
794 (!keyseq.deleted())))
796 UpdatableInset * inset = view()->theLockingInset();
800 inset->getCursorPos(view(), inset_x, dummy_y);
802 if ((action == LFUN_UNKNOWN_ACTION)
803 && argument.empty()) {
804 argument = encoded_last_key;
806 // Undo/Redo is a bit tricky for insets.
807 if (action == LFUN_UNDO) {
809 goto exit_with_message;
810 } else if (action == LFUN_REDO) {
812 goto exit_with_message;
813 } else if (((result=inset->
814 // Hand-over to inset's own dispatch:
815 localDispatch(FuncRequest(view(), action, argument))) ==
817 (result == DISPATCHED_NOUPDATE))
818 goto exit_with_message;
819 // If UNDISPATCHED, just soldier on
820 else if (result == FINISHED) {
821 owner->clearMessage();
822 goto exit_with_message;
823 // We do not need special RTL handling here:
824 // FINISHED means that the cursor should be
825 // one position after the inset.
826 } else if (result == FINISHED_RIGHT) {
827 TEXT()->cursorRight(view());
828 moveCursorUpdate(true, false);
829 owner->clearMessage();
830 goto exit_with_message;
831 } else if (result == FINISHED_UP) {
832 if (TEXT()->cursor.irow() != TEXT()->rows().begin()) {
834 TEXT()->setCursorFromCoordinates(
835 TEXT()->cursor.ix() + inset_x,
836 TEXT()->cursor.iy() -
837 TEXT()->cursor.irow()->baseline() - 1);
838 TEXT()->cursor.x_fix(TEXT()->cursor.x());
840 TEXT()->cursorUp(view());
842 moveCursorUpdate(true, false);
844 view()->update(TEXT(), BufferView::SELECT);
846 owner->clearMessage();
847 goto exit_with_message;
848 } else if (result == FINISHED_DOWN) {
849 if (boost::next(TEXT()->cursor.irow()) != TEXT()->rows().end()) {
851 TEXT()->setCursorFromCoordinates(
852 TEXT()->cursor.ix() + inset_x,
853 TEXT()->cursor.iy() -
854 TEXT()->cursor.irow()->baseline() +
855 TEXT()->cursor.irow()->height() + 1);
856 TEXT()->cursor.x_fix(TEXT()->cursor.x());
858 TEXT()->cursorDown(view());
861 TEXT()->cursorRight(view());
863 moveCursorUpdate(true, false);
864 owner->clearMessage();
865 goto exit_with_message;
867 #warning I am not sure this is still right, please have a look! (Jug 20020417)
868 else { // result == UNDISPATCHED
869 //setMessage(N_("Text mode"));
871 case LFUN_UNKNOWN_ACTION:
872 case LFUN_BREAKPARAGRAPH:
874 TEXT()->cursorRight(view());
875 view()->switchKeyMap();
876 owner->view_state_changed();
879 if (!TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
880 TEXT()->cursorRight(view());
881 moveCursorUpdate(true, false);
882 owner->view_state_changed();
884 goto exit_with_message;
886 if (TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
887 TEXT()->cursorRight(view());
888 moveCursorUpdate(true, false);
889 owner->view_state_changed();
891 goto exit_with_message;
893 if (boost::next(TEXT()->cursor.row()) != TEXT()->rows().end())
894 TEXT()->cursorDown(view());
896 TEXT()->cursorRight(view());
897 moveCursorUpdate(true, false);
898 owner->view_state_changed();
899 goto exit_with_message;
911 if (!view()->available()) break;
912 // this function should be used always [asierra060396]
913 UpdatableInset * tli =
914 view()->theLockingInset();
916 UpdatableInset * lock = tli->getLockingInset();
919 view()->unlockInset(tli);
920 TEXT()->cursorRight(view());
921 moveCursorUpdate(true, false);
922 owner->view_state_changed();
924 tli->unlockInsetInInset(view(),
929 // Tell the paragraph dialog that we changed paragraph
930 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
935 // --- Misc -------------------------------------------
936 case LFUN_WORDFINDFORWARD :
937 case LFUN_WORDFINDBACKWARD : {
938 static string last_search;
939 string searched_string;
941 if (!argument.empty()) {
942 last_search = argument;
943 searched_string = argument;
945 searched_string = last_search;
947 bool fw = (action == LFUN_WORDFINDFORWARD);
948 if (!searched_string.empty()) {
949 lyxfind::LyXFind(view(), searched_string, fw);
951 // view()->showCursor();
957 if (view()->available() && !view()->theLockingInset()) {
958 view()->update(TEXT(), BufferView::SELECT);
960 owner->message(keyseq.printOptions());
964 // --- Misc -------------------------------------------
965 case LFUN_EXEC_COMMAND:
966 owner->focus_command_buffer();
969 case LFUN_CANCEL: // RVDK_PATCH_5
971 meta_fake_bit = key_modifier::none;
972 if (view()->available())
973 // cancel any selection
974 dispatch(LFUN_MARK_OFF);
975 setMessage(N_("Cancel"));
978 case LFUN_META_FAKE: // RVDK_PATCH_5
980 meta_fake_bit = key_modifier::alt;
981 setMessage(keyseq.print());
985 case LFUN_READ_ONLY_TOGGLE:
986 if (owner->buffer()->lyxvc.inUse()) {
987 owner->buffer()->lyxvc.toggleReadOnly();
989 owner->buffer()->setReadonly(
990 !owner->buffer()->isReadonly());
994 case LFUN_CENTER: // this is center and redraw.
998 // --- Menus -----------------------------------------------
1000 menuNew(argument, false);
1003 case LFUN_MENUNEWTMPLT:
1004 menuNew(argument, true);
1007 case LFUN_CLOSEBUFFER:
1011 case LFUN_MENUWRITE:
1012 if (!owner->buffer()->isUnnamed()) {
1014 #if USE_BOOST_FORMAT
1015 s1 << boost::format(_("Saving document %1$s..."))
1016 % MakeDisplayPath(owner->buffer()->fileName());
1018 s1 << _("Saving document ")
1019 << MakeDisplayPath(owner->buffer()->fileName())
1022 owner->message(STRCONV(s1.str()));
1023 MenuWrite(view(), owner->buffer());
1025 owner->message(STRCONV(s1.str()));
1027 WriteAs(view(), owner->buffer());
1031 WriteAs(view(), owner->buffer(), argument);
1034 case LFUN_MENURELOAD: {
1035 string const file = MakeDisplayPath(view()->buffer()->fileName(), 20);
1036 #if USE_BOOST_FORMAT
1037 boost::format fmt(_("Any changes will be lost. Are you sure you want to revert to the saved version of the document %1$s?"));
1039 string text = fmt.str();
1041 string text = _("Any changes will be lost. Are you sure you want to revert to the saved version of the document");
1042 text += file + _("?");
1044 int const ret = Alert::prompt(_("Revert to saved document?"),
1045 text, 1, _("&Revert"), _("&Cancel"));
1053 Exporter::Export(owner->buffer(), argument, true);
1057 Exporter::Preview(owner->buffer(), argument);
1060 case LFUN_BUILDPROG:
1061 Exporter::Export(owner->buffer(), "program", true);
1064 case LFUN_RUNCHKTEX:
1065 owner->buffer()->runChktex();
1068 case LFUN_MENUPRINT:
1069 owner->getDialogs().showPrint();
1073 if (argument == "custom")
1074 owner->getDialogs().showSendto();
1076 Exporter::Export(owner->buffer(), argument, false);
1089 InsetCommandParams p("tableofcontents");
1090 string const data = InsetCommandMailer::params2string("toc", p);
1091 owner->getDialogs().show("toc", data, 0);
1107 case LFUN_MENUSEARCH:
1108 owner->getDialogs().showSearch();
1111 case LFUN_REMOVEERRORS:
1112 if (view()->removeAutoInsets()) {
1113 #warning repaint() or update() or nothing ?
1115 view()->fitCursor();
1119 case LFUN_DEPTH_MIN:
1120 changeDepth(view(), TEXT(false), DEC_DEPTH, false);
1121 owner->view_state_changed();
1124 case LFUN_DEPTH_PLUS:
1125 changeDepth(view(), TEXT(false), INC_DEPTH, false);
1126 owner->view_state_changed();
1129 case LFUN_FREEFONT_APPLY:
1130 apply_freefont(view());
1133 case LFUN_FREEFONT_UPDATE:
1134 update_and_apply_freefont(view(), argument);
1137 case LFUN_RECONFIGURE:
1138 Reconfigure(view());
1142 case LFUN_FLOATSOPERATE:
1143 if (argument == "openfoot")
1144 view()->allFloats(1,0);
1145 else if (argument == "closefoot")
1146 view()->allFloats(0,0);
1147 else if (argument == "openfig")
1148 view()->allFloats(1,1);
1149 else if (argument == "closefig")
1150 view()->allFloats(0,1);
1153 #ifdef WITH_WARNINGS
1154 //#warning Find another implementation here (or another lyxfunc)!
1157 case LFUN_HELP_ABOUTLYX:
1158 owner->getDialogs().show("about");
1161 case LFUN_HELP_TEXINFO:
1162 owner->getDialogs().showTexinfo();
1165 case LFUN_HELP_OPEN:
1167 string const arg = argument;
1169 setErrorMessage(N_("Missing argument"));
1172 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1173 if (fname.empty()) {
1174 lyxerr << "LyX: unable to find documentation file `"
1175 << arg << "'. Bad installation?" << endl;
1179 #if USE_BOOST_FORMAT
1180 str << boost::format(_("Opening help file %1$s..."))
1181 % MakeDisplayPath(fname);
1183 str << _("Opening help file ")
1184 << MakeDisplayPath(fname) << _("...");
1186 owner->message(STRCONV(str.str()));
1187 view()->buffer(bufferlist.loadLyXFile(fname, false));
1191 // --- version control -------------------------------
1192 case LFUN_VC_REGISTER:
1194 if (!owner->buffer()->lyxvc.inUse())
1195 owner->buffer()->lyxvc.registrer();
1199 case LFUN_VC_CHECKIN:
1201 if (owner->buffer()->lyxvc.inUse()
1202 && !owner->buffer()->isReadonly())
1203 owner->buffer()->lyxvc.checkIn();
1207 case LFUN_VC_CHECKOUT:
1209 if (owner->buffer()->lyxvc.inUse()
1210 && owner->buffer()->isReadonly())
1211 owner->buffer()->lyxvc.checkOut();
1215 case LFUN_VC_REVERT:
1217 owner->buffer()->lyxvc.revert();
1223 owner->buffer()->lyxvc.undoLast();
1227 case LFUN_VC_HISTORY:
1229 owner->getDialogs().show("vclog");
1233 // --- buffers ----------------------------------------
1235 case LFUN_SWITCHBUFFER:
1236 view()->buffer(bufferlist.getBuffer(argument));
1241 // servercmd: argument must be <file>:<template>
1242 Buffer * tmpbuf = NewFile(argument);
1244 view()->buffer(tmpbuf);
1248 case LFUN_FILE_OPEN:
1252 case LFUN_LATEX_LOG:
1253 owner->getDialogs().show("log");
1256 case LFUN_LAYOUT_DOCUMENT:
1257 owner->getDialogs().showDocument();
1260 case LFUN_LAYOUT_CHARACTER: {
1261 string data = freefont2string();
1263 owner->getDialogs().show("character", data);
1267 case LFUN_LAYOUT_TABULAR:
1268 if (view()->theLockingInset()) {
1269 if (view()->theLockingInset()->lyxCode()==Inset::TABULAR_CODE) {
1270 InsetTabular * inset = static_cast<InsetTabular *>
1271 (view()->theLockingInset());
1272 inset->openLayoutDialog(view());
1273 } else if (view()->theLockingInset()->
1274 getFirstLockingInsetOfType(Inset::TABULAR_CODE)!=0) {
1275 InsetTabular * inset = static_cast<InsetTabular *>(
1276 view()->theLockingInset()->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
1277 inset->openLayoutDialog(view());
1282 case LFUN_LAYOUT_PREAMBLE:
1283 owner->getDialogs().showPreamble();
1286 case LFUN_DROP_LAYOUTS_CHOICE:
1287 owner->getToolbar().openLayoutList();
1290 case LFUN_MENU_OPEN_BY_NAME:
1291 owner->getMenubar().openByName(argument);
1292 break; // RVDK_PATCH_5
1294 case LFUN_SPELLCHECK:
1295 owner->getDialogs().showSpellchecker();
1298 // --- lyxserver commands ----------------------------
1302 setMessage(owner->buffer()->fileName());
1303 lyxerr[Debug::INFO] << "FNAME["
1304 << owner->buffer()->fileName()
1310 dispatch_buffer = keyseq.print();
1311 lyxserver->notifyClient(dispatch_buffer);
1315 case LFUN_GOTOFILEROW:
1319 istringstream istr(argument.c_str());
1320 istr >> file_name >> row;
1321 // Must replace extension of the file to be .lyx and get full path
1322 string const s(ChangeExtension(file_name, ".lyx"));
1324 // Either change buffer or load the file
1325 if (bufferlist.exists(s)) {
1326 view()->buffer(bufferlist.getBuffer(s));
1328 view()->buffer(bufferlist.loadLyXFile(s));
1331 view()->setCursorFromRow(row);
1334 // see BufferView_pimpl::center()
1335 view()->updateScrollbar();
1339 case LFUN_GOTO_PARAGRAPH:
1341 istringstream istr(argument.c_str());
1345 Paragraph * par = owner->buffer()->getParFromID(id);
1347 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1348 << id << ']' << endl;
1351 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1352 << " found." << endl;
1355 if (view()->theLockingInset())
1356 view()->unlockInset(view()->theLockingInset());
1357 if (par->inInset()) {
1358 par->inInset()->edit(view());
1361 view()->getLyXText()->setCursor(par, 0);
1362 view()->switchKeyMap();
1363 owner->view_state_changed();
1366 // see BufferView_pimpl::center()
1367 view()->updateScrollbar();
1371 // --- insert characters ----------------------------------------
1373 // --- Mathed stuff. If we are here, there is no locked inset yet.
1374 case LFUN_MATH_EXTERN:
1375 case LFUN_MATH_NUMBER:
1376 case LFUN_MATH_NONUMBER:
1377 case LFUN_MATH_LIMITS:
1379 setErrorMessage(N_("This is only allowed in math mode!"));
1383 // passthrough hat and underscore outside mathed:
1384 case LFUN_SUBSCRIPT:
1385 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "_"));
1387 case LFUN_SUPERSCRIPT:
1388 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "^"));
1391 case LFUN_MATH_PANEL:
1392 owner->getDialogs().showMathPanel();
1395 case LFUN_DIALOG_SHOW_NEW_INSET: {
1396 string const & name = argument;
1398 if (name == "bibitem" ||
1400 name == "include" ||
1405 InsetCommandParams p(name);
1406 data = InsetCommandMailer::params2string(name, p);
1407 } else if (name == "citation") {
1408 InsetCommandParams p("cite");
1409 data = InsetCommandMailer::params2string(name, p);
1411 owner->getDialogs().show(name, data, 0);
1415 case LFUN_DIALOG_SHOW_NEXT_INSET: {
1419 case LFUN_DIALOG_UPDATE: {
1420 string const & name = argument;
1421 // Can only update a dialog connected to an existing inset
1422 InsetBase * inset = owner->getDialogs().getOpenInset(name);
1424 FuncRequest fr(view(), LFUN_INSET_DIALOG_UPDATE,
1426 inset->localDispatch(fr);
1427 } else if (name == "paragraph") {
1428 dispatch(FuncRequest(LFUN_PARAGRAPH_UPDATE));
1433 case LFUN_DIALOG_HIDE:
1434 Dialogs::hide(argument, 0);
1437 case LFUN_DIALOG_DISCONNECT_INSET:
1438 owner->getDialogs().disconnect(argument);
1441 case LFUN_CHILDOPEN:
1443 string const filename =
1444 MakeAbsPath(argument,
1445 owner->buffer()->filePath());
1446 setMessage(N_("Opening child document ") +
1447 MakeDisplayPath(filename) + "...");
1448 view()->savePosition(0);
1449 if (bufferlist.exists(filename))
1450 view()->buffer(bufferlist.getBuffer(filename));
1452 view()->buffer(bufferlist.loadLyXFile(filename));
1456 case LFUN_TOGGLECURSORFOLLOW:
1457 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1461 owner->getIntl().KeyMapOn(false);
1464 case LFUN_KMAP_PRIM:
1465 owner->getIntl().KeyMapPrim();
1469 owner->getIntl().KeyMapSec();
1472 case LFUN_KMAP_TOGGLE:
1473 owner->getIntl().ToggleKeyMap();
1478 // argument contains ';'-terminated commands
1479 while (!argument.empty()) {
1481 argument = split(argument, first, ';');
1487 case LFUN_DIALOG_PREFERENCES:
1488 owner->getDialogs().showPreferences();
1491 case LFUN_SAVEPREFERENCES:
1493 Path p(user_lyxdir);
1494 lyxrc.write("preferences");
1498 case LFUN_SCREEN_FONT_UPDATE:
1500 // handle the screen font changes.
1501 lyxrc.set_font_norm_type();
1502 lyx_gui::update_fonts();
1503 // We also need to empty the textcache so that
1504 // the buffer will be formatted correctly after
1507 // Of course we should only do the resize and the textcache.clear
1508 // if values really changed...but not very important right now. (Lgb)
1509 // All visible buffers will need resize
1515 case LFUN_SET_COLOR:
1518 string const x11_name = split(argument, lyx_name, ' ');
1519 if (lyx_name.empty() || x11_name.empty()) {
1520 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1525 bool const graphicsbg_changed =
1526 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1527 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1529 if (!lcolor.setColor(lyx_name, x11_name)) {
1530 #if USE_BOOST_FORMAT
1534 _("Set-color \"%1$s\" failed "
1535 "- color is undefined or "
1536 "may not be redefined"))
1539 setErrorMessage(_("Set-color ") + lyx_name
1540 + _(" failed - color is undefined"
1541 " or may not be redefined"));
1547 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1549 if (graphicsbg_changed) {
1550 #ifdef WITH_WARNINGS
1551 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1554 grfx::GCache & gc = grfx::GCache::get();
1555 gc.changeDisplay(true);
1564 owner->message(argument);
1567 case LFUN_FORKS_SHOW:
1568 owner->getDialogs().showForks();
1571 case LFUN_FORKS_KILL:
1573 if (!isStrInt(argument))
1576 pid_t const pid = strToInt(argument);
1577 ForkedcallsController & fcc = ForkedcallsController::get();
1582 case LFUN_TOOLTIPS_TOGGLE:
1583 owner->getDialogs().toggleTooltips();
1587 // Then if it was none of the above
1588 // Trying the BufferView::pimpl dispatch:
1589 if (!view()->dispatch(ev))
1590 lyxerr << "A truly unknown func ["
1591 << lyxaction.getActionName(ev.action) << "]!"
1598 view()->owner()->updateLayoutChoice();
1600 if (view()->available()) {
1601 view()->fitCursor();
1603 // If we executed a mutating lfun, mark the buffer as dirty
1604 if (!lyxaction.funcHasFlag(ev.action, LyXAction::NoBuffer)
1605 && !lyxaction.funcHasFlag(ev.action, LyXAction::ReadOnly))
1606 view()->buffer()->markDirty();
1609 sendDispatchMessage(getMessage(), ev, verbose);
1613 void LyXFunc::sendDispatchMessage(string const & msg, FuncRequest const & ev, bool verbose)
1615 owner->updateMenubar();
1616 owner->updateToolbar();
1618 if (ev.action == LFUN_SELFINSERT || !verbose) {
1619 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1621 owner->message(msg);
1625 string dispatch_msg = msg;
1626 if (!dispatch_msg.empty())
1627 dispatch_msg += ' ';
1629 string comname = lyxaction.getActionName(ev.action);
1631 int pseudoaction = ev.action;
1632 bool argsadded = false;
1634 if (!ev.argument.empty()) {
1635 // the pseudoaction is useful for the bindings
1636 pseudoaction = lyxaction.searchActionArg(ev.action, ev.argument);
1638 if (pseudoaction == LFUN_UNKNOWN_ACTION) {
1639 pseudoaction = ev.action;
1641 comname += ' ' + ev.argument;
1646 string const shortcuts = toplevel_keymap->findbinding(pseudoaction);
1648 if (!shortcuts.empty()) {
1649 comname += ": " + shortcuts;
1650 } else if (!argsadded && !ev.argument.empty()) {
1651 comname += ' ' + ev.argument;
1654 if (!comname.empty()) {
1655 comname = rtrim(comname);
1656 dispatch_msg += '(' + comname + ')';
1659 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1660 if (!dispatch_msg.empty())
1661 owner->message(dispatch_msg);
1665 void LyXFunc::setupLocalKeymap()
1667 keyseq.stdmap = keyseq.curmap = toplevel_keymap.get();
1668 cancel_meta_seq.stdmap = cancel_meta_seq.curmap = toplevel_keymap.get();
1672 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1674 string initpath = lyxrc.document_path;
1675 string filename(name);
1677 if (view()->available()) {
1678 string const trypath = owner->buffer()->filePath();
1679 // If directory is writeable, use this as default.
1680 if (IsDirWriteable(trypath))
1684 static int newfile_number;
1686 if (filename.empty()) {
1687 filename = AddName(lyxrc.document_path,
1688 "newfile" + tostr(++newfile_number) + ".lyx");
1689 FileInfo fi(filename);
1690 while (bufferlist.exists(filename) || fi.readable()) {
1692 filename = AddName(lyxrc.document_path,
1693 "newfile" + tostr(newfile_number) +
1695 fi.newFile(filename);
1699 // The template stuff
1702 FileDialog fileDlg(_("Select template file"),
1703 LFUN_SELECT_FILE_SYNC,
1704 make_pair(string(_("Documents|#o#O")),
1705 string(lyxrc.document_path)),
1706 make_pair(string(_("Templates|#T#t")),
1707 string(lyxrc.template_path)));
1709 FileDialog::Result result =
1710 fileDlg.open(lyxrc.template_path,
1711 _("*.lyx| LyX Documents (*.lyx)"));
1713 if (result.first == FileDialog::Later)
1716 string const fname = result.second;
1723 view()->buffer(bufferlist.newFile(filename, templname, !name.empty()));
1727 void LyXFunc::open(string const & fname)
1729 string initpath = lyxrc.document_path;
1731 if (view()->available()) {
1732 string const trypath = owner->buffer()->filePath();
1733 // If directory is writeable, use this as default.
1734 if (IsDirWriteable(trypath))
1740 if (fname.empty()) {
1741 FileDialog fileDlg(_("Select document to open"),
1743 make_pair(string(_("Documents|#o#O")),
1744 string(lyxrc.document_path)),
1745 make_pair(string(_("Examples|#E#e")),
1746 string(AddPath(system_lyxdir, "examples"))));
1748 FileDialog::Result result =
1749 fileDlg.open(initpath,
1750 _("*.lyx| LyX Documents (*.lyx)"));
1752 if (result.first == FileDialog::Later)
1755 filename = result.second;
1757 // check selected filename
1758 if (filename.empty()) {
1759 owner->message(_("Canceled."));
1765 // get absolute path of file and add ".lyx" to the filename if
1767 string const fullpath = FileSearch(string(), filename, "lyx");
1768 if (!fullpath.empty()) {
1769 filename = fullpath;
1772 string const disp_fn(MakeDisplayPath(filename));
1774 // if the file doesn't exist, let the user create one
1775 FileInfo const f(filename, true);
1777 // the user specifically chose this name. Believe them.
1778 Buffer * buffer = bufferlist.newFile(filename, "", true);
1779 view()->buffer(buffer);
1784 #if USE_BOOST_FORMAT
1785 str << boost::format(_("Opening document %1$s...")) % disp_fn;
1787 str << _("Opening document ") << disp_fn << _("...");
1790 owner->message(STRCONV(str.str()));
1792 Buffer * openbuf = bufferlist.loadLyXFile(filename);
1795 view()->buffer(openbuf);
1796 #if USE_BOOST_FORMAT
1797 str2 << boost::format(_("Document %1$s opened.")) % disp_fn;
1799 str2 << _("Document ") << disp_fn << _(" opened.");
1802 #if USE_BOOST_FORMAT
1803 str2 << boost::format(_("Could not open document %1$s"))
1806 str2 << _("Could not open document ") << disp_fn;
1809 owner->message(STRCONV(str2.str()));
1813 void LyXFunc::doImport(string const & argument)
1816 string filename = split(argument, format, ' ');
1818 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1819 << " file: " << filename << endl;
1821 // need user interaction
1822 if (filename.empty()) {
1823 string initpath = lyxrc.document_path;
1825 if (view()->available()) {
1826 string const trypath = owner->buffer()->filePath();
1827 // If directory is writeable, use this as default.
1828 if (IsDirWriteable(trypath))
1832 #if USE_BOOST_FORMAT
1833 boost::format fmt(_("Select %1$s file to import"));
1834 fmt % formats.prettyName(format);
1835 string const text = fmt.str();
1837 string const text = _("Select ") + formats.prettyName(format)
1838 + _(" file to import");;
1841 FileDialog fileDlg(text,
1843 make_pair(string(_("Documents|#o#O")),
1844 string(lyxrc.document_path)),
1845 make_pair(string(_("Examples|#E#e")),
1846 string(AddPath(system_lyxdir, "examples"))));
1848 string const extension = "*." + formats.extension(format)
1849 + "| " + formats.prettyName(format)
1850 + " (*." + formats.extension(format) + ')';
1852 FileDialog::Result result = fileDlg.open(initpath,
1855 if (result.first == FileDialog::Later)
1858 filename = result.second;
1860 // check selected filename
1861 if (filename.empty())
1862 owner->message(_("Canceled."));
1865 if (filename.empty())
1868 // get absolute path of file
1869 filename = MakeAbsPath(filename);
1871 string const lyxfile = ChangeExtension(filename, ".lyx");
1873 // Check if the document already is open
1874 if (lyx_gui::use_gui && bufferlist.exists(lyxfile)) {
1875 if (!bufferlist.close(bufferlist.getBuffer(lyxfile), true)) {
1876 owner->message(_("Canceled."));
1881 // if the file exists already, and we didn't do
1882 // -i lyx thefile.lyx, warn
1883 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1884 string const file = MakeDisplayPath(lyxfile, 30);
1886 #if USE_BOOST_FORMAT
1887 boost::format fmt(_("The document %1$s already exists.\n\nDo you want to over-write that document?"));
1889 string text = fmt.str();
1891 string text = _("The document ");
1892 text += file + _(" already exists.\n\nDo you want to over-write that document?");
1894 int const ret = Alert::prompt(_("Over-write document?"),
1895 text, 1, _("&Over-write"), _("&Cancel"));
1898 owner->message(_("Canceled."));
1903 Importer::Import(owner, filename, format);
1907 void LyXFunc::closeBuffer()
1909 if (bufferlist.close(owner->buffer(), true) && !quitting) {
1910 if (bufferlist.empty()) {
1911 // need this otherwise SEGV may occur while trying to
1912 // set variables that don't exist
1913 // since there's no current buffer
1914 owner->getDialogs().hideBufferDependent();
1916 view()->buffer(bufferlist.first());
1922 // Each "owner" should have it's own message method. lyxview and
1923 // the minibuffer would use the minibuffer, but lyxserver would
1924 // send an ERROR signal to its client. Alejandro 970603
1925 // This func is bit problematic when it comes to NLS, to make the
1926 // lyx servers client be language indepenent we must not translate
1927 // strings sent to this func.
1928 void LyXFunc::setErrorMessage(string const & m) const
1930 dispatch_buffer = m;
1935 void LyXFunc::setMessage(string const & m) const
1937 dispatch_buffer = m;
1941 void LyXFunc::setStatusMessage(string const & m) const
1947 string const LyXFunc::view_status_message()
1949 // When meta-fake key is pressed, show the key sequence so far + "M-".
1951 return keyseq.print() + "M-";
1954 // Else, when a non-complete key sequence is pressed,
1955 // show the available options.
1956 if (keyseq.length() > 0 && !keyseq.deleted()) {
1957 return keyseq.printOptions();
1960 if (!view()->available())
1961 return _("Welcome to LyX!");
1963 return currentState(view());
1967 BufferView * LyXFunc::view() const
1970 return owner->view().get();