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.
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"
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/InsetMathScript.h"
51 #include "mathed/MacroTable.h"
52 #include "mathed/MathData.h"
53 #include "mathed/MathMacro.h"
55 #include "support/bind.h"
68 bool positionable(DocIterator const & cursor, DocIterator const & anchor)
70 // avoid deeper nested insets when selecting
71 if (cursor.depth() > anchor.depth())
74 // anchor might be deeper, should have same path then
75 for (size_t i = 0; i < cursor.depth(); ++i)
76 if (&cursor[i].inset() != &anchor[i].inset())
79 // position should be ok.
84 // Find position closest to (x, y) in cell given by iter.
85 // Used only in mathed
86 DocIterator bruteFind2(Cursor const & c, int x, int y)
88 double best_dist = numeric_limits<double>::max();
95 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
96 for (size_t i = 0;; ++i) {
99 Inset const * inset = &it.inset();
100 CoordCache const & cache = c.bv().coordCache();
102 // FIXME: in the case where the inset is not in the cache, this
103 // means that no part of it is visible on screen. In this case
104 // we don't do elaborate search and we just return the forwarded
105 // DocIterator at its beginning.
106 if (!cache.getInsets().has(inset)) {
111 Point const o = cache.getInsets().xy(inset);
112 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
113 // Convert to absolute
116 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
117 // '<=' in order to take the last possible position
118 // this is important for clicking behind \sum in e.g. '\sum_i a'
119 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
120 << " best: " << best_dist);
121 if (d <= best_dist) {
134 /// moves position closest to (x, y) in given box
135 bool bruteFind(Cursor & cursor,
136 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
138 LASSERT(!cursor.empty(), return false);
139 Inset & inset = cursor[0].inset();
140 BufferView & bv = cursor.bv();
142 CoordCache::InnerParPosCache const & cache =
143 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
144 // Get an iterator on the first paragraph in the cache
145 DocIterator it(inset);
146 it.push_back(CursorSlice(inset));
147 it.pit() = cache.begin()->first;
148 // Get an iterator after the last paragraph in the cache
149 DocIterator et(inset);
150 et.push_back(CursorSlice(inset));
151 et.pit() = boost::prior(cache.end())->first;
152 if (et.pit() >= et.lastpit())
153 et = doc_iterator_end(inset);
157 double best_dist = numeric_limits<double>::max();
158 DocIterator best_cursor = et;
160 for ( ; it != et; it.forwardPos(true)) {
161 // avoid invalid nesting when selecting
162 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
163 Point p = bv.getPos(it, false);
166 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
167 double const dx = xo - x;
168 double const dy = yo - y;
169 double const d = dx * dx + dy * dy;
170 // '<=' in order to take the last possible position
171 // this is important for clicking behind \sum in e.g. '\sum_i a'
172 if (d <= best_dist) {
173 // lyxerr << "*" << endl;
181 if (best_cursor != et) {
182 cursor.setCursor(best_cursor);
191 /// moves position closest to (x, y) in given box
192 bool bruteFind3(Cursor & cur, int x, int y, bool up)
194 BufferView & bv = cur.bv();
195 int ylow = up ? 0 : y + 1;
196 int yhigh = up ? y - 1 : bv.workHeight();
198 int xhigh = bv.workWidth();
200 // FIXME: bit more work needed to get 'from' and 'to' right.
201 pit_type from = cur.bottom().pit();
202 //pit_type to = cur.bottom().pit();
203 //lyxerr << "Pit start: " << from << endl;
205 //lyxerr << "bruteFind3: x: " << x << " y: " << y
206 // << " xlow: " << xlow << " xhigh: " << xhigh
207 // << " ylow: " << ylow << " yhigh: " << yhigh
209 DocIterator it = doc_iterator_begin(cur.buffer());
211 DocIterator et = doc_iterator_end(cur.buffer());
213 double best_dist = numeric_limits<double>::max();
214 DocIterator best_cursor = et;
216 for ( ; it != et; it.forwardPos()) {
217 // avoid invalid nesting when selecting
218 if (bv.cursorStatus(it) == CUR_INSIDE
219 && (!cur.selection() || positionable(it, cur.realAnchor()))) {
220 // If this function is ever used again, check
221 // whether this is the same as "bv.getPos(it,
222 // false)" with boundary = false.
223 Point p = bv.getPos(it);
226 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
227 double const dx = xo - x;
228 double const dy = yo - y;
229 double const d = dx * dx + dy * dy;
230 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
231 // << " dx: " << dx << " dy: " << dy
232 // << " idx: " << it.idx() << " pos: " << it.pos()
235 // '<=' in order to take the last possible position
236 // this is important for clicking behind \sum in e.g. '\sum_i a'
237 if (d <= best_dist) {
238 //lyxerr << "*" << endl;
246 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
247 if (best_cursor == et)
249 cur.setCursor(best_cursor);
256 CursorData::CursorData()
257 : DocIterator(), anchor_(),
258 selection_(false), mark_(false), word_selection_(false),
259 logicalpos_(false), current_font(inherit_font)
263 CursorData::CursorData(Buffer * buffer)
264 : DocIterator(buffer), anchor_(),
265 selection_(false), mark_(false), word_selection_(false),
266 logicalpos_(false), current_font(inherit_font)
270 CursorData::CursorData(DocIterator const & dit)
271 : DocIterator(dit), anchor_(),
272 selection_(false), mark_(false), word_selection_(false),
273 logicalpos_(false), current_font(inherit_font)
277 // be careful: this is called from the bv's constructor, too, so
278 // bv functions are not yet available!
279 Cursor::Cursor(BufferView & bv)
280 : CursorData(&bv.buffer()), bv_(&bv),
281 x_target_(-1), textTargetOffset_(0)
288 push_back(CursorSlice(buffer()->inset()));
289 anchor_ = doc_iterator_begin(buffer());
291 new_word_ = doc_iterator_begin(buffer());
299 // this (intentionally) does neither touch anchor nor selection status
300 void Cursor::setCursor(DocIterator const & cur)
302 DocIterator::operator=(cur);
306 void Cursor::setCursorToAnchor()
309 DocIterator normal = anchor_;
310 while (depth() < normal.depth())
312 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
319 void Cursor::setCursorData(CursorData const & data)
321 CursorData::operator=(data);
325 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
329 // Try to fix cursor in case it is broken.
332 // Is this a function that acts on inset at point?
333 Inset * inset = cur.nextInset();
334 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
335 && inset && inset->getStatus(cur, cmd, status))
338 // This is, of course, a mess. Better create a new doc iterator and use
339 // this in Inset::getStatus. This might require an additional
340 // BufferView * arg, though (which should be avoided)
341 //Cursor safe = *this;
343 for ( ; cur.depth(); cur.pop()) {
344 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
345 // LASSERT: Is it safe to continue here, or should we return?
346 LASSERT(cur.idx() <= cur.lastidx(), /**/);
347 LASSERT(cur.pit() <= cur.lastpit(), /**/);
348 LASSERT(cur.pos() <= cur.lastpos(), /**/);
350 // The inset's getStatus() will return 'true' if it made
351 // a definitive decision on whether it want to handle the
352 // request or not. The result of this decision is put into
353 // the 'status' parameter.
354 if (cur.inset().getStatus(cur, cmd, status)) {
363 void Cursor::saveBeforeDispatchPosXY()
365 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
369 void Cursor::dispatch(FuncRequest const & cmd0)
371 LYXERR(Debug::DEBUG, "cmd: " << cmd0 << '\n' << *this);
376 FuncRequest cmd = cmd0;
379 disp_ = DispatchResult();
383 // Is this a function that acts on inset at point?
384 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
386 disp_.dispatched(true);
387 disp_.screenUpdate(Update::FitCursor | Update::Force);
388 FuncRequest tmpcmd = cmd;
389 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
390 << cmd0 << endl << *this);
391 nextInset()->dispatch(*this, tmpcmd);
392 if (disp_.dispatched()) {
398 // store some values to be used inside of the handlers
399 beforeDispatchCursor_ = *this;
400 for (; depth(); pop(), boundary(false)) {
401 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
402 << cmd0 << endl << *this);
404 // In any of these cases, the cursor is invalid, and we should
405 // try to save this document rather than crash.
406 LBUFERR(pos() <= lastpos());
407 LBUFERR(idx() <= lastidx());
408 LBUFERR(pit() <= lastpit());
410 // The common case is 'LFUN handled, need update', so make the
411 // LFUN handler's life easier by assuming this as default value.
412 // The handler can reset the update and val flags if necessary.
413 disp_.screenUpdate(Update::FitCursor | Update::Force);
414 disp_.dispatched(true);
415 inset().dispatch(*this, cmd);
416 if (disp_.dispatched())
420 // it completely to get a 'bomb early' behaviour in case this
421 // object will be used again.
422 if (!disp_.dispatched()) {
423 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
424 // We might have invalidated the cursor when removing an empty
425 // paragraph while the cursor could not be moved out the inset
426 // while we initially thought we could. This might happen when
427 // a multiline inset becomes an inline inset when the second
428 // paragraph is removed.
429 if (safe.pit() > safe.lastpit()) {
430 safe.pit() = safe.lastpit();
431 safe.pos() = safe.lastpos();
434 disp_.screenUpdate(Update::None);
435 disp_.dispatched(false);
437 // restore the previous one because nested Cursor::dispatch calls
438 // are possible which would change it
439 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
443 // notify insets we just left
445 old.beginUndoGroup();
447 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
450 bv().resetInlineCompletionPos();
457 DispatchResult const & Cursor::result() const
463 BufferView & Cursor::bv() const
472 LBUFERR(depth() >= 1);
477 void Cursor::push(Inset & p)
479 push_back(CursorSlice(p));
480 p.setBuffer(*buffer());
484 void Cursor::pushBackward(Inset & p)
486 LASSERT(!empty(), return);
487 //lyxerr << "Entering inset " << t << " front" << endl;
493 bool Cursor::popBackward()
495 LASSERT(!empty(), return false);
503 bool Cursor::popForward()
505 LASSERT(!empty(), return false);
506 //lyxerr << "Leaving inset from in back" << endl;
507 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
511 pos() += lastpos() - lp + 1;
516 int Cursor::currentMode()
518 LASSERT(!empty(), return Inset::UNDECIDED_MODE);
519 for (int i = depth() - 1; i >= 0; --i) {
520 int res = operator[](i).inset().currentMode();
521 bool locked_mode = operator[](i).inset().lockedMode();
522 // Also return UNDECIDED_MODE when the mode is locked,
523 // as in this case it is treated the same as TEXT_MODE
524 if (res != Inset::UNDECIDED_MODE || locked_mode)
527 return Inset::TEXT_MODE;
531 void Cursor::getPos(int & x, int & y) const
533 Point p = bv().getPos(*this);
539 Row const & Cursor::textRow() const
541 CursorSlice const & cs = innerTextSlice();
542 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
543 return pm.getRow(pos(), boundary());
547 void Cursor::resetAnchor()
550 checkNewWordPosition();
554 void Cursor::markNewWordPosition()
556 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
557 FontSpan nw = locateWord(WHOLE_WORD);
558 if (nw.size() == 1) {
559 LYXERR(Debug::DEBUG, "start new word: "
561 << " pos: " << nw.first);
568 void Cursor::clearNewWordPosition()
570 if (!new_word_.empty()) {
571 LYXERR(Debug::DEBUG, "clear new word: "
573 << " pos: " << pos());
579 void Cursor::checkNewWordPosition()
581 if (!lyxrc.spellcheck_continuously || new_word_.empty())
584 clearNewWordPosition();
586 // forget the position of the current new word if
587 // 1) the paragraph changes or
588 // 2) the count of nested insets changes or
589 // 3) the cursor pos is out of paragraph bound
590 if (pit() != new_word_.pit() ||
591 depth() != new_word_.depth() ||
592 new_word_.pos() > new_word_.lastpos()) {
593 clearNewWordPosition();
594 } else if (new_word_.fixIfBroken())
595 // 4) or the remembered position was "broken"
596 clearNewWordPosition();
598 FontSpan nw = locateWord(WHOLE_WORD);
600 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
601 if (nw.intersect(ow).empty())
602 clearNewWordPosition();
604 LYXERR(Debug::DEBUG, "new word: "
606 << " pos: " << nw.first << ".." << nw.last);
608 clearNewWordPosition();
615 bool Cursor::posBackward()
624 bool Cursor::posForward()
626 if (pos() == lastpos())
633 bool Cursor::posVisRight(bool skip_inset)
635 Cursor new_cur = *this; // where we will move to
636 pos_type left_pos; // position visually left of current cursor
637 pos_type right_pos; // position visually right of current cursor
638 bool new_pos_is_RTL; // is new position we're moving to RTL?
640 getSurroundingPos(left_pos, right_pos);
642 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
644 // Are we at an inset?
645 new_cur.pos() = right_pos;
646 new_cur.boundary(false);
648 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
649 // we actually move the cursor at the end of this
650 // function, for now we just keep track of the new
651 // position in new_cur...
652 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
655 // Are we already at rightmost pos in row?
656 else if (text()->empty() || right_pos == -1) {
659 if (!new_cur.posVisToNewRow(false)) {
660 LYXERR(Debug::RTL, "not moving!");
664 // we actually move the cursor at the end of this
665 // function, for now just keep track of the new
666 // position in new_cur...
667 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
668 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
671 // normal movement to the right
674 // Recall, if the cursor is at position 'x', that
675 // means *before* the character at position 'x'. In
676 // RTL, "before" means "to the right of", in LTR, "to
677 // the left of". So currently our situation is this:
678 // the position to our right is 'right_pos' (i.e.,
679 // we're currently to the left of 'right_pos'). In
680 // order to move to the right, it depends whether or
681 // not the character at 'right_pos' is RTL.
682 new_pos_is_RTL = paragraph().getFontSettings(
683 buffer()->params(), right_pos).isVisibleRightToLeft();
684 // If the character at 'right_pos' *is* LTR, then in
685 // order to move to the right of it, we need to be
686 // *after* 'right_pos', i.e., move to position
688 if (!new_pos_is_RTL) {
689 new_cur.pos() = right_pos + 1;
690 // set the boundary to true in two situations:
692 // 1. if new_pos is now lastpos, and we're in
693 // an RTL paragraph (this means that we're
694 // moving right to the end of an LTR chunk
695 // which is at the end of an RTL paragraph);
696 (new_cur.pos() == lastpos()
697 && paragraph().isRTL(buffer()->params()))
698 // 2. if the position *after* right_pos is RTL
699 // (we want to be *after* right_pos, not
700 // before right_pos + 1!)
701 || paragraph().getFontSettings(buffer()->params(),
702 new_cur.pos()).isVisibleRightToLeft()
704 new_cur.boundary(true);
705 else // set the boundary to false
706 new_cur.boundary(false);
708 // Otherwise (if the character at position 'right_pos'
709 // is RTL), then moving to the right of it is as easy
710 // as setting the new position to 'right_pos'.
712 new_cur.pos() = right_pos;
713 new_cur.boundary(false);
718 bool moved = (new_cur.pos() != pos()
719 || new_cur.pit() != pit()
720 || new_cur.boundary() != boundary()
721 || &new_cur.inset() != &inset());
724 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
725 << (new_cur.boundary() ? " (boundary)" : ""));
733 bool Cursor::posVisLeft(bool skip_inset)
735 Cursor new_cur = *this; // where we will move to
736 pos_type left_pos; // position visually left of current cursor
737 pos_type right_pos; // position visually right of current cursor
738 bool new_pos_is_RTL; // is new position we're moving to RTL?
740 getSurroundingPos(left_pos, right_pos);
742 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
744 // Are we at an inset?
745 new_cur.pos() = left_pos;
746 new_cur.boundary(false);
748 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
749 // we actually move the cursor at the end of this
750 // function, for now we just keep track of the new
751 // position in new_cur...
752 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
755 // Are we already at leftmost pos in row?
756 else if (text()->empty() || left_pos == -1) {
759 if (!new_cur.posVisToNewRow(true)) {
760 LYXERR(Debug::RTL, "not moving!");
764 // we actually move the cursor at the end of this
765 // function, for now just keep track of the new
766 // position in new_cur...
767 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
768 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
771 // normal movement to the left
774 // Recall, if the cursor is at position 'x', that
775 // means *before* the character at position 'x'. In
776 // RTL, "before" means "to the right of", in LTR, "to
777 // the left of". So currently our situation is this:
778 // the position to our left is 'left_pos' (i.e., we're
779 // currently to the right of 'left_pos'). In order to
780 // move to the left, it depends whether or not the
781 // character at 'left_pos' is RTL.
782 new_pos_is_RTL = paragraph().getFontSettings(
783 buffer()->params(), left_pos).isVisibleRightToLeft();
784 // If the character at 'left_pos' *is* RTL, then in
785 // order to move to the left of it, we need to be
786 // *after* 'left_pos', i.e., move to position
788 if (new_pos_is_RTL) {
789 new_cur.pos() = left_pos + 1;
790 // set the boundary to true in two situations:
792 // 1. if new_pos is now lastpos and we're in
793 // an LTR paragraph (this means that we're
794 // moving left to the end of an RTL chunk
795 // which is at the end of an LTR paragraph);
796 (new_cur.pos() == lastpos()
797 && !paragraph().isRTL(buffer()->params()))
798 // 2. if the position *after* left_pos is not
799 // RTL (we want to be *after* left_pos, not
800 // before left_pos + 1!)
801 || !paragraph().getFontSettings(buffer()->params(),
802 new_cur.pos()).isVisibleRightToLeft()
804 new_cur.boundary(true);
805 else // set the boundary to false
806 new_cur.boundary(false);
808 // Otherwise (if the character at position 'left_pos'
809 // is LTR), then moving to the left of it is as easy
810 // as setting the new position to 'left_pos'.
812 new_cur.pos() = left_pos;
813 new_cur.boundary(false);
818 bool moved = (new_cur.pos() != pos()
819 || new_cur.pit() != pit()
820 || new_cur.boundary() != boundary());
823 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
824 << (new_cur.boundary() ? " (boundary)" : ""));
832 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
834 // preparing bidi tables
835 Paragraph const & par = paragraph();
836 Buffer const & buf = *buffer();
837 Row const & row = textRow();
839 bidi.computeTables(par, buf, row);
841 LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
843 // The cursor is painted *before* the character at pos(), or,
844 // if 'boundary' is true, *after* the character at (pos() -
845 // 1). So we already have one known position around the
847 pos_type const known_pos = boundary() && pos() > 0 ? pos() - 1 : pos();
849 // edge case: if we're at the end of the paragraph, things are
850 // a little different (because lastpos is a position which
851 // does not really "exist" --- there's no character there
853 if (known_pos == lastpos()) {
854 if (par.isRTL(buf.params())) {
856 right_pos = bidi.vis2log(row.pos());
860 left_pos = bidi.vis2log(row.endpos() - 1);
865 // Whether 'known_pos' is to the left or to the right of the
866 // cursor depends on whether it is an RTL or LTR character...
867 bool const cur_is_RTL =
868 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
869 // ... in the following manner:
870 // For an RTL character, "before"
871 // means "to the right" and "after" means "to the left"; and
872 // for LTR, it's the reverse. So, 'known_pos' is to the right
873 // of the cursor if (RTL && boundary) or (!RTL && !boundary):
874 bool const known_pos_on_right = cur_is_RTL == boundary();
876 // So we now know one of the positions surrounding the cursor.
877 // Let's determine the other one:
878 if (known_pos_on_right) {
879 right_pos = known_pos;
880 // *visual* position of 'left_pos':
881 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
882 // If the position we just identified as 'left_pos' is
883 // a "skipped separator" (a separator which is at the
884 // logical end of a row, except for the last row in a
885 // paragraph; such separators are not painted, so they
886 // "are not really there"; note that in bidi text,
887 // such a separator could appear visually in the
888 // middle of a row), set 'left_pos' to the *next*
889 // position to the left.
890 if (bidi.inRange(v_left_pos)
891 && bidi.vis2log(v_left_pos) + 1 == row.endpos()
892 && row.endpos() < lastpos()
893 && par.isSeparator(bidi.vis2log(v_left_pos)))
896 // calculate the logical position of 'left_pos', if in row
897 if (!bidi.inRange(v_left_pos))
900 left_pos = bidi.vis2log(v_left_pos);
901 // If the position we identified as 'right_pos' is a
902 // "skipped separator", set 'right_pos' to the *next*
903 // position to the right.
904 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos()
905 && par.isSeparator(right_pos)) {
906 pos_type const v_right_pos = bidi.log2vis(right_pos) + 1;
907 if (!bidi.inRange(v_right_pos))
910 right_pos = bidi.vis2log(v_right_pos);
913 // known_pos is on the left
914 left_pos = known_pos;
915 // *visual* position of 'right_pos'
916 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
917 // If the position we just identified as 'right_pos'
918 // is a "skipped separator", set 'right_pos' to the
919 // *next* position to the right.
920 if (bidi.inRange(v_right_pos)
921 && bidi.vis2log(v_right_pos) + 1 == row.endpos()
922 && row.endpos() < lastpos()
923 && par.isSeparator(bidi.vis2log(v_right_pos)))
926 // calculate the logical position of 'right_pos', if in row
927 if (!bidi.inRange(v_right_pos))
930 right_pos = bidi.vis2log(v_right_pos);
931 // If the position we identified as 'left_pos' is a
932 // "skipped separator", set 'left_pos' to the *next*
933 // position to the left.
934 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos()
935 && par.isSeparator(left_pos)) {
936 pos_type const v_left_pos = bidi.log2vis(left_pos) - 1;
937 if (!bidi.inRange(v_left_pos))
940 left_pos = bidi.vis2log(v_left_pos);
947 bool Cursor::posVisToNewRow(bool movingLeft)
949 Paragraph const & par = paragraph();
950 Buffer const & buf = *buffer();
951 Row const & row = textRow();
952 bool par_is_LTR = !par.isRTL(buf.params());
954 // Inside a table, determining whether to move to the next or
955 // previous row should be done based on the table's direction.
957 if (s >= 1 && (*this)[s].inset().asInsetTabular()) {
958 par_is_LTR = !(*this)[s].inset().asInsetTabular()->isRightToLeft(*this);
959 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
962 // if moving left in an LTR paragraph or moving right in an
963 // RTL one, move to previous row
964 if (par_is_LTR == movingLeft) {
965 if (row.pos() == 0) { // we're at first row in paragraph
966 if (pit() == 0) // no previous paragraph! don't move
968 // move to last pos in previous par
972 } else { // move to previous row in this par
973 pos() = row.pos() - 1; // this is guaranteed to be in previous row
977 // if moving left in an RTL paragraph or moving right in an
978 // LTR one, move to next row
980 if (row.endpos() == lastpos()) { // we're at last row in paragraph
981 if (pit() == lastpit()) // last paragraph! don't move
983 // move to first row in next par
987 } else { // move to next row in this par
988 pos() = row.endpos();
993 // make sure we're at left-/right-most pos in new row
994 posVisToRowExtremity(!movingLeft);
1000 void Cursor::posVisToRowExtremity(bool left)
1002 // prepare bidi tables
1003 Paragraph const & par = paragraph();
1004 Buffer const & buf = *buffer();
1005 Row const & row = textRow();
1007 bidi.computeTables(par, buf, row);
1009 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
1010 << (boundary() ? 1 : 0));
1012 if (left) { // move to leftmost position
1013 // if this is an RTL paragraph, and we're at the last row in the
1014 // paragraph, move to lastpos
1015 if (par.isRTL(buf.params()) && row.endpos() == lastpos())
1018 pos() = bidi.vis2log(row.pos());
1020 // Moving to the leftmost position in the row,
1021 // the cursor should normally be placed to the
1022 // *left* of the leftmost position. A very
1023 // common exception, though, is if the
1024 // leftmost character also happens to be the
1025 // separator at the (logical) end of the row
1026 // --- in this case, the separator is
1027 // positioned beyond the left margin, and we
1028 // don't want to move the cursor there (moving
1029 // to the left of the separator is equivalent
1030 // to moving to the next line). So, in this
1031 // case we actually want to place the cursor
1032 // to the *right* of the leftmost position
1033 // (the separator). Another exception is if
1034 // we're moving to the logically last position
1035 // in the row, which is *not* a separator:
1036 // this means that the entire row has no
1037 // separators (if there were any, the row
1038 // would have been broken there); and
1039 // therefore in this case we also move to the
1040 // *right* of the last position (this
1041 // indicates to the user that there is no
1042 // space after this position, and is
1043 // consistent with the behavior in the middle
1044 // of a row --- moving right or left moves to
1045 // the next/previous character; if we were to
1046 // move to the *left* of this position, that
1047 // would simulate a separator which is not
1048 // really there!). Finally, there is an
1049 // exception to the previous exception: if
1050 // this non-separator-but-last-position-in-row
1051 // is an inset, then we *do* want to stay to
1052 // the left of it anyway: this is the
1053 // "boundary" which we simulate at insets.
1055 // Another exception is when row.endpos() is
1058 // do we want to be to the right of pos?
1059 // as explained above, if at last pos in row, stay to the right
1060 bool const right_of_pos = row.endpos() > 0
1061 && pos() == row.endpos() - 1 && !par.isInset(pos());
1063 // Now we know if we want to be to the left or to the right of pos,
1064 // let's make sure we are where we want to be.
1065 bool const new_pos_is_RTL =
1066 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
1068 if (new_pos_is_RTL != right_of_pos) {
1074 // move to rightmost position
1075 // if this is an LTR paragraph, and we're at the last row in the
1076 // paragraph, move to lastpos
1077 if (!par.isRTL(buf.params()) && row.endpos() == lastpos())
1080 pos() = row.endpos() > 0 ? bidi.vis2log(row.endpos() - 1) : 0;
1082 // Moving to the rightmost position in the
1083 // row, the cursor should normally be placed
1084 // to the *right* of the rightmost position. A
1085 // very common exception, though, is if the
1086 // rightmost character also happens to be the
1087 // separator at the (logical) end of the row
1088 // --- in this case, the separator is
1089 // positioned beyond the right margin, and we
1090 // don't want to move the cursor there (moving
1091 // to the right of the separator is equivalent
1092 // to moving to the next line). So, in this
1093 // case we actually want to place the cursor
1094 // to the *left* of the rightmost position
1095 // (the separator). Another exception is if
1096 // we're moving to the logically last position
1097 // in the row, which is *not* a separator:
1098 // this means that the entire row has no
1099 // separators (if there were any, the row
1100 // would have been broken there); and
1101 // therefore in this case we also move to the
1102 // *left* of the last position (this indicates
1103 // to the user that there is no space after
1104 // this position, and is consistent with the
1105 // behavior in the middle of a row --- moving
1106 // right or left moves to the next/previous
1107 // character; if we were to move to the
1108 // *right* of this position, that would
1109 // simulate a separator which is not really
1110 // there!). Finally, there is an exception to
1111 // the previous exception: if this
1112 // non-separator-but-last-position-in-row is
1113 // an inset, then we *do* want to stay to the
1114 // right of it anyway: this is the "boundary"
1115 // which we simulate at insets. Another
1116 // exception is when row.endpos() is 0.
1118 // do we want to be to the left of pos?
1119 // as explained above, if at last pos in row, stay to the left,
1120 // unless the last position is the same as the first.
1121 bool const left_of_pos = row.endpos() > 0
1122 && pos() == row.endpos() - 1 && !par.isInset(pos());
1124 // Now we know if we want to be to the left or to the right of pos,
1125 // let's make sure we are where we want to be.
1126 bool const new_pos_is_RTL =
1127 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
1129 if (new_pos_is_RTL == left_of_pos) {
1135 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1136 << (boundary() ? 1 : 0));
1140 CursorSlice Cursor::normalAnchor() const
1144 // LASSERT: There have been several bugs around this code, that seem
1145 // to involve failures to reset the anchor. We can at least not crash
1146 // in release mode by resetting it ourselves.
1147 LASSERT(anchor_.depth() >= depth(),
1148 const_cast<DocIterator &>(anchor_) = *this);
1150 CursorSlice normal = anchor_[depth() - 1];
1151 if (depth() < anchor_.depth() && top() <= normal) {
1152 // anchor is behind cursor -> move anchor behind the inset
1159 DocIterator & Cursor::realAnchor()
1165 CursorSlice Cursor::selBegin() const
1169 return normalAnchor() < top() ? normalAnchor() : top();
1173 CursorSlice Cursor::selEnd() const
1177 return normalAnchor() > top() ? normalAnchor() : top();
1181 DocIterator Cursor::selectionBegin() const
1187 // FIXME: This is a work-around for the problem that
1188 // CursorSlice doesn't keep track of the boundary.
1189 if (normalAnchor() == top())
1190 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1192 di = normalAnchor() < top() ? anchor_ : *this;
1198 DocIterator Cursor::selectionEnd() const
1204 // FIXME: This is a work-around for the problem that
1205 // CursorSlice doesn't keep track of the boundary.
1206 if (normalAnchor() == top())
1207 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1209 di = normalAnchor() > top() ? anchor_ : *this;
1211 if (di.depth() > depth()) {
1219 void Cursor::setSelection()
1222 // A selection with no contents is not a selection
1223 // FIXME: doesnt look ok
1224 if (idx() == normalAnchor().idx() &&
1225 pit() == normalAnchor().pit() &&
1226 pos() == normalAnchor().pos())
1227 setSelection(false);
1231 void Cursor::setSelection(DocIterator const & where, int n)
1240 void Cursor::clearSelection()
1242 setSelection(false);
1243 setWordSelection(false);
1249 void Cursor::setTargetX(int x)
1252 textTargetOffset_ = 0;
1256 int Cursor::x_target() const
1262 void Cursor::clearTargetX()
1265 textTargetOffset_ = 0;
1269 void Cursor::updateTextTargetOffset()
1274 textTargetOffset_ = x - x_target_;
1278 void Cursor::info(odocstream & os) const
1280 for (int i = 1, n = depth(); i < n; ++i) {
1281 operator[](i).inset().infoize(os);
1285 Inset const * inset = prevInset();
1286 // prevInset() can return 0 in certain case.
1288 prevInset()->infoize2(os);
1290 // overwite old message
1295 bool Cursor::selHandle(bool sel)
1297 //lyxerr << "Cursor::selHandle" << endl;
1300 if (sel == selection())
1304 cap::saveSelection(*this);
1312 ostream & operator<<(ostream & os, Cursor const & cur)
1314 os << "\n cursor: | anchor:\n";
1315 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
1316 os << " " << cur[i] << " | ";
1317 if (i < cur.anchor_.depth())
1318 os << cur.anchor_[i];
1320 os << "-------------------------------";
1323 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
1324 os << "------------------------------- | " << cur.anchor_[i] << "\n";
1326 os << " selection: " << cur.selection_
1327 << " x_target: " << cur.x_target_
1328 << " boundary: " << cur.boundary() << endl;
1333 LyXErr & operator<<(LyXErr & os, Cursor const & cur)
1343 ///////////////////////////////////////////////////////////////////
1346 // The part below is the non-integrated rest of the original math
1347 // cursor. This should be either generalized for texted or moved
1348 // back to mathed (in most cases to InsetMathNest).
1350 ///////////////////////////////////////////////////////////////////
1352 #include "mathed/InsetMathChar.h"
1353 #include "mathed/InsetMathGrid.h"
1354 #include "mathed/InsetMathScript.h"
1355 #include "mathed/InsetMathUnknown.h"
1356 #include "mathed/MathFactory.h"
1357 #include "mathed/MathStream.h"
1358 #include "mathed/MathSupport.h"
1363 bool Cursor::isInside(Inset const * p) const
1365 for (size_t i = 0; i != depth(); ++i)
1366 if (&operator[](i).inset() == p)
1372 void Cursor::leaveInset(Inset const & inset)
1374 for (size_t i = 0; i != depth(); ++i) {
1375 if (&operator[](i).inset() == &inset) {
1383 bool Cursor::openable(MathAtom const & t) const
1394 // we can't move into anything new during selection
1395 if (depth() >= anchor_.depth())
1397 if (t.nucleus() != &anchor_[depth()].inset())
1404 void Cursor::setScreenPos(int x, int /*y*/)
1407 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1412 void Cursor::plainErase()
1414 cell().erase(pos());
1418 void Cursor::markInsert()
1420 insert(char_type(0));
1424 void Cursor::markErase()
1426 cell().erase(pos());
1430 void Cursor::plainInsert(MathAtom const & t)
1432 cell().insert(pos(), t);
1434 inset().setBuffer(bv_->buffer());
1436 forceBufferUpdate();
1440 void Cursor::insert(docstring const & str)
1442 for_each(str.begin(), str.end(),
1443 bind(static_cast<void(Cursor::*)(char_type)>
1444 (&Cursor::insert), this, _1));
1448 void Cursor::insert(char_type c)
1450 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1451 LASSERT(!empty(), return);
1453 cap::selClearOrDel(*this);
1454 insert(new InsetMathChar(c));
1456 text()->insertChar(*this, c);
1461 void Cursor::insert(MathAtom const & t)
1463 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1465 cap::selClearOrDel(*this);
1470 void Cursor::insert(Inset * inset0)
1472 LASSERT(inset0, return);
1474 insert(MathAtom(inset0->asInsetMath()));
1476 text()->insertInset(*this, inset0);
1477 inset0->setBuffer(bv_->buffer());
1479 if (inset0->isLabeled())
1480 forceBufferUpdate();
1485 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1487 MathData ar(buffer());
1489 if (ar.size() == 1 && (enter || selection()))
1497 void Cursor::niceInsert(MathAtom const & t)
1500 docstring const safe = cap::grabAndEraseSelection(*this);
1502 // If possible, enter the new inset and move the contents of the selection
1503 if (t->isActive()) {
1505 // be careful here: don't use 'pushBackward(t)' as this we need to
1506 // push the clone, not the original
1507 pushBackward(*nextInset());
1508 // We may not use niceInsert here (recursion)
1509 MathData ar(buffer());
1512 } else if (t->asMacro() && !safe.empty()) {
1513 MathData ar(buffer());
1515 docstring const name = t->asMacro()->name();
1516 MacroData const * data = buffer()->getMacro(name);
1517 if (data && data->numargs() - data->optionals() > 0) {
1518 plainInsert(MathAtom(new InsetMathBrace(ar)));
1525 void Cursor::insert(MathData const & ar)
1529 cap::eraseSelection(*this);
1530 cell().insert(pos(), ar);
1532 // FIXME audit setBuffer calls
1533 inset().setBuffer(bv_->buffer());
1537 bool Cursor::backspace()
1540 cap::eraseSelection(*this);
1545 // If empty cell, and not part of a big cell
1546 if (lastpos() == 0 && inset().nargs() == 1) {
1548 // Directly delete empty cell: [|[]] => [|]
1554 // [|], can not delete from inside
1565 if (inMacroMode()) {
1566 InsetMathUnknown * p = activeMacro();
1567 if (p->name().size() > 1) {
1568 p->setName(p->name().substr(0, p->name().size() - 1));
1573 if (pos() != 0 && prevAtom()->nargs() > 0) {
1574 // let's require two backspaces for 'big stuff' and
1575 // highlight on the first
1587 bool Cursor::erase()
1593 cap::eraseSelection(*this);
1597 // delete empty cells if possible
1598 if (pos() == lastpos() && inset().idxDelete(idx()))
1601 // special behaviour when in last position of cell
1602 if (pos() == lastpos()) {
1603 bool one_cell = inset().nargs() == 1;
1604 if (one_cell && lastpos() == 0) {
1606 // Directly delete empty cell: [|[]] => [|]
1612 // [|], can not delete from inside
1617 inset().idxGlue(idx());
1621 // 'clever' UI hack: only erase large items if previously slected
1622 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1637 DocIterator save = *this;
1638 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1639 this->dispatch(cmd);
1640 if (disp_.dispatched())
1650 DocIterator save = *this;
1651 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1652 this->dispatch(cmd);
1653 if (disp_.dispatched())
1660 bool Cursor::macroModeClose()
1664 InsetMathUnknown * p = activeMacro();
1666 MathData selection(buffer());
1667 asArray(p->selection(), selection);
1668 docstring const s = p->name();
1670 cell().erase(pos());
1672 // do nothing if the macro name is empty
1676 // trigger updates of macros, at least, if no full
1677 // updates take place anyway
1678 screenUpdateFlags(Update::Force);
1680 docstring const name = s.substr(1);
1681 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1682 if (in && in->interpretString(*this, s))
1684 MathAtom atom = buffer()->getMacro(name, *this, false) ?
1685 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1687 // try to put argument into macro, if we just inserted a macro
1688 bool macroArg = false;
1689 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1691 // macros here are still unfolded (in init mode in fact). So
1692 // we have to resolve the macro here manually and check its arity
1693 // to put the selection behind it if arity > 0.
1694 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1695 if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
1697 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1699 // non-greedy case. Do not touch the arguments behind
1700 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1703 // insert remembered selection into first argument of a non-macro
1704 else if (atom.nucleus()->nargs() > 0)
1705 atom.nucleus()->cell(0).append(selection);
1709 // finally put the macro argument behind, if needed
1711 if (selection.size() > 1 || selection[0]->asScriptInset())
1712 plainInsert(MathAtom(new InsetMathBrace(selection)));
1721 docstring Cursor::macroName()
1723 return inMacroMode() ? activeMacro()->name() : docstring();
1727 void Cursor::handleNest(MathAtom const & a, int c)
1729 //lyxerr << "Cursor::handleNest: " << c << endl;
1731 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1734 pushBackward(*nextInset());
1738 int Cursor::targetX() const
1740 if (x_target() != -1)
1749 int Cursor::textTargetOffset() const
1751 return textTargetOffset_;
1755 void Cursor::setTargetX()
1764 bool Cursor::inMacroMode() const
1768 if (pos() == 0 || cell().empty())
1770 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1771 return p && !p->final();
1775 InsetMathUnknown * Cursor::activeMacro()
1777 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1781 InsetMathUnknown const * Cursor::activeMacro() const
1783 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1787 void Cursor::pullArg()
1790 MathData ar = cell();
1791 if (popBackward() && inMathed()) {
1793 cell().insert(pos(), ar);
1796 //formula()->mutateToText();
1801 void Cursor::touch()
1805 DocIterator::const_iterator it = begin();
1806 DocIterator::const_iterator et = end();
1807 for ( ; it != et; ++it)
1813 void Cursor::normalize()
1815 if (idx() > lastidx()) {
1816 lyxerr << "this should not really happen - 1: "
1817 << idx() << ' ' << nargs()
1818 << " in: " << &inset() << endl;
1822 if (pos() > lastpos()) {
1823 lyxerr << "this should not really happen - 2: "
1824 << pos() << ' ' << lastpos() << " in idx: " << idx()
1826 odocstringstream os;
1827 WriteStream wi(os, false, true, WriteStream::wsDefault);
1828 inset().asInsetMath()->write(wi);
1829 lyxerr << to_utf8(os.str()) << endl;
1835 bool Cursor::upDownInMath(bool up)
1837 // Be warned: The 'logic' implemented in this function is highly
1838 // fragile. A distance of one pixel or a '<' vs '<=' _really
1839 // matters. So fiddle around with it only if you think you know
1840 // what you are doing!
1844 xo = beforeDispatchPosX_;
1846 // check if we had something else in mind, if not, this is the future
1848 if (x_target_ == -1)
1850 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1851 // In text mode inside the line (not left or right) possibly set a new target_x,
1852 // but only if we are somewhere else than the previous target-offset.
1854 // We want to keep the x-target on subsequent up/down movements
1855 // that cross beyond the end of short lines. Thus a special
1856 // handling when the cursor is at the end of line: Use the new
1857 // x-target only if the old one was before the end of line
1858 // or the old one was after the beginning of the line
1859 bool inRTL = isWithinRtlParagraph(*this);
1863 left = pos() == textRow().endpos();
1864 right = pos() == textRow().pos();
1866 left = pos() == textRow().pos();
1867 right = pos() == textRow().endpos();
1869 if ((!left && !right) ||
1870 (left && !right && xo < x_target_) ||
1871 (!left && right && x_target_ < xo))
1878 // try neigbouring script insets
1880 if (inMathed() && !selection()) {
1883 InsetMathScript const * p = prevAtom()->asScriptInset();
1884 if (p && p->has(up)) {
1886 push(*const_cast<InsetMathScript*>(p));
1887 idx() = p->idxOfScript(up);
1890 // we went in the right direction? Otherwise don't jump into the script
1894 int oy = beforeDispatchPosY_;
1895 if ((!up && y <= oy) ||
1904 if (pos() != lastpos()) {
1905 InsetMathScript const * p = nextAtom()->asScriptInset();
1906 if (p && p->has(up)) {
1907 push(*const_cast<InsetMathScript*>(p));
1908 idx() = p->idxOfScript(up);
1911 // we went in the right direction? Otherwise don't jump into the script
1915 int oy = beforeDispatchPosY_;
1916 if ((!up && y <= oy) ||
1925 // try to find an inset that knows better then we,
1926 if (inset().idxUpDown(*this, up)) {
1927 //lyxerr << "idxUpDown triggered" << endl;
1928 // try to find best position within this inset
1930 setCursor(bruteFind2(*this, xo, yo));
1934 // any improvement going just out of inset?
1935 if (popBackward() && inMathed()) {
1936 //lyxerr << "updown: popBackward succeeded" << endl;
1939 int yold = beforeDispatchPosY_;
1941 if (up ? ynew < yold : ynew > yold)
1945 // no success, we are probably at the document top or bottom
1951 bool Cursor::atFirstOrLastRow(bool up)
1953 TextMetrics const & tm = bv_->textMetrics(text());
1954 ParagraphMetrics const & pm = tm.parMetrics(pit());
1957 if (pos() && boundary())
1958 row = pm.pos2row(pos() - 1);
1960 row = pm.pos2row(pos());
1963 if (pit() == 0 && row == 0)
1966 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1967 row + 1 >= int(pm.rows().size()))
1974 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1976 LASSERT(text(), return false);
1982 xo = beforeDispatchPosX_;
1984 // update the targetX - this is here before the "return false"
1985 // to set a new target which can be used by InsetTexts above
1986 // if we cannot move up/down inside this inset anymore
1987 if (x_target_ == -1)
1989 else if (xo - textTargetOffset() != x_target() &&
1990 depth() == beforeDispatchCursor_.depth()) {
1991 // In text mode inside the line (not left or right)
1992 // possibly set a new target_x, but only if we are
1993 // somewhere else than the previous target-offset.
1995 // We want to keep the x-target on subsequent up/down
1996 // movements that cross beyond the end of short lines.
1997 // Thus a special handling when the cursor is at the
1998 // end of line: Use the new x-target only if the old
1999 // one was before the end of line or the old one was
2000 // after the beginning of the line
2001 bool inRTL = isWithinRtlParagraph(*this);
2005 left = pos() == textRow().endpos();
2006 right = pos() == textRow().pos();
2008 left = pos() == textRow().pos();
2009 right = pos() == textRow().endpos();
2011 if ((!left && !right) ||
2012 (left && !right && xo < x_target_) ||
2013 (!left && right && x_target_ < xo))
2020 // first get the current line
2021 TextMetrics & tm = bv_->textMetrics(text());
2022 ParagraphMetrics const & pm = tm.parMetrics(pit());
2024 if (pos() && boundary())
2025 row = pm.pos2row(pos() - 1);
2027 row = pm.pos2row(pos());
2029 if (atFirstOrLastRow(up)) {
2030 // Is there a place for the cursor to go ? If yes, we
2031 // can execute the DEPM, otherwise we should keep the
2032 // paragraph to host the cursor.
2033 Cursor dummy = *this;
2034 bool valid_destination = false;
2035 for(; dummy.depth(); dummy.pop())
2036 if (!dummy.atFirstOrLastRow(up)) {
2037 valid_destination = true;
2041 // will a next dispatch follow and if there is a new
2042 // dispatch will it move the cursor out ?
2043 if (depth() > 1 && valid_destination) {
2044 // The cursor hasn't changed yet. This happens when
2045 // you e.g. move out of an inset. And to give the
2046 // DEPM the possibility of doing something we must
2047 // provide it with two different cursors. (Lgb, vfr)
2049 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
2050 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
2052 updateNeeded |= bv().checkDepm(dummy, *this);
2053 updateTextTargetOffset();
2055 forceBufferUpdate();
2060 // with and without selection are handled differently
2062 int yo = bv().getPos(*this).y_;
2064 // To next/previous row
2066 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
2068 tm.editXY(*this, xo, yo + textRow().descent() + 1);
2071 // This happens when you move out of an inset.
2072 // And to give the DEPM the possibility of doing
2073 // something we must provide it with two different
2075 Cursor dummy = *this;
2078 if (bv().checkDepm(dummy, old)) {
2079 updateNeeded = true;
2080 // Make sure that cur gets back whatever happened to dummy (Lgb)
2084 // if there is a selection, we stay out of any inset,
2085 // and just jump to the right position:
2091 } else if (pit() > 0) {
2093 TextMetrics & tm = bv_->textMetrics(text());
2094 if (!tm.contains(pit()))
2095 tm.newParMetricsUp();
2096 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
2097 next_row = pmcur.rows().size() - 1;
2100 if (row + 1 < int(pm.rows().size())) {
2102 } else if (pit() + 1 < int(text()->paragraphs().size())) {
2104 TextMetrics & tm = bv_->textMetrics(text());
2105 if (!tm.contains(pit()))
2106 tm.newParMetricsDown();
2111 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
2113 pos_type const col = tm.getColumnNearX(pit(), real_next_row,
2115 top().pos() = real_next_row.pos() + col;
2118 updateNeeded |= bv().checkDepm(*this, old);
2122 forceBufferUpdate();
2123 updateTextTargetOffset();
2128 void Cursor::handleFont(string const & font)
2130 LYXERR(Debug::DEBUG, font);
2134 safe = cap::grabAndEraseSelection(*this);
2139 if (lastpos() != 0) {
2140 // something left in the cell
2142 // cursor in first position
2144 } else if (pos() == lastpos()) {
2145 // cursor in last position
2148 // cursor in between. split cell
2149 MathData::iterator bt = cell().begin();
2150 MathAtom at = createInsetMath(from_utf8(font), buffer());
2151 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2152 cell().erase(bt, bt + pos());
2157 // nothing left in the cell
2166 void Cursor::message(docstring const & msg) const
2168 disp_.setMessage(msg);
2172 void Cursor::errorMessage(docstring const & msg) const
2174 disp_.setMessage(msg);
2175 disp_.setError(true);
2181 docstring parbreak(Cursor const * cur)
2183 odocstringstream os;
2185 // only add blank line if we're not in a ParbreakIsNewline situation
2186 if (!cur->inset().getLayout().parbreakIsNewline()
2187 && !cur->paragraph().layout().parbreak_is_newline)
2195 docstring Cursor::selectionAsString(bool with_label) const
2201 return cap::grabSelection(*this);
2203 int const label = with_label
2204 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2206 idx_type const startidx = selBegin().idx();
2207 idx_type const endidx = selEnd().idx();
2208 if (startidx != endidx) {
2209 // multicell selection
2210 InsetTabular * table = inset().asInsetTabular();
2211 LASSERT(table, return docstring());
2212 return table->asString(startidx, endidx);
2215 ParagraphList const & pars = text()->paragraphs();
2217 pit_type const startpit = selBegin().pit();
2218 pit_type const endpit = selEnd().pit();
2219 size_t const startpos = selBegin().pos();
2220 size_t const endpos = selEnd().pos();
2222 if (startpit == endpit)
2223 return pars[startpit].asString(startpos, endpos, label);
2225 // First paragraph in selection
2226 docstring result = pars[startpit].
2227 asString(startpos, pars[startpit].size(), label)
2230 // The paragraphs in between (if any)
2231 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2232 Paragraph const & par = pars[pit];
2233 result += par.asString(0, par.size(), label)
2237 // Last paragraph in selection
2238 result += pars[endpit].asString(0, endpos, label);
2244 docstring Cursor::currentState() const
2247 odocstringstream os;
2253 return text()->currentState(*this);
2259 docstring Cursor::getPossibleLabel() const
2261 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2265 Encoding const * Cursor::getEncoding() const
2269 CursorSlice const & sl = innerTextSlice();
2270 Text const & text = *sl.text();
2271 Font font = text.getPar(sl.pit()).getFont(
2272 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2273 return font.language()->encoding();
2277 void Cursor::undispatched() const
2279 disp_.dispatched(false);
2283 void Cursor::dispatched() const
2285 disp_.dispatched(true);
2289 void Cursor::screenUpdateFlags(Update::flags f) const
2291 disp_.screenUpdate(f);
2295 void Cursor::forceBufferUpdate() const
2297 disp_.forceBufferUpdate();
2301 void Cursor::clearBufferUpdate() const
2303 disp_.clearBufferUpdate();
2307 bool Cursor::needBufferUpdate() const
2309 return disp_.needBufferUpdate();
2313 void Cursor::noScreenUpdate() const
2315 disp_.screenUpdate(Update::None);
2319 Font Cursor::getFont() const
2321 // The logic here should more or less match to the
2322 // Cursor::setCurrentFont logic, i.e. the cursor height should
2323 // give a hint what will happen if a character is entered.
2325 // HACK. far from being perfect...
2327 CursorSlice const & sl = innerTextSlice();
2328 Text const & text = *sl.text();
2329 Paragraph const & par = text.getPar(sl.pit());
2331 // on boundary, so we are really at the character before
2332 pos_type pos = sl.pos();
2333 if (pos > 0 && boundary())
2336 // on space? Take the font before (only for RTL boundary stay)
2338 TextMetrics const & tm = bv().textMetrics(&text);
2339 if (pos == sl.lastpos()
2340 || (par.isSeparator(pos)
2341 && !tm.isRTLBoundary(sl.pit(), pos)))
2345 // get font at the position
2346 Font font = par.getFont(buffer()->params(), pos,
2347 text.outerFont(sl.pit()));
2353 bool Cursor::fixIfBroken()
2355 bool const broken_cursor = DocIterator::fixIfBroken();
2356 bool const broken_anchor = anchor_.fixIfBroken();
2358 if (broken_cursor || broken_anchor) {
2359 clearNewWordPosition();
2367 void Cursor::sanitize()
2369 setBuffer(&bv_->buffer());
2370 DocIterator::sanitize();
2375 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2377 // find inset in common
2379 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2380 if (&old[i].inset() != &cur[i].inset())
2384 // update words if we just moved to another paragraph
2385 if (i == old.depth() && i == cur.depth()
2386 && !cur.buffer()->isClean()
2387 && cur.inTexted() && old.inTexted()
2388 && cur.pit() != old.pit()) {
2389 old.paragraph().updateWords();
2392 // notify everything on top of the common part in old cursor,
2393 // but stop if the inset claims the cursor to be invalid now
2394 for (size_type j = i; j < old.depth(); ++j) {
2395 Cursor inset_pos = old;
2396 inset_pos.cutOff(j);
2397 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2401 // notify everything on top of the common part in new cursor,
2402 // but stop if the inset claims the cursor to be invalid now
2403 for (; i < cur.depth(); ++i) {
2404 if (cur[i].inset().notifyCursorEnters(cur))
2412 void Cursor::setCurrentFont()
2414 CursorSlice const & cs = innerTextSlice();
2415 Paragraph const & par = cs.paragraph();
2416 pos_type cpit = cs.pit();
2417 pos_type cpos = cs.pos();
2418 Text const & ctext = *cs.text();
2419 TextMetrics const & tm = bv().textMetrics(&ctext);
2421 // are we behind previous char in fact? -> go to that char
2422 if (cpos > 0 && boundary())
2425 // find position to take the font from
2427 // paragraph end? -> font of last char
2428 if (cpos == lastpos())
2430 // on space? -> look at the words in front of space
2431 else if (cpos > 0 && par.isSeparator(cpos)) {
2432 // abc| def -> font of c
2433 // abc |[WERBEH], i.e. boundary==true -> font of c
2434 // abc [WERBEH]| def, font of the space
2435 if (!tm.isRTLBoundary(cpit, cpos))
2441 BufferParams const & bufparams = buffer()->params();
2442 current_font = par.getFontSettings(bufparams, cpos);
2443 real_current_font = tm.displayFont(cpit, cpos);
2445 // special case for paragraph end
2446 if (cs.pos() == lastpos()
2447 && tm.isRTLBoundary(cpit, cs.pos())
2449 Language const * lang = par.getParLanguage(bufparams);
2450 current_font.setLanguage(lang);
2451 current_font.fontInfo().setNumber(FONT_OFF);
2452 real_current_font.setLanguage(lang);
2453 real_current_font.fontInfo().setNumber(FONT_OFF);
2458 bool Cursor::textUndo()
2460 if (!buffer()->undo().textUndo(*this))
2467 bool Cursor::textRedo()
2469 if (!buffer()->undo().textRedo(*this))
2476 void Cursor::finishUndo() const
2478 buffer()->undo().finishUndo();
2482 void Cursor::beginUndoGroup() const
2484 buffer()->undo().beginUndoGroup();
2488 void Cursor::endUndoGroup() const
2490 buffer()->undo().endUndoGroup(*this);
2494 void Cursor::recordUndo(UndoKind kind, pit_type from, pit_type to) const
2496 buffer()->undo().recordUndo(*this, kind, from, to);
2500 void Cursor::recordUndo(UndoKind kind, pit_type from) const
2502 buffer()->undo().recordUndo(*this, kind, from);
2506 void Cursor::recordUndo(UndoKind kind) const
2508 buffer()->undo().recordUndo(*this, kind);
2512 void Cursor::recordUndoInset(UndoKind kind, Inset const * inset) const
2514 buffer()->undo().recordUndoInset(*this, kind, inset);
2518 void Cursor::recordUndoFullDocument() const
2520 buffer()->undo().recordUndoFullDocument(*this);
2524 void Cursor::recordUndoSelection() const
2527 if (cap::multipleCellsSelected(*this))
2532 buffer()->undo().recordUndo(*this, ATOMIC_UNDO,
2533 selBegin().pit(), selEnd().pit());
2538 void Cursor::checkBufferStructure()
2540 Buffer const * master = buffer()->masterBuffer();
2541 master->tocBackend().updateItem(*this);
2542 if (master != buffer() && !master->hasGuiDelegate())
2543 // In case the master has no gui associated with it,
2544 // the TocItem is not updated (part of bug 5699).
2545 buffer()->tocBackend().updateItem(*this);