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), word_selection_(false),
258 logicalpos_(false), 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()
487 DocIterator normal = anchor_;
488 while (depth() < normal.depth())
490 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
497 bool Cursor::posBackward()
506 bool Cursor::posForward()
508 if (pos() == lastpos())
515 bool Cursor::posVisRight(bool skip_inset)
517 Cursor new_cur = *this; // where we will move to
518 pos_type left_pos; // position visually left of current cursor
519 pos_type right_pos; // position visually right of current cursor
520 bool new_pos_is_RTL; // is new position we're moving to RTL?
522 getSurroundingPos(left_pos, right_pos);
524 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
526 // Are we at an inset?
527 new_cur.pos() = right_pos;
528 new_cur.boundary(false);
530 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
531 // we actually move the cursor at the end of this function, for now
532 // we just keep track of the new position in new_cur...
533 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
536 // Are we already at rightmost pos in row?
537 else if (text()->empty() || right_pos == -1) {
540 if (!new_cur.posVisToNewRow(false)) {
541 LYXERR(Debug::RTL, "not moving!");
545 // we actually move the cursor at the end of this function, for now
546 // just keep track of the new position in new_cur...
547 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
548 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
551 // normal movement to the right
554 // Recall, if the cursor is at position 'x', that means *before*
555 // the character at position 'x'. In RTL, "before" means "to the
556 // right of", in LTR, "to the left of". So currently our situation
557 // is this: the position to our right is 'right_pos' (i.e., we're
558 // currently to the left of 'right_pos'). In order to move to the
559 // right, it depends whether or not the character at 'right_pos' is RTL.
560 new_pos_is_RTL = paragraph().getFontSettings(
561 buffer()->params(), right_pos).isVisibleRightToLeft();
562 // If the character at 'right_pos' *is* LTR, then in order to move to
563 // the right of it, we need to be *after* 'right_pos', i.e., move to
564 // position 'right_pos' + 1.
565 if (!new_pos_is_RTL) {
566 new_cur.pos() = right_pos + 1;
567 // set the boundary to true in two situations:
569 // 1. if new_pos is now lastpos, and we're in an RTL paragraph
570 // (this means that we're moving right to the end of an LTR chunk
571 // which is at the end of an RTL paragraph);
572 (new_cur.pos() == lastpos()
573 && paragraph().isRTL(buffer()->params()))
574 // 2. if the position *after* right_pos is RTL (we want to be
575 // *after* right_pos, not before right_pos + 1!)
576 || paragraph().getFontSettings(buffer()->params(),
577 new_cur.pos()).isVisibleRightToLeft()
579 new_cur.boundary(true);
580 else // set the boundary to false
581 new_cur.boundary(false);
583 // Otherwise (if the character at position 'right_pos' is RTL), then
584 // moving to the right of it is as easy as setting the new position
587 new_cur.pos() = right_pos;
588 new_cur.boundary(false);
593 bool moved = (new_cur.pos() != pos()
594 || new_cur.pit() != pit()
595 || new_cur.boundary() != boundary()
596 || &new_cur.inset() != &inset());
599 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
600 << (new_cur.boundary() ? " (boundary)" : ""));
608 bool Cursor::posVisLeft(bool skip_inset)
610 Cursor new_cur = *this; // where we will move to
611 pos_type left_pos; // position visually left of current cursor
612 pos_type right_pos; // position visually right of current cursor
613 bool new_pos_is_RTL; // is new position we're moving to RTL?
615 getSurroundingPos(left_pos, right_pos);
617 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
619 // Are we at an inset?
620 new_cur.pos() = left_pos;
621 new_cur.boundary(false);
623 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
624 // we actually move the cursor at the end of this function, for now
625 // we just keep track of the new position in new_cur...
626 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
629 // Are we already at leftmost pos in row?
630 else if (text()->empty() || left_pos == -1) {
633 if (!new_cur.posVisToNewRow(true)) {
634 LYXERR(Debug::RTL, "not moving!");
638 // we actually move the cursor at the end of this function, for now
639 // just keep track of the new position in new_cur...
640 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
641 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
644 // normal movement to the left
647 // Recall, if the cursor is at position 'x', that means *before*
648 // the character at position 'x'. In RTL, "before" means "to the
649 // right of", in LTR, "to the left of". So currently our situation
650 // is this: the position to our left is 'left_pos' (i.e., we're
651 // currently to the right of 'left_pos'). In order to move to the
652 // left, it depends whether or not the character at 'left_pos' is RTL.
653 new_pos_is_RTL = paragraph().getFontSettings(
654 buffer()->params(), left_pos).isVisibleRightToLeft();
655 // If the character at 'left_pos' *is* RTL, then in order to move to
656 // the left of it, we need to be *after* 'left_pos', i.e., move to
657 // position 'left_pos' + 1.
658 if (new_pos_is_RTL) {
659 new_cur.pos() = left_pos + 1;
660 // set the boundary to true in two situations:
662 // 1. if new_pos is now lastpos and we're in an LTR paragraph
663 // (this means that we're moving left to the end of an RTL chunk
664 // which is at the end of an LTR paragraph);
665 (new_cur.pos() == lastpos()
666 && !paragraph().isRTL(buffer()->params()))
667 // 2. if the position *after* left_pos is not RTL (we want to be
668 // *after* left_pos, not before left_pos + 1!)
669 || !paragraph().getFontSettings(buffer()->params(),
670 new_cur.pos()).isVisibleRightToLeft()
672 new_cur.boundary(true);
673 else // set the boundary to false
674 new_cur.boundary(false);
676 // Otherwise (if the character at position 'left_pos' is LTR), then
677 // moving to the left of it is as easy as setting the new position
680 new_cur.pos() = left_pos;
681 new_cur.boundary(false);
686 bool moved = (new_cur.pos() != pos()
687 || new_cur.pit() != pit()
688 || new_cur.boundary() != boundary());
691 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
692 << (new_cur.boundary() ? " (boundary)" : ""));
700 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
702 // preparing bidi tables
703 Paragraph const & par = paragraph();
704 Buffer const & buf = *buffer();
705 Row const & row = textRow();
707 bidi.computeTables(par, buf, row);
709 LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
711 // The cursor is painted *before* the character at pos(), or, if 'boundary'
712 // is true, *after* the character at (pos() - 1). So we already have one
713 // known position around the cursor:
714 pos_type const known_pos = boundary() && pos() > 0 ? pos() - 1 : pos();
716 // edge case: if we're at the end of the paragraph, things are a little
717 // different (because lastpos is a position which does not really "exist"
718 // --- there's no character there yet).
719 if (known_pos == lastpos()) {
720 if (par.isRTL(buf.params())) {
722 right_pos = bidi.vis2log(row.pos());
726 left_pos = bidi.vis2log(row.endpos() - 1);
731 // Whether 'known_pos' is to the left or to the right of the cursor depends
732 // on whether it is an RTL or LTR character...
733 bool const cur_is_RTL =
734 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
735 // ... in the following manner:
736 // For an RTL character, "before" means "to the right" and "after" means
737 // "to the left"; and for LTR, it's the reverse. So, 'known_pos' is to the
738 // right of the cursor if (RTL && boundary) or (!RTL && !boundary):
739 bool const known_pos_on_right = cur_is_RTL == boundary();
741 // So we now know one of the positions surrounding the cursor. Let's
742 // determine the other one:
743 if (known_pos_on_right) {
744 right_pos = known_pos;
745 // *visual* position of 'left_pos':
746 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
747 // If the position we just identified as 'left_pos' is a "skipped
748 // separator" (a separator which is at the logical end of a row,
749 // except for the last row in a paragraph; such separators are not
750 // painted, so they "are not really there"; note that in bidi text,
751 // such a separator could appear visually in the middle of a row),
752 // set 'left_pos' to the *next* position to the left.
753 if (bidi.inRange(v_left_pos)
754 && bidi.vis2log(v_left_pos) + 1 == row.endpos()
755 && row.endpos() < lastpos()
756 && par.isSeparator(bidi.vis2log(v_left_pos)))
759 // calculate the logical position of 'left_pos', if in row
760 if (!bidi.inRange(v_left_pos))
763 left_pos = bidi.vis2log(v_left_pos);
764 // If the position we identified as 'right_pos' is a "skipped
765 // separator", set 'right_pos' to the *next* position to the right.
766 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos()
767 && par.isSeparator(right_pos)) {
768 pos_type const v_right_pos = bidi.log2vis(right_pos) + 1;
769 if (!bidi.inRange(v_right_pos))
772 right_pos = bidi.vis2log(v_right_pos);
775 // known_pos is on the left
776 left_pos = known_pos;
777 // *visual* position of 'right_pos'
778 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
779 // If the position we just identified as 'right_pos' is a "skipped
780 // separator", set 'right_pos' to the *next* position to the right.
781 if (bidi.inRange(v_right_pos)
782 && bidi.vis2log(v_right_pos) + 1 == row.endpos()
783 && row.endpos() < lastpos()
784 && par.isSeparator(bidi.vis2log(v_right_pos)))
787 // calculate the logical position of 'right_pos', if in row
788 if (!bidi.inRange(v_right_pos))
791 right_pos = bidi.vis2log(v_right_pos);
792 // If the position we identified as 'left_pos' is a "skipped
793 // separator", set 'left_pos' to the *next* position to the left.
794 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos()
795 && par.isSeparator(left_pos)) {
796 pos_type const v_left_pos = bidi.log2vis(left_pos) - 1;
797 if (!bidi.inRange(v_left_pos))
800 left_pos = bidi.vis2log(v_left_pos);
807 bool Cursor::posVisToNewRow(bool movingLeft)
809 Paragraph const & par = paragraph();
810 Buffer const & buf = *buffer();
811 Row const & row = textRow();
812 bool par_is_LTR = !par.isRTL(buf.params());
814 // Inside a table, determining whether to move to the next or previous row
815 // should be done based on the table's direction.
817 if (s >= 1 && (*this)[s].inset().asInsetTabular()) {
818 par_is_LTR = !(*this)[s].inset().asInsetTabular()->isRightToLeft(*this);
819 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
822 // if moving left in an LTR paragraph or moving right in an RTL one,
823 // move to previous row
824 if (par_is_LTR == movingLeft) {
825 if (row.pos() == 0) { // we're at first row in paragraph
826 if (pit() == 0) // no previous paragraph! don't move
828 // move to last pos in previous par
832 } else { // move to previous row in this par
833 pos() = row.pos() - 1; // this is guaranteed to be in previous row
837 // if moving left in an RTL paragraph or moving right in an LTR one,
840 if (row.endpos() == lastpos()) { // we're at last row in paragraph
841 if (pit() == lastpit()) // last paragraph! don't move
843 // move to first row in next par
847 } else { // move to next row in this par
848 pos() = row.endpos();
853 // make sure we're at left-/right-most pos in new row
854 posVisToRowExtremity(!movingLeft);
860 void Cursor::posVisToRowExtremity(bool left)
862 // prepare bidi tables
863 Paragraph const & par = paragraph();
864 Buffer const & buf = *buffer();
865 Row const & row = textRow();
867 bidi.computeTables(par, buf, row);
869 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
870 << (boundary() ? 1 : 0));
872 if (left) { // move to leftmost position
873 // if this is an RTL paragraph, and we're at the last row in the
874 // paragraph, move to lastpos
875 if (par.isRTL(buf.params()) && row.endpos() == lastpos())
878 pos() = bidi.vis2log(row.pos());
880 // Moving to the leftmost position in the row, the cursor should
881 // normally be placed to the *left* of the leftmost position.
882 // A very common exception, though, is if the leftmost character
883 // also happens to be the separator at the (logical) end of the row
884 // --- in this case, the separator is positioned beyond the left
885 // margin, and we don't want to move the cursor there (moving to
886 // the left of the separator is equivalent to moving to the next
887 // line). So, in this case we actually want to place the cursor
888 // to the *right* of the leftmost position (the separator).
889 // Another exception is if we're moving to the logically last
890 // position in the row, which is *not* a separator: this means
891 // that the entire row has no separators (if there were any, the
892 // row would have been broken there); and therefore in this case
893 // we also move to the *right* of the last position (this indicates
894 // to the user that there is no space after this position, and is
895 // consistent with the behavior in the middle of a row --- moving
896 // right or left moves to the next/previous character; if we were
897 // to move to the *left* of this position, that would simulate
898 // a separator which is not really there!).
899 // Finally, there is an exception to the previous exception: if
900 // this non-separator-but-last-position-in-row is an inset, then
901 // we *do* want to stay to the left of it anyway: this is the
902 // "boundary" which we simulate at insets.
903 // Another exception is when row.endpos() is 0.
905 // do we want to be to the right of pos?
906 // as explained above, if at last pos in row, stay to the right
907 bool const right_of_pos = row.endpos() > 0
908 && pos() == row.endpos() - 1 && !par.isInset(pos());
910 // Now we know if we want to be to the left or to the right of pos,
911 // let's make sure we are where we want to be.
912 bool const new_pos_is_RTL =
913 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
915 if (new_pos_is_RTL != right_of_pos) {
921 // move to rightmost position
922 // if this is an LTR paragraph, and we're at the last row in the
923 // paragraph, move to lastpos
924 if (!par.isRTL(buf.params()) && row.endpos() == lastpos())
927 pos() = row.endpos() > 0 ? bidi.vis2log(row.endpos() - 1) : 0;
929 // Moving to the rightmost position in the row, the cursor should
930 // normally be placed to the *right* of the rightmost position.
931 // A very common exception, though, is if the rightmost character
932 // also happens to be the separator at the (logical) end of the row
933 // --- in this case, the separator is positioned beyond the right
934 // margin, and we don't want to move the cursor there (moving to
935 // the right of the separator is equivalent to moving to the next
936 // line). So, in this case we actually want to place the cursor
937 // to the *left* of the rightmost position (the separator).
938 // Another exception is if we're moving to the logically last
939 // position in the row, which is *not* a separator: this means
940 // that the entire row has no separators (if there were any, the
941 // row would have been broken there); and therefore in this case
942 // we also move to the *left* of the last position (this indicates
943 // to the user that there is no space after this position, and is
944 // consistent with the behavior in the middle of a row --- moving
945 // right or left moves to the next/previous character; if we were
946 // to move to the *right* of this position, that would simulate
947 // a separator which is not really there!).
948 // Finally, there is an exception to the previous exception: if
949 // this non-separator-but-last-position-in-row is an inset, then
950 // we *do* want to stay to the right of it anyway: this is the
951 // "boundary" which we simulate at insets.
952 // Another exception is when row.endpos() is 0.
954 // do we want to be to the left of pos?
955 // as explained above, if at last pos in row, stay to the left,
956 // unless the last position is the same as the first.
957 bool const left_of_pos = row.endpos() > 0
958 && pos() == row.endpos() - 1 && !par.isInset(pos());
960 // Now we know if we want to be to the left or to the right of pos,
961 // let's make sure we are where we want to be.
962 bool const new_pos_is_RTL =
963 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
965 if (new_pos_is_RTL == left_of_pos) {
971 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
972 << (boundary() ? 1 : 0));
976 CursorSlice Cursor::anchor() const
980 LASSERT(anchor_.depth() >= depth(), /**/);
981 CursorSlice normal = anchor_[depth() - 1];
982 if (depth() < anchor_.depth() && top() <= normal) {
983 // anchor is behind cursor -> move anchor behind the inset
990 CursorSlice Cursor::selBegin() const
994 return anchor() < top() ? anchor() : top();
998 CursorSlice Cursor::selEnd() const
1002 return anchor() > top() ? anchor() : top();
1006 DocIterator Cursor::selectionBegin() const
1012 // FIXME: This is a work-around for the problem that
1013 // CursorSlice doesn't keep track of the boundary.
1014 if (anchor() == top())
1015 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1017 di = anchor() < top() ? anchor_ : *this;
1023 DocIterator Cursor::selectionEnd() const
1029 // FIXME: This is a work-around for the problem that
1030 // CursorSlice doesn't keep track of the boundary.
1031 if (anchor() == top())
1032 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1034 di = anchor() > top() ? anchor_ : *this;
1036 if (di.depth() > depth()) {
1044 void Cursor::setSelection()
1047 // A selection with no contents is not a selection
1048 // FIXME: doesnt look ok
1049 if (idx() == anchor().idx() &&
1050 pit() == anchor().pit() &&
1051 pos() == anchor().pos())
1052 setSelection(false);
1056 void Cursor::setSelection(DocIterator const & where, int n)
1065 void Cursor::clearSelection()
1067 setSelection(false);
1068 setWordSelection(false);
1074 void Cursor::setTargetX(int x)
1077 textTargetOffset_ = 0;
1081 int Cursor::x_target() const
1087 void Cursor::clearTargetX()
1090 textTargetOffset_ = 0;
1094 void Cursor::updateTextTargetOffset()
1099 textTargetOffset_ = x - x_target_;
1103 void Cursor::info(odocstream & os) const
1105 for (int i = 1, n = depth(); i < n; ++i) {
1106 operator[](i).inset().infoize(os);
1110 Inset const * inset = prevInset();
1111 // prevInset() can return 0 in certain case.
1113 prevInset()->infoize2(os);
1115 // overwite old message
1120 bool Cursor::selHandle(bool sel)
1122 //lyxerr << "Cursor::selHandle" << endl;
1125 if (sel == selection())
1129 cap::saveSelection(*this);
1137 ostream & operator<<(ostream & os, Cursor const & cur)
1139 os << "\n cursor: | anchor:\n";
1140 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
1141 os << " " << cur[i] << " | ";
1142 if (i < cur.anchor_.depth())
1143 os << cur.anchor_[i];
1145 os << "-------------------------------";
1148 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
1149 os << "------------------------------- | " << cur.anchor_[i] << "\n";
1151 os << " selection: " << cur.selection_
1152 << " x_target: " << cur.x_target_ << endl;
1157 LyXErr & operator<<(LyXErr & os, Cursor const & cur)
1167 ///////////////////////////////////////////////////////////////////
1170 // The part below is the non-integrated rest of the original math
1171 // cursor. This should be either generalized for texted or moved
1172 // back to mathed (in most cases to InsetMathNest).
1174 ///////////////////////////////////////////////////////////////////
1176 #include "mathed/InsetMathChar.h"
1177 #include "mathed/InsetMathGrid.h"
1178 #include "mathed/InsetMathScript.h"
1179 #include "mathed/InsetMathUnknown.h"
1180 #include "mathed/MathFactory.h"
1181 #include "mathed/MathStream.h"
1182 #include "mathed/MathSupport.h"
1187 //#define FILEDEBUG 1
1190 bool Cursor::isInside(Inset const * p) const
1192 for (size_t i = 0; i != depth(); ++i)
1193 if (&operator[](i).inset() == p)
1199 void Cursor::leaveInset(Inset const & inset)
1201 for (size_t i = 0; i != depth(); ++i) {
1202 if (&operator[](i).inset() == &inset) {
1210 bool Cursor::openable(MathAtom const & t) const
1221 // we can't move into anything new during selection
1222 if (depth() >= anchor_.depth())
1224 if (t.nucleus() != &anchor_[depth()].inset())
1231 void Cursor::setScreenPos(int x, int /*y*/)
1234 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1239 void Cursor::plainErase()
1241 cell().erase(pos());
1245 void Cursor::markInsert()
1247 insert(char_type(0));
1251 void Cursor::markErase()
1253 cell().erase(pos());
1257 void Cursor::plainInsert(MathAtom const & t)
1259 cell().insert(pos(), t);
1261 inset().setBuffer(bv_->buffer());
1266 void Cursor::insert(docstring const & str)
1268 for_each(str.begin(), str.end(),
1269 boost::bind(static_cast<void(Cursor::*)(char_type)>
1270 (&Cursor::insert), this, _1));
1274 void Cursor::insert(char_type c)
1276 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1277 LASSERT(!empty(), /**/);
1279 cap::selClearOrDel(*this);
1280 insert(new InsetMathChar(c));
1282 text()->insertChar(*this, c);
1287 void Cursor::insert(MathAtom const & t)
1289 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1291 cap::selClearOrDel(*this);
1296 void Cursor::insert(Inset * inset0)
1298 LASSERT(inset0, /**/);
1300 insert(MathAtom(inset0));
1302 text()->insertInset(*this, inset0);
1303 inset0->setBuffer(bv_->buffer());
1309 void Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1311 MathData ar(buffer());
1313 if (ar.size() == 1 && (enter || selection()))
1320 void Cursor::niceInsert(MathAtom const & t)
1323 docstring const safe = cap::grabAndEraseSelection(*this);
1325 // If possible, enter the new inset and move the contents of the selection
1326 if (t->isActive()) {
1328 // be careful here: don't use 'pushBackward(t)' as this we need to
1329 // push the clone, not the original
1330 pushBackward(*nextInset());
1331 // We may not use niceInsert here (recursion)
1332 MathData ar(buffer());
1339 void Cursor::insert(MathData const & ar)
1343 cap::eraseSelection(*this);
1344 cell().insert(pos(), ar);
1349 bool Cursor::backspace()
1351 autocorrect() = false;
1354 cap::eraseSelection(*this);
1359 // If empty cell, and not part of a big cell
1360 if (lastpos() == 0 && inset().nargs() == 1) {
1362 // Directly delete empty cell: [|[]] => [|]
1368 // [|], can not delete from inside
1379 if (inMacroMode()) {
1380 InsetMathUnknown * p = activeMacro();
1381 if (p->name().size() > 1) {
1382 p->setName(p->name().substr(0, p->name().size() - 1));
1387 if (pos() != 0 && prevAtom()->nargs() > 0) {
1388 // let's require two backspaces for 'big stuff' and
1389 // highlight on the first
1401 bool Cursor::erase()
1403 autocorrect() = false;
1408 cap::eraseSelection(*this);
1412 // delete empty cells if possible
1413 if (pos() == lastpos() && inset().idxDelete(idx()))
1416 // special behaviour when in last position of cell
1417 if (pos() == lastpos()) {
1418 bool one_cell = inset().nargs() == 1;
1419 if (one_cell && lastpos() == 0) {
1421 // Directly delete empty cell: [|[]] => [|]
1427 // [|], can not delete from inside
1432 inset().idxGlue(idx());
1436 // 'clever' UI hack: only erase large items if previously slected
1437 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1452 DocIterator save = *this;
1453 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1454 this->dispatch(cmd);
1455 if (disp_.dispatched())
1458 autocorrect() = false;
1466 DocIterator save = *this;
1467 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1468 this->dispatch(cmd);
1469 if (disp_.dispatched())
1472 autocorrect() = false;
1477 bool Cursor::macroModeClose()
1481 InsetMathUnknown * p = activeMacro();
1483 MathData selection(buffer());
1484 asArray(p->selection(), selection);
1485 docstring const s = p->name();
1487 cell().erase(pos());
1489 // do nothing if the macro name is empty
1493 // trigger updates of macros, at least, if no full
1494 // updates take place anyway
1495 updateFlags(Update::Force);
1497 docstring const name = s.substr(1);
1498 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1499 if (in && in->interpretString(*this, s))
1501 MathAtom atom = buffer()->getMacro(name, *this, false) ?
1502 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1504 // try to put argument into macro, if we just inserted a macro
1505 bool macroArg = false;
1506 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1508 // macros here are still unfolded (in init mode in fact). So
1509 // we have to resolve the macro here manually and check its arity
1510 // to put the selection behind it if arity > 0.
1511 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1512 if (selection.size() > 0 && data && data->numargs() - data->optionals() > 0) {
1514 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1516 // non-greedy case. Do not touch the arguments behind
1517 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1520 // insert remembered selection into first argument of a non-macro
1521 else if (atom.nucleus()->nargs() > 0)
1522 atom.nucleus()->cell(0).append(selection);
1526 // finally put the macro argument behind, if needed
1528 if (selection.size() > 1 || selection[0]->asScriptInset())
1529 plainInsert(MathAtom(new InsetMathBrace(selection)));
1538 docstring Cursor::macroName()
1540 return inMacroMode() ? activeMacro()->name() : docstring();
1544 void Cursor::handleNest(MathAtom const & a, int c)
1546 //lyxerr << "Cursor::handleNest: " << c << endl;
1548 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1551 pushBackward(*nextInset());
1555 int Cursor::targetX() const
1557 if (x_target() != -1)
1566 int Cursor::textTargetOffset() const
1568 return textTargetOffset_;
1572 void Cursor::setTargetX()
1581 bool Cursor::inMacroMode() const
1587 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1588 return p && !p->final();
1592 InsetMathUnknown * Cursor::activeMacro()
1594 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1598 InsetMathUnknown const * Cursor::activeMacro() const
1600 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1604 void Cursor::pullArg()
1607 MathData ar = cell();
1608 if (popBackward() && inMathed()) {
1610 cell().insert(pos(), ar);
1613 //formula()->mutateToText();
1618 void Cursor::touch()
1622 DocIterator::const_iterator it = begin();
1623 DocIterator::const_iterator et = end();
1624 for ( ; it != et; ++it)
1630 void Cursor::normalize()
1632 if (idx() > lastidx()) {
1633 lyxerr << "this should not really happen - 1: "
1634 << idx() << ' ' << nargs()
1635 << " in: " << &inset() << endl;
1639 if (pos() > lastpos()) {
1640 lyxerr << "this should not really happen - 2: "
1641 << pos() << ' ' << lastpos() << " in idx: " << idx()
1643 odocstringstream os;
1644 WriteStream wi(os, false, true, WriteStream::wsDefault);
1645 inset().asInsetMath()->write(wi);
1646 lyxerr << to_utf8(os.str()) << endl;
1652 bool Cursor::upDownInMath(bool up)
1654 // Be warned: The 'logic' implemented in this function is highly
1655 // fragile. A distance of one pixel or a '<' vs '<=' _really
1656 // matters. So fiddle around with it only if you think you know
1657 // what you are doing!
1661 xo = theLyXFunc().cursorBeforeDispatchX();
1663 // check if we had something else in mind, if not, this is the future
1665 if (x_target_ == -1)
1667 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1668 // In text mode inside the line (not left or right) possibly set a new target_x,
1669 // but only if we are somewhere else than the previous target-offset.
1671 // We want to keep the x-target on subsequent up/down movements
1672 // that cross beyond the end of short lines. Thus a special
1673 // handling when the cursor is at the end of line: Use the new
1674 // x-target only if the old one was before the end of line
1675 // or the old one was after the beginning of the line
1676 bool inRTL = isWithinRtlParagraph(*this);
1680 left = pos() == textRow().endpos();
1681 right = pos() == textRow().pos();
1683 left = pos() == textRow().pos();
1684 right = pos() == textRow().endpos();
1686 if ((!left && !right) ||
1687 (left && !right && xo < x_target_) ||
1688 (!left && right && x_target_ < xo))
1695 // try neigbouring script insets
1697 if (inMathed() && !selection()) {
1700 InsetMathScript const * p = prevAtom()->asScriptInset();
1701 if (p && p->has(up)) {
1703 push(*const_cast<InsetMathScript*>(p));
1704 idx() = p->idxOfScript(up);
1707 // we went in the right direction? Otherwise don't jump into the script
1711 int oy = theLyXFunc().cursorBeforeDispatchY();
1712 if ((!up && y <= oy) ||
1721 if (pos() != lastpos()) {
1722 InsetMathScript const * p = nextAtom()->asScriptInset();
1723 if (p && p->has(up)) {
1724 push(*const_cast<InsetMathScript*>(p));
1725 idx() = p->idxOfScript(up);
1728 // we went in the right direction? Otherwise don't jump into the script
1732 int oy = theLyXFunc().cursorBeforeDispatchY();
1733 if ((!up && y <= oy) ||
1742 // try to find an inset that knows better then we,
1743 if (inset().idxUpDown(*this, up)) {
1744 //lyxerr << "idxUpDown triggered" << endl;
1745 // try to find best position within this inset
1747 setCursor(bruteFind2(*this, xo, yo));
1751 // any improvement going just out of inset?
1752 if (popBackward() && inMathed()) {
1753 //lyxerr << "updown: popBackward succeeded" << endl;
1756 int yold = theLyXFunc().cursorBeforeDispatchY();
1758 if (up ? ynew < yold : ynew > yold)
1762 // no success, we are probably at the document top or bottom
1768 bool Cursor::atFirstOrLastRow(bool up)
1770 TextMetrics const & tm = bv_->textMetrics(text());
1771 ParagraphMetrics const & pm = tm.parMetrics(pit());
1774 if (pos() && boundary())
1775 row = pm.pos2row(pos() - 1);
1777 row = pm.pos2row(pos());
1780 if (pit() == 0 && row == 0)
1783 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1784 row + 1 >= int(pm.rows().size()))
1790 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1792 LASSERT(text(), /**/);
1798 xo = theLyXFunc().cursorBeforeDispatchX();
1800 // update the targetX - this is here before the "return false"
1801 // to set a new target which can be used by InsetTexts above
1802 // if we cannot move up/down inside this inset anymore
1803 if (x_target_ == -1)
1805 else if (xo - textTargetOffset() != x_target() &&
1806 depth() == beforeDispatchCursor_.depth()) {
1807 // In text mode inside the line (not left or right) possibly set a new target_x,
1808 // but only if we are somewhere else than the previous target-offset.
1810 // We want to keep the x-target on subsequent up/down movements
1811 // that cross beyond the end of short lines. Thus a special
1812 // handling when the cursor is at the end of line: Use the new
1813 // x-target only if the old one was before the end of line
1814 // or the old one was after the beginning of the line
1815 bool inRTL = isWithinRtlParagraph(*this);
1819 left = pos() == textRow().endpos();
1820 right = pos() == textRow().pos();
1822 left = pos() == textRow().pos();
1823 right = pos() == textRow().endpos();
1825 if ((!left && !right) ||
1826 (left && !right && xo < x_target_) ||
1827 (!left && right && x_target_ < xo))
1834 // first get the current line
1835 TextMetrics & tm = bv_->textMetrics(text());
1836 ParagraphMetrics const & pm = tm.parMetrics(pit());
1838 if (pos() && boundary())
1839 row = pm.pos2row(pos() - 1);
1841 row = pm.pos2row(pos());
1843 if (atFirstOrLastRow(up)) {
1844 // Is there a place for the cursor to go ? If yes, we
1845 // can execute the DEPM, otherwise we should keep the
1846 // paragraph to host the cursor.
1847 Cursor dummy = *this;
1848 bool valid_destination = false;
1849 for(; dummy.depth(); dummy.pop())
1850 if (!dummy.atFirstOrLastRow(up)) {
1851 valid_destination = true;
1855 // will a next dispatch follow and if there is a new
1856 // dispatch will it move the cursor out ?
1857 if (depth() > 1 && valid_destination) {
1858 // The cursor hasn't changed yet. This happens when
1859 // you e.g. move out of an inset. And to give the
1860 // DEPM the possibility of doing something we must
1861 // provide it with two different cursors. (Lgb, vfr)
1863 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1864 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1866 updateNeeded |= bv().checkDepm(dummy, *this);
1867 updateTextTargetOffset();
1872 // with and without selection are handled differently
1874 int yo = bv().getPos(*this, boundary()).y_;
1876 // To next/previous row
1878 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1880 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1883 // This happens when you move out of an inset.
1884 // And to give the DEPM the possibility of doing
1885 // something we must provide it with two different
1887 Cursor dummy = *this;
1890 if (bv().checkDepm(dummy, old)) {
1891 updateNeeded = true;
1892 // Make sure that cur gets back whatever happened to dummy(Lgb)
1896 // if there is a selection, we stay out of any inset,
1897 // and just jump to the right position:
1903 } else if (pit() > 0) {
1905 TextMetrics & tm = bv_->textMetrics(text());
1906 if (!tm.contains(pit()))
1907 tm.newParMetricsUp();
1908 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1909 next_row = pmcur.rows().size() - 1;
1912 if (row + 1 < int(pm.rows().size())) {
1914 } else if (pit() + 1 < int(text()->paragraphs().size())) {
1916 TextMetrics & tm = bv_->textMetrics(text());
1917 if (!tm.contains(pit()))
1918 tm.newParMetricsDown();
1922 top().pos() = min(tm.x2pos(pit(), next_row, xo), top().lastpos());
1924 int const xpos = tm.x2pos(pit(), next_row, xo);
1925 bool const at_end_row = xpos == tm.x2pos(pit(), next_row, tm.width());
1926 bool const at_beg_row = xpos == tm.x2pos(pit(), next_row, 0);
1928 if (at_end_row && at_beg_row)
1929 // make sure the cursor ends up on this row
1932 boundary(at_end_row);
1934 updateNeeded |= bv().checkDepm(*this, old);
1937 updateTextTargetOffset();
1942 void Cursor::handleFont(string const & font)
1944 LYXERR(Debug::DEBUG, font);
1948 safe = cap::grabAndEraseSelection(*this);
1953 if (lastpos() != 0) {
1954 // something left in the cell
1956 // cursor in first position
1958 } else if (pos() == lastpos()) {
1959 // cursor in last position
1962 // cursor in between. split cell
1963 MathData::iterator bt = cell().begin();
1964 MathAtom at = createInsetMath(from_utf8(font), buffer());
1965 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
1966 cell().erase(bt, bt + pos());
1971 // nothing left in the cell
1980 void Cursor::message(docstring const & msg) const
1982 theLyXFunc().setMessage(msg);
1986 void Cursor::errorMessage(docstring const & msg) const
1988 theLyXFunc().setErrorMessage(msg);
1992 static docstring parbreak(InsetCode code)
1994 odocstringstream os;
1996 // only add blank line if we're not in an ERT or Listings inset
1997 if (code != ERT_CODE && code != LISTINGS_CODE)
2003 docstring Cursor::selectionAsString(bool with_label) const
2009 return cap::grabSelection(*this);
2011 int const label = with_label
2012 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2014 idx_type const startidx = selBegin().idx();
2015 idx_type const endidx = selEnd().idx();
2016 if (startidx != endidx) {
2017 // multicell selection
2018 InsetTabular * table = inset().asInsetTabular();
2019 LASSERT(table, return docstring());
2020 return table->asString(startidx, endidx);
2023 ParagraphList const & pars = text()->paragraphs();
2025 pit_type const startpit = selBegin().pit();
2026 pit_type const endpit = selEnd().pit();
2027 size_t const startpos = selBegin().pos();
2028 size_t const endpos = selEnd().pos();
2030 if (startpit == endpit)
2031 return pars[startpit].asString(startpos, endpos, label);
2033 // First paragraph in selection
2034 docstring result = pars[startpit].
2035 asString(startpos, pars[startpit].size(), label)
2036 + parbreak(inset().lyxCode());
2038 // The paragraphs in between (if any)
2039 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2040 Paragraph const & par = pars[pit];
2041 result += par.asString(0, par.size(), label)
2042 + parbreak(inset().lyxCode());
2045 // Last paragraph in selection
2046 result += pars[endpit].asString(0, endpos, label);
2052 docstring Cursor::currentState() const
2055 odocstringstream os;
2061 return text()->currentState(*this);
2067 docstring Cursor::getPossibleLabel() const
2069 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2073 Encoding const * Cursor::getEncoding() const
2077 CursorSlice const & sl = innerTextSlice();
2078 Text const & text = *sl.text();
2079 Font font = text.getPar(sl.pit()).getFont(
2080 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2081 return font.language()->encoding();
2085 void Cursor::undispatched()
2087 disp_.dispatched(false);
2091 void Cursor::dispatched()
2093 disp_.dispatched(true);
2097 void Cursor::updateFlags(Update::flags f)
2103 void Cursor::noUpdate()
2105 disp_.update(Update::None);
2109 Font Cursor::getFont() const
2111 // The logic here should more or less match to the Cursor::setCurrentFont
2112 // logic, i.e. the cursor height should give a hint what will happen
2113 // if a character is entered.
2115 // HACK. far from being perfect...
2117 CursorSlice const & sl = innerTextSlice();
2118 Text const & text = *sl.text();
2119 Paragraph const & par = text.getPar(sl.pit());
2121 // on boundary, so we are really at the character before
2122 pos_type pos = sl.pos();
2123 if (pos > 0 && boundary())
2126 // on space? Take the font before (only for RTL boundary stay)
2128 TextMetrics const & tm = bv().textMetrics(&text);
2129 if (pos == sl.lastpos()
2130 || (par.isSeparator(pos)
2131 && !tm.isRTLBoundary(sl.pit(), pos)))
2135 // get font at the position
2136 Font font = par.getFont(buffer()->params(), pos,
2137 text.outerFont(sl.pit()));
2143 bool Cursor::fixIfBroken()
2145 bool const broken_cursor = DocIterator::fixIfBroken();
2146 bool const broken_anchor = anchor_.fixIfBroken();
2148 if (broken_cursor || broken_anchor) {
2156 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2158 // find inset in common
2160 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2161 if (&old[i].inset() != &cur[i].inset())
2165 // update words if we just moved to another paragraph
2166 if (i == old.depth() && i == cur.depth()
2167 && !cur.buffer()->isClean()
2168 && cur.inTexted() && old.inTexted()
2169 && cur.pit() != old.pit()) {
2170 old.paragraph().updateWords();
2173 // notify everything on top of the common part in old cursor,
2174 // but stop if the inset claims the cursor to be invalid now
2175 for (size_type j = i; j < old.depth(); ++j) {
2176 Cursor inset_pos = old;
2177 inset_pos.cutOff(j);
2178 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2182 // notify everything on top of the common part in new cursor,
2183 // but stop if the inset claims the cursor to be invalid now
2184 for (; i < cur.depth(); ++i) {
2185 if (cur[i].inset().notifyCursorEnters(cur))
2193 void Cursor::setCurrentFont()
2195 CursorSlice const & cs = innerTextSlice();
2196 Paragraph const & par = cs.paragraph();
2197 pos_type cpit = cs.pit();
2198 pos_type cpos = cs.pos();
2199 Text const & ctext = *cs.text();
2200 TextMetrics const & tm = bv().textMetrics(&ctext);
2202 // are we behind previous char in fact? -> go to that char
2203 if (cpos > 0 && boundary())
2206 // find position to take the font from
2208 // paragraph end? -> font of last char
2209 if (cpos == lastpos())
2211 // on space? -> look at the words in front of space
2212 else if (cpos > 0 && par.isSeparator(cpos)) {
2213 // abc| def -> font of c
2214 // abc |[WERBEH], i.e. boundary==true -> font of c
2215 // abc [WERBEH]| def, font of the space
2216 if (!tm.isRTLBoundary(cpit, cpos))
2222 BufferParams const & bufparams = buffer()->params();
2223 current_font = par.getFontSettings(bufparams, cpos);
2224 real_current_font = tm.displayFont(cpit, cpos);
2226 // special case for paragraph end
2227 if (cs.pos() == lastpos()
2228 && tm.isRTLBoundary(cpit, cs.pos())
2230 Language const * lang = par.getParLanguage(bufparams);
2231 current_font.setLanguage(lang);
2232 current_font.fontInfo().setNumber(FONT_OFF);
2233 real_current_font.setLanguage(lang);
2234 real_current_font.fontInfo().setNumber(FONT_OFF);
2239 bool Cursor::textUndo()
2241 DocIterator dit = *this;
2242 // Undo::textUndo() will modify dit.
2243 if (!buffer()->undo().textUndo(dit))
2253 bool Cursor::textRedo()
2255 DocIterator dit = *this;
2256 // Undo::textRedo() will modify dit.
2257 if (!buffer()->undo().textRedo(dit))
2267 void Cursor::finishUndo() const
2269 buffer()->undo().finishUndo();
2273 void Cursor::beginUndoGroup() const
2275 buffer()->undo().beginUndoGroup();
2279 void Cursor::endUndoGroup() const
2281 buffer()->undo().endUndoGroup();
2285 void Cursor::recordUndo(UndoKind kind, pit_type from, pit_type to) const
2287 buffer()->undo().recordUndo(*this, kind, from, to);
2291 void Cursor::recordUndo(UndoKind kind, pit_type from) const
2293 buffer()->undo().recordUndo(*this, kind, from);
2297 void Cursor::recordUndo(UndoKind kind) const
2299 buffer()->undo().recordUndo(*this, kind);
2303 void Cursor::recordUndoInset(UndoKind kind) const
2305 buffer()->undo().recordUndoInset(*this, kind);
2309 void Cursor::recordUndoFullDocument() const
2311 buffer()->undo().recordUndoFullDocument(*this);
2315 void Cursor::recordUndoSelection() const
2318 if (cap::multipleCellsSelected(*this))
2323 buffer()->undo().recordUndo(*this, ATOMIC_UNDO,
2324 selBegin().pit(), selEnd().pit());
2329 void Cursor::checkBufferStructure()
2331 Buffer const * master = buffer()->masterBuffer();
2332 master->tocBackend().updateItem(*this);
2333 if (master != buffer() && !master->hasGuiDelegate())
2334 // In case the master has no gui associated with it,
2335 // the TocItem is not updated (part of bug 5699).
2336 buffer()->tocBackend().updateItem(*this);