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;
115 extern void show_symbols_form(LyXFunc *);
117 extern LyXAction lyxaction;
119 extern tex_accent_struct get_accent(kb_action action);
121 extern void ShowLatexLog();
124 /* === globals =========================================================== */
127 LyXFunc::LyXFunc(LyXView * o)
129 keyseq(toplevel_keymap.get(), toplevel_keymap.get()),
130 cancel_meta_seq(toplevel_keymap.get(), toplevel_keymap.get())
132 meta_fake_bit = key_modifier::none;
133 lyx_dead_action = LFUN_NOACTION;
134 lyx_calling_dead_action = LFUN_NOACTION;
139 LyXText * LyXFunc::TEXT(bool flag = true) const
142 return owner->view()->text;
143 return owner->view()->getLyXText();
148 void LyXFunc::moveCursorUpdate(bool flag, bool selecting)
150 if (selecting || TEXT(flag)->selection.mark()) {
151 TEXT(flag)->setSelection(owner->view().get());
152 if (TEXT(flag)->bv_owner)
153 owner->view()->toggleToggle();
155 owner->view()->update(TEXT(flag), BufferView::SELECT|BufferView::FITCUR);
156 owner->view()->showCursor();
158 owner->view()->switchKeyMap();
162 void LyXFunc::handleKeyFunc(kb_action action)
164 char c = keyseq.getLastKeyEncoded();
166 if (keyseq.length() > 1) {
170 owner->getIntl()->getTransManager()
171 .deadkey(c, get_accent(action).accent, TEXT(false));
172 // Need to clear, in case the minibuffer calls these
175 // copied verbatim from do_accent_char
176 owner->view()->update(TEXT(false),
177 BufferView::SELECT|BufferView::FITCUR|BufferView::CHANGE);
178 TEXT(false)->selection.cursor = TEXT(false)->cursor;
182 void LyXFunc::processKeySym(LyXKeySymPtr keysym,
183 key_modifier::state state)
187 if (lyxerr.debugging(Debug::KEY)) {
188 lyxerr << "KeySym is "
189 << keysym->getSymbolName()
192 // Do nothing if we have nothing (JMarc)
193 if ( ! keysym->isOK() ) {
194 lyxerr[Debug::KEY] << "Empty kbd action (probably composing)"
199 if (keysym->isModifier()) {
203 // Do a one-deep top-level lookup for
204 // cancel and meta-fake keys. RVDK_PATCH_5
205 cancel_meta_seq.reset();
207 int action = cancel_meta_seq.addkey(keysym, state);
208 if (lyxerr.debugging(Debug::KEY)) {
209 lyxerr << "action first set to [" << action << "]" << endl;
212 // When not cancel or meta-fake, do the normal lookup.
213 // Note how the meta_fake Mod1 bit is OR-ed in and reset afterwards.
214 // Mostly, meta_fake_bit = key_modifier::none. RVDK_PATCH_5.
215 if ((action != LFUN_CANCEL) && (action != LFUN_META_FAKE)) {
216 // remove Caps Lock and Mod2 as a modifiers
217 action = keyseq.addkey(keysym, (state | meta_fake_bit));
218 lyxerr[Debug::KEY] << "action now set to ["
219 << action << "]" << endl;
222 // Dont remove this unless you know what you are doing.
223 meta_fake_bit = key_modifier::none;
225 // can this happen now ?
226 if (action == LFUN_NOACTION) {
227 action = LFUN_PREFIX;
230 if (lyxerr.debugging(Debug::KEY)) {
231 lyxerr << "Key [action="
233 << keyseq.print() << "]"
237 // already here we know if it any point in going further
238 // why not return already here if action == -1 and
239 // num_bytes == 0? (Lgb)
241 if (keyseq.length() > 1) {
242 owner->message(keyseq.print());
245 if (action == LFUN_UNKNOWN_ACTION) {
246 // It is unknown, but what if we remove all
247 // the modifiers? (Lgb)
248 action = keyseq.addkey(keysym, key_modifier::none);
250 lyxerr[Debug::KEY] << "Removing modifiers...\n"
251 << "Action now set to ["
252 << action << "]" << endl;
254 if (action == LFUN_UNKNOWN_ACTION) {
255 owner->message(_("Unknown function."));
260 if (action == LFUN_SELFINSERT) {
261 char c = keysym->getISOEncoded();
267 dispatch(LFUN_SELFINSERT, argument);
268 lyxerr[Debug::KEY] << "SelfInsert arg[`"
269 << argument << "']" << endl;
276 FuncStatus LyXFunc::getStatus(int ac) const
280 action = lyxaction.retrieveActionArg(ac, argument);
281 return getStatus(action, argument);
285 FuncStatus LyXFunc::getStatus(kb_action action,
286 string const & argument) const
289 Buffer * buf = owner->buffer();
291 if (action == LFUN_NOACTION) {
292 setStatusMessage(N_("Nothing to do"));
293 return flag.disabled(true);
296 if (action == LFUN_UNKNOWN_ACTION) {
297 setStatusMessage(N_("Unknown action"));
298 return flag.unknown(true);
301 // the default error message if we disable the command
302 setStatusMessage(N_("Command disabled"));
304 // Check whether we need a buffer
305 if (!lyxaction.funcHasFlag(action, LyXAction::NoBuffer)) {
306 // Yes we need a buffer, do we have one?
309 // Can we use a readonly buffer?
310 if (buf->isReadonly() &&
311 !lyxaction.funcHasFlag(action,
312 LyXAction::ReadOnly)) {
314 setStatusMessage(N_("Document is read-only"));
319 setStatusMessage(N_("Command not allowed with"
320 "out any document open"));
321 return flag.disabled(true);
325 UpdatableInset * tli = owner->view()->theLockingInset();
327 // I would really like to avoid having this switch and rather try to
328 // encode this in the function itself.
329 bool disable = false;
332 disable = !Exporter::IsExportable(buf, "dvi")
333 || lyxrc.print_command == "none";
336 disable = argument == "fax" &&
337 !Exporter::IsExportable(buf, argument);
340 disable = buf->undostack.empty();
343 disable = buf->redostack.empty();
345 #ifndef HAVE_LIBAIKSAURUS
346 case LFUN_THESAURUS_ENTRY:
351 disable = lyxrc.chktex_command == "none";
354 disable = !Exporter::IsExportable(buf, "program");
357 case LFUN_LAYOUT_CHARACTER:
358 disable = tli && tli->lyxCode() == Inset::ERT_CODE;
361 case LFUN_LAYOUT_TABULAR:
363 || (tli->lyxCode() != Inset::TABULAR_CODE
364 && !tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
368 case LFUN_LAYOUT_PARAGRAPH: {
369 Inset * inset = TEXT(false)->cursor.par()->inInset();
370 disable = inset && inset->forceDefaultParagraphs(inset);
374 case LFUN_TABULAR_FEATURE:
378 //ret.disabled(true);
379 if (tli->lyxCode() == Inset::TABULAR_CODE) {
380 ret = static_cast<InsetTabular *>(tli)
381 ->getStatus(argument);
382 } else if (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE)) {
383 ret = static_cast<InsetTabular *>
384 (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE))
385 ->getStatus(argument);
390 static InsetTabular inset(*owner->buffer(), 1, 1);
394 ret = inset.getStatus(argument);
395 if (ret.onoff(true) || ret.onoff(false))
396 flag.setOnOff(false);
400 case LFUN_VC_REGISTER:
401 disable = buf->lyxvc.inUse();
403 case LFUN_VC_CHECKIN:
404 disable = !buf->lyxvc.inUse() || buf->isReadonly();
406 case LFUN_VC_CHECKOUT:
407 disable = !buf->lyxvc.inUse() || !buf->isReadonly();
411 case LFUN_VC_HISTORY:
412 disable = !buf->lyxvc.inUse();
414 case LFUN_BOOKMARK_GOTO:
415 disable = !owner->view()->
416 isSavedPosition(strToUnsignedInt(argument));
418 case LFUN_INSET_TOGGLE: {
419 LyXText * lt = owner->view()->getLyXText();
420 disable = !(isEditableInset(lt->getInset())
422 && lt->inset_owner->owner()
423 && lt->inset_owner->owner()->isOpen()));
427 disable = !IsFileReadable(buf->getLogName().second);
429 case LFUN_MATH_VALIGN:
430 if (mathcursor && mathcursor->formula()->hullType() != "simple") {
431 char align = mathcursor->valign();
436 if (argument.empty()) {
440 if (!contains("tcb", argument[0])) {
444 flag.setOnOff(argument[0] == align);
449 case LFUN_MATH_HALIGN:
450 if (mathcursor && mathcursor->formula()->hullType() != "simple") {
451 char align = mathcursor->halign();
456 if (argument.empty()) {
460 if (!contains("lcr", argument[0])) {
464 flag.setOnOff(argument[0] == align);
469 case LFUN_MATH_MUTATE:
470 if (tli && (tli->lyxCode() == Inset::MATH_CODE))
471 flag.setOnOff(mathcursor->formula()->hullType() == argument);
476 // we just need to be in math mode to enable that
478 case LFUN_MATH_SPACE:
479 case LFUN_MATH_LIMITS:
480 case LFUN_MATH_NONUMBER:
481 case LFUN_MATH_NUMBER:
482 disable = !mathcursor;
485 // we need to be math mode and a math array for that
486 // Hack: halign produces non-zero result iff we are in a math array
487 case LFUN_MATH_ROW_INSERT:
488 case LFUN_MATH_ROW_DELETE:
489 case LFUN_MATH_COLUMN_INSERT:
490 case LFUN_MATH_COLUMN_DELETE:
491 disable = !mathcursor || !mathcursor->halign() ||
492 mathcursor->formula()->hullType() == "simple";
499 // the functions which insert insets
500 Inset::Code code = Inset::NO_CODE;
503 code = Inset::ERT_CODE;
505 case LFUN_INSET_GRAPHICS:
506 code = Inset::GRAPHICS_CODE;
508 case LFUN_INSET_FOOTNOTE:
509 code = Inset::FOOT_CODE;
511 case LFUN_TABULAR_INSERT:
512 code = Inset::TABULAR_CODE;
514 case LFUN_INSET_EXTERNAL:
515 code = Inset::EXTERNAL_CODE;
517 case LFUN_INSET_MARGINAL:
518 code = Inset::MARGIN_CODE;
520 case LFUN_INSET_MINIPAGE:
521 code = Inset::MINIPAGE_CODE;
523 case LFUN_INSET_FLOAT:
524 case LFUN_INSET_WIDE_FLOAT:
525 code = Inset::FLOAT_CODE;
527 case LFUN_FLOAT_LIST:
528 code = Inset::FLOAT_LIST_CODE;
531 case LFUN_INSET_LIST:
532 code = Inset::LIST_CODE;
534 case LFUN_INSET_THEOREM:
535 code = Inset::THEOREM_CODE;
538 case LFUN_INSET_CAPTION:
539 code = Inset::CAPTION_CODE;
541 case LFUN_INSERT_NOTE:
542 code = Inset::NOTE_CODE;
544 case LFUN_INSERT_LABEL:
545 code = Inset::LABEL_CODE;
547 case LFUN_REF_INSERT:
548 code = Inset::REF_CODE;
550 case LFUN_CITATION_CREATE:
551 case LFUN_CITATION_INSERT:
552 code = Inset::CITE_CODE;
554 case LFUN_INSERT_BIBTEX:
555 code = Inset::BIBTEX_CODE;
557 case LFUN_INDEX_INSERT:
558 code = Inset::INDEX_CODE;
560 case LFUN_INDEX_PRINT:
561 code = Inset::INDEX_PRINT_CODE;
563 case LFUN_CHILD_INSERT:
564 code = Inset::INCLUDE_CODE;
566 case LFUN_TOC_INSERT:
567 code = Inset::TOC_CODE;
569 case LFUN_PARENTINSERT:
570 code = Inset::PARENT_CODE;
574 case LFUN_INSERT_URL:
575 code = Inset::URL_CODE;
578 // always allow this, since we will inset a raw quote
579 // if an inset is not allowed.
581 case LFUN_HYPHENATION:
582 case LFUN_LIGATURE_BREAK:
584 case LFUN_MENU_SEPARATOR:
586 case LFUN_END_OF_SENTENCE:
587 code = Inset::SPECIALCHAR_CODE;
589 case LFUN_PROTECTEDSPACE:
590 // slight hack: we know this is allowed in math mode
592 code = Inset::SPECIALCHAR_CODE;
597 if (code != Inset::NO_CODE && tli && !tli->insetAllowed(code)) {
604 // A few general toggles
606 case LFUN_TOOLTIPS_TOGGLE:
607 flag.setOnOff(owner->getDialogs()->tooltipsEnabled());
610 case LFUN_READ_ONLY_TOGGLE:
611 flag.setOnOff(buf->isReadonly());
614 flag.setOnOff(TEXT(false)->cursor.par()->params().startOfAppendix());
616 case LFUN_SWITCHBUFFER:
617 // toggle on the current buffer, but do not toggle off
618 // the other ones (is that a good idea?)
619 if (argument == buf->fileName())
626 // the font related toggles
628 LyXFont const & font = TEXT(false)->real_current_font;
631 flag.setOnOff(font.emph() == LyXFont::ON);
634 flag.setOnOff(font.noun() == LyXFont::ON);
637 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
640 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
643 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
646 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
652 string tc = mathcursor->getLastCode();
655 flag.setOnOff(tc == "mathbf");
658 flag.setOnOff(tc == "mathsf");
661 flag.setOnOff(tc == "mathcal");
664 flag.setOnOff(tc == "mathrm");
667 flag.setOnOff(tc == "mathtt");
670 flag.setOnOff(tc == "mathbb");
673 flag.setOnOff(tc == "mathnormal");
680 // this one is difficult to get right. As a half-baked
681 // solution, we consider only the first action of the sequence
682 if (action == LFUN_SEQUENCE) {
683 // argument contains ';'-terminated commands
684 const int ac = lyxaction.LookupFunc(token(argument, ';', 0));
685 flag = getStatus(ac);
692 void LyXFunc::dispatch(string const & s, bool verbose)
694 int const action = lyxaction.LookupFunc(s);
696 if (action == LFUN_UNKNOWN_ACTION) {
697 string const msg = string(_("Unknown function ("))
703 dispatch(action, verbose);
707 void LyXFunc::dispatch(int ac, bool verbose)
710 kb_action const action = lyxaction.retrieveActionArg(ac, argument);
711 dispatch(action, argument, verbose);
716 void LyXFunc::dispatch(kb_action action, string argument, bool verbose)
718 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: action[" << action
719 <<"] arg[" << argument << "]" << endl;
721 // we have not done anything wrong yet.
723 dispatch_buffer.erase();
725 #ifdef NEW_DISPATCHER
726 // We try do call the most specific dispatcher first:
727 // 1. the lockinginset's dispatch
728 // 2. the bufferview's dispatch
729 // 3. the lyxview's dispatch
732 selection_possible = false;
734 if (owner->view()->available())
735 owner->view()->hideCursor();
737 // We cannot use this function here
738 if (getStatus(action, argument).disabled()) {
739 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
740 << lyxaction.getActionName(action)
741 << " [" << action << "] is disabled at this location"
743 setErrorMessage(getStatusMessage());
744 goto exit_with_message;
747 if (owner->view()->available() && owner->view()->theLockingInset()) {
748 UpdatableInset::RESULT result;
749 if ((action > 1) || ((action == LFUN_UNKNOWN_ACTION) &&
750 (!keyseq.deleted())))
752 UpdatableInset * inset = owner->view()->theLockingInset();
756 inset->getCursorPos(owner->view().get(), inset_x, dummy_y);
758 if ((action == LFUN_UNKNOWN_ACTION)
759 && argument.empty()) {
760 argument = keyseq.getLastKeyEncoded();
762 // Undo/Redo is a bit tricky for insets.
763 if (action == LFUN_UNDO) {
764 owner->view()->menuUndo();
765 goto exit_with_message;
766 } else if (action == LFUN_REDO) {
767 owner->view()->menuRedo();
768 goto exit_with_message;
769 } else if (((result=inset->
770 // Hand-over to inset's own dispatch:
771 localDispatch(owner->view().get(), action, argument)) ==
772 UpdatableInset::DISPATCHED) ||
773 (result == UpdatableInset::DISPATCHED_NOUPDATE))
774 goto exit_with_message;
775 // If UNDISPATCHED, just soldier on
776 else if (result == UpdatableInset::FINISHED) {
777 goto exit_with_message;
778 // We do not need special RTL handling here:
779 // FINISHED means that the cursor should be
780 // one position after the inset.
781 } else if (result == UpdatableInset::FINISHED_RIGHT) {
782 TEXT()->cursorRight(owner->view().get());
783 moveCursorUpdate(true, false);
784 owner->view_state_changed();
785 goto exit_with_message;
786 } else if (result == UpdatableInset::FINISHED_UP) {
787 if (TEXT()->cursor.irow()->previous()) {
789 TEXT()->setCursorFromCoordinates(
790 owner->view().get(), TEXT()->cursor.ix() + inset_x,
791 TEXT()->cursor.iy() -
792 TEXT()->cursor.irow()->baseline() - 1);
793 TEXT()->cursor.x_fix(TEXT()->cursor.x());
795 TEXT()->cursorUp(owner->view().get());
797 moveCursorUpdate(true, false);
798 owner->view_state_changed();
800 owner->view()->update(TEXT(), BufferView::SELECT|BufferView::FITCUR);
802 goto exit_with_message;
803 } else if (result == UpdatableInset::FINISHED_DOWN) {
804 if (TEXT()->cursor.irow()->next()) {
806 TEXT()->setCursorFromCoordinates(
807 owner->view().get(), TEXT()->cursor.ix() + inset_x,
808 TEXT()->cursor.iy() -
809 TEXT()->cursor.irow()->baseline() +
810 TEXT()->cursor.irow()->height() + 1);
811 TEXT()->cursor.x_fix(TEXT()->cursor.x());
813 TEXT()->cursorDown(owner->view().get());
816 TEXT()->cursorRight(owner->view().get());
818 moveCursorUpdate(true, false);
819 owner->view_state_changed();
820 goto exit_with_message;
822 #warning I am not sure this is still right, please have a look! (Jug 20020417)
823 else { // result == UNDISPATCHED
824 //setMessage(N_("Text mode"));
826 case LFUN_UNKNOWN_ACTION:
827 case LFUN_BREAKPARAGRAPH:
829 TEXT()->cursorRight(owner->view().get());
830 owner->view()->switchKeyMap();
831 owner->view_state_changed();
834 if (!TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
835 TEXT()->cursorRight(owner->view().get());
836 moveCursorUpdate(true, false);
837 owner->view_state_changed();
839 goto exit_with_message;
841 if (TEXT()->cursor.par()->isRightToLeftPar(owner->buffer()->params)) {
842 TEXT()->cursorRight(owner->view().get());
843 moveCursorUpdate(true, false);
844 owner->view_state_changed();
846 goto exit_with_message;
848 if (TEXT()->cursor.row()->next())
849 TEXT()->cursorDown(owner->view().get());
851 TEXT()->cursorRight(owner->view().get());
852 moveCursorUpdate(true, false);
853 owner->view_state_changed();
854 goto exit_with_message;
866 if (!owner->view()->available()) break;
867 // this function should be used always [asierra060396]
868 UpdatableInset * tli =
869 owner->view()->theLockingInset();
871 UpdatableInset * lock = tli->getLockingInset();
874 owner->view()->unlockInset(tli);
875 TEXT()->cursorRight(owner->view().get());
876 moveCursorUpdate(true, false);
877 owner->view_state_changed();
879 tli->unlockInsetInInset(owner->view().get(),
884 // Tell the paragraph dialog that we changed paragraph
885 owner->getDialogs()->updateParagraph();
890 // --- Misc -------------------------------------------
891 case LFUN_WORDFINDFORWARD :
892 case LFUN_WORDFINDBACKWARD : {
893 static string last_search;
894 string searched_string;
896 if (!argument.empty()) {
897 last_search = argument;
898 searched_string = argument;
900 searched_string = last_search;
902 bool fw = (action == LFUN_WORDFINDBACKWARD);
903 if (!searched_string.empty()) {
904 lyxfind::LyXFind(owner->view().get(), searched_string, fw);
906 // owner->view()->showCursor();
912 if (owner->view()->available() && !owner->view()->theLockingInset()) {
913 owner->view()->update(TEXT(),
914 BufferView::SELECT|BufferView::FITCUR);
916 owner->message(keyseq.printOptions());
920 // --- Misc -------------------------------------------
921 case LFUN_EXEC_COMMAND:
922 owner->focus_command_buffer();
925 case LFUN_CANCEL: // RVDK_PATCH_5
927 meta_fake_bit = key_modifier::none;
928 if (owner->view()->available())
929 // cancel any selection
930 dispatch(LFUN_MARK_OFF);
931 setMessage(N_("Cancel"));
934 case LFUN_META_FAKE: // RVDK_PATCH_5
936 meta_fake_bit = key_modifier::alt;
937 setMessage(keyseq.print());
941 case LFUN_READ_ONLY_TOGGLE:
942 if (owner->buffer()->lyxvc.inUse()) {
943 owner->buffer()->lyxvc.toggleReadOnly();
945 owner->buffer()->setReadonly(
946 !owner->buffer()->isReadonly());
950 case LFUN_CENTER: // this is center and redraw.
951 owner->view()->center();
954 // --- Menus -----------------------------------------------
956 menuNew(argument, false);
959 case LFUN_MENUNEWTMPLT:
960 menuNew(argument, true);
963 case LFUN_CLOSEBUFFER:
968 if (!owner->buffer()->isUnnamed()) {
970 s1 << _("Saving document") << ' '
971 << MakeDisplayPath(owner->buffer()->fileName() + "...");
972 owner->message(s1.str().c_str());
973 MenuWrite(owner->view().get(), owner->buffer());
975 owner->message(s1.str().c_str());
977 WriteAs(owner->view().get(), owner->buffer());
981 WriteAs(owner->view().get(), owner->buffer(), argument);
984 case LFUN_MENURELOAD:
989 Exporter::Export(owner->buffer(), argument, true);
993 Exporter::Preview(owner->buffer(), argument);
997 Exporter::Export(owner->buffer(), "program", true);
1000 case LFUN_RUNCHKTEX:
1001 MenuRunChktex(owner->buffer());
1004 case LFUN_MENUPRINT:
1005 owner->getDialogs()->showPrint();
1009 if (argument == "custom")
1010 owner->getDialogs()->showSendto();
1012 Exporter::Export(owner->buffer(), argument, false);
1030 InsetCommandParams p;
1033 if (action == LFUN_TOCVIEW)
1035 p.setCmdName("tableofcontents");
1037 else if (action == LFUN_LOAVIEW)
1038 p.setCmdName("listof{algorithm}{List of Algorithms}");
1039 else if (action == LFUN_LOFVIEW)
1040 p.setCmdName("listoffigures");
1042 p.setCmdName("listoftables");
1044 owner->getDialogs()->createTOC(p.getAsString());
1049 AutoSave(owner->view().get());
1053 owner->view()->menuUndo();
1057 owner->view()->menuRedo();
1060 case LFUN_MENUSEARCH:
1061 owner->getDialogs()->showSearch();
1064 case LFUN_REMOVEERRORS:
1065 if (owner->view()->removeAutoInsets()) {
1066 #warning repaint() or update() or nothing ?
1067 owner->view()->repaint();
1068 owner->view()->fitCursor();
1072 case LFUN_DEPTH_MIN:
1073 changeDepth(owner->view().get(), TEXT(false), -1);
1076 case LFUN_DEPTH_PLUS:
1077 changeDepth(owner->view().get(), TEXT(false), 1);
1081 owner->getDialogs()->setUserFreeFont();
1084 case LFUN_RECONFIGURE:
1085 Reconfigure(owner->view().get());
1089 case LFUN_FLOATSOPERATE:
1090 if (argument == "openfoot")
1091 owner->view()->allFloats(1,0);
1092 else if (argument == "closefoot")
1093 owner->view()->allFloats(0,0);
1094 else if (argument == "openfig")
1095 owner->view()->allFloats(1,1);
1096 else if (argument == "closefig")
1097 owner->view()->allFloats(0,1);
1100 #ifdef WITH_WARNINGS
1101 //#warning Find another implementation here (or another lyxfunc)!
1104 case LFUN_HELP_ABOUTLYX:
1105 owner->getDialogs()->showAboutlyx();
1108 case LFUN_HELP_TEXINFO:
1109 owner->getDialogs()->showTexinfo();
1112 case LFUN_HELP_OPEN:
1114 string const arg = argument;
1116 setErrorMessage(N_("Missing argument"));
1119 owner->prohibitInput();
1120 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1121 if (fname.empty()) {
1122 lyxerr << "LyX: unable to find documentation file `"
1123 << arg << "'. Bad installation?" << endl;
1124 owner->allowInput();
1128 str << _("Opening help file") << ' '
1129 << MakeDisplayPath(fname) << "...";
1130 owner->message(str.str().c_str());
1131 owner->view()->buffer(bufferlist.loadLyXFile(fname, false));
1132 owner->allowInput();
1136 // --- version control -------------------------------
1137 case LFUN_VC_REGISTER:
1139 if (!owner->buffer()->lyxvc.inUse())
1140 owner->buffer()->lyxvc.registrer();
1144 case LFUN_VC_CHECKIN:
1146 if (owner->buffer()->lyxvc.inUse()
1147 && !owner->buffer()->isReadonly())
1148 owner->buffer()->lyxvc.checkIn();
1152 case LFUN_VC_CHECKOUT:
1154 if (owner->buffer()->lyxvc.inUse()
1155 && owner->buffer()->isReadonly())
1156 owner->buffer()->lyxvc.checkOut();
1160 case LFUN_VC_REVERT:
1162 owner->buffer()->lyxvc.revert();
1168 owner->buffer()->lyxvc.undoLast();
1172 case LFUN_VC_HISTORY:
1174 owner->getDialogs()->showVCLogFile();
1178 // --- buffers ----------------------------------------
1180 case LFUN_SWITCHBUFFER:
1181 owner->view()->buffer(bufferlist.getBuffer(argument));
1186 // servercmd: argument must be <file>:<template>
1187 Buffer * tmpbuf = NewFile(argument);
1189 owner->view()->buffer(tmpbuf);
1193 case LFUN_FILE_OPEN:
1197 case LFUN_LATEX_LOG:
1198 owner->getDialogs()->showLogFile();
1201 case LFUN_LAYOUT_DOCUMENT:
1202 owner->getDialogs()->showDocument();
1205 case LFUN_LAYOUT_PARAGRAPH:
1206 owner->getDialogs()->showParagraph();
1209 case LFUN_LAYOUT_CHARACTER:
1210 owner->getDialogs()->showCharacter();
1213 case LFUN_LAYOUT_TABULAR:
1214 if (owner->view()->theLockingInset()) {
1215 if (owner->view()->theLockingInset()->lyxCode()==Inset::TABULAR_CODE) {
1216 InsetTabular * inset = static_cast<InsetTabular *>
1217 (owner->view()->theLockingInset());
1218 inset->openLayoutDialog(owner->view().get());
1219 } else if (owner->view()->theLockingInset()->
1220 getFirstLockingInsetOfType(Inset::TABULAR_CODE)!=0) {
1221 InsetTabular * inset = static_cast<InsetTabular *>(
1222 owner->view()->theLockingInset()->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
1223 inset->openLayoutDialog(owner->view().get());
1228 case LFUN_LAYOUT_PREAMBLE:
1229 owner->getDialogs()->showPreamble();
1232 case LFUN_DROP_LAYOUTS_CHOICE:
1233 owner->getToolbar()->openLayoutList();
1236 case LFUN_MENU_OPEN_BY_NAME:
1237 owner->getMenubar()->openByName(argument);
1238 break; // RVDK_PATCH_5
1240 case LFUN_SPELLCHECK:
1241 owner->getDialogs()->showSpellchecker();
1244 // --- lyxserver commands ----------------------------
1248 setMessage(owner->buffer()->fileName());
1249 lyxerr[Debug::INFO] << "FNAME["
1250 << owner->buffer()->fileName()
1256 dispatch_buffer = keyseq.print();
1257 lyxserver->notifyClient(dispatch_buffer);
1261 case LFUN_GOTOFILEROW:
1265 istringstream istr(argument.c_str());
1266 istr >> file_name >> row;
1267 // Must replace extension of the file to be .lyx and get full path
1268 string const s(ChangeExtension(file_name, ".lyx"));
1270 // Either change buffer or load the file
1271 if (bufferlist.exists(s)) {
1272 owner->view()->buffer(bufferlist.getBuffer(s));
1274 owner->view()->buffer(bufferlist.loadLyXFile(s));
1277 owner->view()->setCursorFromRow(row);
1279 owner->view()->center();
1280 // see BufferView_pimpl::center()
1281 owner->view()->updateScrollbar();
1285 case LFUN_GOTO_PARAGRAPH:
1287 istringstream istr(argument.c_str());
1291 Paragraph * par = owner->buffer()->getParFromID(id);
1293 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1294 << id << "]" << endl;
1297 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1298 << " found." << endl;
1301 if (owner->view()->theLockingInset())
1302 owner->view()->unlockInset(owner->view()->theLockingInset());
1303 if (par->inInset()) {
1304 par->inInset()->edit(owner->view().get());
1307 owner->view()->getLyXText()->setCursor(owner->view().get(), par, 0);
1308 owner->view()->switchKeyMap();
1309 owner->view_state_changed();
1311 owner->view()->center();
1312 // see BufferView_pimpl::center()
1313 owner->view()->updateScrollbar();
1320 int const qa = lyxaction.LookupFunc(argument);
1321 setMessage(lyxaction.helpText(static_cast<kb_action>(qa)));
1325 // --- insert characters ----------------------------------------
1327 // --- Mathed stuff. If we are here, there is no locked inset yet.
1328 case LFUN_MATH_EXTERN:
1329 case LFUN_MATH_NUMBER:
1330 case LFUN_MATH_NONUMBER:
1331 case LFUN_MATH_LIMITS:
1333 setErrorMessage(N_("This is only allowed in math mode!"));
1337 // passthrough hat and underscore outside mathed:
1338 case LFUN_SUBSCRIPT:
1339 dispatch(LFUN_SELFINSERT, "_", false);
1341 case LFUN_SUPERSCRIPT:
1342 dispatch(LFUN_SELFINSERT, "^", false);
1345 case LFUN_MATH_PANEL:
1346 owner->getDialogs()->showMathPanel();
1349 case LFUN_CITATION_CREATE:
1351 InsetCommandParams p("cite");
1353 if (!argument.empty()) {
1354 // This should be set at source, ie when typing
1355 // "citation-insert foo" in the minibuffer.
1356 // Question: would pybibliographer also need to be
1357 // changed. Suspect so. Leave as-is therefore.
1358 if (contains(argument, "|")) {
1359 p.setContents(token(argument, '|', 0));
1360 p.setOptions( token(argument, '|', 1));
1362 p.setContents(argument);
1364 dispatch(LFUN_CITATION_INSERT, p.getAsString());
1366 owner->getDialogs()->createCitation(p.getAsString());
1370 case LFUN_CHILDOPEN:
1372 string const filename =
1373 MakeAbsPath(argument,
1374 owner->buffer()->filePath());
1375 setMessage(N_("Opening child document ") +
1376 MakeDisplayPath(filename) + "...");
1377 owner->view()->savePosition(0);
1378 if (bufferlist.exists(filename))
1379 owner->view()->buffer(bufferlist.getBuffer(filename));
1381 owner->view()->buffer(bufferlist.loadLyXFile(filename));
1385 case LFUN_TOGGLECURSORFOLLOW:
1386 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1389 case LFUN_KMAP_OFF: // keymap off
1390 owner->getIntl()->KeyMapOn(false);
1393 case LFUN_KMAP_PRIM: // primary keymap
1394 owner->getIntl()->KeyMapPrim();
1397 case LFUN_KMAP_SEC: // secondary keymap
1398 owner->getIntl()->KeyMapSec();
1401 case LFUN_KMAP_TOGGLE: // toggle keymap
1402 owner->getIntl()->ToggleKeyMap();
1407 // argument contains ';'-terminated commands
1408 while (!argument.empty()) {
1410 argument = split(argument, first, ';');
1416 case LFUN_DIALOG_PREFERENCES:
1417 owner->getDialogs()->showPreferences();
1420 case LFUN_SAVEPREFERENCES:
1422 Path p(user_lyxdir);
1423 lyxrc.write("preferences");
1427 case LFUN_SCREEN_FONT_UPDATE:
1429 // handle the screen font changes.
1431 lyxrc.set_font_norm_type();
1432 lyx_gui::update_fonts();
1433 // Of course we should only do the resize and the textcache.clear
1434 // if values really changed...but not very important right now. (Lgb)
1435 // All visible buffers will need resize
1436 owner->view()->resize();
1437 owner->view()->repaint();
1438 // We also need to empty the textcache so that
1439 // the buffer will be formatted correctly after
1445 case LFUN_SET_COLOR:
1448 string const x11_name = split(argument, lyx_name, ' ');
1449 if (lyx_name.empty() || x11_name.empty()) {
1450 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1455 bool const graphicsbg_changed =
1456 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1457 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1459 if (!lcolor.setColor(lyx_name, x11_name)) {
1460 static string const err1 (N_("Set-color \""));
1461 static string const err2 (
1462 N_("\" failed - color is undefined "
1463 "or may not be redefined"));
1464 setErrorMessage(_(err1) + lyx_name + _(err2));
1468 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1470 if (graphicsbg_changed) {
1471 #ifdef WITH_WARNINGS
1472 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1475 grfx::GCache & gc = grfx::GCache::get();
1476 gc.changeDisplay(true);
1480 owner->view()->repaint();
1485 owner->message(argument);
1488 case LFUN_FORKS_SHOW:
1489 owner->getDialogs()->showForks();
1492 case LFUN_FORKS_KILL:
1494 if (!isStrInt(argument))
1497 pid_t const pid = strToInt(argument);
1498 ForkedcallsController & fcc = ForkedcallsController::get();
1503 case LFUN_TOOLTIPS_TOGGLE:
1504 owner->getDialogs()->toggleTooltips();
1508 // Then if it was none of the above
1509 // Trying the BufferView::pimpl dispatch:
1510 if (!owner->view()->dispatch(action, argument))
1511 lyxerr << "A truly unknown func ["
1512 << lyxaction.getActionName(action) << "]!"
1518 string const & msg = getMessage();
1519 sendDispatchMessage(msg, action, argument, verbose);
1523 void LyXFunc::sendDispatchMessage(string const & msg, kb_action action, string const & arg, bool verbose)
1525 owner->updateMenubar();
1526 owner->updateToolbar();
1528 if (action == LFUN_SELFINSERT || !verbose) {
1529 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1531 owner->message(msg);
1535 string dispatch_msg(msg);
1536 if (!dispatch_msg.empty())
1537 dispatch_msg += " ";
1539 string comname = lyxaction.getActionName(action);
1541 int pseudoaction = action;
1542 bool argsadded = false;
1545 // the pseudoaction is useful for the bindings
1546 pseudoaction = lyxaction.searchActionArg(action, arg);
1548 if (pseudoaction == LFUN_UNKNOWN_ACTION) {
1549 pseudoaction = action;
1551 comname += " " + arg;
1556 string const shortcuts = toplevel_keymap->findbinding(pseudoaction);
1558 if (!shortcuts.empty()) {
1559 comname += ": " + shortcuts;
1560 } else if (!argsadded && !arg.empty()) {
1561 comname += " " + arg;
1564 if (!comname.empty()) {
1565 comname = rtrim(comname);
1566 dispatch_msg += "(" + comname + ')';
1569 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1570 if (!dispatch_msg.empty())
1571 owner->message(dispatch_msg);
1575 void LyXFunc::setupLocalKeymap()
1577 keyseq.stdmap = keyseq.curmap = toplevel_keymap.get();
1578 cancel_meta_seq.stdmap = cancel_meta_seq.curmap = toplevel_keymap.get();
1582 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1584 string initpath = lyxrc.document_path;
1585 string filename(name);
1587 if (owner->view()->available()) {
1588 string const trypath = owner->buffer()->filePath();
1589 // If directory is writeable, use this as default.
1590 if (IsDirWriteable(trypath))
1594 static int newfile_number;
1596 if (filename.empty()) {
1597 filename = AddName(lyxrc.document_path,
1598 "newfile" + tostr(++newfile_number) + ".lyx");
1599 FileInfo fi(filename);
1600 while (bufferlist.exists(filename) || fi.readable()) {
1602 filename = AddName(lyxrc.document_path,
1603 "newfile" + tostr(newfile_number) +
1605 fi.newFile(filename);
1609 // The template stuff
1612 FileDialog fileDlg(owner, _("Select template file"),
1613 LFUN_SELECT_FILE_SYNC,
1614 make_pair(string(_("Documents|#o#O")),
1615 string(lyxrc.document_path)),
1616 make_pair(string(_("Templates|#T#t")),
1617 string(lyxrc.template_path)));
1619 FileDialog::Result result =
1620 fileDlg.Select(lyxrc.template_path,
1621 _("*.lyx|LyX Documents (*.lyx)"));
1623 if (result.first == FileDialog::Later)
1626 string const fname = result.second;
1633 owner->view()->buffer(bufferlist.newFile(filename, templname, !name.empty()));
1637 void LyXFunc::open(string const & fname)
1639 string initpath = lyxrc.document_path;
1641 if (owner->view()->available()) {
1642 string const trypath = owner->buffer()->filePath();
1643 // If directory is writeable, use this as default.
1644 if (IsDirWriteable(trypath))
1650 if (fname.empty()) {
1651 FileDialog fileDlg(owner, _("Select document to open"),
1653 make_pair(string(_("Documents|#o#O")),
1654 string(lyxrc.document_path)),
1655 make_pair(string(_("Examples|#E#e")),
1656 string(AddPath(system_lyxdir, "examples"))));
1658 FileDialog::Result result =
1659 fileDlg.Select(initpath,
1660 "*.lyx|LyX Documents (*.lyx)");
1662 if (result.first == FileDialog::Later)
1665 filename = result.second;
1667 // check selected filename
1668 if (filename.empty()) {
1669 owner->message(_("Canceled."));
1675 // get absolute path of file and add ".lyx" to the filename if
1677 string const fullpath = FileSearch(string(), filename, "lyx");
1678 if (!fullpath.empty()) {
1679 filename = fullpath;
1682 string const disp_fn(MakeDisplayPath(filename));
1684 // if the file doesn't exist, let the user create one
1685 FileInfo const f(filename, true);
1687 if (!Alert::askQuestion(_("No such file"), disp_fn,
1688 _("Start a new document with this filename ?"))) {
1689 owner->message(_("Canceled"));
1692 // the user specifically chose this name. Believe them.
1693 Buffer * buffer = bufferlist.newFile(filename, "", true);
1694 owner->view()->buffer(buffer);
1699 str << _("Opening document") << ' ' << disp_fn << "...";
1701 owner->message(str.str().c_str());
1703 Buffer * openbuf = bufferlist.loadLyXFile(filename);
1705 owner->view()->buffer(openbuf);
1707 str << _("Document") << ' ' << disp_fn << ' ' << _("opened.");
1708 owner->message(str.str().c_str());
1711 str << _("Could not open document") << ' ' << disp_fn;
1712 owner->message(str.str().c_str());
1717 void LyXFunc::doImport(string const & argument)
1720 string filename = split(argument, format, ' ');
1722 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1723 << " file: " << filename << endl;
1725 // need user interaction
1726 if (filename.empty()) {
1727 string initpath = lyxrc.document_path;
1729 if (owner->view()->available()) {
1730 string const trypath = owner->buffer()->filePath();
1731 // If directory is writeable, use this as default.
1732 if (IsDirWriteable(trypath))
1736 string const text = _("Select ") + formats.prettyName(format)
1737 + _(" file to import");
1739 FileDialog fileDlg(owner, text,
1741 make_pair(string(_("Documents|#o#O")),
1742 string(lyxrc.document_path)),
1743 make_pair(string(_("Examples|#E#e")),
1744 string(AddPath(system_lyxdir, "examples"))));
1746 string const extension = "*." + formats.extension(format)
1747 + "| " + formats.prettyName(format)
1748 + " (*." + formats.extension(format) + ")";
1750 FileDialog::Result result = fileDlg.Select(initpath,
1753 if (result.first == FileDialog::Later)
1756 filename = result.second;
1758 // check selected filename
1759 if (filename.empty())
1760 owner->message(_("Canceled."));
1763 if (filename.empty())
1766 // get absolute path of file
1767 filename = MakeAbsPath(filename);
1769 string const lyxfile = ChangeExtension(filename, ".lyx");
1771 // Check if the document already is open
1772 if (lyxrc.use_gui && bufferlist.exists(lyxfile)) {
1773 switch (Alert::askConfirmation(_("Document is already open:"),
1774 MakeDisplayPath(lyxfile, 50),
1775 _("Do you want to close that document now?\n"
1776 "('No' will just switch to the open version)")))
1779 // If close is canceled, we cancel here too.
1780 if (!bufferlist.close(bufferlist.getBuffer(lyxfile)))
1784 owner->view()->buffer(bufferlist.getBuffer(lyxfile));
1787 owner->message(_("Canceled."));
1792 // if the file exists already, and we didn't do
1793 // -i lyx thefile.lyx, warn
1794 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1795 if (!Alert::askQuestion(_("A document by the name"),
1796 MakeDisplayPath(lyxfile), _("already exists. Overwrite?"))) {
1797 owner->message(_("Canceled"));
1802 Importer::Import(owner, filename, format);
1806 void LyXFunc::reloadBuffer()
1808 string const fn = owner->buffer()->fileName();
1809 if (bufferlist.close(owner->buffer()))
1810 owner->view()->buffer(bufferlist.loadLyXFile(fn));
1814 void LyXFunc::closeBuffer()
1816 if (bufferlist.close(owner->buffer()) && !quitting) {
1817 if (bufferlist.empty()) {
1818 // need this otherwise SEGV may occur while trying to
1819 // set variables that don't exist
1820 // since there's no current buffer
1821 owner->getDialogs()->hideBufferDependent();
1823 owner->view()->buffer(bufferlist.first());
1829 // Each "owner" should have it's own message method. lyxview and
1830 // the minibuffer would use the minibuffer, but lyxserver would
1831 // send an ERROR signal to its client. Alejandro 970603
1832 // This func is bit problematic when it comes to NLS, to make the
1833 // lyx servers client be language indepenent we must not translate
1834 // strings sent to this func.
1835 void LyXFunc::setErrorMessage(string const & m) const
1837 dispatch_buffer = m;
1842 void LyXFunc::setMessage(string const & m) const
1844 dispatch_buffer = m;
1848 void LyXFunc::setStatusMessage(string const & m) const
1854 string const LyXFunc::view_status_message()
1856 // When meta-fake key is pressed, show the key sequence so far + "M-".
1858 return keyseq.print() + "M-";
1861 // Else, when a non-complete key sequence is pressed,
1862 // show the available options.
1863 if (keyseq.length() > 0 && !keyseq.deleted()) {
1864 return keyseq.printOptions();
1867 if (!owner->view()->available())
1868 return _("Welcome to LyX!");
1870 return currentState(owner->view().get());