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 if (lyxerr.debugging(Debug::KEY)) {
219 lyxerr << "action now set to ["
220 << action << "]" << endl;
223 // Dont remove this unless you know what you are doing.
224 meta_fake_bit = key_modifier::none;
226 // can this happen now ?
227 if (action == LFUN_NOACTION) {
228 action = LFUN_PREFIX;
231 if (lyxerr.debugging(Debug::KEY)) {
232 lyxerr << "Key [action="
234 << keyseq.print() << "]"
238 // already here we know if it any point in going further
239 // why not return already here if action == -1 and
240 // num_bytes == 0? (Lgb)
242 if (keyseq.length() > 1) {
243 owner->message(keyseq.print());
246 if (action == LFUN_UNKNOWN_ACTION) {
247 // It is unknown, but what if we remove all
248 // the modifiers? (Lgb)
249 action = keyseq.addkey(keysym, key_modifier::none);
251 if (lyxerr.debugging(Debug::KEY)) {
252 lyxerr << "Removing modifiers...\n"
253 << "Action now set to ["
254 << action << "]" << endl;
256 if (action == LFUN_UNKNOWN_ACTION) {
257 owner->message(_("Unknown function."));
262 if (action == LFUN_SELFINSERT) {
263 // This is very X dependent.
264 char c = keysym->getISOEncoded();
270 dispatch(LFUN_SELFINSERT, argument);
271 lyxerr[Debug::KEY] << "SelfInsert arg[`"
272 << argument << "']" << endl;
279 FuncStatus LyXFunc::getStatus(int ac) const
283 action = lyxaction.retrieveActionArg(ac, argument);
284 return getStatus(action, argument);
288 FuncStatus LyXFunc::getStatus(kb_action action,
289 string const & argument) const
292 Buffer * buf = owner->buffer();
294 if (action == LFUN_NOACTION) {
295 setStatusMessage(N_("Nothing to do"));
296 return flag.disabled(true);
299 if (action == LFUN_UNKNOWN_ACTION) {
300 setStatusMessage(N_("Unknown action"));
301 return flag.unknown(true);
304 // the default error message if we disable the command
305 setStatusMessage(N_("Command disabled"));
307 // Check whether we need a buffer
308 if (!lyxaction.funcHasFlag(action, LyXAction::NoBuffer)) {
309 // Yes we need a buffer, do we have one?
312 // Can we use a readonly buffer?
313 if (buf->isReadonly() &&
314 !lyxaction.funcHasFlag(action,
315 LyXAction::ReadOnly)) {
317 setStatusMessage(N_("Document is read-only"));
322 setStatusMessage(N_("Command not allowed with"
323 "out any document open"));
324 return flag.disabled(true);
328 UpdatableInset * tli = owner->view()->theLockingInset();
330 // I would really like to avoid having this switch and rather try to
331 // encode this in the function itself.
332 bool disable = false;
335 disable = !Exporter::IsExportable(buf, "dvi")
336 || lyxrc.print_command == "none";
339 disable = argument == "fax" &&
340 !Exporter::IsExportable(buf, argument);
343 disable = buf->undostack.empty();
346 disable = buf->redostack.empty();
348 case LFUN_SPELLCHECK:
349 disable = lyxrc.isp_command == "none";
351 #ifndef HAVE_LIBAIKSAURUS
352 case LFUN_THESAURUS_ENTRY:
357 disable = lyxrc.chktex_command == "none";
360 disable = !Exporter::IsExportable(buf, "program");
363 case LFUN_LAYOUT_CHARACTER:
364 disable = tli && tli->lyxCode() == Inset::ERT_CODE;
367 case LFUN_LAYOUT_TABULAR:
369 || (tli->lyxCode() != Inset::TABULAR_CODE
370 && !tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
374 case LFUN_LAYOUT_PARAGRAPH: {
375 Inset * inset = TEXT(false)->cursor.par()->inInset();
376 disable = inset && inset->forceDefaultParagraphs(inset);
380 case LFUN_TABULAR_FEATURE:
384 //ret.disabled(true);
385 if (tli->lyxCode() == Inset::TABULAR_CODE) {
386 ret = static_cast<InsetTabular *>(tli)
387 ->getStatus(argument);
388 } else if (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE)) {
389 ret = static_cast<InsetTabular *>
390 (tli->getFirstLockingInsetOfType(Inset::TABULAR_CODE))
391 ->getStatus(argument);
396 static InsetTabular inset(*owner->buffer(), 1, 1);
400 ret = inset.getStatus(argument);
401 if (ret.onoff(true) || ret.onoff(false))
402 flag.setOnOff(false);
406 case LFUN_VC_REGISTER:
407 disable = buf->lyxvc.inUse();
409 case LFUN_VC_CHECKIN:
410 disable = !buf->lyxvc.inUse() || buf->isReadonly();
412 case LFUN_VC_CHECKOUT:
413 disable = !buf->lyxvc.inUse() || !buf->isReadonly();
417 case LFUN_VC_HISTORY:
418 disable = !buf->lyxvc.inUse();
420 case LFUN_BOOKMARK_GOTO:
421 disable = !owner->view()->
422 isSavedPosition(strToUnsignedInt(argument));
424 case LFUN_INSET_TOGGLE: {
425 LyXText * lt = owner->view()->getLyXText();
426 disable = !(isEditableInset(lt->getInset())
428 && lt->inset_owner->owner()
429 && lt->inset_owner->owner()->isOpen()));
433 disable = !IsFileReadable(buf->getLogName().second);
435 case LFUN_MATH_VALIGN:
436 if (mathcursor && mathcursor->formula()->hullType() != "simple") {
437 char align = mathcursor->valign();
442 if (argument.empty()) {
446 if (!contains("tcb", argument[0])) {
450 flag.setOnOff(argument[0] == align);
455 case LFUN_MATH_HALIGN:
456 if (mathcursor && mathcursor->formula()->hullType() != "simple") {
457 char align = mathcursor->halign();
462 if (argument.empty()) {
466 if (!contains("lcr", argument[0])) {
470 flag.setOnOff(argument[0] == align);
475 case LFUN_MATH_MUTATE:
476 if (tli && (tli->lyxCode() == Inset::MATH_CODE))
477 flag.setOnOff(mathcursor->formula()->hullType() == argument);
482 // we just need to be in math mode to enable that
484 case LFUN_MATH_SPACE:
485 case LFUN_MATH_LIMITS:
486 case LFUN_MATH_NONUMBER:
487 case LFUN_MATH_NUMBER:
488 disable = !mathcursor;
491 // we need to be math mode and a math array for that
492 // Hack: halign produces non-zero result iff we are in a math array
493 case LFUN_MATH_ROW_INSERT:
494 case LFUN_MATH_ROW_DELETE:
495 case LFUN_MATH_COLUMN_INSERT:
496 case LFUN_MATH_COLUMN_DELETE:
497 disable = !mathcursor || !mathcursor->halign() ||
498 mathcursor->formula()->hullType() == "simple";
505 // the functions which insert insets
506 Inset::Code code = Inset::NO_CODE;
509 code = Inset::ERT_CODE;
511 case LFUN_INSET_GRAPHICS:
512 code = Inset::GRAPHICS_CODE;
514 case LFUN_INSET_FOOTNOTE:
515 code = Inset::FOOT_CODE;
517 case LFUN_DIALOG_TABULAR_INSERT:
518 case LFUN_INSET_TABULAR:
519 code = Inset::TABULAR_CODE;
521 case LFUN_INSET_EXTERNAL:
522 code = Inset::EXTERNAL_CODE;
524 case LFUN_INSET_MARGINAL:
525 code = Inset::MARGIN_CODE;
527 case LFUN_INSET_MINIPAGE:
528 code = Inset::MINIPAGE_CODE;
530 case LFUN_INSET_FLOAT:
531 case LFUN_INSET_WIDE_FLOAT:
532 code = Inset::FLOAT_CODE;
534 case LFUN_FLOAT_LIST:
535 code = Inset::FLOAT_LIST_CODE;
538 case LFUN_INSET_LIST:
539 code = Inset::LIST_CODE;
541 case LFUN_INSET_THEOREM:
542 code = Inset::THEOREM_CODE;
545 case LFUN_INSET_CAPTION:
546 code = Inset::CAPTION_CODE;
548 case LFUN_INSERT_NOTE:
549 code = Inset::IGNORE_CODE;
551 case LFUN_INSERT_LABEL:
552 code = Inset::LABEL_CODE;
554 case LFUN_REF_INSERT:
555 code = Inset::REF_CODE;
557 case LFUN_CITATION_CREATE:
558 case LFUN_CITATION_INSERT:
559 code = Inset::CITE_CODE;
561 case LFUN_INSERT_BIBTEX:
562 code = Inset::BIBTEX_CODE;
564 case LFUN_INDEX_INSERT:
565 code = Inset::INDEX_CODE;
567 case LFUN_INDEX_PRINT:
568 code = Inset::INDEX_PRINT_CODE;
570 case LFUN_CHILD_INSERT:
571 code = Inset::INCLUDE_CODE;
573 case LFUN_TOC_INSERT:
574 code = Inset::TOC_CODE;
576 case LFUN_PARENTINSERT:
577 code = Inset::PARENT_CODE;
581 case LFUN_INSERT_URL:
582 code = Inset::URL_CODE;
585 // always allow this, since we will inset a raw quote
586 // if an inset is not allowed.
588 case LFUN_HYPHENATION:
589 case LFUN_LIGATURE_BREAK:
591 case LFUN_MENU_SEPARATOR:
593 case LFUN_END_OF_SENTENCE:
594 code = Inset::SPECIALCHAR_CODE;
596 case LFUN_PROTECTEDSPACE:
597 // slight hack: we know this is allowed in math mode
599 code = Inset::SPECIALCHAR_CODE;
604 if (code != Inset::NO_CODE && tli && !tli->insetAllowed(code)) {
611 // A few general toggles
613 case LFUN_TOOLTIPS_TOGGLE:
614 flag.setOnOff(owner->getDialogs()->tooltipsEnabled());
617 case LFUN_READ_ONLY_TOGGLE:
618 flag.setOnOff(buf->isReadonly());
621 flag.setOnOff(TEXT(false)->cursor.par()->params().startOfAppendix());
623 case LFUN_SWITCHBUFFER:
624 // toggle on the current buffer, but do not toggle off
625 // the other ones (is that a good idea?)
626 if (argument == buf->fileName())
633 // the font related toggles
635 LyXFont const & font = TEXT(false)->real_current_font;
638 flag.setOnOff(font.emph() == LyXFont::ON);
641 flag.setOnOff(font.noun() == LyXFont::ON);
644 flag.setOnOff(font.series() == LyXFont::BOLD_SERIES);
647 flag.setOnOff(font.family() == LyXFont::SANS_FAMILY);
650 flag.setOnOff(font.family() == LyXFont::ROMAN_FAMILY);
653 flag.setOnOff(font.family() == LyXFont::TYPEWRITER_FAMILY);
659 string tc = mathcursor->getLastCode();
662 flag.setOnOff(tc == "mathbf");
665 flag.setOnOff(tc == "mathsf");
668 flag.setOnOff(tc == "mathcal");
671 flag.setOnOff(tc == "mathrm");
674 flag.setOnOff(tc == "mathtt");
677 flag.setOnOff(tc == "mathbb");
680 flag.setOnOff(tc == "mathnormal");
687 // this one is difficult to get right. As a half-baked
688 // solution, we consider only the first action of the sequence
689 if (action == LFUN_SEQUENCE) {
690 // argument contains ';'-terminated commands
691 const int ac = lyxaction.LookupFunc(token(argument, ';', 0));
692 flag = getStatus(ac);
699 void LyXFunc::dispatch(string const & s, bool verbose)
701 int const action = lyxaction.LookupFunc(s);
703 if (action == LFUN_UNKNOWN_ACTION) {
704 string const msg = string(_("Unknown function ("))
710 dispatch(action, verbose);
714 void LyXFunc::dispatch(int ac, bool verbose)
717 kb_action const action = lyxaction.retrieveActionArg(ac, argument);
718 dispatch(action, argument, verbose);
723 void LyXFunc::dispatch(kb_action action, string argument, bool verbose)
725 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: action[" << action
726 <<"] arg[" << argument << "]" << endl;
728 // we have not done anything wrong yet.
730 dispatch_buffer.erase();
732 #ifdef NEW_DISPATCHER
733 // We try do call the most specific dispatcher first:
734 // 1. the lockinginset's dispatch
735 // 2. the bufferview's dispatch
736 // 3. the lyxview's dispatch
739 selection_possible = false;
741 if (owner->view()->available())
742 owner->view()->hideCursor();
744 // We cannot use this function here
745 if (getStatus(action, argument).disabled()) {
746 lyxerr[Debug::ACTION] << "LyXFunc::dispatch: "
747 << lyxaction.getActionName(action)
748 << " [" << action << "] is disabled at this location"
750 setErrorMessage(getStatusMessage());
751 goto exit_with_message;
754 if (owner->view()->available() && owner->view()->theLockingInset()) {
755 UpdatableInset::RESULT result;
756 if ((action > 1) || ((action == LFUN_UNKNOWN_ACTION) &&
757 (!keyseq.deleted())))
759 UpdatableInset * inset = owner->view()->theLockingInset();
763 inset->getCursorPos(owner->view().get(), inset_x, dummy_y);
765 if ((action == LFUN_UNKNOWN_ACTION)
766 && argument.empty()) {
767 argument = keyseq.getLastKeyEncoded();
769 // Undo/Redo is a bit tricky for insets.
770 if (action == LFUN_UNDO) {
771 owner->view()->menuUndo();
772 goto exit_with_message;
773 } else if (action == LFUN_REDO) {
774 owner->view()->menuRedo();
775 goto exit_with_message;
776 } else if (((result=inset->
777 // Hand-over to inset's own dispatch:
778 localDispatch(owner->view().get(), action, argument)) ==
779 UpdatableInset::DISPATCHED) ||
780 (result == UpdatableInset::DISPATCHED_NOUPDATE))
781 goto exit_with_message;
782 // If UNDISPATCHED, just soldier on
783 else if (result == UpdatableInset::FINISHED) {
784 goto exit_with_message;
785 // We do not need special RTL handling here:
786 // FINISHED means that the cursor should be
787 // one position after the inset.
788 } else if (result == UpdatableInset::FINISHED_RIGHT) {
789 TEXT()->cursorRight(owner->view().get());
790 moveCursorUpdate(true, false);
791 owner->view_state_changed();
792 goto exit_with_message;
793 } else if (result == UpdatableInset::FINISHED_UP) {
794 if (TEXT()->cursor.irow()->previous()) {
796 TEXT()->setCursorFromCoordinates(
797 owner->view().get(), TEXT()->cursor.ix() + inset_x,
798 TEXT()->cursor.iy() -
799 TEXT()->cursor.irow()->baseline() - 1);
800 TEXT()->cursor.x_fix(TEXT()->cursor.x());
802 TEXT()->cursorUp(owner->view().get());
804 moveCursorUpdate(true, false);
805 owner->view_state_changed();
807 owner->view()->update(TEXT(), BufferView::SELECT|BufferView::FITCUR);
809 goto exit_with_message;
810 } else if (result == UpdatableInset::FINISHED_DOWN) {
811 if (TEXT()->cursor.irow()->next()) {
813 TEXT()->setCursorFromCoordinates(
814 owner->view().get(), TEXT()->cursor.ix() + inset_x,
815 TEXT()->cursor.iy() -
816 TEXT()->cursor.irow()->baseline() +
817 TEXT()->cursor.irow()->height() + 1);
818 TEXT()->cursor.x_fix(TEXT()->cursor.x());
820 TEXT()->cursorDown(owner->view().get());
823 TEXT()->cursorRight(owner->view().get());
825 moveCursorUpdate(true, false);
826 owner->view_state_changed();
827 goto exit_with_message;
829 #warning I am not sure this is still right, please have a look! (Jug 20020417)
830 else { // result == UNDISPATCHED
831 //setMessage(N_("Text mode"));
833 case LFUN_UNKNOWN_ACTION:
834 case LFUN_BREAKPARAGRAPH:
836 TEXT()->cursorRight(owner->view().get());
837 owner->view()->switchKeyMap();
838 owner->view_state_changed();
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.par()->isRightToLeftPar(owner->buffer()->params)) {
849 TEXT()->cursorRight(owner->view().get());
850 moveCursorUpdate(true, false);
851 owner->view_state_changed();
853 goto exit_with_message;
855 if (TEXT()->cursor.row()->next())
856 TEXT()->cursorDown(owner->view().get());
858 TEXT()->cursorRight(owner->view().get());
859 moveCursorUpdate(true, false);
860 owner->view_state_changed();
861 goto exit_with_message;
873 if (!owner->view()->available()) break;
874 // this function should be used always [asierra060396]
875 UpdatableInset * tli =
876 owner->view()->theLockingInset();
878 UpdatableInset * lock = tli->getLockingInset();
881 owner->view()->unlockInset(tli);
882 TEXT()->cursorRight(owner->view().get());
883 moveCursorUpdate(true, false);
884 owner->view_state_changed();
886 tli->unlockInsetInInset(owner->view().get(),
891 // Tell the paragraph dialog that we changed paragraph
892 owner->getDialogs()->updateParagraph();
897 // --- Misc -------------------------------------------
898 case LFUN_WORDFINDFORWARD :
899 case LFUN_WORDFINDBACKWARD : {
900 static string last_search;
901 string searched_string;
903 if (!argument.empty()) {
904 last_search = argument;
905 searched_string = argument;
907 searched_string = last_search;
909 bool fw = (action == LFUN_WORDFINDBACKWARD);
910 if (!searched_string.empty()) {
911 lyxfind::LyXFind(owner->view().get(), searched_string, fw);
913 // owner->view()->showCursor();
919 if (owner->view()->available() && !owner->view()->theLockingInset()) {
920 owner->view()->update(TEXT(),
921 BufferView::SELECT|BufferView::FITCUR);
923 owner->message(keyseq.printOptions());
927 // --- Misc -------------------------------------------
928 case LFUN_EXEC_COMMAND:
929 owner->focus_command_buffer();
932 case LFUN_CANCEL: // RVDK_PATCH_5
934 meta_fake_bit = key_modifier::none;
935 if (owner->view()->available())
936 // cancel any selection
937 dispatch(LFUN_MARK_OFF);
938 setMessage(N_("Cancel"));
941 case LFUN_META_FAKE: // RVDK_PATCH_5
943 meta_fake_bit = key_modifier::alt;
944 setMessage(keyseq.print());
948 case LFUN_READ_ONLY_TOGGLE:
949 if (owner->buffer()->lyxvc.inUse()) {
950 owner->buffer()->lyxvc.toggleReadOnly();
952 owner->buffer()->setReadonly(
953 !owner->buffer()->isReadonly());
957 case LFUN_CENTER: // this is center and redraw.
958 owner->view()->center();
961 // --- Menus -----------------------------------------------
963 menuNew(argument, false);
966 case LFUN_MENUNEWTMPLT:
967 menuNew(argument, true);
970 case LFUN_CLOSEBUFFER:
975 if (!owner->buffer()->isUnnamed()) {
977 s1 << _("Saving document") << ' '
978 << MakeDisplayPath(owner->buffer()->fileName() + "...");
979 owner->message(s1.str().c_str());
980 MenuWrite(owner->view().get(), owner->buffer());
982 owner->message(s1.str().c_str());
984 WriteAs(owner->view().get(), owner->buffer());
988 WriteAs(owner->view().get(), owner->buffer(), argument);
991 case LFUN_MENURELOAD:
996 Exporter::Export(owner->buffer(), argument, true);
1000 Exporter::Preview(owner->buffer(), argument);
1003 case LFUN_BUILDPROG:
1004 Exporter::Export(owner->buffer(), "program", true);
1007 case LFUN_RUNCHKTEX:
1008 MenuRunChktex(owner->buffer());
1011 case LFUN_MENUPRINT:
1012 owner->getDialogs()->showPrint();
1016 if (argument == "custom")
1017 owner->getDialogs()->showSendto();
1019 Exporter::Export(owner->buffer(), argument, false);
1037 InsetCommandParams p;
1040 if (action == LFUN_TOCVIEW)
1042 p.setCmdName("tableofcontents");
1044 else if (action == LFUN_LOAVIEW)
1045 p.setCmdName("listof{algorithm}{List of Algorithms}");
1046 else if (action == LFUN_LOFVIEW)
1047 p.setCmdName("listoffigures");
1049 p.setCmdName("listoftables");
1051 owner->getDialogs()->createTOC(p.getAsString());
1055 case LFUN_DIALOG_TABULAR_INSERT:
1056 owner->getDialogs()->showTabularCreate();
1060 AutoSave(owner->view().get());
1064 owner->view()->menuUndo();
1068 owner->view()->menuRedo();
1071 case LFUN_MENUSEARCH:
1072 owner->getDialogs()->showSearch();
1075 case LFUN_REMOVEERRORS:
1076 if (owner->view()->removeAutoInsets()) {
1077 #warning repaint() or update() or nothing ?
1078 owner->view()->repaint();
1079 owner->view()->fitCursor();
1083 case LFUN_DEPTH_MIN:
1084 changeDepth(owner->view().get(), TEXT(false), -1);
1087 case LFUN_DEPTH_PLUS:
1088 changeDepth(owner->view().get(), TEXT(false), 1);
1092 owner->getDialogs()->setUserFreeFont();
1095 case LFUN_RECONFIGURE:
1096 Reconfigure(owner->view().get());
1100 case LFUN_FLOATSOPERATE:
1101 if (argument == "openfoot")
1102 owner->view()->allFloats(1,0);
1103 else if (argument == "closefoot")
1104 owner->view()->allFloats(0,0);
1105 else if (argument == "openfig")
1106 owner->view()->allFloats(1,1);
1107 else if (argument == "closefig")
1108 owner->view()->allFloats(0,1);
1111 #ifdef WITH_WARNINGS
1112 //#warning Find another implementation here (or another lyxfunc)!
1115 case LFUN_HELP_ABOUTLYX:
1116 owner->getDialogs()->showAboutlyx();
1119 case LFUN_HELP_TEXINFO:
1120 owner->getDialogs()->showTexinfo();
1123 case LFUN_HELP_OPEN:
1125 string const arg = argument;
1127 setErrorMessage(N_("Missing argument"));
1130 owner->prohibitInput();
1131 string const fname = i18nLibFileSearch("doc", arg, "lyx");
1132 if (fname.empty()) {
1133 lyxerr << "LyX: unable to find documentation file `"
1134 << arg << "'. Bad installation?" << endl;
1135 owner->allowInput();
1139 str << _("Opening help file") << ' '
1140 << MakeDisplayPath(fname) << "...";
1141 owner->message(str.str().c_str());
1142 owner->view()->buffer(bufferlist.loadLyXFile(fname, false));
1143 owner->allowInput();
1147 // --- version control -------------------------------
1148 case LFUN_VC_REGISTER:
1150 if (!owner->buffer()->lyxvc.inUse())
1151 owner->buffer()->lyxvc.registrer();
1155 case LFUN_VC_CHECKIN:
1157 if (owner->buffer()->lyxvc.inUse()
1158 && !owner->buffer()->isReadonly())
1159 owner->buffer()->lyxvc.checkIn();
1163 case LFUN_VC_CHECKOUT:
1165 if (owner->buffer()->lyxvc.inUse()
1166 && owner->buffer()->isReadonly())
1167 owner->buffer()->lyxvc.checkOut();
1171 case LFUN_VC_REVERT:
1173 owner->buffer()->lyxvc.revert();
1179 owner->buffer()->lyxvc.undoLast();
1183 case LFUN_VC_HISTORY:
1185 owner->getDialogs()->showVCLogFile();
1189 // --- buffers ----------------------------------------
1191 case LFUN_SWITCHBUFFER:
1192 owner->view()->buffer(bufferlist.getBuffer(argument));
1197 // servercmd: argument must be <file>:<template>
1198 Buffer * tmpbuf = NewLyxFile(argument);
1200 owner->view()->buffer(tmpbuf);
1204 case LFUN_FILE_OPEN:
1208 case LFUN_LATEX_LOG:
1209 owner->getDialogs()->showLogFile();
1212 case LFUN_LAYOUT_DOCUMENT:
1213 owner->getDialogs()->showDocument();
1216 case LFUN_LAYOUT_PARAGRAPH:
1217 owner->getDialogs()->showParagraph();
1220 case LFUN_LAYOUT_CHARACTER:
1221 owner->getDialogs()->showCharacter();
1224 case LFUN_LAYOUT_TABULAR:
1225 if (owner->view()->theLockingInset()) {
1226 if (owner->view()->theLockingInset()->lyxCode()==Inset::TABULAR_CODE) {
1227 InsetTabular * inset = static_cast<InsetTabular *>
1228 (owner->view()->theLockingInset());
1229 inset->openLayoutDialog(owner->view().get());
1230 } else if (owner->view()->theLockingInset()->
1231 getFirstLockingInsetOfType(Inset::TABULAR_CODE)!=0) {
1232 InsetTabular * inset = static_cast<InsetTabular *>(
1233 owner->view()->theLockingInset()->getFirstLockingInsetOfType(Inset::TABULAR_CODE));
1234 inset->openLayoutDialog(owner->view().get());
1239 case LFUN_LAYOUT_PREAMBLE:
1240 owner->getDialogs()->showPreamble();
1243 case LFUN_DROP_LAYOUTS_CHOICE:
1244 owner->getToolbar()->openLayoutList();
1247 case LFUN_MENU_OPEN_BY_NAME:
1248 owner->getMenubar()->openByName(argument);
1249 break; // RVDK_PATCH_5
1251 case LFUN_SPELLCHECK:
1252 if (lyxrc.isp_command != "none")
1253 owner->getDialogs()->showSpellchecker();
1256 // --- lyxserver commands ----------------------------
1260 setMessage(owner->buffer()->fileName());
1261 lyxerr[Debug::INFO] << "FNAME["
1262 << owner->buffer()->fileName()
1268 dispatch_buffer = keyseq.print();
1269 lyxserver->notifyClient(dispatch_buffer);
1273 case LFUN_GOTOFILEROW:
1277 istringstream istr(argument.c_str());
1278 istr >> file_name >> row;
1279 // Must replace extension of the file to be .lyx and get full path
1280 string const s(ChangeExtension(file_name, ".lyx"));
1282 // Either change buffer or load the file
1283 if (bufferlist.exists(s)) {
1284 owner->view()->buffer(bufferlist.getBuffer(s));
1286 owner->view()->buffer(bufferlist.loadLyXFile(s));
1289 owner->view()->setCursorFromRow(row);
1291 owner->view()->center();
1292 // see BufferView_pimpl::center()
1293 owner->view()->updateScrollbar();
1297 case LFUN_GOTO_PARAGRAPH:
1299 istringstream istr(argument.c_str());
1303 Paragraph * par = owner->buffer()->getParFromID(id);
1305 lyxerr[Debug::INFO] << "No matching paragraph found! ["
1306 << id << "]" << endl;
1309 lyxerr[Debug::INFO] << "Paragraph " << par->id()
1310 << " found." << endl;
1313 if (owner->view()->theLockingInset())
1314 owner->view()->unlockInset(owner->view()->theLockingInset());
1315 if (par->inInset()) {
1316 par->inInset()->edit(owner->view().get());
1319 owner->view()->getLyXText()->setCursor(owner->view().get(), par, 0);
1320 owner->view()->switchKeyMap();
1321 owner->view_state_changed();
1323 owner->view()->center();
1324 // see BufferView_pimpl::center()
1325 owner->view()->updateScrollbar();
1332 int const qa = lyxaction.LookupFunc(argument);
1333 setMessage(lyxaction.helpText(static_cast<kb_action>(qa)));
1337 // --- insert characters ----------------------------------------
1339 // --- Mathed stuff. If we are here, there is no locked inset yet.
1340 case LFUN_MATH_EXTERN:
1341 case LFUN_MATH_NUMBER:
1342 case LFUN_MATH_NONUMBER:
1343 case LFUN_MATH_LIMITS:
1345 setErrorMessage(N_("This is only allowed in math mode!"));
1349 // passthrough hat and underscore outside mathed:
1350 case LFUN_SUBSCRIPT:
1351 dispatch(LFUN_SELFINSERT, "_", false);
1353 case LFUN_SUPERSCRIPT:
1354 dispatch(LFUN_SELFINSERT, "^", false);
1357 case LFUN_MATH_PANEL:
1358 owner->getDialogs()->showMathPanel();
1361 case LFUN_CITATION_CREATE:
1363 InsetCommandParams p("cite");
1365 if (!argument.empty()) {
1366 // This should be set at source, ie when typing
1367 // "citation-insert foo" in the minibuffer.
1368 // Question: would pybibliographer also need to be
1369 // changed. Suspect so. Leave as-is therefore.
1370 if (contains(argument, "|")) {
1371 p.setContents(token(argument, '|', 0));
1372 p.setOptions( token(argument, '|', 1));
1374 p.setContents(argument);
1376 dispatch(LFUN_CITATION_INSERT, p.getAsString());
1378 owner->getDialogs()->createCitation(p.getAsString());
1382 case LFUN_CHILDOPEN:
1384 string const filename =
1385 MakeAbsPath(argument,
1386 owner->buffer()->filePath());
1387 setMessage(N_("Opening child document ") +
1388 MakeDisplayPath(filename) + "...");
1389 owner->view()->savePosition(0);
1390 if (bufferlist.exists(filename))
1391 owner->view()->buffer(bufferlist.getBuffer(filename));
1393 owner->view()->buffer(bufferlist.loadLyXFile(filename));
1397 case LFUN_TOGGLECURSORFOLLOW:
1398 lyxrc.cursor_follows_scrollbar = !lyxrc.cursor_follows_scrollbar;
1401 case LFUN_KMAP_OFF: // keymap off
1402 owner->getIntl()->KeyMapOn(false);
1405 case LFUN_KMAP_PRIM: // primary keymap
1406 owner->getIntl()->KeyMapPrim();
1409 case LFUN_KMAP_SEC: // secondary keymap
1410 owner->getIntl()->KeyMapSec();
1413 case LFUN_KMAP_TOGGLE: // toggle keymap
1414 owner->getIntl()->ToggleKeyMap();
1419 // argument contains ';'-terminated commands
1420 while (!argument.empty()) {
1422 argument = split(argument, first, ';');
1428 case LFUN_DIALOG_PREFERENCES:
1429 owner->getDialogs()->showPreferences();
1432 case LFUN_SAVEPREFERENCES:
1434 Path p(user_lyxdir);
1435 lyxrc.write("preferences");
1439 case LFUN_SCREEN_FONT_UPDATE:
1441 // handle the screen font changes.
1443 lyxrc.set_font_norm_type();
1444 lyx_gui::update_fonts();
1445 // Of course we should only do the resize and the textcache.clear
1446 // if values really changed...but not very important right now. (Lgb)
1447 // All visible buffers will need resize
1448 owner->view()->resize();
1449 owner->view()->repaint();
1450 // We also need to empty the textcache so that
1451 // the buffer will be formatted correctly after
1457 case LFUN_SET_COLOR:
1460 string const x11_name = split(argument, lyx_name, ' ');
1461 if (lyx_name.empty() || x11_name.empty()) {
1462 setErrorMessage(N_("Syntax: set-color <lyx_name>"
1467 bool const graphicsbg_changed =
1468 (lyx_name == lcolor.getLyXName(LColor::graphicsbg) &&
1469 x11_name != lcolor.getX11Name(LColor::graphicsbg));
1471 if (!lcolor.setColor(lyx_name, x11_name)) {
1472 static string const err1 (N_("Set-color \""));
1473 static string const err2 (
1474 N_("\" failed - color is undefined "
1475 "or may not be redefined"));
1476 setErrorMessage(_(err1) + lyx_name + _(err2));
1480 lyx_gui::update_color(lcolor.getFromLyXName(lyx_name));
1482 if (graphicsbg_changed) {
1483 #ifdef WITH_WARNINGS
1484 #warning FIXME!! The graphics cache no longer has a changeDisplay method.
1487 grfx::GCache & gc = grfx::GCache::get();
1488 gc.changeDisplay(true);
1492 owner->view()->repaint();
1497 owner->message(argument);
1500 case LFUN_FORKS_SHOW:
1501 owner->getDialogs()->showForks();
1504 case LFUN_FORKS_KILL:
1506 if (!isStrInt(argument))
1509 pid_t const pid = strToInt(argument);
1510 ForkedcallsController & fcc = ForkedcallsController::get();
1515 case LFUN_TOOLTIPS_TOGGLE:
1516 owner->getDialogs()->toggleTooltips();
1520 // Then if it was none of the above
1521 // Trying the BufferView::pimpl dispatch:
1522 if (!owner->view()->dispatch(action, argument))
1523 lyxerr << "A truly unknown func ["
1524 << lyxaction.getActionName(action) << "]!"
1530 string const & msg = getMessage();
1531 sendDispatchMessage(msg, action, argument, verbose);
1535 void LyXFunc::sendDispatchMessage(string const & msg, kb_action action, string const & arg, bool verbose)
1537 owner->updateMenubar();
1538 owner->updateToolbar();
1540 if (action == LFUN_SELFINSERT || !verbose) {
1541 lyxerr[Debug::ACTION] << "dispatch msg is " << msg << endl;
1543 owner->message(msg);
1547 string dispatch_msg(msg);
1548 if (!dispatch_msg.empty())
1549 dispatch_msg += " ";
1551 string comname = lyxaction.getActionName(action);
1553 int pseudoaction = action;
1554 bool argsadded = false;
1557 // the pseudoaction is useful for the bindings
1558 pseudoaction = lyxaction.searchActionArg(action, arg);
1560 if (pseudoaction == LFUN_UNKNOWN_ACTION) {
1561 pseudoaction = action;
1563 comname += " " + arg;
1568 string const shortcuts = toplevel_keymap->findbinding(pseudoaction);
1570 if (!shortcuts.empty()) {
1571 comname += ": " + shortcuts;
1572 } else if (!argsadded && !arg.empty()) {
1573 comname += " " + arg;
1576 if (!comname.empty()) {
1577 comname = rtrim(comname);
1578 dispatch_msg += "(" + comname + ')';
1581 lyxerr[Debug::ACTION] << "verbose dispatch msg " << dispatch_msg << endl;
1582 if (!dispatch_msg.empty())
1583 owner->message(dispatch_msg);
1587 void LyXFunc::setupLocalKeymap()
1589 keyseq.stdmap = keyseq.curmap = toplevel_keymap.get();
1590 cancel_meta_seq.stdmap = cancel_meta_seq.curmap = toplevel_keymap.get();
1594 void LyXFunc::menuNew(string const & name, bool fromTemplate)
1596 string initpath = lyxrc.document_path;
1597 string filename(name);
1599 if (owner->view()->available()) {
1600 string const trypath = owner->buffer()->filePath();
1601 // If directory is writeable, use this as default.
1602 if (IsDirWriteable(trypath))
1606 static int newfile_number;
1608 if (filename.empty()) {
1609 filename = AddName(lyxrc.document_path,
1610 "newfile" + tostr(++newfile_number) + ".lyx");
1611 FileInfo fi(filename);
1612 while (bufferlist.exists(filename) || fi.readable()) {
1614 filename = AddName(lyxrc.document_path,
1615 "newfile" + tostr(newfile_number) +
1617 fi.newFile(filename);
1621 // The template stuff
1624 FileDialog fileDlg(owner, _("Select template file"),
1625 LFUN_SELECT_FILE_SYNC,
1626 make_pair(string(_("Documents|#o#O")),
1627 string(lyxrc.document_path)),
1628 make_pair(string(_("Templates|#T#t")),
1629 string(lyxrc.template_path)));
1631 FileDialog::Result result =
1632 fileDlg.Select(lyxrc.template_path,
1633 _("*.lyx|LyX Documents (*.lyx)"));
1635 if (result.first == FileDialog::Later)
1638 string const fname = result.second;
1645 owner->view()->buffer(bufferlist.newFile(filename, templname, !name.empty()));
1649 void LyXFunc::open(string const & fname)
1651 string initpath = lyxrc.document_path;
1653 if (owner->view()->available()) {
1654 string const trypath = owner->buffer()->filePath();
1655 // If directory is writeable, use this as default.
1656 if (IsDirWriteable(trypath))
1662 if (fname.empty()) {
1663 FileDialog fileDlg(owner, _("Select document to open"),
1665 make_pair(string(_("Documents|#o#O")),
1666 string(lyxrc.document_path)),
1667 make_pair(string(_("Examples|#E#e")),
1668 string(AddPath(system_lyxdir, "examples"))));
1670 FileDialog::Result result =
1671 fileDlg.Select(initpath,
1672 "*.lyx|LyX Documents (*.lyx)");
1674 if (result.first == FileDialog::Later)
1677 filename = result.second;
1679 // check selected filename
1680 if (filename.empty()) {
1681 owner->message(_("Canceled."));
1687 // get absolute path of file and add ".lyx" to the filename if
1689 string const fullpath = FileSearch(string(), filename, "lyx");
1690 if (!fullpath.empty()) {
1691 filename = fullpath;
1694 string const disp_fn(MakeDisplayPath(filename));
1696 // if the file doesn't exist, let the user create one
1697 FileInfo const f(filename, true);
1699 if (!Alert::askQuestion(_("No such file"), disp_fn,
1700 _("Start a new document with this filename ?"))) {
1701 owner->message(_("Canceled"));
1704 // the user specifically chose this name. Believe them.
1705 Buffer * buffer = bufferlist.newFile(filename, "", true);
1706 owner->view()->buffer(buffer);
1711 str << _("Opening document") << ' ' << disp_fn << "...";
1713 owner->message(str.str().c_str());
1715 Buffer * openbuf = bufferlist.loadLyXFile(filename);
1717 owner->view()->buffer(openbuf);
1719 str << _("Document") << ' ' << disp_fn << ' ' << _("opened.");
1720 owner->message(str.str().c_str());
1723 str << _("Could not open document") << ' ' << disp_fn;
1724 owner->message(str.str().c_str());
1729 void LyXFunc::doImport(string const & argument)
1732 string filename = split(argument, format, ' ');
1734 lyxerr[Debug::INFO] << "LyXFunc::doImport: " << format
1735 << " file: " << filename << endl;
1737 // need user interaction
1738 if (filename.empty()) {
1739 string initpath = lyxrc.document_path;
1741 if (owner->view()->available()) {
1742 string const trypath = owner->buffer()->filePath();
1743 // If directory is writeable, use this as default.
1744 if (IsDirWriteable(trypath))
1748 string const text = _("Select ") + formats.prettyName(format)
1749 + _(" file to import");
1751 FileDialog fileDlg(owner, text,
1753 make_pair(string(_("Documents|#o#O")),
1754 string(lyxrc.document_path)),
1755 make_pair(string(_("Examples|#E#e")),
1756 string(AddPath(system_lyxdir, "examples"))));
1758 string const extension = "*." + formats.extension(format)
1759 + "| " + formats.prettyName(format)
1760 + " (*." + formats.extension(format) + ")";
1762 FileDialog::Result result = fileDlg.Select(initpath,
1765 if (result.first == FileDialog::Later)
1768 filename = result.second;
1770 // check selected filename
1771 if (filename.empty())
1772 owner->message(_("Canceled."));
1775 if (filename.empty())
1778 // get absolute path of file
1779 filename = MakeAbsPath(filename);
1781 string const lyxfile = ChangeExtension(filename, ".lyx");
1783 // Check if the document already is open
1784 if (lyxrc.use_gui && bufferlist.exists(lyxfile)) {
1785 switch (Alert::askConfirmation(_("Document is already open:"),
1786 MakeDisplayPath(lyxfile, 50),
1787 _("Do you want to close that document now?\n"
1788 "('No' will just switch to the open version)")))
1791 // If close is canceled, we cancel here too.
1792 if (!bufferlist.close(bufferlist.getBuffer(lyxfile)))
1796 owner->view()->buffer(bufferlist.getBuffer(lyxfile));
1799 owner->message(_("Canceled."));
1804 // if the file exists already, and we didn't do
1805 // -i lyx thefile.lyx, warn
1806 if (FileInfo(lyxfile, true).exist() && filename != lyxfile) {
1807 if (!Alert::askQuestion(_("A document by the name"),
1808 MakeDisplayPath(lyxfile), _("already exists. Overwrite?"))) {
1809 owner->message(_("Canceled"));
1814 Importer::Import(owner, filename, format);
1818 void LyXFunc::reloadBuffer()
1820 string const fn = owner->buffer()->fileName();
1821 if (bufferlist.close(owner->buffer()))
1822 owner->view()->buffer(bufferlist.loadLyXFile(fn));
1826 void LyXFunc::closeBuffer()
1828 if (bufferlist.close(owner->buffer()) && !quitting) {
1829 if (bufferlist.empty()) {
1830 // need this otherwise SEGV may occur while trying to
1831 // set variables that don't exist
1832 // since there's no current buffer
1833 owner->getDialogs()->hideBufferDependent();
1835 owner->view()->buffer(bufferlist.first());
1841 // Each "owner" should have it's own message method. lyxview and
1842 // the minibuffer would use the minibuffer, but lyxserver would
1843 // send an ERROR signal to its client. Alejandro 970603
1844 // This func is bit problematic when it comes to NLS, to make the
1845 // lyx servers client be language indepenent we must not translate
1846 // strings sent to this func.
1847 void LyXFunc::setErrorMessage(string const & m) const
1849 dispatch_buffer = m;
1854 void LyXFunc::setMessage(string const & m) const
1856 dispatch_buffer = m;
1860 void LyXFunc::setStatusMessage(string const & m) const
1866 string const LyXFunc::view_status_message()
1868 // When meta-fake key is pressed, show the key sequence so far + "M-".
1870 return keyseq.print() + "M-";
1873 // Else, when a non-complete key sequence is pressed,
1874 // show the available options.
1875 if (keyseq.length() > 0 && !keyseq.deleted()) {
1876 return keyseq.printOptions();
1879 if (!owner->view()->available())
1880 return _("Welcome to LyX!");
1882 return currentState(owner->view().get());