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 * ====================================================== */
14 #pragma implementation
21 #include "bufferlist.h"
22 #include "BufferView.h"
23 #include "lyxserver.h"
27 #include "LyXAction.h"
33 #include "trans_mgr.h"
35 #include "bufferview_funcs.h"
36 #include "frontends/LyXView.h"
37 #include "frontends/lyx_gui.h"
39 #include "FloatList.h"
40 #include "converter.h"
43 #include "TextCache.h"
45 #include "undo_funcs.h"
46 #include "ParagraphParameters.h"
48 #include "insets/inseturl.h"
49 #include "insets/insetlatexaccent.h"
50 #include "insets/insettoc.h"
51 #include "insets/insetref.h"
52 #include "insets/insetparent.h"
53 #include "insets/insetindex.h"
54 #include "insets/insetinclude.h"
55 #include "insets/insetbib.h"
56 #include "insets/insetcite.h"
57 #include "insets/insettext.h"
58 #include "insets/insetert.h"
59 #include "insets/insetexternal.h"
60 #include "insets/insetgraphics.h"
61 #include "insets/insetfoot.h"
62 #include "insets/insetmarginal.h"
63 #include "insets/insetminipage.h"
64 #include "insets/insetfloat.h"
66 #include "insets/insetlist.h"
67 #include "insets/insettheorem.h"
69 #include "insets/insettabular.h"
70 #include "insets/insetcaption.h"
72 #include "mathed/formulamacro.h"
73 #include "mathed/math_cursor.h"
74 #include "mathed/math_inset.h"
76 #include "frontends/FileDialog.h"
77 #include "frontends/Dialogs.h"
78 #include "frontends/Toolbar.h"
79 #include "frontends/Menubar.h"
80 #include "frontends/Alert.h"
82 #include "graphics/GraphicsCache.h"
84 #include "support/lyxalgo.h"
85 #include "support/LAssert.h"
86 #include "support/filetools.h"
87 #include "support/FileInfo.h"
88 #include "support/forkedcontr.h"
89 #include "support/lstrings.h"
90 #include "support/path.h"
91 #include "support/lyxfunctional.h"
102 using std::make_pair;
106 using std::transform;
107 using std::back_inserter;
109 extern BufferList bufferlist;
110 extern LyXServer * lyxserver;
111 extern bool selection_possible;
113 extern boost::scoped_ptr<kb_keymap> toplevel_keymap;
116 extern tex_accent_struct get_accent(kb_action action);
118 extern void ShowLatexLog();
121 LyXFunc::LyXFunc(LyXView * o)
123 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
124 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get())
126 meta_fake_bit = key_modifier::none;
127 lyx_dead_action = LFUN_NOACTION;
128 lyx_calling_dead_action = LFUN_NOACTION;
133 LyXText * LyXFunc::TEXT(bool flag = true) const
137 return view()->getLyXText();
142 void LyXFunc::moveCursorUpdate(bool flag, bool selecting)
144 if (selecting || TEXT(flag)->selection.mark()) {
145 TEXT(flag)->setSelection(view());
146 if (TEXT(flag)->bv_owner)
147 view()->toggleToggle();
149 view()->update(TEXT(flag), BufferView::SELECT|BufferView::FITCUR);
150 view()->showCursor();
152 view()->switchKeyMap();
156 void LyXFunc::handleKeyFunc(kb_action action)
158 char c = keyseq.getLastKeyEncoded();
160 if (keyseq.length() > 1) {
164 owner->getIntl().getTransManager()
165 .deadkey(c, get_accent(action).accent, TEXT(false));
166 // Need to clear, in case the minibuffer calls these
169 // copied verbatim from do_accent_char
170 view()->update(TEXT(false),
171 BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
172 TEXT(false)->selection.cursor = TEXT(false)->cursor;
176 void LyXFunc::processKeySym(LyXKeySymPtr keysym,
177 key_modifier::state state)
181 if (lyxerr.debugging(Debug::KEY)) {
182 lyxerr << "KeySym is "
183 << keysym->getSymbolName()
186 // Do nothing if we have nothing (JMarc)
187 if (!keysym->isOK()) {
188 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
193 if (keysym->isModifier()) {
197 // Do a one-deep top-level lookup for
198 // cancel and meta-fake keys. RVDK_PATCH_5
199 cancel_meta_seq.reset();
201 int action = cancel_meta_seq.addkey(keysym, state);
202 if (lyxerr.debugging(Debug::KEY)) {
203 lyxerr << "action first set to [" << action << "]" << endl;
206 // When not cancel or meta-fake, do the normal lookup.
207 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
208 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
209 if ((action != LFUN_CANCEL) && (action != LFUN_META_FAKE)) {
210 // remove Caps Lock and Mod2 as a modifiers
211 action = keyseq.addkey(keysym, (state | meta_fake_bit));
212 lyxerr[Debug::KEY] << "action now set to ["
213 << action << "]" << endl;
216 // Dont remove this unless you know what you are doing.
217 meta_fake_bit = key_modifier::none;
219 // can this happen now ?
220 if (action == LFUN_NOACTION) {
221 action = LFUN_PREFIX;
224 if (lyxerr.debugging(Debug::KEY)) {
225 lyxerr << "Key [action="
227 << keyseq.print() << "]"
231 // already here we know if it any point in going further
232 // why not return already here if action == -1 and
233 // num_bytes == 0? (Lgb)
235 if (keyseq.length() > 1) {
236 owner->message(keyseq.print());
239 if (action == LFUN_UNKNOWN_ACTION) {
240 // It is unknown, but what if we remove all
241 // the modifiers? (Lgb)
242 action = keyseq.addkey(keysym, key_modifier::none);
244 lyxerr[Debug::KEY] << "Removing modifiers...\n"
245 << "Action now set to ["
246 << action << "]" << endl;
248 if (action == LFUN_UNKNOWN_ACTION) {
249 owner->message(_("Unknown function."));
254 if (action == LFUN_SELFINSERT) {
255 char c = keysym->getISOEncoded();
261 dispatch(FuncRequest(view(), LFUN_SELFINSERT, argument));
262 lyxerr[Debug::KEY] << "SelfInsert arg[`"
263 << argument << "']" << endl;
270 FuncStatus LyXFunc::getStatus(int ac) const
272 return getStatus(lyxaction.retrieveActionArg(ac));
276 FuncStatus LyXFunc::getStatus(FuncRequest const & ev) const
279 Buffer * buf = owner->buffer();
281 if (ev.action == LFUN_NOACTION) {
282 setStatusMessage(N_("Nothing to do"));
283 return flag.disabled(true);
286 if (ev.action == LFUN_UNKNOWN_ACTION) {
287 setStatusMessage(N_("Unknown action"));
288 return flag.unknown(true);
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 == "fax" &&
327 !Exporter::IsExportable(buf, ev.argument);
330 disable = buf->undostack.empty();
333 disable = buf->redostack.empty();
335 #ifndef HAVE_LIBAIKSAURUS
336 case LFUN_THESAURUS_ENTRY:
341 disable = lyxrc.chktex_command == "none";
344 disable = !Exporter::IsExportable(buf, "program");
347 case LFUN_LAYOUT_CHARACTER:
348 disable = tli && tli->lyxCode() == Inset::ERT_CODE;
351 case LFUN_LAYOUT_TABULAR:
353 || (tli->lyxCode() != Inset::TABULAR_CODE
354 && !tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
358 case LFUN_LAYOUT_PARAGRAPH: {
359 Inset * inset = TEXT(false)->cursor.par()->inInset();
360 disable = inset && inset->forceDefaultParagraphs(inset);
364 case LFUN_INSET_OPTARG:
365 disable = (TEXT(false)->cursor.par()->layout()->optionalargs == 0);
368 case LFUN_TABULAR_FEATURE:
371 // FIXME: check temporarily disabled
373 char align = mathcursor->valign();
378 if (ev.argument.empty()) {
382 if (!contains("tcb", ev.argument[0])) {
386 flag.setOnOff(ev.argument[0] == align);
390 char align = mathcursor->halign();
395 if (ev.argument.empty()) {
399 if (!contains("lcr", ev.argument[0])) {
403 flag.setOnOff(ev.argument[0] == align);
406 disable = !mathcursor->halign();
412 //ret.disabled(true);
413 if (tli->lyxCode() == Inset::TABULAR_CODE) {
414 ret = static_cast<InsetTabular *>(tli)
415 ->getStatus(ev.argument);
416 } else if (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE)) {
417 ret = static_cast<InsetTabular *>
418 (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE))
419 ->getStatus(ev.argument);
424 static InsetTabular inset(*owner->buffer(), 1, 1);
428 ret = inset.getStatus(ev.argument);
429 if (ret.onoff(true) || ret.onoff(false))
430 flag.setOnOff(false);
434 case LFUN_VC_REGISTER:
435 disable = buf->lyxvc.inUse();
437 case LFUN_VC_CHECKIN:
438 disable = !buf->lyxvc.inUse() || buf->isReadonly();
440 case LFUN_VC_CHECKOUT:
441 disable = !buf->lyxvc.inUse() || !buf->isReadonly();
445 case LFUN_VC_HISTORY:
446 disable = !buf->lyxvc.inUse();
448 case LFUN_BOOKMARK_GOTO:
450 isSavedPosition(strToUnsignedInt(ev.argument));
452 case LFUN_INSET_TOGGLE: {
453 LyXText * lt = view()->getLyXText();
454 disable = !(isEditableInset(lt->getInset())
456 && lt->inset_owner->owner()
457 && lt->inset_owner->owner()->isOpen()));
461 disable = !IsFileReadable(buf->getLogName().second);
464 case LFUN_MATH_MUTATE:
466 //flag.setOnOff(mathcursor->formula()->hullType() == ev.argument);
467 flag.setOnOff(false);
472 // we just need to be in math mode to enable that
474 case LFUN_MATH_SPACE:
475 case LFUN_MATH_LIMITS:
476 case LFUN_MATH_NONUMBER:
477 case LFUN_MATH_NUMBER:
478 case LFUN_MATH_EXTERN:
479 disable = !mathcursor;
486 // the functions which insert insets
487 Inset::Code code = Inset::NO_CODE;
490 code = Inset::ERT_CODE;
492 case LFUN_INSET_GRAPHICS:
493 code = Inset::GRAPHICS_CODE;
495 case LFUN_INSET_FOOTNOTE:
496 code = Inset::FOOT_CODE;
498 case LFUN_TABULAR_INSERT:
499 code = Inset::TABULAR_CODE;
501 case LFUN_INSET_EXTERNAL:
502 code = Inset::EXTERNAL_CODE;
504 case LFUN_INSET_MARGINAL:
505 code = Inset::MARGIN_CODE;
507 case LFUN_INSET_MINIPAGE:
508 code = Inset::MINIPAGE_CODE;
510 case LFUN_INSET_FLOAT:
511 case LFUN_INSET_WIDE_FLOAT:
512 code = Inset::FLOAT_CODE;
514 case LFUN_FLOAT_LIST:
515 code = Inset::FLOAT_LIST_CODE;
518 case LFUN_INSET_LIST:
519 code = Inset::LIST_CODE;
521 case LFUN_INSET_THEOREM:
522 code = Inset::THEOREM_CODE;
525 case LFUN_INSET_CAPTION:
526 code = Inset::CAPTION_CODE;
528 case LFUN_INSERT_NOTE:
529 code = Inset::NOTE_CODE;
531 case LFUN_INSERT_LABEL:
532 code = Inset::LABEL_CODE;
534 case LFUN_INSET_OPTARG:
535 code = Inset::OPTARG_CODE;
537 case LFUN_REF_INSERT:
538 code = Inset::REF_CODE;
540 case LFUN_CITATION_CREATE:
541 case LFUN_CITATION_INSERT:
542 code = Inset::CITE_CODE;
544 case LFUN_INSERT_BIBTEX:
545 code = Inset::BIBTEX_CODE;
547 case LFUN_INDEX_INSERT:
548 code = Inset::INDEX_CODE;
550 case LFUN_INDEX_PRINT:
551 code = Inset::INDEX_PRINT_CODE;
553 case LFUN_CHILD_INSERT:
554 code = Inset::INCLUDE_CODE;
556 case LFUN_TOC_INSERT:
557 code = Inset::TOC_CODE;
559 case LFUN_PARENTINSERT:
560 code = Inset::PARENT_CODE;
564 case LFUN_INSERT_URL:
565 code = Inset::URL_CODE;
568 // always allow this, since we will inset a raw quote
569 // if an inset is not allowed.
571 case LFUN_HYPHENATION:
572 case LFUN_LIGATURE_BREAK:
574 case LFUN_MENU_SEPARATOR:
576 case LFUN_END_OF_SENTENCE:
577 code = Inset::SPECIALCHAR_CODE;
579 case LFUN_PROTECTEDSPACE:
580 // slight hack: we know this is allowed in math mode
582 code = Inset::SPECIALCHAR_CODE;
587 if (code != Inset::NO_CODE && tli && !tli->insetAllowed(code))
593 // A few general toggles
595 case LFUN_TOOLTIPS_TOGGLE:
596 flag.setOnOff(owner->getDialogs().tooltipsEnabled());
599 case LFUN_READ_ONLY_TOGGLE:
600 flag.setOnOff(buf->isReadonly());
603 flag.setOnOff(TEXT(false)->cursor.par()->params().startOfAppendix());
605 case LFUN_SWITCHBUFFER:
606 // toggle on the current buffer, but do not toggle off
607 // the other ones (is that a good idea?)
608 if (ev.argument == buf->fileName())
615 // the font related toggles
617 LyXFont const & font = TEXT(false)->real_current_font;
620 flag.setOnOff(font.emph() == LyXFont::ON);
623 flag.setOnOff(font.noun() == LyXFont::ON);
626 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
629 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
632 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
635 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
641 string tc = mathcursor->getLastCode();
644 flag.setOnOff(tc == "mathbf");
647 flag.setOnOff(tc == "mathsf");
650 flag.setOnOff(tc == "mathcal");
653 flag.setOnOff(tc == "mathrm");
656 flag.setOnOff(tc == "mathtt");
659 flag.setOnOff(tc == "mathbb");
662 flag.setOnOff(tc == "mathnormal");
669 // this one is difficult to get right. As a half-baked
670 // solution, we consider only the first action of the sequence
671 if (ev.action == LFUN_SEQUENCE) {
672 // argument contains ';'-terminated commands
673 flag = getStatus(lyxaction.LookupFunc(token(ev.argument, ';', 0)));
680 void LyXFunc::dispatch(string const & s, bool verbose)
682 int const action = lyxaction.LookupFunc(s);
684 if (action == LFUN_UNKNOWN_ACTION) {
685 string const msg = string(_("Unknown function ("))
691 dispatch(action, verbose);
695 void LyXFunc::dispatch(int ac, bool verbose)
697 dispatch(lyxaction.retrieveActionArg(ac), verbose);
702 void LyXFunc::dispatch(FuncRequest const & ev, bool verbose)
704 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: action[" << ev.action
705 <<"] arg[" << ev.argument << "]" << endl;
707 // we have not done anything wrong yet.
709 dispatch_buffer.erase();
711 #ifdef NEW_DISPATCHER
712 // We try do call the most specific dispatcher first:
713 // 1. the lockinginset's dispatch
714 // 2. the bufferview's dispatch
715 // 3. the lyxview's dispatch
718 selection_possible = false;
720 if (view()->available())
721 view()->hideCursor();
723 string argument = ev.argument;
724 kb_action action = ev.action;
726 // We cannot use this function here
727 if (getStatus(ev).disabled()) {
728 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
729 << lyxaction.getActionName(action)
730 << " [" << action << "] is disabled at this location"
732 setErrorMessage(getStatusMessage());
733 goto exit_with_message;
736 if (view()->available() && view()->theLockingInset()) {
737 Inset::RESULT result;
738 if ((action > 1) || ((action == LFUN_UNKNOWN_ACTION) &&
739 (!keyseq.deleted())))
741 UpdatableInset * inset = view()->theLockingInset();
745 inset->getCursorPos(view(), inset_x, dummy_y);
747 if ((action == LFUN_UNKNOWN_ACTION)
748 && argument.empty()) {
749 argument = keyseq.getLastKeyEncoded();
751 // Undo/Redo is a bit tricky for insets.
752 if (action == LFUN_UNDO) {
754 goto exit_with_message;
755 } else if (action == LFUN_REDO) {
757 goto exit_with_message;
758 } else if (((result=inset->
759 // Hand-over to inset's own dispatch:
760 localDispatch(FuncRequest(view(), action, argument))) ==
761 UpdatableInset::DISPATCHED) ||
762 (result == UpdatableInset::DISPATCHED_NOUPDATE))
763 goto exit_with_message;
764 // If UNDISPATCHED, just soldier on
765 else if (result == UpdatableInset::FINISHED) {
766 goto exit_with_message;
767 // We do not need special RTL handling here:
768 // FINISHED means that the cursor should be
769 // one position after the inset.
770 } else if (result == UpdatableInset::FINISHED_RIGHT) {
771 TEXT()->cursorRight(view());
772 moveCursorUpdate(true, false);
773 owner->view_state_changed();
774 goto exit_with_message;
775 } else if (result == UpdatableInset::FINISHED_UP) {
776 if (TEXT()->cursor.irow()->previous()) {
778 TEXT()->setCursorFromCoordinates(
779 view(), TEXT()->cursor.ix() + inset_x,
780 TEXT()->cursor.iy() -
781 TEXT()->cursor.irow()->baseline() - 1);
782 TEXT()->cursor.x_fix(TEXT()->cursor.x());
784 TEXT()->cursorUp(view());
786 moveCursorUpdate(true, false);
787 owner->view_state_changed();
789 view()->update(TEXT(), BufferView::SELECT|BufferView::FITCUR);
791 goto exit_with_message;
792 } else if (result == UpdatableInset::FINISHED_DOWN) {
793 if (TEXT()->cursor.irow()->next()) {
795 TEXT()->setCursorFromCoordinates(
796 view(), TEXT()->cursor.ix() + inset_x,
797 TEXT()->cursor.iy() -
798 TEXT()->cursor.irow()->baseline() +
799 TEXT()->cursor.irow()->height() + 1);
800 TEXT()->cursor.x_fix(TEXT()->cursor.x());
802 TEXT()->cursorDown(view());
805 TEXT()->cursorRight(view());
807 moveCursorUpdate(true, false);
808 owner->view_state_changed();
809 goto exit_with_message;
811 #warning I am not sure this is still right, please have a look! (Jug 20020417)
812 else { // result == UNDISPATCHED
813 //setMessage(N_("Text mode"));
815 case LFUN_UNKNOWN_ACTION:
816 case LFUN_BREAKPARAGRAPH:
818 TEXT()->cursorRight(view());
819 view()->switchKeyMap();
820 owner->view_state_changed();
823 if (!TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
824 TEXT()->cursorRight(view());
825 moveCursorUpdate(true, false);
826 owner->view_state_changed();
828 goto exit_with_message;
830 if (TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
831 TEXT()->cursorRight(view());
832 moveCursorUpdate(true, false);
833 owner->view_state_changed();
835 goto exit_with_message;
837 if (TEXT()->cursor.row()->next())
838 TEXT()->cursorDown(view());
840 TEXT()->cursorRight(view());
841 moveCursorUpdate(true, false);
842 owner->view_state_changed();
843 goto exit_with_message;
855 if (!view()->available()) break;
856 // this function should be used always [asierra060396]
857 UpdatableInset * tli =
858 view()->theLockingInset();
860 UpdatableInset * lock = tli->getLockingInset();
863 view()->unlockInset(tli);
864 TEXT()->cursorRight(view());
865 moveCursorUpdate(true, false);
866 owner->view_state_changed();
868 tli->unlockInsetInInset(view(),
873 // Tell the paragraph dialog that we changed paragraph
874 owner->getDialogs().updateParagraph();
879 // --- Misc -------------------------------------------
880 case LFUN_WORDFINDFORWARD :
881 case LFUN_WORDFINDBACKWARD : {
882 static string last_search;
883 string searched_string;
885 if (!argument.empty()) {
886 last_search = argument;
887 searched_string = argument;
889 searched_string = last_search;
891 bool fw = (action == LFUN_WORDFINDBACKWARD);
892 if (!searched_string.empty()) {
893 lyxfind::LyXFind(view(), searched_string, fw);
895 // view()->showCursor();
901 if (view()->available() && !view()->theLockingInset()) {
902 view()->update(TEXT(),
903 BufferView::SELECT|BufferView::FITCUR);
905 owner->message(keyseq.printOptions());
909 // --- Misc -------------------------------------------
910 case LFUN_EXEC_COMMAND:
911 owner->focus_command_buffer();
914 case LFUN_CANCEL: // RVDK_PATCH_5
916 meta_fake_bit = key_modifier::none;
917 if (view()->available())
918 // cancel any selection
919 dispatch(LFUN_MARK_OFF);
920 setMessage(N_("Cancel"));
923 case LFUN_META_FAKE: // RVDK_PATCH_5
925 meta_fake_bit = key_modifier::alt;
926 setMessage(keyseq.print());
930 case LFUN_READ_ONLY_TOGGLE:
931 if (owner->buffer()->lyxvc.inUse()) {
932 owner->buffer()->lyxvc.toggleReadOnly();
934 owner->buffer()->setReadonly(
935 !owner->buffer()->isReadonly());
939 case LFUN_CENTER: // this is center and redraw.
943 // --- Menus -----------------------------------------------
945 menuNew(argument, false);
948 case LFUN_MENUNEWTMPLT:
949 menuNew(argument, true);
952 case LFUN_CLOSEBUFFER:
957 if (!owner->buffer()->isUnnamed()) {
959 s1 << _("Saving document") << ' '
960 << MakeDisplayPath(owner->buffer()->fileName() + "...");
961 owner->message(s1.str().c_str());
962 MenuWrite(view(), owner->buffer());
964 owner->message(s1.str().c_str());
966 WriteAs(view(), owner->buffer());
970 WriteAs(view(), owner->buffer(), argument);
973 case LFUN_MENURELOAD:
978 Exporter::Export(owner->buffer(), argument, true);
982 Exporter::Preview(owner->buffer(), argument);
986 Exporter::Export(owner->buffer(), "program", true);
990 MenuRunChktex(owner->buffer());
994 owner->getDialogs().showPrint();
998 if (argument == "custom")
999 owner->getDialogs().showSendto();
1001 Exporter::Export(owner->buffer(), argument, false);
1019 InsetCommandParams p;
1022 if (action == LFUN_TOCVIEW)
1024 p.setCmdName("tableofcontents");
1026 else if (action == LFUN_LOAVIEW)
1027 p.setCmdName("listof{algorithm}{List of Algorithms}");
1028 else if (action == LFUN_LOFVIEW)
1029 p.setCmdName("listoffigures");
1031 p.setCmdName("listoftables");
1033 owner->getDialogs().createTOC(p.getAsString());
1049 case LFUN_MENUSEARCH:
1050 owner->getDialogs().showSearch();
1053 case LFUN_REMOVEERRORS:
1054 if (view()->removeAutoInsets()) {
1055 #warning repaint() or update() or nothing ?
1057 view()->fitCursor();
1061 case LFUN_DEPTH_MIN:
1062 changeDepth(view(), TEXT(false), -1);
1065 case LFUN_DEPTH_PLUS:
1066 changeDepth(view(), TEXT(false), 1);
1070 owner->getDialogs().setUserFreeFont();
1073 case LFUN_RECONFIGURE:
1074 Reconfigure(view());
1078 case LFUN_FLOATSOPERATE:
1079 if (argument == "openfoot")
1080 view()->allFloats(1,0);
1081 else if (argument == "closefoot")
1082 view()->allFloats(0,0);
1083 else if (argument == "openfig")
1084 view()->allFloats(1,1);
1085 else if (argument == "closefig")
1086 view()->allFloats(0,1);
1089 #ifdef WITH_WARNINGS
1090 //#warning Find another implementation here (or another lyxfunc)!
1093 case LFUN_HELP_ABOUTLYX:
1094 owner->getDialogs().showAboutlyx();
1097 case LFUN_HELP_TEXINFO:
1098 owner->getDialogs().showTexinfo();
1101 case LFUN_HELP_OPEN:
1103 string const arg = argument;
1105 setErrorMessage(N_("Missing argument"));
1108 owner->prohibitInput();
1109 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1110 if (fname.empty()) {
1111 lyxerr << "LyX: unable to find documentation file `"
1112 << arg << "'. Bad installation?" << endl;
1113 owner->allowInput();
1117 str << _("Opening help file") << ' '
1118 << MakeDisplayPath(fname) << "...";
1119 owner->message(str.str().c_str());
1120 view()->buffer(bufferlist.loadLyXFile(fname, false));
1121 owner->allowInput();
1125 // --- version control -------------------------------
1126 case LFUN_VC_REGISTER:
1128 if (!owner->buffer()->lyxvc.inUse())
1129 owner->buffer()->lyxvc.registrer();
1133 case LFUN_VC_CHECKIN:
1135 if (owner->buffer()->lyxvc.inUse()
1136 && !owner->buffer()->isReadonly())
1137 owner->buffer()->lyxvc.checkIn();
1141 case LFUN_VC_CHECKOUT:
1143 if (owner->buffer()->lyxvc.inUse()
1144 && owner->buffer()->isReadonly())
1145 owner->buffer()->lyxvc.checkOut();
1149 case LFUN_VC_REVERT:
1151 owner->buffer()->lyxvc.revert();
1157 owner->buffer()->lyxvc.undoLast();
1161 case LFUN_VC_HISTORY:
1163 owner->getDialogs().showVCLogFile();
1167 // --- buffers ----------------------------------------
1169 case LFUN_SWITCHBUFFER:
1170 view()->buffer(bufferlist.getBuffer(argument));
1175 // servercmd: argument must be <file>:<template>
1176 Buffer * tmpbuf = NewFile(argument);
1178 view()->buffer(tmpbuf);
1182 case LFUN_FILE_OPEN:
1186 case LFUN_LATEX_LOG:
1187 owner->getDialogs().showLogFile();
1190 case LFUN_LAYOUT_DOCUMENT:
1191 owner->getDialogs().showDocument();
1194 case LFUN_LAYOUT_PARAGRAPH:
1195 owner->getDialogs().showParagraph();
1198 case LFUN_LAYOUT_CHARACTER:
1199 owner->getDialogs().showCharacter();
1202 case LFUN_LAYOUT_TABULAR:
1203 if (view()->theLockingInset()) {
1204 if (view()->theLockingInset()->lyxCode()==Inset::TABULAR_CODE) {
1205 InsetTabular * inset = static_cast<InsetTabular *>
1206 (view()->theLockingInset());
1207 inset->openLayoutDialog(view());
1208 } else if (view()->theLockingInset()->
1209 getFirstLockingInsetOfType(Inset::TABULAR_CODE)!=0) {
1210 InsetTabular * inset = static_cast<InsetTabular *>(
1211 view()->theLockingInset()->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
1212 inset->openLayoutDialog(view());
1217 case LFUN_LAYOUT_PREAMBLE:
1218 owner->getDialogs().showPreamble();
1221 case LFUN_DROP_LAYOUTS_CHOICE:
1222 owner->getToolbar().openLayoutList();
1225 case LFUN_MENU_OPEN_BY_NAME:
1226 owner->getMenubar().openByName(argument);
1227 break; // RVDK_PATCH_5
1229 case LFUN_SPELLCHECK:
1230 owner->getDialogs().showSpellchecker();
1233 // --- lyxserver commands ----------------------------
1237 setMessage(owner->buffer()->fileName());
1238 lyxerr[Debug::INFO] << "FNAME["
1239 << owner->buffer()->fileName()
1245 dispatch_buffer = keyseq.print();
1246 lyxserver->notifyClient(dispatch_buffer);
1250 case LFUN_GOTOFILEROW:
1254 istringstream istr(argument.c_str());
1255 istr >> file_name >> row;
1256 // Must replace extension of the file to be .lyx and get full path
1257 string const s(ChangeExtension(file_name, ".lyx"));
1259 // Either change buffer or load the file
1260 if (bufferlist.exists(s)) {
1261 view()->buffer(bufferlist.getBuffer(s));
1263 view()->buffer(bufferlist.loadLyXFile(s));
1266 view()->setCursorFromRow(row);
1269 // see BufferView_pimpl::center()
1270 view()->updateScrollbar();
1274 case LFUN_GOTO_PARAGRAPH:
1276 istringstream istr(argument.c_str());
1280 Paragraph * par = owner->buffer()->getParFromID(id);
1282 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1283 << id << "]" << endl;
1286 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1287 << " found." << endl;
1290 if (view()->theLockingInset())
1291 view()->unlockInset(view()->theLockingInset());
1292 if (par->inInset()) {
1293 par->inInset()->edit(view());
1296 view()->getLyXText()->setCursor(view(), par, 0);
1297 view()->switchKeyMap();
1298 owner->view_state_changed();
1301 // see BufferView_pimpl::center()
1302 view()->updateScrollbar();
1309 int const qa = lyxaction.LookupFunc(argument);
1310 setMessage(lyxaction.helpText(static_cast<kb_action>(qa)));
1314 // --- insert characters ----------------------------------------
1316 // --- Mathed stuff. If we are here, there is no locked inset yet.
1317 case LFUN_MATH_EXTERN:
1318 case LFUN_MATH_NUMBER:
1319 case LFUN_MATH_NONUMBER:
1320 case LFUN_MATH_LIMITS:
1322 setErrorMessage(N_("This is only allowed in math mode!"));
1326 // passthrough hat and underscore outside mathed:
1327 case LFUN_SUBSCRIPT:
1328 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "_"));
1330 case LFUN_SUPERSCRIPT:
1331 dispatch(FuncRequest(view(), LFUN_SELFINSERT, "^"));
1334 case LFUN_MATH_PANEL:
1335 owner->getDialogs().showMathPanel();
1338 case LFUN_CITATION_CREATE:
1340 InsetCommandParams p("cite");
1342 if (!argument.empty()) {
1343 // This should be set at source, ie when typing
1344 // "citation-insert foo" in the minibuffer.
1345 // Question: would pybibliographer also need to be
1346 // changed. Suspect so. Leave as-is therefore.
1347 if (contains(argument, "|")) {
1348 p.setContents(token(argument, '|', 0));
1349 p.setOptions(token(argument, '|', 1));
1351 p.setContents(argument);
1353 dispatch(FuncRequest(view(), LFUN_CITATION_INSERT, p.getAsString()));
1355 owner->getDialogs().createCitation(p.getAsString());
1359 case LFUN_CHILDOPEN:
1361 string const filename =
1362 MakeAbsPath(argument,
1363 owner->buffer()->filePath());
1364 setMessage(N_("Opening child document ") +
1365 MakeDisplayPath(filename) + "...");
1366 view()->savePosition(0);
1367 if (bufferlist.exists(filename))
1368 view()->buffer(bufferlist.getBuffer(filename));
1370 view()->buffer(bufferlist.loadLyXFile(filename));
1374 case LFUN_TOGGLECURSORFOLLOW:
1375 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1378 case LFUN_KMAP_OFF: // keymap off
1379 owner->getIntl().KeyMapOn(false);
1382 case LFUN_KMAP_PRIM: // primary keymap
1383 owner->getIntl().KeyMapPrim();
1386 case LFUN_KMAP_SEC: // secondary keymap
1387 owner->getIntl().KeyMapSec();
1390 case LFUN_KMAP_TOGGLE: // toggle keymap
1391 owner->getIntl().ToggleKeyMap();
1396 // argument contains ';'-terminated commands
1397 while (!argument.empty()) {
1399 argument = split(argument, first, ';');
1405 case LFUN_DIALOG_PREFERENCES:
1406 owner->getDialogs().showPreferences();
1409 case LFUN_SAVEPREFERENCES:
1411 Path p(user_lyxdir);
1412 lyxrc.write("preferences");
1416 case LFUN_SCREEN_FONT_UPDATE:
1418 // handle the screen font changes.
1419 lyxrc.set_font_norm_type();
1420 lyx_gui::update_fonts();
1421 // We also need to empty the textcache so that
1422 // the buffer will be formatted correctly after
1425 // Of course we should only do the resize and the textcache.clear
1426 // if values really changed...but not very important right now. (Lgb)
1427 // All visible buffers will need resize
1433 case LFUN_SET_COLOR:
1436 string const x11_name = split(argument, lyx_name, ' ');
1437 if (lyx_name.empty() || x11_name.empty()) {
1438 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1443 bool const graphicsbg_changed =
1444 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1445 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1447 if (!lcolor.setColor(lyx_name, x11_name)) {
1448 static string const err1 (N_("Set-color \""));
1449 static string const err2 (
1450 N_("\" failed - color is undefined "
1451 "or may not be redefined"));
1452 setErrorMessage(_(err1) + lyx_name + _(err2));
1456 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1458 if (graphicsbg_changed) {
1459 #ifdef WITH_WARNINGS
1460 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1463 grfx::GCache & gc = grfx::GCache::get();
1464 gc.changeDisplay(true);
1473 owner->message(argument);
1476 case LFUN_FORKS_SHOW:
1477 owner->getDialogs().showForks();
1480 case LFUN_FORKS_KILL:
1482 if (!isStrInt(argument))
1485 pid_t const pid = strToInt(argument);
1486 ForkedcallsController & fcc = ForkedcallsController::get();
1491 case LFUN_TOOLTIPS_TOGGLE:
1492 owner->getDialogs().toggleTooltips();
1496 // Then if it was none of the above
1497 // Trying the BufferView::pimpl dispatch:
1498 if (!view()->dispatch(ev))
1499 lyxerr << "A truly unknown func ["
1500 << lyxaction.getActionName(ev.action) << "]!"
1506 sendDispatchMessage(getMessage(), ev, verbose);
1510 void LyXFunc::sendDispatchMessage(string const & msg, FuncRequest const & ev, bool verbose)
1512 owner->updateMenubar();
1513 owner->updateToolbar();
1515 if (ev.action == LFUN_SELFINSERT || !verbose) {
1516 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1518 owner->message(msg);
1522 string dispatch_msg = msg;
1523 if (!dispatch_msg.empty())
1524 dispatch_msg += " ";
1526 string comname = lyxaction.getActionName(ev.action);
1528 int pseudoaction = ev.action;
1529 bool argsadded = false;
1531 if (!ev.argument.empty()) {
1532 // the pseudoaction is useful for the bindings
1533 pseudoaction = lyxaction.searchActionArg(ev.action, ev.argument);
1535 if (pseudoaction == LFUN_UNKNOWN_ACTION) {
1536 pseudoaction = ev.action;
1538 comname += " " + ev.argument;
1543 string const shortcuts = toplevel_keymap->findbinding(pseudoaction);
1545 if (!shortcuts.empty()) {
1546 comname += ": " + shortcuts;
1547 } else if (!argsadded && !ev.argument.empty()) {
1548 comname += " " + ev.argument;
1551 if (!comname.empty()) {
1552 comname = rtrim(comname);
1553 dispatch_msg += "(" + comname + ')';
1556 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1557 if (!dispatch_msg.empty())
1558 owner->message(dispatch_msg);
1562 void LyXFunc::setupLocalKeymap()
1564 keyseq.stdmap = keyseq.curmap = toplevel_keymap.get();
1565 cancel_meta_seq.stdmap = cancel_meta_seq.curmap = toplevel_keymap.get();
1569 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1571 string initpath = lyxrc.document_path;
1572 string filename(name);
1574 if (view()->available()) {
1575 string const trypath = owner->buffer()->filePath();
1576 // If directory is writeable, use this as default.
1577 if (IsDirWriteable(trypath))
1581 static int newfile_number;
1583 if (filename.empty()) {
1584 filename = AddName(lyxrc.document_path,
1585 "newfile" + tostr(++newfile_number) + ".lyx");
1586 FileInfo fi(filename);
1587 while (bufferlist.exists(filename) || fi.readable()) {
1589 filename = AddName(lyxrc.document_path,
1590 "newfile" + tostr(newfile_number) +
1592 fi.newFile(filename);
1596 // The template stuff
1599 FileDialog fileDlg(owner, _("Select template file"),
1600 LFUN_SELECT_FILE_SYNC,
1601 make_pair(string(_("Documents|#o#O")),
1602 string(lyxrc.document_path)),
1603 make_pair(string(_("Templates|#T#t")),
1604 string(lyxrc.template_path)));
1606 FileDialog::Result result =
1607 fileDlg.Select(lyxrc.template_path,
1608 _("*.lyx|LyX Documents (*.lyx)"));
1610 if (result.first == FileDialog::Later)
1613 string const fname = result.second;
1620 view()->buffer(bufferlist.newFile(filename, templname, !name.empty()));
1624 void LyXFunc::open(string const & fname)
1626 string initpath = lyxrc.document_path;
1628 if (view()->available()) {
1629 string const trypath = owner->buffer()->filePath();
1630 // If directory is writeable, use this as default.
1631 if (IsDirWriteable(trypath))
1637 if (fname.empty()) {
1638 FileDialog fileDlg(owner, _("Select document to open"),
1640 make_pair(string(_("Documents|#o#O")),
1641 string(lyxrc.document_path)),
1642 make_pair(string(_("Examples|#E#e")),
1643 string(AddPath(system_lyxdir, "examples"))));
1645 FileDialog::Result result =
1646 fileDlg.Select(initpath,
1647 "*.lyx|LyX Documents (*.lyx)");
1649 if (result.first == FileDialog::Later)
1652 filename = result.second;
1654 // check selected filename
1655 if (filename.empty()) {
1656 owner->message(_("Canceled."));
1662 // get absolute path of file and add ".lyx" to the filename if
1664 string const fullpath = FileSearch(string(), filename, "lyx");
1665 if (!fullpath.empty()) {
1666 filename = fullpath;
1669 string const disp_fn(MakeDisplayPath(filename));
1671 // if the file doesn't exist, let the user create one
1672 FileInfo const f(filename, true);
1674 if (!Alert::askQuestion(_("No such file"), disp_fn,
1675 _("Start a new document with this filename ?"))) {
1676 owner->message(_("Canceled"));
1679 // the user specifically chose this name. Believe them.
1680 Buffer * buffer = bufferlist.newFile(filename, "", true);
1681 view()->buffer(buffer);
1686 str << _("Opening document") << ' ' << disp_fn << "...";
1688 owner->message(str.str().c_str());
1690 Buffer * openbuf = bufferlist.loadLyXFile(filename);
1692 view()->buffer(openbuf);
1694 str << _("Document") << ' ' << disp_fn << ' ' << _("opened.");
1695 owner->message(str.str().c_str());
1698 str << _("Could not open document") << ' ' << disp_fn;
1699 owner->message(str.str().c_str());
1704 void LyXFunc::doImport(string const & argument)
1707 string filename = split(argument, format, ' ');
1709 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1710 << " file: " << filename << endl;
1712 // need user interaction
1713 if (filename.empty()) {
1714 string initpath = lyxrc.document_path;
1716 if (view()->available()) {
1717 string const trypath = owner->buffer()->filePath();
1718 // If directory is writeable, use this as default.
1719 if (IsDirWriteable(trypath))
1723 string const text = _("Select ") + formats.prettyName(format)
1724 + _(" file to import");
1726 FileDialog fileDlg(owner, text,
1728 make_pair(string(_("Documents|#o#O")),
1729 string(lyxrc.document_path)),
1730 make_pair(string(_("Examples|#E#e")),
1731 string(AddPath(system_lyxdir, "examples"))));
1733 string const extension = "*." + formats.extension(format)
1734 + "| " + formats.prettyName(format)
1735 + " (*." + formats.extension(format) + ")";
1737 FileDialog::Result result = fileDlg.Select(initpath,
1740 if (result.first == FileDialog::Later)
1743 filename = result.second;
1745 // check selected filename
1746 if (filename.empty())
1747 owner->message(_("Canceled."));
1750 if (filename.empty())
1753 // get absolute path of file
1754 filename = MakeAbsPath(filename);
1756 string const lyxfile = ChangeExtension(filename, ".lyx");
1758 // Check if the document already is open
1759 if (lyxrc.use_gui && bufferlist.exists(lyxfile)) {
1760 switch (Alert::askConfirmation(_("Document is already open:"),
1761 MakeDisplayPath(lyxfile, 50),
1762 _("Do you want to close that document now?\n"
1763 "('No' will just switch to the open version)")))
1766 // If close is canceled, we cancel here too.
1767 if (!bufferlist.close(bufferlist.getBuffer(lyxfile)))
1771 view()->buffer(bufferlist.getBuffer(lyxfile));
1774 owner->message(_("Canceled."));
1779 // if the file exists already, and we didn't do
1780 // -i lyx thefile.lyx, warn
1781 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1782 if (!Alert::askQuestion(_("A document by the name"),
1783 MakeDisplayPath(lyxfile), _("already exists. Overwrite?"))) {
1784 owner->message(_("Canceled"));
1789 Importer::Import(owner, filename, format);
1793 void LyXFunc::reloadBuffer()
1795 string const fn = owner->buffer()->fileName();
1796 if (bufferlist.close(owner->buffer()))
1797 view()->buffer(bufferlist.loadLyXFile(fn));
1801 void LyXFunc::closeBuffer()
1803 if (bufferlist.close(owner->buffer()) && !quitting) {
1804 if (bufferlist.empty()) {
1805 // need this otherwise SEGV may occur while trying to
1806 // set variables that don't exist
1807 // since there's no current buffer
1808 owner->getDialogs().hideBufferDependent();
1810 view()->buffer(bufferlist.first());
1816 // Each "owner" should have it's own message method. lyxview and
1817 // the minibuffer would use the minibuffer, but lyxserver would
1818 // send an ERROR signal to its client. Alejandro 970603
1819 // This func is bit problematic when it comes to NLS, to make the
1820 // lyx servers client be language indepenent we must not translate
1821 // strings sent to this func.
1822 void LyXFunc::setErrorMessage(string const & m) const
1824 dispatch_buffer = m;
1829 void LyXFunc::setMessage(string const & m) const
1831 dispatch_buffer = m;
1835 void LyXFunc::setStatusMessage(string const & m) const
1841 string const LyXFunc::view_status_message()
1843 // When meta-fake key is pressed, show the key sequence so far + "M-".
1845 return keyseq.print() + "M-";
1848 // Else, when a non-complete key sequence is pressed,
1849 // show the available options.
1850 if (keyseq.length() > 0 && !keyseq.deleted()) {
1851 return keyseq.printOptions();
1854 if (!view()->available())
1855 return _("Welcome to LyX!");
1857 return currentState(view());
1861 BufferView * LyXFunc::view() const
1864 return owner->view().get();