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.
20 #include "BranchList.h"
21 #include "FloatList.h"
22 #include "FuncStatus.h"
24 #include "buffer_funcs.h"
25 #include "BufferParams.h"
26 #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 "ParagraphParameters.h"
44 #include "SpellChecker.h"
45 #include "TextClass.h"
46 #include "TextMetrics.h"
47 #include "Thesaurus.h"
48 #include "WordLangTuple.h"
50 #include "frontends/alert.h"
51 #include "frontends/Application.h"
52 #include "frontends/Clipboard.h"
53 #include "frontends/Selection.h"
55 #include "insets/InsetArgument.h"
56 #include "insets/InsetCollapsible.h"
57 #include "insets/InsetCommand.h"
58 #include "insets/InsetExternal.h"
59 #include "insets/InsetFloat.h"
60 #include "insets/InsetFloatList.h"
61 #include "insets/InsetGraphics.h"
62 #include "insets/InsetGraphicsParams.h"
63 #include "insets/InsetInfo.h"
64 #include "insets/InsetIPAMacro.h"
65 #include "insets/InsetNewline.h"
66 #include "insets/InsetQuotes.h"
67 #include "insets/InsetSpecialChar.h"
68 #include "insets/InsetText.h"
69 #include "insets/InsetWrap.h"
71 #include "support/convert.h"
72 #include "support/debug.h"
73 #include "support/filetools.h"
74 #include "support/gettext.h"
75 #include "support/lassert.h"
76 #include "support/limited_stack.h"
77 #include "support/lstrings.h"
78 #include "support/lyxalgo.h"
79 #include "support/lyxtime.h"
80 #include "support/os.h"
81 #include "support/regex.h"
83 #include "mathed/InsetMathHull.h"
84 #include "mathed/InsetMathMacroTemplate.h"
91 using namespace lyx::support;
95 using cap::copySelection;
96 using cap::copySelectionToTemp;
97 using cap::cutSelection;
98 using cap::cutSelectionToTemp;
99 using cap::pasteFromStack;
100 using cap::pasteFromTemp;
101 using cap::pasteClipboardText;
102 using cap::pasteClipboardGraphics;
103 using cap::replaceSelection;
104 using cap::grabAndEraseSelection;
105 using cap::selClearOrDel;
106 using cap::pasteSimpleText;
107 using frontend::Clipboard;
110 typedef limited_stack<pair<docstring, Font>> FontStack;
111 static FontStack freeFonts(15);
112 static bool toggleall = false;
114 static void toggleAndShow(Cursor & cur, Text * text,
115 Font const & font, bool togall = true)
117 text->toggleFree(cur, font, togall);
119 if (font.language() != ignore_language ||
120 font.fontInfo().number() != FONT_IGNORE) {
121 TextMetrics const & tm = cur.bv().textMetrics(text);
122 if (cur.boundary() != tm.isRTLBoundary(cur.pit(), cur.pos(),
123 cur.real_current_font))
124 text->setCursor(cur, cur.pit(), cur.pos(),
125 false, !cur.boundary());
130 static void moveCursor(Cursor & cur, bool selecting)
132 if (selecting || cur.mark())
137 static void finishChange(Cursor & cur, bool selecting)
140 moveCursor(cur, selecting);
144 static void mathDispatch(Cursor & cur, FuncRequest const & cmd)
147 docstring sel = cur.selectionAsString(false);
149 // It may happen that sel is empty but there is a selection
150 replaceSelection(cur);
152 // Is this a valid formula?
156 #ifdef ENABLE_ASSERTIONS
157 const int old_pos = cur.pos();
159 cur.insert(new InsetMathHull(cur.buffer(), hullSimple));
160 #ifdef ENABLE_ASSERTIONS
161 LATTEST(old_pos == cur.pos());
163 cur.nextInset()->edit(cur, true);
164 if (cmd.action() != LFUN_MATH_MODE)
165 // LFUN_MATH_MODE has a different meaning in math mode
168 InsetMathHull * formula = new InsetMathHull(cur.buffer());
169 string const selstr = to_utf8(sel);
170 istringstream is(selstr);
173 if (!formula->readQuiet(lex)) {
174 // No valid formula, let's try with delims
175 is.str("$" + selstr + "$");
177 if (!formula->readQuiet(lex)) {
178 // Still not valid, leave it as is
186 cur.nextInset()->edit(cur, true);
187 LASSERT(cur.inMathed(), return);
191 cur.pos() = cur.lastpos();
192 if (cmd.action() != LFUN_MATH_MODE)
193 // LFUN_MATH_MODE has a different meaning in math mode
195 cur.clearSelection();
196 cur.pos() = cur.lastpos();
200 cur.message(from_utf8(N_("Math editor mode")));
202 cur.message(from_utf8(N_("No valid math formula")));
206 void regexpDispatch(Cursor & cur, FuncRequest const & cmd)
208 LASSERT(cmd.action() == LFUN_REGEXP_MODE, return);
209 if (cur.inRegexped()) {
210 cur.message(_("Already in regular expression mode"));
214 docstring sel = cur.selectionAsString(false);
216 // It may happen that sel is empty but there is a selection
217 replaceSelection(cur);
219 cur.insert(new InsetMathHull(cur.buffer(), hullRegexp));
220 cur.nextInset()->edit(cur, true);
223 cur.message(_("Regexp editor mode"));
227 static void specialChar(Cursor & cur, InsetSpecialChar::Kind kind)
230 cap::replaceSelection(cur);
231 cur.insert(new InsetSpecialChar(kind));
236 static void ipaChar(Cursor & cur, InsetIPAChar::Kind kind)
239 cap::replaceSelection(cur);
240 cur.insert(new InsetIPAChar(kind));
245 static bool doInsertInset(Cursor & cur, Text * text,
246 FuncRequest const & cmd, bool edit, bool pastesel)
248 Buffer & buffer = cur.bv().buffer();
249 BufferParams const & bparams = buffer.params();
250 Inset * inset = createInset(&buffer, cmd);
254 if (InsetCollapsible * ci = inset->asInsetCollapsible())
255 ci->setButtonLabel();
258 if (cmd.action() == LFUN_ARGUMENT_INSERT) {
259 bool cotextinsert = false;
260 InsetArgument const * const ia = static_cast<InsetArgument const *>(inset);
261 Layout const & lay = cur.paragraph().layout();
262 Layout::LaTeXArgMap args = lay.args();
263 Layout::LaTeXArgMap::const_iterator const lait = args.find(ia->name());
264 if (lait != args.end())
265 cotextinsert = (*lait).second.insertcotext;
267 InsetLayout const & il = cur.inset().getLayout();
269 Layout::LaTeXArgMap::const_iterator const ilait = args.find(ia->name());
270 if (ilait != args.end())
271 cotextinsert = (*ilait).second.insertcotext;
273 // The argument requests to insert a copy of the co-text to the inset
276 // If we have a selection within a paragraph, use this
277 if (cur.selection() && cur.selBegin().pit() == cur.selEnd().pit())
278 ds = cur.selectionAsString(false);
279 // else use the whole paragraph
281 ds = cur.paragraph().asString();
282 text->insertInset(cur, inset);
284 inset->edit(cur, true);
285 // Now put co-text into inset
286 Font const f(inherit_font, cur.current_font.language());
288 cur.text()->insertStringAsLines(cur, ds, f);
289 cur.leaveInset(*inset);
296 bool move_layout = false;
297 if (cur.selection()) {
298 if (cmd.action() == LFUN_INDEX_INSERT)
299 copySelectionToTemp(cur);
301 cutSelectionToTemp(cur, pastesel);
302 /* Move layout information inside the inset if the whole
303 * paragraph and the inset allows setting layout
304 * FIXME: this does not work as expected when change tracking is on
305 * However, we do not really know what to do in this case.
307 if (cur.paragraph().empty() && !inset->forcePlainLayout()) {
308 cur.paragraph().setPlainOrDefaultLayout(bparams.documentClass());
312 cur.clearSelection();
314 } else if (cmd.action() == LFUN_INDEX_INSERT) {
315 gotsel = text->selectWordWhenUnderCursor(cur, WHOLE_WORD);
316 copySelectionToTemp(cur);
317 cur.clearSelection();
319 text->insertInset(cur, inset);
322 inset->edit(cur, true);
324 if (!gotsel || !pastesel)
327 pasteFromTemp(cur, cur.buffer()->errorList("Paste"));
328 cur.buffer()->errors("Paste");
329 cur.clearSelection(); // bug 393
331 InsetText * inset_text = inset->asInsetText();
333 inset_text->fixParagraphsFont();
336 /* If the containing paragraph has kept its layout, reset the
337 * layout of the first paragraph of the inset.
340 cur.paragraph().setPlainOrDefaultLayout(bparams.documentClass());
341 // FIXME: what does this do?
342 if (cmd.action() == LFUN_FLEX_INSERT)
345 cur.leaveInset(*inset);
346 if (cmd.action() == LFUN_PREVIEW_INSERT
347 || cmd.action() == LFUN_IPA_INSERT)
349 notifyCursorLeavesOrEnters(old, cur);
351 cur.leaveInset(*inset);
352 // reset surrounding par to default
353 DocumentClass const & dc = bparams.documentClass();
354 docstring const layoutname = inset->usePlainLayout()
355 ? dc.plainLayoutName()
356 : dc.defaultLayoutName();
357 text->setLayout(cur, layoutname);
363 /// the type of outline operation
365 OutlineUp, // Move this header with text down
366 OutlineDown, // Move this header with text up
367 OutlineIn, // Make this header deeper
368 OutlineOut // Make this header shallower
372 static void insertSeparator(Cursor const & cur, depth_type const depth)
374 Buffer & buf = *cur.buffer();
375 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_BREAK));
376 DocumentClass const & tc = buf.params().documentClass();
377 lyx::dispatch(FuncRequest(LFUN_LAYOUT, from_ascii("\"") + tc.plainLayout().name()
378 + from_ascii("\" ignoreautonests")));
379 // FIXME: Bibitem mess!
380 if (cur.prevInset() && cur.prevInset()->lyxCode() == BIBITEM_CODE)
381 lyx::dispatch(FuncRequest(LFUN_CHAR_DELETE_BACKWARD));
382 lyx::dispatch(FuncRequest(LFUN_SEPARATOR_INSERT, "plain"));
383 while (cur.paragraph().params().depth() > depth)
384 lyx::dispatch(FuncRequest(LFUN_DEPTH_DECREMENT));
388 static void outline(OutlineOp mode, Cursor & cur, Text * text)
390 Buffer & buf = *cur.buffer();
391 pit_type & pit = cur.pit();
392 ParagraphList & pars = buf.text().paragraphs();
393 ParagraphList::iterator const bgn = pars.begin();
394 // The first paragraph of the area to be copied:
395 ParagraphList::iterator start = pars.iterator_at(pit);
396 // The final paragraph of area to be copied:
397 ParagraphList::iterator finish = start;
398 ParagraphList::iterator const end = pars.end();
399 depth_type const current_depth = cur.paragraph().params().depth();
401 int const thistoclevel = buf.text().getTocLevel(distance(bgn, start));
404 // Move out (down) from this section header
408 // Seek the one (on same level) below
409 for (; finish != end; ++finish) {
410 toclevel = buf.text().getTocLevel(distance(bgn, finish));
411 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
417 if (start == pars.begin())
420 ParagraphList::iterator dest = start;
421 // Move out (up) from this header
424 // Search previous same-level header above
427 toclevel = buf.text().getTocLevel(distance(bgn, dest));
429 && (toclevel == Layout::NOT_IN_TOC
430 || toclevel > thistoclevel));
431 // Not found; do nothing
432 if (toclevel == Layout::NOT_IN_TOC || toclevel > thistoclevel)
434 pit_type newpit = distance(bgn, dest);
435 pit_type const len = distance(start, finish);
436 pit_type const deletepit = pit + len;
437 buf.undo().recordUndo(cur, newpit, deletepit - 1);
438 // If we move an environment upwards, make sure it is
439 // separated from its new neighbour below:
440 // If an environment of the same layout follows, and the moved
441 // paragraph sequence does not end with a separator, insert one.
442 ParagraphList::iterator lastmoved = finish;
444 if (start->layout().isEnvironment()
445 && dest->layout() == start->layout()
446 && !lastmoved->isEnvSeparator(lastmoved->beginOfBody())) {
447 cur.pit() = distance(bgn, lastmoved);
448 cur.pos() = cur.lastpos();
449 insertSeparator(cur, current_depth);
452 // Likewise, if we moved an environment upwards, make sure it
453 // is separated from its new neighbour above.
454 // The paragraph before the target of movement
456 ParagraphList::iterator before = dest;
458 // Get the parent paragraph (outer in nested context)
459 pit_type const parent =
460 before->params().depth() > current_depth
461 ? text->depthHook(distance(bgn, before), current_depth)
462 : distance(bgn, before);
463 // If a environment with same layout preceeds the moved one in the new
464 // position, and there is no separator yet, insert one.
465 if (start->layout().isEnvironment()
466 && pars[parent].layout() == start->layout()
467 && !before->isEnvSeparator(before->beginOfBody())) {
468 cur.pit() = distance(bgn, before);
469 cur.pos() = cur.lastpos();
470 insertSeparator(cur, current_depth);
474 newpit = distance(bgn, dest);
475 pars.splice(dest, start, finish);
483 // Go one down from *this* header:
484 ParagraphList::iterator dest = next(finish, 1);
485 // Go further down to find header to insert in front of:
486 for (; dest != end; ++dest) {
487 toclevel = buf.text().getTocLevel(distance(bgn, dest));
488 if (toclevel != Layout::NOT_IN_TOC
489 && toclevel <= thistoclevel)
492 // One such was found, so go on...
493 // If we move an environment downwards, make sure it is
494 // separated from its new neighbour above.
495 pit_type newpit = distance(bgn, dest);
496 buf.undo().recordUndo(cur, pit, newpit - 1);
497 // The paragraph before the target of movement
498 ParagraphList::iterator before = dest;
500 // Get the parent paragraph (outer in nested context)
501 pit_type const parent =
502 before->params().depth() > current_depth
503 ? text->depthHook(distance(bgn, before), current_depth)
504 : distance(bgn, before);
505 // If a environment with same layout preceeds the moved one in the new
506 // position, and there is no separator yet, insert one.
507 if (start->layout().isEnvironment()
508 && pars[parent].layout() == start->layout()
509 && !before->isEnvSeparator(before->beginOfBody())) {
510 cur.pit() = distance(bgn, before);
511 cur.pos() = cur.lastpos();
512 insertSeparator(cur, current_depth);
515 // Likewise, make sure moved environments are separated
516 // from their new neighbour below:
517 // If an environment of the same layout follows, and the moved
518 // paragraph sequence does not end with a separator, insert one.
519 ParagraphList::iterator lastmoved = finish;
522 && start->layout().isEnvironment()
523 && dest->layout() == start->layout()
524 && !lastmoved->isEnvSeparator(lastmoved->beginOfBody())) {
525 cur.pit() = distance(bgn, lastmoved);
526 cur.pos() = cur.lastpos();
527 insertSeparator(cur, current_depth);
530 newpit = distance(bgn, dest);
531 pit_type const len = distance(start, finish);
532 pars.splice(dest, start, finish);
533 cur.pit() = newpit - len;
538 pit_type const len = distance(start, finish);
539 buf.undo().recordUndo(cur, pit, pit + len - 1);
540 for (; start != finish; ++start) {
541 toclevel = buf.text().getTocLevel(distance(bgn, start));
542 if (toclevel == Layout::NOT_IN_TOC)
545 DocumentClass const & tc = buf.params().documentClass();
546 int const newtoclevel =
547 (mode == OutlineIn ? toclevel + 1 : toclevel - 1);
548 LabelType const oldlabeltype = start->layout().labeltype;
550 for (auto const & lay : tc) {
551 if (lay.toclevel == newtoclevel &&
552 lay.labeltype == oldlabeltype) {
553 start->setLayout(lay);
564 void Text::number(Cursor & cur)
566 FontInfo font = ignore_font;
567 font.setNumber(FONT_TOGGLE);
568 toggleAndShow(cur, this, Font(font, ignore_language));
572 bool Text::isRTL(pit_type const pit) const
574 Buffer const & buffer = owner_->buffer();
575 return pars_[pit].isRTL(buffer.params());
581 Language const * getLanguage(Cursor const & cur, string const & lang)
583 return lang.empty() ? cur.getFont().language() : languages.getLanguage(lang);
587 docstring resolveLayout(docstring layout, DocIterator const & dit)
589 Paragraph const & par = dit.paragraph();
590 DocumentClass const & tclass = dit.buffer()->params().documentClass();
593 layout = tclass.defaultLayoutName();
595 if (dit.inset().forcePlainLayout(dit.idx()))
596 // in this case only the empty layout is allowed
597 layout = tclass.plainLayoutName();
598 else if (par.usePlainLayout()) {
599 // in this case, default layout maps to empty layout
600 if (layout == tclass.defaultLayoutName())
601 layout = tclass.plainLayoutName();
603 // otherwise, the empty layout maps to the default
604 if (layout == tclass.plainLayoutName())
605 layout = tclass.defaultLayoutName();
608 // If the entry is obsolete, use the new one instead.
609 if (tclass.hasLayout(layout)) {
610 docstring const & obs = tclass[layout].obsoleted_by();
614 if (!tclass.hasLayout(layout))
620 bool isAlreadyLayout(docstring const & layout, CursorData const & cur)
622 ParagraphList const & pars = cur.text()->paragraphs();
624 pit_type pit = cur.selBegin().pit();
625 pit_type const epit = cur.selEnd().pit() + 1;
626 for ( ; pit != epit; ++pit)
627 if (pars[pit].layout().name() != layout)
637 void Text::dispatch(Cursor & cur, FuncRequest & cmd)
639 LYXERR(Debug::ACTION, "Text::dispatch: cmd: " << cmd);
641 // Dispatch if the cursor is inside the text. It is not the
642 // case for context menus (bug 5797).
643 if (cur.text() != this) {
648 BufferView * bv = &cur.bv();
649 TextMetrics * tm = &bv->textMetrics(this);
650 if (!tm->contains(cur.pit())) {
651 lyx::dispatch(FuncRequest(LFUN_SCREEN_SHOW_CURSOR));
652 tm = &bv->textMetrics(this);
655 // FIXME: We use the update flag to indicates wether a singlePar or a
656 // full screen update is needed. We reset it here but shall we restore it
658 cur.noScreenUpdate();
660 LBUFERR(this == cur.text());
662 // NOTE: This should NOT be a reference. See commit 94a5481a.
663 CursorSlice const oldTopSlice = cur.top();
664 bool const oldBoundary = cur.boundary();
665 bool const oldSelection = cur.selection();
666 // Signals that, even if needsUpdate == false, an update of the
667 // cursor paragraph is required
668 bool singleParUpdate = lyxaction.funcHasFlag(cmd.action(),
669 LyXAction::SingleParUpdate);
670 // Signals that a full-screen update is required
671 bool needsUpdate = !(lyxaction.funcHasFlag(cmd.action(),
672 LyXAction::NoUpdate) || singleParUpdate);
673 bool const last_misspelled = lyxrc.spellcheck_continuously
674 && cur.paragraph().isMisspelled(cur.pos(), true);
676 FuncCode const act = cmd.action();
679 case LFUN_PARAGRAPH_MOVE_DOWN: {
680 pit_type const pit = cur.pit();
681 cur.recordUndo(pit, pit + 1);
682 pars_.swap(pit, pit + 1);
684 cur.forceBufferUpdate();
689 case LFUN_PARAGRAPH_MOVE_UP: {
690 pit_type const pit = cur.pit();
691 cur.recordUndo(pit - 1, pit);
693 pars_.swap(pit, pit - 1);
696 cur.forceBufferUpdate();
700 case LFUN_APPENDIX: {
701 Paragraph & par = cur.paragraph();
702 bool start = !par.params().startOfAppendix();
704 // FIXME: The code below only makes sense at top level.
705 // Should LFUN_APPENDIX be restricted to top-level paragraphs?
706 // ensure that we have only one start_of_appendix in this document
707 // FIXME: this don't work for multipart document!
708 for (pit_type tmp = 0, end = pars_.size(); tmp != end; ++tmp) {
709 if (pars_[tmp].params().startOfAppendix()) {
710 cur.recordUndo(tmp, tmp);
711 pars_[tmp].params().startOfAppendix(false);
717 par.params().startOfAppendix(start);
719 // we can set the refreshing parameters now
720 cur.forceBufferUpdate();
724 case LFUN_WORD_DELETE_FORWARD:
726 cutSelection(cur, false);
728 deleteWordForward(cur, cmd.getArg(0) == "force");
729 finishChange(cur, false);
732 case LFUN_WORD_DELETE_BACKWARD:
734 cutSelection(cur, false);
736 deleteWordBackward(cur, cmd.getArg(0) == "force");
737 finishChange(cur, false);
740 case LFUN_LINE_DELETE_FORWARD:
742 cutSelection(cur, false);
744 tm->deleteLineForward(cur);
745 finishChange(cur, false);
748 case LFUN_BUFFER_BEGIN:
749 case LFUN_BUFFER_BEGIN_SELECT:
750 needsUpdate |= cur.selHandle(act == LFUN_BUFFER_BEGIN_SELECT);
751 if (cur.depth() == 1)
752 needsUpdate |= cursorTop(cur);
755 cur.screenUpdateFlags(Update::FitCursor);
758 case LFUN_BUFFER_END:
759 case LFUN_BUFFER_END_SELECT:
760 needsUpdate |= cur.selHandle(act == LFUN_BUFFER_END_SELECT);
761 if (cur.depth() == 1)
762 needsUpdate |= cursorBottom(cur);
765 cur.screenUpdateFlags(Update::FitCursor);
768 case LFUN_INSET_BEGIN:
769 case LFUN_INSET_BEGIN_SELECT:
770 needsUpdate |= cur.selHandle(act == LFUN_INSET_BEGIN_SELECT);
771 if (cur.depth() == 1 || !cur.top().at_begin())
772 needsUpdate |= cursorTop(cur);
775 cur.screenUpdateFlags(Update::FitCursor);
779 case LFUN_INSET_END_SELECT:
780 needsUpdate |= cur.selHandle(act == LFUN_INSET_END_SELECT);
781 if (cur.depth() == 1 || !cur.top().at_end())
782 needsUpdate |= cursorBottom(cur);
785 cur.screenUpdateFlags(Update::FitCursor);
788 case LFUN_CHAR_FORWARD:
789 case LFUN_CHAR_FORWARD_SELECT: {
790 //LYXERR0(" LFUN_CHAR_FORWARD[SEL]:\n" << cur);
791 needsUpdate |= cur.selHandle(act == LFUN_CHAR_FORWARD_SELECT);
792 bool const cur_moved = cursorForward(cur);
793 needsUpdate |= cur_moved;
795 if (!cur_moved && oldTopSlice == cur.top()
796 && cur.boundary() == oldBoundary) {
798 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
800 // we will probably be moving out the inset, so we should execute
801 // the depm-mechanism, but only when the cursor has a place to
802 // go outside this inset, i.e. in a slice above.
803 if (cur.depth() > 1 && cur.pos() == cur.lastpos()
804 && cur.pit() == cur.lastpit()) {
805 // The cursor hasn't changed yet. To give the
806 // DEPM the possibility of doing something we must
807 // provide it with two different cursors.
809 dummy.pos() = dummy.pit() = 0;
810 if (cur.bv().checkDepm(dummy, cur))
811 cur.forceBufferUpdate();
817 case LFUN_CHAR_BACKWARD:
818 case LFUN_CHAR_BACKWARD_SELECT: {
819 //lyxerr << "handle LFUN_CHAR_BACKWARD[_SELECT]:\n" << cur << endl;
820 needsUpdate |= cur.selHandle(act == LFUN_CHAR_BACKWARD_SELECT);
821 bool const cur_moved = cursorBackward(cur);
822 needsUpdate |= cur_moved;
824 if (!cur_moved && oldTopSlice == cur.top()
825 && cur.boundary() == oldBoundary) {
827 cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
829 // we will probably be moving out the inset, so we should execute
830 // the depm-mechanism, but only when the cursor has a place to
831 // go outside this inset, i.e. in a slice above.
832 if (cur.depth() > 1 && cur.pos() == 0 && cur.pit() == 0) {
833 // The cursor hasn't changed yet. To give the
834 // DEPM the possibility of doing something we must
835 // provide it with two different cursors.
837 dummy.pos() = cur.lastpos();
838 dummy.pit() = cur.lastpit();
839 if (cur.bv().checkDepm(dummy, cur))
840 cur.forceBufferUpdate();
847 case LFUN_CHAR_LEFT_SELECT:
848 if (lyxrc.visual_cursor) {
849 needsUpdate |= cur.selHandle(act == LFUN_CHAR_LEFT_SELECT);
850 bool const cur_moved = cursorVisLeft(cur);
851 needsUpdate |= cur_moved;
852 if (!cur_moved && oldTopSlice == cur.top()
853 && cur.boundary() == oldBoundary) {
855 cmd = FuncRequest(LFUN_FINISHED_LEFT);
858 if (cur.reverseDirectionNeeded()) {
859 cmd.setAction(cmd.action() == LFUN_CHAR_LEFT_SELECT ?
860 LFUN_CHAR_FORWARD_SELECT : LFUN_CHAR_FORWARD);
862 cmd.setAction(cmd.action() == LFUN_CHAR_LEFT_SELECT ?
863 LFUN_CHAR_BACKWARD_SELECT : LFUN_CHAR_BACKWARD);
870 case LFUN_CHAR_RIGHT:
871 case LFUN_CHAR_RIGHT_SELECT:
872 if (lyxrc.visual_cursor) {
873 needsUpdate |= cur.selHandle(cmd.action() == LFUN_CHAR_RIGHT_SELECT);
874 bool const cur_moved = cursorVisRight(cur);
875 needsUpdate |= cur_moved;
876 if (!cur_moved && oldTopSlice == cur.top()
877 && cur.boundary() == oldBoundary) {
879 cmd = FuncRequest(LFUN_FINISHED_RIGHT);
882 if (cur.reverseDirectionNeeded()) {
883 cmd.setAction(cmd.action() == LFUN_CHAR_RIGHT_SELECT ?
884 LFUN_CHAR_BACKWARD_SELECT : LFUN_CHAR_BACKWARD);
886 cmd.setAction(cmd.action() == LFUN_CHAR_RIGHT_SELECT ?
887 LFUN_CHAR_FORWARD_SELECT : LFUN_CHAR_FORWARD);
896 case LFUN_DOWN_SELECT:
899 // stop/start the selection
900 bool select = cmd.action() == LFUN_DOWN_SELECT ||
901 cmd.action() == LFUN_UP_SELECT;
903 // move cursor up/down
904 bool up = cmd.action() == LFUN_UP_SELECT || cmd.action() == LFUN_UP;
905 bool const atFirstOrLastRow = cur.atFirstOrLastRow(up);
907 if (!atFirstOrLastRow) {
908 needsUpdate |= cur.selHandle(select);
909 cur.upDownInText(up, needsUpdate);
910 needsUpdate |= cur.beforeDispatchCursor().inMathed();
912 pos_type newpos = up ? 0 : cur.lastpos();
913 if (lyxrc.mac_like_cursor_movement && cur.pos() != newpos) {
914 needsUpdate |= cur.selHandle(select);
915 // we do not reset the targetx of the cursor
917 needsUpdate |= bv->checkDepm(cur, bv->cursor());
918 cur.updateTextTargetOffset();
920 cur.forceBufferUpdate();
924 // if the cursor cannot be moved up or down do not remove
925 // the selection right now, but wait for the next dispatch.
927 needsUpdate |= cur.selHandle(select);
928 cur.upDownInText(up, needsUpdate);
935 case LFUN_PARAGRAPH_SELECT:
937 needsUpdate |= setCursor(cur, cur.pit(), 0);
938 needsUpdate |= cur.selHandle(true);
939 if (cur.pos() < cur.lastpos())
940 needsUpdate |= setCursor(cur, cur.pit(), cur.lastpos());
943 case LFUN_PARAGRAPH_UP:
944 case LFUN_PARAGRAPH_UP_SELECT:
945 needsUpdate |= cur.selHandle(cmd.action() == LFUN_PARAGRAPH_UP_SELECT);
946 needsUpdate |= cursorUpParagraph(cur);
949 case LFUN_PARAGRAPH_DOWN:
950 case LFUN_PARAGRAPH_DOWN_SELECT:
951 needsUpdate |= cur.selHandle(cmd.action() == LFUN_PARAGRAPH_DOWN_SELECT);
952 needsUpdate |= cursorDownParagraph(cur);
955 case LFUN_LINE_BEGIN:
956 case LFUN_LINE_BEGIN_SELECT:
957 needsUpdate |= cur.selHandle(cmd.action() == LFUN_LINE_BEGIN_SELECT);
958 needsUpdate |= tm->cursorHome(cur);
962 case LFUN_LINE_END_SELECT:
963 needsUpdate |= cur.selHandle(cmd.action() == LFUN_LINE_END_SELECT);
964 needsUpdate |= tm->cursorEnd(cur);
967 case LFUN_SECTION_SELECT: {
968 Buffer const & buf = *cur.buffer();
969 pit_type const pit = cur.pit();
970 ParagraphList & pars = buf.text().paragraphs();
971 ParagraphList::iterator bgn = pars.begin();
972 // The first paragraph of the area to be selected:
973 ParagraphList::iterator start = pars.iterator_at(pit);
974 // The final paragraph of area to be selected:
975 ParagraphList::iterator finish = start;
976 ParagraphList::iterator end = pars.end();
978 int const thistoclevel = buf.text().getTocLevel(distance(bgn, start));
979 if (thistoclevel == Layout::NOT_IN_TOC)
983 Cursor const old_cur = cur;
984 needsUpdate |= cur.selHandle(true);
986 // Move out (down) from this section header
990 // Seek the one (on same level) below
991 for (; finish != end; ++finish, ++cur.pit()) {
992 int const toclevel = buf.text().getTocLevel(distance(bgn, finish));
993 if (toclevel != Layout::NOT_IN_TOC && toclevel <= thistoclevel)
996 cur.pos() = cur.lastpos();
998 cur.setCurrentFont();
1000 needsUpdate |= cur != old_cur;
1004 case LFUN_WORD_RIGHT:
1005 case LFUN_WORD_RIGHT_SELECT:
1006 if (lyxrc.visual_cursor) {
1007 needsUpdate |= cur.selHandle(cmd.action() == LFUN_WORD_RIGHT_SELECT);
1008 bool const cur_moved = cursorVisRightOneWord(cur);
1009 needsUpdate |= cur_moved;
1010 if (!cur_moved && oldTopSlice == cur.top()
1011 && cur.boundary() == oldBoundary) {
1013 cmd = FuncRequest(LFUN_FINISHED_RIGHT);
1016 if (cur.reverseDirectionNeeded()) {
1017 cmd.setAction(cmd.action() == LFUN_WORD_RIGHT_SELECT ?
1018 LFUN_WORD_BACKWARD_SELECT : LFUN_WORD_BACKWARD);
1020 cmd.setAction(cmd.action() == LFUN_WORD_RIGHT_SELECT ?
1021 LFUN_WORD_FORWARD_SELECT : LFUN_WORD_FORWARD);
1028 case LFUN_WORD_FORWARD:
1029 case LFUN_WORD_FORWARD_SELECT: {
1030 needsUpdate |= cur.selHandle(cmd.action() == LFUN_WORD_FORWARD_SELECT);
1031 bool const cur_moved = cursorForwardOneWord(cur);
1032 needsUpdate |= cur_moved;
1034 if (!cur_moved && oldTopSlice == cur.top()
1035 && cur.boundary() == oldBoundary) {
1037 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
1039 // we will probably be moving out the inset, so we should execute
1040 // the depm-mechanism, but only when the cursor has a place to
1041 // go outside this inset, i.e. in a slice above.
1042 if (cur.depth() > 1 && cur.pos() == cur.lastpos()
1043 && cur.pit() == cur.lastpit()) {
1044 // The cursor hasn't changed yet. To give the
1045 // DEPM the possibility of doing something we must
1046 // provide it with two different cursors.
1048 dummy.pos() = dummy.pit() = 0;
1049 if (cur.bv().checkDepm(dummy, cur))
1050 cur.forceBufferUpdate();
1056 case LFUN_WORD_LEFT:
1057 case LFUN_WORD_LEFT_SELECT:
1058 if (lyxrc.visual_cursor) {
1059 needsUpdate |= cur.selHandle(cmd.action() == LFUN_WORD_LEFT_SELECT);
1060 bool const cur_moved = cursorVisLeftOneWord(cur);
1061 needsUpdate |= cur_moved;
1062 if (!cur_moved && oldTopSlice == cur.top()
1063 && cur.boundary() == oldBoundary) {
1065 cmd = FuncRequest(LFUN_FINISHED_LEFT);
1068 if (cur.reverseDirectionNeeded()) {
1069 cmd.setAction(cmd.action() == LFUN_WORD_LEFT_SELECT ?
1070 LFUN_WORD_FORWARD_SELECT : LFUN_WORD_FORWARD);
1072 cmd.setAction(cmd.action() == LFUN_WORD_LEFT_SELECT ?
1073 LFUN_WORD_BACKWARD_SELECT : LFUN_WORD_BACKWARD);
1080 case LFUN_WORD_BACKWARD:
1081 case LFUN_WORD_BACKWARD_SELECT: {
1082 needsUpdate |= cur.selHandle(cmd.action() == LFUN_WORD_BACKWARD_SELECT);
1083 bool const cur_moved = cursorBackwardOneWord(cur);
1084 needsUpdate |= cur_moved;
1086 if (!cur_moved && oldTopSlice == cur.top()
1087 && cur.boundary() == oldBoundary) {
1089 cmd = FuncRequest(LFUN_FINISHED_BACKWARD);
1091 // we will probably be moving out the inset, so we should execute
1092 // the depm-mechanism, but only when the cursor has a place to
1093 // go outside this inset, i.e. in a slice above.
1094 if (cur.depth() > 1 && cur.pos() == 0
1095 && cur.pit() == 0) {
1096 // The cursor hasn't changed yet. To give the
1097 // DEPM the possibility of doing something we must
1098 // provide it with two different cursors.
1100 dummy.pos() = cur.lastpos();
1101 dummy.pit() = cur.lastpit();
1102 if (cur.bv().checkDepm(dummy, cur))
1103 cur.forceBufferUpdate();
1109 case LFUN_WORD_SELECT: {
1110 selectWord(cur, WHOLE_WORD);
1111 finishChange(cur, true);
1115 case LFUN_NEWLINE_INSERT: {
1116 InsetNewlineParams inp;
1117 docstring arg = cmd.argument();
1118 if (arg == "linebreak")
1119 inp.kind = InsetNewlineParams::LINEBREAK;
1121 inp.kind = InsetNewlineParams::NEWLINE;
1122 cap::replaceSelection(cur);
1124 cur.insert(new InsetNewline(inp));
1126 moveCursor(cur, false);
1130 case LFUN_TAB_INSERT: {
1131 bool const multi_par_selection = cur.selection() &&
1132 cur.selBegin().pit() != cur.selEnd().pit();
1133 if (multi_par_selection) {
1134 // If there is a multi-paragraph selection, a tab is inserted
1135 // at the beginning of each paragraph.
1136 cur.recordUndoSelection();
1137 pit_type const pit_end = cur.selEnd().pit();
1138 for (pit_type pit = cur.selBegin().pit(); pit <= pit_end; pit++) {
1139 pars_[pit].insertChar(0, '\t',
1140 bv->buffer().params().track_changes);
1141 // Update the selection pos to make sure the selection does not
1142 // change as the inserted tab will increase the logical pos.
1143 if (cur.realAnchor().pit() == pit)
1144 cur.realAnchor().forwardPos();
1145 if (cur.pit() == pit)
1150 // Maybe we shouldn't allow tabs within a line, because they
1151 // are not (yet) aligned as one might do expect.
1152 FuncRequest ncmd(LFUN_SELF_INSERT, from_ascii("\t"));
1153 dispatch(cur, ncmd);
1158 case LFUN_TAB_DELETE: {
1159 bool const tc = bv->buffer().params().track_changes;
1160 if (cur.selection()) {
1161 // If there is a selection, a tab (if present) is removed from
1162 // the beginning of each paragraph.
1163 cur.recordUndoSelection();
1164 pit_type const pit_end = cur.selEnd().pit();
1165 for (pit_type pit = cur.selBegin().pit(); pit <= pit_end; pit++) {
1166 Paragraph & par = paragraphs()[pit];
1169 char_type const c = par.getChar(0);
1170 if (c == '\t' || c == ' ') {
1171 // remove either 1 tab or 4 spaces.
1172 int const n = (c == ' ' ? 4 : 1);
1173 for (int i = 0; i < n
1174 && !par.empty() && par.getChar(0) == c; ++i) {
1175 if (cur.pit() == pit)
1177 if (cur.realAnchor().pit() == pit
1178 && cur.realAnchor().pos() > 0 )
1179 cur.realAnchor().backwardPos();
1180 par.eraseChar(0, tc);
1186 // If there is no selection, try to remove a tab or some spaces
1187 // before the position of the cursor.
1188 Paragraph & par = paragraphs()[cur.pit()];
1189 pos_type const pos = cur.pos();
1194 char_type const c = par.getChar(pos - 1);
1198 par.eraseChar(cur.pos(), tc);
1200 for (int n_spaces = 0;
1202 && par.getChar(cur.pos() - 1) == ' '
1206 par.eraseChar(cur.pos(), tc);
1213 case LFUN_CHAR_DELETE_FORWARD:
1214 if (!cur.selection()) {
1215 if (cur.pos() == cur.paragraph().size())
1216 // Par boundary, force full-screen update
1217 singleParUpdate = false;
1218 else if (cmd.getArg(0) != "force" && cur.confirmDeletion()) {
1220 cur.selection(true);
1225 needsUpdate |= erase(cur);
1228 cutSelection(cur, false);
1229 cur.setCurrentFont();
1230 singleParUpdate = false;
1232 moveCursor(cur, false);
1235 case LFUN_CHAR_DELETE_BACKWARD:
1236 if (!cur.selection()) {
1237 if (bv->getIntl().getTransManager().backspace()) {
1238 bool par_boundary = cur.pos() == 0;
1239 bool first_par = cur.pit() == 0;
1240 // Par boundary, full-screen update
1242 singleParUpdate = false;
1243 else if (cmd.getArg(0) != "force" && cur.confirmDeletion(true)) {
1245 cur.selection(true);
1250 needsUpdate |= backspace(cur);
1252 if (par_boundary && !first_par && cur.pos() > 0
1253 && cur.paragraph().isEnvSeparator(cur.pos() - 1)) {
1254 needsUpdate |= backspace(cur);
1259 DocIterator const dit = cur.selectionBegin();
1260 cutSelection(cur, false);
1261 if (cur.buffer()->params().track_changes)
1262 // since we're doing backwards deletion,
1263 // and the selection is not really cut,
1264 // move cursor before selection (#11630)
1266 cur.setCurrentFont();
1267 singleParUpdate = false;
1271 case LFUN_PARAGRAPH_BREAK: {
1272 cap::replaceSelection(cur);
1273 pit_type pit = cur.pit();
1274 Paragraph const & par = pars_[pit];
1275 bool lastpar = (pit == pit_type(pars_.size() - 1));
1276 Paragraph const & nextpar = lastpar ? par : pars_[pit + 1];
1277 pit_type prev = pit > 0 ? depthHook(pit, par.getDepth()) : pit;
1278 if (prev < pit && cur.pos() == par.beginOfBody()
1279 && par.empty() && !par.isEnvSeparator(cur.pos())
1280 && !par.layout().keepempty
1281 && !par.layout().isCommand()
1282 && pars_[prev].layout() != par.layout()
1283 && pars_[prev].layout().isEnvironment()
1284 && !nextpar.isEnvSeparator(nextpar.beginOfBody())) {
1285 if (par.layout().isEnvironment()
1286 && pars_[prev].getDepth() == par.getDepth()) {
1287 docstring const layout = par.layout().name();
1288 DocumentClass const & tc = bv->buffer().params().documentClass();
1289 lyx::dispatch(FuncRequest(LFUN_LAYOUT, tc.plainLayout().name()));
1290 lyx::dispatch(FuncRequest(LFUN_SEPARATOR_INSERT, "plain"));
1291 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_BREAK, "inverse"));
1292 lyx::dispatch(FuncRequest(LFUN_LAYOUT, layout));
1294 lyx::dispatch(FuncRequest(LFUN_SEPARATOR_INSERT, "plain"));
1295 breakParagraph(cur);
1297 Font const f(inherit_font, cur.current_font.language());
1298 pars_[cur.pit() - 1].resetFonts(f);
1300 if (par.isEnvSeparator(cur.pos()) && cmd.getArg(1) != "ignoresep")
1302 breakParagraph(cur, cmd.getArg(0) == "inverse");
1305 // If we have a list and autoinsert item insets,
1307 Layout::LaTeXArgMap args = par.layout().args();
1308 for (auto const & thearg : args) {
1309 Layout::latexarg arg = thearg.second;
1310 if (arg.autoinsert && prefixIs(thearg.first, "item:")) {
1311 FuncRequest cmd2(LFUN_ARGUMENT_INSERT, thearg.first);
1312 lyx::dispatch(cmd2);
1318 case LFUN_INSET_INSERT: {
1321 // We have to avoid triggering InstantPreview loading
1322 // before inserting into the document. See bug #5626.
1323 bool loaded = bv->buffer().isFullyLoaded();
1324 bv->buffer().setFullyLoaded(false);
1325 Inset * inset = createInset(&bv->buffer(), cmd);
1326 bv->buffer().setFullyLoaded(loaded);
1329 // FIXME (Abdel 01/02/2006):
1330 // What follows would be a partial fix for bug 2154:
1331 // http://www.lyx.org/trac/ticket/2154
1332 // This automatically put the label inset _after_ a
1333 // numbered section. It should be possible to extend the mechanism
1334 // to any kind of LateX environement.
1335 // The correct way to fix that bug would be at LateX generation.
1336 // I'll let the code here for reference as it could be used for some
1337 // other feature like "automatic labelling".
1339 Paragraph & par = pars_[cur.pit()];
1340 if (inset->lyxCode() == LABEL_CODE
1341 && !par.layout().counter.empty()) {
1342 // Go to the end of the paragraph
1343 // Warning: Because of Change-Tracking, the last
1344 // position is 'size()' and not 'size()-1':
1345 cur.pos() = par.size();
1346 // Insert a new paragraph
1347 FuncRequest fr(LFUN_PARAGRAPH_BREAK);
1351 if (cur.selection())
1352 cutSelection(cur, false);
1354 cur.forceBufferUpdate();
1355 if (inset->editable() && inset->asInsetText())
1356 inset->edit(cur, true);
1360 // trigger InstantPreview now
1361 if (inset->lyxCode() == EXTERNAL_CODE) {
1362 InsetExternal & ins =
1363 static_cast<InsetExternal &>(*inset);
1364 ins.updatePreview();
1371 case LFUN_INSET_DISSOLVE: {
1372 if (dissolveInset(cur)) {
1374 cur.forceBufferUpdate();
1379 case LFUN_GRAPHICS_SET_GROUP: {
1380 InsetGraphics * ins = graphics::getCurrentGraphicsInset(cur);
1386 string id = to_utf8(cmd.argument());
1387 string grp = graphics::getGroupParams(bv->buffer(), id);
1388 InsetGraphicsParams tmp, inspar = ins->getParams();
1391 inspar.groupId = to_utf8(cmd.argument());
1393 InsetGraphics::string2params(grp, bv->buffer(), tmp);
1394 tmp.filename = inspar.filename;
1398 ins->setParams(inspar);
1402 case LFUN_SPACE_INSERT:
1403 if (cur.paragraph().layout().free_spacing)
1404 insertChar(cur, ' ');
1406 doInsertInset(cur, this, cmd, false, false);
1409 moveCursor(cur, false);
1412 case LFUN_SPECIALCHAR_INSERT: {
1413 string const name = to_utf8(cmd.argument());
1414 if (name == "hyphenation")
1415 specialChar(cur, InsetSpecialChar::HYPHENATION);
1416 else if (name == "allowbreak")
1417 specialChar(cur, InsetSpecialChar::ALLOWBREAK);
1418 else if (name == "ligature-break")
1419 specialChar(cur, InsetSpecialChar::LIGATURE_BREAK);
1420 else if (name == "slash")
1421 specialChar(cur, InsetSpecialChar::SLASH);
1422 else if (name == "nobreakdash")
1423 specialChar(cur, InsetSpecialChar::NOBREAKDASH);
1424 else if (name == "dots")
1425 specialChar(cur, InsetSpecialChar::LDOTS);
1426 else if (name == "end-of-sentence")
1427 specialChar(cur, InsetSpecialChar::END_OF_SENTENCE);
1428 else if (name == "menu-separator")
1429 specialChar(cur, InsetSpecialChar::MENU_SEPARATOR);
1430 else if (name == "lyx")
1431 specialChar(cur, InsetSpecialChar::PHRASE_LYX);
1432 else if (name == "tex")
1433 specialChar(cur, InsetSpecialChar::PHRASE_TEX);
1434 else if (name == "latex")
1435 specialChar(cur, InsetSpecialChar::PHRASE_LATEX);
1436 else if (name == "latex2e")
1437 specialChar(cur, InsetSpecialChar::PHRASE_LATEX2E);
1438 else if (name.empty())
1439 lyxerr << "LyX function 'specialchar-insert' needs an argument." << endl;
1441 lyxerr << "Wrong argument for LyX function 'specialchar-insert'." << endl;
1445 case LFUN_IPAMACRO_INSERT: {
1446 string const arg = cmd.getArg(0);
1447 if (arg == "deco") {
1448 // Open the inset, and move the current selection
1450 doInsertInset(cur, this, cmd, true, true);
1452 // Some insets are numbered, others are shown in the outline pane so
1453 // let's update the labels and the toc backend.
1454 cur.forceBufferUpdate();
1457 if (arg == "tone-falling")
1458 ipaChar(cur, InsetIPAChar::TONE_FALLING);
1459 else if (arg == "tone-rising")
1460 ipaChar(cur, InsetIPAChar::TONE_RISING);
1461 else if (arg == "tone-high-rising")
1462 ipaChar(cur, InsetIPAChar::TONE_HIGH_RISING);
1463 else if (arg == "tone-low-rising")
1464 ipaChar(cur, InsetIPAChar::TONE_LOW_RISING);
1465 else if (arg == "tone-high-rising-falling")
1466 ipaChar(cur, InsetIPAChar::TONE_HIGH_RISING_FALLING);
1467 else if (arg.empty())
1468 lyxerr << "LyX function 'ipamacro-insert' needs an argument." << endl;
1470 lyxerr << "Wrong argument for LyX function 'ipamacro-insert'." << endl;
1474 case LFUN_WORD_UPCASE:
1475 changeCase(cur, text_uppercase, cmd.getArg(0) == "partial");
1478 case LFUN_WORD_LOWCASE:
1479 changeCase(cur, text_lowercase, cmd.getArg(0) == "partial");
1482 case LFUN_WORD_CAPITALIZE:
1483 changeCase(cur, text_capitalization, cmd.getArg(0) == "partial");
1486 case LFUN_CHARS_TRANSPOSE:
1487 charsTranspose(cur);
1491 cur.message(_("Paste"));
1492 LASSERT(cur.selBegin().idx() == cur.selEnd().idx(), break);
1493 cap::replaceSelection(cur);
1495 // without argument?
1496 string const arg = to_utf8(cmd.argument());
1498 bool tryGraphics = true;
1499 if (theClipboard().isInternal())
1500 pasteFromStack(cur, bv->buffer().errorList("Paste"), 0);
1501 else if (theClipboard().hasTextContents()) {
1502 if (pasteClipboardText(cur, bv->buffer().errorList("Paste"),
1503 true, Clipboard::AnyTextType))
1504 tryGraphics = false;
1506 if (tryGraphics && theClipboard().hasGraphicsContents())
1507 pasteClipboardGraphics(cur, bv->buffer().errorList("Paste"));
1508 } else if (isStrUnsignedInt(arg)) {
1509 // we have a numerical argument
1510 pasteFromStack(cur, bv->buffer().errorList("Paste"),
1511 convert<unsigned int>(arg));
1512 } else if (arg == "html" || arg == "latex") {
1513 Clipboard::TextType type = (arg == "html") ?
1514 Clipboard::HtmlTextType : Clipboard::LaTeXTextType;
1515 pasteClipboardText(cur, bv->buffer().errorList("Paste"), true, type);
1517 Clipboard::GraphicsType type = Clipboard::AnyGraphicsType;
1519 type = Clipboard::PdfGraphicsType;
1520 else if (arg == "png")
1521 type = Clipboard::PngGraphicsType;
1522 else if (arg == "jpeg")
1523 type = Clipboard::JpegGraphicsType;
1524 else if (arg == "linkback")
1525 type = Clipboard::LinkBackGraphicsType;
1526 else if (arg == "emf")
1527 type = Clipboard::EmfGraphicsType;
1528 else if (arg == "wmf")
1529 type = Clipboard::WmfGraphicsType;
1531 // we also check in getStatus()
1532 LYXERR0("Unrecognized graphics type: " << arg);
1534 pasteClipboardGraphics(cur, bv->buffer().errorList("Paste"), type);
1537 bv->buffer().errors("Paste");
1538 bv->buffer().updatePreviews(); // bug 11619
1539 cur.clearSelection(); // bug 393
1545 cutSelection(cur, true);
1546 cur.message(_("Cut"));
1551 cur.message(_("Copy"));
1554 case LFUN_SERVER_GET_XY:
1555 cur.message(from_utf8(
1556 convert<string>(tm->cursorX(cur.top(), cur.boundary()))
1557 + ' ' + convert<string>(tm->cursorY(cur.top(), cur.boundary()))));
1560 case LFUN_SERVER_SET_XY: {
1563 istringstream is(to_utf8(cmd.argument()));
1566 lyxerr << "SETXY: Could not parse coordinates in '"
1567 << to_utf8(cmd.argument()) << endl;
1569 tm->setCursorFromCoordinates(cur, x, y);
1573 case LFUN_SERVER_GET_LAYOUT:
1574 cur.message(cur.paragraph().layout().name());
1578 case LFUN_LAYOUT_TOGGLE: {
1579 bool const ignoreautonests = cmd.getArg(1) == "ignoreautonests";
1580 docstring req_layout = ignoreautonests ? from_utf8(cmd.getArg(0)) : cmd.argument();
1581 LYXERR(Debug::INFO, "LFUN_LAYOUT: (arg) " << to_utf8(req_layout));
1583 docstring layout = resolveLayout(req_layout, cur);
1584 if (layout.empty()) {
1585 cur.errorMessage(from_utf8(N_("Layout ")) + req_layout +
1586 from_utf8(N_(" not known")));
1590 docstring const old_layout = cur.paragraph().layout().name();
1591 bool change_layout = !isAlreadyLayout(layout, cur);
1593 if (cmd.action() == LFUN_LAYOUT_TOGGLE && !change_layout) {
1594 change_layout = true;
1595 layout = resolveLayout(docstring(), cur);
1598 if (change_layout) {
1599 setLayout(cur, layout);
1600 if (cur.pit() > 0 && !ignoreautonests) {
1601 pit_type prev_pit = cur.pit() - 1;
1602 depth_type const cur_depth = pars_[cur.pit()].getDepth();
1603 // Scan for the previous par on same nesting level
1604 while (prev_pit > 0 && pars_[prev_pit].getDepth() > cur_depth)
1606 set<docstring> const & autonests =
1607 pars_[prev_pit].layout().autonests();
1608 set<docstring> const & autonested =
1609 pars_[cur.pit()].layout().isAutonestedBy();
1610 if (autonests.find(layout) != autonests.end()
1611 || autonested.find(old_layout) != autonested.end())
1612 lyx::dispatch(FuncRequest(LFUN_DEPTH_INCREMENT));
1616 DocumentClass const & tclass = bv->buffer().params().documentClass();
1617 bool inautoarg = false;
1618 for (auto const & la_pair : tclass[layout].args()) {
1619 Layout::latexarg const & arg = la_pair.second;
1620 if (arg.autoinsert) {
1621 // If we had already inserted an arg automatically,
1622 // leave this now in order to insert the next one.
1624 cur.leaveInset(cur.inset());
1627 FuncRequest const cmd2(LFUN_ARGUMENT_INSERT, la_pair.first);
1628 lyx::dispatch(cmd2);
1636 case LFUN_ENVIRONMENT_SPLIT: {
1637 bool const outer = cmd.argument() == "outer";
1638 bool const previous = cmd.argument() == "previous";
1639 bool const before = cmd.argument() == "before";
1640 bool const normal = cmd.argument().empty();
1641 Paragraph const & para = cur.paragraph();
1643 if (para.layout().isEnvironment())
1644 layout = para.layout().name();
1645 depth_type split_depth = cur.paragraph().params().depth();
1646 depth_type nextpar_depth = 0;
1647 if (outer || previous) {
1648 // check if we have an environment in our scope
1649 pit_type pit = cur.pit();
1650 Paragraph cpar = pars_[pit];
1656 if (layout.empty() && previous
1657 && cpar.layout().isEnvironment()
1658 && cpar.params().depth() <= split_depth)
1659 layout = cpar.layout().name();
1660 if (cpar.params().depth() < split_depth
1661 && cpar.layout().isEnvironment()) {
1663 layout = cpar.layout().name();
1664 split_depth = cpar.params().depth();
1666 if (cpar.params().depth() == 0)
1670 if ((outer || normal) && cur.pit() < cur.lastpit()) {
1671 // save nesting of following paragraph
1672 Paragraph cpar = pars_[cur.pit() + 1];
1673 nextpar_depth = cpar.params().depth();
1676 cur.top().setPitPos(cur.pit(), 0);
1677 if (before || cur.pos() > 0)
1678 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_BREAK));
1679 else if (previous && cur.nextInset() && cur.nextInset()->lyxCode() == SEPARATOR_CODE)
1680 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_BREAK, "inverse ignoresep"));
1682 while (cur.paragraph().params().depth() > split_depth)
1683 lyx::dispatch(FuncRequest(LFUN_DEPTH_DECREMENT));
1685 DocumentClass const & tc = bv->buffer().params().documentClass();
1686 lyx::dispatch(FuncRequest(LFUN_LAYOUT, from_ascii("\"") + tc.plainLayout().name()
1687 + from_ascii("\" ignoreautonests")));
1688 // FIXME: Bibitem mess!
1689 if (cur.prevInset() && cur.prevInset()->lyxCode() == BIBITEM_CODE)
1690 lyx::dispatch(FuncRequest(LFUN_CHAR_DELETE_BACKWARD));
1691 lyx::dispatch(FuncRequest(LFUN_SEPARATOR_INSERT, "plain"));
1694 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_BREAK, "inverse ignoresep"));
1695 while (cur.paragraph().params().depth() < split_depth)
1696 lyx::dispatch(FuncRequest(LFUN_DEPTH_INCREMENT));
1699 lyx::dispatch(FuncRequest(LFUN_PARAGRAPH_BREAK, "inverse"));
1700 lyx::dispatch(FuncRequest(LFUN_LAYOUT, layout));
1701 if ((outer || normal) && nextpar_depth > 0) {
1702 // restore nesting of following paragraph
1703 DocIterator scur = cur;
1704 depth_type const max_depth = cur.paragraph().params().depth() + 1;
1706 while (cur.paragraph().params().depth() < min(nextpar_depth, max_depth)) {
1707 depth_type const olddepth = cur.paragraph().params().depth();
1708 lyx::dispatch(FuncRequest(LFUN_DEPTH_INCREMENT));
1709 if (olddepth == cur.paragraph().params().depth())
1710 // leave loop if no incrementation happens
1713 cur.setCursor(scur);
1719 case LFUN_CLIPBOARD_PASTE:
1720 cap::replaceSelection(cur);
1721 pasteClipboardText(cur, bv->buffer().errorList("Paste"),
1722 cmd.argument() == "paragraph");
1723 bv->buffer().errors("Paste");
1726 case LFUN_CLIPBOARD_PASTE_SIMPLE:
1727 cap::replaceSelection(cur);
1728 pasteSimpleText(cur, cmd.argument() == "paragraph");
1731 case LFUN_PRIMARY_SELECTION_PASTE:
1732 cap::replaceSelection(cur);
1733 pasteString(cur, theSelection().get(),
1734 cmd.argument() == "paragraph");
1737 case LFUN_SELECTION_PASTE:
1738 // Copy the selection buffer to the clipboard stack,
1739 // because we want it to appear in the "Edit->Paste
1741 cap::replaceSelection(cur);
1742 cap::copySelectionToStack();
1743 cap::pasteSelection(bv->cursor(), bv->buffer().errorList("Paste"));
1744 bv->buffer().errors("Paste");
1747 case LFUN_QUOTE_INSERT: {
1748 cap::replaceSelection(cur);
1751 Paragraph const & par = cur.paragraph();
1752 pos_type pos = cur.pos();
1753 // Ignore deleted text before cursor
1754 while (pos > 0 && par.isDeleted(pos - 1))
1757 bool const inner = (cmd.getArg(0) == "single" || cmd.getArg(0) == "inner");
1759 // Guess quote side.
1760 // A space triggers an opening quote. This is passed if the preceding
1761 // char/inset is a space or at paragraph start.
1763 if (pos > 0 && !par.isSpace(pos - 1)) {
1764 if (cur.prevInset() && cur.prevInset()->lyxCode() == QUOTE_CODE) {
1765 // If an opening double quotation mark precedes, and this
1766 // is a single quote, make it opening as well
1768 static_cast<InsetQuotes &>(*cur.prevInset());
1769 string const type = ins.getType();
1770 if (!suffixIs(type, "ld") || !inner)
1771 c = par.getChar(pos - 1);
1773 else if (!cur.prevInset()
1774 || (cur.prevInset() && cur.prevInset()->isChar()))
1775 // If a char precedes, pass that and let InsetQuote decide
1776 c = par.getChar(pos - 1);
1779 if (par.getInset(pos - 1)
1780 && !par.getInset(pos - 1)->isPartOfTextSequence()) {
1781 // skip "invisible" insets
1785 c = par.getChar(pos - 1);
1790 InsetQuotesParams::QuoteLevel const quote_level = inner
1791 ? InsetQuotesParams::SecondaryQuotes : InsetQuotesParams::PrimaryQuotes;
1792 cur.insert(new InsetQuotes(cur.buffer(), c, quote_level, cmd.getArg(1), cmd.getArg(2)));
1793 cur.buffer()->updateBuffer();
1798 case LFUN_MOUSE_TRIPLE:
1799 if (cmd.button() == mouse_button::button1) {
1801 setCursor(cur, cur.pit(), 0);
1804 if (cur.pos() < cur.lastpos())
1805 setCursor(cur, cur.pit(), cur.lastpos());
1811 case LFUN_MOUSE_DOUBLE:
1812 if (cmd.button() == mouse_button::button1) {
1813 selectWord(cur, WHOLE_WORD);
1818 // Single-click on work area
1819 case LFUN_MOUSE_PRESS: {
1820 // We are not marking a selection with the keyboard in any case.
1821 Cursor & bvcur = cur.bv().cursor();
1822 bvcur.setMark(false);
1823 switch (cmd.button()) {
1824 case mouse_button::button1:
1825 if (!bvcur.selection())
1827 bvcur.resetAnchor();
1828 if (!bv->mouseSetCursor(cur, cmd.modifier() == ShiftModifier))
1829 cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1830 if (bvcur.wordSelection())
1831 selectWord(bvcur, WHOLE_WORD);
1834 case mouse_button::button2:
1835 if (lyxrc.mouse_middlebutton_paste) {
1836 // Middle mouse pasting.
1837 bv->mouseSetCursor(cur);
1839 FuncRequest(LFUN_COMMAND_ALTERNATIVES,
1840 "selection-paste ; primary-selection-paste paragraph"));
1842 cur.noScreenUpdate();
1845 case mouse_button::button3: {
1846 // Don't do anything if we right-click a
1847 // selection, a context menu will popup.
1848 if (bvcur.selection() && cur >= bvcur.selectionBegin()
1849 && cur < bvcur.selectionEnd()) {
1850 cur.noScreenUpdate();
1853 if (!bv->mouseSetCursor(cur, false))
1854 cur.screenUpdateFlags(Update::FitCursor);
1860 } // switch (cmd.button())
1863 case LFUN_MOUSE_MOTION: {
1864 // Mouse motion with right or middle mouse do nothing for now.
1865 if (cmd.button() != mouse_button::button1) {
1866 cur.noScreenUpdate();
1869 // ignore motions deeper nested than the real anchor
1870 Cursor & bvcur = cur.bv().cursor();
1871 if (!bvcur.realAnchor().hasPart(cur)) {
1875 CursorSlice old = bvcur.top();
1877 int const wh = bv->workHeight();
1878 int const y = max(0, min(wh - 1, cmd.y()));
1880 tm->setCursorFromCoordinates(cur, cmd.x(), y);
1881 cur.setTargetX(cmd.x());
1882 // Don't allow selecting a separator inset
1883 if (cur.pos() && cur.paragraph().isEnvSeparator(cur.pos() - 1))
1886 lyx::dispatch(FuncRequest(LFUN_DOWN_SELECT));
1887 else if (cmd.y() < 0)
1888 lyx::dispatch(FuncRequest(LFUN_UP_SELECT));
1889 // This is to allow jumping over large insets
1890 if (cur.top() == old) {
1892 lyx::dispatch(FuncRequest(LFUN_DOWN_SELECT));
1893 else if (cmd.y() < 0)
1894 lyx::dispatch(FuncRequest(LFUN_UP_SELECT));
1896 // We continue with our existing selection or start a new one, so don't
1897 // reset the anchor.
1898 bvcur.setCursor(cur);
1899 bvcur.selection(true);
1900 bvcur.setCurrentFont();
1901 if (cur.top() == old) {
1902 // We didn't move one iota, so no need to update the screen.
1903 cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1904 //cur.noScreenUpdate();
1910 case LFUN_MOUSE_RELEASE:
1911 switch (cmd.button()) {
1912 case mouse_button::button1:
1913 // Cursor was set at LFUN_MOUSE_PRESS or LFUN_MOUSE_MOTION time.
1914 // If there is a new selection, update persistent selection;
1915 // otherwise, single click does not clear persistent selection
1917 if (cur.selection()) {
1918 // Finish selection. If double click,
1919 // cur is moved to the end of word by
1920 // selectWord but bvcur is current
1922 cur.bv().cursor().setSelection();
1923 // We might have removed an empty but drawn selection
1924 // (probably a margin)
1925 cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
1927 cur.noScreenUpdate();
1928 // FIXME: We could try to handle drag and drop of selection here.
1931 case mouse_button::button2:
1932 // Middle mouse pasting is handled at mouse press time,
1933 // see LFUN_MOUSE_PRESS.
1934 cur.noScreenUpdate();
1937 case mouse_button::button3:
1938 // Cursor was set at LFUN_MOUSE_PRESS time.
1939 // FIXME: If there is a selection we could try to handle a special
1940 // drag & drop context menu.
1941 cur.noScreenUpdate();
1944 case mouse_button::none:
1945 case mouse_button::button4:
1946 case mouse_button::button5:
1948 } // switch (cmd.button())
1952 case LFUN_SELF_INSERT: {
1953 if (cmd.argument().empty())
1956 // Automatically delete the currently selected
1957 // text and replace it with what is being
1958 // typed in now. Depends on lyxrc settings
1959 // "auto_region_delete", which defaults to
1962 if (lyxrc.auto_region_delete && cur.selection())
1963 cutSelection(cur, false);
1964 cur.clearSelection();
1966 for (char_type c : cmd.argument())
1967 bv->translateAndInsert(c, this, cur);
1970 moveCursor(cur, false);
1971 cur.markNewWordPosition();
1972 bv->bookmarkEditPosition();
1976 case LFUN_HREF_INSERT: {
1977 docstring content = cmd.argument();
1978 if (content.empty() && cur.selection())
1979 content = cur.selectionAsString(false);
1981 InsetCommandParams p(HYPERLINK_CODE);
1982 if (!content.empty()){
1983 // if it looks like a link, we'll put it as target,
1984 // otherwise as name (bug #8792).
1987 // regex_match(to_utf8(content), matches, link_re)
1988 // because smatch stores pointers to the substrings rather
1989 // than making copies of them. And those pointers become
1990 // invalid after regex_match returns, since it is then
1991 // being given a temporary object. (Thanks to Georg for
1992 // figuring that out.)
1993 regex const link_re("^([a-z]+):.*");
1995 string const c = to_utf8(lowercase(content));
1997 if (c.substr(0,7) == "mailto:") {
1998 p["target"] = content;
1999 p["type"] = from_ascii("mailto:");
2000 } else if (regex_match(c, matches, link_re)) {
2001 p["target"] = content;
2002 string protocol = matches.str(1);
2003 if (protocol == "file")
2004 p["type"] = from_ascii("file:");
2006 p["name"] = content;
2008 string const data = InsetCommand::params2string(p);
2010 // we need to have a target. if we already have one, then
2011 // that gets used at the default for the name, too, which
2012 // is probably what is wanted.
2013 if (p["target"].empty()) {
2014 bv->showDialog("href", data);
2016 FuncRequest fr(LFUN_INSET_INSERT, data);
2022 case LFUN_LABEL_INSERT: {
2023 InsetCommandParams p(LABEL_CODE);
2024 // Try to generate a valid label
2025 p["name"] = (cmd.argument().empty()) ?
2026 cur.getPossibleLabel() :
2028 string const data = InsetCommand::params2string(p);
2030 if (cmd.argument().empty()) {
2031 bv->showDialog("label", data);
2033 FuncRequest fr(LFUN_INSET_INSERT, data);
2039 case LFUN_INFO_INSERT: {
2040 if (cmd.argument().empty()) {
2041 bv->showDialog("info", cur.current_font.language()->lang());
2044 inset = createInset(cur.buffer(), cmd);
2048 insertInset(cur, inset);
2049 cur.forceBufferUpdate();
2054 case LFUN_CAPTION_INSERT:
2055 case LFUN_FOOTNOTE_INSERT:
2056 case LFUN_NOTE_INSERT:
2057 case LFUN_BOX_INSERT:
2058 case LFUN_BRANCH_INSERT:
2059 case LFUN_PHANTOM_INSERT:
2060 case LFUN_ERT_INSERT:
2061 case LFUN_LISTING_INSERT:
2062 case LFUN_MARGINALNOTE_INSERT:
2063 case LFUN_ARGUMENT_INSERT:
2064 case LFUN_INDEX_INSERT:
2065 case LFUN_PREVIEW_INSERT:
2066 case LFUN_SCRIPT_INSERT:
2067 case LFUN_IPA_INSERT:
2068 // Open the inset, and move the current selection
2070 doInsertInset(cur, this, cmd, true, true);
2072 if (act == LFUN_SCRIPT_INSERT) {
2073 /* Script insets change the font style in metrics(), and
2074 * this is used to compute the height of the caret
2075 * (because the font is stored in TextMetrics::font_).
2076 * When we insert, we have to make sure that metrics are
2077 * computed so that the caret height is wrong. Arguably,
2078 * this is hackish.*/
2079 bv->processUpdateFlags(Update::SinglePar);
2081 cur.setCurrentFont();
2082 // Some insets are numbered, others are shown in the outline pane so
2083 // let's update the labels and the toc backend.
2084 cur.forceBufferUpdate();
2087 case LFUN_FLEX_INSERT: {
2088 // Open the inset, and move the current selection
2090 bool const sel = cur.selection();
2091 doInsertInset(cur, this, cmd, true, true);
2092 // Insert auto-insert arguments
2093 bool autoargs = false, inautoarg = false;
2094 Layout::LaTeXArgMap args = cur.inset().getLayout().args();
2095 for (auto const & argt : args) {
2096 Layout::latexarg arg = argt.second;
2097 if (!inautoarg && arg.insertonnewline && cur.pos() > 0) {
2098 FuncRequest cmd2(LFUN_PARAGRAPH_BREAK);
2099 lyx::dispatch(cmd2);
2101 if (arg.autoinsert) {
2102 // The cursor might have been invalidated by the replaceSelection.
2103 cur.buffer()->changed(true);
2104 // If we had already inserted an arg automatically,
2105 // leave this now in order to insert the next one.
2107 cur.leaveInset(cur.inset());
2109 if (arg.insertonnewline && cur.pos() > 0) {
2110 FuncRequest cmd2(LFUN_PARAGRAPH_BREAK);
2111 lyx::dispatch(cmd2);
2114 FuncRequest cmd2(LFUN_ARGUMENT_INSERT, argt.first);
2115 lyx::dispatch(cmd2);
2122 cur.leaveInset(cur.inset());
2125 // Some insets are numbered, others are shown in the outline pane so
2126 // let's update the labels and the toc backend.
2127 cur.forceBufferUpdate();
2131 case LFUN_TABULAR_INSERT: {
2132 // if there were no arguments, just open the dialog
2133 if (cmd.argument().empty()) {
2134 bv->showDialog("tabularcreate");
2136 } else if (cur.buffer()->masterParams().tablestyle != "default"
2137 || bv->buffer().params().documentClass().tablestyle() != "default") {
2138 string tabstyle = cur.buffer()->masterParams().tablestyle;
2139 if (tabstyle == "default")
2140 tabstyle = bv->buffer().params().documentClass().tablestyle();
2141 if (!libFileSearch("tabletemplates", tabstyle + ".lyx").empty()) {
2142 FuncRequest fr(LFUN_TABULAR_STYLE_INSERT,
2143 tabstyle + " " + to_ascii(cmd.argument()));
2147 // Unknown style. Report and fall back to default.
2148 cur.errorMessage(from_utf8(N_("Table Style ")) + from_utf8(tabstyle) +
2149 from_utf8(N_(" not known")));
2152 if (doInsertInset(cur, this, cmd, false, true))
2157 case LFUN_TABULAR_STYLE_INSERT: {
2158 string const style = cmd.getArg(0);
2159 string const rows = cmd.getArg(1);
2160 string const cols = cmd.getArg(2);
2161 if (cols.empty() || !isStrInt(cols)
2162 || rows.empty() || !isStrInt(rows))
2164 int const r = convert<int>(rows);
2165 int const c = convert<int>(cols);
2172 FileName const tabstyle = libFileSearch("tabletemplates",
2173 style + suffix + ".lyx", "lyx");
2174 if (tabstyle.empty())
2176 UndoGroupHelper ugh(cur.buffer());
2178 FuncRequest cmd2(LFUN_FILE_INSERT, tabstyle.absFileName() + " ignorelang");
2179 lyx::dispatch(cmd2);
2183 // move one cell up to middle cell
2185 // add the missing rows
2186 int const addrows = r - 3;
2187 for (int i = 0 ; i < addrows ; ++i) {
2188 FuncRequest fr(LFUN_TABULAR_FEATURE, "append-row");
2192 // add the missing columns
2193 int const addcols = c - 1;
2194 for (int i = 0 ; i < addcols ; ++i) {
2195 FuncRequest fr(LFUN_TABULAR_FEATURE, "append-column");
2204 case LFUN_FLOAT_INSERT:
2205 case LFUN_FLOAT_WIDE_INSERT:
2206 case LFUN_WRAP_INSERT: {
2207 // will some content be moved into the inset?
2208 bool const content = cur.selection();
2209 // does the content consist of multiple paragraphs?
2210 bool const singlepar = (cur.selBegin().pit() == cur.selEnd().pit());
2212 doInsertInset(cur, this, cmd, true, true);
2215 // If some single-par content is moved into the inset,
2216 // doInsertInset puts the cursor outside the inset.
2217 // To insert the caption we put it back into the inset.
2218 // FIXME cleanup doInsertInset to avoid such dances!
2219 if (content && singlepar)
2222 ParagraphList & pars = cur.text()->paragraphs();
2224 DocumentClass const & tclass = bv->buffer().params().documentClass();
2226 // add a separate paragraph for the caption inset
2227 pars.push_back(Paragraph());
2228 pars.back().setInsetOwner(&cur.text()->inset());
2229 pars.back().setPlainOrDefaultLayout(tclass);
2230 int cap_pit = pars.size() - 1;
2232 // if an empty inset was created, we create an additional empty
2233 // paragraph at the bottom so that the user can choose where to put
2234 // the graphics (or table).
2236 pars.push_back(Paragraph());
2237 pars.back().setInsetOwner(&cur.text()->inset());
2238 pars.back().setPlainOrDefaultLayout(tclass);
2241 // reposition the cursor to the caption
2242 cur.pit() = cap_pit;
2244 // FIXME: This Text/Cursor dispatch handling is a mess!
2245 // We cannot use Cursor::dispatch here it needs access to up to
2247 FuncRequest cmd_caption(LFUN_CAPTION_INSERT);
2248 doInsertInset(cur, cur.text(), cmd_caption, true, false);
2249 cur.forceBufferUpdate();
2250 cur.screenUpdateFlags(Update::Force);
2251 // FIXME: When leaving the Float (or Wrap) inset we should
2252 // delete any empty paragraph left above or below the
2257 case LFUN_NOMENCL_INSERT: {
2258 InsetCommandParams p(NOMENCL_CODE);
2259 if (cmd.argument().empty()) {
2261 bv->cursor().innerText()->getStringForDialog(bv->cursor());
2262 cur.clearSelection();
2264 p["symbol"] = cmd.argument();
2265 string const data = InsetCommand::params2string(p);
2266 bv->showDialog("nomenclature", data);
2270 case LFUN_INDEX_PRINT: {
2271 InsetCommandParams p(INDEX_PRINT_CODE);
2272 if (cmd.argument().empty())
2273 p["type"] = from_ascii("idx");
2275 p["type"] = cmd.argument();
2276 string const data = InsetCommand::params2string(p);
2277 FuncRequest fr(LFUN_INSET_INSERT, data);
2282 case LFUN_NOMENCL_PRINT:
2283 case LFUN_NEWPAGE_INSERT:
2285 doInsertInset(cur, this, cmd, false, false);
2289 case LFUN_SEPARATOR_INSERT: {
2290 doInsertInset(cur, this, cmd, false, false);
2292 // remove a following space
2293 Paragraph & par = cur.paragraph();
2294 if (cur.pos() != cur.lastpos() && par.isLineSeparator(cur.pos()))
2295 par.eraseChar(cur.pos(), cur.buffer()->params().track_changes);
2299 case LFUN_DEPTH_DECREMENT:
2300 changeDepth(cur, DEC_DEPTH);
2303 case LFUN_DEPTH_INCREMENT:
2304 changeDepth(cur, INC_DEPTH);
2307 case LFUN_REGEXP_MODE:
2308 regexpDispatch(cur, cmd);
2311 case LFUN_MATH_MODE: {
2312 if (cmd.argument() == "on" || cmd.argument() == "") {
2313 // don't pass "on" as argument
2314 // (it would appear literally in the first cell)
2315 docstring sel = cur.selectionAsString(false);
2316 InsetMathMacroTemplate * macro = new InsetMathMacroTemplate(cur.buffer());
2317 // create a macro template if we see "\\newcommand" somewhere, and
2318 // an ordinary formula otherwise
2320 && (sel.find(from_ascii("\\newcommand")) != string::npos
2321 || sel.find(from_ascii("\\newlyxcommand")) != string::npos
2322 || sel.find(from_ascii("\\def")) != string::npos)
2323 && macro->fromString(sel)) {
2325 replaceSelection(cur);
2328 // no meaningful macro template was found
2330 mathDispatch(cur,FuncRequest(LFUN_MATH_MODE));
2333 // The argument is meaningful
2334 // We replace cmd with LFUN_MATH_INSERT because LFUN_MATH_MODE
2335 // has a different meaning in math mode
2336 mathDispatch(cur, FuncRequest(LFUN_MATH_INSERT,cmd.argument()));
2340 case LFUN_MATH_MACRO:
2341 if (cmd.argument().empty())
2342 cur.errorMessage(from_utf8(N_("Missing argument")));
2345 string s = to_utf8(cmd.argument());
2346 string const s1 = token(s, ' ', 1);
2347 int const nargs = s1.empty() ? 0 : convert<int>(s1);
2348 string const s2 = token(s, ' ', 2);
2349 MacroType type = MacroTypeNewcommand;
2351 type = MacroTypeDef;
2352 InsetMathMacroTemplate * inset = new InsetMathMacroTemplate(cur.buffer(),
2353 from_utf8(token(s, ' ', 0)), nargs, false, type);
2354 inset->setBuffer(bv->buffer());
2355 insertInset(cur, inset);
2357 // enter macro inset and select the name
2359 cur.top().pos() = cur.top().lastpos();
2361 cur.selection(true);
2362 cur.top().pos() = 0;
2366 case LFUN_MATH_DISPLAY:
2367 case LFUN_MATH_SUBSCRIPT:
2368 case LFUN_MATH_SUPERSCRIPT:
2369 case LFUN_MATH_INSERT:
2370 case LFUN_MATH_AMS_MATRIX:
2371 case LFUN_MATH_MATRIX:
2372 case LFUN_MATH_DELIM:
2373 case LFUN_MATH_BIGDELIM:
2374 mathDispatch(cur, cmd);
2377 case LFUN_FONT_EMPH: {
2378 Font font(ignore_font, ignore_language);
2379 font.fontInfo().setEmph(FONT_TOGGLE);
2380 toggleAndShow(cur, this, font);
2384 case LFUN_FONT_ITAL: {
2385 Font font(ignore_font, ignore_language);
2386 font.fontInfo().setShape(ITALIC_SHAPE);
2387 toggleAndShow(cur, this, font);
2391 case LFUN_FONT_BOLD:
2392 case LFUN_FONT_BOLDSYMBOL: {
2393 Font font(ignore_font, ignore_language);
2394 font.fontInfo().setSeries(BOLD_SERIES);
2395 toggleAndShow(cur, this, font);
2399 case LFUN_FONT_NOUN: {
2400 Font font(ignore_font, ignore_language);
2401 font.fontInfo().setNoun(FONT_TOGGLE);
2402 toggleAndShow(cur, this, font);
2406 case LFUN_FONT_TYPEWRITER: {
2407 Font font(ignore_font, ignore_language);
2408 font.fontInfo().setFamily(TYPEWRITER_FAMILY); // no good
2409 toggleAndShow(cur, this, font);
2413 case LFUN_FONT_SANS: {
2414 Font font(ignore_font, ignore_language);
2415 font.fontInfo().setFamily(SANS_FAMILY);
2416 toggleAndShow(cur, this, font);
2420 case LFUN_FONT_ROMAN: {
2421 Font font(ignore_font, ignore_language);
2422 font.fontInfo().setFamily(ROMAN_FAMILY);
2423 toggleAndShow(cur, this, font);
2427 case LFUN_FONT_DEFAULT: {
2428 Font font(inherit_font, ignore_language);
2429 toggleAndShow(cur, this, font);
2433 case LFUN_FONT_STRIKEOUT: {
2434 Font font(ignore_font, ignore_language);
2435 font.fontInfo().setStrikeout(FONT_TOGGLE);
2436 toggleAndShow(cur, this, font);
2440 case LFUN_FONT_CROSSOUT: {
2441 Font font(ignore_font, ignore_language);
2442 font.fontInfo().setXout(FONT_TOGGLE);
2443 toggleAndShow(cur, this, font);
2447 case LFUN_FONT_UNDERUNDERLINE: {
2448 Font font(ignore_font, ignore_language);
2449 font.fontInfo().setUuline(FONT_TOGGLE);
2450 toggleAndShow(cur, this, font);
2454 case LFUN_FONT_UNDERWAVE: {
2455 Font font(ignore_font, ignore_language);
2456 font.fontInfo().setUwave(FONT_TOGGLE);
2457 toggleAndShow(cur, this, font);
2461 case LFUN_FONT_UNDERLINE: {
2462 Font font(ignore_font, ignore_language);
2463 font.fontInfo().setUnderbar(FONT_TOGGLE);
2464 toggleAndShow(cur, this, font);
2468 case LFUN_FONT_SIZE: {
2469 Font font(ignore_font, ignore_language);
2470 setLyXSize(to_utf8(cmd.argument()), font.fontInfo());
2471 toggleAndShow(cur, this, font);
2475 case LFUN_LANGUAGE: {
2476 string const lang_arg = cmd.getArg(0);
2477 bool const reset = (lang_arg.empty() || lang_arg == "reset");
2478 Language const * lang =
2479 reset ? reset_language
2480 : languages.getLanguage(lang_arg);
2481 // we allow reset_language, which is 0, but only if it
2482 // was requested via empty or "reset" arg.
2483 if (!lang && !reset)
2485 bool const toggle = (cmd.getArg(1) != "set");
2486 selectWordWhenUnderCursor(cur, WHOLE_WORD_STRICT);
2487 Font font(ignore_font, lang);
2488 toggleAndShow(cur, this, font, toggle);
2489 // We need a buffer update if we change the language
2491 if (cur.insetInSelection(INFO_CODE))
2492 cur.forceBufferUpdate();
2496 case LFUN_TEXTSTYLE_APPLY: {
2497 unsigned int num = 0;
2498 string const arg = to_utf8(cmd.argument());
2501 if (isStrUnsignedInt(arg)) {
2502 num = convert<uint>(arg);
2503 if (num >= freeFonts.size()) {
2504 cur.message(_("Invalid argument (number exceeds stack size)!"));
2508 cur.message(_("Invalid argument (must be a non-negative number)!"));
2512 toggleAndShow(cur, this, freeFonts[num].second, toggleall);
2513 cur.message(bformat(_("Text properties applied: %1$s"), freeFonts[num].first));
2517 // Set the freefont using the contents of \param data dispatched from
2518 // the frontends and apply it at the current cursor location.
2519 case LFUN_TEXTSTYLE_UPDATE: {
2520 Font font(ignore_font, ignore_language);
2522 if (font.fromString(to_utf8(cmd.argument()), toggle)) {
2523 docstring const props = font.stateText(&bv->buffer().params(), true);
2524 freeFonts.push(make_pair(props, font));
2526 toggleAndShow(cur, this, font, toggleall);
2527 // We need a buffer update if we change the language
2529 if (cur.insetInSelection(INFO_CODE))
2530 cur.forceBufferUpdate();
2531 cur.message(bformat(_("Text properties applied: %1$s"), props));
2533 LYXERR0("Invalid argument of textstyle-update");
2537 case LFUN_FINISHED_LEFT:
2538 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_LEFT:\n" << cur);
2539 // We're leaving an inset, going left. If the inset is LTR, we're
2540 // leaving from the front, so we should not move (remain at --- but
2541 // not in --- the inset). If the inset is RTL, move left, without
2542 // entering the inset itself; i.e., move to after the inset.
2543 if (cur.paragraph().getFontSettings(
2544 cur.bv().buffer().params(), cur.pos()).isRightToLeft())
2545 cursorVisLeft(cur, true);
2548 case LFUN_FINISHED_RIGHT:
2549 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_RIGHT:\n" << cur);
2550 // We're leaving an inset, going right. If the inset is RTL, we're
2551 // leaving from the front, so we should not move (remain at --- but
2552 // not in --- the inset). If the inset is LTR, move right, without
2553 // entering the inset itself; i.e., move to after the inset.
2554 if (!cur.paragraph().getFontSettings(
2555 cur.bv().buffer().params(), cur.pos()).isRightToLeft())
2556 cursorVisRight(cur, true);
2559 case LFUN_FINISHED_BACKWARD:
2560 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_BACKWARD:\n" << cur);
2561 cur.setCurrentFont();
2564 case LFUN_FINISHED_FORWARD:
2565 LYXERR(Debug::DEBUG, "handle LFUN_FINISHED_FORWARD:\n" << cur);
2567 cur.setCurrentFont();
2570 case LFUN_LAYOUT_PARAGRAPH: {
2572 params2string(cur.paragraph(), data);
2573 data = "show\n" + data;
2574 bv->showDialog("paragraph", data);
2578 case LFUN_PARAGRAPH_UPDATE: {
2580 params2string(cur.paragraph(), data);
2582 // Will the paragraph accept changes from the dialog?
2584 cur.inset().allowParagraphCustomization(cur.idx());
2586 data = "update " + convert<string>(accept) + '\n' + data;
2587 bv->updateDialog("paragraph", data);
2591 case LFUN_ACCENT_UMLAUT:
2592 case LFUN_ACCENT_CIRCUMFLEX:
2593 case LFUN_ACCENT_GRAVE:
2594 case LFUN_ACCENT_ACUTE:
2595 case LFUN_ACCENT_TILDE:
2596 case LFUN_ACCENT_PERISPOMENI:
2597 case LFUN_ACCENT_CEDILLA:
2598 case LFUN_ACCENT_MACRON:
2599 case LFUN_ACCENT_DOT:
2600 case LFUN_ACCENT_UNDERDOT:
2601 case LFUN_ACCENT_UNDERBAR:
2602 case LFUN_ACCENT_CARON:
2603 case LFUN_ACCENT_BREVE:
2604 case LFUN_ACCENT_TIE:
2605 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
2606 case LFUN_ACCENT_CIRCLE:
2607 case LFUN_ACCENT_OGONEK:
2608 theApp()->handleKeyFunc(cmd.action());
2609 if (!cmd.argument().empty())
2610 // FIXME: Are all these characters encoded in one byte in utf8?
2611 bv->translateAndInsert(cmd.argument()[0], this, cur);
2612 cur.screenUpdateFlags(Update::FitCursor);
2615 case LFUN_FLOAT_LIST_INSERT: {
2616 DocumentClass const & tclass = bv->buffer().params().documentClass();
2617 if (tclass.floats().typeExist(to_utf8(cmd.argument()))) {
2619 if (cur.selection())
2620 cutSelection(cur, false);
2621 breakParagraph(cur);
2623 if (cur.lastpos() != 0) {
2624 cursorBackward(cur);
2625 breakParagraph(cur);
2628 docstring const laystr = cur.inset().usePlainLayout() ?
2629 tclass.plainLayoutName() :
2630 tclass.defaultLayoutName();
2631 setLayout(cur, laystr);
2632 ParagraphParameters p;
2633 // FIXME If this call were replaced with one to clearParagraphParams(),
2634 // then we could get rid of this method altogether.
2635 setParagraphs(cur, p);
2636 // FIXME This should be simplified when InsetFloatList takes a
2637 // Buffer in its constructor.
2638 InsetFloatList * ifl = new InsetFloatList(cur.buffer(), to_utf8(cmd.argument()));
2639 ifl->setBuffer(bv->buffer());
2640 insertInset(cur, ifl);
2643 lyxerr << "Non-existent float type: "
2644 << to_utf8(cmd.argument()) << endl;
2649 case LFUN_CHANGE_ACCEPT: {
2650 acceptOrRejectChanges(cur, ACCEPT);
2654 case LFUN_CHANGE_REJECT: {
2655 acceptOrRejectChanges(cur, REJECT);
2659 case LFUN_THESAURUS_ENTRY: {
2660 Language const * language = cur.getFont().language();
2661 docstring arg = cmd.argument();
2663 arg = cur.selectionAsString(false);
2665 if (arg.size() > 100 || arg.empty()) {
2666 // Get word or selection
2667 selectWordWhenUnderCursor(cur, WHOLE_WORD);
2668 arg = cur.selectionAsString(false);
2669 arg += " lang=" + from_ascii(language->lang());
2672 string lang = cmd.getArg(1);
2673 // This duplicates the code in GuiThesaurus::initialiseParams
2674 if (prefixIs(lang, "lang=")) {
2675 language = languages.getLanguage(lang.substr(5));
2677 language = cur.getFont().language();
2680 string lang = language->code();
2681 if (lyxrc.thesaurusdir_path.empty() && !thesaurus.thesaurusInstalled(from_ascii(lang))) {
2682 LYXERR(Debug::ACTION, "Command " << cmd << ". Thesaurus not found for language " << lang);
2683 frontend::Alert::warning(_("Path to thesaurus directory not set!"),
2684 _("The path to the thesaurus directory has not been specified.\n"
2685 "The thesaurus is not functional.\n"
2686 "Please refer to sec. 6.15.1 of the User's Guide for setup\n"
2689 bv->showDialog("thesaurus", to_utf8(arg));
2693 case LFUN_SPELLING_ADD: {
2694 Language const * language = getLanguage(cur, cmd.getArg(1));
2695 docstring word = from_utf8(cmd.getArg(0));
2697 word = cur.selectionAsString(false);
2699 if (word.size() > 100 || word.empty()) {
2700 // Get word or selection
2701 selectWordWhenUnderCursor(cur, WHOLE_WORD);
2702 word = cur.selectionAsString(false);
2705 WordLangTuple wl(word, language);
2706 theSpellChecker()->insert(wl);
2710 case LFUN_SPELLING_IGNORE: {
2711 Language const * language = getLanguage(cur, cmd.getArg(1));
2712 docstring word = from_utf8(cmd.getArg(0));
2714 word = cur.selectionAsString(false);
2716 if (word.size() > 100 || word.empty()) {
2717 // Get word or selection
2718 selectWordWhenUnderCursor(cur, WHOLE_WORD);
2719 word = cur.selectionAsString(false);
2722 WordLangTuple wl(word, language);
2723 theSpellChecker()->accept(wl);
2727 case LFUN_SPELLING_REMOVE: {
2728 Language const * language = getLanguage(cur, cmd.getArg(1));
2729 docstring word = from_utf8(cmd.getArg(0));
2731 word = cur.selectionAsString(false);
2733 if (word.size() > 100 || word.empty()) {
2734 // Get word or selection
2735 selectWordWhenUnderCursor(cur, WHOLE_WORD);
2736 word = cur.selectionAsString(false);
2739 WordLangTuple wl(word, language);
2740 theSpellChecker()->remove(wl);
2744 case LFUN_PARAGRAPH_PARAMS_APPLY: {
2745 // Given data, an encoding of the ParagraphParameters
2746 // generated in the Paragraph dialog, this function sets
2747 // the current paragraph, or currently selected paragraphs,
2749 // NOTE: This function overrides all existing settings.
2750 setParagraphs(cur, cmd.argument());
2751 cur.message(_("Paragraph layout set"));
2755 case LFUN_PARAGRAPH_PARAMS: {
2756 // Given data, an encoding of the ParagraphParameters as we'd
2757 // find them in a LyX file, this function modifies the current paragraph,
2758 // or currently selected paragraphs.
2759 // NOTE: This function only modifies, and does not override, existing
2761 setParagraphs(cur, cmd.argument(), true);
2762 cur.message(_("Paragraph layout set"));
2767 if (cur.selection()) {
2768 cur.selection(false);
2771 // This used to be LFUN_FINISHED_RIGHT, I think FORWARD is more
2772 // correct, but I'm not 100% sure -- dov, 071019
2773 cmd = FuncRequest(LFUN_FINISHED_FORWARD);
2777 case LFUN_OUTLINE_UP: {
2778 pos_type const opos = cur.pos();
2779 outline(OutlineUp, cur, this);
2780 setCursor(cur, cur.pit(), opos);
2781 cur.forceBufferUpdate();
2786 case LFUN_OUTLINE_DOWN: {
2787 pos_type const opos = cur.pos();
2788 outline(OutlineDown, cur, this);
2789 setCursor(cur, cur.pit(), opos);
2790 cur.forceBufferUpdate();
2795 case LFUN_OUTLINE_IN:
2796 outline(OutlineIn, cur, this);
2797 cur.forceBufferUpdate();
2801 case LFUN_OUTLINE_OUT:
2802 outline(OutlineOut, cur, this);
2803 cur.forceBufferUpdate();
2807 case LFUN_SERVER_GET_STATISTICS:
2809 DocIterator from, to;
2810 if (cur.selection()) {
2811 from = cur.selectionBegin();
2812 to = cur.selectionEnd();
2814 from = doc_iterator_begin(cur.buffer());
2815 to = doc_iterator_end(cur.buffer());
2818 cur.buffer()->updateStatistics(from, to);
2819 string const arg0 = cmd.getArg(0);
2820 if (arg0 == "words") {
2821 cur.message(convert<docstring>(cur.buffer()->wordCount()));
2822 } else if (arg0 == "chars") {
2823 cur.message(convert<docstring>(cur.buffer()->charCount(false)));
2824 } else if (arg0 == "chars-space") {
2825 cur.message(convert<docstring>(cur.buffer()->charCount(true)));
2827 cur.message(convert<docstring>(cur.buffer()->wordCount()) + " "
2828 + convert<docstring>(cur.buffer()->charCount(false)) + " "
2829 + convert<docstring>(cur.buffer()->charCount(true)));
2835 LYXERR(Debug::ACTION, "Command " << cmd << " not DISPATCHED by Text");
2840 needsUpdate |= (cur.pos() != cur.lastpos()) && cur.selection();
2842 if (lyxrc.spellcheck_continuously && !needsUpdate) {
2843 // Check for misspelled text
2844 // The redraw is useful because of the painting of
2845 // misspelled markers depends on the cursor position.
2846 // Trigger a redraw for cursor moves inside misspelled text.
2847 if (!cur.inTexted()) {
2848 // move from regular text to math
2849 needsUpdate = last_misspelled;
2850 } else if (oldTopSlice != cur.top() || oldBoundary != cur.boundary()) {
2851 // move inside regular text
2852 needsUpdate = last_misspelled
2853 || cur.paragraph().isMisspelled(cur.pos(), true);
2857 // FIXME: The cursor flag is reset two lines below
2858 // so we need to check here if some of the LFUN did touch that.
2859 // for now only Text::erase() and Text::backspace() do that.
2860 // The plan is to verify all the LFUNs and then to remove this
2861 // singleParUpdate boolean altogether.
2862 if (cur.result().screenUpdate() & Update::Force) {
2863 singleParUpdate = false;
2867 // FIXME: the following code should go in favor of fine grained
2868 // update flag treatment.
2869 if (singleParUpdate) {
2870 // Inserting characters does not change par height in general. So, try
2871 // to update _only_ this paragraph. BufferView will detect if a full
2872 // metrics update is needed anyway.
2873 cur.screenUpdateFlags(Update::SinglePar | Update::FitCursor);
2877 && &oldTopSlice.inset() == &cur.inset()
2878 && oldTopSlice.idx() == cur.idx()
2879 && !oldSelection // oldSelection is a backup of cur.selection() at the beginning of the function.
2880 && !cur.selection())
2881 // FIXME: it would be better if we could just do this
2883 //if (cur.result().update() != Update::FitCursor)
2884 // cur.noScreenUpdate();
2886 // But some LFUNs do not set Update::FitCursor when needed, so we
2887 // do it for all. This is not very harmfull as FitCursor will provoke
2888 // a full redraw only if needed but still, a proper review of all LFUN
2889 // should be done and this needsUpdate boolean can then be removed.
2890 cur.screenUpdateFlags(Update::FitCursor);
2892 cur.screenUpdateFlags(Update::Force | Update::FitCursor);
2896 bool Text::getStatus(Cursor & cur, FuncRequest const & cmd,
2897 FuncStatus & flag) const
2899 LBUFERR(this == cur.text());
2901 FontInfo const & fontinfo = cur.real_current_font.fontInfo();
2903 bool allow_in_passthru = false;
2904 InsetCode code = NO_CODE;
2906 switch (cmd.action()) {
2908 case LFUN_DEPTH_DECREMENT:
2909 enable = changeDepthAllowed(cur, DEC_DEPTH);
2912 case LFUN_DEPTH_INCREMENT:
2913 enable = changeDepthAllowed(cur, INC_DEPTH);
2917 // FIXME We really should not allow this to be put, e.g.,
2918 // in a footnote, or in ERT. But it would make sense in a
2919 // branch, so I'm not sure what to do.
2920 flag.setOnOff(cur.paragraph().params().startOfAppendix());
2923 case LFUN_DIALOG_SHOW_NEW_INSET:
2924 if (cmd.argument() == "bibitem")
2925 code = BIBITEM_CODE;
2926 else if (cmd.argument() == "bibtex") {
2928 // not allowed in description items
2929 enable = !inDescriptionItem(cur);
2931 else if (cmd.argument() == "box")
2933 else if (cmd.argument() == "branch")
2935 else if (cmd.argument() == "citation")
2937 else if (cmd.argument() == "ert")
2939 else if (cmd.argument() == "external")
2940 code = EXTERNAL_CODE;
2941 else if (cmd.argument() == "float")
2943 else if (cmd.argument() == "graphics")
2944 code = GRAPHICS_CODE;
2945 else if (cmd.argument() == "href")
2946 code = HYPERLINK_CODE;
2947 else if (cmd.argument() == "include")
2948 code = INCLUDE_CODE;
2949 else if (cmd.argument() == "index")
2951 else if (cmd.argument() == "index_print")
2952 code = INDEX_PRINT_CODE;
2953 else if (cmd.argument() == "listings")
2954 code = LISTINGS_CODE;
2955 else if (cmd.argument() == "mathspace")
2956 code = MATH_HULL_CODE;
2957 else if (cmd.argument() == "nomenclature")
2958 code = NOMENCL_CODE;
2959 else if (cmd.argument() == "nomencl_print")
2960 code = NOMENCL_PRINT_CODE;
2961 else if (cmd.argument() == "label")
2963 else if (cmd.argument() == "line")
2965 else if (cmd.argument() == "note")
2967 else if (cmd.argument() == "phantom")
2968 code = PHANTOM_CODE;
2969 else if (cmd.argument() == "ref")
2971 else if (cmd.argument() == "space")
2973 else if (cmd.argument() == "toc")
2975 else if (cmd.argument() == "vspace")
2977 else if (cmd.argument() == "wrap")
2981 case LFUN_ERT_INSERT:
2984 case LFUN_LISTING_INSERT:
2985 code = LISTINGS_CODE;
2986 // not allowed in description items
2987 enable = !inDescriptionItem(cur);
2989 case LFUN_FOOTNOTE_INSERT:
2992 case LFUN_TABULAR_INSERT:
2993 code = TABULAR_CODE;
2995 case LFUN_TABULAR_STYLE_INSERT:
2996 code = TABULAR_CODE;
2998 case LFUN_MARGINALNOTE_INSERT:
3001 case LFUN_FLOAT_INSERT:
3002 case LFUN_FLOAT_WIDE_INSERT:
3003 // FIXME: If there is a selection, we should check whether there
3004 // are floats in the selection, but this has performance issues, see
3005 // LFUN_CHANGE_ACCEPT/REJECT.
3007 if (inDescriptionItem(cur))
3008 // not allowed in description items
3011 InsetCode const inset_code = cur.inset().lyxCode();
3013 // algorithm floats cannot be put in another float
3014 if (to_utf8(cmd.argument()) == "algorithm") {
3015 enable = inset_code != WRAP_CODE && inset_code != FLOAT_CODE;
3019 // for figures and tables: only allow in another
3020 // float or wrap if it is of the same type and
3021 // not a subfloat already
3022 if(cur.inset().lyxCode() == code) {
3023 InsetFloat const & ins =
3024 static_cast<InsetFloat const &>(cur.inset());
3025 enable = ins.params().type == to_utf8(cmd.argument())
3026 && !ins.params().subfloat;
3027 } else if(cur.inset().lyxCode() == WRAP_CODE) {
3028 InsetWrap const & ins =
3029 static_cast<InsetWrap const &>(cur.inset());
3030 enable = ins.params().type == to_utf8(cmd.argument());
3034 case LFUN_WRAP_INSERT:
3036 // not allowed in description items
3037 enable = !inDescriptionItem(cur);
3039 case LFUN_FLOAT_LIST_INSERT: {
3040 code = FLOAT_LIST_CODE;
3041 // not allowed in description items
3042 enable = !inDescriptionItem(cur);
3044 FloatList const & floats = cur.buffer()->params().documentClass().floats();
3045 FloatList::const_iterator cit = floats[to_ascii(cmd.argument())];
3046 // make sure we know about such floats
3047 if (cit == floats.end() ||
3048 // and that we know how to generate a list of them
3049 (!cit->second.usesFloatPkg() && cit->second.listCommand().empty())) {
3050 flag.setUnknown(true);
3051 // probably not necessary, but...
3057 case LFUN_CAPTION_INSERT: {
3058 code = CAPTION_CODE;
3059 string arg = cmd.getArg(0);
3060 bool varia = arg != "Unnumbered"
3061 && cur.inset().allowsCaptionVariation(arg);
3062 // not allowed in description items,
3063 // and in specific insets
3064 enable = !inDescriptionItem(cur)
3065 && (varia || arg.empty() || arg == "Standard");
3068 case LFUN_NOTE_INSERT:
3071 case LFUN_FLEX_INSERT: {
3073 string s = cmd.getArg(0);
3075 cur.buffer()->params().documentClass().insetLayout(from_utf8(s));
3076 if (il.lyxtype() != InsetLayout::CHARSTYLE &&
3077 il.lyxtype() != InsetLayout::CUSTOM &&
3078 il.lyxtype ()!= InsetLayout::STANDARD)
3082 case LFUN_BOX_INSERT:
3085 case LFUN_BRANCH_INSERT:
3087 if (cur.buffer()->masterBuffer()->params().branchlist().empty()
3088 && cur.buffer()->params().branchlist().empty())
3091 case LFUN_IPA_INSERT:
3094 case LFUN_PHANTOM_INSERT:
3095 code = PHANTOM_CODE;
3097 case LFUN_LABEL_INSERT:
3100 case LFUN_INFO_INSERT:
3102 enable = cmd.argument().empty()
3103 || infoparams.validateArgument(cur.buffer(), cmd.argument(), true);
3105 case LFUN_ARGUMENT_INSERT: {
3107 allow_in_passthru = true;
3108 string const arg = cmd.getArg(0);
3113 Layout const & lay = cur.paragraph().layout();
3114 Layout::LaTeXArgMap args = lay.args();
3115 Layout::LaTeXArgMap::const_iterator const lait =
3117 if (lait != args.end()) {
3119 pit_type pit = cur.pit();
3120 pit_type lastpit = cur.pit();
3121 if (lay.isEnvironment() && !prefixIs(arg, "item:")) {
3122 // In a sequence of "merged" environment layouts, we only allow
3123 // non-item arguments once.
3124 lastpit = cur.lastpit();
3125 // get the first paragraph in sequence with this layout
3126 depth_type const current_depth = cur.paragraph().params().depth();
3130 Paragraph cpar = pars_[pit - 1];
3131 if (cpar.layout() == lay && cpar.params().depth() == current_depth)
3137 for (; pit <= lastpit; ++pit) {
3138 if (pars_[pit].layout() != lay)
3140 for (auto const & table : pars_[pit].insetList())
3141 if (InsetArgument const * ins = table.inset->asInsetArgument())
3142 if (ins->name() == arg) {
3143 // we have this already
3152 case LFUN_INDEX_INSERT:
3155 case LFUN_INDEX_PRINT:
3156 code = INDEX_PRINT_CODE;
3157 // not allowed in description items
3158 enable = !inDescriptionItem(cur);
3160 case LFUN_NOMENCL_INSERT:
3161 if (cur.selIsMultiCell() || cur.selIsMultiLine()) {
3165 code = NOMENCL_CODE;
3167 case LFUN_NOMENCL_PRINT:
3168 code = NOMENCL_PRINT_CODE;
3169 // not allowed in description items
3170 enable = !inDescriptionItem(cur);
3172 case LFUN_HREF_INSERT:
3173 if (cur.selIsMultiCell() || cur.selIsMultiLine()) {
3177 code = HYPERLINK_CODE;
3179 case LFUN_IPAMACRO_INSERT: {
3180 string const arg = cmd.getArg(0);
3182 code = IPADECO_CODE;
3184 code = IPACHAR_CODE;
3187 case LFUN_QUOTE_INSERT:
3188 // always allow this, since we will inset a raw quote
3189 // if an inset is not allowed.
3190 allow_in_passthru = true;
3192 case LFUN_SPECIALCHAR_INSERT:
3193 code = SPECIALCHAR_CODE;
3195 case LFUN_SPACE_INSERT:
3196 // slight hack: we know this is allowed in math mode
3200 case LFUN_PREVIEW_INSERT:
3201 code = PREVIEW_CODE;
3203 case LFUN_SCRIPT_INSERT:
3207 case LFUN_MATH_INSERT:
3208 case LFUN_MATH_AMS_MATRIX:
3209 case LFUN_MATH_MATRIX:
3210 case LFUN_MATH_DELIM:
3211 case LFUN_MATH_BIGDELIM:
3212 case LFUN_MATH_DISPLAY:
3213 case LFUN_MATH_MODE:
3214 case LFUN_MATH_MACRO:
3215 case LFUN_MATH_SUBSCRIPT:
3216 case LFUN_MATH_SUPERSCRIPT:
3217 code = MATH_HULL_CODE;
3220 case LFUN_REGEXP_MODE:
3221 code = MATH_HULL_CODE;
3222 enable = cur.buffer()->isInternal() && !cur.inRegexped();
3225 case LFUN_INSET_MODIFY:
3226 // We need to disable this, because we may get called for a
3228 // InsetTabular::getStatus() -> InsetText::getStatus()
3229 // and we don't handle LFUN_INSET_MODIFY.
3233 case LFUN_FONT_EMPH:
3234 flag.setOnOff(fontinfo.emph() == FONT_ON);
3235 enable = !cur.paragraph().isPassThru();
3238 case LFUN_FONT_ITAL:
3239 flag.setOnOff(fontinfo.shape() == ITALIC_SHAPE);
3240 enable = !cur.paragraph().isPassThru();
3243 case LFUN_FONT_NOUN:
3244 flag.setOnOff(fontinfo.noun() == FONT_ON);
3245 enable = !cur.paragraph().isPassThru();
3248 case LFUN_FONT_BOLD:
3249 case LFUN_FONT_BOLDSYMBOL:
3250 flag.setOnOff(fontinfo.series() == BOLD_SERIES);
3251 enable = !cur.paragraph().isPassThru();
3254 case LFUN_FONT_SANS:
3255 flag.setOnOff(fontinfo.family() == SANS_FAMILY);
3256 enable = !cur.paragraph().isPassThru();
3259 case LFUN_FONT_ROMAN:
3260 flag.setOnOff(fontinfo.family() == ROMAN_FAMILY);
3261 enable = !cur.paragraph().isPassThru();
3264 case LFUN_FONT_TYPEWRITER:
3265 flag.setOnOff(fontinfo.family() == TYPEWRITER_FAMILY);
3266 enable = !cur.paragraph().isPassThru();
3271 enable = cur.selection();
3275 if (cmd.argument().empty()) {
3276 if (theClipboard().isInternal())
3277 enable = cap::numberOfSelections() > 0;
3279 enable = !theClipboard().empty();
3283 // we have an argument
3284 string const arg = to_utf8(cmd.argument());
3285 if (isStrUnsignedInt(arg)) {
3286 // it's a number and therefore means the internal stack
3287 unsigned int n = convert<unsigned int>(arg);
3288 enable = cap::numberOfSelections() > n;
3292 // explicit text type?
3293 if (arg == "html") {
3294 // Do not enable for PlainTextType, since some tidying in the
3295 // frontend is needed for HTML, which is too unsafe for plain text.
3296 enable = theClipboard().hasTextContents(Clipboard::HtmlTextType);
3298 } else if (arg == "latex") {
3299 // LaTeX is usually not available on the clipboard with
3300 // the correct MIME type, but in plain text.
3301 enable = theClipboard().hasTextContents(Clipboard::PlainTextType) ||
3302 theClipboard().hasTextContents(Clipboard::LaTeXTextType);
3306 Clipboard::GraphicsType type = Clipboard::AnyGraphicsType;
3308 type = Clipboard::PdfGraphicsType;
3309 else if (arg == "png")
3310 type = Clipboard::PngGraphicsType;
3311 else if (arg == "jpeg")
3312 type = Clipboard::JpegGraphicsType;
3313 else if (arg == "linkback")
3314 type = Clipboard::LinkBackGraphicsType;
3315 else if (arg == "emf")
3316 type = Clipboard::EmfGraphicsType;
3317 else if (arg == "wmf")
3318 type = Clipboard::WmfGraphicsType;
3321 LYXERR0("Unrecognized graphics type: " << arg);
3322 // we don't want to assert if the user just mistyped the LFUN
3323 LATTEST(cmd.origin() != FuncRequest::INTERNAL);
3327 enable = theClipboard().hasGraphicsContents(type);
3331 case LFUN_CLIPBOARD_PASTE:
3332 case LFUN_CLIPBOARD_PASTE_SIMPLE:
3333 enable = !theClipboard().empty();
3336 case LFUN_PRIMARY_SELECTION_PASTE:
3337 enable = cur.selection() || !theSelection().empty();
3340 case LFUN_SELECTION_PASTE:
3341 enable = cap::selection();
3344 case LFUN_PARAGRAPH_MOVE_UP:
3345 enable = cur.pit() > 0 && !cur.selection();
3348 case LFUN_PARAGRAPH_MOVE_DOWN:
3349 enable = cur.pit() < cur.lastpit() && !cur.selection();
3352 case LFUN_CHANGE_ACCEPT:
3353 case LFUN_CHANGE_REJECT:
3354 if (!cur.selection())
3355 enable = cur.paragraph().isChanged(cur.pos());
3357 // will enable if there is a change in the selection
3360 // cheap improvement for efficiency: using cached
3361 // buffer variable, if there is no change in the
3362 // document, no need to check further.
3363 if (!cur.buffer()->areChangesPresent())
3366 for (DocIterator it = cur.selectionBegin(); ; it.forwardPar()) {
3367 pos_type const beg = it.pos();
3369 bool const in_last_par = (it.pit() == cur.selectionEnd().pit() &&
3370 it.idx() == cur.selectionEnd().idx());
3372 end = cur.selectionEnd().pos();
3374 // the +1 is needed for cases, e.g., where there is a
3375 // paragraph break. See #11629.
3376 end = it.lastpos() + 1;
3377 if (beg != end && it.paragraph().isChanged(beg, end)) {
3381 if (beg != end && it.paragraph().hasChangedInsets(beg, end)) {
3391 case LFUN_OUTLINE_UP:
3392 case LFUN_OUTLINE_DOWN:
3393 case LFUN_OUTLINE_IN:
3394 case LFUN_OUTLINE_OUT:
3395 // FIXME: LyX is not ready for outlining within inset.
3396 enable = isMainText()
3397 && cur.buffer()->text().getTocLevel(cur.pit()) != Layout::NOT_IN_TOC;
3400 case LFUN_NEWLINE_INSERT:
3401 // LaTeX restrictions (labels or empty par)
3402 enable = !cur.paragraph().isPassThru()
3403 && cur.pos() > cur.paragraph().beginOfBody();
3406 case LFUN_SEPARATOR_INSERT:
3407 // Always enabled for now
3411 case LFUN_TAB_INSERT:
3412 case LFUN_TAB_DELETE:
3413 enable = cur.paragraph().isPassThru();
3416 case LFUN_GRAPHICS_SET_GROUP: {
3417 InsetGraphics * ins = graphics::getCurrentGraphicsInset(cur);
3421 flag.setOnOff(to_utf8(cmd.argument()) == ins->getParams().groupId);
3425 case LFUN_NEWPAGE_INSERT:
3426 // not allowed in description items
3427 code = NEWPAGE_CODE;
3428 enable = !inDescriptionItem(cur);
3432 enable = !cur.paragraph().isPassThru();
3433 flag.setOnOff(cmd.getArg(0) == cur.real_current_font.language()->lang());
3436 case LFUN_PARAGRAPH_BREAK:
3437 enable = inset().allowMultiPar();
3440 case LFUN_SPELLING_ADD:
3441 case LFUN_SPELLING_IGNORE:
3442 case LFUN_SPELLING_REMOVE:
3443 enable = theSpellChecker() != nullptr;
3444 if (enable && !cmd.getArg(1).empty()) {
3445 // validate explicitly given language
3446 Language const * const lang = const_cast<Language *>(languages.getLanguage(cmd.getArg(1)));
3447 enable &= lang != nullptr;
3452 case LFUN_LAYOUT_TOGGLE: {
3453 bool const ignoreautonests = cmd.getArg(1) == "ignoreautonests";
3454 docstring const req_layout = ignoreautonests ? from_utf8(cmd.getArg(0)) : cmd.argument();
3455 docstring const layout = resolveLayout(req_layout, cur);
3457 enable = !owner_->forcePlainLayout() && !layout.empty();
3458 flag.setOnOff(isAlreadyLayout(layout, cur));
3462 case LFUN_ENVIRONMENT_SPLIT: {
3463 if (cmd.argument() == "outer") {
3464 // check if we have an environment in our nesting hierarchy
3466 depth_type const current_depth = cur.paragraph().params().depth();
3467 pit_type pit = cur.pit();
3468 Paragraph cpar = pars_[pit];
3470 if (pit == 0 || cpar.params().depth() == 0)
3474 if (cpar.params().depth() < current_depth)
3475 res = cpar.layout().isEnvironment();
3480 else if (cmd.argument() == "previous") {
3481 // look if we have an environment in the previous par
3482 pit_type pit = cur.pit();
3483 Paragraph cpar = pars_[pit];
3487 enable = cpar.layout().isEnvironment();
3493 else if (cur.paragraph().layout().isEnvironment()) {
3494 enable = cmd.argument() == "before"
3495 || cur.pos() > 0 || !isFirstInSequence(cur.pit());
3502 case LFUN_LAYOUT_PARAGRAPH:
3503 case LFUN_PARAGRAPH_PARAMS:
3504 case LFUN_PARAGRAPH_PARAMS_APPLY:
3505 case LFUN_PARAGRAPH_UPDATE:
3506 enable = owner_->allowParagraphCustomization();
3509 // FIXME: why are accent lfuns forbidden with pass_thru layouts?
3510 // Because they insert COMBINING DIACRITICAL Unicode characters,
3511 // that cannot be handled by LaTeX but must be converted according
3512 // to the definition in lib/unicodesymbols?
3513 case LFUN_ACCENT_ACUTE:
3514 case LFUN_ACCENT_BREVE:
3515 case LFUN_ACCENT_CARON:
3516 case LFUN_ACCENT_CEDILLA:
3517 case LFUN_ACCENT_CIRCLE:
3518 case LFUN_ACCENT_CIRCUMFLEX:
3519 case LFUN_ACCENT_DOT:
3520 case LFUN_ACCENT_GRAVE:
3521 case LFUN_ACCENT_HUNGARIAN_UMLAUT:
3522 case LFUN_ACCENT_MACRON:
3523 case LFUN_ACCENT_OGONEK:
3524 case LFUN_ACCENT_TIE:
3525 case LFUN_ACCENT_TILDE:
3526 case LFUN_ACCENT_PERISPOMENI:
3527 case LFUN_ACCENT_UMLAUT:
3528 case LFUN_ACCENT_UNDERBAR:
3529 case LFUN_ACCENT_UNDERDOT:
3530 case LFUN_FONT_FRAK:
3531 case LFUN_FONT_SIZE:
3532 case LFUN_FONT_STATE:
3533 case LFUN_FONT_UNDERLINE:
3534 case LFUN_FONT_STRIKEOUT:
3535 case LFUN_FONT_CROSSOUT:
3536 case LFUN_FONT_UNDERUNDERLINE:
3537 case LFUN_FONT_UNDERWAVE:
3538 case LFUN_TEXTSTYLE_UPDATE:
3539 enable = !cur.paragraph().isPassThru();
3542 case LFUN_FONT_DEFAULT: {
3543 Font font(inherit_font, ignore_language);
3544 BufferParams const & bp = cur.buffer()->masterParams();
3545 if (cur.selection()) {
3547 // Check if we have a non-default font attribute
3548 // in the selection range.
3549 DocIterator const from = cur.selectionBegin();
3550 DocIterator const to = cur.selectionEnd();
3551 for (DocIterator dit = from ; dit != to && !dit.atEnd(); ) {
3552 if (!dit.inTexted()) {
3556 Paragraph const & par = dit.paragraph();
3557 pos_type const pos = dit.pos();
3558 Font tmp = par.getFontSettings(bp, pos);
3559 if (tmp.fontInfo() != font.fontInfo()
3560 || tmp.language() != bp.language) {
3568 // Disable if all is default already.
3569 enable = (cur.current_font.fontInfo() != font.fontInfo()
3570 || cur.current_font.language() != bp.language);
3574 case LFUN_TEXTSTYLE_APPLY:
3575 enable = !freeFonts.empty();
3578 case LFUN_WORD_DELETE_FORWARD:
3579 case LFUN_WORD_DELETE_BACKWARD:
3580 case LFUN_LINE_DELETE_FORWARD:
3581 case LFUN_WORD_FORWARD:
3582 case LFUN_WORD_BACKWARD:
3583 case LFUN_WORD_RIGHT:
3584 case LFUN_WORD_LEFT:
3585 case LFUN_CHAR_FORWARD:
3586 case LFUN_CHAR_FORWARD_SELECT:
3587 case LFUN_CHAR_BACKWARD:
3588 case LFUN_CHAR_BACKWARD_SELECT:
3589 case LFUN_CHAR_LEFT:
3590 case LFUN_CHAR_LEFT_SELECT:
3591 case LFUN_CHAR_RIGHT:
3592 case LFUN_CHAR_RIGHT_SELECT:
3594 case LFUN_UP_SELECT:
3596 case LFUN_DOWN_SELECT:
3597 case LFUN_PARAGRAPH_SELECT:
3598 case LFUN_PARAGRAPH_UP_SELECT:
3599 case LFUN_PARAGRAPH_DOWN_SELECT:
3600 case LFUN_LINE_BEGIN_SELECT:
3601 case LFUN_LINE_END_SELECT:
3602 case LFUN_WORD_FORWARD_SELECT:
3603 case LFUN_WORD_BACKWARD_SELECT:
3604 case LFUN_WORD_RIGHT_SELECT:
3605 case LFUN_WORD_LEFT_SELECT:
3606 case LFUN_WORD_SELECT:
3607 case LFUN_SECTION_SELECT:
3608 case LFUN_BUFFER_BEGIN:
3609 case LFUN_BUFFER_END:
3610 case LFUN_BUFFER_BEGIN_SELECT:
3611 case LFUN_BUFFER_END_SELECT:
3612 case LFUN_INSET_BEGIN:
3613 case LFUN_INSET_END:
3614 case LFUN_INSET_BEGIN_SELECT:
3615 case LFUN_INSET_END_SELECT:
3616 case LFUN_PARAGRAPH_UP:
3617 case LFUN_PARAGRAPH_DOWN:
3618 case LFUN_LINE_BEGIN:
3620 case LFUN_CHAR_DELETE_FORWARD:
3621 case LFUN_CHAR_DELETE_BACKWARD:
3622 case LFUN_WORD_UPCASE:
3623 case LFUN_WORD_LOWCASE:
3624 case LFUN_WORD_CAPITALIZE:
3625 case LFUN_CHARS_TRANSPOSE:
3626 case LFUN_SERVER_GET_XY:
3627 case LFUN_SERVER_SET_XY:
3628 case LFUN_SERVER_GET_LAYOUT:
3629 case LFUN_SELF_INSERT:
3630 case LFUN_UNICODE_INSERT:
3631 case LFUN_THESAURUS_ENTRY:
3633 case LFUN_SERVER_GET_STATISTICS:
3634 // these are handled in our dispatch()
3638 case LFUN_INSET_INSERT: {
3639 string const type = cmd.getArg(0);
3640 if (type == "toc") {
3642 // not allowed in description items
3643 //FIXME: couldn't this be merged in Inset::insetAllowed()?
3644 enable = !inDescriptionItem(cur);
3651 case LFUN_SEARCH_IGNORE: {
3652 bool const value = cmd.getArg(1) == "true";
3653 setIgnoreFormat(cmd.getArg(0), value);
3663 || !cur.inset().insetAllowed(code)
3664 || (cur.paragraph().layout().pass_thru && !allow_in_passthru)))
3667 flag.setEnabled(enable);
3672 void Text::pasteString(Cursor & cur, docstring const & clip,
3675 if (!clip.empty()) {
3678 insertStringAsParagraphs(cur, clip, cur.current_font);
3680 insertStringAsLines(cur, clip, cur.current_font);
3685 // FIXME: an item inset would make things much easier.
3686 bool Text::inDescriptionItem(Cursor const & cur) const
3688 Paragraph const & par = cur.paragraph();
3689 pos_type const pos = cur.pos();
3690 pos_type const body_pos = par.beginOfBody();
3692 if (par.layout().latextype != LATEX_LIST_ENVIRONMENT
3693 && (par.layout().latextype != LATEX_ITEM_ENVIRONMENT
3694 || par.layout().margintype != MARGIN_FIRST_DYNAMIC))
3697 return (pos < body_pos
3699 && (pos == 0 || par.getChar(pos - 1) != ' ')));
3703 std::vector<docstring> Text::getFreeFonts() const
3705 vector<docstring> ffList;
3707 for (auto const & f : freeFonts)
3708 ffList.push_back(f.first);