3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
7 * \author Alfredo Braunstein
8 * \author Dov Feldstern
10 * \author Stefan Schimanski
12 * Full author contact details are available in file CREDITS.
18 #include "BufferParams.h"
19 #include "BufferView.h"
20 #include "CoordCache.h"
22 #include "CutAndPaste.h"
23 #include "DispatchResult.h"
27 #include "FuncRequest.h"
30 #include "LyXAction.h"
32 #include "Paragraph.h"
33 #include "ParIterator.h"
35 #include "texstream.h"
37 #include "TextMetrics.h"
38 #include "TocBackend.h"
40 #include "support/debug.h"
41 #include "support/docstream.h"
42 #include "support/ExceptionMessage.h"
43 #include "support/gettext.h"
44 #include "support/lassert.h"
46 #include "insets/InsetTabular.h"
47 #include "insets/InsetText.h"
49 #include "mathed/InsetMath.h"
50 #include "mathed/InsetMathBrace.h"
51 #include "mathed/InsetMathEnsureMath.h"
52 #include "mathed/InsetMathScript.h"
53 #include "mathed/MacroTable.h"
54 #include "mathed/MathData.h"
55 #include "mathed/MathFactory.h"
56 #include "mathed/MathMacro.h"
69 // Find position closest to (x, y) in cell given by iter.
70 // Used only in mathed
71 DocIterator bruteFind(Cursor const & c, int x, int y)
73 double best_dist = numeric_limits<double>::max();
80 et.pos() = et.lastpos();
81 for (size_t i = 0;; ++i) {
84 Inset const * inset = &it.inset();
85 CoordCache::Insets const & insetCache = c.bv().coordCache().getInsets();
87 // FIXME: in the case where the inset is not in the cache, this
88 // means that no part of it is visible on screen. In this case
89 // we don't do elaborate search and we just return the forwarded
90 // DocIterator at its beginning.
91 if (!insetCache.has(inset)) {
96 Point const o = insetCache.xy(inset);
97 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
98 // Convert to absolute
101 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
102 // '<=' in order to take the last possible position
103 // this is important for clicking behind \sum in e.g. '\sum_i a'
104 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
105 << " best: " << best_dist);
106 if (d <= best_dist) {
121 CursorData::CursorData()
122 : DocIterator(), anchor_(),
123 selection_(false), mark_(false), word_selection_(false),
124 current_font(inherit_font),
125 autocorrect_(false), macromode_(false)
129 CursorData::CursorData(Buffer * buffer)
130 : DocIterator(buffer), anchor_(),
131 selection_(false), mark_(false), word_selection_(false),
132 current_font(inherit_font),
133 autocorrect_(false), macromode_(false)
137 CursorData::CursorData(DocIterator const & dit)
138 : DocIterator(dit), anchor_(),
139 selection_(false), mark_(false), word_selection_(false),
140 current_font(inherit_font),
141 autocorrect_(false), macromode_(false)
147 ostream & operator<<(ostream & os, CursorData const & cur)
149 os << "\n cursor: | anchor:\n";
150 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
151 os << " " << cur[i] << " | ";
152 if (i < cur.anchor_.depth())
153 os << cur.anchor_[i];
155 os << "-------------------------------";
158 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
159 os << "------------------------------- | " << cur.anchor_[i] << "\n";
161 os << " selection: " << cur.selection_
162 // << " x_target: " << cur.x_target_
163 << " boundary: " << cur.boundary() << endl;
168 LyXErr & operator<<(LyXErr & os, CursorData const & cur)
175 // be careful: this is called from the bv's constructor, too, so
176 // bv functions are not yet available!
177 Cursor::Cursor(BufferView & bv)
178 : CursorData(&bv.buffer()), bv_(&bv),
179 x_target_(-1), textTargetOffset_(0),
180 beforeDispatchPosX_(0), beforeDispatchPosY_(0)
187 push_back(CursorSlice(buffer()->inset()));
188 anchor_ = doc_iterator_begin(buffer());
190 new_word_ = doc_iterator_begin(buffer());
198 void Cursor::setCursor(DocIterator const & cur)
200 DocIterator::operator=(cur);
204 void Cursor::setCursorSelectionTo(DocIterator dit)
208 while (i < dit.depth() && i < anchor_.depth() && dit[i] == anchor_[i])
210 if (i != dit.depth()) {
211 // otherwise the cursor is already normal
212 if (i == anchor_.depth())
213 // dit is a proper extension of the anchor_
215 else if (i + 1 < dit.depth()) {
216 // one has dit[i] != anchor_[i] but either dit[i-1] == anchor_[i-1]
217 // or i == 0. Remove excess.
219 if (dit[i] > anchor_[i])
220 // place dit after the inset it was in
229 void Cursor::setCursorToAnchor()
232 DocIterator normal = anchor_;
233 while (depth() < normal.depth())
235 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
242 void Cursor::setCursorData(CursorData const & data)
244 CursorData::operator=(data);
248 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
252 // Try to fix cursor in case it is broken.
255 // Is this a function that acts on inset at point?
256 Inset * inset = cur.nextInset();
257 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
258 && inset && inset->getStatus(cur, cmd, status))
261 // This is, of course, a mess. Better create a new doc iterator and use
262 // this in Inset::getStatus. This might require an additional
263 // BufferView * arg, though (which should be avoided)
264 //Cursor safe = *this;
266 for ( ; cur.depth(); cur.pop()) {
267 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
268 // LASSERT: Is it safe to continue here, or should we return?
269 LASSERT(cur.idx() <= cur.lastidx(), /**/);
270 LASSERT(cur.pit() <= cur.lastpit(), /**/);
271 LASSERT(cur.pos() <= cur.lastpos(), /**/);
273 // The inset's getStatus() will return 'true' if it made
274 // a definitive decision on whether it want to handle the
275 // request or not. The result of this decision is put into
276 // the 'status' parameter.
277 if (cur.inset().getStatus(cur, cmd, status)) {
286 void Cursor::saveBeforeDispatchPosXY()
288 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
292 void Cursor::dispatch(FuncRequest const & cmd0)
294 LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
299 FuncRequest cmd = cmd0;
302 disp_ = DispatchResult();
306 // Is this a function that acts on inset at point?
307 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
309 disp_.dispatched(true);
310 disp_.screenUpdate(Update::FitCursor | Update::Force);
311 FuncRequest tmpcmd = cmd;
312 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
313 << cmd0 << endl << *this);
314 nextInset()->dispatch(*this, tmpcmd);
315 if (disp_.dispatched()) {
321 // store some values to be used inside of the handlers
322 beforeDispatchCursor_ = *this;
323 for (; depth(); pop(), boundary(false)) {
324 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
325 << cmd0 << endl << *this);
327 // In any of these cases, the cursor is invalid, and we should
328 // try to save this document rather than crash.
329 LBUFERR(pos() <= lastpos());
330 LBUFERR(idx() <= lastidx());
331 LBUFERR(pit() <= lastpit());
333 // The common case is 'LFUN handled, need update', so make the
334 // LFUN handler's life easier by assuming this as default value.
335 // The handler can reset the update and val flags if necessary.
336 disp_.screenUpdate(Update::FitCursor | Update::Force);
337 disp_.dispatched(true);
338 inset().dispatch(*this, cmd);
339 if (disp_.dispatched())
343 // it completely to get a 'bomb early' behaviour in case this
344 // object will be used again.
345 if (!disp_.dispatched()) {
346 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
347 // We might have invalidated the cursor when removing an empty
348 // paragraph while the cursor could not be moved out the inset
349 // while we initially thought we could. This might happen when
350 // a multiline inset becomes an inline inset when the second
351 // paragraph is removed.
352 if (safe.pit() > safe.lastpit()) {
353 safe.pit() = safe.lastpit();
354 safe.pos() = safe.lastpos();
357 disp_.screenUpdate(Update::None);
358 disp_.dispatched(false);
360 // restore the previous one because nested Cursor::dispatch calls
361 // are possible which would change it
362 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
366 // NOTE: The code below has been copied to BufferView::dispatch.
367 // If you need to modify this, please update the other one too.
369 // notify insets we just left
371 old.beginUndoGroup();
373 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
376 bv().resetInlineCompletionPos();
383 DispatchResult const & Cursor::result() const
389 BufferView & Cursor::bv() const
398 LBUFERR(depth() >= 1);
403 void Cursor::push(Inset & p)
405 push_back(CursorSlice(p));
406 p.setBuffer(*buffer());
410 void Cursor::pushBackward(Inset & p)
412 LASSERT(!empty(), return);
413 //lyxerr << "Entering inset " << t << " front" << endl;
419 bool Cursor::popBackward()
421 LASSERT(!empty(), return false);
429 bool Cursor::popForward()
431 LASSERT(!empty(), return false);
432 //lyxerr << "Leaving inset from in back" << endl;
433 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
437 pos() += lastpos() - lp + 1;
442 int Cursor::currentMode()
444 LASSERT(!empty(), return Inset::UNDECIDED_MODE);
445 for (int i = depth() - 1; i >= 0; --i) {
446 int res = operator[](i).inset().currentMode();
447 bool locked_mode = operator[](i).inset().lockedMode();
448 // Also return UNDECIDED_MODE when the mode is locked,
449 // as in this case it is treated the same as TEXT_MODE
450 if (res != Inset::UNDECIDED_MODE || locked_mode)
453 return Inset::TEXT_MODE;
457 bool Cursor::inCoordCache() const
459 // the root inset is not in cache, but we do not need it.
462 CoordCache::Insets const & icache = bv_->coordCache().getInsets();
463 for (size_t i = 1 ; i < depth() ; ++i)
464 if (!icache.has(&(*this)[i].inset()))
470 void Cursor::getPos(int & x, int & y) const
472 Point p = bv().getPos(*this);
478 Row const & Cursor::textRow() const
480 CursorSlice const & cs = innerTextSlice();
481 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
482 return pm.getRow(pos(), boundary());
486 void Cursor::resetAnchor()
489 checkNewWordPosition();
493 void Cursor::markNewWordPosition()
495 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
496 FontSpan nw = locateWord(WHOLE_WORD);
497 if (nw.size() == 1) {
498 LYXERR(Debug::DEBUG, "start new word: "
500 << " pos: " << nw.first);
507 void Cursor::clearNewWordPosition()
509 if (!new_word_.empty()) {
510 LYXERR(Debug::DEBUG, "clear new word: "
512 << " pos: " << pos());
518 void Cursor::checkNewWordPosition()
520 if (!lyxrc.spellcheck_continuously || new_word_.empty())
523 clearNewWordPosition();
525 // forget the position of the current new word if
526 // 1) the paragraph changes or
527 // 2) the count of nested insets changes or
528 // 3) the cursor pos is out of paragraph bound
529 if (pit() != new_word_.pit() ||
530 depth() != new_word_.depth() ||
531 new_word_.pos() > new_word_.lastpos()) {
532 clearNewWordPosition();
533 } else if (new_word_.fixIfBroken())
534 // 4) or the remembered position was "broken"
535 clearNewWordPosition();
537 FontSpan nw = locateWord(WHOLE_WORD);
539 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
540 if (nw.intersect(ow).empty())
541 clearNewWordPosition();
543 LYXERR(Debug::DEBUG, "new word: "
545 << " pos: " << nw.first << ".." << nw.last);
547 clearNewWordPosition();
554 bool Cursor::posBackward()
563 bool Cursor::posForward()
565 if (pos() == lastpos())
572 bool Cursor::posVisRight(bool skip_inset)
574 Cursor new_cur = *this; // where we will move to
575 pos_type left_pos; // position visually left of current cursor
576 pos_type right_pos; // position visually right of current cursor
578 getSurroundingPos(left_pos, right_pos);
580 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
582 // Are we at an inset?
583 new_cur.pos() = right_pos;
584 new_cur.boundary(false);
586 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
587 // we actually move the cursor at the end of this
588 // function, for now we just keep track of the new
589 // position in new_cur...
590 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
593 // Are we already at rightmost pos in row?
594 else if (text()->empty() || right_pos == -1) {
597 if (!new_cur.posVisToNewRow(false)) {
598 LYXERR(Debug::RTL, "not moving!");
602 // we actually move the cursor at the end of this
603 // function, for now just keep track of the new
604 // position in new_cur...
605 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
606 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
609 // normal movement to the right
612 // Recall, if the cursor is at position 'x', that
613 // means *before* the character at position 'x'. In
614 // RTL, "before" means "to the right of", in LTR, "to
615 // the left of". So currently our situation is this:
616 // the position to our right is 'right_pos' (i.e.,
617 // we're currently to the left of 'right_pos'). In
618 // order to move to the right, it depends whether or
619 // not the character at 'right_pos' is RTL.
620 bool const new_pos_is_RTL = paragraph().getFontSettings(
621 buffer()->params(), right_pos).isVisibleRightToLeft();
622 // If the character at 'right_pos' *is* LTR, then in
623 // order to move to the right of it, we need to be
624 // *after* 'right_pos', i.e., move to position
626 if (!new_pos_is_RTL) {
627 new_cur.pos() = right_pos + 1;
628 // set the boundary to true in two situations:
630 // 1. if new_pos is now lastpos, and we're in
631 // an RTL paragraph (this means that we're
632 // moving right to the end of an LTR chunk
633 // which is at the end of an RTL paragraph);
634 (new_cur.pos() == lastpos()
635 && paragraph().isRTL(buffer()->params()))
636 // 2. if the position *after* right_pos is RTL
637 // (we want to be *after* right_pos, not
638 // before right_pos + 1!)
639 || paragraph().getFontSettings(buffer()->params(),
640 new_cur.pos()).isVisibleRightToLeft()
642 new_cur.boundary(true);
643 else // set the boundary to false
644 new_cur.boundary(false);
646 // Otherwise (if the character at position 'right_pos'
647 // is RTL), then moving to the right of it is as easy
648 // as setting the new position to 'right_pos'.
650 new_cur.pos() = right_pos;
651 new_cur.boundary(false);
656 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
659 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
660 << (new_cur.boundary() ? " (boundary)" : ""));
668 bool Cursor::posVisLeft(bool skip_inset)
670 Cursor new_cur = *this; // where we will move to
671 pos_type left_pos; // position visually left of current cursor
672 pos_type right_pos; // position visually right of current cursor
674 getSurroundingPos(left_pos, right_pos);
676 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
678 // Are we at an inset?
679 new_cur.pos() = left_pos;
680 new_cur.boundary(false);
682 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
683 // we actually move the cursor at the end of this
684 // function, for now we just keep track of the new
685 // position in new_cur...
686 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
689 // Are we already at leftmost pos in row?
690 else if (text()->empty() || left_pos == -1) {
693 if (!new_cur.posVisToNewRow(true)) {
694 LYXERR(Debug::RTL, "not moving!");
698 // we actually move the cursor at the end of this
699 // function, for now just keep track of the new
700 // position in new_cur...
701 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
702 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
705 // normal movement to the left
708 // Recall, if the cursor is at position 'x', that
709 // means *before* the character at position 'x'. In
710 // RTL, "before" means "to the right of", in LTR, "to
711 // the left of". So currently our situation is this:
712 // the position to our left is 'left_pos' (i.e., we're
713 // currently to the right of 'left_pos'). In order to
714 // move to the left, it depends whether or not the
715 // character at 'left_pos' is RTL.
716 bool const new_pos_is_RTL = paragraph().getFontSettings(
717 buffer()->params(), left_pos).isVisibleRightToLeft();
718 // If the character at 'left_pos' *is* RTL, then in
719 // order to move to the left of it, we need to be
720 // *after* 'left_pos', i.e., move to position
722 if (new_pos_is_RTL) {
723 new_cur.pos() = left_pos + 1;
724 // set the boundary to true in two situations:
726 // 1. if new_pos is now lastpos and we're in
727 // an LTR paragraph (this means that we're
728 // moving left to the end of an RTL chunk
729 // which is at the end of an LTR paragraph);
730 (new_cur.pos() == lastpos()
731 && !paragraph().isRTL(buffer()->params()))
732 // 2. if the position *after* left_pos is not
733 // RTL (we want to be *after* left_pos, not
734 // before left_pos + 1!)
735 || !paragraph().getFontSettings(buffer()->params(),
736 new_cur.pos()).isVisibleRightToLeft()
738 new_cur.boundary(true);
739 else // set the boundary to false
740 new_cur.boundary(false);
742 // Otherwise (if the character at position 'left_pos'
743 // is LTR), then moving to the left of it is as easy
744 // as setting the new position to 'left_pos'.
746 new_cur.pos() = left_pos;
747 new_cur.boundary(false);
752 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
755 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
756 << (new_cur.boundary() ? " (boundary)" : ""));
766 // Return true on success
767 bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
770 while (cit != row.begin() && cit->isVirtual())
773 while (cit != row.end() && cit->isVirtual())
776 return cit != row.end() && !cit->isVirtual();
781 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
783 // by default, we know nothing.
787 Row const & row = textRow();
788 TextMetrics const & tm = bv_->textMetrics(text());
790 Row::const_iterator cit = tm.findRowElement(row, pos(), boundary(), dummy);
791 // Handle the case of empty row
792 if (cit == row.end()) {
794 right_pos = row.pos();
796 left_pos = row.pos() - 1;
800 // skip virtual elements and exit if no non-virtual one exists
801 if (!findNonVirtual(row, cit, !cit->isRTL()))
804 // if the position is at the left side of the element, we have to
805 // look at the previous element
806 if (pos() == cit->left_pos()) {
807 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
808 << "), AT LEFT of *cit=" << *cit);
809 // this one is easy (see common case below)
810 right_pos = pos() - (cit->isRTL() ? 1 : 0);
811 // at the left of the row
812 if (cit == row.begin())
815 if (!findNonVirtual(row, cit, true))
817 // [...[ is the row element, | is cursor position (! with boundary)
818 // [ 1 2 [ is a ltr row element with pos=1 and endpos=3
819 // ] 2 1] is an rtl row element with pos=1 and endpos=3
820 // [ 1 2 [ [|3 4 [ => (2, 3)
821 // or [ 1 2 [ ]!4 3 ] => (2, 4)
822 // or ] 2 1 ] [|3 4 [ => (1, 3)
823 // or ] 4 3 ] ]!2 1 ] => (3, 2)
824 left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
825 // happens with consecutive row of same direction
826 if (left_pos == right_pos) {
827 left_pos += cit->isRTL() ? 1 : -1;
830 // same code but with the element at the right
831 else if (pos() == cit->right_pos()) {
832 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
833 << "), AT RIGHT of *cit=" << *cit);
834 // this one is easy (see common case below)
835 left_pos = pos() - (cit->isRTL() ? 0 : 1);
836 // at the right of the row
837 if (cit + 1 == row.end())
840 if (!findNonVirtual(row, cit, false))
842 // [ 1 2![ [ 3 4 [ => (2, 3)
843 // or [ 1 2![ ] 4 3 ] => (2, 4)
844 // or ] 2 1|] [ 3 4 [ => (1, 3)
845 // or ] 4 3|] ] 2 1 ] => (3, 2)
846 right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
847 // happens with consecutive row of same direction
848 if (right_pos == left_pos)
849 right_pos += cit->isRTL() ? -1 : 1;
851 // common case: both positions are inside the row element
853 // [ 1 2|3 [ => (2, 3)
854 // or ] 3|2 1 ] => (3, 2)
855 left_pos = pos() - (cit->isRTL() ? 0 : 1);
856 right_pos = pos() - (cit->isRTL() ? 1 : 0);
859 // Note that debug message does not catch all early returns above
860 LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
861 << ") => (" << left_pos << ", " << right_pos <<")");
865 bool Cursor::posVisToNewRow(bool movingLeft)
867 Row const & row = textRow();
868 bool par_is_LTR = !row.isRTL();
870 // Inside a table, determining whether to move to the next or
871 // previous row should be done based on the table's direction.
872 if (inset().asInsetTabular()) {
873 par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
874 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
877 // if moving left in an LTR paragraph or moving right in an
878 // RTL one, move to previous row
879 if (par_is_LTR == movingLeft) {
880 if (row.pos() == 0) { // we're at first row in paragraph
881 if (pit() == 0) // no previous paragraph! don't move
883 // move to last pos in previous par
887 } else { // move to previous row in this par
888 pos() = row.pos() - 1; // this is guaranteed to be in previous row
892 // if moving left in an RTL paragraph or moving right in an
893 // LTR one, move to next row
895 if (row.endpos() == lastpos()) { // we're at last row in paragraph
896 if (pit() == lastpit()) // last paragraph! don't move
898 // move to first row in next par
902 } else { // move to next row in this par
903 pos() = row.endpos();
908 // make sure we're at left-/right-most pos in new row
909 posVisToRowExtremity(!movingLeft);
915 void Cursor::posVisToRowExtremity(bool left)
917 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
918 << (boundary() ? 1 : 0));
920 TextMetrics const & tm = bv_->textMetrics(text());
921 // Looking for extremities is like clicking on the left or the
923 int x = tm.origin().x_ + (left ? 0 : textRow().width());
925 pos() = tm.getPosNearX(textRow(), x, b);
928 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
929 << (boundary() ? 1 : 0));
933 bool Cursor::reverseDirectionNeeded() const
936 * We determine the directions based on the direction of the
937 * bottom() --- i.e., outermost --- paragraph, because that is
938 * the only way to achieve consistency of the arrow's movements
939 * within a paragraph, and thus avoid situations in which the
942 return bottom().paragraph().isRTL(bv().buffer().params());
946 CursorSlice Cursor::normalAnchor() const
950 // LASSERT: There have been several bugs around this code, that seem
951 // to involve failures to reset the anchor. We can at least not crash
952 // in release mode by resetting it ourselves.
953 if (anchor_.depth() < depth()) {
954 LYXERR0("Cursor is deeper than anchor. PLEASE REPORT.\nCursor is"
956 const_cast<DocIterator &>(anchor_) = *this;
959 CursorSlice normal = anchor_[depth() - 1];
960 if (depth() < anchor_.depth() && top() <= normal) {
961 // anchor is behind cursor -> move anchor behind the inset
968 CursorSlice Cursor::selBegin() const
972 return normalAnchor() < top() ? normalAnchor() : top();
976 CursorSlice Cursor::selEnd() const
980 return normalAnchor() > top() ? normalAnchor() : top();
984 DocIterator Cursor::selectionBegin() const
990 // FIXME: This is a work-around for the problem that
991 // CursorSlice doesn't keep track of the boundary.
992 if (normalAnchor() == top())
993 di = anchor_.boundary() > boundary() ? anchor_ : *this;
995 di = normalAnchor() < top() ? anchor_ : *this;
1001 DocIterator Cursor::selectionEnd() const
1007 // FIXME: This is a work-around for the problem that
1008 // CursorSlice doesn't keep track of the boundary.
1009 if (normalAnchor() == top())
1010 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1012 di = normalAnchor() > top() ? anchor_ : *this;
1014 if (di.depth() > depth()) {
1022 void Cursor::setSelection()
1025 if (idx() == normalAnchor().idx() &&
1026 pit() == normalAnchor().pit() &&
1027 pos() == normalAnchor().pos())
1032 void Cursor::setSelection(DocIterator const & where, int n)
1041 void Cursor::clearSelection()
1044 setWordSelection(false);
1050 void Cursor::setTargetX(int x)
1053 textTargetOffset_ = 0;
1057 int Cursor::x_target() const
1063 void Cursor::clearTargetX()
1066 textTargetOffset_ = 0;
1070 void Cursor::updateTextTargetOffset()
1075 textTargetOffset_ = x - x_target_;
1079 void Cursor::info(odocstream & os) const
1081 for (int i = 1, n = depth(); i < n; ++i) {
1082 operator[](i).inset().infoize(os);
1086 Inset const * inset = prevInset();
1087 // prevInset() can return 0 in certain case.
1089 prevInset()->infoize2(os);
1094 bool Cursor::selHandle(bool sel)
1096 //lyxerr << "Cursor::selHandle" << endl;
1099 if (sel == selection())
1103 cap::saveSelection(*this);
1112 ///////////////////////////////////////////////////////////////////
1115 // The part below is the non-integrated rest of the original math
1116 // cursor. This should be either generalized for texted or moved
1117 // back to mathed (in most cases to InsetMathNest).
1119 ///////////////////////////////////////////////////////////////////
1121 #include "mathed/InsetMathChar.h"
1122 #include "mathed/InsetMathGrid.h"
1123 #include "mathed/InsetMathScript.h"
1124 #include "mathed/InsetMathUnknown.h"
1125 #include "mathed/MathFactory.h"
1126 #include "mathed/MathStream.h"
1127 #include "mathed/MathSupport.h"
1132 bool Cursor::isInside(Inset const * p) const
1134 for (size_t i = 0; i != depth(); ++i)
1135 if (&operator[](i).inset() == p)
1141 void Cursor::leaveInset(Inset const & inset)
1143 for (size_t i = 0; i != depth(); ++i) {
1144 if (&operator[](i).inset() == &inset) {
1152 bool Cursor::openable(MathAtom const & t) const
1163 // we can't move into anything new during selection
1164 if (depth() >= anchor_.depth())
1166 if (t.nucleus() != &anchor_[depth()].inset())
1173 void Cursor::setScreenPos(int x, int /*y*/)
1176 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1181 void Cursor::plainErase()
1183 cell().erase(pos());
1187 void Cursor::markInsert()
1189 insert(char_type(0));
1193 void Cursor::markErase()
1195 cell().erase(pos());
1199 void Cursor::plainInsert(MathAtom const & t)
1201 cell().insert(pos(), t);
1203 inset().setBuffer(bv_->buffer());
1205 checkBufferStructure();
1209 void Cursor::insert(docstring const & str)
1211 for (char_type c : str)
1216 void Cursor::insert(char_type c)
1218 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1219 LASSERT(!empty(), return);
1221 cap::selClearOrDel(*this);
1222 insert(new InsetMathChar(c));
1224 text()->insertChar(*this, c);
1229 void Cursor::insert(MathAtom const & t)
1231 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1233 cap::selClearOrDel(*this);
1238 void Cursor::insert(Inset * inset0)
1240 LASSERT(inset0, return);
1242 insert(MathAtom(inset0->asInsetMath()));
1244 text()->insertInset(*this, inset0);
1245 inset0->setBuffer(bv_->buffer());
1247 if (inset0->isLabeled())
1248 forceBufferUpdate();
1253 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1255 MathData ar(buffer());
1257 if (ar.size() == 1 && (enter || selection()))
1265 void Cursor::niceInsert(MathAtom const & t)
1268 docstring const safe = cap::grabAndEraseSelection(*this);
1270 // If possible, enter the new inset and move the contents of the selection
1271 if (t->isActive()) {
1273 // be careful here: don't use 'pushBackward(t)' as this we need to
1274 // push the clone, not the original
1275 pushBackward(*nextInset());
1276 // We may not use niceInsert here (recursion)
1277 MathData ar(buffer());
1280 } else if (t->asMacro() && !safe.empty()) {
1281 MathData ar(buffer());
1283 docstring const name = t->asMacro()->name();
1284 MacroData const * data = buffer()->getMacro(name);
1285 if (data && data->numargs() - data->optionals() > 0) {
1286 plainInsert(MathAtom(new InsetMathBrace(ar)));
1293 void Cursor::insert(MathData const & ar)
1297 cap::eraseSelection(*this);
1298 cell().insert(pos(), ar);
1300 // FIXME audit setBuffer calls
1301 inset().setBuffer(bv_->buffer());
1305 bool Cursor::backspace()
1308 cap::eraseSelection(*this);
1313 // If empty cell, and not part of a big cell
1314 if (lastpos() == 0 && inset().nargs() == 1) {
1316 // Directly delete empty cell: [|[]] => [|]
1322 // [|], can not delete from inside
1333 if (inMacroMode()) {
1334 InsetMathUnknown * p = activeMacro();
1335 if (p->name().size() > 1) {
1336 p->setName(p->name().substr(0, p->name().size() - 1));
1341 if (pos() != 0 && prevAtom()->nargs() > 0) {
1342 // let's require two backspaces for 'big stuff' and
1343 // highlight on the first
1355 bool Cursor::erase()
1361 cap::eraseSelection(*this);
1365 // delete empty cells if possible
1366 if (pos() == lastpos() && inset().idxDelete(idx()))
1369 // special behaviour when in last position of cell
1370 if (pos() == lastpos()) {
1371 bool one_cell = inset().nargs() == 1;
1372 if (one_cell && lastpos() == 0) {
1374 // Directly delete empty cell: [|[]] => [|]
1380 // [|], can not delete from inside
1385 inset().idxGlue(idx());
1389 // 'clever' UI hack: only erase large items if previously slected
1390 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1405 DocIterator save = *this;
1406 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1407 this->dispatch(cmd);
1408 if (disp_.dispatched())
1418 DocIterator save = *this;
1419 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1420 this->dispatch(cmd);
1421 if (disp_.dispatched())
1428 bool Cursor::macroModeClose()
1432 InsetMathUnknown * p = activeMacro();
1434 MathData selection(buffer());
1435 asArray(p->selection(), selection);
1436 docstring const s = p->name();
1438 cell().erase(pos());
1440 // do nothing if the macro name is empty
1444 // trigger updates of macros, at least, if no full
1445 // updates take place anyway
1446 screenUpdateFlags(Update::Force);
1448 docstring const name = s.substr(1);
1449 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1450 if (in && in->interpretString(*this, s))
1452 bool const user_macro = buffer()->getMacro(name, *this, false);
1453 MathAtom atom = user_macro ? MathAtom(new MathMacro(buffer(), name))
1454 : createInsetMath(name, buffer());
1456 // try to put argument into macro, if we just inserted a macro
1457 bool macroArg = false;
1458 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1460 // macros here are still unfolded (in init mode in fact). So
1461 // we have to resolve the macro here manually and check its arity
1462 // to put the selection behind it if arity > 0.
1463 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1464 if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
1466 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1468 // non-greedy case. Do not touch the arguments behind
1469 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1472 // insert remembered selection into first argument of a non-macro
1473 else if (atom.nucleus()->nargs() > 0)
1474 atom.nucleus()->cell(0).append(selection);
1476 MathWordList const & words = mathedWordList();
1477 MathWordList::const_iterator it = words.find(name);
1478 bool keep_mathmode = it != words.end() && (it->second.inset == "font"
1479 || it->second.inset == "oldfont"
1480 || it->second.inset == "mbox");
1481 bool ert_macro = !user_macro && it == words.end() && atomAsMacro;
1483 if (in && in->currentMode() == Inset::TEXT_MODE
1484 && atom.nucleus()->currentMode() == Inset::MATH_MODE
1485 && name != from_ascii("ensuremath") && !ert_macro) {
1486 MathAtom at(new InsetMathEnsureMath(buffer()));
1487 at.nucleus()->cell(0).push_back(atom);
1490 } else if (in && in->currentMode() == Inset::MATH_MODE
1491 && atom.nucleus()->currentMode() == Inset::TEXT_MODE
1492 && !keep_mathmode) {
1493 MathAtom at = createInsetMath("text", buffer());
1494 at.nucleus()->cell(0).push_back(atom);
1500 // finally put the macro argument behind, if needed
1502 if (selection.size() > 1 || selection[0]->asScriptInset())
1503 plainInsert(MathAtom(new InsetMathBrace(selection)));
1512 docstring Cursor::macroName()
1514 return inMacroMode() ? activeMacro()->name() : docstring();
1518 void Cursor::handleNest(MathAtom const & a, int c)
1520 //lyxerr << "Cursor::handleNest: " << c << endl;
1522 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1525 pushBackward(*nextInset());
1529 int Cursor::targetX() const
1531 if (x_target() != -1)
1540 int Cursor::textTargetOffset() const
1542 return textTargetOffset_;
1546 void Cursor::setTargetX()
1555 bool Cursor::inMacroMode() const
1559 if (pos() == 0 || cell().empty())
1561 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1562 return p && !p->final();
1566 InsetMathUnknown * Cursor::activeMacro()
1568 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1572 InsetMathUnknown const * Cursor::activeMacro() const
1574 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1578 void Cursor::pullArg()
1581 MathData ar = cell();
1582 if (popBackward() && inMathed()) {
1584 cell().insert(pos(), ar);
1587 //formula()->mutateToText();
1592 void Cursor::touch()
1596 DocIterator::const_iterator it = begin();
1597 DocIterator::const_iterator et = end();
1598 for ( ; it != et; ++it)
1604 void Cursor::normalize()
1606 if (idx() > lastidx()) {
1607 lyxerr << "this should not really happen - 1: "
1608 << idx() << ' ' << nargs()
1609 << " in: " << &inset() << endl;
1613 if (pos() > lastpos()) {
1614 lyxerr << "this should not really happen - 2: "
1615 << pos() << ' ' << lastpos() << " in idx: " << idx()
1617 odocstringstream os;
1618 otexrowstream ots(os);
1619 WriteStream wi(ots, false, true, WriteStream::wsDefault);
1620 inset().asInsetMath()->write(wi);
1621 lyxerr << to_utf8(os.str()) << endl;
1627 bool Cursor::upDownInMath(bool up)
1629 // Be warned: The 'logic' implemented in this function is highly
1630 // fragile. A distance of one pixel or a '<' vs '<=' _really
1631 // matters. So fiddle around with it only if you think you know
1632 // what you are doing!
1636 xo = beforeDispatchPosX_;
1638 // check if we had something else in mind, if not, this is the future
1640 if (x_target_ == -1)
1642 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1643 // In text mode inside the line (not left or right) possibly set a new target_x,
1644 // but only if we are somewhere else than the previous target-offset.
1646 // We want to keep the x-target on subsequent up/down movements
1647 // that cross beyond the end of short lines. Thus a special
1648 // handling when the cursor is at the end of line: Use the new
1649 // x-target only if the old one was before the end of line
1650 // or the old one was after the beginning of the line
1651 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1655 left = pos() == textRow().endpos();
1656 right = pos() == textRow().pos();
1658 left = pos() == textRow().pos();
1659 right = pos() == textRow().endpos();
1661 if ((!left && !right) ||
1662 (left && !right && xo < x_target_) ||
1663 (!left && right && x_target_ < xo))
1670 // try neigbouring script insets
1672 if (inMathed() && !selection()) {
1675 InsetMathScript const * p = prevAtom()->asScriptInset();
1676 if (p && p->has(up)) {
1678 push(*const_cast<InsetMathScript*>(p));
1679 idx() = p->idxOfScript(up);
1682 // we went in the right direction? Otherwise don't jump into the script
1686 int oy = beforeDispatchPosY_;
1687 if ((!up && y <= oy) ||
1696 if (pos() != lastpos()) {
1697 InsetMathScript const * p = nextAtom()->asScriptInset();
1698 if (p && p->has(up)) {
1699 push(*const_cast<InsetMathScript*>(p));
1700 idx() = p->idxOfScript(up);
1703 // we went in the right direction? Otherwise don't jump into the script
1707 int oy = beforeDispatchPosY_;
1708 if ((!up && y <= oy) ||
1717 // try to find an inset that knows better then we,
1718 if (inset().idxUpDown(*this, up)) {
1719 //lyxerr << "idxUpDown triggered" << endl;
1720 // try to find best position within this inset
1722 setCursor(bruteFind(*this, xo, yo));
1726 // any improvement going just out of inset?
1727 if (popBackward() && inMathed()) {
1728 //lyxerr << "updown: popBackward succeeded" << endl;
1731 int yold = beforeDispatchPosY_;
1733 if (up ? ynew < yold : ynew > yold)
1737 // no success, we are probably at the document top or bottom
1743 InsetMath & Cursor::nextMath()
1745 return *nextAtom().nucleus();
1749 InsetMath & Cursor::prevMath()
1751 return *prevAtom().nucleus();
1755 bool Cursor::mathForward(bool word)
1757 LASSERT(inMathed(), return false);
1758 if (pos() < lastpos()) {
1760 // word: skip a group of insets with same math class
1761 MathClass mc = nextMath().mathClass();
1764 while (pos() < lastpos() && mc == nextMath().mathClass());
1765 } else if (openable(nextAtom())) {
1766 // single step: try to enter the next inset
1767 pushBackward(nextMath());
1768 inset().idxFirst(*this);
1773 if (inset().idxForward(*this))
1775 // try to pop forwards --- but don't pop out of math! leave that to
1777 int s = depth() - 2;
1778 if (s >= 0 && operator[](s).inset().asInsetMath())
1779 return popForward();
1784 bool Cursor::mathBackward(bool word)
1786 LASSERT(inMathed(), return false);
1789 // word: skip a group of insets with same math class
1790 MathClass mc = prevMath().mathClass();
1793 while (pos() > 0 && mc == prevMath().mathClass());
1794 } else if (openable(prevAtom())) {
1795 // single step: try to enter the preceding inset
1798 inset().idxLast(*this);
1803 if (inset().idxBackward(*this))
1805 // try to pop backwards --- but don't pop out of math! leave that to
1807 int s = depth() - 2;
1808 if (s >= 0 && operator[](s).inset().asInsetMath())
1809 return popBackward();
1814 bool Cursor::atFirstOrLastRow(bool up)
1816 TextMetrics const & tm = bv_->textMetrics(text());
1817 ParagraphMetrics const & pm = tm.parMetrics(pit());
1820 if (pos() && boundary())
1821 row = pm.pos2row(pos() - 1);
1823 row = pm.pos2row(pos());
1826 if (pit() == 0 && row == 0)
1829 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1830 row + 1 >= int(pm.rows().size()))
1837 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1839 LASSERT(text(), return false);
1845 xo = beforeDispatchPosX_;
1847 // update the targetX - this is here before the "return false"
1848 // to set a new target which can be used by InsetTexts above
1849 // if we cannot move up/down inside this inset anymore
1850 if (x_target_ == -1)
1852 else if (xo - textTargetOffset() != x_target() &&
1853 depth() == beforeDispatchCursor_.depth()) {
1854 // In text mode inside the line (not left or right)
1855 // possibly set a new target_x, but only if we are
1856 // somewhere else than the previous target-offset.
1858 // We want to keep the x-target on subsequent up/down
1859 // movements that cross beyond the end of short lines.
1860 // Thus a special handling when the cursor is at the
1861 // end of line: Use the new x-target only if the old
1862 // one was before the end of line or the old one was
1863 // after the beginning of the line
1864 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1868 left = pos() == textRow().endpos();
1869 right = pos() == textRow().pos();
1871 left = pos() == textRow().pos();
1872 right = pos() == textRow().endpos();
1874 if ((!left && !right) ||
1875 (left && !right && xo < x_target_) ||
1876 (!left && right && x_target_ < xo))
1883 // first get the current line
1884 TextMetrics & tm = bv_->textMetrics(text());
1885 ParagraphMetrics const & pm = tm.parMetrics(pit());
1887 if (pos() && boundary())
1888 row = pm.pos2row(pos() - 1);
1890 row = pm.pos2row(pos());
1892 if (atFirstOrLastRow(up)) {
1893 // Is there a place for the cursor to go ? If yes, we
1894 // can execute the DEPM, otherwise we should keep the
1895 // paragraph to host the cursor.
1896 Cursor dummy = *this;
1897 bool valid_destination = false;
1898 for(; dummy.depth(); dummy.pop())
1899 if (!dummy.atFirstOrLastRow(up)) {
1900 valid_destination = true;
1904 // will a next dispatch follow and if there is a new
1905 // dispatch will it move the cursor out ?
1906 if (depth() > 1 && valid_destination) {
1907 // The cursor hasn't changed yet. This happens when
1908 // you e.g. move out of an inset. And to give the
1909 // DEPM the possibility of doing something we must
1910 // provide it with two different cursors. (Lgb, vfr)
1912 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1913 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1915 updateNeeded |= bv().checkDepm(dummy, *this);
1916 updateTextTargetOffset();
1918 forceBufferUpdate();
1923 // with and without selection are handled differently
1925 int yo = bv().getPos(*this).y_;
1927 // To next/previous row
1929 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1931 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1934 // This happens when you move out of an inset.
1935 // And to give the DEPM the possibility of doing
1936 // something we must provide it with two different
1938 Cursor dummy = *this;
1941 if (bv().checkDepm(dummy, old)) {
1942 updateNeeded = true;
1943 // Make sure that cur gets back whatever happened to dummy (Lgb)
1946 if (inTexted() && pos() && paragraph().isEnvSeparator(pos() - 1))
1949 // if there is a selection, we stay out of any inset,
1950 // and just jump to the right position:
1956 } else if (pit() > 0) {
1958 TextMetrics & tm = bv_->textMetrics(text());
1959 if (!tm.contains(pit()))
1960 tm.newParMetricsUp();
1961 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1962 next_row = pmcur.rows().size() - 1;
1965 if (row + 1 < int(pm.rows().size())) {
1967 } else if (pit() + 1 < int(text()->paragraphs().size())) {
1969 TextMetrics & tm = bv_->textMetrics(text());
1970 if (!tm.contains(pit()))
1971 tm.newParMetricsDown();
1976 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
1978 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
1981 updateNeeded |= bv().checkDepm(*this, old);
1985 forceBufferUpdate();
1986 updateTextTargetOffset();
1991 void Cursor::handleFont(string const & font)
1993 LYXERR(Debug::DEBUG, font);
1997 safe = cap::grabAndEraseSelection(*this);
2002 if (lastpos() != 0) {
2003 // something left in the cell
2005 // cursor in first position
2007 } else if (pos() == lastpos()) {
2008 // cursor in last position
2011 // cursor in between. split cell
2012 MathData::iterator bt = cell().begin();
2013 MathAtom at = createInsetMath(from_utf8(font), buffer());
2014 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2015 cell().erase(bt, bt + pos());
2020 // nothing left in the cell
2029 void Cursor::message(docstring const & msg) const
2031 disp_.setMessage(msg);
2035 void Cursor::errorMessage(docstring const & msg) const
2037 disp_.setMessage(msg);
2038 disp_.setError(true);
2044 docstring parbreak(Cursor const * cur)
2046 odocstringstream os;
2048 // only add blank line if we're not in a ParbreakIsNewline situation
2049 if (!cur->inset().getLayout().parbreakIsNewline()
2050 && !cur->paragraph().layout().parbreak_is_newline)
2058 docstring Cursor::selectionAsString(bool with_label) const
2064 return cap::grabSelection(*this);
2066 int const label = with_label
2067 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2069 idx_type const startidx = selBegin().idx();
2070 idx_type const endidx = selEnd().idx();
2071 if (startidx != endidx) {
2072 // multicell selection
2073 InsetTabular * table = inset().asInsetTabular();
2074 LASSERT(table, return docstring());
2075 return table->asString(startidx, endidx);
2078 ParagraphList const & pars = text()->paragraphs();
2080 pit_type const startpit = selBegin().pit();
2081 pit_type const endpit = selEnd().pit();
2082 size_t const startpos = selBegin().pos();
2083 size_t const endpos = selEnd().pos();
2085 if (startpit == endpit)
2086 return pars[startpit].asString(startpos, endpos, label);
2088 // First paragraph in selection
2089 docstring result = pars[startpit].
2090 asString(startpos, pars[startpit].size(), label)
2093 // The paragraphs in between (if any)
2094 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2095 Paragraph const & par = pars[pit];
2096 result += par.asString(0, par.size(), label)
2100 // Last paragraph in selection
2101 result += pars[endpit].asString(0, endpos, label);
2107 docstring Cursor::currentState() const
2110 odocstringstream os;
2112 #ifdef DEVEL_VERSION
2113 InsetMath * math = inset().asInsetMath();
2115 os << _(", Inset: ") << math->id();
2116 os << _(", Cell: ") << idx();
2117 os << _(", Position: ") << pos();
2123 return text()->currentState(*this);
2129 docstring Cursor::getPossibleLabel() const
2131 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2135 Encoding const * Cursor::getEncoding() const
2139 BufferParams const & bp = bv().buffer().params();
2140 if (bp.useNonTeXFonts)
2141 return encodings.fromLyXName("utf8-plain");
2143 CursorSlice const & sl = innerTextSlice();
2144 Text const & text = *sl.text();
2145 Font font = text.getPar(sl.pit()).getFont(bp, sl.pos(),
2146 text.outerFont(sl.pit()));
2147 return font.language()->encoding();
2151 void Cursor::undispatched() const
2153 disp_.dispatched(false);
2157 void Cursor::dispatched() const
2159 disp_.dispatched(true);
2163 void Cursor::screenUpdateFlags(Update::flags f) const
2165 disp_.screenUpdate(f);
2169 void Cursor::forceBufferUpdate() const
2171 disp_.forceBufferUpdate();
2175 void Cursor::clearBufferUpdate() const
2177 disp_.clearBufferUpdate();
2181 bool Cursor::needBufferUpdate() const
2183 return disp_.needBufferUpdate();
2187 void Cursor::noScreenUpdate() const
2189 disp_.screenUpdate(Update::None);
2193 Font Cursor::getFont() const
2195 // The logic here should more or less match to the
2196 // Cursor::setCurrentFont logic, i.e. the cursor height should
2197 // give a hint what will happen if a character is entered.
2198 // FIXME: this is not the case, what about removing this method ? (see #10478).
2200 // HACK. far from being perfect...
2202 CursorSlice const & sl = innerTextSlice();
2203 Text const & text = *sl.text();
2204 Paragraph const & par = text.getPar(sl.pit());
2206 // on boundary, so we are really at the character before
2207 pos_type pos = sl.pos();
2208 if (pos > 0 && boundary())
2211 // on space? Take the font before (only for RTL boundary stay)
2213 TextMetrics const & tm = bv().textMetrics(&text);
2214 if (pos == sl.lastpos()
2215 || (par.isSeparator(pos)
2216 && !tm.isRTLBoundary(sl.pit(), pos)))
2220 // get font at the position
2221 Font font = par.getFont(buffer()->params(), pos,
2222 text.outerFont(sl.pit()));
2228 bool Cursor::fixIfBroken()
2230 bool const broken_cursor = DocIterator::fixIfBroken();
2231 bool const broken_anchor = anchor_.fixIfBroken();
2233 if (broken_cursor || broken_anchor) {
2234 clearNewWordPosition();
2242 void Cursor::sanitize()
2244 setBuffer(&bv_->buffer());
2245 DocIterator::sanitize();
2246 new_word_.sanitize();
2254 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2256 // find inset in common
2258 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2259 if (&old[i].inset() != &cur[i].inset())
2263 // update words if we just moved to another paragraph
2264 if (i == old.depth() && i == cur.depth()
2265 && !cur.buffer()->isClean()
2266 && cur.inTexted() && old.inTexted()
2267 && cur.pit() != old.pit()) {
2268 old.paragraph().updateWords();
2271 // notify everything on top of the common part in old cursor,
2272 // but stop if the inset claims the cursor to be invalid now
2273 for (size_type j = i; j < old.depth(); ++j) {
2274 Cursor inset_pos = old;
2275 inset_pos.cutOff(j);
2276 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2280 // notify everything on top of the common part in new cursor,
2281 // but stop if the inset claims the cursor to be invalid now
2282 for (; i < cur.depth(); ++i) {
2283 if (cur[i].inset().notifyCursorEnters(cur))
2291 void Cursor::setCurrentFont()
2293 CursorSlice const & cs = innerTextSlice();
2294 Paragraph const & par = cs.paragraph();
2295 pos_type cpit = cs.pit();
2296 pos_type cpos = cs.pos();
2297 Text const & ctext = *cs.text();
2298 TextMetrics const & tm = bv().textMetrics(&ctext);
2300 // are we behind previous char in fact? -> go to that char
2301 if (cpos > 0 && boundary())
2304 // find position to take the font from
2306 // paragraph end? -> font of last char
2307 if (cpos == lastpos())
2309 // on space? -> look at the words in front of space
2310 else if (cpos > 0 && par.isSeparator(cpos)) {
2311 // abc| def -> font of c
2312 // abc |[WERBEH], i.e. boundary==true -> font of c
2313 // abc [WERBEH]| def, font of the space
2314 if (!tm.isRTLBoundary(cpit, cpos))
2320 BufferParams const & bufparams = buffer()->params();
2321 current_font = par.getFontSettings(bufparams, cpos);
2322 real_current_font = tm.displayFont(cpit, cpos);
2324 // special case for paragraph end
2325 if (cs.pos() == lastpos()
2326 && tm.isRTLBoundary(cpit, cs.pos())
2328 Language const * lang = par.getParLanguage(bufparams);
2329 current_font.setLanguage(lang);
2330 current_font.fontInfo().setNumber(FONT_OFF);
2331 real_current_font.setLanguage(lang);
2332 real_current_font.fontInfo().setNumber(FONT_OFF);
2337 bool Cursor::textUndo()
2339 if (!buffer()->undo().textUndo(*this))
2346 bool Cursor::textRedo()
2348 if (!buffer()->undo().textRedo(*this))
2355 void Cursor::finishUndo() const
2357 buffer()->undo().finishUndo();
2361 void Cursor::beginUndoGroup() const
2363 buffer()->undo().beginUndoGroup(*this);
2367 void Cursor::endUndoGroup() const
2369 buffer()->undo().endUndoGroup(*this);
2373 void Cursor::recordUndo(pit_type from, pit_type to) const
2375 buffer()->undo().recordUndo(*this, from, to);
2379 void Cursor::recordUndo(pit_type from) const
2381 buffer()->undo().recordUndo(*this, from, pit());
2385 void Cursor::recordUndo(UndoKind kind) const
2387 buffer()->undo().recordUndo(*this, kind);
2391 void Cursor::recordUndoInset(Inset const * in) const
2393 buffer()->undo().recordUndoInset(*this, in);
2397 void Cursor::recordUndoFullBuffer() const
2399 buffer()->undo().recordUndoFullBuffer(*this);
2403 void Cursor::recordUndoBufferParams() const
2405 buffer()->undo().recordUndoBufferParams(*this);
2409 void Cursor::recordUndoSelection() const
2412 if (cap::multipleCellsSelected(*this))
2417 buffer()->undo().recordUndo(*this,
2418 selBegin().pit(), selEnd().pit());
2423 void Cursor::checkBufferStructure()
2425 Buffer const * master = buffer()->masterBuffer();
2426 master->tocBackend().updateItem(*this);
2427 if (master != buffer() && !master->hasGuiDelegate())
2428 // In case the master has no gui associated with it,
2429 // the TocItem is not updated (part of bug 5699).
2430 buffer()->tocBackend().updateItem(*this);
2432 // If the last tracked change of the paragraph has just been
2433 // deleted, then we need to recompute the buffer flag
2434 // tracked_changes_present_.
2435 if (inTexted() && paragraph().isChangeUpdateRequired())
2436 disp_.forceChangesUpdate();