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"
26 #include "FuncRequest.h"
29 #include "LyXAction.h"
31 #include "Paragraph.h"
32 #include "ParIterator.h"
34 #include "texstream.h"
36 #include "TextMetrics.h"
37 #include "TocBackend.h"
39 #include "support/debug.h"
40 #include "support/docstream.h"
41 #include "support/ExceptionMessage.h"
42 #include "support/gettext.h"
43 #include "support/lassert.h"
45 #include "insets/InsetTabular.h"
46 #include "insets/InsetText.h"
48 #include "mathed/InsetMath.h"
49 #include "mathed/InsetMathBrace.h"
50 #include "mathed/InsetMathEnsureMath.h"
51 #include "mathed/InsetMathScript.h"
52 #include "mathed/MacroTable.h"
53 #include "mathed/MathData.h"
54 #include "mathed/MathFactory.h"
55 #include "mathed/InsetMathMacro.h"
68 // Find position closest to (x, y) in cell given by iter.
69 // Used only in mathed
70 DocIterator bruteFind(Cursor const & c, int x, int y)
72 double best_dist = numeric_limits<double>::max();
79 et.pos() = et.lastpos();
80 for (size_t i = 0;; ++i) {
83 Inset const * inset = &it.inset();
84 CoordCache::Insets const & insetCache = c.bv().coordCache().getInsets();
86 // FIXME: in the case where the inset is not in the cache, this
87 // means that no part of it is visible on screen. In this case
88 // we don't do elaborate search and we just return the forwarded
89 // DocIterator at its beginning.
90 if (!insetCache.has(inset)) {
95 Point const o = insetCache.xy(inset);
96 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
97 // Convert to absolute
100 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
101 // '<=' in order to take the last possible position
102 // this is important for clicking behind \sum in e.g. '\sum_i a'
103 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
104 << " best: " << best_dist);
105 if (d <= best_dist) {
120 CursorData::CursorData()
121 : DocIterator(), anchor_(),
122 selection_(false), mark_(false), word_selection_(false),
123 current_font(inherit_font),
124 autocorrect_(false), macromode_(false)
128 CursorData::CursorData(Buffer * buffer)
129 : DocIterator(buffer), anchor_(),
130 selection_(false), mark_(false), word_selection_(false),
131 current_font(inherit_font),
132 autocorrect_(false), macromode_(false)
136 CursorData::CursorData(DocIterator const & dit)
137 : DocIterator(dit), anchor_(),
138 selection_(false), mark_(false), word_selection_(false),
139 current_font(inherit_font),
140 autocorrect_(false), macromode_(false)
146 ostream & operator<<(ostream & os, CursorData const & cur)
148 os << "\n cursor: | anchor:\n";
149 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
150 os << " " << cur[i] << " | ";
151 if (i < cur.anchor_.depth())
152 os << cur.anchor_[i];
154 os << "-------------------------------";
157 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
158 os << "------------------------------- | " << cur.anchor_[i] << "\n";
160 os << " selection: " << cur.selection_
161 // << " x_target: " << cur.x_target_
162 << " boundary: " << cur.boundary() << endl;
167 LyXErr & operator<<(LyXErr & os, CursorData const & cur)
174 // be careful: this is called from the bv's constructor, too, so
175 // bv functions are not yet available!
176 Cursor::Cursor(BufferView & bv)
177 : CursorData(&bv.buffer()), bv_(&bv),
178 x_target_(-1), textTargetOffset_(0),
179 beforeDispatchPosX_(0), beforeDispatchPosY_(0)
186 push_back(CursorSlice(buffer()->inset()));
187 anchor_ = doc_iterator_begin(buffer());
189 new_word_ = doc_iterator_begin(buffer());
197 void Cursor::setCursor(DocIterator const & cur)
199 DocIterator::operator=(cur);
203 void Cursor::setCursorSelectionTo(DocIterator dit)
207 while (i < dit.depth() && i < anchor_.depth() && dit[i] == anchor_[i])
209 if (i != dit.depth()) {
210 // otherwise the cursor is already normal
211 if (i == anchor_.depth())
212 // dit is a proper extension of the anchor_
214 else if (i + 1 < dit.depth()) {
215 // one has dit[i] != anchor_[i] but either dit[i-1] == anchor_[i-1]
216 // or i == 0. Remove excess.
218 if (dit[i] > anchor_[i])
219 // place dit after the inset it was in
228 void Cursor::setCursorToAnchor()
231 DocIterator normal = anchor_;
232 while (depth() < normal.depth())
234 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
241 void Cursor::setCursorData(CursorData const & data)
243 CursorData::operator=(data);
247 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
251 // Try to fix cursor in case it is broken.
254 // Is this a function that acts on inset at point?
255 Inset * inset = cur.nextInset();
256 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
257 && inset && inset->getStatus(cur, cmd, status))
260 // This is, of course, a mess. Better create a new doc iterator and use
261 // this in Inset::getStatus. This might require an additional
262 // BufferView * arg, though (which should be avoided)
263 //Cursor safe = *this;
265 for ( ; cur.depth(); cur.pop()) {
266 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
267 // LASSERT: Is it safe to continue here, or should we return?
268 LASSERT(cur.idx() <= cur.lastidx(), /**/);
269 LASSERT(cur.pit() <= cur.lastpit(), /**/);
270 LASSERT(cur.pos() <= cur.lastpos(), /**/);
272 // The inset's getStatus() will return 'true' if it made
273 // a definitive decision on whether it want to handle the
274 // request or not. The result of this decision is put into
275 // the 'status' parameter.
276 if (cur.inset().getStatus(cur, cmd, status)) {
285 void Cursor::saveBeforeDispatchPosXY()
287 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
291 void Cursor::dispatch(FuncRequest const & cmd0)
293 LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
298 FuncRequest cmd = cmd0;
301 disp_ = DispatchResult();
305 // Is this a function that acts on inset at point?
306 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
308 disp_.dispatched(true);
309 disp_.screenUpdate(Update::FitCursor | Update::Force);
310 FuncRequest tmpcmd = cmd;
311 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
312 << cmd0 << endl << *this);
313 nextInset()->dispatch(*this, tmpcmd);
314 if (disp_.dispatched()) {
320 // store some values to be used inside of the handlers
321 beforeDispatchCursor_ = *this;
322 for (; depth(); pop(), boundary(false)) {
323 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
324 << cmd0 << endl << *this);
326 // In any of these cases, the cursor is invalid, and we should
327 // try to save this document rather than crash.
328 LBUFERR(pos() <= lastpos());
329 LBUFERR(idx() <= lastidx());
330 LBUFERR(pit() <= lastpit());
332 // The common case is 'LFUN handled, need update', so make the
333 // LFUN handler's life easier by assuming this as default value.
334 // The handler can reset the update and val flags if necessary.
335 disp_.screenUpdate(Update::FitCursor | Update::Force);
336 disp_.dispatched(true);
337 inset().dispatch(*this, cmd);
338 if (disp_.dispatched())
342 // it completely to get a 'bomb early' behaviour in case this
343 // object will be used again.
344 if (!disp_.dispatched()) {
345 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
346 // We might have invalidated the cursor when removing an empty
347 // paragraph while the cursor could not be moved out the inset
348 // while we initially thought we could. This might happen when
349 // a multiline inset becomes an inline inset when the second
350 // paragraph is removed.
351 if (safe.pit() > safe.lastpit()) {
352 safe.pit() = safe.lastpit();
353 safe.pos() = safe.lastpos();
356 disp_.screenUpdate(Update::None);
357 disp_.dispatched(false);
359 // restore the previous one because nested Cursor::dispatch calls
360 // are possible which would change it
361 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
365 // NOTE: The code below has been copied to BufferView::dispatch.
366 // If you need to modify this, please update the other one too.
368 // notify insets we just left
370 old.beginUndoGroup();
372 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
375 bv().resetInlineCompletionPos();
382 DispatchResult const & Cursor::result() const
388 BufferView & Cursor::bv() const
397 LBUFERR(depth() >= 1);
402 void Cursor::push(Inset & p)
404 push_back(CursorSlice(p));
405 p.setBuffer(*buffer());
409 void Cursor::pushBackward(Inset & p)
411 LASSERT(!empty(), return);
412 //lyxerr << "Entering inset " << t << " front" << endl;
418 bool Cursor::popBackward()
420 LASSERT(!empty(), return false);
428 bool Cursor::popForward()
430 LASSERT(!empty(), return false);
431 //lyxerr << "Leaving inset from in back" << endl;
432 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
436 pos() += lastpos() - lp + 1;
441 int Cursor::currentMode()
443 LASSERT(!empty(), return Inset::UNDECIDED_MODE);
444 for (int i = depth() - 1; i >= 0; --i) {
445 int res = operator[](i).inset().currentMode();
446 bool locked_mode = operator[](i).inset().lockedMode();
447 // Also return UNDECIDED_MODE when the mode is locked,
448 // as in this case it is treated the same as TEXT_MODE
449 if (res != Inset::UNDECIDED_MODE || locked_mode)
452 return Inset::TEXT_MODE;
456 bool Cursor::inCoordCache() const
458 // the root inset is not in cache, but we do not need it.
461 CoordCache::Insets const & icache = bv_->coordCache().getInsets();
462 for (size_t i = 1 ; i < depth() ; ++i)
463 if (!icache.has(&(*this)[i].inset()))
469 void Cursor::getPos(int & x, int & y) const
471 Point p = bv().getPos(*this);
477 Row const & Cursor::textRow() const
479 CursorSlice const & cs = innerTextSlice();
480 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
481 return pm.getRow(pos(), boundary());
485 void Cursor::resetAnchor()
488 checkNewWordPosition();
492 void Cursor::markNewWordPosition()
494 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
495 FontSpan nw = locateWord(WHOLE_WORD);
496 if (nw.size() == 1) {
497 LYXERR(Debug::DEBUG, "start new word: "
499 << " pos: " << nw.first);
506 void Cursor::clearNewWordPosition()
508 if (!new_word_.empty()) {
509 LYXERR(Debug::DEBUG, "clear new word: "
511 << " pos: " << pos());
517 void Cursor::checkNewWordPosition()
519 if (!lyxrc.spellcheck_continuously || new_word_.empty())
522 clearNewWordPosition();
524 // forget the position of the current new word if
525 // 1) the paragraph changes or
526 // 2) the count of nested insets changes or
527 // 3) the cursor pos is out of paragraph bound
528 if (pit() != new_word_.pit() ||
529 depth() != new_word_.depth() ||
530 new_word_.pos() > new_word_.lastpos()) {
531 clearNewWordPosition();
532 } else if (new_word_.fixIfBroken())
533 // 4) or the remembered position was "broken"
534 clearNewWordPosition();
536 FontSpan nw = locateWord(WHOLE_WORD);
538 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
539 if (nw.intersect(ow).empty())
540 clearNewWordPosition();
542 LYXERR(Debug::DEBUG, "new word: "
544 << " pos: " << nw.first << ".." << nw.last);
546 clearNewWordPosition();
553 bool Cursor::posVisRight(bool skip_inset)
555 Cursor new_cur = *this; // where we will move to
556 pos_type left_pos; // position visually left of current cursor
557 pos_type right_pos; // position visually right of current cursor
559 getSurroundingPos(left_pos, right_pos);
561 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
563 // Are we at an inset?
564 new_cur.pos() = right_pos;
565 new_cur.boundary(false);
567 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
568 // we actually move the cursor at the end of this
569 // function, for now we just keep track of the new
570 // position in new_cur...
571 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
574 // Are we already at rightmost pos in row?
575 else if (text()->empty() || right_pos == -1) {
578 if (!new_cur.posVisToNewRow(false)) {
579 LYXERR(Debug::RTL, "not moving!");
583 // we actually move the cursor at the end of this
584 // function, for now just keep track of the new
585 // position in new_cur...
586 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
587 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
590 // normal movement to the right
593 // Recall, if the cursor is at position 'x', that
594 // means *before* the character at position 'x'. In
595 // RTL, "before" means "to the right of", in LTR, "to
596 // the left of". So currently our situation is this:
597 // the position to our right is 'right_pos' (i.e.,
598 // we're currently to the left of 'right_pos'). In
599 // order to move to the right, it depends whether or
600 // not the character at 'right_pos' is RTL.
601 bool const new_pos_is_RTL = paragraph().getFontSettings(
602 buffer()->params(), right_pos).isVisibleRightToLeft();
603 // If the character at 'right_pos' *is* LTR, then in
604 // order to move to the right of it, we need to be
605 // *after* 'right_pos', i.e., move to position
607 if (!new_pos_is_RTL) {
608 new_cur.pos() = right_pos + 1;
609 // set the boundary to true in two situations:
611 // 1. if new_pos is now lastpos, and we're in
612 // an RTL paragraph (this means that we're
613 // moving right to the end of an LTR chunk
614 // which is at the end of an RTL paragraph);
615 (new_cur.pos() == lastpos()
616 && paragraph().isRTL(buffer()->params()))
617 // 2. if the position *after* right_pos is RTL
618 // (we want to be *after* right_pos, not
619 // before right_pos + 1!)
620 || paragraph().getFontSettings(buffer()->params(),
621 new_cur.pos()).isVisibleRightToLeft()
623 new_cur.boundary(true);
624 else // set the boundary to false
625 new_cur.boundary(false);
627 // Otherwise (if the character at position 'right_pos'
628 // is RTL), then moving to the right of it is as easy
629 // as setting the new position to 'right_pos'.
631 new_cur.pos() = right_pos;
632 new_cur.boundary(false);
637 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
640 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
641 << (new_cur.boundary() ? " (boundary)" : ""));
649 bool Cursor::posVisLeft(bool skip_inset)
651 Cursor new_cur = *this; // where we will move to
652 pos_type left_pos; // position visually left of current cursor
653 pos_type right_pos; // position visually right of current cursor
655 getSurroundingPos(left_pos, right_pos);
657 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
659 // Are we at an inset?
660 new_cur.pos() = left_pos;
661 new_cur.boundary(false);
663 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
664 // we actually move the cursor at the end of this
665 // function, for now we just keep track of the new
666 // position in new_cur...
667 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
670 // Are we already at leftmost pos in row?
671 else if (text()->empty() || left_pos == -1) {
674 if (!new_cur.posVisToNewRow(true)) {
675 LYXERR(Debug::RTL, "not moving!");
679 // we actually move the cursor at the end of this
680 // function, for now just keep track of the new
681 // position in new_cur...
682 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
683 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
686 // normal movement to the left
689 // Recall, if the cursor is at position 'x', that
690 // means *before* the character at position 'x'. In
691 // RTL, "before" means "to the right of", in LTR, "to
692 // the left of". So currently our situation is this:
693 // the position to our left is 'left_pos' (i.e., we're
694 // currently to the right of 'left_pos'). In order to
695 // move to the left, it depends whether or not the
696 // character at 'left_pos' is RTL.
697 bool const new_pos_is_RTL = paragraph().getFontSettings(
698 buffer()->params(), left_pos).isVisibleRightToLeft();
699 // If the character at 'left_pos' *is* RTL, then in
700 // order to move to the left of it, we need to be
701 // *after* 'left_pos', i.e., move to position
703 if (new_pos_is_RTL) {
704 new_cur.pos() = left_pos + 1;
705 // set the boundary to true in two situations:
707 // 1. if new_pos is now lastpos and we're in
708 // an LTR paragraph (this means that we're
709 // moving left to the end of an RTL chunk
710 // which is at the end of an LTR paragraph);
711 (new_cur.pos() == lastpos()
712 && !paragraph().isRTL(buffer()->params()))
713 // 2. if the position *after* left_pos is not
714 // RTL (we want to be *after* left_pos, not
715 // before left_pos + 1!)
716 || !paragraph().getFontSettings(buffer()->params(),
717 new_cur.pos()).isVisibleRightToLeft()
719 new_cur.boundary(true);
720 else // set the boundary to false
721 new_cur.boundary(false);
723 // Otherwise (if the character at position 'left_pos'
724 // is LTR), then moving to the left of it is as easy
725 // as setting the new position to 'left_pos'.
727 new_cur.pos() = left_pos;
728 new_cur.boundary(false);
733 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
736 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
737 << (new_cur.boundary() ? " (boundary)" : ""));
747 // Return true on success
748 bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
751 while (cit != row.begin() && cit->isVirtual())
754 while (cit != row.end() && cit->isVirtual())
757 return cit != row.end() && !cit->isVirtual();
762 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
764 // by default, we know nothing.
768 Row const & row = textRow();
770 Row::const_iterator cit = row.findElement(pos(), boundary(), dummy);
771 // Handle the case of empty row
772 if (cit == row.end()) {
774 right_pos = row.pos();
776 left_pos = row.pos() - 1;
780 // skip virtual elements and exit if no non-virtual one exists
781 if (!findNonVirtual(row, cit, !cit->isRTL()))
784 // if the position is at the left side of the element, we have to
785 // look at the previous element
786 if (pos() == cit->left_pos()) {
787 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
788 << "), AT LEFT of *cit=" << *cit);
789 // this one is easy (see common case below)
790 right_pos = pos() - (cit->isRTL() ? 1 : 0);
791 // at the left of the row
792 if (cit == row.begin())
795 if (!findNonVirtual(row, cit, true))
797 // [...[ is the row element, | is cursor position (! with boundary)
798 // [ 1 2 [ is a ltr row element with pos=1 and endpos=3
799 // ] 2 1] is an rtl row element with pos=1 and endpos=3
800 // [ 1 2 [ [|3 4 [ => (2, 3)
801 // or [ 1 2 [ ]!4 3 ] => (2, 4)
802 // or ] 2 1 ] [|3 4 [ => (1, 3)
803 // or ] 4 3 ] ]!2 1 ] => (3, 2)
804 left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
805 // happens with consecutive row of same direction
806 if (left_pos == right_pos) {
807 left_pos += cit->isRTL() ? 1 : -1;
810 // same code but with the element at the right
811 else if (pos() == cit->right_pos()) {
812 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
813 << "), AT RIGHT of *cit=" << *cit);
814 // this one is easy (see common case below)
815 left_pos = pos() - (cit->isRTL() ? 0 : 1);
816 // at the right of the row
817 if (cit + 1 == row.end())
820 if (!findNonVirtual(row, cit, false))
822 // [ 1 2![ [ 3 4 [ => (2, 3)
823 // or [ 1 2![ ] 4 3 ] => (2, 4)
824 // or ] 2 1|] [ 3 4 [ => (1, 3)
825 // or ] 4 3|] ] 2 1 ] => (3, 2)
826 right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
827 // happens with consecutive row of same direction
828 if (right_pos == left_pos)
829 right_pos += cit->isRTL() ? -1 : 1;
831 // common case: both positions are inside the row element
833 // [ 1 2|3 [ => (2, 3)
834 // or ] 3|2 1 ] => (3, 2)
835 left_pos = pos() - (cit->isRTL() ? 0 : 1);
836 right_pos = pos() - (cit->isRTL() ? 1 : 0);
839 // Note that debug message does not catch all early returns above
840 LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
841 << ") => (" << left_pos << ", " << right_pos <<")");
845 bool Cursor::posVisToNewRow(bool movingLeft)
847 Row const & row = textRow();
848 bool par_is_LTR = !row.isRTL();
850 // Inside a table, determining whether to move to the next or
851 // previous row should be done based on the table's direction.
852 if (inset().asInsetTabular()) {
853 par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
854 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
857 // if moving left in an LTR paragraph or moving right in an
858 // RTL one, move to previous row
859 if (par_is_LTR == movingLeft) {
860 if (row.pos() == 0) { // we're at first row in paragraph
861 if (pit() == 0) // no previous paragraph! don't move
863 // move to last pos in previous par
867 } else { // move to previous row in this par
868 pos() = row.pos() - 1; // this is guaranteed to be in previous row
872 // if moving left in an RTL paragraph or moving right in an
873 // LTR one, move to next row
875 if (row.endpos() == lastpos()) { // we're at last row in paragraph
876 if (pit() == lastpit()) // last paragraph! don't move
878 // move to first row in next par
882 } else { // move to next row in this par
883 pos() = row.endpos();
888 // make sure we're at left-/right-most pos in new row
889 posVisToRowExtremity(!movingLeft);
895 void Cursor::posVisToRowExtremity(bool left)
897 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
898 << (boundary() ? 1 : 0));
900 TextMetrics const & tm = bv_->textMetrics(text());
901 // Looking for extremities is like clicking on the left or the
903 int x = tm.origin().x_ + (left ? 0 : textRow().width());
905 pos() = tm.getPosNearX(textRow(), x, b);
908 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
909 << (boundary() ? 1 : 0));
913 bool Cursor::reverseDirectionNeeded() const
916 * We determine the directions based on the direction of the
917 * bottom() --- i.e., outermost --- paragraph, because that is
918 * the only way to achieve consistency of the arrow's movements
919 * within a paragraph, and thus avoid situations in which the
922 return bottom().paragraph().isRTL(bv().buffer().params());
926 CursorSlice Cursor::normalAnchor() const
930 // LASSERT: There have been several bugs around this code, that seem
931 // to involve failures to reset the anchor. We can at least not crash
932 // in release mode by resetting it ourselves.
933 if (anchor_.depth() < depth()) {
934 LYXERR0("Cursor is deeper than anchor. PLEASE REPORT.\nCursor is"
936 const_cast<DocIterator &>(anchor_) = *this;
939 CursorSlice normal = anchor_[depth() - 1];
940 if (depth() < anchor_.depth() && top() <= normal) {
941 // anchor is behind cursor -> move anchor behind the inset
948 CursorSlice Cursor::selBegin() const
952 return normalAnchor() < top() ? normalAnchor() : top();
956 CursorSlice Cursor::selEnd() const
960 return normalAnchor() > top() ? normalAnchor() : top();
964 DocIterator Cursor::selectionBegin() const
970 // FIXME: This is a work-around for the problem that
971 // CursorSlice doesn't keep track of the boundary.
972 if (normalAnchor() == top())
973 di = anchor_.boundary() > boundary() ? anchor_ : *this;
975 di = normalAnchor() < top() ? anchor_ : *this;
981 DocIterator Cursor::selectionEnd() const
987 // FIXME: This is a work-around for the problem that
988 // CursorSlice doesn't keep track of the boundary.
989 if (normalAnchor() == top())
990 di = anchor_.boundary() < boundary() ? anchor_ : *this;
992 di = normalAnchor() > top() ? anchor_ : *this;
994 if (di.depth() > depth()) {
1002 void Cursor::setSelection()
1005 if (idx() == normalAnchor().idx() &&
1006 pit() == normalAnchor().pit() &&
1007 pos() == normalAnchor().pos())
1012 void Cursor::setSelection(DocIterator const & where, int n)
1021 void Cursor::clearSelection()
1024 setWordSelection(false);
1030 void Cursor::setTargetX(int x)
1033 textTargetOffset_ = 0;
1037 int Cursor::x_target() const
1043 void Cursor::clearTargetX()
1046 textTargetOffset_ = 0;
1050 void Cursor::updateTextTargetOffset()
1055 textTargetOffset_ = x - x_target_;
1059 void Cursor::info(odocstream & os, bool devel_mode) const
1061 for (int i = 1, n = depth(); i < n; ++i) {
1062 operator[](i).inset().infoize(os);
1066 Inset const * inset = prevInset();
1067 // prevInset() can return 0 in certain case.
1069 prevInset()->infoize2(os);
1072 InsetMath * math = inset().asInsetMath();
1074 os << _(", Inset: ") << math->id();
1075 os << _(", Cell: ") << idx();
1076 os << _(", Position: ") << pos();
1082 bool Cursor::selHandle(bool sel)
1084 //lyxerr << "Cursor::selHandle" << endl;
1087 if (sel == selection())
1091 cap::saveSelection(*this);
1100 ///////////////////////////////////////////////////////////////////
1103 // The part below is the non-integrated rest of the original math
1104 // cursor. This should be either generalized for texted or moved
1105 // back to mathed (in most cases to InsetMathNest).
1107 ///////////////////////////////////////////////////////////////////
1109 #include "mathed/InsetMathChar.h"
1110 #include "mathed/InsetMathGrid.h"
1111 #include "mathed/InsetMathScript.h"
1112 #include "mathed/InsetMathUnknown.h"
1113 #include "mathed/MathFactory.h"
1114 #include "mathed/MathStream.h"
1115 #include "mathed/MathSupport.h"
1120 bool Cursor::isInside(Inset const * p) const
1122 for (size_t i = 0; i != depth(); ++i)
1123 if (&operator[](i).inset() == p)
1129 void Cursor::leaveInset(Inset const & inset)
1131 for (size_t i = 0; i != depth(); ++i) {
1132 if (&operator[](i).inset() == &inset) {
1140 bool Cursor::openable(MathAtom const & t) const
1151 // we can't move into anything new during selection
1152 if (depth() >= anchor_.depth())
1154 if (t.nucleus() != &anchor_[depth()].inset())
1161 void Cursor::setScreenPos(int x, int /*y*/)
1164 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1169 void Cursor::plainErase()
1171 cell().erase(pos());
1175 void Cursor::markInsert()
1177 insert(char_type(0));
1181 void Cursor::markErase()
1183 cell().erase(pos());
1187 void Cursor::plainInsert(MathAtom const & t)
1189 cell().insert(pos(), t);
1191 inset().setBuffer(bv_->buffer());
1193 checkBufferStructure();
1197 void Cursor::insert(docstring const & str)
1199 for (char_type c : str)
1204 void Cursor::insert(char_type c)
1206 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1207 LASSERT(!empty(), return);
1209 cap::selClearOrDel(*this);
1210 insert(new InsetMathChar(c));
1212 text()->insertChar(*this, c);
1217 void Cursor::insert(MathAtom const & t)
1219 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1221 cap::selClearOrDel(*this);
1226 void Cursor::insert(Inset * inset0)
1228 LASSERT(inset0, return);
1230 insert(MathAtom(inset0->asInsetMath()));
1232 text()->insertInset(*this, inset0);
1233 inset0->setBuffer(bv_->buffer());
1235 if (inset0->isLabeled())
1236 forceBufferUpdate();
1241 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1243 MathData ar(buffer());
1245 if (ar.size() == 1 && (enter || selection()))
1253 void Cursor::niceInsert(MathAtom const & t)
1256 docstring const safe = cap::grabAndEraseSelection(*this);
1258 // If possible, enter the new inset and move the contents of the selection
1259 if (t->isActive()) {
1261 // be careful here: don't use 'pushBackward(t)' as this we need to
1262 // push the clone, not the original
1263 pushBackward(*nextInset());
1264 // We may not use niceInsert here (recursion)
1265 MathData ar(buffer());
1268 } else if (t->asMacro() && !safe.empty()) {
1269 MathData ar(buffer());
1271 docstring const name = t->asMacro()->name();
1272 MacroData const * data = buffer()->getMacro(name);
1273 if (data && data->numargs() - data->optionals() > 0) {
1274 plainInsert(MathAtom(new InsetMathBrace(ar)));
1281 void Cursor::insert(MathData const & ar)
1285 cap::eraseSelection(*this);
1286 cell().insert(pos(), ar);
1288 // FIXME audit setBuffer calls
1289 inset().setBuffer(bv_->buffer());
1293 bool Cursor::backspace(bool const force)
1296 cap::eraseSelection(*this);
1301 // If empty cell, and not part of a big cell
1302 if (lastpos() == 0 && inset().nargs() == 1) {
1304 // Directly delete empty cell: [|[]] => [|]
1310 // [|], can not delete from inside
1321 if (inMacroMode()) {
1322 InsetMathUnknown * p = activeMacro();
1323 if (p->name().size() > 1) {
1324 p->setName(p->name().substr(0, p->name().size() - 1));
1329 if (pos() != 0 && !force && prevAtom()->confirmDeletion()) {
1330 // let's require two backspaces for 'big stuff' and
1331 // highlight on the first
1343 bool Cursor::erase(bool const force)
1349 cap::eraseSelection(*this);
1353 // delete empty cells if possible
1354 if (pos() == lastpos() && inset().idxDelete(idx()))
1357 // special behaviour when in last position of cell
1358 if (pos() == lastpos()) {
1359 bool one_cell = inset().nargs() == 1;
1360 if (one_cell && lastpos() == 0) {
1362 // Directly delete empty cell: [|[]] => [|]
1368 // [|], can not delete from inside
1373 inset().idxGlue(idx());
1377 // 'clever' UI hack: only erase large items if previously slected
1378 if (pos() != lastpos() && !force && nextAtom()->confirmDeletion()) {
1393 DocIterator save = *this;
1394 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1395 this->dispatch(cmd);
1396 if (disp_.dispatched())
1406 DocIterator save = *this;
1407 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1408 this->dispatch(cmd);
1409 if (disp_.dispatched())
1416 bool Cursor::macroModeClose()
1420 InsetMathUnknown * p = activeMacro();
1422 MathData selection(buffer());
1423 asArray(p->selection(), selection);
1424 docstring const s = p->name();
1426 cell().erase(pos());
1428 // do nothing if the macro name is empty
1432 // trigger updates of macros, at least, if no full
1433 // updates take place anyway
1434 screenUpdateFlags(Update::Force);
1436 docstring const name = s.substr(1);
1437 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1438 if (in && in->interpretString(*this, s))
1440 bool const user_macro = buffer()->getMacro(name, *this, false);
1441 MathAtom atom = user_macro ? MathAtom(new InsetMathMacro(buffer(), name))
1442 : createInsetMath(name, buffer());
1444 // try to put argument into macro, if we just inserted a macro
1445 bool macroArg = false;
1446 InsetMathMacro * atomAsMacro = atom.nucleus()->asMacro();
1448 // macros here are still unfolded (in init mode in fact). So
1449 // we have to resolve the macro here manually and check its arity
1450 // to put the selection behind it if arity > 0.
1451 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1452 if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
1454 atomAsMacro->setDisplayMode(InsetMathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1456 // non-greedy case. Do not touch the arguments behind
1457 atomAsMacro->setDisplayMode(InsetMathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1460 // insert remembered selection into first argument of a non-macro
1461 else if (atom.nucleus()->nargs() > 0)
1462 atom.nucleus()->cell(0).append(selection);
1464 MathWordList const & words = mathedWordList();
1465 MathWordList::const_iterator it = words.find(name);
1466 bool keep_mathmode = user_macro
1467 || (it != words.end() && (it->second.inset == "font"
1468 || it->second.inset == "oldfont"
1469 || it->second.inset == "mbox"));
1470 bool ert_macro = !user_macro && it == words.end() && atomAsMacro;
1472 if (in && in->currentMode() == Inset::TEXT_MODE
1473 && atom.nucleus()->currentMode() == Inset::MATH_MODE
1474 && name != from_ascii("ensuremath") && !ert_macro) {
1475 MathAtom at(new InsetMathEnsureMath(buffer()));
1476 at.nucleus()->cell(0).push_back(atom);
1479 } else if (in && in->currentMode() == Inset::MATH_MODE
1480 && atom.nucleus()->currentMode() == Inset::TEXT_MODE
1481 && !keep_mathmode) {
1482 MathAtom at = createInsetMath("text", buffer());
1483 at.nucleus()->cell(0).push_back(atom);
1489 // finally put the macro argument behind, if needed
1491 if (selection.size() > 1 || selection[0]->asScriptInset())
1492 plainInsert(MathAtom(new InsetMathBrace(selection)));
1501 docstring Cursor::macroName()
1503 return inMacroMode() ? activeMacro()->name() : docstring();
1507 void Cursor::handleNest(MathAtom const & a, int c)
1509 //lyxerr << "Cursor::handleNest: " << c << endl;
1511 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1514 pushBackward(*nextInset());
1518 int Cursor::targetX() const
1520 if (x_target() != -1)
1529 int Cursor::textTargetOffset() const
1531 return textTargetOffset_;
1535 void Cursor::setTargetX()
1544 bool Cursor::inMacroMode() const
1548 if (pos() == 0 || cell().empty())
1550 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1551 return p && !p->final();
1555 InsetMathUnknown * Cursor::activeMacro()
1557 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1561 InsetMathUnknown const * Cursor::activeMacro() const
1563 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1567 void Cursor::pullArg()
1570 MathData ar = cell();
1571 if (popBackward() && inMathed()) {
1573 cell().insert(pos(), ar);
1576 //formula()->mutateToText();
1581 void Cursor::touch()
1585 DocIterator::const_iterator it = begin();
1586 DocIterator::const_iterator et = end();
1587 for ( ; it != et; ++it)
1593 void Cursor::normalize()
1595 if (idx() > lastidx()) {
1596 lyxerr << "this should not really happen - 1: "
1597 << idx() << ' ' << nargs()
1598 << " in: " << &inset() << endl;
1602 if (pos() > lastpos()) {
1603 lyxerr << "this should not really happen - 2: "
1604 << pos() << ' ' << lastpos() << " in idx: " << idx()
1606 odocstringstream os;
1607 otexrowstream ots(os);
1608 WriteStream wi(ots, false, true, WriteStream::wsDefault);
1609 inset().asInsetMath()->write(wi);
1610 lyxerr << to_utf8(os.str()) << endl;
1616 bool Cursor::upDownInMath(bool up)
1618 // Be warned: The 'logic' implemented in this function is highly
1619 // fragile. A distance of one pixel or a '<' vs '<=' _really
1620 // matters. So fiddle around with it only if you think you know
1621 // what you are doing!
1625 xo = beforeDispatchPosX_;
1627 // check if we had something else in mind, if not, this is the future
1629 if (x_target_ == -1)
1631 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1632 // In text mode inside the line (not left or right) possibly set a new target_x,
1633 // but only if we are somewhere else than the previous target-offset.
1635 // We want to keep the x-target on subsequent up/down movements
1636 // that cross beyond the end of short lines. Thus a special
1637 // handling when the cursor is at the end of line: Use the new
1638 // x-target only if the old one was before the end of line
1639 // or the old one was after the beginning of the line
1640 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1644 left = pos() == textRow().endpos();
1645 right = pos() == textRow().pos();
1647 left = pos() == textRow().pos();
1648 right = pos() == textRow().endpos();
1650 if ((!left && !right) ||
1651 (left && !right && xo < x_target_) ||
1652 (!left && right && x_target_ < xo))
1659 // try neigbouring script insets
1661 if (inMathed() && !selection()) {
1664 InsetMathScript const * p = prevAtom()->asScriptInset();
1665 if (p && p->has(up)) {
1667 push(*const_cast<InsetMathScript*>(p));
1668 idx() = p->idxOfScript(up);
1671 // we went in the right direction? Otherwise don't jump into the script
1675 int oy = beforeDispatchPosY_;
1676 if ((!up && y <= oy) ||
1685 if (pos() != lastpos()) {
1686 InsetMathScript const * p = nextAtom()->asScriptInset();
1687 if (p && p->has(up)) {
1688 push(*const_cast<InsetMathScript*>(p));
1689 idx() = p->idxOfScript(up);
1692 // we went in the right direction? Otherwise don't jump into the script
1696 int oy = beforeDispatchPosY_;
1697 if ((!up && y <= oy) ||
1706 // try to find an inset that knows better then we,
1707 if (inset().idxUpDown(*this, up)) {
1708 //lyxerr << "idxUpDown triggered" << endl;
1709 // try to find best position within this inset
1711 setCursor(bruteFind(*this, xo, yo));
1715 // any improvement going just out of inset?
1716 if (popBackward() && inMathed()) {
1717 //lyxerr << "updown: popBackward succeeded" << endl;
1720 int yold = beforeDispatchPosY_;
1722 if (up ? ynew < yold : ynew > yold)
1726 // no success, we are probably at the document top or bottom
1732 InsetMath & Cursor::nextMath()
1734 return *nextAtom().nucleus();
1738 InsetMath & Cursor::prevMath()
1740 return *prevAtom().nucleus();
1744 bool Cursor::mathForward(bool word)
1746 LASSERT(inMathed(), return false);
1747 if (pos() < lastpos()) {
1749 // word: skip a group of insets of the form X*(B*|R*|P*) (greedy
1750 // match) where X is any math class, B is mathbin, R is mathrel, and
1751 // P is mathpunct. Make sure that the following remains true:
1752 // mathForward(true); mathBackward(true); mathForward(true)
1753 // is the same as mathForward(true) and
1754 // mathBackward(true); mathForward(true); mathBackward(true)
1755 // is the same as mathBackward(true).
1756 MathClass mc = nextMath().mathClass();
1759 while (pos() < lastpos() && mc == nextMath().mathClass());
1760 if (pos() < lastpos() &&
1761 ((mc = nextMath().mathClass()) == MC_BIN ||
1762 mc == MC_REL || mc == MC_PUNCT))
1765 while (pos() < lastpos() && mc == nextMath().mathClass());
1766 } else if (openable(nextAtom())) {
1767 // single step: try to enter the next inset
1768 pushBackward(nextMath());
1769 inset().idxFirst(*this);
1774 if (inset().idxForward(*this))
1776 // try to pop forwards --- but don't pop out of math! leave that to
1778 int s = depth() - 2;
1779 if (s >= 0 && operator[](s).inset().asInsetMath())
1780 return popForward();
1785 bool Cursor::mathBackward(bool word)
1787 LASSERT(inMathed(), return false);
1790 // word: skip a group of insets. See the comment in mathForward.
1791 MathClass mc = prevMath().mathClass();
1794 while (pos() > 0 && mc == prevMath().mathClass());
1795 if (pos() > 0 && (mc == MC_BIN || mc == MC_REL || mc == MC_PUNCT)) {
1796 mc = prevMath().mathClass();
1799 while (pos() > 0 && mc == prevMath().mathClass());
1801 } else if (openable(prevAtom())) {
1802 // single step: try to enter the preceding inset
1805 inset().idxLast(*this);
1810 if (inset().idxBackward(*this))
1812 // try to pop backwards --- but don't pop out of math! leave that to
1814 int s = depth() - 2;
1815 if (s >= 0 && operator[](s).inset().asInsetMath())
1816 return popBackward();
1821 bool Cursor::atFirstOrLastRow(bool up)
1823 TextMetrics const & tm = bv_->textMetrics(text());
1824 ParagraphMetrics const & pm = tm.parMetrics(pit());
1827 if (pos() && boundary())
1828 row = pm.pos2row(pos() - 1);
1830 row = pm.pos2row(pos());
1833 if (pit() == 0 && row == 0)
1836 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1837 row + 1 >= int(pm.rows().size()))
1844 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1846 LASSERT(text(), return false);
1852 xo = beforeDispatchPosX_;
1854 // update the targetX - this is here before the "return false"
1855 // to set a new target which can be used by InsetTexts above
1856 // if we cannot move up/down inside this inset anymore
1857 if (x_target_ == -1)
1859 else if (xo - textTargetOffset() != x_target() &&
1860 depth() == beforeDispatchCursor_.depth()) {
1861 // In text mode inside the line (not left or right)
1862 // possibly set a new target_x, but only if we are
1863 // somewhere else than the previous target-offset.
1865 // We want to keep the x-target on subsequent up/down
1866 // movements that cross beyond the end of short lines.
1867 // Thus a special handling when the cursor is at the
1868 // end of line: Use the new x-target only if the old
1869 // one was before the end of line or the old one was
1870 // after the beginning of the line
1871 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1875 left = pos() == textRow().endpos();
1876 right = pos() == textRow().pos();
1878 left = pos() == textRow().pos();
1879 right = pos() == textRow().endpos();
1881 if ((!left && !right) ||
1882 (left && !right && xo < x_target_) ||
1883 (!left && right && x_target_ < xo))
1890 // first get the current line
1891 TextMetrics & tm = bv_->textMetrics(text());
1892 ParagraphMetrics const & pm = tm.parMetrics(pit());
1894 if (pos() && boundary())
1895 row = pm.pos2row(pos() - 1);
1897 row = pm.pos2row(pos());
1899 if (atFirstOrLastRow(up)) {
1900 // Is there a place for the cursor to go ? If yes, we
1901 // can execute the DEPM, otherwise we should keep the
1902 // paragraph to host the cursor.
1903 Cursor dummy = *this;
1904 bool valid_destination = false;
1905 for(; dummy.depth(); dummy.pop())
1906 if (!dummy.atFirstOrLastRow(up)) {
1907 valid_destination = true;
1911 // will a next dispatch follow and if there is a new
1912 // dispatch will it move the cursor out ?
1913 if (depth() > 1 && valid_destination) {
1914 // The cursor hasn't changed yet. This happens when
1915 // you e.g. move out of an inset. And to give the
1916 // DEPM the possibility of doing something we must
1917 // provide it with two different cursors. (Lgb, vfr)
1919 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1920 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1922 updateNeeded |= bv().checkDepm(dummy, *this);
1923 updateTextTargetOffset();
1925 forceBufferUpdate();
1930 // with and without selection are handled differently
1932 int yo = bv().getPos(*this).y_;
1934 // To next/previous row
1935 // FIXME: the y position is often guessed wrongly across styles and
1936 // insets, which leads to weird behaviour.
1938 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1940 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1941 x_target_ = old.x_target_;
1944 // This happens when you move out of an inset.
1945 // And to give the DEPM the possibility of doing
1946 // something we must provide it with two different
1948 Cursor dummy = *this;
1951 if (bv().checkDepm(dummy, old)) {
1952 updateNeeded = true;
1953 // Make sure that cur gets back whatever happened to dummy (Lgb)
1956 if (inTexted() && pos() && paragraph().isEnvSeparator(pos() - 1))
1959 // if there is a selection, we stay out of any inset,
1960 // and just jump to the right position:
1966 } else if (pit() > 0) {
1968 TextMetrics & tm = bv_->textMetrics(text());
1969 if (!tm.contains(pit()))
1970 tm.newParMetricsUp();
1971 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1972 next_row = pmcur.rows().size() - 1;
1975 if (row + 1 < int(pm.rows().size())) {
1977 } else if (pit() + 1 < int(text()->paragraphs().size())) {
1979 TextMetrics & tm = bv_->textMetrics(text());
1980 if (!tm.contains(pit()))
1981 tm.newParMetricsDown();
1986 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
1988 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
1990 // When selection==false, this is done by TextMetrics::editXY
1993 updateNeeded |= bv().checkDepm(*this, old);
1997 forceBufferUpdate();
1998 updateTextTargetOffset();
2003 void Cursor::handleFont(string const & font)
2005 LYXERR(Debug::DEBUG, font);
2009 safe = cap::grabAndEraseSelection(*this);
2014 if (lastpos() != 0) {
2015 // something left in the cell
2017 // cursor in first position
2019 } else if (pos() == lastpos()) {
2020 // cursor in last position
2023 // cursor in between. split cell
2024 MathData::iterator bt = cell().begin();
2025 MathAtom at = createInsetMath(from_utf8(font), buffer());
2026 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2027 cell().erase(bt, bt + pos());
2032 // nothing left in the cell
2041 void Cursor::message(docstring const & msg) const
2043 disp_.setMessage(msg);
2047 void Cursor::errorMessage(docstring const & msg) const
2049 disp_.setMessage(msg);
2050 disp_.setError(true);
2056 docstring parbreak(Cursor const * cur)
2058 odocstringstream os;
2060 // only add blank line if we're not in a ParbreakIsNewline situation
2061 if (!cur->inset().getLayout().parbreakIsNewline()
2062 && !cur->paragraph().layout().parbreak_is_newline)
2070 docstring Cursor::selectionAsString(bool with_label) const
2076 return cap::grabSelection(*this);
2078 int const label = with_label
2079 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2081 idx_type const startidx = selBegin().idx();
2082 idx_type const endidx = selEnd().idx();
2083 if (startidx != endidx) {
2084 // multicell selection
2085 InsetTabular * table = inset().asInsetTabular();
2086 LASSERT(table, return docstring());
2087 return table->asString(startidx, endidx);
2090 ParagraphList const & pars = text()->paragraphs();
2092 pit_type const startpit = selBegin().pit();
2093 pit_type const endpit = selEnd().pit();
2094 size_t const startpos = selBegin().pos();
2095 size_t const endpos = selEnd().pos();
2097 if (startpit == endpit)
2098 return pars[startpit].asString(startpos, endpos, label);
2100 // First paragraph in selection
2101 docstring result = pars[startpit].
2102 asString(startpos, pars[startpit].size(), label)
2105 // The paragraphs in between (if any)
2106 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2107 Paragraph const & par = pars[pit];
2108 result += par.asString(0, par.size(), label)
2112 // Last paragraph in selection
2113 result += pars[endpit].asString(0, endpos, label);
2119 docstring Cursor::currentState(bool devel_mode) const
2122 odocstringstream os;
2123 info(os, devel_mode);
2128 return text()->currentState(*this, devel_mode);
2134 docstring Cursor::getPossibleLabel() const
2136 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2140 void Cursor::undispatched() const
2142 disp_.dispatched(false);
2146 void Cursor::dispatched() const
2148 disp_.dispatched(true);
2152 void Cursor::screenUpdateFlags(Update::flags f) const
2154 disp_.screenUpdate(f);
2158 void Cursor::forceBufferUpdate() const
2160 disp_.forceBufferUpdate();
2164 void Cursor::clearBufferUpdate() const
2166 disp_.clearBufferUpdate();
2170 bool Cursor::needBufferUpdate() const
2172 return disp_.needBufferUpdate();
2176 void Cursor::noScreenUpdate() const
2178 disp_.screenUpdate(Update::None);
2182 Font Cursor::getFont() const
2184 // The logic here should more or less match to the
2185 // Cursor::setCurrentFont logic, i.e. the cursor height should
2186 // give a hint what will happen if a character is entered.
2187 // FIXME: this is not the case, what about removing this method ? (see #10478).
2189 // HACK. far from being perfect...
2191 CursorSlice const & sl = innerTextSlice();
2192 Text const & text = *sl.text();
2193 Paragraph const & par = text.getPar(sl.pit());
2195 // on boundary, so we are really at the character before
2196 pos_type pos = sl.pos();
2197 if (pos > 0 && boundary())
2200 // on space? Take the font before (only for RTL boundary stay)
2202 TextMetrics const & tm = bv().textMetrics(&text);
2203 if (pos == sl.lastpos()
2204 || (par.isSeparator(pos)
2205 && !tm.isRTLBoundary(sl.pit(), pos)))
2209 // get font at the position
2210 Font font = par.getFont(buffer()->params(), pos,
2211 text.outerFont(sl.pit()));
2217 bool Cursor::fixIfBroken()
2219 bool const broken_cursor = DocIterator::fixIfBroken();
2220 bool const broken_anchor = anchor_.fixIfBroken();
2222 if (broken_cursor || broken_anchor) {
2223 clearNewWordPosition();
2231 void Cursor::sanitize()
2233 setBuffer(&bv_->buffer());
2234 DocIterator::sanitize();
2235 new_word_.sanitize();
2243 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2245 // find inset in common
2247 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2248 if (&old[i].inset() != &cur[i].inset())
2252 // update words if we just moved to another paragraph
2253 if (i == old.depth() && i == cur.depth()
2254 && !cur.buffer()->isClean()
2255 && cur.inTexted() && old.inTexted()
2256 && cur.pit() != old.pit()) {
2257 old.paragraph().updateWords();
2260 // notify everything on top of the common part in old cursor,
2261 // but stop if the inset claims the cursor to be invalid now
2262 for (size_type j = i; j < old.depth(); ++j) {
2263 Cursor inset_pos = old;
2264 inset_pos.cutOff(j);
2265 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2269 // notify everything on top of the common part in new cursor,
2270 // but stop if the inset claims the cursor to be invalid now
2271 for (; i < cur.depth(); ++i) {
2272 if (cur[i].inset().notifyCursorEnters(cur))
2280 void Cursor::setCurrentFont()
2282 CursorSlice const & cs = innerTextSlice();
2283 Paragraph const & par = cs.paragraph();
2284 pos_type cpit = cs.pit();
2285 pos_type cpos = cs.pos();
2286 Text const & ctext = *cs.text();
2287 TextMetrics const & tm = bv().textMetrics(&ctext);
2289 // are we behind previous char in fact? -> go to that char
2290 if (cpos > 0 && boundary())
2293 // find position to take the font from
2295 // paragraph end? -> font of last char
2296 if (cpos == lastpos())
2298 // on space? -> look at the words in front of space
2299 else if (cpos > 0 && par.isSeparator(cpos)) {
2300 // abc| def -> font of c
2301 // abc |[WERBEH], i.e. boundary==true -> font of c
2302 // abc [WERBEH]| def, font of the space
2303 if (!tm.isRTLBoundary(cpit, cpos))
2309 BufferParams const & bufparams = buffer()->params();
2310 current_font = par.getFontSettings(bufparams, cpos);
2311 real_current_font = tm.displayFont(cpit, cpos);
2313 // special case for paragraph end
2314 if (cs.pos() == lastpos()
2315 && tm.isRTLBoundary(cpit, cs.pos())
2317 Language const * lang = par.getParLanguage(bufparams);
2318 current_font.setLanguage(lang);
2319 current_font.fontInfo().setNumber(FONT_OFF);
2320 real_current_font.setLanguage(lang);
2321 real_current_font.fontInfo().setNumber(FONT_OFF);
2326 bool Cursor::textUndo()
2328 if (!buffer()->undo().textUndo(*this))
2335 bool Cursor::textRedo()
2337 if (!buffer()->undo().textRedo(*this))
2344 void Cursor::finishUndo() const
2346 buffer()->undo().finishUndo();
2350 void Cursor::beginUndoGroup() const
2352 buffer()->undo().beginUndoGroup(*this);
2356 void Cursor::endUndoGroup() const
2358 buffer()->undo().endUndoGroup(*this);
2362 void Cursor::recordUndo(pit_type from, pit_type to) const
2364 buffer()->undo().recordUndo(*this, from, to);
2368 void Cursor::recordUndo(pit_type from) const
2370 buffer()->undo().recordUndo(*this, from, pit());
2374 void Cursor::recordUndo(UndoKind kind) const
2376 buffer()->undo().recordUndo(*this, kind);
2380 void Cursor::recordUndoInset(Inset const * in) const
2382 buffer()->undo().recordUndoInset(*this, in);
2386 void Cursor::recordUndoFullBuffer() const
2388 buffer()->undo().recordUndoFullBuffer(*this);
2392 void Cursor::recordUndoBufferParams() const
2394 buffer()->undo().recordUndoBufferParams(*this);
2398 void Cursor::recordUndoSelection() const
2401 if (cap::multipleCellsSelected(*this))
2406 buffer()->undo().recordUndo(*this,
2407 selBegin().pit(), selEnd().pit());
2412 void Cursor::checkBufferStructure()
2414 Buffer const * master = buffer()->masterBuffer();
2415 master->tocBackend().updateItem(*this);
2416 if (master != buffer() && !master->hasGuiDelegate())
2417 // In case the master has no gui associated with it,
2418 // the TocItem is not updated (part of bug 5699).
2419 buffer()->tocBackend().updateItem(*this);
2421 // If the last tracked change of the paragraph has just been
2422 // deleted, then we need to recompute the buffer flag
2423 // tracked_changes_present_.
2424 if (inTexted() && paragraph().isChangeUpdateRequired())
2425 disp_.forceChangesUpdate();
2429 bool Cursor::confirmDeletion(bool const before) const
2432 if (Inset const * inset = before ? prevInset() : nextInset())
2433 return inset->confirmDeletion();
2435 DocIterator dit = selectionBegin();
2436 CursorSlice const end = selectionEnd().top();
2437 for (; dit.top() < end; dit.top().forwardPos())
2438 if (Inset const * inset = dit.nextInset())
2439 if (inset->confirmDeletion())
2446 void Cursor::moveToClosestEdge(int const x, bool const edit)
2448 if (Inset const * inset = nextInset()) {
2449 // stay in front of insets for which we want to open the dialog
2450 // (e.g. InsetMathSpace).
2451 if (edit && (inset->hasSettings() || !inset->contextMenuName().empty()))
2453 CoordCache::Insets const & insetCache = bv().coordCache().getInsets();
2454 if (!insetCache.has(inset))
2456 int const wid = insetCache.dim(inset).wid;
2457 Point p = insetCache.xy(inset);
2458 if (x > p.x_ + (wid + 1) / 2)