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"
29 #include "LyXAction.h"
30 #include "LyXFunc.h" // only for setMessage()
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 <boost/bind.hpp>
65 bool positionable(DocIterator const & cursor, DocIterator const & anchor)
67 // avoid deeper nested insets when selecting
68 if (cursor.depth() > anchor.depth())
71 // anchor might be deeper, should have same path then
72 for (size_t i = 0; i < cursor.depth(); ++i)
73 if (&cursor[i].inset() != &anchor[i].inset())
76 // position should be ok.
81 // Find position closest to (x, y) in cell given by iter.
82 // Used only in mathed
83 DocIterator bruteFind2(Cursor const & c, int x, int y)
85 double best_dist = numeric_limits<double>::max();
92 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
93 for (size_t i = 0;; ++i) {
96 Inset const * inset = &it.inset();
97 map<Inset const *, Geometry> const & data =
98 c.bv().coordCache().getInsets().getData();
99 map<Inset const *, Geometry>::const_iterator I = data.find(inset);
101 // FIXME: in the case where the inset is not in the cache, this
102 // means that no part of it is visible on screen. In this case
103 // we don't do elaborate search and we just return the forwarded
104 // DocIterator at its beginning.
105 if (I == data.end()) {
110 Point o = I->second.pos;
111 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
112 // Convert to absolute
115 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
116 // '<=' in order to take the last possible position
117 // this is important for clicking behind \sum in e.g. '\sum_i a'
118 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
119 << " best: " << best_dist);
120 if (d <= best_dist) {
133 /// moves position closest to (x, y) in given box
134 bool bruteFind(Cursor & cursor,
135 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
137 LASSERT(!cursor.empty(), return false);
138 Inset & inset = cursor[0].inset();
139 BufferView & bv = cursor.bv();
141 CoordCache::InnerParPosCache const & cache =
142 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
143 // Get an iterator on the first paragraph in the cache
144 DocIterator it(inset);
145 it.push_back(CursorSlice(inset));
146 it.pit() = cache.begin()->first;
147 // Get an iterator after the last paragraph in the cache
148 DocIterator et(inset);
149 et.push_back(CursorSlice(inset));
150 et.pit() = boost::prior(cache.end())->first;
151 if (et.pit() >= et.lastpit())
152 et = doc_iterator_end(inset);
156 double best_dist = numeric_limits<double>::max();;
157 DocIterator best_cursor = et;
159 for ( ; it != et; it.forwardPos(true)) {
160 // avoid invalid nesting when selecting
161 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
162 Point p = bv.getPos(it, false);
165 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
166 double const dx = xo - x;
167 double const dy = yo - y;
168 double const d = dx * dx + dy * dy;
169 // '<=' in order to take the last possible position
170 // this is important for clicking behind \sum in e.g. '\sum_i a'
171 if (d <= best_dist) {
172 // lyxerr << "*" << endl;
180 if (best_cursor != et) {
181 cursor.setCursor(best_cursor);
190 /// moves position closest to (x, y) in given box
191 bool bruteFind3(Cursor & cur, int x, int y, bool up)
193 BufferView & bv = cur.bv();
194 int ylow = up ? 0 : y + 1;
195 int yhigh = up ? y - 1 : bv.workHeight();
197 int xhigh = bv.workWidth();
199 // FIXME: bit more work needed to get 'from' and 'to' right.
200 pit_type from = cur.bottom().pit();
201 //pit_type to = cur.bottom().pit();
202 //lyxerr << "Pit start: " << from << endl;
204 //lyxerr << "bruteFind3: x: " << x << " y: " << y
205 // << " xlow: " << xlow << " xhigh: " << xhigh
206 // << " ylow: " << ylow << " yhigh: " << yhigh
208 DocIterator it = doc_iterator_begin(cur.buffer());
210 DocIterator et = doc_iterator_end(cur.buffer());
212 double best_dist = numeric_limits<double>::max();
213 DocIterator best_cursor = et;
215 for ( ; it != et; it.forwardPos()) {
216 // avoid invalid nesting when selecting
217 if (bv.cursorStatus(it) == CUR_INSIDE
218 && (!cur.selection() || positionable(it, cur.anchor_))) {
219 Point p = bv.getPos(it, false);
222 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
223 double const dx = xo - x;
224 double const dy = yo - y;
225 double const d = dx * dx + dy * dy;
226 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
227 // << " dx: " << dx << " dy: " << dy
228 // << " idx: " << it.idx() << " pos: " << it.pos()
231 // '<=' in order to take the last possible position
232 // this is important for clicking behind \sum in e.g. '\sum_i a'
233 if (d <= best_dist) {
234 //lyxerr << "*" << endl;
242 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
243 if (best_cursor == et)
245 cur.setCursor(best_cursor);
252 // be careful: this is called from the bv's constructor, too, so
253 // bv functions are not yet available!
254 Cursor::Cursor(BufferView & bv)
255 : DocIterator(&bv.buffer()), bv_(&bv), anchor_(),
256 x_target_(-1), textTargetOffset_(0),
257 selection_(false), mark_(false), logicalpos_(false),
258 current_font(inherit_font)
265 push_back(CursorSlice(buffer()->inset()));
266 anchor_ = doc_iterator_begin(buffer());
274 // this (intentionally) does neither touch anchor nor selection status
275 void Cursor::setCursor(DocIterator const & cur)
277 DocIterator::operator=(cur);
281 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
285 // Try to fix cursor in case it is broken.
288 // Is this a function that acts on inset at point?
289 Inset * inset = cur.nextInset();
290 if (lyxaction.funcHasFlag(cmd.action, LyXAction::AtPoint)
291 && inset && inset->getStatus(cur, cmd, status))
294 // This is, of course, a mess. Better create a new doc iterator and use
295 // this in Inset::getStatus. This might require an additional
296 // BufferView * arg, though (which should be avoided)
297 //Cursor safe = *this;
299 for ( ; cur.depth(); cur.pop()) {
300 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
301 LASSERT(cur.idx() <= cur.lastidx(), /**/);
302 LASSERT(cur.pit() <= cur.lastpit(), /**/);
303 LASSERT(cur.pos() <= cur.lastpos(), /**/);
305 // The inset's getStatus() will return 'true' if it made
306 // a definitive decision on whether it want to handle the
307 // request or not. The result of this decision is put into
308 // the 'status' parameter.
309 if (cur.inset().getStatus(cur, cmd, status)) {
318 void Cursor::dispatch(FuncRequest const & cmd0)
320 LYXERR(Debug::DEBUG, "cmd: " << cmd0 << '\n' << *this);
325 FuncRequest cmd = cmd0;
328 buffer()->undo().beginUndoGroup();
330 // Is this a function that acts on inset at point?
331 if (lyxaction.funcHasFlag(cmd.action, LyXAction::AtPoint)
333 result().dispatched(true);
334 result().update(Update::FitCursor | Update::Force);
335 FuncRequest tmpcmd = cmd;
336 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
337 << cmd0 << endl << *this);
338 nextInset()->dispatch(*this, tmpcmd);
339 if (result().dispatched())
343 // store some values to be used inside of the handlers
344 beforeDispatchCursor_ = *this;
345 for (; depth(); pop(), boundary(false)) {
346 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
347 << cmd0 << endl << *this);
348 LASSERT(pos() <= lastpos(), /**/);
349 LASSERT(idx() <= lastidx(), /**/);
350 LASSERT(pit() <= lastpit(), /**/);
352 // The common case is 'LFUN handled, need update', so make the
353 // LFUN handler's life easier by assuming this as default value.
354 // The handler can reset the update and val flags if necessary.
355 disp_.update(Update::FitCursor | Update::Force);
356 disp_.dispatched(true);
357 inset().dispatch(*this, cmd);
358 if (disp_.dispatched())
362 // it completely to get a 'bomb early' behaviour in case this
363 // object will be used again.
364 if (!disp_.dispatched()) {
365 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
366 // We might have invalidated the cursor when removing an empty
367 // paragraph while the cursor could not be moved out the inset
368 // while we initially thought we could. This might happen when
369 // a multiline inset becomes an inline inset when the second
370 // paragraph is removed.
371 if (safe.pit() > safe.lastpit()) {
372 safe.pit() = safe.lastpit();
373 safe.pos() = safe.lastpos();
376 disp_.update(Update::None);
377 disp_.dispatched(false);
379 // restore the previous one because nested Cursor::dispatch calls
380 // are possible which would change it
381 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
383 buffer()->undo().endUndoGroup();
387 DispatchResult Cursor::result() const
393 BufferView & Cursor::bv() const
402 LASSERT(depth() >= 1, /**/);
407 void Cursor::push(Inset & p)
409 push_back(CursorSlice(p));
410 p.setBuffer(*buffer());
414 void Cursor::pushBackward(Inset & p)
416 LASSERT(!empty(), return);
417 //lyxerr << "Entering inset " << t << " front" << endl;
423 bool Cursor::popBackward()
425 LASSERT(!empty(), return false);
433 bool Cursor::popForward()
435 LASSERT(!empty(), return false);
436 //lyxerr << "Leaving inset from in back" << endl;
437 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
441 pos() += lastpos() - lp + 1;
446 int Cursor::currentMode()
448 LASSERT(!empty(), /**/);
449 for (int i = depth() - 1; i >= 0; --i) {
450 int res = operator[](i).inset().currentMode();
451 bool locked_mode = operator[](i).inset().lockedMode();
452 // Also return UNDECIDED_MODE when the mode is locked,
453 // as in this case it is treated the same as TEXT_MODE
454 if (res != Inset::UNDECIDED_MODE || locked_mode)
457 return Inset::TEXT_MODE;
461 void Cursor::getPos(int & x, int & y) const
463 Point p = bv().getPos(*this, boundary());
469 Row const & Cursor::textRow() const
471 CursorSlice const & cs = innerTextSlice();
472 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
473 LASSERT(!pm.rows().empty(), /**/);
474 return pm.getRow(pos(), boundary());
478 void Cursor::resetAnchor()
484 void Cursor::setCursorToAnchor()
491 bool Cursor::posBackward()
500 bool Cursor::posForward()
502 if (pos() == lastpos())
509 bool Cursor::posVisRight(bool skip_inset)
511 Cursor new_cur = *this; // where we will move to
512 pos_type left_pos; // position visually left of current cursor
513 pos_type right_pos; // position visually right of current cursor
514 bool new_pos_is_RTL; // is new position we're moving to RTL?
516 getSurroundingPos(left_pos, right_pos);
518 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
520 // Are we at an inset?
521 new_cur.pos() = right_pos;
522 new_cur.boundary(false);
524 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
525 // we actually move the cursor at the end of this function, for now
526 // we just keep track of the new position in new_cur...
527 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
530 // Are we already at rightmost pos in row?
531 else if (text()->empty() || right_pos == -1) {
534 if (!new_cur.posVisToNewRow(false)) {
535 LYXERR(Debug::RTL, "not moving!");
539 // we actually move the cursor at the end of this function, for now
540 // just keep track of the new position in new_cur...
541 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
542 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
545 // normal movement to the right
548 // Recall, if the cursor is at position 'x', that means *before*
549 // the character at position 'x'. In RTL, "before" means "to the
550 // right of", in LTR, "to the left of". So currently our situation
551 // is this: the position to our right is 'right_pos' (i.e., we're
552 // currently to the left of 'right_pos'). In order to move to the
553 // right, it depends whether or not the character at 'right_pos' is RTL.
554 new_pos_is_RTL = paragraph().getFontSettings(
555 buffer()->params(), right_pos).isVisibleRightToLeft();
556 // If the character at 'right_pos' *is* LTR, then in order to move to
557 // the right of it, we need to be *after* 'right_pos', i.e., move to
558 // position 'right_pos' + 1.
559 if (!new_pos_is_RTL) {
560 new_cur.pos() = right_pos + 1;
561 // set the boundary to true in two situations:
563 // 1. if new_pos is now lastpos, and we're in an RTL paragraph
564 // (this means that we're moving right to the end of an LTR chunk
565 // which is at the end of an RTL paragraph);
566 (new_cur.pos() == lastpos()
567 && paragraph().isRTL(buffer()->params()))
568 // 2. if the position *after* right_pos is RTL (we want to be
569 // *after* right_pos, not before right_pos + 1!)
570 || paragraph().getFontSettings(buffer()->params(),
571 new_cur.pos()).isVisibleRightToLeft()
573 new_cur.boundary(true);
574 else // set the boundary to false
575 new_cur.boundary(false);
577 // Otherwise (if the character at position 'right_pos' is RTL), then
578 // moving to the right of it is as easy as setting the new position
581 new_cur.pos() = right_pos;
582 new_cur.boundary(false);
587 bool moved = (new_cur.pos() != pos()
588 || new_cur.pit() != pit()
589 || new_cur.boundary() != boundary()
590 || &new_cur.inset() != &inset());
593 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
594 << (new_cur.boundary() ? " (boundary)" : ""));
602 bool Cursor::posVisLeft(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() = left_pos;
615 new_cur.boundary(false);
617 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
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 leftmost pos in row?
624 else if (text()->empty() || left_pos == -1) {
627 if (!new_cur.posVisToNewRow(true)) {
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, "left edge, moving: " << int(new_cur.pit()) << ","
635 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
638 // normal movement to the left
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 left is 'left_pos' (i.e., we're
645 // currently to the right of 'left_pos'). In order to move to the
646 // left, it depends whether or not the character at 'left_pos' is RTL.
647 new_pos_is_RTL = paragraph().getFontSettings(
648 buffer()->params(), left_pos).isVisibleRightToLeft();
649 // If the character at 'left_pos' *is* RTL, then in order to move to
650 // the left of it, we need to be *after* 'left_pos', i.e., move to
651 // position 'left_pos' + 1.
652 if (new_pos_is_RTL) {
653 new_cur.pos() = left_pos + 1;
654 // set the boundary to true in two situations:
656 // 1. if new_pos is now lastpos and we're in an LTR paragraph
657 // (this means that we're moving left to the end of an RTL chunk
658 // which is at the end of an LTR paragraph);
659 (new_cur.pos() == lastpos()
660 && !paragraph().isRTL(buffer()->params()))
661 // 2. if the position *after* left_pos is not RTL (we want to be
662 // *after* left_pos, not before left_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 'left_pos' is LTR), then
671 // moving to the left of it is as easy as setting the new position
674 new_cur.pos() = left_pos;
675 new_cur.boundary(false);
680 bool moved = (new_cur.pos() != pos()
681 || new_cur.pit() != pit()
682 || new_cur.boundary() != boundary());
685 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
686 << (new_cur.boundary() ? " (boundary)" : ""));
694 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
696 // preparing bidi tables
697 Paragraph const & par = paragraph();
698 Buffer const & buf = *buffer();
699 Row const & row = textRow();
701 bidi.computeTables(par, buf, row);
703 LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
705 // The cursor is painted *before* the character at pos(), or, if 'boundary'
706 // is true, *after* the character at (pos() - 1). So we already have one
707 // known position around the cursor:
708 pos_type const known_pos = boundary() && pos() > 0 ? pos() - 1 : pos();
710 // edge case: if we're at the end of the paragraph, things are a little
711 // different (because lastpos is a position which does not really "exist"
712 // --- there's no character there yet).
713 if (known_pos == lastpos()) {
714 if (par.isRTL(buf.params())) {
716 right_pos = bidi.vis2log(row.pos());
720 left_pos = bidi.vis2log(row.endpos() - 1);
725 // Whether 'known_pos' is to the left or to the right of the cursor depends
726 // on whether it is an RTL or LTR character...
727 bool const cur_is_RTL =
728 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
729 // ... in the following manner:
730 // For an RTL character, "before" means "to the right" and "after" means
731 // "to the left"; and for LTR, it's the reverse. So, 'known_pos' is to the
732 // right of the cursor if (RTL && boundary) or (!RTL && !boundary):
733 bool const known_pos_on_right = cur_is_RTL == boundary();
735 // So we now know one of the positions surrounding the cursor. Let's
736 // determine the other one:
737 if (known_pos_on_right) {
738 right_pos = known_pos;
739 // *visual* position of 'left_pos':
740 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
741 // If the position we just identified as 'left_pos' is a "skipped
742 // separator" (a separator which is at the logical end of a row,
743 // except for the last row in a paragraph; such separators are not
744 // painted, so they "are not really there"; note that in bidi text,
745 // such a separator could appear visually in the middle of a row),
746 // set 'left_pos' to the *next* position to the left.
747 if (bidi.inRange(v_left_pos)
748 && bidi.vis2log(v_left_pos) + 1 == row.endpos()
749 && row.endpos() < lastpos()
750 && par.isSeparator(bidi.vis2log(v_left_pos)))
753 // calculate the logical position of 'left_pos', if in row
754 if (!bidi.inRange(v_left_pos))
757 left_pos = bidi.vis2log(v_left_pos);
758 // If the position we identified as 'right_pos' is a "skipped
759 // separator", set 'right_pos' to the *next* position to the right.
760 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos()
761 && par.isSeparator(right_pos)) {
762 pos_type const v_right_pos = bidi.log2vis(right_pos) + 1;
763 if (!bidi.inRange(v_right_pos))
766 right_pos = bidi.vis2log(v_right_pos);
769 // known_pos is on the left
770 left_pos = known_pos;
771 // *visual* position of 'right_pos'
772 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
773 // If the position we just identified as 'right_pos' is a "skipped
774 // separator", set 'right_pos' to the *next* position to the right.
775 if (bidi.inRange(v_right_pos)
776 && bidi.vis2log(v_right_pos) + 1 == row.endpos()
777 && row.endpos() < lastpos()
778 && par.isSeparator(bidi.vis2log(v_right_pos)))
781 // calculate the logical position of 'right_pos', if in row
782 if (!bidi.inRange(v_right_pos))
785 right_pos = bidi.vis2log(v_right_pos);
786 // If the position we identified as 'left_pos' is a "skipped
787 // separator", set 'left_pos' to the *next* position to the left.
788 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos()
789 && par.isSeparator(left_pos)) {
790 pos_type const v_left_pos = bidi.log2vis(left_pos) - 1;
791 if (!bidi.inRange(v_left_pos))
794 left_pos = bidi.vis2log(v_left_pos);
801 bool Cursor::posVisToNewRow(bool movingLeft)
803 Paragraph const & par = paragraph();
804 Buffer const & buf = *buffer();
805 Row const & row = textRow();
806 bool par_is_LTR = !par.isRTL(buf.params());
808 // Inside a table, determining whether to move to the next or previous row
809 // should be done based on the table's direction.
811 if (s >= 1 && (*this)[s].inset().asInsetTabular()) {
812 par_is_LTR = !(*this)[s].inset().asInsetTabular()->isRightToLeft(*this);
813 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
816 // if moving left in an LTR paragraph or moving right in an RTL one,
817 // move to previous row
818 if (par_is_LTR == movingLeft) {
819 if (row.pos() == 0) { // we're at first row in paragraph
820 if (pit() == 0) // no previous paragraph! don't move
822 // move to last pos in previous par
826 } else { // move to previous row in this par
827 pos() = row.pos() - 1; // this is guaranteed to be in previous row
831 // if moving left in an RTL paragraph or moving right in an LTR one,
834 if (row.endpos() == lastpos()) { // we're at last row in paragraph
835 if (pit() == lastpit()) // last paragraph! don't move
837 // move to first row in next par
841 } else { // move to next row in this par
842 pos() = row.endpos();
847 // make sure we're at left-/right-most pos in new row
848 posVisToRowExtremity(!movingLeft);
854 void Cursor::posVisToRowExtremity(bool left)
856 // prepare bidi tables
857 Paragraph const & par = paragraph();
858 Buffer const & buf = *buffer();
859 Row const & row = textRow();
861 bidi.computeTables(par, buf, row);
863 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
864 << (boundary() ? 1 : 0));
866 if (left) { // move to leftmost position
867 // if this is an RTL paragraph, and we're at the last row in the
868 // paragraph, move to lastpos
869 if (par.isRTL(buf.params()) && row.endpos() == lastpos())
872 pos() = bidi.vis2log(row.pos());
874 // Moving to the leftmost position in the row, the cursor should
875 // normally be placed to the *left* of the leftmost position.
876 // A very common exception, though, is if the leftmost character
877 // also happens to be the separator at the (logical) end of the row
878 // --- in this case, the separator is positioned beyond the left
879 // margin, and we don't want to move the cursor there (moving to
880 // the left of the separator is equivalent to moving to the next
881 // line). So, in this case we actually want to place the cursor
882 // to the *right* of the leftmost position (the separator).
883 // Another exception is if we're moving to the logically last
884 // position in the row, which is *not* a separator: this means
885 // that the entire row has no separators (if there were any, the
886 // row would have been broken there); and therefore in this case
887 // we also move to the *right* of the last position (this indicates
888 // to the user that there is no space after this position, and is
889 // consistent with the behavior in the middle of a row --- moving
890 // right or left moves to the next/previous character; if we were
891 // to move to the *left* of this position, that would simulate
892 // a separator which is not really there!).
893 // Finally, there is an exception to the previous exception: if
894 // this non-separator-but-last-position-in-row is an inset, then
895 // we *do* want to stay to the left of it anyway: this is the
896 // "boundary" which we simulate at insets.
897 // Another exception is when row.endpos() is 0.
899 // do we want to be to the right of pos?
900 // as explained above, if at last pos in row, stay to the right
901 bool const right_of_pos = row.endpos() > 0
902 && pos() == row.endpos() - 1 && !par.isInset(pos());
904 // Now we know if we want to be to the left or to the right of pos,
905 // let's make sure we are where we want to be.
906 bool const new_pos_is_RTL =
907 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
909 if (new_pos_is_RTL != right_of_pos) {
915 // move to rightmost position
916 // if this is an LTR paragraph, and we're at the last row in the
917 // paragraph, move to lastpos
918 if (!par.isRTL(buf.params()) && row.endpos() == lastpos())
921 pos() = row.endpos() > 0 ? bidi.vis2log(row.endpos() - 1) : 0;
923 // Moving to the rightmost position in the row, the cursor should
924 // normally be placed to the *right* of the rightmost position.
925 // A very common exception, though, is if the rightmost character
926 // also happens to be the separator at the (logical) end of the row
927 // --- in this case, the separator is positioned beyond the right
928 // margin, and we don't want to move the cursor there (moving to
929 // the right of the separator is equivalent to moving to the next
930 // line). So, in this case we actually want to place the cursor
931 // to the *left* of the rightmost position (the separator).
932 // Another exception is if we're moving to the logically last
933 // position in the row, which is *not* a separator: this means
934 // that the entire row has no separators (if there were any, the
935 // row would have been broken there); and therefore in this case
936 // we also move to the *left* of the last position (this indicates
937 // to the user that there is no space after this position, and is
938 // consistent with the behavior in the middle of a row --- moving
939 // right or left moves to the next/previous character; if we were
940 // to move to the *right* of this position, that would simulate
941 // a separator which is not really there!).
942 // Finally, there is an exception to the previous exception: if
943 // this non-separator-but-last-position-in-row is an inset, then
944 // we *do* want to stay to the right of it anyway: this is the
945 // "boundary" which we simulate at insets.
946 // Another exception is when row.endpos() is 0.
948 // do we want to be to the left of pos?
949 // as explained above, if at last pos in row, stay to the left,
950 // unless the last position is the same as the first.
951 bool const left_of_pos = row.endpos() > 0
952 && pos() == row.endpos() - 1 && !par.isInset(pos());
954 // Now we know if we want to be to the left or to the right of pos,
955 // let's make sure we are where we want to be.
956 bool const new_pos_is_RTL =
957 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
959 if (new_pos_is_RTL == left_of_pos) {
965 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
966 << (boundary() ? 1 : 0));
970 CursorSlice Cursor::anchor() const
974 LASSERT(anchor_.depth() >= depth(), /**/);
975 CursorSlice normal = anchor_[depth() - 1];
976 if (depth() < anchor_.depth() && top() <= normal) {
977 // anchor is behind cursor -> move anchor behind the inset
984 CursorSlice Cursor::selBegin() const
988 return anchor() < top() ? anchor() : top();
992 CursorSlice Cursor::selEnd() const
996 return anchor() > top() ? anchor() : top();
1000 DocIterator Cursor::selectionBegin() const
1006 // FIXME: This is a work-around for the problem that
1007 // CursorSlice doesn't keep track of the boundary.
1008 if (anchor() == top())
1009 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1011 di = anchor() < top() ? anchor_ : *this;
1017 DocIterator Cursor::selectionEnd() const
1023 // FIXME: This is a work-around for the problem that
1024 // CursorSlice doesn't keep track of the boundary.
1025 if (anchor() == top())
1026 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1028 di = anchor() > top() ? anchor_ : *this;
1030 if (di.depth() > depth()) {
1038 void Cursor::setSelection()
1041 // A selection with no contents is not a selection
1042 // FIXME: doesnt look ok
1043 if (idx() == anchor().idx() &&
1044 pit() == anchor().pit() &&
1045 pos() == anchor().pos())
1046 setSelection(false);
1050 void Cursor::setSelection(DocIterator const & where, int n)
1059 void Cursor::clearSelection()
1061 setSelection(false);
1067 void Cursor::setTargetX(int x)
1070 textTargetOffset_ = 0;
1074 int Cursor::x_target() const
1080 void Cursor::clearTargetX()
1083 textTargetOffset_ = 0;
1087 void Cursor::updateTextTargetOffset()
1092 textTargetOffset_ = x - x_target_;
1096 void Cursor::info(odocstream & os) const
1098 for (int i = 1, n = depth(); i < n; ++i) {
1099 operator[](i).inset().infoize(os);
1103 Inset const * inset = prevInset();
1104 // prevInset() can return 0 in certain case.
1106 prevInset()->infoize2(os);
1108 // overwite old message
1113 bool Cursor::selHandle(bool sel)
1115 //lyxerr << "Cursor::selHandle" << endl;
1118 if (sel == selection())
1122 cap::saveSelection(*this);
1130 ostream & operator<<(ostream & os, Cursor const & cur)
1132 os << "\n cursor: | anchor:\n";
1133 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
1134 os << " " << cur[i] << " | ";
1135 if (i < cur.anchor_.depth())
1136 os << cur.anchor_[i];
1138 os << "-------------------------------";
1141 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
1142 os << "------------------------------- | " << cur.anchor_[i] << "\n";
1144 os << " selection: " << cur.selection_
1145 << " x_target: " << cur.x_target_ << endl;
1150 LyXErr & operator<<(LyXErr & os, Cursor const & cur)
1160 ///////////////////////////////////////////////////////////////////
1163 // The part below is the non-integrated rest of the original math
1164 // cursor. This should be either generalized for texted or moved
1165 // back to mathed (in most cases to InsetMathNest).
1167 ///////////////////////////////////////////////////////////////////
1169 #include "mathed/InsetMathChar.h"
1170 #include "mathed/InsetMathGrid.h"
1171 #include "mathed/InsetMathScript.h"
1172 #include "mathed/InsetMathUnknown.h"
1173 #include "mathed/MathFactory.h"
1174 #include "mathed/MathStream.h"
1175 #include "mathed/MathSupport.h"
1180 //#define FILEDEBUG 1
1183 bool Cursor::isInside(Inset const * p) const
1185 for (size_t i = 0; i != depth(); ++i)
1186 if (&operator[](i).inset() == p)
1192 void Cursor::leaveInset(Inset const & inset)
1194 for (size_t i = 0; i != depth(); ++i) {
1195 if (&operator[](i).inset() == &inset) {
1203 bool Cursor::openable(MathAtom const & t) const
1214 // we can't move into anything new during selection
1215 if (depth() >= anchor_.depth())
1217 if (t.nucleus() != &anchor_[depth()].inset())
1224 void Cursor::setScreenPos(int x, int /*y*/)
1227 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1232 void Cursor::plainErase()
1234 cell().erase(pos());
1238 void Cursor::markInsert()
1240 insert(char_type(0));
1244 void Cursor::markErase()
1246 cell().erase(pos());
1250 void Cursor::plainInsert(MathAtom const & t)
1252 cell().insert(pos(), t);
1254 inset().setBuffer(bv_->buffer());
1259 void Cursor::insert(docstring const & str)
1261 for_each(str.begin(), str.end(),
1262 boost::bind(static_cast<void(Cursor::*)(char_type)>
1263 (&Cursor::insert), this, _1));
1267 void Cursor::insert(char_type c)
1269 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1270 LASSERT(!empty(), /**/);
1272 cap::selClearOrDel(*this);
1273 insert(new InsetMathChar(c));
1275 text()->insertChar(*this, c);
1280 void Cursor::insert(MathAtom const & t)
1282 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1284 cap::selClearOrDel(*this);
1289 void Cursor::insert(Inset * inset0)
1291 LASSERT(inset0, /**/);
1293 insert(MathAtom(inset0));
1295 text()->insertInset(*this, inset0);
1296 inset0->setBuffer(bv_->buffer());
1302 void Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1304 MathData ar(buffer());
1306 if (ar.size() == 1 && (enter || selection()))
1313 void Cursor::niceInsert(MathAtom const & t)
1316 docstring const safe = cap::grabAndEraseSelection(*this);
1318 // If possible, enter the new inset and move the contents of the selection
1319 if (t->isActive()) {
1321 // be careful here: don't use 'pushBackward(t)' as this we need to
1322 // push the clone, not the original
1323 pushBackward(*nextInset());
1324 // We may not use niceInsert here (recursion)
1325 MathData ar(buffer());
1332 void Cursor::insert(MathData const & ar)
1336 cap::eraseSelection(*this);
1337 cell().insert(pos(), ar);
1342 bool Cursor::backspace()
1344 autocorrect() = false;
1347 cap::eraseSelection(*this);
1352 // If empty cell, and not part of a big cell
1353 if (lastpos() == 0 && inset().nargs() == 1) {
1355 // Directly delete empty cell: [|[]] => [|]
1361 // [|], can not delete from inside
1372 if (inMacroMode()) {
1373 InsetMathUnknown * p = activeMacro();
1374 if (p->name().size() > 1) {
1375 p->setName(p->name().substr(0, p->name().size() - 1));
1380 if (pos() != 0 && prevAtom()->nargs() > 0) {
1381 // let's require two backspaces for 'big stuff' and
1382 // highlight on the first
1394 bool Cursor::erase()
1396 autocorrect() = false;
1401 cap::eraseSelection(*this);
1405 // delete empty cells if possible
1406 if (pos() == lastpos() && inset().idxDelete(idx()))
1409 // special behaviour when in last position of cell
1410 if (pos() == lastpos()) {
1411 bool one_cell = inset().nargs() == 1;
1412 if (one_cell && lastpos() == 0) {
1414 // Directly delete empty cell: [|[]] => [|]
1420 // [|], can not delete from inside
1425 inset().idxGlue(idx());
1429 // 'clever' UI hack: only erase large items if previously slected
1430 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1445 DocIterator save = *this;
1446 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1447 this->dispatch(cmd);
1448 if (disp_.dispatched())
1451 autocorrect() = false;
1459 DocIterator save = *this;
1460 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1461 this->dispatch(cmd);
1462 if (disp_.dispatched())
1465 autocorrect() = false;
1470 bool Cursor::macroModeClose()
1474 InsetMathUnknown * p = activeMacro();
1476 MathData selection(buffer());
1477 asArray(p->selection(), selection);
1478 docstring const s = p->name();
1480 cell().erase(pos());
1482 // do nothing if the macro name is empty
1486 // trigger updates of macros, at least, if no full
1487 // updates take place anyway
1488 updateFlags(Update::Force);
1490 docstring const name = s.substr(1);
1491 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1492 if (in && in->interpretString(*this, s))
1494 MathAtom atom = buffer()->getMacro(name, *this, false) ?
1495 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1497 // try to put argument into macro, if we just inserted a macro
1498 bool macroArg = false;
1499 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1501 // macros here are still unfolded (in init mode in fact). So
1502 // we have to resolve the macro here manually and check its arity
1503 // to put the selection behind it if arity > 0.
1504 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1505 if (selection.size() > 0 && data && data->numargs() - data->optionals() > 0) {
1507 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1509 // non-greedy case. Do not touch the arguments behind
1510 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1513 // insert remembered selection into first argument of a non-macro
1514 else if (atom.nucleus()->nargs() > 0)
1515 atom.nucleus()->cell(0).append(selection);
1519 // finally put the macro argument behind, if needed
1521 if (selection.size() > 1 || selection[0]->asScriptInset())
1522 plainInsert(MathAtom(new InsetMathBrace(selection)));
1531 docstring Cursor::macroName()
1533 return inMacroMode() ? activeMacro()->name() : docstring();
1537 void Cursor::handleNest(MathAtom const & a, int c)
1539 //lyxerr << "Cursor::handleNest: " << c << endl;
1541 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1544 pushBackward(*nextInset());
1548 int Cursor::targetX() const
1550 if (x_target() != -1)
1559 int Cursor::textTargetOffset() const
1561 return textTargetOffset_;
1565 void Cursor::setTargetX()
1574 bool Cursor::inMacroMode() const
1580 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1581 return p && !p->final();
1585 InsetMathUnknown * Cursor::activeMacro()
1587 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1591 InsetMathUnknown const * Cursor::activeMacro() const
1593 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1597 void Cursor::pullArg()
1600 MathData ar = cell();
1601 if (popBackward() && inMathed()) {
1603 cell().insert(pos(), ar);
1606 //formula()->mutateToText();
1611 void Cursor::touch()
1615 DocIterator::const_iterator it = begin();
1616 DocIterator::const_iterator et = end();
1617 for ( ; it != et; ++it)
1623 void Cursor::normalize()
1625 if (idx() > lastidx()) {
1626 lyxerr << "this should not really happen - 1: "
1627 << idx() << ' ' << nargs()
1628 << " in: " << &inset() << endl;
1632 if (pos() > lastpos()) {
1633 lyxerr << "this should not really happen - 2: "
1634 << pos() << ' ' << lastpos() << " in idx: " << idx()
1636 odocstringstream os;
1637 WriteStream wi(os, false, true, WriteStream::wsDefault);
1638 inset().asInsetMath()->write(wi);
1639 lyxerr << to_utf8(os.str()) << endl;
1645 bool Cursor::upDownInMath(bool up)
1647 // Be warned: The 'logic' implemented in this function is highly
1648 // fragile. A distance of one pixel or a '<' vs '<=' _really
1649 // matters. So fiddle around with it only if you think you know
1650 // what you are doing!
1654 xo = theLyXFunc().cursorBeforeDispatchX();
1656 // check if we had something else in mind, if not, this is the future
1658 if (x_target_ == -1)
1660 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1661 // In text mode inside the line (not left or right) possibly set a new target_x,
1662 // but only if we are somewhere else than the previous target-offset.
1664 // We want to keep the x-target on subsequent up/down movements
1665 // that cross beyond the end of short lines. Thus a special
1666 // handling when the cursor is at the end of line: Use the new
1667 // x-target only if the old one was before the end of line
1668 // or the old one was after the beginning of the line
1669 bool inRTL = isWithinRtlParagraph(*this);
1673 left = pos() == textRow().endpos();
1674 right = pos() == textRow().pos();
1676 left = pos() == textRow().pos();
1677 right = pos() == textRow().endpos();
1679 if ((!left && !right) ||
1680 (left && !right && xo < x_target_) ||
1681 (!left && right && x_target_ < xo))
1688 // try neigbouring script insets
1690 if (inMathed() && !selection()) {
1693 InsetMathScript const * p = prevAtom()->asScriptInset();
1694 if (p && p->has(up)) {
1696 push(*const_cast<InsetMathScript*>(p));
1697 idx() = p->idxOfScript(up);
1700 // we went in the right direction? Otherwise don't jump into the script
1704 int oy = theLyXFunc().cursorBeforeDispatchY();
1705 if ((!up && y <= oy) ||
1714 if (pos() != lastpos()) {
1715 InsetMathScript const * p = nextAtom()->asScriptInset();
1716 if (p && p->has(up)) {
1717 push(*const_cast<InsetMathScript*>(p));
1718 idx() = p->idxOfScript(up);
1721 // we went in the right direction? Otherwise don't jump into the script
1725 int oy = theLyXFunc().cursorBeforeDispatchY();
1726 if ((!up && y <= oy) ||
1735 // try to find an inset that knows better then we,
1736 if (inset().idxUpDown(*this, up)) {
1737 //lyxerr << "idxUpDown triggered" << endl;
1738 // try to find best position within this inset
1740 setCursor(bruteFind2(*this, xo, yo));
1744 // any improvement going just out of inset?
1745 if (popBackward() && inMathed()) {
1746 //lyxerr << "updown: popBackward succeeded" << endl;
1749 int yold = theLyXFunc().cursorBeforeDispatchY();
1751 if (up ? ynew < yold : ynew > yold)
1755 // no success, we are probably at the document top or bottom
1761 bool Cursor::atFirstOrLastRow(bool up)
1763 TextMetrics const & tm = bv_->textMetrics(text());
1764 ParagraphMetrics const & pm = tm.parMetrics(pit());
1767 if (pos() && boundary())
1768 row = pm.pos2row(pos() - 1);
1770 row = pm.pos2row(pos());
1773 if (pit() == 0 && row == 0)
1776 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1777 row + 1 >= int(pm.rows().size()))
1783 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1785 LASSERT(text(), /**/);
1791 xo = theLyXFunc().cursorBeforeDispatchX();
1793 // update the targetX - this is here before the "return false"
1794 // to set a new target which can be used by InsetTexts above
1795 // if we cannot move up/down inside this inset anymore
1796 if (x_target_ == -1)
1798 else if (xo - textTargetOffset() != x_target() &&
1799 depth() == beforeDispatchCursor_.depth()) {
1800 // In text mode inside the line (not left or right) possibly set a new target_x,
1801 // but only if we are somewhere else than the previous target-offset.
1803 // We want to keep the x-target on subsequent up/down movements
1804 // that cross beyond the end of short lines. Thus a special
1805 // handling when the cursor is at the end of line: Use the new
1806 // x-target only if the old one was before the end of line
1807 // or the old one was after the beginning of the line
1808 bool inRTL = isWithinRtlParagraph(*this);
1812 left = pos() == textRow().endpos();
1813 right = pos() == textRow().pos();
1815 left = pos() == textRow().pos();
1816 right = pos() == textRow().endpos();
1818 if ((!left && !right) ||
1819 (left && !right && xo < x_target_) ||
1820 (!left && right && x_target_ < xo))
1827 // first get the current line
1828 TextMetrics & tm = bv_->textMetrics(text());
1829 ParagraphMetrics const & pm = tm.parMetrics(pit());
1831 if (pos() && boundary())
1832 row = pm.pos2row(pos() - 1);
1834 row = pm.pos2row(pos());
1836 if (atFirstOrLastRow(up)) {
1837 // Is there a place for the cursor to go ? If yes, we
1838 // can execute the DEPM, otherwise we should keep the
1839 // paragraph to host the cursor.
1840 Cursor dummy = *this;
1841 bool valid_destination = false;
1842 for(; dummy.depth(); dummy.pop())
1843 if (!dummy.atFirstOrLastRow(up)) {
1844 valid_destination = true;
1848 // will a next dispatch follow and if there is a new
1849 // dispatch will it move the cursor out ?
1850 if (depth() > 1 && valid_destination) {
1851 // The cursor hasn't changed yet. This happens when
1852 // you e.g. move out of an inset. And to give the
1853 // DEPM the possibility of doing something we must
1854 // provide it with two different cursors. (Lgb, vfr)
1856 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1857 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1859 updateNeeded |= bv().checkDepm(dummy, *this);
1860 updateTextTargetOffset();
1865 // with and without selection are handled differently
1867 int yo = bv().getPos(*this, boundary()).y_;
1869 // To next/previous row
1871 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1873 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1876 // This happens when you move out of an inset.
1877 // And to give the DEPM the possibility of doing
1878 // something we must provide it with two different
1880 Cursor dummy = *this;
1883 if (bv().checkDepm(dummy, old)) {
1884 updateNeeded = true;
1885 // Make sure that cur gets back whatever happened to dummy(Lgb)
1889 // if there is a selection, we stay out of any inset,
1890 // and just jump to the right position:
1896 } else if (pit() > 0) {
1898 TextMetrics & tm = bv_->textMetrics(text());
1899 if (!tm.contains(pit()))
1900 tm.newParMetricsUp();
1901 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1902 next_row = pmcur.rows().size() - 1;
1905 if (row + 1 < int(pm.rows().size())) {
1907 } else if (pit() + 1 < int(text()->paragraphs().size())) {
1909 TextMetrics & tm = bv_->textMetrics(text());
1910 if (!tm.contains(pit()))
1911 tm.newParMetricsDown();
1915 top().pos() = min(tm.x2pos(pit(), next_row, xo), top().lastpos());
1917 int const xpos = tm.x2pos(pit(), next_row, xo);
1918 bool const at_end_row = xpos == tm.x2pos(pit(), next_row, tm.width());
1919 bool const at_beg_row = xpos == tm.x2pos(pit(), next_row, 0);
1921 if (at_end_row && at_beg_row)
1922 // make sure the cursor ends up on this row
1925 boundary(at_end_row);
1927 updateNeeded |= bv().checkDepm(*this, old);
1930 updateTextTargetOffset();
1935 void Cursor::handleFont(string const & font)
1937 LYXERR(Debug::DEBUG, font);
1941 safe = cap::grabAndEraseSelection(*this);
1946 if (lastpos() != 0) {
1947 // something left in the cell
1949 // cursor in first position
1951 } else if (pos() == lastpos()) {
1952 // cursor in last position
1955 // cursor in between. split cell
1956 MathData::iterator bt = cell().begin();
1957 MathAtom at = createInsetMath(from_utf8(font), buffer());
1958 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
1959 cell().erase(bt, bt + pos());
1964 // nothing left in the cell
1973 void Cursor::message(docstring const & msg) const
1975 theLyXFunc().setMessage(msg);
1979 void Cursor::errorMessage(docstring const & msg) const
1981 theLyXFunc().setErrorMessage(msg);
1985 static docstring parbreak(InsetCode code)
1987 odocstringstream os;
1989 // only add blank line if we're not in an ERT or Listings inset
1990 if (code != ERT_CODE && code != LISTINGS_CODE)
1996 docstring Cursor::selectionAsString(bool with_label) const
2002 return cap::grabSelection(*this);
2004 int const label = with_label
2005 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2007 idx_type const startidx = selBegin().idx();
2008 idx_type const endidx = selEnd().idx();
2009 if (startidx != endidx) {
2010 // multicell selection
2011 InsetTabular * table = inset().asInsetTabular();
2012 LASSERT(table, return docstring());
2013 return table->asString(startidx, endidx);
2016 ParagraphList const & pars = text()->paragraphs();
2018 pit_type const startpit = selBegin().pit();
2019 pit_type const endpit = selEnd().pit();
2020 size_t const startpos = selBegin().pos();
2021 size_t const endpos = selEnd().pos();
2023 if (startpit == endpit)
2024 return pars[startpit].asString(startpos, endpos, label);
2026 // First paragraph in selection
2027 docstring result = pars[startpit].
2028 asString(startpos, pars[startpit].size(), label)
2029 + parbreak(inset().lyxCode());
2031 // The paragraphs in between (if any)
2032 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2033 Paragraph const & par = pars[pit];
2034 result += par.asString(0, par.size(), label)
2035 + parbreak(inset().lyxCode());
2038 // Last paragraph in selection
2039 result += pars[endpit].asString(0, endpos, label);
2045 docstring Cursor::currentState() const
2048 odocstringstream os;
2054 return text()->currentState(*this);
2060 docstring Cursor::getPossibleLabel() const
2062 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2066 Encoding const * Cursor::getEncoding() const
2070 CursorSlice const & sl = innerTextSlice();
2071 Text const & text = *sl.text();
2072 Font font = text.getPar(sl.pit()).getFont(
2073 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2074 return font.language()->encoding();
2078 void Cursor::undispatched()
2080 disp_.dispatched(false);
2084 void Cursor::dispatched()
2086 disp_.dispatched(true);
2090 void Cursor::updateFlags(Update::flags f)
2096 void Cursor::noUpdate()
2098 disp_.update(Update::None);
2102 Font Cursor::getFont() const
2104 // The logic here should more or less match to the Cursor::setCurrentFont
2105 // logic, i.e. the cursor height should give a hint what will happen
2106 // if a character is entered.
2108 // HACK. far from being perfect...
2110 CursorSlice const & sl = innerTextSlice();
2111 Text const & text = *sl.text();
2112 Paragraph const & par = text.getPar(sl.pit());
2114 // on boundary, so we are really at the character before
2115 pos_type pos = sl.pos();
2116 if (pos > 0 && boundary())
2119 // on space? Take the font before (only for RTL boundary stay)
2121 TextMetrics const & tm = bv().textMetrics(&text);
2122 if (pos == sl.lastpos()
2123 || (par.isSeparator(pos)
2124 && !tm.isRTLBoundary(sl.pit(), pos)))
2128 // get font at the position
2129 Font font = par.getFont(buffer()->params(), pos,
2130 text.outerFont(sl.pit()));
2136 bool Cursor::fixIfBroken()
2138 if (DocIterator::fixIfBroken()) {
2146 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2148 // find inset in common
2150 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2151 if (&old[i].inset() != &cur[i].inset())
2155 // update words if we just moved to another paragraph
2156 if (i == old.depth() && i == cur.depth()
2157 && !cur.buffer()->isClean()
2158 && cur.inTexted() && old.inTexted()
2159 && cur.pit() != old.pit()) {
2160 old.paragraph().updateWords();
2163 // notify everything on top of the common part in old cursor,
2164 // but stop if the inset claims the cursor to be invalid now
2165 for (size_type j = i; j < old.depth(); ++j) {
2166 Cursor inset_pos = old;
2167 inset_pos.cutOff(j);
2168 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2172 // notify everything on top of the common part in new cursor,
2173 // but stop if the inset claims the cursor to be invalid now
2174 for (; i < cur.depth(); ++i) {
2175 if (cur[i].inset().notifyCursorEnters(cur))
2183 void Cursor::setCurrentFont()
2185 CursorSlice const & cs = innerTextSlice();
2186 Paragraph const & par = cs.paragraph();
2187 pos_type cpit = cs.pit();
2188 pos_type cpos = cs.pos();
2189 Text const & ctext = *cs.text();
2190 TextMetrics const & tm = bv().textMetrics(&ctext);
2192 // are we behind previous char in fact? -> go to that char
2193 if (cpos > 0 && boundary())
2196 // find position to take the font from
2198 // paragraph end? -> font of last char
2199 if (cpos == lastpos())
2201 // on space? -> look at the words in front of space
2202 else if (cpos > 0 && par.isSeparator(cpos)) {
2203 // abc| def -> font of c
2204 // abc |[WERBEH], i.e. boundary==true -> font of c
2205 // abc [WERBEH]| def, font of the space
2206 if (!tm.isRTLBoundary(cpit, cpos))
2212 BufferParams const & bufparams = buffer()->params();
2213 current_font = par.getFontSettings(bufparams, cpos);
2214 real_current_font = tm.displayFont(cpit, cpos);
2216 // special case for paragraph end
2217 if (cs.pos() == lastpos()
2218 && tm.isRTLBoundary(cpit, cs.pos())
2220 Language const * lang = par.getParLanguage(bufparams);
2221 current_font.setLanguage(lang);
2222 current_font.fontInfo().setNumber(FONT_OFF);
2223 real_current_font.setLanguage(lang);
2224 real_current_font.fontInfo().setNumber(FONT_OFF);
2229 bool Cursor::textUndo()
2231 DocIterator dit = *this;
2232 // Undo::textUndo() will modify dit.
2233 if (!buffer()->undo().textUndo(dit))
2243 bool Cursor::textRedo()
2245 DocIterator dit = *this;
2246 // Undo::textRedo() will modify dit.
2247 if (!buffer()->undo().textRedo(dit))
2257 void Cursor::finishUndo() const
2259 buffer()->undo().finishUndo();
2263 void Cursor::beginUndoGroup() const
2265 buffer()->undo().beginUndoGroup();
2269 void Cursor::endUndoGroup() const
2271 buffer()->undo().endUndoGroup();
2275 void Cursor::recordUndo(UndoKind kind, pit_type from, pit_type to) const
2277 buffer()->undo().recordUndo(*this, kind, from, to);
2281 void Cursor::recordUndo(UndoKind kind, pit_type from) const
2283 buffer()->undo().recordUndo(*this, kind, from);
2287 void Cursor::recordUndo(UndoKind kind) const
2289 buffer()->undo().recordUndo(*this, kind);
2293 void Cursor::recordUndoInset(UndoKind kind) const
2295 buffer()->undo().recordUndoInset(*this, kind);
2299 void Cursor::recordUndoFullDocument() const
2301 buffer()->undo().recordUndoFullDocument(*this);
2305 void Cursor::recordUndoSelection() const
2308 if (cap::multipleCellsSelected(*this))
2313 buffer()->undo().recordUndo(*this, ATOMIC_UNDO,
2314 selBegin().pit(), selEnd().pit());
2319 void Cursor::checkBufferStructure()
2321 Buffer const * master = buffer()->masterBuffer();
2322 master->tocBackend().updateItem(*this);
2323 if (master != buffer() && !master->hasGuiDelegate())
2324 // In case the master has no gui associated with it,
2325 // the TocItem is not updated (part of bug 5699).
2326 buffer()->tocBackend().updateItem(*this);