3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Asger Alstrup
7 * \author Lars Gullik Bjønnes
8 * \author Alfredo Braunstein
9 * \author Angus Leeming
11 * \author André Pönitz
13 * Full author contact details are available in file CREDITS.
21 #include "BranchList.h"
22 #include "FloatList.h"
23 #include "FuncStatus.h"
25 #include "buffer_funcs.h"
26 #include "BufferParams.h"
27 #include "BufferView.h"
29 #include "CutAndPaste.h"
30 #include "DispatchResult.h"
31 #include "ErrorList.h"
33 #include "FuncRequest.h"
34 #include "InsetList.h"
38 #include "LyXAction.h"
42 #include "Paragraph.h"
43 #include "paragraph_funcs.h"
44 #include "ParagraphParameters.h"
45 #include "TextClass.h"
46 #include "TextMetrics.h"
49 #include "frontends/Clipboard.h"
50 #include "frontends/Selection.h"
52 #include "insets/InsetCollapsable.h"
53 #include "insets/InsetCommand.h"
54 #include "insets/InsetFloatList.h"
55 #include "insets/InsetNewline.h"
56 #include "insets/InsetQuotes.h"
57 #include "insets/InsetSpecialChar.h"
58 #include "insets/InsetText.h"
59 #include "insets/InsetInfo.h"
60 #include "insets/InsetGraphics.h"
61 #include "insets/InsetGraphicsParams.h"
63 #include "support/convert.h"
64 #include "support/debug.h"
65 #include "support/gettext.h"
66 #include "support/lstrings.h"
67 #include "support/lyxtime.h"
69 #include "mathed/InsetMathHull.h"
70 #include "mathed/MathMacroTemplate.h"
72 #include <boost/next_prior.hpp>
78 using namespace lyx::support;
82 using cap::copySelection;
83 using cap::cutSelection;
84 using cap::pasteFromStack;
85 using cap::pasteClipboardText;
86 using cap::pasteClipboardGraphics;
87 using cap::replaceSelection;
90 static Font freefont(ignore_font, ignore_language);
91 static bool toggleall = false;
93 static void toggleAndShow(Cursor & cur, Text * text,
94 Font const & font, bool toggleall = true)
96 text->toggleFree(cur, font, toggleall);
98 if (font.language() != ignore_language ||
99 font.fontInfo().number() != FONT_IGNORE) {
100 TextMetrics const & tm = cur.bv().textMetrics(text);
101 if (cur.boundary() != tm.isRTLBoundary(cur.pit(), cur.pos(),
102 cur.real_current_font))
103 text->setCursor(cur, cur.pit(), cur.pos(),
104 false, !cur.boundary());
109 static void moveCursor(Cursor & cur, bool selecting)
111 if (selecting || cur.mark())
116 static void finishChange(Cursor & cur, bool selecting)
119 moveCursor(cur, selecting);
123 static void mathDispatch(Cursor & cur, FuncRequest const & cmd, bool display)
126 docstring sel = cur.selectionAsString(false);
128 // It may happen that sel is empty but there is a selection
129 replaceSelection(cur);
132 #ifdef ENABLE_ASSERTIONS
133 const int old_pos = cur.pos();
135 cur.insert(new InsetMathHull(hullSimple));
136 #ifdef ENABLE_ASSERTIONS
137 LASSERT(old_pos == cur.pos(), /**/);
139 cur.nextInset()->edit(cur, true);
140 // don't do that also for LFUN_MATH_MODE
141 // unless you want end up with always changing
142 // to mathrm when opening an inlined inset --
143 // I really hate "LyXfunc overloading"...
145 cur.dispatch(FuncRequest(LFUN_MATH_DISPLAY));
146 // Avoid an unnecessary undo step if cmd.argument
148 if (!cmd.argument().empty())
149 cur.dispatch(FuncRequest(LFUN_MATH_INSERT,
152 // create a macro if we see "\\newcommand"
153 // somewhere, and an ordinary formula
155 if (sel.find(from_ascii("\\newcommand")) == string::npos
156 && sel.find(from_ascii("\\newlyxcommand")) == string::npos
157 && sel.find(from_ascii("\\def")) == string::npos)
159 InsetMathHull * formula = new InsetMathHull;
160 istringstream is(to_utf8(sel));
164 if (formula->getType() == hullNone)
165 // Don't create pseudo formulas if
166 // delimiters are left out
167 formula->mutate(hullSimple);
170 cur.insert(new MathMacroTemplate(sel));
173 cur.message(from_utf8(N_("Math editor mode")));
177 static void specialChar(Cursor & cur, InsetSpecialChar::Kind kind)
180 cap::replaceSelection(cur);
181 cur.insert(new InsetSpecialChar(kind));
186 static bool doInsertInset(Cursor & cur, Text * text,
187 FuncRequest const & cmd, bool edit, bool pastesel)
189 Buffer & buffer = cur.bv().buffer();
190 BufferParams const & bparams = buffer.params();
191 Inset * inset = createInset(buffer, cmd);
195 if (InsetCollapsable * ci = inset->asInsetCollapsable())
196 ci->setLayout(bparams);
199 if (cmd.action == LFUN_INDEX_INSERT) {
200 docstring ds = subst(text->getStringToIndex(cur), '\n', ' ');
201 text->insertInset(cur, inset);
203 inset->edit(cur, true);
204 // Now put this into inset
205 static_cast<InsetCollapsable *>(inset)->text_.insertStringAsParagraphs(cur, ds);
210 if (cur.selection()) {
211 lyx::dispatch(FuncRequest(LFUN_CUT));
214 text->insertInset(cur, inset);
217 inset->edit(cur, true);
219 if (!gotsel || !pastesel)
222 lyx::dispatch(FuncRequest(LFUN_PASTE, "0"));
223 InsetText * insetText = dynamic_cast<InsetText *>(inset);
224 if (insetText && !insetText->allowMultiPar() || cur.lastpit() == 0) {
225 // reset first par to default
226 cur.text()->paragraphs().begin()
227 ->setEmptyOrDefaultLayout(bparams.documentClass());
230 // Merge multiple paragraphs -- hack
231 while (cur.lastpit() > 0)
232 mergeParagraph(bparams, cur.text()->paragraphs(), 0);
234 // reset surrounding par to default
235 docstring const layoutname = insetText->useEmptyLayout()
236 ? bparams.documentClass().emptyLayoutName()
237 : bparams.documentClass().defaultLayoutName();
238 cur.leaveInset(*inset);
239 text->setLayout(cur, layoutname);
246 string const freefont2string()
248 return freefont.toString(toggleall);
252 /// the type of outline operation
254 OutlineUp, // Move this header with text down
255 OutlineDown, // Move this header with text up
256 OutlineIn, // Make this header deeper
257 OutlineOut // Make this header shallower
261 static void outline(OutlineOp mode, Cursor & cur)
263 Buffer & buf = cur.buffer();
264 pit_type & pit = cur.pit();
265 ParagraphList & pars = buf.text().paragraphs();
266 ParagraphList::iterator bgn = pars.begin();
267 // The first paragraph of the area to be copied:
268 ParagraphList::iterator start = boost::next(bgn, pit);
269 // The final paragraph of area to be copied:
270 ParagraphList::iterator finish = start;
271 ParagraphList::iterator end = pars.end();
273 DocumentClass const & tc = buf.params().documentClass();
275 int const thistoclevel = start->layout().toclevel;
278 // Move out (down) from this section header
281 // Seek the one (on same level) below
282 for (; finish != end; ++finish) {
283 toclevel = finish->layout().toclevel;
284 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel) {
291 if (start == pars.begin())
294 ParagraphList::iterator dest = start;
295 // Move out (up) from this header
298 // Search previous same-level header above
301 toclevel = dest->layout().toclevel;
303 && (toclevel == Layout::NOT_IN_TOC
304 || toclevel > thistoclevel));
305 // Not found; do nothing
306 if (toclevel == Layout::NOT_IN_TOC || toclevel > thistoclevel)
308 pit_type const newpit = distance(bgn, dest);
309 pit_type const len = distance(start, finish);
310 pit_type const deletepit = pit + len;
311 buf.undo().recordUndo(cur, ATOMIC_UNDO, newpit, deletepit - 1);
312 pars.insert(dest, start, finish);
313 start = boost::next(pars.begin(), deletepit);
315 pars.erase(start, finish);
322 // Go one down from *this* header:
323 ParagraphList::iterator dest = boost::next(finish, 1);
324 // Go further down to find header to insert in front of:
325 for (; dest != end; ++dest) {
326 toclevel = dest->layout().toclevel;
327 if (toclevel != Layout::NOT_IN_TOC
328 && toclevel <= thistoclevel) {
332 // One such was found:
333 pit_type newpit = distance(bgn, dest);
334 pit_type const len = distance(start, finish);
335 buf.undo().recordUndo(cur, ATOMIC_UNDO, pit, newpit - 1);
336 pars.insert(dest, start, finish);
337 start = boost::next(bgn, pit);
339 pars.erase(start, finish);
343 pit_type const len = distance(start, finish);
344 buf.undo().recordUndo(cur, ATOMIC_UNDO, pit, pit + len - 1);
345 for (; start != finish; ++start) {
346 toclevel = start->layout().toclevel;
347 if (toclevel == Layout::NOT_IN_TOC)
349 DocumentClass::const_iterator lit = tc.begin();
350 DocumentClass::const_iterator len = tc.end();
351 for (; lit != len; ++lit) {
352 if (lit->toclevel == toclevel + 1 &&
353 start->layout().labeltype == lit->labeltype) {
354 start->setLayout(*lit);
362 pit_type const len = distance(start, finish);
363 buf.undo().recordUndo(cur, ATOMIC_UNDO, pit, pit + len - 1);
364 for (; start != finish; ++start) {
365 toclevel = start->layout().toclevel;
366 if (toclevel == Layout::NOT_IN_TOC)
368 DocumentClass::const_iterator lit = tc.begin();
369 DocumentClass::const_iterator len = tc.end();
370 for (; lit != len; ++lit) {
371 if (lit->toclevel == toclevel - 1 &&
372 start->layout().labeltype == lit->labeltype) {
373 start->setLayout(*lit);
384 void Text::number(Cursor & cur)
386 FontInfo font = ignore_font;
387 font.setNumber(FONT_TOGGLE);
388 toggleAndShow(cur, this, Font(font, ignore_language));
392 bool Text::isRTL(Buffer const & buffer, Paragraph const & par) const
394 return par.isRTL(buffer.params());
398 void Text::dispatch(Cursor & cur, FuncRequest & cmd)
400 LYXERR(Debug::ACTION, "Text::dispatch: cmd: " << cmd);
402 BufferView * bv = &cur.bv();
403 TextMetrics & tm = bv->textMetrics(this);
404 if (!tm.contains(cur.pit()))
405 lyx::dispatch(FuncRequest(LFUN_SCREEN_RECENTER));
407 // FIXME: We use the update flag to indicates wether a singlePar or a
408 // full screen update is needed. We reset it here but shall we restore it
412 LASSERT(cur.text() == this, /**/);
413 CursorSlice oldTopSlice = cur.top();
414 bool oldBoundary = cur.boundary();
415 bool sel = cur.selection();
416 // Signals that, even if needsUpdate == false, an update of the
417 // cursor paragraph is required
418 bool singleParUpdate = lyxaction.funcHasFlag(cmd.action,
419 LyXAction::SingleParUpdate);
420 // Signals that a full-screen update is required
421 bool needsUpdate = !(lyxaction.funcHasFlag(cmd.action,
422 LyXAction::NoUpdate) || singleParUpdate);
424 switch (cmd.action) {
426 case LFUN_PARAGRAPH_MOVE_DOWN: {
427 pit_type const pit = cur.pit();
428 recUndo(cur, pit, pit + 1);
430 swap(pars_[pit], pars_[pit + 1]);
431 updateLabels(cur.buffer());
437 case LFUN_PARAGRAPH_MOVE_UP: {
438 pit_type const pit = cur.pit();
439 recUndo(cur, pit - 1, pit);
441 swap(pars_[pit], pars_[pit - 1]);
442 updateLabels(cur.buffer());
448 case LFUN_APPENDIX: {
449 Paragraph & par = cur.paragraph();
450 bool start = !par.params().startOfAppendix();
452 // FIXME: The code below only makes sense at top level.
453 // Should LFUN_APPENDIX be restricted to top-level paragraphs?
454 // ensure that we have only one start_of_appendix in this document
455 // FIXME: this don't work for multipart document!
456 for (pit_type tmp = 0, end = pars_.size(); tmp != end; ++tmp) {
457 if (pars_[tmp].params().startOfAppendix()) {
459 pars_[tmp].params().startOfAppendix(false);
465 par.params().startOfAppendix(start);
467 // we can set the refreshing parameters now
468 updateLabels(cur.buffer());
472 case LFUN_WORD_DELETE_FORWARD:
473 if (cur.selection()) {
474 cutSelection(cur, true, false);
476 deleteWordForward(cur);
477 finishChange(cur, false);
480 case LFUN_WORD_DELETE_BACKWARD:
481 if (cur.selection()) {
482 cutSelection(cur, true, false);
484 deleteWordBackward(cur);
485 finishChange(cur, false);
488 case LFUN_LINE_DELETE:
489 if (cur.selection()) {
490 cutSelection(cur, true, false);
492 tm.deleteLineForward(cur);
493 finishChange(cur, false);
496 case LFUN_BUFFER_BEGIN:
497 case LFUN_BUFFER_BEGIN_SELECT:
498 needsUpdate |= cur.selHandle(cmd.action == LFUN_BUFFER_BEGIN_SELECT);
499 if (cur.depth() == 1) {
500 needsUpdate |= cursorTop(cur);
504 cur.updateFlags(Update::FitCursor);
507 case LFUN_BUFFER_END:
508 case LFUN_BUFFER_END_SELECT:
509 needsUpdate |= cur.selHandle(cmd.action == LFUN_BUFFER_END_SELECT);
510 if (cur.depth() == 1) {
511 needsUpdate |= cursorBottom(cur);
515 cur.updateFlags(Update::FitCursor);
518 case LFUN_CHAR_FORWARD:
519 case LFUN_CHAR_FORWARD_SELECT:
520 //LYXERR0(" LFUN_CHAR_FORWARD[SEL]:\n" << cur);
521 needsUpdate |= cur.selHandle(cmd.action == LFUN_CHAR_FORWARD_SELECT);
522 needsUpdate |= cursorForward(cur);
524 if (!needsUpdate && oldTopSlice == cur.top()
525 && cur.boundary() == oldBoundary) {
527 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
531 case LFUN_CHAR_BACKWARD:
532 case LFUN_CHAR_BACKWARD_SELECT:
533 //lyxerr << "handle LFUN_CHAR_BACKWARD[_SELECT]:\n" << cur << endl;
534 needsUpdate |= cur.selHandle(cmd.action == LFUN_CHAR_BACKWARD_SELECT);
535 needsUpdate |= cursorBackward(cur);
537 if (!needsUpdate && oldTopSlice == cur.top()
538 && cur.boundary() == oldBoundary) {
540 cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
545 case LFUN_CHAR_LEFT_SELECT:
546 if (lyxrc.visual_cursor) {
547 needsUpdate |= cur.selHandle(cmd.action == LFUN_CHAR_LEFT_SELECT);
548 needsUpdate |= cursorVisLeft(cur);
549 if (!needsUpdate && oldTopSlice == cur.top()
550 && cur.boundary() == oldBoundary) {
552 cmd = FuncRequest(LFUN_FINISHED_LEFT);
555 if (reverseDirectionNeeded(cur)) {
556 cmd.action = cmd.action == LFUN_CHAR_LEFT_SELECT ?
557 LFUN_CHAR_FORWARD_SELECT : LFUN_CHAR_FORWARD;
559 cmd.action = cmd.action == LFUN_CHAR_LEFT_SELECT ?
560 LFUN_CHAR_BACKWARD_SELECT : LFUN_CHAR_BACKWARD;
567 case LFUN_CHAR_RIGHT:
568 case LFUN_CHAR_RIGHT_SELECT:
569 if (lyxrc.visual_cursor) {
570 needsUpdate |= cur.selHandle(cmd.action == LFUN_CHAR_RIGHT_SELECT);
571 needsUpdate |= cursorVisRight(cur);
572 if (!needsUpdate && oldTopSlice == cur.top()
573 && cur.boundary() == oldBoundary) {
575 cmd = FuncRequest(LFUN_FINISHED_RIGHT);
578 if (reverseDirectionNeeded(cur)) {
579 cmd.action = cmd.action == LFUN_CHAR_RIGHT_SELECT ?
580 LFUN_CHAR_BACKWARD_SELECT : LFUN_CHAR_BACKWARD;
582 cmd.action = cmd.action == LFUN_CHAR_RIGHT_SELECT ?
583 LFUN_CHAR_FORWARD_SELECT : LFUN_CHAR_FORWARD;
592 case LFUN_DOWN_SELECT:
595 // stop/start the selection
596 bool select = cmd.action == LFUN_DOWN_SELECT ||
597 cmd.action == LFUN_UP_SELECT;
598 cur.selHandle(select);
600 // move cursor up/down
601 bool up = cmd.action == LFUN_UP_SELECT || cmd.action == LFUN_UP;
602 bool const successful = cur.upDownInText(up, needsUpdate);
604 // redraw if you leave mathed (for the decorations)
605 needsUpdate |= cur.beforeDispatchCursor().inMathed();
612 case LFUN_PARAGRAPH_UP:
613 case LFUN_PARAGRAPH_UP_SELECT:
614 needsUpdate |= cur.selHandle(cmd.action == LFUN_PARAGRAPH_UP_SELECT);
615 needsUpdate |= cursorUpParagraph(cur);
618 case LFUN_PARAGRAPH_DOWN:
619 case LFUN_PARAGRAPH_DOWN_SELECT:
620 needsUpdate |= cur.selHandle(cmd.action == LFUN_PARAGRAPH_DOWN_SELECT);
621 needsUpdate |= cursorDownParagraph(cur);
624 case LFUN_LINE_BEGIN:
625 case LFUN_LINE_BEGIN_SELECT:
626 needsUpdate |= cur.selHandle(cmd.action == LFUN_LINE_BEGIN_SELECT);
627 needsUpdate |= tm.cursorHome(cur);
631 case LFUN_LINE_END_SELECT:
632 needsUpdate |= cur.selHandle(cmd.action == LFUN_LINE_END_SELECT);
633 needsUpdate |= tm.cursorEnd(cur);
636 case LFUN_WORD_RIGHT:
637 case LFUN_WORD_RIGHT_SELECT:
638 if (lyxrc.visual_cursor) {
639 needsUpdate |= cur.selHandle(cmd.action == LFUN_WORD_RIGHT_SELECT);
640 needsUpdate |= cursorVisRightOneWord(cur);
641 if (!needsUpdate && oldTopSlice == cur.top()
642 && cur.boundary() == oldBoundary) {
644 cmd = FuncRequest(LFUN_FINISHED_RIGHT);
647 if (reverseDirectionNeeded(cur)) {
648 cmd.action = cmd.action == LFUN_WORD_RIGHT_SELECT ?
649 LFUN_WORD_BACKWARD_SELECT : LFUN_WORD_BACKWARD;
651 cmd.action = cmd.action == LFUN_WORD_RIGHT_SELECT ?
652 LFUN_WORD_FORWARD_SELECT : LFUN_WORD_FORWARD;
659 case LFUN_WORD_FORWARD:
660 case LFUN_WORD_FORWARD_SELECT:
661 needsUpdate |= cur.selHandle(cmd.action == LFUN_WORD_FORWARD_SELECT);
662 needsUpdate |= cursorForwardOneWord(cur);
666 case LFUN_WORD_LEFT_SELECT:
667 if (lyxrc.visual_cursor) {
668 needsUpdate |= cur.selHandle(cmd.action == LFUN_WORD_LEFT_SELECT);
669 needsUpdate |= cursorVisLeftOneWord(cur);
670 if (!needsUpdate && oldTopSlice == cur.top()
671 && cur.boundary() == oldBoundary) {
673 cmd = FuncRequest(LFUN_FINISHED_LEFT);
676 if (reverseDirectionNeeded(cur)) {
677 cmd.action = cmd.action == LFUN_WORD_LEFT_SELECT ?
678 LFUN_WORD_FORWARD_SELECT : LFUN_WORD_FORWARD;
680 cmd.action = cmd.action == LFUN_WORD_LEFT_SELECT ?
681 LFUN_WORD_BACKWARD_SELECT : LFUN_WORD_BACKWARD;
688 case LFUN_WORD_BACKWARD:
689 case LFUN_WORD_BACKWARD_SELECT:
690 needsUpdate |= cur.selHandle(cmd.action == LFUN_WORD_BACKWARD_SELECT);
691 needsUpdate |= cursorBackwardOneWord(cur);
694 case LFUN_WORD_SELECT: {
695 selectWord(cur, WHOLE_WORD);
696 finishChange(cur, true);
700 case LFUN_NEWLINE_INSERT: {
701 InsetNewlineParams inp;
702 docstring arg = cmd.argument();
703 // this avoids a double undo
704 // FIXME: should not be needed, ideally
705 if (!cur.selection())
707 cap::replaceSelection(cur);
708 if (arg == "linebreak")
709 inp.kind = InsetNewlineParams::LINEBREAK;
711 inp.kind = InsetNewlineParams::NEWLINE;
712 cur.insert(new InsetNewline(inp));
714 moveCursor(cur, false);
718 case LFUN_CHAR_DELETE_FORWARD:
719 if (!cur.selection()) {
720 if (cur.pos() == cur.paragraph().size())
721 // Par boundary, force full-screen update
722 singleParUpdate = false;
723 needsUpdate |= erase(cur);
725 // It is possible to make it a lot faster still
726 // just comment out the line below...
728 cutSelection(cur, true, false);
729 singleParUpdate = false;
731 moveCursor(cur, false);
734 case LFUN_DELETE_FORWARD_SKIP:
735 // Reverse the effect of LFUN_BREAK_PARAGRAPH_SKIP.
736 if (!cur.selection()) {
737 if (cur.pos() == cur.lastpos()) {
744 cutSelection(cur, true, false);
749 case LFUN_CHAR_DELETE_BACKWARD:
750 if (!cur.selection()) {
751 if (bv->getIntl().getTransManager().backspace()) {
752 // Par boundary, full-screen update
754 singleParUpdate = false;
755 needsUpdate |= backspace(cur);
757 // It is possible to make it a lot faster still
758 // just comment out the line below...
761 cutSelection(cur, true, false);
762 singleParUpdate = false;
766 case LFUN_DELETE_BACKWARD_SKIP:
767 // Reverse the effect of LFUN_BREAK_PARAGRAPH_SKIP.
768 if (!cur.selection()) {
770 //CursorSlice cur = cursor();
774 cutSelection(cur, true, false);
778 case LFUN_BREAK_PARAGRAPH:
779 cap::replaceSelection(cur);
780 breakParagraph(cur, cmd.argument() == "inverse");
784 case LFUN_BREAK_PARAGRAPH_SKIP: {
785 // When at the beginning of a paragraph, remove
786 // indentation. Otherwise, do the same as LFUN_BREAK_PARAGRAPH.
787 cap::replaceSelection(cur);
789 cur.paragraph().params().labelWidthString(docstring());
791 breakParagraph(cur, false);
797 // With the creation of LFUN_PARAGRAPH_PARAMS, this is now redundant,
798 // as its duties can be performed there. Should it be removed??
799 // FIXME For now, it can just dispatch LFUN_PARAGRAPH_PARAMS...
800 case LFUN_PARAGRAPH_SPACING: {
801 Paragraph & par = cur.paragraph();
802 Spacing::Space cur_spacing = par.params().spacing().getSpace();
803 string cur_value = "1.0";
804 if (cur_spacing == Spacing::Other)
805 cur_value = par.params().spacing().getValueAsString();
807 istringstream is(to_utf8(cmd.argument()));
810 Spacing::Space new_spacing = cur_spacing;
811 string new_value = cur_value;
813 lyxerr << "Missing argument to `paragraph-spacing'"
815 } else if (tmp == "single") {
816 new_spacing = Spacing::Single;
817 } else if (tmp == "onehalf") {
818 new_spacing = Spacing::Onehalf;
819 } else if (tmp == "double") {
820 new_spacing = Spacing::Double;
821 } else if (tmp == "other") {
822 new_spacing = Spacing::Other;
823 string tmpval = "0.0";
825 lyxerr << "new_value = " << tmpval << endl;
828 } else if (tmp == "default") {
829 new_spacing = Spacing::Default;
831 lyxerr << to_utf8(_("Unknown spacing argument: "))
832 << to_utf8(cmd.argument()) << endl;
834 if (cur_spacing != new_spacing || cur_value != new_value)
835 par.params().spacing(Spacing(new_spacing, new_value));
839 case LFUN_INSET_INSERT: {
841 Inset * inset = createInset(bv->buffer(), cmd);
843 // FIXME (Abdel 01/02/2006):
844 // What follows would be a partial fix for bug 2154:
845 // http://bugzilla.lyx.org/show_bug.cgi?id=2154
846 // This automatically put the label inset _after_ a
847 // numbered section. It should be possible to extend the mechanism
848 // to any kind of LateX environement.
849 // The correct way to fix that bug would be at LateX generation.
850 // I'll let the code here for reference as it could be used for some
851 // other feature like "automatic labelling".
853 Paragraph & par = pars_[cur.pit()];
854 if (inset->lyxCode() == LABEL_CODE
855 && par.layout().labeltype == LABEL_COUNTER) {
856 // Go to the end of the paragraph
857 // Warning: Because of Change-Tracking, the last
858 // position is 'size()' and not 'size()-1':
859 cur.pos() = par.size();
860 // Insert a new paragraph
861 FuncRequest fr(LFUN_BREAK_PARAGRAPH);
866 cutSelection(cur, true, false);
873 case LFUN_INSET_DISSOLVE:
874 needsUpdate |= dissolveInset(cur);
877 case LFUN_INSET_SETTINGS: {
878 Inset & inset = cur.inset();
879 if (cmd.getArg(0) == insetName(inset.lyxCode())) {
880 // This inset dialog has been explicitely requested.
881 inset.showInsetDialog(bv);
884 // else, if there is an inset at the cursor, access this
885 Inset * next_inset = cur.nextInset();
887 next_inset->showInsetDialog(bv);
890 // if not then access the underlying inset.
891 inset.showInsetDialog(bv);
895 case LFUN_SET_GRAPHICS_GROUP: {
896 Inset * instmp = &cur.inset();
897 if (instmp->lyxCode() != GRAPHICS_CODE) instmp = cur.nextInset();
898 if (!instmp || instmp->lyxCode() != GRAPHICS_CODE) break;
900 cur.recordUndoFullDocument();
901 Inset & inset = *instmp;
902 InsetGraphics & ins = static_cast<InsetGraphics &>(inset);
904 string id = to_utf8(cmd.argument());
905 string grp = InsetGraphics::getGroupParams(bv->buffer(), id);
906 InsetGraphicsParams tmp, inspar = ins.getParams();
909 inspar.groupId = to_utf8(cmd.argument());
911 InsetGraphics::string2params(grp, bv->buffer(), tmp);
912 tmp.filename = inspar.filename;
916 ins.setParams(inspar);
919 case LFUN_SPACE_INSERT:
920 if (cur.paragraph().layout().free_spacing)
921 insertChar(cur, ' ');
923 doInsertInset(cur, this, cmd, false, false);
926 moveCursor(cur, false);
929 case LFUN_SPECIALCHAR_INSERT: {
930 string const name = to_utf8(cmd.argument());
931 if (name == "hyphenation")
932 specialChar(cur, InsetSpecialChar::HYPHENATION);
933 else if (name == "ligature-break")
934 specialChar(cur, InsetSpecialChar::LIGATURE_BREAK);
935 else if (name == "slash")
936 specialChar(cur, InsetSpecialChar::SLASH);
937 else if (name == "nobreakdash")
938 specialChar(cur, InsetSpecialChar::NOBREAKDASH);
939 else if (name == "dots")
940 specialChar(cur, InsetSpecialChar::LDOTS);
941 else if (name == "end-of-sentence")
942 specialChar(cur, InsetSpecialChar::END_OF_SENTENCE);
943 else if (name == "menu-separator")
944 specialChar(cur, InsetSpecialChar::MENU_SEPARATOR);
945 else if (name.empty())
946 lyxerr << "LyX function 'specialchar-insert' needs an argument." << endl;
948 lyxerr << "Wrong argument for LyX function 'specialchar-insert'." << endl;
952 case LFUN_WORD_UPCASE:
953 changeCase(cur, text_uppercase);
956 case LFUN_WORD_LOWCASE:
957 changeCase(cur, text_lowercase);
960 case LFUN_WORD_CAPITALIZE:
961 changeCase(cur, text_capitalization);
964 case LFUN_CHARS_TRANSPOSE:
969 cur.message(_("Paste"));
970 cap::replaceSelection(cur);
973 string const arg = to_utf8(cmd.argument());
975 if (theClipboard().isInternal())
976 pasteFromStack(cur, bv->buffer().errorList("Paste"), 0);
977 else if (theClipboard().hasGraphicsContents())
978 pasteClipboardGraphics(cur, bv->buffer().errorList("Paste"));
980 pasteClipboardText(cur, bv->buffer().errorList("Paste"));
981 } else if (isStrUnsignedInt(arg)) {
982 // we have a numerical argument
983 pasteFromStack(cur, bv->buffer().errorList("Paste"),
984 convert<unsigned int>(arg));
986 Clipboard::GraphicsType type = Clipboard::AnyGraphicsType;
988 type = Clipboard::PdfGraphicsType;
989 else if (arg == "png")
990 type = Clipboard::PngGraphicsType;
991 else if (arg == "jpeg")
992 type = Clipboard::JpegGraphicsType;
993 else if (arg == "linkback")
994 type = Clipboard::LinkBackGraphicsType;
996 LASSERT(false, /**/);
998 pasteClipboardGraphics(cur, bv->buffer().errorList("Paste"), type);
1001 bv->buffer().errors("Paste");
1002 cur.clearSelection(); // bug 393
1008 cutSelection(cur, true, true);
1009 cur.message(_("Cut"));
1014 cur.message(_("Copy"));
1017 case LFUN_SERVER_GET_XY:
1018 cur.message(from_utf8(
1019 convert<string>(tm.cursorX(cur.top(), cur.boundary()))
1020 + ' ' + convert<string>(tm.cursorY(cur.top(), cur.boundary()))));
1023 case LFUN_SERVER_SET_XY: {
1026 istringstream is(to_utf8(cmd.argument()));
1029 lyxerr << "SETXY: Could not parse coordinates in '"
1030 << to_utf8(cmd.argument()) << endl;
1032 tm.setCursorFromCoordinates(cur, x, y);
1036 case LFUN_SERVER_GET_LAYOUT:
1037 cur.message(cur.paragraph().layout().name());
1041 docstring layout = cmd.argument();
1042 LYXERR(Debug::INFO, "LFUN_LAYOUT: (arg) " << to_utf8(layout));
1044 Paragraph const & para = cur.paragraph();
1045 docstring const old_layout = para.layout().name();
1046 DocumentClass const & tclass = bv->buffer().params().documentClass();
1049 layout = tclass.defaultLayoutName();
1051 if (para.forceEmptyLayout())
1052 // in this case only the empty layout is allowed
1053 layout = tclass.emptyLayoutName();
1054 else if (para.useEmptyLayout()) {
1055 // in this case, default layout maps to empty layout
1056 if (layout == tclass.defaultLayoutName())
1057 layout = tclass.emptyLayoutName();
1059 // otherwise, the empty layout maps to the default
1060 if (layout == tclass.emptyLayoutName())
1061 layout = tclass.defaultLayoutName();
1064 bool hasLayout = tclass.hasLayout(layout);
1066 // If the entry is obsolete, use the new one instead.
1068 docstring const & obs = tclass[layout].obsoleted_by();
1074 cur.errorMessage(from_utf8(N_("Layout ")) + cmd.argument() +
1075 from_utf8(N_(" not known")));
1079 bool change_layout = (old_layout != layout);
1081 if (!change_layout && cur.selection() &&
1082 cur.selBegin().pit() != cur.selEnd().pit())
1084 pit_type spit = cur.selBegin().pit();
1085 pit_type epit = cur.selEnd().pit() + 1;
1086 while (spit != epit) {
1087 if (pars_[spit].layout().name() != old_layout) {
1088 change_layout = true;
1096 setLayout(cur, layout);
1101 case LFUN_CLIPBOARD_PASTE:
1102 cur.clearSelection();
1103 pasteClipboardText(cur, bv->buffer().errorList("Paste"),
1104 cmd.argument() == "paragraph");
1105 bv->buffer().errors("Paste");
1108 case LFUN_PRIMARY_SELECTION_PASTE:
1109 pasteString(cur, theSelection().get(),
1110 cmd.argument() == "paragraph");
1113 case LFUN_UNICODE_INSERT: {
1114 if (cmd.argument().empty())
1116 docstring hexstring = cmd.argument();
1117 if (isHex(hexstring)) {
1118 char_type c = hexToInt(hexstring);
1119 if (c >= 32 && c < 0x10ffff) {
1120 lyxerr << "Inserting c: " << c << endl;
1121 docstring s = docstring(1, c);
1122 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, s));
1128 case LFUN_QUOTE_INSERT: {
1129 Paragraph & par = cur.paragraph();
1130 pos_type pos = cur.pos();
1131 BufferParams const & bufparams = bv->buffer().params();
1132 Layout const & style = par.layout();
1133 if (!style.pass_thru
1134 && par.getFontSettings(bufparams, pos).language()->lang() != "hebrew") {
1135 // this avoids a double undo
1136 // FIXME: should not be needed, ideally
1137 if (!cur.selection())
1139 cap::replaceSelection(cur);
1144 else if (cur.prevInset() && cur.prevInset()->isSpace())
1147 c = par.getChar(pos - 1);
1148 string arg = to_utf8(cmd.argument());
1149 cur.insert(new InsetQuotes(c, bufparams.quotes_language,
1150 (arg == "single") ? InsetQuotes::SingleQuotes
1151 : InsetQuotes::DoubleQuotes));
1155 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, "\""));
1159 case LFUN_DATE_INSERT: {
1160 string const format = cmd.argument().empty()
1161 ? lyxrc.date_insert_format : to_utf8(cmd.argument());
1162 string const time = formatted_time(current_time(), format);
1163 lyx::dispatch(FuncRequest(LFUN_SELF_INSERT, time));
1167 case LFUN_MOUSE_TRIPLE:
1168 if (cmd.button() == mouse_button::button1) {
1177 case LFUN_MOUSE_DOUBLE:
1178 if (cmd.button() == mouse_button::button1) {
1179 selectWord(cur, WHOLE_WORD_STRICT);
1184 // Single-click on work area
1185 case LFUN_MOUSE_PRESS:
1186 // We are not marking a selection with the keyboard in any case.
1187 cur.bv().cursor().mark() = false;
1188 switch (cmd.button()) {
1189 case mouse_button::button1:
1191 if (!bv->mouseSetCursor(cur, cmd.argument() == "region-select"))
1192 cur.updateFlags(Update::SinglePar | Update::FitCursor);
1195 case mouse_button::button2:
1196 // Middle mouse pasting.
1197 if (!cap::selection()) {
1198 // There is no local selection in the current buffer, so try to
1199 // paste primary selection instead.
1200 lyx::dispatch(FuncRequest(LFUN_PRIMARY_SELECTION_PASTE,
1202 // Nothing else to do.
1206 // Copy the selection buffer to the clipboard stack, because we want it
1207 // to appear in the "Edit->Paste recent" menu.
1208 cap::copySelectionToStack();
1209 cap::pasteSelection(bv->cursor(), bv->buffer().errorList("Paste"));
1210 cur.updateFlags(Update::Force | Update::FitCursor);
1211 bv->buffer().errors("Paste");
1212 bv->buffer().markDirty();
1213 bv->cursor().finishUndo();
1216 case mouse_button::button3:
1217 if (cur.selection()) {
1218 DocIterator const selbeg = cur.selectionBegin();
1219 DocIterator const selend = cur.selectionEnd();
1220 Cursor tmpcur = cur;
1221 tm.setCursorFromCoordinates(tmpcur, cmd.x, cmd.y);
1222 // Don't do anything if we right-click a selection, a selection
1223 // context menu should popup instead.
1224 if (tmpcur < selbeg || tmpcur >= selend) {
1229 if (!bv->mouseSetCursor(cur, false)) {
1230 cur.updateFlags(Update::SinglePar | Update::FitCursor);
1235 } // switch (cmd.button())
1238 case LFUN_MOUSE_MOTION: {
1239 // Mouse motion with right or middle mouse do nothing for now.
1240 if (cmd.button() != mouse_button::button1) {
1244 // ignore motions deeper nested than the real anchor
1245 Cursor & bvcur = cur.bv().cursor();
1246 if (!bvcur.anchor_.hasPart(cur)) {
1250 CursorSlice old = bvcur.top();
1252 int const wh = bv->workHeight();
1253 int const y = max(0, min(wh - 1, cmd.y));
1255 tm.setCursorFromCoordinates(cur, cmd.x, y);
1256 cur.setTargetX(cmd.x);
1258 lyx::dispatch(FuncRequest(LFUN_DOWN_SELECT));
1260 lyx::dispatch(FuncRequest(LFUN_UP_SELECT));
1261 // This is to allow jumping over large insets
1262 if (cur.top() == old) {
1264 lyx::dispatch(FuncRequest(LFUN_DOWN_SELECT));
1266 lyx::dispatch(FuncRequest(LFUN_UP_SELECT));
1268 // We continue with our existing selection or start a new one, so don't
1269 // reset the anchor.
1270 bvcur.setCursor(cur);
1271 bvcur.selection() = true;
1272 if (cur.top() == old) {
1273 // We didn't move one iota, so no need to update the screen.
1274 cur.updateFlags(Update::SinglePar | Update::FitCursor);
1281 case LFUN_MOUSE_RELEASE:
1282 switch (cmd.button()) {
1283 case mouse_button::button1:
1284 // Cursor was set at LFUN_MOUSE_PRESS or LFUN_MOUSE_MOTION time.
1285 // If there is a new selection, update persistent selection;
1286 // otherwise, single click does not clear persistent selection
1288 if (cur.selection()) {
1289 // Finish selection.
1290 // If double click, cur is moved to the end of word by selectWord
1291 // but bvcur is current mouse position.
1292 cur.bv().cursor().selection() = true;
1294 // FIXME: We could try to handle drag and drop of selection here.
1298 case mouse_button::button2:
1299 // Middle mouse pasting is handled at mouse press time,
1300 // see LFUN_MOUSE_PRESS.
1304 case mouse_button::button3:
1305 // Cursor was set at LFUN_MOUSE_PRESS time.
1306 // FIXME: If there is a selection we could try to handle a special
1307 // drag & drop context menu.
1311 } // switch (cmd.button())
1315 case LFUN_SELF_INSERT: {
1316 if (cmd.argument().empty())
1319 // Automatically delete the currently selected
1320 // text and replace it with what is being
1321 // typed in now. Depends on lyxrc settings
1322 // "auto_region_delete", which defaults to
1325 if (lyxrc.auto_region_delete && cur.selection())
1326 cutSelection(cur, false, false);
1328 cur.clearSelection();
1329 Font const old_font = cur.real_current_font;
1331 docstring::const_iterator cit = cmd.argument().begin();
1332 docstring::const_iterator end = cmd.argument().end();
1333 for (; cit != end; ++cit)
1334 bv->translateAndInsert(*cit, this, cur);
1337 moveCursor(cur, false);
1341 case LFUN_HYPERLINK_INSERT: {
1342 InsetCommandParams p(HYPERLINK_CODE);
1344 if (cur.selection()) {
1345 content = cur.selectionAsString(false);
1346 cutSelection(cur, true, false);
1348 p["target"] = (cmd.argument().empty()) ?
1349 content : cmd.argument();
1350 string const data = InsetCommand::params2string("href", p);
1351 if (p["target"].empty()) {
1352 bv->showDialog("href", data);
1354 FuncRequest fr(LFUN_INSET_INSERT, data);
1360 case LFUN_LABEL_INSERT: {
1361 InsetCommandParams p(LABEL_CODE);
1362 // Try to generate a valid label
1363 p["name"] = (cmd.argument().empty()) ?
1364 cur.getPossibleLabel() :
1366 string const data = InsetCommand::params2string("label", p);
1368 if (cmd.argument().empty()) {
1369 bv->showDialog("label", data);
1371 FuncRequest fr(LFUN_INSET_INSERT, data);
1377 case LFUN_INFO_INSERT: {
1378 Inset * inset = createInset(cur.bv().buffer(), cmd);
1381 // if an empty inset is created (cmd.argument() is empty)
1382 // use current selection as parameter.
1383 if (cmd.argument().empty() && cur.selection()) {
1384 // use selected text as info to avoid a separate UI
1385 docstring ds = cur.selectionAsString(false);
1386 cutSelection(cur, true, false);
1387 static_cast<InsetInfo *>(inset)->setInfo(to_utf8(ds));
1388 static_cast<InsetInfo *>(inset)->updateInfo();
1390 insertInset(cur, inset);
1395 case LFUN_LIST_INSERT:
1397 case LFUN_CAPTION_INSERT:
1398 case LFUN_FOOTNOTE_INSERT:
1399 case LFUN_NOTE_INSERT:
1400 case LFUN_FLEX_INSERT:
1401 case LFUN_BOX_INSERT:
1402 case LFUN_BRANCH_INSERT:
1403 case LFUN_BIBITEM_INSERT:
1404 case LFUN_ERT_INSERT:
1405 case LFUN_LISTING_INSERT:
1406 case LFUN_MARGINALNOTE_INSERT:
1407 case LFUN_OPTIONAL_INSERT:
1408 case LFUN_ENVIRONMENT_INSERT:
1409 case LFUN_INDEX_INSERT:
1410 // Open the inset, and move the current selection
1412 doInsertInset(cur, this, cmd, true, true);
1414 // Some insets are numbered, others are shown in the outline pane so
1415 // let's update the labels and the toc backend.
1416 updateLabels(bv->buffer());
1419 case LFUN_TABULAR_INSERT:
1420 // if there were no arguments, just open the dialog
1421 if (doInsertInset(cur, this, cmd, false, true))
1424 bv->showDialog("tabularcreate");
1428 case LFUN_FLOAT_INSERT:
1429 case LFUN_FLOAT_WIDE_INSERT:
1430 case LFUN_WRAP_INSERT: {
1431 bool content = cur.selection(); // will some text be moved into the inset?
1433 doInsertInset(cur, this, cmd, true, true);
1435 ParagraphList & pars = cur.text()->paragraphs();
1437 DocumentClass const & tclass = bv->buffer().params().documentClass();
1439 // add a separate paragraph for the caption inset
1440 pars.push_back(Paragraph());
1441 pars.back().setInsetOwner(pars[0].inInset());
1442 pars.back().setEmptyOrDefaultLayout(tclass);
1443 int cap_pit = pars.size() - 1;
1445 // if an empty inset was created, we create an additional empty
1446 // paragraph at the bottom so that the user can choose where to put
1447 // the graphics (or table).
1449 pars.push_back(Paragraph());
1450 pars.back().setInsetOwner(pars[0].inInset());
1451 pars.back().setEmptyOrDefaultLayout(tclass);
1454 // reposition the cursor to the caption
1455 cur.pit() = cap_pit;
1457 // FIXME: This Text/Cursor dispatch handling is a mess!
1458 // We cannot use Cursor::dispatch here it needs access to up to
1460 FuncRequest cmd_caption(LFUN_CAPTION_INSERT);
1461 cur.text()->dispatch(cur, cmd_caption);
1462 cur.updateFlags(Update::Force);
1463 // FIXME: When leaving the Float (or Wrap) inset we should
1464 // delete any empty paragraph left above or below the
1469 case LFUN_NOMENCL_INSERT: {
1470 FuncRequest cmd1 = cmd;
1471 if (cmd.argument().empty())
1472 cmd1 = FuncRequest(cmd,
1473 bv->cursor().innerText()->getStringToIndex(bv->cursor()));
1474 Inset * inset = createInset(cur.bv().buffer(), cmd1);
1478 cur.clearSelection();
1479 insertInset(cur, inset);
1480 // Show the dialog for the nomenclature entry, since the
1481 // description entry still needs to be filled in.
1482 if (cmd.action == LFUN_NOMENCL_INSERT)
1483 inset->edit(cur, true);
1488 case LFUN_INDEX_PRINT:
1489 case LFUN_NOMENCL_PRINT:
1490 case LFUN_TOC_INSERT:
1491 case LFUN_LINE_INSERT:
1492 case LFUN_NEWPAGE_INSERT:
1494 doInsertInset(cur, this, cmd, false, false);
1498 case LFUN_DEPTH_DECREMENT:
1499 changeDepth(cur, DEC_DEPTH);
1502 case LFUN_DEPTH_INCREMENT:
1503 changeDepth(cur, INC_DEPTH);
1506 case LFUN_MATH_DISPLAY:
1507 mathDispatch(cur, cmd, true);
1510 case LFUN_MATH_IMPORT_SELECTION:
1511 case LFUN_MATH_MODE:
1512 if (cmd.argument() == "on")
1513 // don't pass "on" as argument
1514 mathDispatch(cur, FuncRequest(LFUN_MATH_MODE), false);
1516 mathDispatch(cur, cmd, false);
1519 case LFUN_MATH_MACRO:
1520 if (cmd.argument().empty())
1521 cur.errorMessage(from_utf8(N_("Missing argument")));
1523 string s = to_utf8(cmd.argument());
1524 string const s1 = token(s, ' ', 1);
1525 int const nargs = s1.empty() ? 0 : convert<int>(s1);
1526 string const s2 = token(s, ' ', 2);
1527 MacroType type = MacroTypeNewcommand;
1529 type = MacroTypeDef;
1530 cur.insert(new MathMacroTemplate(from_utf8(token(s, ' ', 0)), nargs, false, type));
1531 //cur.nextInset()->edit(cur, true);
1535 // passthrough hat and underscore outside mathed:
1536 case LFUN_MATH_SUBSCRIPT:
1537 mathDispatch(cur, FuncRequest(LFUN_SELF_INSERT, "_"), false);
1539 case LFUN_MATH_SUPERSCRIPT:
1540 mathDispatch(cur, FuncRequest(LFUN_SELF_INSERT, "^"), false);
1543 case LFUN_MATH_INSERT:
1544 case LFUN_MATH_MATRIX:
1545 case LFUN_MATH_DELIM:
1546 case LFUN_MATH_BIGDELIM: {
1547 cap::replaceSelection(cur);
1548 cur.insert(new InsetMathHull(hullSimple));
1549 checkAndActivateInset(cur, true);
1550 LASSERT(cur.inMathed(), /**/);
1555 case LFUN_FONT_EMPH: {
1556 Font font(ignore_font, ignore_language);
1557 font.fontInfo().setEmph(FONT_TOGGLE);
1558 toggleAndShow(cur, this, font);
1562 case LFUN_FONT_BOLD: {
1563 Font font(ignore_font, ignore_language);
1564 font.fontInfo().setSeries(BOLD_SERIES);
1565 toggleAndShow(cur, this, font);
1569 case LFUN_FONT_NOUN: {
1570 Font font(ignore_font, ignore_language);
1571 font.fontInfo().setNoun(FONT_TOGGLE);
1572 toggleAndShow(cur, this, font);
1576 case LFUN_FONT_TYPEWRITER: {
1577 Font font(ignore_font, ignore_language);
1578 font.fontInfo().setFamily(TYPEWRITER_FAMILY); // no good
1579 toggleAndShow(cur, this, font);
1583 case LFUN_FONT_SANS: {
1584 Font font(ignore_font, ignore_language);
1585 font.fontInfo().setFamily(SANS_FAMILY);
1586 toggleAndShow(cur, this, font);
1590 case LFUN_FONT_ROMAN: {
1591 Font font(ignore_font, ignore_language);
1592 font.fontInfo().setFamily(ROMAN_FAMILY);
1593 toggleAndShow(cur, this, font);
1597 case LFUN_FONT_DEFAULT: {
1598 Font font(inherit_font, ignore_language);
1599 toggleAndShow(cur, this, font);
1603 case LFUN_FONT_UNDERLINE: {
1604 Font font(ignore_font, ignore_language);
1605 font.fontInfo().setUnderbar(FONT_TOGGLE);
1606 toggleAndShow(cur, this, font);
1610 case LFUN_FONT_SIZE: {
1611 Font font(ignore_font, ignore_language);
1612 setLyXSize(to_utf8(cmd.argument()), font.fontInfo());
1613 toggleAndShow(cur, this, font);
1617 case LFUN_LANGUAGE: {
1618 Language const * lang = languages.getLanguage(to_utf8(cmd.argument()));
1621 Font font(ignore_font, lang);
1622 toggleAndShow(cur, this, font);
1626 case LFUN_FONT_FREE_APPLY:
1627 toggleAndShow(cur, this, freefont, toggleall);
1628 cur.message(_("Character set"));
1631 // Set the freefont using the contents of \param data dispatched from
1632 // the frontends and apply it at the current cursor location.
1633 case LFUN_FONT_FREE_UPDATE: {
1636 if (font.fromString(to_utf8(cmd.argument()), toggle)) {
1639 toggleAndShow(cur, this, freefont, toggleall);
1640 cur.message(_("Character set"));
1642 lyxerr << "Argument not ok";
1647 case LFUN_FINISHED_LEFT:
1648 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_LEFT:\n" << cur);
1649 // We're leaving an inset, going left. If the inset is LTR, we're
1650 // leaving from the front, so we should not move (remain at --- but
1651 // not in --- the inset). If the inset is RTL, move left, without
1652 // entering the inset itself; i.e., move to after the inset.
1653 if (cur.paragraph().getFontSettings(
1654 cur.bv().buffer().params(), cur.pos()).isRightToLeft())
1655 cursorVisLeft(cur, true);
1658 case LFUN_FINISHED_RIGHT:
1659 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_RIGHT:\n" << cur);
1660 // We're leaving an inset, going right. If the inset is RTL, we're
1661 // leaving from the front, so we should not move (remain at --- but
1662 // not in --- the inset). If the inset is LTR, move right, without
1663 // entering the inset itself; i.e., move to after the inset.
1664 if (!cur.paragraph().getFontSettings(
1665 cur.bv().buffer().params(), cur.pos()).isRightToLeft())
1666 cursorVisRight(cur, true);
1669 case LFUN_FINISHED_BACKWARD:
1670 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_BACKWARD:\n" << cur);
1673 case LFUN_FINISHED_FORWARD:
1674 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_FORWARD:\n" << cur);
1676 cur.setCurrentFont();
1679 case LFUN_LAYOUT_PARAGRAPH: {
1681 params2string(cur.paragraph(), data);
1682 data = "show\n" + data;
1683 bv->showDialog("paragraph", data);
1687 case LFUN_PARAGRAPH_UPDATE: {
1689 params2string(cur.paragraph(), data);
1691 // Will the paragraph accept changes from the dialog?
1693 cur.inset().allowParagraphCustomization(cur.idx());
1695 data = "update " + convert<string>(accept) + '\n' + data;
1696 bv->updateDialog("paragraph", data);
1700 case LFUN_ACCENT_UMLAUT:
1701 case LFUN_ACCENT_CIRCUMFLEX:
1702 case LFUN_ACCENT_GRAVE:
1703 case LFUN_ACCENT_ACUTE:
1704 case LFUN_ACCENT_TILDE:
1705 case LFUN_ACCENT_CEDILLA:
1706 case LFUN_ACCENT_MACRON:
1707 case LFUN_ACCENT_DOT:
1708 case LFUN_ACCENT_UNDERDOT:
1709 case LFUN_ACCENT_UNDERBAR:
1710 case LFUN_ACCENT_CARON:
1711 case LFUN_ACCENT_SPECIAL_CARON:
1712 case LFUN_ACCENT_BREVE:
1713 case LFUN_ACCENT_TIE:
1714 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
1715 case LFUN_ACCENT_CIRCLE:
1716 case LFUN_ACCENT_OGONEK:
1717 theLyXFunc().handleKeyFunc(cmd.action);
1718 if (!cmd.argument().empty())
1719 // FIXME: Are all these characters encoded in one byte in utf8?
1720 bv->translateAndInsert(cmd.argument()[0], this, cur);
1723 case LFUN_FLOAT_LIST: {
1724 DocumentClass const & tclass = bv->buffer().params().documentClass();
1725 if (tclass.floats().typeExist(to_utf8(cmd.argument()))) {
1727 if (cur.selection())
1728 cutSelection(cur, true, false);
1729 breakParagraph(cur);
1731 if (cur.lastpos() != 0) {
1732 cursorBackward(cur);
1733 breakParagraph(cur);
1736 docstring const laystr = cur.inset().useEmptyLayout() ?
1737 tclass.emptyLayoutName() :
1738 tclass.defaultLayoutName();
1739 setLayout(cur, laystr);
1740 ParagraphParameters p;
1741 setParagraphs(cur, p);
1742 // FIXME This should be simplified when InsetFloatList takes a
1743 // Buffer in its constructor.
1744 InsetFloatList * ifl = new InsetFloatList(to_utf8(cmd.argument()));
1745 ifl->setBuffer(bv->buffer());
1746 insertInset(cur, ifl);
1749 lyxerr << "Non-existent float type: "
1750 << to_utf8(cmd.argument()) << endl;
1755 case LFUN_CHANGE_ACCEPT: {
1756 acceptOrRejectChanges(cur, ACCEPT);
1760 case LFUN_CHANGE_REJECT: {
1761 acceptOrRejectChanges(cur, REJECT);
1765 case LFUN_THESAURUS_ENTRY: {
1766 docstring arg = cmd.argument();
1768 arg = cur.selectionAsString(false);
1770 if (arg.size() > 100 || arg.empty()) {
1771 // Get word or selection
1772 selectWordWhenUnderCursor(cur, WHOLE_WORD);
1773 arg = cur.selectionAsString(false);
1776 bv->showDialog("thesaurus", to_utf8(arg));
1780 case LFUN_PARAGRAPH_PARAMS_APPLY: {
1781 // Given data, an encoding of the ParagraphParameters
1782 // generated in the Paragraph dialog, this function sets
1783 // the current paragraph, or currently selected paragraphs,
1785 // NOTE: This function overrides all existing settings.
1786 setParagraphs(cur, cmd.argument());
1787 cur.message(_("Paragraph layout set"));
1791 case LFUN_PARAGRAPH_PARAMS: {
1792 // Given data, an encoding of the ParagraphParameters as we'd
1793 // find them in a LyX file, this function modifies the current paragraph,
1794 // or currently selected paragraphs.
1795 // NOTE: This function only modifies, and does not override, existing
1797 setParagraphs(cur, cmd.argument(), true);
1798 cur.message(_("Paragraph layout set"));
1803 if (cur.selection()) {
1804 cur.selection() = false;
1807 // This used to be LFUN_FINISHED_RIGHT, I think FORWARD is more
1808 // correct, but I'm not 100% sure -- dov, 071019
1809 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
1813 case LFUN_OUTLINE_UP:
1814 outline(OutlineUp, cur);
1815 setCursor(cur, cur.pit(), 0);
1816 updateLabels(cur.buffer());
1820 case LFUN_OUTLINE_DOWN:
1821 outline(OutlineDown, cur);
1822 setCursor(cur, cur.pit(), 0);
1823 updateLabels(cur.buffer());
1827 case LFUN_OUTLINE_IN:
1828 outline(OutlineIn, cur);
1829 updateLabels(cur.buffer());
1833 case LFUN_OUTLINE_OUT:
1834 outline(OutlineOut, cur);
1835 updateLabels(cur.buffer());
1840 LYXERR(Debug::ACTION, "Command " << cmd << " not DISPATCHED by Text");
1845 needsUpdate |= (cur.pos() != cur.lastpos()) && cur.selection();
1847 // FIXME: The cursor flag is reset two lines below
1848 // so we need to check here if some of the LFUN did touch that.
1849 // for now only Text::erase() and Text::backspace() do that.
1850 // The plan is to verify all the LFUNs and then to remove this
1851 // singleParUpdate boolean altogether.
1852 if (cur.result().update() & Update::Force) {
1853 singleParUpdate = false;
1857 // FIXME: the following code should go in favor of fine grained
1858 // update flag treatment.
1859 if (singleParUpdate) {
1860 // Inserting characters does not change par height in general. So, try
1861 // to update _only_ this paragraph. BufferView will detect if a full
1862 // metrics update is needed anyway.
1863 cur.updateFlags(Update::SinglePar | Update::FitCursor);
1868 && &oldTopSlice.inset() == &cur.inset()
1869 && oldTopSlice.idx() == cur.idx()
1870 && !sel // sel is a backup of cur.selection() at the biginning of the function.
1871 && !cur.selection())
1872 // FIXME: it would be better if we could just do this
1874 //if (cur.result().update() != Update::FitCursor)
1877 // But some LFUNs do not set Update::FitCursor when needed, so we
1878 // do it for all. This is not very harmfull as FitCursor will provoke
1879 // a full redraw only if needed but still, a proper review of all LFUN
1880 // should be done and this needsUpdate boolean can then be removed.
1881 cur.updateFlags(Update::FitCursor);
1883 cur.updateFlags(Update::Force | Update::FitCursor);
1887 bool Text::getStatus(Cursor & cur, FuncRequest const & cmd,
1888 FuncStatus & flag) const
1890 LASSERT(cur.text() == this, /**/);
1892 Font const & font = cur.real_current_font;
1893 FontInfo const & fontinfo = font.fontInfo();
1895 InsetCode code = NO_CODE;
1897 switch (cmd.action) {
1899 case LFUN_DEPTH_DECREMENT:
1900 enable = changeDepthAllowed(cur, DEC_DEPTH);
1903 case LFUN_DEPTH_INCREMENT:
1904 enable = changeDepthAllowed(cur, INC_DEPTH);
1908 flag.setOnOff(cur.paragraph().params().startOfAppendix());
1911 case LFUN_BIBITEM_INSERT:
1912 enable = (cur.paragraph().layout().labeltype == LABEL_BIBLIO
1916 case LFUN_DIALOG_SHOW_NEW_INSET:
1917 if (cmd.argument() == "bibitem")
1918 code = BIBITEM_CODE;
1919 else if (cmd.argument() == "bibtex")
1921 else if (cmd.argument() == "box")
1923 else if (cmd.argument() == "branch")
1925 else if (cmd.argument() == "citation")
1927 else if (cmd.argument() == "ert")
1929 else if (cmd.argument() == "external")
1930 code = EXTERNAL_CODE;
1931 else if (cmd.argument() == "float")
1933 else if (cmd.argument() == "graphics")
1934 code = GRAPHICS_CODE;
1935 else if (cmd.argument() == "href")
1936 code = HYPERLINK_CODE;
1937 else if (cmd.argument() == "include")
1938 code = INCLUDE_CODE;
1939 else if (cmd.argument() == "index")
1941 else if (cmd.argument() == "nomenclature")
1942 code = NOMENCL_CODE;
1943 else if (cmd.argument() == "label")
1945 else if (cmd.argument() == "note")
1947 else if (cmd.argument() == "ref")
1949 else if (cmd.argument() == "space")
1951 else if (cmd.argument() == "toc")
1953 else if (cmd.argument() == "vspace")
1955 else if (cmd.argument() == "wrap")
1957 else if (cmd.argument() == "listings")
1958 code = LISTINGS_CODE;
1961 case LFUN_ERT_INSERT:
1964 case LFUN_LISTING_INSERT:
1965 code = LISTINGS_CODE;
1967 case LFUN_FOOTNOTE_INSERT:
1970 case LFUN_TABULAR_INSERT:
1971 code = TABULAR_CODE;
1973 case LFUN_MARGINALNOTE_INSERT:
1976 case LFUN_FLOAT_INSERT:
1977 case LFUN_FLOAT_WIDE_INSERT:
1980 case LFUN_WRAP_INSERT:
1983 case LFUN_FLOAT_LIST:
1984 code = FLOAT_LIST_CODE;
1987 case LFUN_LIST_INSERT:
1991 case LFUN_CAPTION_INSERT:
1992 code = CAPTION_CODE;
1994 case LFUN_NOTE_INSERT:
1996 // in commands (sections etc., only Notes are allowed)
1997 enable = (cmd.argument().empty() || cmd.getArg(0) == "Note" ||
1998 !cur.paragraph().layout().isCommand());
2000 case LFUN_FLEX_INSERT: {
2002 string s = cmd.getArg(0);
2004 cur.buffer().params().documentClass().insetLayout(from_utf8(s));
2005 if (il.lyxtype() != "charstyle" &&
2006 il.lyxtype() != "custom" &&
2007 il.lyxtype() != "element" &&
2008 il.lyxtype ()!= "standard")
2012 case LFUN_BOX_INSERT:
2015 case LFUN_BRANCH_INSERT:
2017 if (cur.buffer().masterBuffer()->params().branchlist().empty())
2020 case LFUN_LABEL_INSERT:
2023 case LFUN_INFO_INSERT:
2026 case LFUN_OPTIONAL_INSERT:
2028 enable = cur.paragraph().insetList().count(OPTARG_CODE)
2029 < cur.paragraph().layout().optionalargs;
2031 case LFUN_ENVIRONMENT_INSERT:
2034 case LFUN_INDEX_INSERT:
2037 case LFUN_INDEX_PRINT:
2038 code = INDEX_PRINT_CODE;
2040 case LFUN_NOMENCL_INSERT:
2041 code = NOMENCL_CODE;
2043 case LFUN_NOMENCL_PRINT:
2044 code = NOMENCL_PRINT_CODE;
2046 case LFUN_TOC_INSERT:
2049 case LFUN_HYPERLINK_INSERT:
2050 code = HYPERLINK_CODE;
2052 case LFUN_QUOTE_INSERT:
2053 // always allow this, since we will inset a raw quote
2054 // if an inset is not allowed.
2056 case LFUN_SPECIALCHAR_INSERT:
2057 code = SPECIALCHAR_CODE;
2059 case LFUN_SPACE_INSERT:
2060 // slight hack: we know this is allowed in math mode
2065 case LFUN_INSET_MODIFY:
2066 // We need to disable this, because we may get called for a
2068 // InsetTabular::getStatus() -> InsetText::getStatus()
2069 // and we don't handle LFUN_INSET_MODIFY.
2073 case LFUN_FONT_EMPH:
2074 flag.setOnOff(fontinfo.emph() == FONT_ON);
2077 case LFUN_FONT_NOUN:
2078 flag.setOnOff(fontinfo.noun() == FONT_ON);
2081 case LFUN_FONT_BOLD:
2082 flag.setOnOff(fontinfo.series() == BOLD_SERIES);
2085 case LFUN_FONT_SANS:
2086 flag.setOnOff(fontinfo.family() == SANS_FAMILY);
2089 case LFUN_FONT_ROMAN:
2090 flag.setOnOff(fontinfo.family() == ROMAN_FAMILY);
2093 case LFUN_FONT_TYPEWRITER:
2094 flag.setOnOff(fontinfo.family() == TYPEWRITER_FAMILY);
2099 enable = cur.selection();
2103 if (cmd.argument().empty()) {
2104 if (theClipboard().isInternal())
2105 enable = cap::numberOfSelections() > 0;
2107 enable = !theClipboard().empty();
2111 // we have an argument
2112 string const arg = to_utf8(cmd.argument());
2113 if (isStrUnsignedInt(arg)) {
2114 // it's a number and therefore means the internal stack
2115 unsigned int n = convert<unsigned int>(arg);
2116 enable = cap::numberOfSelections() > n;
2120 // explicit graphics type?
2121 if ((arg == "pdf" && theClipboard().hasGraphicsContents(Clipboard::PdfGraphicsType))
2122 || (arg == "png" && theClipboard().hasGraphicsContents(Clipboard::PngGraphicsType))
2123 || (arg == "jpeg" && theClipboard().hasGraphicsContents(Clipboard::JpegGraphicsType))
2124 || (arg == "linkback" && theClipboard().hasGraphicsContents(Clipboard::LinkBackGraphicsType))) {
2134 case LFUN_CLIPBOARD_PASTE:
2135 enable = !theClipboard().empty();
2138 case LFUN_PRIMARY_SELECTION_PASTE:
2139 enable = cur.selection() || !theSelection().empty();
2142 case LFUN_PARAGRAPH_MOVE_UP:
2143 enable = cur.pit() > 0 && !cur.selection();
2146 case LFUN_PARAGRAPH_MOVE_DOWN:
2147 enable = cur.pit() < cur.lastpit() && !cur.selection();
2150 case LFUN_INSET_DISSOLVE:
2151 if (!cmd.argument().empty()) {
2152 InsetLayout il = cur.inset().getLayout(cur.buffer().params());
2153 enable = cur.inset().lyxCode() == FLEX_CODE
2154 && il.lyxtype() == to_utf8(cmd.argument());
2156 enable = !isMainText(cur.bv().buffer())
2157 && cur.inset().nargs() == 1;
2161 case LFUN_CHANGE_ACCEPT:
2162 case LFUN_CHANGE_REJECT:
2163 // TODO: context-sensitive enabling of LFUN_CHANGE_ACCEPT/REJECT
2164 // In principle, these LFUNs should only be enabled if there
2165 // is a change at the current position/in the current selection.
2166 // However, without proper optimizations, this will inevitably
2167 // result in unacceptable performance - just imagine a user who
2168 // wants to select the complete content of a long document.
2172 case LFUN_OUTLINE_UP:
2173 case LFUN_OUTLINE_DOWN:
2174 case LFUN_OUTLINE_IN:
2175 case LFUN_OUTLINE_OUT:
2176 enable = (cur.paragraph().layout().toclevel != Layout::NOT_IN_TOC);
2179 case LFUN_NEWLINE_INSERT:
2180 // LaTeX restrictions (labels or empty par)
2181 enable = (cur.pos() > cur.paragraph().beginOfBody());
2184 case LFUN_WORD_DELETE_FORWARD:
2185 case LFUN_WORD_DELETE_BACKWARD:
2186 case LFUN_LINE_DELETE:
2187 case LFUN_WORD_FORWARD:
2188 case LFUN_WORD_BACKWARD:
2189 case LFUN_WORD_RIGHT:
2190 case LFUN_WORD_LEFT:
2191 case LFUN_CHAR_FORWARD:
2192 case LFUN_CHAR_FORWARD_SELECT:
2193 case LFUN_CHAR_BACKWARD:
2194 case LFUN_CHAR_BACKWARD_SELECT:
2195 case LFUN_CHAR_LEFT:
2196 case LFUN_CHAR_LEFT_SELECT:
2197 case LFUN_CHAR_RIGHT:
2198 case LFUN_CHAR_RIGHT_SELECT:
2200 case LFUN_UP_SELECT:
2202 case LFUN_DOWN_SELECT:
2203 case LFUN_PARAGRAPH_UP_SELECT:
2204 case LFUN_PARAGRAPH_DOWN_SELECT:
2205 case LFUN_LINE_BEGIN_SELECT:
2206 case LFUN_LINE_END_SELECT:
2207 case LFUN_WORD_FORWARD_SELECT:
2208 case LFUN_WORD_BACKWARD_SELECT:
2209 case LFUN_WORD_RIGHT_SELECT:
2210 case LFUN_WORD_LEFT_SELECT:
2211 case LFUN_WORD_SELECT:
2212 case LFUN_PARAGRAPH_UP:
2213 case LFUN_PARAGRAPH_DOWN:
2214 case LFUN_LINE_BEGIN:
2216 case LFUN_CHAR_DELETE_FORWARD:
2217 case LFUN_DELETE_FORWARD_SKIP:
2218 case LFUN_CHAR_DELETE_BACKWARD:
2219 case LFUN_DELETE_BACKWARD_SKIP:
2220 case LFUN_BREAK_PARAGRAPH:
2221 case LFUN_BREAK_PARAGRAPH_SKIP:
2222 case LFUN_PARAGRAPH_SPACING:
2223 case LFUN_INSET_INSERT:
2224 case LFUN_WORD_UPCASE:
2225 case LFUN_WORD_LOWCASE:
2226 case LFUN_WORD_CAPITALIZE:
2227 case LFUN_CHARS_TRANSPOSE:
2228 case LFUN_SERVER_GET_XY:
2229 case LFUN_SERVER_SET_XY:
2230 case LFUN_SERVER_GET_LAYOUT:
2232 case LFUN_DATE_INSERT:
2233 case LFUN_SELF_INSERT:
2234 case LFUN_LINE_INSERT:
2235 case LFUN_NEWPAGE_INSERT:
2236 case LFUN_MATH_DISPLAY:
2237 case LFUN_MATH_IMPORT_SELECTION:
2238 case LFUN_MATH_MODE:
2239 case LFUN_MATH_MACRO:
2240 case LFUN_MATH_MATRIX:
2241 case LFUN_MATH_DELIM:
2242 case LFUN_MATH_BIGDELIM:
2243 case LFUN_MATH_INSERT:
2244 case LFUN_MATH_SUBSCRIPT:
2245 case LFUN_MATH_SUPERSCRIPT:
2246 case LFUN_FONT_DEFAULT:
2247 case LFUN_FONT_UNDERLINE:
2248 case LFUN_FONT_SIZE:
2250 case LFUN_FONT_FREE_APPLY:
2251 case LFUN_FONT_FREE_UPDATE:
2252 case LFUN_LAYOUT_PARAGRAPH:
2253 case LFUN_PARAGRAPH_UPDATE:
2254 case LFUN_ACCENT_UMLAUT:
2255 case LFUN_ACCENT_CIRCUMFLEX:
2256 case LFUN_ACCENT_GRAVE:
2257 case LFUN_ACCENT_ACUTE:
2258 case LFUN_ACCENT_TILDE:
2259 case LFUN_ACCENT_CEDILLA:
2260 case LFUN_ACCENT_MACRON:
2261 case LFUN_ACCENT_DOT:
2262 case LFUN_ACCENT_UNDERDOT:
2263 case LFUN_ACCENT_UNDERBAR:
2264 case LFUN_ACCENT_CARON:
2265 case LFUN_ACCENT_SPECIAL_CARON:
2266 case LFUN_ACCENT_BREVE:
2267 case LFUN_ACCENT_TIE:
2268 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
2269 case LFUN_ACCENT_CIRCLE:
2270 case LFUN_ACCENT_OGONEK:
2271 case LFUN_THESAURUS_ENTRY:
2272 case LFUN_PARAGRAPH_PARAMS_APPLY:
2273 case LFUN_PARAGRAPH_PARAMS:
2275 case LFUN_BUFFER_END:
2276 case LFUN_BUFFER_BEGIN:
2277 case LFUN_BUFFER_BEGIN_SELECT:
2278 case LFUN_BUFFER_END_SELECT:
2279 case LFUN_UNICODE_INSERT:
2280 case LFUN_SET_GRAPHICS_GROUP:
2281 // these are handled in our dispatch()
2290 && (cur.empty() || !cur.inset().insetAllowed(code)))
2293 flag.enabled(enable);
2298 void Text::pasteString(Cursor & cur, docstring const & clip,
2301 cur.clearSelection();
2302 if (!clip.empty()) {
2305 insertStringAsParagraphs(cur, clip);
2307 insertStringAsLines(cur, clip);