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/lassert.h"
40 #include "support/debug.h"
41 #include "support/docstream.h"
43 #include "insets/InsetTabular.h"
44 #include "insets/InsetText.h"
46 #include "mathed/InsetMath.h"
47 #include "mathed/InsetMathBrace.h"
48 #include "mathed/InsetMathScript.h"
49 #include "mathed/MacroTable.h"
50 #include "mathed/MathData.h"
51 #include "mathed/MathMacro.h"
53 #include "support/bind.h"
66 bool positionable(DocIterator const & cursor, DocIterator const & anchor)
68 // avoid deeper nested insets when selecting
69 if (cursor.depth() > anchor.depth())
72 // anchor might be deeper, should have same path then
73 for (size_t i = 0; i < cursor.depth(); ++i)
74 if (&cursor[i].inset() != &anchor[i].inset())
77 // position should be ok.
82 // Find position closest to (x, y) in cell given by iter.
83 // Used only in mathed
84 DocIterator bruteFind2(Cursor const & c, int x, int y)
86 double best_dist = numeric_limits<double>::max();
93 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
94 for (size_t i = 0;; ++i) {
97 Inset const * inset = &it.inset();
98 map<Inset const *, Geometry> const & data =
99 c.bv().coordCache().getInsets().getData();
100 map<Inset const *, Geometry>::const_iterator I = data.find(inset);
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 (I == data.end()) {
111 Point o = I->second.pos;
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 whether this
221 // is the same as "bv.getPos(it, false)" with boundary = false.
222 Point p = bv.getPos(it);
225 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
226 double const dx = xo - x;
227 double const dy = yo - y;
228 double const d = dx * dx + dy * dy;
229 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
230 // << " dx: " << dx << " dy: " << dy
231 // << " idx: " << it.idx() << " pos: " << it.pos()
234 // '<=' in order to take the last possible position
235 // this is important for clicking behind \sum in e.g. '\sum_i a'
236 if (d <= best_dist) {
237 //lyxerr << "*" << endl;
245 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
246 if (best_cursor == et)
248 cur.setCursor(best_cursor);
255 // be careful: this is called from the bv's constructor, too, so
256 // bv functions are not yet available!
257 Cursor::Cursor(BufferView & bv)
258 : DocIterator(&bv.buffer()), bv_(&bv), anchor_(),
259 x_target_(-1), textTargetOffset_(0),
260 selection_(false), mark_(false), word_selection_(false),
261 logicalpos_(false), current_font(inherit_font)
268 push_back(CursorSlice(buffer()->inset()));
269 anchor_ = doc_iterator_begin(buffer());
277 // this (intentionally) does neither touch anchor nor selection status
278 void Cursor::setCursor(DocIterator const & cur)
280 DocIterator::operator=(cur);
284 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
288 // Try to fix cursor in case it is broken.
291 // Is this a function that acts on inset at point?
292 Inset * inset = cur.nextInset();
293 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
294 && inset && inset->getStatus(cur, cmd, status))
297 // This is, of course, a mess. Better create a new doc iterator and use
298 // this in Inset::getStatus. This might require an additional
299 // BufferView * arg, though (which should be avoided)
300 //Cursor safe = *this;
302 for ( ; cur.depth(); cur.pop()) {
303 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
304 LASSERT(cur.idx() <= cur.lastidx(), /**/);
305 LASSERT(cur.pit() <= cur.lastpit(), /**/);
306 LASSERT(cur.pos() <= cur.lastpos(), /**/);
308 // The inset's getStatus() will return 'true' if it made
309 // a definitive decision on whether it want to handle the
310 // request or not. The result of this decision is put into
311 // the 'status' parameter.
312 if (cur.inset().getStatus(cur, cmd, status)) {
321 void Cursor::saveBeforeDispatchPosXY()
323 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
327 void Cursor::dispatch(FuncRequest const & cmd0)
329 LYXERR(Debug::DEBUG, "cmd: " << cmd0 << '\n' << *this);
334 FuncRequest cmd = cmd0;
337 disp_ = DispatchResult();
339 buffer()->undo().beginUndoGroup();
341 // Is this a function that acts on inset at point?
342 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
344 disp_.dispatched(true);
345 disp_.screenUpdate(Update::FitCursor | Update::Force);
346 FuncRequest tmpcmd = cmd;
347 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
348 << cmd0 << endl << *this);
349 nextInset()->dispatch(*this, tmpcmd);
350 if (disp_.dispatched()) {
351 buffer()->undo().endUndoGroup();
356 // store some values to be used inside of the handlers
357 beforeDispatchCursor_ = *this;
358 for (; depth(); pop(), boundary(false)) {
359 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
360 << cmd0 << endl << *this);
361 LASSERT(pos() <= lastpos(), /**/);
362 LASSERT(idx() <= lastidx(), /**/);
363 LASSERT(pit() <= lastpit(), /**/);
365 // The common case is 'LFUN handled, need update', so make the
366 // LFUN handler's life easier by assuming this as default value.
367 // The handler can reset the update and val flags if necessary.
368 disp_.screenUpdate(Update::FitCursor | Update::Force);
369 disp_.dispatched(true);
370 inset().dispatch(*this, cmd);
371 if (disp_.dispatched())
375 // it completely to get a 'bomb early' behaviour in case this
376 // object will be used again.
377 if (!disp_.dispatched()) {
378 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
379 // We might have invalidated the cursor when removing an empty
380 // paragraph while the cursor could not be moved out the inset
381 // while we initially thought we could. This might happen when
382 // a multiline inset becomes an inline inset when the second
383 // paragraph is removed.
384 if (safe.pit() > safe.lastpit()) {
385 safe.pit() = safe.lastpit();
386 safe.pos() = safe.lastpos();
389 disp_.screenUpdate(Update::None);
390 disp_.dispatched(false);
392 // restore the previous one because nested Cursor::dispatch calls
393 // are possible which would change it
394 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
396 buffer()->undo().endUndoGroup();
398 // notify insets we just left
400 old.beginUndoGroup();
402 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
405 bv().resetInlineCompletionPos();
412 DispatchResult const & Cursor::result() const
418 BufferView & Cursor::bv() const
427 LASSERT(depth() >= 1, /**/);
432 void Cursor::push(Inset & p)
434 push_back(CursorSlice(p));
435 p.setBuffer(*buffer());
439 void Cursor::pushBackward(Inset & p)
441 LASSERT(!empty(), return);
442 //lyxerr << "Entering inset " << t << " front" << endl;
448 bool Cursor::popBackward()
450 LASSERT(!empty(), return false);
458 bool Cursor::popForward()
460 LASSERT(!empty(), return false);
461 //lyxerr << "Leaving inset from in back" << endl;
462 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
466 pos() += lastpos() - lp + 1;
471 int Cursor::currentMode()
473 LASSERT(!empty(), /**/);
474 for (int i = depth() - 1; i >= 0; --i) {
475 int res = operator[](i).inset().currentMode();
476 bool locked_mode = operator[](i).inset().lockedMode();
477 // Also return UNDECIDED_MODE when the mode is locked,
478 // as in this case it is treated the same as TEXT_MODE
479 if (res != Inset::UNDECIDED_MODE || locked_mode)
482 return Inset::TEXT_MODE;
486 void Cursor::getPos(int & x, int & y) const
488 Point p = bv().getPos(*this);
494 Row const & Cursor::textRow() const
496 CursorSlice const & cs = innerTextSlice();
497 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
498 LASSERT(!pm.rows().empty(), /**/);
499 return pm.getRow(pos(), boundary());
503 void Cursor::resetAnchor()
506 checkNewWordPosition();
510 void Cursor::setCursorToAnchor()
513 DocIterator normal = anchor_;
514 while (depth() < normal.depth())
516 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
523 void Cursor::markEditPosition()
525 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
526 FontSpan ow = locateWord(WHOLE_WORD);
527 if (ow.size() == 1) {
528 LYXERR(Debug::DEBUG, "start new word: "
530 << " pos: " << ow.first);
537 void Cursor::clearNewWordPosition()
539 if (!new_word_.empty()) {
540 LYXERR(Debug::DEBUG, "clear new word: "
542 << " pos: " << pos());
548 void Cursor::checkNewWordPosition()
550 if (!lyxrc.spellcheck_continuously || new_word_.empty())
553 clearNewWordPosition();
555 // forget the position of the current new word if
556 // 1) the paragraph changes or
557 // 2) the count of nested insets changes or
558 // 3) the cursor pos is out of paragraph bound
559 if (pit() != new_word_.pit() ||
560 depth() != new_word_.depth() ||
561 new_word_.pos() > new_word_.lastpos()) {
562 clearNewWordPosition();
563 } else if (new_word_.fixIfBroken())
564 // 4) or the remembered position was "broken"
565 clearNewWordPosition();
567 FontSpan nw = locateWord(WHOLE_WORD);
569 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
570 if (nw.intersect(ow).empty())
571 clearNewWordPosition();
573 LYXERR(Debug::DEBUG, "new word: "
575 << " pos: " << nw.first << ".." << nw.last);
577 clearNewWordPosition();
584 bool Cursor::posBackward()
593 bool Cursor::posForward()
595 if (pos() == lastpos())
602 bool Cursor::posVisRight(bool skip_inset)
604 Cursor new_cur = *this; // where we will move to
605 pos_type left_pos; // position visually left of current cursor
606 pos_type right_pos; // position visually right of current cursor
607 bool new_pos_is_RTL; // is new position we're moving to RTL?
609 getSurroundingPos(left_pos, right_pos);
611 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
613 // Are we at an inset?
614 new_cur.pos() = right_pos;
615 new_cur.boundary(false);
617 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
618 // we actually move the cursor at the end of this function, for now
619 // we just keep track of the new position in new_cur...
620 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
623 // Are we already at rightmost pos in row?
624 else if (text()->empty() || right_pos == -1) {
627 if (!new_cur.posVisToNewRow(false)) {
628 LYXERR(Debug::RTL, "not moving!");
632 // we actually move the cursor at the end of this function, for now
633 // just keep track of the new position in new_cur...
634 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
635 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
638 // normal movement to the right
641 // Recall, if the cursor is at position 'x', that means *before*
642 // the character at position 'x'. In RTL, "before" means "to the
643 // right of", in LTR, "to the left of". So currently our situation
644 // is this: the position to our right is 'right_pos' (i.e., we're
645 // currently to the left of 'right_pos'). In order to move to the
646 // right, it depends whether or not the character at 'right_pos' is RTL.
647 new_pos_is_RTL = paragraph().getFontSettings(
648 buffer()->params(), right_pos).isVisibleRightToLeft();
649 // If the character at 'right_pos' *is* LTR, then in order to move to
650 // the right of it, we need to be *after* 'right_pos', i.e., move to
651 // position 'right_pos' + 1.
652 if (!new_pos_is_RTL) {
653 new_cur.pos() = right_pos + 1;
654 // set the boundary to true in two situations:
656 // 1. if new_pos is now lastpos, and we're in an RTL paragraph
657 // (this means that we're moving right to the end of an LTR chunk
658 // which is at the end of an RTL paragraph);
659 (new_cur.pos() == lastpos()
660 && paragraph().isRTL(buffer()->params()))
661 // 2. if the position *after* right_pos is RTL (we want to be
662 // *after* right_pos, not before right_pos + 1!)
663 || paragraph().getFontSettings(buffer()->params(),
664 new_cur.pos()).isVisibleRightToLeft()
666 new_cur.boundary(true);
667 else // set the boundary to false
668 new_cur.boundary(false);
670 // Otherwise (if the character at position 'right_pos' is RTL), then
671 // moving to the right of it is as easy as setting the new position
674 new_cur.pos() = right_pos;
675 new_cur.boundary(false);
680 bool moved = (new_cur.pos() != pos()
681 || new_cur.pit() != pit()
682 || new_cur.boundary() != boundary()
683 || &new_cur.inset() != &inset());
686 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
687 << (new_cur.boundary() ? " (boundary)" : ""));
695 bool Cursor::posVisLeft(bool skip_inset)
697 Cursor new_cur = *this; // where we will move to
698 pos_type left_pos; // position visually left of current cursor
699 pos_type right_pos; // position visually right of current cursor
700 bool new_pos_is_RTL; // is new position we're moving to RTL?
702 getSurroundingPos(left_pos, right_pos);
704 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
706 // Are we at an inset?
707 new_cur.pos() = left_pos;
708 new_cur.boundary(false);
710 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
711 // we actually move the cursor at the end of this function, for now
712 // we just keep track of the new position in new_cur...
713 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
716 // Are we already at leftmost pos in row?
717 else if (text()->empty() || left_pos == -1) {
720 if (!new_cur.posVisToNewRow(true)) {
721 LYXERR(Debug::RTL, "not moving!");
725 // we actually move the cursor at the end of this function, for now
726 // just keep track of the new position in new_cur...
727 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
728 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
731 // normal movement to the left
734 // Recall, if the cursor is at position 'x', that means *before*
735 // the character at position 'x'. In RTL, "before" means "to the
736 // right of", in LTR, "to the left of". So currently our situation
737 // is this: the position to our left is 'left_pos' (i.e., we're
738 // currently to the right of 'left_pos'). In order to move to the
739 // left, it depends whether or not the character at 'left_pos' is RTL.
740 new_pos_is_RTL = paragraph().getFontSettings(
741 buffer()->params(), left_pos).isVisibleRightToLeft();
742 // If the character at 'left_pos' *is* RTL, then in order to move to
743 // the left of it, we need to be *after* 'left_pos', i.e., move to
744 // position 'left_pos' + 1.
745 if (new_pos_is_RTL) {
746 new_cur.pos() = left_pos + 1;
747 // set the boundary to true in two situations:
749 // 1. if new_pos is now lastpos and we're in an LTR paragraph
750 // (this means that we're moving left to the end of an RTL chunk
751 // which is at the end of an LTR paragraph);
752 (new_cur.pos() == lastpos()
753 && !paragraph().isRTL(buffer()->params()))
754 // 2. if the position *after* left_pos is not RTL (we want to be
755 // *after* left_pos, not before left_pos + 1!)
756 || !paragraph().getFontSettings(buffer()->params(),
757 new_cur.pos()).isVisibleRightToLeft()
759 new_cur.boundary(true);
760 else // set the boundary to false
761 new_cur.boundary(false);
763 // Otherwise (if the character at position 'left_pos' is LTR), then
764 // moving to the left of it is as easy as setting the new position
767 new_cur.pos() = left_pos;
768 new_cur.boundary(false);
773 bool moved = (new_cur.pos() != pos()
774 || new_cur.pit() != pit()
775 || new_cur.boundary() != boundary());
778 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
779 << (new_cur.boundary() ? " (boundary)" : ""));
787 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
789 // preparing bidi tables
790 Paragraph const & par = paragraph();
791 Buffer const & buf = *buffer();
792 Row const & row = textRow();
794 bidi.computeTables(par, buf, row);
796 LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
798 // The cursor is painted *before* the character at pos(), or, if 'boundary'
799 // is true, *after* the character at (pos() - 1). So we already have one
800 // known position around the cursor:
801 pos_type const known_pos = boundary() && pos() > 0 ? pos() - 1 : pos();
803 // edge case: if we're at the end of the paragraph, things are a little
804 // different (because lastpos is a position which does not really "exist"
805 // --- there's no character there yet).
806 if (known_pos == lastpos()) {
807 if (par.isRTL(buf.params())) {
809 right_pos = bidi.vis2log(row.pos());
813 left_pos = bidi.vis2log(row.endpos() - 1);
818 // Whether 'known_pos' is to the left or to the right of the cursor depends
819 // on whether it is an RTL or LTR character...
820 bool const cur_is_RTL =
821 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
822 // ... in the following manner:
823 // For an RTL character, "before" means "to the right" and "after" means
824 // "to the left"; and for LTR, it's the reverse. So, 'known_pos' is to the
825 // right of the cursor if (RTL && boundary) or (!RTL && !boundary):
826 bool const known_pos_on_right = cur_is_RTL == boundary();
828 // So we now know one of the positions surrounding the cursor. Let's
829 // determine the other one:
830 if (known_pos_on_right) {
831 right_pos = known_pos;
832 // *visual* position of 'left_pos':
833 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
834 // If the position we just identified as 'left_pos' is a "skipped
835 // separator" (a separator which is at the logical end of a row,
836 // except for the last row in a paragraph; such separators are not
837 // painted, so they "are not really there"; note that in bidi text,
838 // such a separator could appear visually in the middle of a row),
839 // set 'left_pos' to the *next* position to the left.
840 if (bidi.inRange(v_left_pos)
841 && bidi.vis2log(v_left_pos) + 1 == row.endpos()
842 && row.endpos() < lastpos()
843 && par.isSeparator(bidi.vis2log(v_left_pos)))
846 // calculate the logical position of 'left_pos', if in row
847 if (!bidi.inRange(v_left_pos))
850 left_pos = bidi.vis2log(v_left_pos);
851 // If the position we identified as 'right_pos' is a "skipped
852 // separator", set 'right_pos' to the *next* position to the right.
853 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos()
854 && par.isSeparator(right_pos)) {
855 pos_type const v_right_pos = bidi.log2vis(right_pos) + 1;
856 if (!bidi.inRange(v_right_pos))
859 right_pos = bidi.vis2log(v_right_pos);
862 // known_pos is on the left
863 left_pos = known_pos;
864 // *visual* position of 'right_pos'
865 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
866 // If the position we just identified as 'right_pos' is a "skipped
867 // separator", set 'right_pos' to the *next* position to the right.
868 if (bidi.inRange(v_right_pos)
869 && bidi.vis2log(v_right_pos) + 1 == row.endpos()
870 && row.endpos() < lastpos()
871 && par.isSeparator(bidi.vis2log(v_right_pos)))
874 // calculate the logical position of 'right_pos', if in row
875 if (!bidi.inRange(v_right_pos))
878 right_pos = bidi.vis2log(v_right_pos);
879 // If the position we identified as 'left_pos' is a "skipped
880 // separator", set 'left_pos' to the *next* position to the left.
881 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos()
882 && par.isSeparator(left_pos)) {
883 pos_type const v_left_pos = bidi.log2vis(left_pos) - 1;
884 if (!bidi.inRange(v_left_pos))
887 left_pos = bidi.vis2log(v_left_pos);
894 bool Cursor::posVisToNewRow(bool movingLeft)
896 Paragraph const & par = paragraph();
897 Buffer const & buf = *buffer();
898 Row const & row = textRow();
899 bool par_is_LTR = !par.isRTL(buf.params());
901 // Inside a table, determining whether to move to the next or previous row
902 // should be done based on the table's direction.
904 if (s >= 1 && (*this)[s].inset().asInsetTabular()) {
905 par_is_LTR = !(*this)[s].inset().asInsetTabular()->isRightToLeft(*this);
906 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
909 // if moving left in an LTR paragraph or moving right in an RTL one,
910 // move to previous row
911 if (par_is_LTR == movingLeft) {
912 if (row.pos() == 0) { // we're at first row in paragraph
913 if (pit() == 0) // no previous paragraph! don't move
915 // move to last pos in previous par
919 } else { // move to previous row in this par
920 pos() = row.pos() - 1; // this is guaranteed to be in previous row
924 // if moving left in an RTL paragraph or moving right in an LTR one,
927 if (row.endpos() == lastpos()) { // we're at last row in paragraph
928 if (pit() == lastpit()) // last paragraph! don't move
930 // move to first row in next par
934 } else { // move to next row in this par
935 pos() = row.endpos();
940 // make sure we're at left-/right-most pos in new row
941 posVisToRowExtremity(!movingLeft);
947 void Cursor::posVisToRowExtremity(bool left)
949 // prepare bidi tables
950 Paragraph const & par = paragraph();
951 Buffer const & buf = *buffer();
952 Row const & row = textRow();
954 bidi.computeTables(par, buf, row);
956 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
957 << (boundary() ? 1 : 0));
959 if (left) { // move to leftmost position
960 // if this is an RTL paragraph, and we're at the last row in the
961 // paragraph, move to lastpos
962 if (par.isRTL(buf.params()) && row.endpos() == lastpos())
965 pos() = bidi.vis2log(row.pos());
967 // Moving to the leftmost position in the row, the cursor should
968 // normally be placed to the *left* of the leftmost position.
969 // A very common exception, though, is if the leftmost character
970 // also happens to be the separator at the (logical) end of the row
971 // --- in this case, the separator is positioned beyond the left
972 // margin, and we don't want to move the cursor there (moving to
973 // the left of the separator is equivalent to moving to the next
974 // line). So, in this case we actually want to place the cursor
975 // to the *right* of the leftmost position (the separator).
976 // Another exception is if we're moving to the logically last
977 // position in the row, which is *not* a separator: this means
978 // that the entire row has no separators (if there were any, the
979 // row would have been broken there); and therefore in this case
980 // we also move to the *right* of the last position (this indicates
981 // to the user that there is no space after this position, and is
982 // consistent with the behavior in the middle of a row --- moving
983 // right or left moves to the next/previous character; if we were
984 // to move to the *left* of this position, that would simulate
985 // a separator which is not really there!).
986 // Finally, there is an exception to the previous exception: if
987 // this non-separator-but-last-position-in-row is an inset, then
988 // we *do* want to stay to the left of it anyway: this is the
989 // "boundary" which we simulate at insets.
990 // Another exception is when row.endpos() is 0.
992 // do we want to be to the right of pos?
993 // as explained above, if at last pos in row, stay to the right
994 bool const right_of_pos = row.endpos() > 0
995 && pos() == row.endpos() - 1 && !par.isInset(pos());
997 // Now we know if we want to be to the left or to the right of pos,
998 // let's make sure we are where we want to be.
999 bool const new_pos_is_RTL =
1000 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
1002 if (new_pos_is_RTL != right_of_pos) {
1008 // move to rightmost position
1009 // if this is an LTR paragraph, and we're at the last row in the
1010 // paragraph, move to lastpos
1011 if (!par.isRTL(buf.params()) && row.endpos() == lastpos())
1014 pos() = row.endpos() > 0 ? bidi.vis2log(row.endpos() - 1) : 0;
1016 // Moving to the rightmost position in the row, the cursor should
1017 // normally be placed to the *right* of the rightmost position.
1018 // A very common exception, though, is if the rightmost character
1019 // also happens to be the separator at the (logical) end of the row
1020 // --- in this case, the separator is positioned beyond the right
1021 // margin, and we don't want to move the cursor there (moving to
1022 // the right of the separator is equivalent to moving to the next
1023 // line). So, in this case we actually want to place the cursor
1024 // to the *left* of the rightmost position (the separator).
1025 // Another exception is if we're moving to the logically last
1026 // position in the row, which is *not* a separator: this means
1027 // that the entire row has no separators (if there were any, the
1028 // row would have been broken there); and therefore in this case
1029 // we also move to the *left* of the last position (this indicates
1030 // to the user that there is no space after this position, and is
1031 // consistent with the behavior in the middle of a row --- moving
1032 // right or left moves to the next/previous character; if we were
1033 // to move to the *right* of this position, that would simulate
1034 // a separator which is not really there!).
1035 // Finally, there is an exception to the previous exception: if
1036 // this non-separator-but-last-position-in-row is an inset, then
1037 // we *do* want to stay to the right of it anyway: this is the
1038 // "boundary" which we simulate at insets.
1039 // Another exception is when row.endpos() is 0.
1041 // do we want to be to the left of pos?
1042 // as explained above, if at last pos in row, stay to the left,
1043 // unless the last position is the same as the first.
1044 bool const left_of_pos = row.endpos() > 0
1045 && pos() == row.endpos() - 1 && !par.isInset(pos());
1047 // Now we know if we want to be to the left or to the right of pos,
1048 // let's make sure we are where we want to be.
1049 bool const new_pos_is_RTL =
1050 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
1052 if (new_pos_is_RTL == left_of_pos) {
1058 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1059 << (boundary() ? 1 : 0));
1063 CursorSlice Cursor::normalAnchor() const
1067 LASSERT(anchor_.depth() >= depth(), /**/);
1068 CursorSlice normal = anchor_[depth() - 1];
1069 if (depth() < anchor_.depth() && top() <= normal) {
1070 // anchor is behind cursor -> move anchor behind the inset
1077 DocIterator & Cursor::realAnchor()
1083 CursorSlice Cursor::selBegin() const
1087 return normalAnchor() < top() ? normalAnchor() : top();
1091 CursorSlice Cursor::selEnd() const
1095 return normalAnchor() > top() ? normalAnchor() : top();
1099 DocIterator Cursor::selectionBegin() const
1105 // FIXME: This is a work-around for the problem that
1106 // CursorSlice doesn't keep track of the boundary.
1107 if (normalAnchor() == top())
1108 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1110 di = normalAnchor() < top() ? anchor_ : *this;
1116 DocIterator Cursor::selectionEnd() const
1122 // FIXME: This is a work-around for the problem that
1123 // CursorSlice doesn't keep track of the boundary.
1124 if (normalAnchor() == top())
1125 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1127 di = normalAnchor() > top() ? anchor_ : *this;
1129 if (di.depth() > depth()) {
1137 void Cursor::setSelection()
1140 // A selection with no contents is not a selection
1141 // FIXME: doesnt look ok
1142 if (idx() == normalAnchor().idx() &&
1143 pit() == normalAnchor().pit() &&
1144 pos() == normalAnchor().pos())
1145 setSelection(false);
1149 void Cursor::setSelection(DocIterator const & where, int n)
1158 void Cursor::clearSelection()
1160 setSelection(false);
1161 setWordSelection(false);
1167 void Cursor::setTargetX(int x)
1170 textTargetOffset_ = 0;
1174 int Cursor::x_target() const
1180 void Cursor::clearTargetX()
1183 textTargetOffset_ = 0;
1187 void Cursor::updateTextTargetOffset()
1192 textTargetOffset_ = x - x_target_;
1196 void Cursor::info(odocstream & os) const
1198 for (int i = 1, n = depth(); i < n; ++i) {
1199 operator[](i).inset().infoize(os);
1203 Inset const * inset = prevInset();
1204 // prevInset() can return 0 in certain case.
1206 prevInset()->infoize2(os);
1208 // overwite old message
1213 bool Cursor::selHandle(bool sel)
1215 //lyxerr << "Cursor::selHandle" << endl;
1218 if (sel == selection())
1222 cap::saveSelection(*this);
1230 ostream & operator<<(ostream & os, Cursor const & cur)
1232 os << "\n cursor: | anchor:\n";
1233 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
1234 os << " " << cur[i] << " | ";
1235 if (i < cur.anchor_.depth())
1236 os << cur.anchor_[i];
1238 os << "-------------------------------";
1241 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
1242 os << "------------------------------- | " << cur.anchor_[i] << "\n";
1244 os << " selection: " << cur.selection_
1245 << " x_target: " << cur.x_target_ << endl;
1250 LyXErr & operator<<(LyXErr & os, Cursor const & cur)
1260 ///////////////////////////////////////////////////////////////////
1263 // The part below is the non-integrated rest of the original math
1264 // cursor. This should be either generalized for texted or moved
1265 // back to mathed (in most cases to InsetMathNest).
1267 ///////////////////////////////////////////////////////////////////
1269 #include "mathed/InsetMathChar.h"
1270 #include "mathed/InsetMathGrid.h"
1271 #include "mathed/InsetMathScript.h"
1272 #include "mathed/InsetMathUnknown.h"
1273 #include "mathed/MathFactory.h"
1274 #include "mathed/MathStream.h"
1275 #include "mathed/MathSupport.h"
1280 bool Cursor::isInside(Inset const * p) const
1282 for (size_t i = 0; i != depth(); ++i)
1283 if (&operator[](i).inset() == p)
1289 void Cursor::leaveInset(Inset const & inset)
1291 for (size_t i = 0; i != depth(); ++i) {
1292 if (&operator[](i).inset() == &inset) {
1300 bool Cursor::openable(MathAtom const & t) const
1311 // we can't move into anything new during selection
1312 if (depth() >= anchor_.depth())
1314 if (t.nucleus() != &anchor_[depth()].inset())
1321 void Cursor::setScreenPos(int x, int /*y*/)
1324 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1329 void Cursor::plainErase()
1331 cell().erase(pos());
1335 void Cursor::markInsert()
1337 insert(char_type(0));
1341 void Cursor::markErase()
1343 cell().erase(pos());
1347 void Cursor::plainInsert(MathAtom const & t)
1349 cell().insert(pos(), t);
1351 inset().setBuffer(bv_->buffer());
1353 forceBufferUpdate();
1357 void Cursor::insert(docstring const & str)
1359 for_each(str.begin(), str.end(),
1360 bind(static_cast<void(Cursor::*)(char_type)>
1361 (&Cursor::insert), this, _1));
1365 void Cursor::insert(char_type c)
1367 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1368 LASSERT(!empty(), /**/);
1370 cap::selClearOrDel(*this);
1371 insert(new InsetMathChar(c));
1373 text()->insertChar(*this, c);
1378 void Cursor::insert(MathAtom const & t)
1380 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1382 cap::selClearOrDel(*this);
1387 void Cursor::insert(Inset * inset0)
1389 LASSERT(inset0, /**/);
1391 insert(MathAtom(inset0->asInsetMath()));
1393 text()->insertInset(*this, inset0);
1394 inset0->setBuffer(bv_->buffer());
1396 if (inset0->isLabeled())
1397 forceBufferUpdate();
1402 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1404 MathData ar(buffer());
1406 if (ar.size() == 1 && (enter || selection()))
1414 void Cursor::niceInsert(MathAtom const & t)
1417 docstring const safe = cap::grabAndEraseSelection(*this);
1419 // If possible, enter the new inset and move the contents of the selection
1420 if (t->isActive()) {
1422 // be careful here: don't use 'pushBackward(t)' as this we need to
1423 // push the clone, not the original
1424 pushBackward(*nextInset());
1425 // We may not use niceInsert here (recursion)
1426 MathData ar(buffer());
1429 } else if (t->asMacro() && !safe.empty()) {
1430 MathData ar(buffer());
1432 docstring const name = t->asMacro()->name();
1433 MacroData const * data = buffer()->getMacro(name);
1434 if (data && data->numargs() - data->optionals() > 0) {
1435 plainInsert(MathAtom(new InsetMathBrace(ar)));
1442 void Cursor::insert(MathData const & ar)
1446 cap::eraseSelection(*this);
1447 cell().insert(pos(), ar);
1449 // FIXME audit setBuffer calls
1450 inset().setBuffer(bv_->buffer());
1454 bool Cursor::backspace()
1456 autocorrect() = false;
1459 cap::eraseSelection(*this);
1464 // If empty cell, and not part of a big cell
1465 if (lastpos() == 0 && inset().nargs() == 1) {
1467 // Directly delete empty cell: [|[]] => [|]
1473 // [|], can not delete from inside
1484 if (inMacroMode()) {
1485 InsetMathUnknown * p = activeMacro();
1486 if (p->name().size() > 1) {
1487 p->setName(p->name().substr(0, p->name().size() - 1));
1492 if (pos() != 0 && prevAtom()->nargs() > 0) {
1493 // let's require two backspaces for 'big stuff' and
1494 // highlight on the first
1506 bool Cursor::erase()
1508 autocorrect() = false;
1513 cap::eraseSelection(*this);
1517 // delete empty cells if possible
1518 if (pos() == lastpos() && inset().idxDelete(idx()))
1521 // special behaviour when in last position of cell
1522 if (pos() == lastpos()) {
1523 bool one_cell = inset().nargs() == 1;
1524 if (one_cell && lastpos() == 0) {
1526 // Directly delete empty cell: [|[]] => [|]
1532 // [|], can not delete from inside
1537 inset().idxGlue(idx());
1541 // 'clever' UI hack: only erase large items if previously slected
1542 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1557 DocIterator save = *this;
1558 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1559 this->dispatch(cmd);
1560 if (disp_.dispatched())
1563 autocorrect() = false;
1571 DocIterator save = *this;
1572 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1573 this->dispatch(cmd);
1574 if (disp_.dispatched())
1577 autocorrect() = false;
1582 bool Cursor::macroModeClose()
1586 InsetMathUnknown * p = activeMacro();
1588 MathData selection(buffer());
1589 asArray(p->selection(), selection);
1590 docstring const s = p->name();
1592 cell().erase(pos());
1594 // do nothing if the macro name is empty
1598 // trigger updates of macros, at least, if no full
1599 // updates take place anyway
1600 screenUpdateFlags(Update::Force);
1602 docstring const name = s.substr(1);
1603 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1604 if (in && in->interpretString(*this, s))
1606 MathAtom atom = buffer()->getMacro(name, *this, false) ?
1607 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1609 // try to put argument into macro, if we just inserted a macro
1610 bool macroArg = false;
1611 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1613 // macros here are still unfolded (in init mode in fact). So
1614 // we have to resolve the macro here manually and check its arity
1615 // to put the selection behind it if arity > 0.
1616 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1617 if (selection.size() > 0 && data && data->numargs() - data->optionals() > 0) {
1619 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1621 // non-greedy case. Do not touch the arguments behind
1622 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1625 // insert remembered selection into first argument of a non-macro
1626 else if (atom.nucleus()->nargs() > 0)
1627 atom.nucleus()->cell(0).append(selection);
1631 // finally put the macro argument behind, if needed
1633 if (selection.size() > 1 || selection[0]->asScriptInset())
1634 plainInsert(MathAtom(new InsetMathBrace(selection)));
1643 docstring Cursor::macroName()
1645 return inMacroMode() ? activeMacro()->name() : docstring();
1649 void Cursor::handleNest(MathAtom const & a, int c)
1651 //lyxerr << "Cursor::handleNest: " << c << endl;
1653 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1656 pushBackward(*nextInset());
1660 int Cursor::targetX() const
1662 if (x_target() != -1)
1671 int Cursor::textTargetOffset() const
1673 return textTargetOffset_;
1677 void Cursor::setTargetX()
1686 bool Cursor::inMacroMode() const
1690 if (pos() == 0 || cell().empty())
1692 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1693 return p && !p->final();
1697 InsetMathUnknown * Cursor::activeMacro()
1699 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1703 InsetMathUnknown const * Cursor::activeMacro() const
1705 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1709 void Cursor::pullArg()
1712 MathData ar = cell();
1713 if (popBackward() && inMathed()) {
1715 cell().insert(pos(), ar);
1718 //formula()->mutateToText();
1723 void Cursor::touch()
1727 DocIterator::const_iterator it = begin();
1728 DocIterator::const_iterator et = end();
1729 for ( ; it != et; ++it)
1735 void Cursor::normalize()
1737 if (idx() > lastidx()) {
1738 lyxerr << "this should not really happen - 1: "
1739 << idx() << ' ' << nargs()
1740 << " in: " << &inset() << endl;
1744 if (pos() > lastpos()) {
1745 lyxerr << "this should not really happen - 2: "
1746 << pos() << ' ' << lastpos() << " in idx: " << idx()
1748 odocstringstream os;
1749 WriteStream wi(os, false, true, WriteStream::wsDefault);
1750 inset().asInsetMath()->write(wi);
1751 lyxerr << to_utf8(os.str()) << endl;
1757 bool Cursor::upDownInMath(bool up)
1759 // Be warned: The 'logic' implemented in this function is highly
1760 // fragile. A distance of one pixel or a '<' vs '<=' _really
1761 // matters. So fiddle around with it only if you think you know
1762 // what you are doing!
1766 xo = beforeDispatchPosX_;
1768 // check if we had something else in mind, if not, this is the future
1770 if (x_target_ == -1)
1772 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1773 // In text mode inside the line (not left or right) possibly set a new target_x,
1774 // but only if we are somewhere else than the previous target-offset.
1776 // We want to keep the x-target on subsequent up/down movements
1777 // that cross beyond the end of short lines. Thus a special
1778 // handling when the cursor is at the end of line: Use the new
1779 // x-target only if the old one was before the end of line
1780 // or the old one was after the beginning of the line
1781 bool inRTL = isWithinRtlParagraph(*this);
1785 left = pos() == textRow().endpos();
1786 right = pos() == textRow().pos();
1788 left = pos() == textRow().pos();
1789 right = pos() == textRow().endpos();
1791 if ((!left && !right) ||
1792 (left && !right && xo < x_target_) ||
1793 (!left && right && x_target_ < xo))
1800 // try neigbouring script insets
1802 if (inMathed() && !selection()) {
1805 InsetMathScript const * p = prevAtom()->asScriptInset();
1806 if (p && p->has(up)) {
1808 push(*const_cast<InsetMathScript*>(p));
1809 idx() = p->idxOfScript(up);
1812 // we went in the right direction? Otherwise don't jump into the script
1816 int oy = beforeDispatchPosY_;
1817 if ((!up && y <= oy) ||
1826 if (pos() != lastpos()) {
1827 InsetMathScript const * p = nextAtom()->asScriptInset();
1828 if (p && p->has(up)) {
1829 push(*const_cast<InsetMathScript*>(p));
1830 idx() = p->idxOfScript(up);
1833 // we went in the right direction? Otherwise don't jump into the script
1837 int oy = beforeDispatchPosY_;
1838 if ((!up && y <= oy) ||
1847 // try to find an inset that knows better then we,
1848 if (inset().idxUpDown(*this, up)) {
1849 //lyxerr << "idxUpDown triggered" << endl;
1850 // try to find best position within this inset
1852 setCursor(bruteFind2(*this, xo, yo));
1856 // any improvement going just out of inset?
1857 if (popBackward() && inMathed()) {
1858 //lyxerr << "updown: popBackward succeeded" << endl;
1861 int yold = beforeDispatchPosY_;
1863 if (up ? ynew < yold : ynew > yold)
1867 // no success, we are probably at the document top or bottom
1873 bool Cursor::atFirstOrLastRow(bool up)
1875 TextMetrics const & tm = bv_->textMetrics(text());
1876 ParagraphMetrics const & pm = tm.parMetrics(pit());
1879 if (pos() && boundary())
1880 row = pm.pos2row(pos() - 1);
1882 row = pm.pos2row(pos());
1885 if (pit() == 0 && row == 0)
1888 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1889 row + 1 >= int(pm.rows().size()))
1895 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1897 LASSERT(text(), /**/);
1903 xo = beforeDispatchPosX_;
1905 // update the targetX - this is here before the "return false"
1906 // to set a new target which can be used by InsetTexts above
1907 // if we cannot move up/down inside this inset anymore
1908 if (x_target_ == -1)
1910 else if (xo - textTargetOffset() != x_target() &&
1911 depth() == beforeDispatchCursor_.depth()) {
1912 // In text mode inside the line (not left or right) possibly set a new target_x,
1913 // but only if we are somewhere else than the previous target-offset.
1915 // We want to keep the x-target on subsequent up/down movements
1916 // that cross beyond the end of short lines. Thus a special
1917 // handling when the cursor is at the end of line: Use the new
1918 // x-target only if the old one was before the end of line
1919 // or the old one was after the beginning of the line
1920 bool inRTL = isWithinRtlParagraph(*this);
1924 left = pos() == textRow().endpos();
1925 right = pos() == textRow().pos();
1927 left = pos() == textRow().pos();
1928 right = pos() == textRow().endpos();
1930 if ((!left && !right) ||
1931 (left && !right && xo < x_target_) ||
1932 (!left && right && x_target_ < xo))
1939 // first get the current line
1940 TextMetrics & tm = bv_->textMetrics(text());
1941 ParagraphMetrics const & pm = tm.parMetrics(pit());
1943 if (pos() && boundary())
1944 row = pm.pos2row(pos() - 1);
1946 row = pm.pos2row(pos());
1948 if (atFirstOrLastRow(up)) {
1949 // Is there a place for the cursor to go ? If yes, we
1950 // can execute the DEPM, otherwise we should keep the
1951 // paragraph to host the cursor.
1952 Cursor dummy = *this;
1953 bool valid_destination = false;
1954 for(; dummy.depth(); dummy.pop())
1955 if (!dummy.atFirstOrLastRow(up)) {
1956 valid_destination = true;
1960 // will a next dispatch follow and if there is a new
1961 // dispatch will it move the cursor out ?
1962 if (depth() > 1 && valid_destination) {
1963 // The cursor hasn't changed yet. This happens when
1964 // you e.g. move out of an inset. And to give the
1965 // DEPM the possibility of doing something we must
1966 // provide it with two different cursors. (Lgb, vfr)
1968 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1969 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1971 updateNeeded |= bv().checkDepm(dummy, *this);
1972 updateTextTargetOffset();
1974 forceBufferUpdate();
1979 // with and without selection are handled differently
1981 int yo = bv().getPos(*this).y_;
1983 // To next/previous row
1985 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1987 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1990 // This happens when you move out of an inset.
1991 // And to give the DEPM the possibility of doing
1992 // something we must provide it with two different
1994 Cursor dummy = *this;
1997 if (bv().checkDepm(dummy, old)) {
1998 updateNeeded = true;
1999 // Make sure that cur gets back whatever happened to dummy (Lgb)
2003 // if there is a selection, we stay out of any inset,
2004 // and just jump to the right position:
2010 } else if (pit() > 0) {
2012 TextMetrics & tm = bv_->textMetrics(text());
2013 if (!tm.contains(pit()))
2014 tm.newParMetricsUp();
2015 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
2016 next_row = pmcur.rows().size() - 1;
2019 if (row + 1 < int(pm.rows().size())) {
2021 } else if (pit() + 1 < int(text()->paragraphs().size())) {
2023 TextMetrics & tm = bv_->textMetrics(text());
2024 if (!tm.contains(pit()))
2025 tm.newParMetricsDown();
2029 top().pos() = min(tm.x2pos(pit(), next_row, xo), top().lastpos());
2031 int const xpos = tm.x2pos(pit(), next_row, xo);
2032 bool const at_end_row = xpos == tm.x2pos(pit(), next_row, tm.width());
2033 bool const at_beg_row = xpos == tm.x2pos(pit(), next_row, 0);
2035 if (at_end_row && at_beg_row)
2036 // make sure the cursor ends up on this row
2039 boundary(at_end_row);
2041 updateNeeded |= bv().checkDepm(*this, old);
2045 forceBufferUpdate();
2046 updateTextTargetOffset();
2051 void Cursor::handleFont(string const & font)
2053 LYXERR(Debug::DEBUG, font);
2057 safe = cap::grabAndEraseSelection(*this);
2062 if (lastpos() != 0) {
2063 // something left in the cell
2065 // cursor in first position
2067 } else if (pos() == lastpos()) {
2068 // cursor in last position
2071 // cursor in between. split cell
2072 MathData::iterator bt = cell().begin();
2073 MathAtom at = createInsetMath(from_utf8(font), buffer());
2074 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2075 cell().erase(bt, bt + pos());
2080 // nothing left in the cell
2089 void Cursor::message(docstring const & msg) const
2091 disp_.setMessage(msg);
2095 void Cursor::errorMessage(docstring const & msg) const
2097 disp_.setMessage(msg);
2098 disp_.setError(true);
2103 docstring parbreak(Cursor const * cur)
2105 odocstringstream os;
2107 // only add blank line if we're not in a ParbreakIsNewline situation
2108 if (!cur->inset().getLayout().parbreakIsNewline()
2109 && !cur->paragraph().layout().parbreak_is_newline)
2116 docstring Cursor::selectionAsString(bool with_label) const
2122 return cap::grabSelection(*this);
2124 int const label = with_label
2125 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2127 idx_type const startidx = selBegin().idx();
2128 idx_type const endidx = selEnd().idx();
2129 if (startidx != endidx) {
2130 // multicell selection
2131 InsetTabular * table = inset().asInsetTabular();
2132 LASSERT(table, return docstring());
2133 return table->asString(startidx, endidx);
2136 ParagraphList const & pars = text()->paragraphs();
2138 pit_type const startpit = selBegin().pit();
2139 pit_type const endpit = selEnd().pit();
2140 size_t const startpos = selBegin().pos();
2141 size_t const endpos = selEnd().pos();
2143 if (startpit == endpit)
2144 return pars[startpit].asString(startpos, endpos, label);
2146 // First paragraph in selection
2147 docstring result = pars[startpit].
2148 asString(startpos, pars[startpit].size(), label)
2151 // The paragraphs in between (if any)
2152 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2153 Paragraph const & par = pars[pit];
2154 result += par.asString(0, par.size(), label)
2158 // Last paragraph in selection
2159 result += pars[endpit].asString(0, endpos, label);
2165 docstring Cursor::currentState() const
2168 odocstringstream os;
2174 return text()->currentState(*this);
2180 docstring Cursor::getPossibleLabel() const
2182 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2186 Encoding const * Cursor::getEncoding() const
2190 CursorSlice const & sl = innerTextSlice();
2191 Text const & text = *sl.text();
2192 Font font = text.getPar(sl.pit()).getFont(
2193 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2194 return font.language()->encoding();
2198 void Cursor::undispatched() const
2200 disp_.dispatched(false);
2204 void Cursor::dispatched() const
2206 disp_.dispatched(true);
2210 void Cursor::screenUpdateFlags(Update::flags f) const
2212 disp_.screenUpdate(f);
2216 void Cursor::forceBufferUpdate() const
2218 disp_.forceBufferUpdate();
2222 void Cursor::clearBufferUpdate() const
2224 disp_.clearBufferUpdate();
2228 bool Cursor::needBufferUpdate() const
2230 return disp_.needBufferUpdate();
2234 void Cursor::noScreenUpdate() const
2236 disp_.screenUpdate(Update::None);
2240 Font Cursor::getFont() const
2242 // The logic here should more or less match to the Cursor::setCurrentFont
2243 // logic, i.e. the cursor height should give a hint what will happen
2244 // if a character is entered.
2246 // HACK. far from being perfect...
2248 CursorSlice const & sl = innerTextSlice();
2249 Text const & text = *sl.text();
2250 Paragraph const & par = text.getPar(sl.pit());
2252 // on boundary, so we are really at the character before
2253 pos_type pos = sl.pos();
2254 if (pos > 0 && boundary())
2257 // on space? Take the font before (only for RTL boundary stay)
2259 TextMetrics const & tm = bv().textMetrics(&text);
2260 if (pos == sl.lastpos()
2261 || (par.isSeparator(pos)
2262 && !tm.isRTLBoundary(sl.pit(), pos)))
2266 // get font at the position
2267 Font font = par.getFont(buffer()->params(), pos,
2268 text.outerFont(sl.pit()));
2274 bool Cursor::fixIfBroken()
2276 bool const broken_cursor = DocIterator::fixIfBroken();
2277 bool const broken_anchor = anchor_.fixIfBroken();
2279 if (broken_cursor || broken_anchor) {
2280 clearNewWordPosition();
2288 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2290 // find inset in common
2292 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2293 if (&old[i].inset() != &cur[i].inset())
2297 // update words if we just moved to another paragraph
2298 if (i == old.depth() && i == cur.depth()
2299 && !cur.buffer()->isClean()
2300 && cur.inTexted() && old.inTexted()
2301 && cur.pit() != old.pit()) {
2302 old.paragraph().updateWords();
2305 // notify everything on top of the common part in old cursor,
2306 // but stop if the inset claims the cursor to be invalid now
2307 for (size_type j = i; j < old.depth(); ++j) {
2308 Cursor inset_pos = old;
2309 inset_pos.cutOff(j);
2310 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2314 // notify everything on top of the common part in new cursor,
2315 // but stop if the inset claims the cursor to be invalid now
2316 for (; i < cur.depth(); ++i) {
2317 if (cur[i].inset().notifyCursorEnters(cur))
2325 void Cursor::setCurrentFont()
2327 CursorSlice const & cs = innerTextSlice();
2328 Paragraph const & par = cs.paragraph();
2329 pos_type cpit = cs.pit();
2330 pos_type cpos = cs.pos();
2331 Text const & ctext = *cs.text();
2332 TextMetrics const & tm = bv().textMetrics(&ctext);
2334 // are we behind previous char in fact? -> go to that char
2335 if (cpos > 0 && boundary())
2338 // find position to take the font from
2340 // paragraph end? -> font of last char
2341 if (cpos == lastpos())
2343 // on space? -> look at the words in front of space
2344 else if (cpos > 0 && par.isSeparator(cpos)) {
2345 // abc| def -> font of c
2346 // abc |[WERBEH], i.e. boundary==true -> font of c
2347 // abc [WERBEH]| def, font of the space
2348 if (!tm.isRTLBoundary(cpit, cpos))
2354 BufferParams const & bufparams = buffer()->params();
2355 current_font = par.getFontSettings(bufparams, cpos);
2356 real_current_font = tm.displayFont(cpit, cpos);
2358 // special case for paragraph end
2359 if (cs.pos() == lastpos()
2360 && tm.isRTLBoundary(cpit, cs.pos())
2362 Language const * lang = par.getParLanguage(bufparams);
2363 current_font.setLanguage(lang);
2364 current_font.fontInfo().setNumber(FONT_OFF);
2365 real_current_font.setLanguage(lang);
2366 real_current_font.fontInfo().setNumber(FONT_OFF);
2371 bool Cursor::textUndo()
2373 DocIterator dit = *this;
2374 // Undo::textUndo() will modify dit.
2375 if (!buffer()->undo().textUndo(dit))
2385 bool Cursor::textRedo()
2387 DocIterator dit = *this;
2388 // Undo::textRedo() will modify dit.
2389 if (!buffer()->undo().textRedo(dit))
2399 void Cursor::finishUndo() const
2401 buffer()->undo().finishUndo();
2405 void Cursor::beginUndoGroup() const
2407 buffer()->undo().beginUndoGroup();
2411 void Cursor::endUndoGroup() const
2413 buffer()->undo().endUndoGroup();
2417 void Cursor::recordUndo(UndoKind kind, pit_type from, pit_type to) const
2419 buffer()->undo().recordUndo(*this, kind, from, to);
2423 void Cursor::recordUndo(UndoKind kind, pit_type from) const
2425 buffer()->undo().recordUndo(*this, kind, from);
2429 void Cursor::recordUndo(UndoKind kind) const
2431 buffer()->undo().recordUndo(*this, kind);
2435 void Cursor::recordUndoInset(UndoKind kind, Inset const * inset) const
2437 buffer()->undo().recordUndoInset(*this, kind, inset);
2441 void Cursor::recordUndoFullDocument() const
2443 buffer()->undo().recordUndoFullDocument(*this);
2447 void Cursor::recordUndoSelection() const
2450 if (cap::multipleCellsSelected(*this))
2455 buffer()->undo().recordUndo(*this, ATOMIC_UNDO,
2456 selBegin().pit(), selEnd().pit());
2461 void Cursor::checkBufferStructure()
2463 Buffer const * master = buffer()->masterBuffer();
2464 master->tocBackend().updateItem(*this);
2465 if (master != buffer() && !master->hasGuiDelegate())
2466 // In case the master has no gui associated with it,
2467 // the TocItem is not updated (part of bug 5699).
2468 buffer()->tocBackend().updateItem(*this);