3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
7 * \author Alfredo Braunstein
8 * \author Dov Feldstern
10 * \author Stefan Schimanski
12 * Full author contact details are available in file CREDITS.
18 #include "BufferView.h"
19 #include "CoordCache.h"
21 #include "CutAndPaste.h"
22 #include "DispatchResult.h"
26 #include "FuncRequest.h"
29 #include "LyXAction.h"
31 #include "Paragraph.h"
32 #include "ParIterator.h"
35 #include "TextMetrics.h"
36 #include "TocBackend.h"
38 #include "support/debug.h"
39 #include "support/docstream.h"
40 #include "support/ExceptionMessage.h"
41 #include "support/gettext.h"
42 #include "support/lassert.h"
44 #include "insets/InsetTabular.h"
45 #include "insets/InsetText.h"
47 #include "mathed/InsetMath.h"
48 #include "mathed/InsetMathBrace.h"
49 #include "mathed/InsetMathScript.h"
50 #include "mathed/MacroTable.h"
51 #include "mathed/MathData.h"
52 #include "mathed/MathMacro.h"
54 #include "support/bind.h"
67 // Find position closest to (x, y) in cell given by iter.
68 // Used only in mathed
69 DocIterator bruteFind2(Cursor const & c, int x, int y)
71 double best_dist = numeric_limits<double>::max();
78 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
79 for (size_t i = 0;; ++i) {
82 Inset const * inset = &it.inset();
83 CoordCache const & cache = c.bv().coordCache();
85 // FIXME: in the case where the inset is not in the cache, this
86 // means that no part of it is visible on screen. In this case
87 // we don't do elaborate search and we just return the forwarded
88 // DocIterator at its beginning.
89 if (!cache.getInsets().has(inset)) {
94 Point const o = cache.getInsets().xy(inset);
95 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
96 // Convert to absolute
99 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
100 // '<=' in order to take the last possible position
101 // this is important for clicking behind \sum in e.g. '\sum_i a'
102 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
103 << " best: " << best_dist);
104 if (d <= best_dist) {
117 /// moves position closest to (x, y) in given box
118 bool bruteFind(Cursor & cursor,
119 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
121 LASSERT(!cursor.empty(), return false);
122 Inset & inset = cursor[0].inset();
123 BufferView & bv = cursor.bv();
125 CoordCache::InnerParPosCache const & cache =
126 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
127 // Get an iterator on the first paragraph in the cache
128 DocIterator it(inset);
129 it.push_back(CursorSlice(inset));
130 it.pit() = cache.begin()->first;
131 // Get an iterator after the last paragraph in the cache
132 DocIterator et(inset);
133 et.push_back(CursorSlice(inset));
134 et.pit() = prev(cache.end(), 1)->first;
135 if (et.pit() >= et.lastpit())
136 et = doc_iterator_end(inset);
140 double best_dist = numeric_limits<double>::max();
141 DocIterator best_cursor = et;
143 for ( ; it != et; it.forwardPos(true)) {
144 // avoid invalid nesting when selecting
145 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
146 Point p = bv.getPos(it, false);
149 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
150 double const dx = xo - x;
151 double const dy = yo - y;
152 double const d = dx * dx + dy * dy;
153 // '<=' in order to take the last possible position
154 // this is important for clicking behind \sum in e.g. '\sum_i a'
155 if (d <= best_dist) {
156 // lyxerr << "*" << endl;
164 if (best_cursor != et) {
165 cursor.setCursor(best_cursor);
174 /// moves position closest to (x, y) in given box
175 bool bruteFind3(Cursor & cur, int x, int y, bool up)
177 BufferView & bv = cur.bv();
178 int ylow = up ? 0 : y + 1;
179 int yhigh = up ? y - 1 : bv.workHeight();
181 int xhigh = bv.workWidth();
183 // FIXME: bit more work needed to get 'from' and 'to' right.
184 pit_type from = cur.bottom().pit();
185 //pit_type to = cur.bottom().pit();
186 //lyxerr << "Pit start: " << from << endl;
188 //lyxerr << "bruteFind3: x: " << x << " y: " << y
189 // << " xlow: " << xlow << " xhigh: " << xhigh
190 // << " ylow: " << ylow << " yhigh: " << yhigh
192 DocIterator it = doc_iterator_begin(cur.buffer());
194 DocIterator et = doc_iterator_end(cur.buffer());
196 double best_dist = numeric_limits<double>::max();
197 DocIterator best_cursor = et;
199 for ( ; it != et; it.forwardPos()) {
200 // avoid invalid nesting when selecting
201 if (bv.cursorStatus(it) == CUR_INSIDE
202 && (!cur.selection() || positionable(it, cur.realAnchor()))) {
203 // If this function is ever used again, check
204 // whether this is the same as "bv.getPos(it,
205 // false)" with boundary = false.
206 Point p = bv.getPos(it);
209 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
210 double const dx = xo - x;
211 double const dy = yo - y;
212 double const d = dx * dx + dy * dy;
213 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
214 // << " dx: " << dx << " dy: " << dy
215 // << " idx: " << it.idx() << " pos: " << it.pos()
218 // '<=' in order to take the last possible position
219 // this is important for clicking behind \sum in e.g. '\sum_i a'
220 if (d <= best_dist) {
221 //lyxerr << "*" << endl;
229 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
230 if (best_cursor == et)
232 cur.setCursor(best_cursor);
239 CursorData::CursorData()
240 : DocIterator(), anchor_(),
241 selection_(false), mark_(false), word_selection_(false),
242 logicalpos_(false), current_font(inherit_font),
243 autocorrect_(false), macromode_(false)
247 CursorData::CursorData(Buffer * buffer)
248 : DocIterator(buffer), anchor_(),
249 selection_(false), mark_(false), word_selection_(false),
250 logicalpos_(false), current_font(inherit_font),
251 autocorrect_(false), macromode_(false)
255 CursorData::CursorData(DocIterator const & dit)
256 : DocIterator(dit), anchor_(),
257 selection_(false), mark_(false), word_selection_(false),
258 logicalpos_(false), current_font(inherit_font),
259 autocorrect_(false), macromode_(false)
265 ostream & operator<<(ostream & os, CursorData const & cur)
267 os << "\n cursor: | anchor:\n";
268 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
269 os << " " << cur[i] << " | ";
270 if (i < cur.anchor_.depth())
271 os << cur.anchor_[i];
273 os << "-------------------------------";
276 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
277 os << "------------------------------- | " << cur.anchor_[i] << "\n";
279 os << " selection: " << cur.selection_
280 // << " x_target: " << cur.x_target_
281 << " boundary: " << cur.boundary() << endl;
286 LyXErr & operator<<(LyXErr & os, CursorData const & cur)
293 // be careful: this is called from the bv's constructor, too, so
294 // bv functions are not yet available!
295 Cursor::Cursor(BufferView & bv)
296 : CursorData(&bv.buffer()), bv_(&bv),
297 x_target_(-1), textTargetOffset_(0),
298 beforeDispatchPosX_(0), beforeDispatchPosY_(0)
305 push_back(CursorSlice(buffer()->inset()));
306 anchor_ = doc_iterator_begin(buffer());
308 new_word_ = doc_iterator_begin(buffer());
316 // this (intentionally) does neither touch anchor nor selection status
317 void Cursor::setCursor(DocIterator const & cur)
319 DocIterator::operator=(cur);
323 void Cursor::setCursorToAnchor()
326 DocIterator normal = anchor_;
327 while (depth() < normal.depth())
329 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
336 void Cursor::setCursorData(CursorData const & data)
338 CursorData::operator=(data);
342 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
346 // Try to fix cursor in case it is broken.
349 // Is this a function that acts on inset at point?
350 Inset * inset = cur.nextInset();
351 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
352 && inset && inset->getStatus(cur, cmd, status))
355 // This is, of course, a mess. Better create a new doc iterator and use
356 // this in Inset::getStatus. This might require an additional
357 // BufferView * arg, though (which should be avoided)
358 //Cursor safe = *this;
360 for ( ; cur.depth(); cur.pop()) {
361 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
362 // LASSERT: Is it safe to continue here, or should we return?
363 LASSERT(cur.idx() <= cur.lastidx(), /**/);
364 LASSERT(cur.pit() <= cur.lastpit(), /**/);
365 LASSERT(cur.pos() <= cur.lastpos(), /**/);
367 // The inset's getStatus() will return 'true' if it made
368 // a definitive decision on whether it want to handle the
369 // request or not. The result of this decision is put into
370 // the 'status' parameter.
371 if (cur.inset().getStatus(cur, cmd, status)) {
380 void Cursor::saveBeforeDispatchPosXY()
382 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
386 void Cursor::dispatch(FuncRequest const & cmd0)
388 LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
393 FuncRequest cmd = cmd0;
396 disp_ = DispatchResult();
400 // Is this a function that acts on inset at point?
401 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
403 disp_.dispatched(true);
404 disp_.screenUpdate(Update::FitCursor | Update::Force);
405 FuncRequest tmpcmd = cmd;
406 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
407 << cmd0 << endl << *this);
408 nextInset()->dispatch(*this, tmpcmd);
409 if (disp_.dispatched()) {
415 // store some values to be used inside of the handlers
416 beforeDispatchCursor_ = *this;
417 for (; depth(); pop(), boundary(false)) {
418 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
419 << cmd0 << endl << *this);
421 // In any of these cases, the cursor is invalid, and we should
422 // try to save this document rather than crash.
423 LBUFERR(pos() <= lastpos());
424 LBUFERR(idx() <= lastidx());
425 LBUFERR(pit() <= lastpit());
427 // The common case is 'LFUN handled, need update', so make the
428 // LFUN handler's life easier by assuming this as default value.
429 // The handler can reset the update and val flags if necessary.
430 disp_.screenUpdate(Update::FitCursor | Update::Force);
431 disp_.dispatched(true);
432 inset().dispatch(*this, cmd);
433 if (disp_.dispatched())
437 // it completely to get a 'bomb early' behaviour in case this
438 // object will be used again.
439 if (!disp_.dispatched()) {
440 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
441 // We might have invalidated the cursor when removing an empty
442 // paragraph while the cursor could not be moved out the inset
443 // while we initially thought we could. This might happen when
444 // a multiline inset becomes an inline inset when the second
445 // paragraph is removed.
446 if (safe.pit() > safe.lastpit()) {
447 safe.pit() = safe.lastpit();
448 safe.pos() = safe.lastpos();
451 disp_.screenUpdate(Update::None);
452 disp_.dispatched(false);
454 // restore the previous one because nested Cursor::dispatch calls
455 // are possible which would change it
456 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
460 // NOTE: The code below has been copied to BufferView::dispatch.
461 // If you need to modify this, please update the other one too.
463 // notify insets we just left
465 old.beginUndoGroup();
467 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
470 bv().resetInlineCompletionPos();
477 DispatchResult const & Cursor::result() const
483 BufferView & Cursor::bv() const
492 LBUFERR(depth() >= 1);
497 void Cursor::push(Inset & p)
499 push_back(CursorSlice(p));
500 p.setBuffer(*buffer());
504 void Cursor::pushBackward(Inset & p)
506 LASSERT(!empty(), return);
507 //lyxerr << "Entering inset " << t << " front" << endl;
513 bool Cursor::popBackward()
515 LASSERT(!empty(), return false);
523 bool Cursor::popForward()
525 LASSERT(!empty(), return false);
526 //lyxerr << "Leaving inset from in back" << endl;
527 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
531 pos() += lastpos() - lp + 1;
536 int Cursor::currentMode()
538 LASSERT(!empty(), return Inset::UNDECIDED_MODE);
539 for (int i = depth() - 1; i >= 0; --i) {
540 int res = operator[](i).inset().currentMode();
541 bool locked_mode = operator[](i).inset().lockedMode();
542 // Also return UNDECIDED_MODE when the mode is locked,
543 // as in this case it is treated the same as TEXT_MODE
544 if (res != Inset::UNDECIDED_MODE || locked_mode)
547 return Inset::TEXT_MODE;
551 bool Cursor::inCoordCache() const
553 CoordCache::Insets const & icache = bv_->coordCache().getInsets();
554 for (size_t i = 0 ; i < depth() ; ++i)
555 if (!icache.has(&(*this)[i].inset()))
561 void Cursor::getPos(int & x, int & y) const
563 Point p = bv().getPos(*this);
569 Row const & Cursor::textRow() const
571 CursorSlice const & cs = innerTextSlice();
572 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
573 return pm.getRow(pos(), boundary());
577 void Cursor::resetAnchor()
580 checkNewWordPosition();
584 void Cursor::markNewWordPosition()
586 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
587 FontSpan nw = locateWord(WHOLE_WORD);
588 if (nw.size() == 1) {
589 LYXERR(Debug::DEBUG, "start new word: "
591 << " pos: " << nw.first);
598 void Cursor::clearNewWordPosition()
600 if (!new_word_.empty()) {
601 LYXERR(Debug::DEBUG, "clear new word: "
603 << " pos: " << pos());
609 void Cursor::checkNewWordPosition()
611 if (!lyxrc.spellcheck_continuously || new_word_.empty())
614 clearNewWordPosition();
616 // forget the position of the current new word if
617 // 1) the paragraph changes or
618 // 2) the count of nested insets changes or
619 // 3) the cursor pos is out of paragraph bound
620 if (pit() != new_word_.pit() ||
621 depth() != new_word_.depth() ||
622 new_word_.pos() > new_word_.lastpos()) {
623 clearNewWordPosition();
624 } else if (new_word_.fixIfBroken())
625 // 4) or the remembered position was "broken"
626 clearNewWordPosition();
628 FontSpan nw = locateWord(WHOLE_WORD);
630 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
631 if (nw.intersect(ow).empty())
632 clearNewWordPosition();
634 LYXERR(Debug::DEBUG, "new word: "
636 << " pos: " << nw.first << ".." << nw.last);
638 clearNewWordPosition();
645 bool Cursor::posBackward()
654 bool Cursor::posForward()
656 if (pos() == lastpos())
663 bool Cursor::posVisRight(bool skip_inset)
665 Cursor new_cur = *this; // where we will move to
666 pos_type left_pos; // position visually left of current cursor
667 pos_type right_pos; // position visually right of current cursor
669 getSurroundingPos(left_pos, right_pos);
671 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
673 // Are we at an inset?
674 new_cur.pos() = right_pos;
675 new_cur.boundary(false);
677 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
678 // we actually move the cursor at the end of this
679 // function, for now we just keep track of the new
680 // position in new_cur...
681 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
684 // Are we already at rightmost pos in row?
685 else if (text()->empty() || right_pos == -1) {
688 if (!new_cur.posVisToNewRow(false)) {
689 LYXERR(Debug::RTL, "not moving!");
693 // we actually move the cursor at the end of this
694 // function, for now just keep track of the new
695 // position in new_cur...
696 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
697 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
700 // normal movement to the right
703 // Recall, if the cursor is at position 'x', that
704 // means *before* the character at position 'x'. In
705 // RTL, "before" means "to the right of", in LTR, "to
706 // the left of". So currently our situation is this:
707 // the position to our right is 'right_pos' (i.e.,
708 // we're currently to the left of 'right_pos'). In
709 // order to move to the right, it depends whether or
710 // not the character at 'right_pos' is RTL.
711 bool const new_pos_is_RTL = paragraph().getFontSettings(
712 buffer()->params(), right_pos).isVisibleRightToLeft();
713 // If the character at 'right_pos' *is* LTR, then in
714 // order to move to the right of it, we need to be
715 // *after* 'right_pos', i.e., move to position
717 if (!new_pos_is_RTL) {
718 new_cur.pos() = right_pos + 1;
719 // set the boundary to true in two situations:
721 // 1. if new_pos is now lastpos, and we're in
722 // an RTL paragraph (this means that we're
723 // moving right to the end of an LTR chunk
724 // which is at the end of an RTL paragraph);
725 (new_cur.pos() == lastpos()
726 && paragraph().isRTL(buffer()->params()))
727 // 2. if the position *after* right_pos is RTL
728 // (we want to be *after* right_pos, not
729 // before right_pos + 1!)
730 || paragraph().getFontSettings(buffer()->params(),
731 new_cur.pos()).isVisibleRightToLeft()
733 new_cur.boundary(true);
734 else // set the boundary to false
735 new_cur.boundary(false);
737 // Otherwise (if the character at position 'right_pos'
738 // is RTL), then moving to the right of it is as easy
739 // as setting the new position to 'right_pos'.
741 new_cur.pos() = right_pos;
742 new_cur.boundary(false);
747 bool moved = (new_cur.pos() != pos()
748 || new_cur.pit() != pit()
749 || new_cur.boundary() != boundary()
750 || &new_cur.inset() != &inset());
753 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
754 << (new_cur.boundary() ? " (boundary)" : ""));
762 bool Cursor::posVisLeft(bool skip_inset)
764 Cursor new_cur = *this; // where we will move to
765 pos_type left_pos; // position visually left of current cursor
766 pos_type right_pos; // position visually right of current cursor
768 getSurroundingPos(left_pos, right_pos);
770 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
772 // Are we at an inset?
773 new_cur.pos() = left_pos;
774 new_cur.boundary(false);
776 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
777 // we actually move the cursor at the end of this
778 // function, for now we just keep track of the new
779 // position in new_cur...
780 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
783 // Are we already at leftmost pos in row?
784 else if (text()->empty() || left_pos == -1) {
787 if (!new_cur.posVisToNewRow(true)) {
788 LYXERR(Debug::RTL, "not moving!");
792 // we actually move the cursor at the end of this
793 // function, for now just keep track of the new
794 // position in new_cur...
795 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
796 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
799 // normal movement to the left
802 // Recall, if the cursor is at position 'x', that
803 // means *before* the character at position 'x'. In
804 // RTL, "before" means "to the right of", in LTR, "to
805 // the left of". So currently our situation is this:
806 // the position to our left is 'left_pos' (i.e., we're
807 // currently to the right of 'left_pos'). In order to
808 // move to the left, it depends whether or not the
809 // character at 'left_pos' is RTL.
810 bool const new_pos_is_RTL = paragraph().getFontSettings(
811 buffer()->params(), left_pos).isVisibleRightToLeft();
812 // If the character at 'left_pos' *is* RTL, then in
813 // order to move to the left of it, we need to be
814 // *after* 'left_pos', i.e., move to position
816 if (new_pos_is_RTL) {
817 new_cur.pos() = left_pos + 1;
818 // set the boundary to true in two situations:
820 // 1. if new_pos is now lastpos and we're in
821 // an LTR paragraph (this means that we're
822 // moving left to the end of an RTL chunk
823 // which is at the end of an LTR paragraph);
824 (new_cur.pos() == lastpos()
825 && !paragraph().isRTL(buffer()->params()))
826 // 2. if the position *after* left_pos is not
827 // RTL (we want to be *after* left_pos, not
828 // before left_pos + 1!)
829 || !paragraph().getFontSettings(buffer()->params(),
830 new_cur.pos()).isVisibleRightToLeft()
832 new_cur.boundary(true);
833 else // set the boundary to false
834 new_cur.boundary(false);
836 // Otherwise (if the character at position 'left_pos'
837 // is LTR), then moving to the left of it is as easy
838 // as setting the new position to 'left_pos'.
840 new_cur.pos() = left_pos;
841 new_cur.boundary(false);
846 bool moved = (new_cur.pos() != pos()
847 || new_cur.pit() != pit()
848 || new_cur.boundary() != boundary());
851 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
852 << (new_cur.boundary() ? " (boundary)" : ""));
862 // Return true on success
863 bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
866 while (cit != row.begin() && cit->isVirtual())
869 while (cit != row.end() && cit->isVirtual())
872 return cit != row.end() && !cit->isVirtual();
877 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
879 // by default, we know nothing.
883 Row const & row = textRow();
884 TextMetrics const & tm = bv_->textMetrics(text());
886 Row::const_iterator cit = tm.findRowElement(row, pos(), boundary(), dummy);
887 // Handle the case of empty row
888 if (cit == row.end()) {
889 if (paragraph().isRTL(buffer()->params()))
890 right_pos = row.pos();
892 left_pos = row.pos() - 1;
896 // skip virtual elements and exit if no non-virtual one exists
897 if (!findNonVirtual(row, cit, !cit->isRTL()))
900 // if the position is at the left side of the element, we have to
901 // look at the previous element
902 if (pos() == cit->left_pos()) {
903 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
904 << "), AT LEFT of *cit=" << *cit);
905 // this one is easy (see common case below)
906 right_pos = pos() - (cit->isRTL() ? 1 : 0);
907 // at the left of the row
908 if (cit == row.begin())
911 if (!findNonVirtual(row, cit, true))
913 // [...[ is the row element, | is cursor position (! with boundary)
914 // [ 1 2 [ is a ltr row element with pos=1 and endpos=3
915 // ] 2 1] is an rtl row element with pos=1 and endpos=3
916 // [ 1 2 [ [|3 4 [ => (2, 3)
917 // or [ 1 2 [ ]!4 3 ] => (2, 4)
918 // or ] 2 1 ] [|3 4 [ => (1, 3)
919 // or ] 4 3 ] ]!2 1 ] => (3, 2)
920 left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
921 // happens with consecutive row of same direction
922 if (left_pos == right_pos) {
923 left_pos += cit->isRTL() ? 1 : -1;
926 // same code but with the element at the right
927 else if (pos() == cit->right_pos()) {
928 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
929 << "), AT RIGHT of *cit=" << *cit);
930 // this one is easy (see common case below)
931 left_pos = pos() - (cit->isRTL() ? 0 : 1);
932 // at the right of the row
933 if (cit + 1 == row.end())
936 if (!findNonVirtual(row, cit, false))
938 // [ 1 2![ [ 3 4 [ => (2, 3)
939 // or [ 1 2![ ] 4 3 ] => (2, 4)
940 // or ] 2 1|] [ 3 4 [ => (1, 3)
941 // or ] 4 3|] ] 2 1 ] => (3, 2)
942 right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
943 // happens with consecutive row of same direction
944 if (right_pos == left_pos)
945 right_pos += cit->isRTL() ? -1 : 1;
947 // common case: both positions are inside the row element
949 // [ 1 2|3 [ => (2, 3)
950 // or ] 3|2 1 ] => (3, 2)
951 left_pos = pos() - (cit->isRTL() ? 0 : 1);
952 right_pos = pos() - (cit->isRTL() ? 1 : 0);
955 // Note that debug message does not catch all early returns above
956 LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
957 << ") => (" << left_pos << ", " << right_pos <<")");
961 bool Cursor::posVisToNewRow(bool movingLeft)
963 Paragraph const & par = paragraph();
964 Buffer const & buf = *buffer();
965 Row const & row = textRow();
966 bool par_is_LTR = !par.isRTL(buf.params());
968 // Inside a table, determining whether to move to the next or
969 // previous row should be done based on the table's direction.
970 if (inset().asInsetTabular()) {
971 par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
972 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
975 // if moving left in an LTR paragraph or moving right in an
976 // RTL one, move to previous row
977 if (par_is_LTR == movingLeft) {
978 if (row.pos() == 0) { // we're at first row in paragraph
979 if (pit() == 0) // no previous paragraph! don't move
981 // move to last pos in previous par
985 } else { // move to previous row in this par
986 pos() = row.pos() - 1; // this is guaranteed to be in previous row
990 // if moving left in an RTL paragraph or moving right in an
991 // LTR one, move to next row
993 if (row.endpos() == lastpos()) { // we're at last row in paragraph
994 if (pit() == lastpit()) // last paragraph! don't move
996 // move to first row in next par
1000 } else { // move to next row in this par
1001 pos() = row.endpos();
1006 // make sure we're at left-/right-most pos in new row
1007 posVisToRowExtremity(!movingLeft);
1013 void Cursor::posVisToRowExtremity(bool left)
1015 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
1016 << (boundary() ? 1 : 0));
1018 TextMetrics const & tm = bv_->textMetrics(text());
1019 // Looking for extremities is like clicking on the left or the
1020 // right of the row.
1021 int x = tm.origin().x_ + (left ? 0 : textRow().width());
1023 pos() = tm.getPosNearX(textRow(), x, b);
1026 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1027 << (boundary() ? 1 : 0));
1031 bool Cursor::reverseDirectionNeeded() const
1034 * We determine the directions based on the direction of the
1035 * bottom() --- i.e., outermost --- paragraph, because that is
1036 * the only way to achieve consistency of the arrow's movements
1037 * within a paragraph, and thus avoid situations in which the
1038 * cursor gets stuck.
1040 return bottom().paragraph().isRTL(bv().buffer().params());
1044 CursorSlice Cursor::normalAnchor() const
1048 // LASSERT: There have been several bugs around this code, that seem
1049 // to involve failures to reset the anchor. We can at least not crash
1050 // in release mode by resetting it ourselves.
1051 LASSERT(anchor_.depth() >= depth(),
1052 const_cast<DocIterator &>(anchor_) = *this);
1054 CursorSlice normal = anchor_[depth() - 1];
1055 if (depth() < anchor_.depth() && top() <= normal) {
1056 // anchor is behind cursor -> move anchor behind the inset
1063 DocIterator & Cursor::realAnchor()
1069 CursorSlice Cursor::selBegin() const
1073 return normalAnchor() < top() ? normalAnchor() : top();
1077 CursorSlice Cursor::selEnd() const
1081 return normalAnchor() > top() ? normalAnchor() : top();
1085 DocIterator Cursor::selectionBegin() const
1091 // FIXME: This is a work-around for the problem that
1092 // CursorSlice doesn't keep track of the boundary.
1093 if (normalAnchor() == top())
1094 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1096 di = normalAnchor() < top() ? anchor_ : *this;
1102 DocIterator Cursor::selectionEnd() const
1108 // FIXME: This is a work-around for the problem that
1109 // CursorSlice doesn't keep track of the boundary.
1110 if (normalAnchor() == top())
1111 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1113 di = normalAnchor() > top() ? anchor_ : *this;
1115 if (di.depth() > depth()) {
1123 void Cursor::setSelection()
1126 if (idx() == normalAnchor().idx() &&
1127 pit() == normalAnchor().pit() &&
1128 pos() == normalAnchor().pos())
1129 setSelection(false);
1133 void Cursor::setSelection(DocIterator const & where, int n)
1142 void Cursor::clearSelection()
1144 setSelection(false);
1145 setWordSelection(false);
1151 void Cursor::setTargetX(int x)
1154 textTargetOffset_ = 0;
1158 int Cursor::x_target() const
1164 void Cursor::clearTargetX()
1167 textTargetOffset_ = 0;
1171 void Cursor::updateTextTargetOffset()
1176 textTargetOffset_ = x - x_target_;
1180 void Cursor::info(odocstream & os) const
1182 for (int i = 1, n = depth(); i < n; ++i) {
1183 operator[](i).inset().infoize(os);
1187 Inset const * inset = prevInset();
1188 // prevInset() can return 0 in certain case.
1190 prevInset()->infoize2(os);
1195 bool Cursor::selHandle(bool sel)
1197 //lyxerr << "Cursor::selHandle" << endl;
1200 if (sel == selection())
1204 cap::saveSelection(*this);
1213 ///////////////////////////////////////////////////////////////////
1216 // The part below is the non-integrated rest of the original math
1217 // cursor. This should be either generalized for texted or moved
1218 // back to mathed (in most cases to InsetMathNest).
1220 ///////////////////////////////////////////////////////////////////
1222 #include "mathed/InsetMathChar.h"
1223 #include "mathed/InsetMathGrid.h"
1224 #include "mathed/InsetMathScript.h"
1225 #include "mathed/InsetMathUnknown.h"
1226 #include "mathed/MathFactory.h"
1227 #include "mathed/MathStream.h"
1228 #include "mathed/MathSupport.h"
1233 bool Cursor::isInside(Inset const * p) const
1235 for (size_t i = 0; i != depth(); ++i)
1236 if (&operator[](i).inset() == p)
1242 void Cursor::leaveInset(Inset const & inset)
1244 for (size_t i = 0; i != depth(); ++i) {
1245 if (&operator[](i).inset() == &inset) {
1253 bool Cursor::openable(MathAtom const & t) const
1264 // we can't move into anything new during selection
1265 if (depth() >= anchor_.depth())
1267 if (t.nucleus() != &anchor_[depth()].inset())
1274 void Cursor::setScreenPos(int x, int /*y*/)
1277 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1282 void Cursor::plainErase()
1284 cell().erase(pos());
1288 void Cursor::markInsert()
1290 insert(char_type(0));
1294 void Cursor::markErase()
1296 cell().erase(pos());
1300 void Cursor::plainInsert(MathAtom const & t)
1302 cell().insert(pos(), t);
1304 inset().setBuffer(bv_->buffer());
1306 checkBufferStructure();
1310 void Cursor::insert(docstring const & str)
1312 for_each(str.begin(), str.end(),
1313 bind(static_cast<void(Cursor::*)(char_type)>
1314 (&Cursor::insert), this, _1));
1318 void Cursor::insert(char_type c)
1320 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1321 LASSERT(!empty(), return);
1323 cap::selClearOrDel(*this);
1324 insert(new InsetMathChar(c));
1326 text()->insertChar(*this, c);
1331 void Cursor::insert(MathAtom const & t)
1333 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1335 cap::selClearOrDel(*this);
1340 void Cursor::insert(Inset * inset0)
1342 LASSERT(inset0, return);
1344 insert(MathAtom(inset0->asInsetMath()));
1346 text()->insertInset(*this, inset0);
1347 inset0->setBuffer(bv_->buffer());
1349 if (inset0->isLabeled())
1350 forceBufferUpdate();
1355 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1357 MathData ar(buffer());
1359 if (ar.size() == 1 && (enter || selection()))
1367 void Cursor::niceInsert(MathAtom const & t)
1370 docstring const safe = cap::grabAndEraseSelection(*this);
1372 // If possible, enter the new inset and move the contents of the selection
1373 if (t->isActive()) {
1375 // be careful here: don't use 'pushBackward(t)' as this we need to
1376 // push the clone, not the original
1377 pushBackward(*nextInset());
1378 // We may not use niceInsert here (recursion)
1379 MathData ar(buffer());
1382 } else if (t->asMacro() && !safe.empty()) {
1383 MathData ar(buffer());
1385 docstring const name = t->asMacro()->name();
1386 MacroData const * data = buffer()->getMacro(name);
1387 if (data && data->numargs() - data->optionals() > 0) {
1388 plainInsert(MathAtom(new InsetMathBrace(ar)));
1395 void Cursor::insert(MathData const & ar)
1399 cap::eraseSelection(*this);
1400 cell().insert(pos(), ar);
1402 // FIXME audit setBuffer calls
1403 inset().setBuffer(bv_->buffer());
1407 bool Cursor::backspace()
1410 cap::eraseSelection(*this);
1415 // If empty cell, and not part of a big cell
1416 if (lastpos() == 0 && inset().nargs() == 1) {
1418 // Directly delete empty cell: [|[]] => [|]
1424 // [|], can not delete from inside
1435 if (inMacroMode()) {
1436 InsetMathUnknown * p = activeMacro();
1437 if (p->name().size() > 1) {
1438 p->setName(p->name().substr(0, p->name().size() - 1));
1443 if (pos() != 0 && prevAtom()->nargs() > 0) {
1444 // let's require two backspaces for 'big stuff' and
1445 // highlight on the first
1457 bool Cursor::erase()
1463 cap::eraseSelection(*this);
1467 // delete empty cells if possible
1468 if (pos() == lastpos() && inset().idxDelete(idx()))
1471 // special behaviour when in last position of cell
1472 if (pos() == lastpos()) {
1473 bool one_cell = inset().nargs() == 1;
1474 if (one_cell && lastpos() == 0) {
1476 // Directly delete empty cell: [|[]] => [|]
1482 // [|], can not delete from inside
1487 inset().idxGlue(idx());
1491 // 'clever' UI hack: only erase large items if previously slected
1492 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1507 DocIterator save = *this;
1508 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1509 this->dispatch(cmd);
1510 if (disp_.dispatched())
1520 DocIterator save = *this;
1521 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1522 this->dispatch(cmd);
1523 if (disp_.dispatched())
1530 bool Cursor::macroModeClose()
1534 InsetMathUnknown * p = activeMacro();
1536 MathData selection(buffer());
1537 asArray(p->selection(), selection);
1538 docstring const s = p->name();
1540 cell().erase(pos());
1542 // do nothing if the macro name is empty
1546 // trigger updates of macros, at least, if no full
1547 // updates take place anyway
1548 screenUpdateFlags(Update::Force);
1550 docstring const name = s.substr(1);
1551 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1552 if (in && in->interpretString(*this, s))
1554 MathAtom atom = buffer()->getMacro(name, *this, false) ?
1555 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1557 // try to put argument into macro, if we just inserted a macro
1558 bool macroArg = false;
1559 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1561 // macros here are still unfolded (in init mode in fact). So
1562 // we have to resolve the macro here manually and check its arity
1563 // to put the selection behind it if arity > 0.
1564 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1565 if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
1567 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1569 // non-greedy case. Do not touch the arguments behind
1570 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1573 // insert remembered selection into first argument of a non-macro
1574 else if (atom.nucleus()->nargs() > 0)
1575 atom.nucleus()->cell(0).append(selection);
1579 // finally put the macro argument behind, if needed
1581 if (selection.size() > 1 || selection[0]->asScriptInset())
1582 plainInsert(MathAtom(new InsetMathBrace(selection)));
1591 docstring Cursor::macroName()
1593 return inMacroMode() ? activeMacro()->name() : docstring();
1597 void Cursor::handleNest(MathAtom const & a, int c)
1599 //lyxerr << "Cursor::handleNest: " << c << endl;
1601 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1604 pushBackward(*nextInset());
1608 int Cursor::targetX() const
1610 if (x_target() != -1)
1619 int Cursor::textTargetOffset() const
1621 return textTargetOffset_;
1625 void Cursor::setTargetX()
1634 bool Cursor::inMacroMode() const
1638 if (pos() == 0 || cell().empty())
1640 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1641 return p && !p->final();
1645 InsetMathUnknown * Cursor::activeMacro()
1647 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1651 InsetMathUnknown const * Cursor::activeMacro() const
1653 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1657 void Cursor::pullArg()
1660 MathData ar = cell();
1661 if (popBackward() && inMathed()) {
1663 cell().insert(pos(), ar);
1666 //formula()->mutateToText();
1671 void Cursor::touch()
1675 DocIterator::const_iterator it = begin();
1676 DocIterator::const_iterator et = end();
1677 for ( ; it != et; ++it)
1683 void Cursor::normalize()
1685 if (idx() > lastidx()) {
1686 lyxerr << "this should not really happen - 1: "
1687 << idx() << ' ' << nargs()
1688 << " in: " << &inset() << endl;
1692 if (pos() > lastpos()) {
1693 lyxerr << "this should not really happen - 2: "
1694 << pos() << ' ' << lastpos() << " in idx: " << idx()
1696 odocstringstream os;
1697 TexRow texrow(false);
1698 otexrowstream ots(os,texrow);
1699 WriteStream wi(ots, false, true, WriteStream::wsDefault);
1700 inset().asInsetMath()->write(wi);
1701 lyxerr << to_utf8(os.str()) << endl;
1707 bool Cursor::upDownInMath(bool up)
1709 // Be warned: The 'logic' implemented in this function is highly
1710 // fragile. A distance of one pixel or a '<' vs '<=' _really
1711 // matters. So fiddle around with it only if you think you know
1712 // what you are doing!
1716 xo = beforeDispatchPosX_;
1718 // check if we had something else in mind, if not, this is the future
1720 if (x_target_ == -1)
1722 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1723 // In text mode inside the line (not left or right) possibly set a new target_x,
1724 // but only if we are somewhere else than the previous target-offset.
1726 // We want to keep the x-target on subsequent up/down movements
1727 // that cross beyond the end of short lines. Thus a special
1728 // handling when the cursor is at the end of line: Use the new
1729 // x-target only if the old one was before the end of line
1730 // or the old one was after the beginning of the line
1731 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1735 left = pos() == textRow().endpos();
1736 right = pos() == textRow().pos();
1738 left = pos() == textRow().pos();
1739 right = pos() == textRow().endpos();
1741 if ((!left && !right) ||
1742 (left && !right && xo < x_target_) ||
1743 (!left && right && x_target_ < xo))
1750 // try neigbouring script insets
1752 if (inMathed() && !selection()) {
1755 InsetMathScript const * p = prevAtom()->asScriptInset();
1756 if (p && p->has(up)) {
1758 push(*const_cast<InsetMathScript*>(p));
1759 idx() = p->idxOfScript(up);
1762 // we went in the right direction? Otherwise don't jump into the script
1766 int oy = beforeDispatchPosY_;
1767 if ((!up && y <= oy) ||
1776 if (pos() != lastpos()) {
1777 InsetMathScript const * p = nextAtom()->asScriptInset();
1778 if (p && p->has(up)) {
1779 push(*const_cast<InsetMathScript*>(p));
1780 idx() = p->idxOfScript(up);
1783 // we went in the right direction? Otherwise don't jump into the script
1787 int oy = beforeDispatchPosY_;
1788 if ((!up && y <= oy) ||
1797 // try to find an inset that knows better then we,
1798 if (inset().idxUpDown(*this, up)) {
1799 //lyxerr << "idxUpDown triggered" << endl;
1800 // try to find best position within this inset
1802 setCursor(bruteFind2(*this, xo, yo));
1806 // any improvement going just out of inset?
1807 if (popBackward() && inMathed()) {
1808 //lyxerr << "updown: popBackward succeeded" << endl;
1811 int yold = beforeDispatchPosY_;
1813 if (up ? ynew < yold : ynew > yold)
1817 // no success, we are probably at the document top or bottom
1823 bool Cursor::atFirstOrLastRow(bool up)
1825 TextMetrics const & tm = bv_->textMetrics(text());
1826 ParagraphMetrics const & pm = tm.parMetrics(pit());
1829 if (pos() && boundary())
1830 row = pm.pos2row(pos() - 1);
1832 row = pm.pos2row(pos());
1835 if (pit() == 0 && row == 0)
1838 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1839 row + 1 >= int(pm.rows().size()))
1846 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1848 LASSERT(text(), return false);
1854 xo = beforeDispatchPosX_;
1856 // update the targetX - this is here before the "return false"
1857 // to set a new target which can be used by InsetTexts above
1858 // if we cannot move up/down inside this inset anymore
1859 if (x_target_ == -1)
1861 else if (xo - textTargetOffset() != x_target() &&
1862 depth() == beforeDispatchCursor_.depth()) {
1863 // In text mode inside the line (not left or right)
1864 // possibly set a new target_x, but only if we are
1865 // somewhere else than the previous target-offset.
1867 // We want to keep the x-target on subsequent up/down
1868 // movements that cross beyond the end of short lines.
1869 // Thus a special handling when the cursor is at the
1870 // end of line: Use the new x-target only if the old
1871 // one was before the end of line or the old one was
1872 // after the beginning of the line
1873 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1877 left = pos() == textRow().endpos();
1878 right = pos() == textRow().pos();
1880 left = pos() == textRow().pos();
1881 right = pos() == textRow().endpos();
1883 if ((!left && !right) ||
1884 (left && !right && xo < x_target_) ||
1885 (!left && right && x_target_ < xo))
1892 // first get the current line
1893 TextMetrics & tm = bv_->textMetrics(text());
1894 ParagraphMetrics const & pm = tm.parMetrics(pit());
1896 if (pos() && boundary())
1897 row = pm.pos2row(pos() - 1);
1899 row = pm.pos2row(pos());
1901 if (atFirstOrLastRow(up)) {
1902 // Is there a place for the cursor to go ? If yes, we
1903 // can execute the DEPM, otherwise we should keep the
1904 // paragraph to host the cursor.
1905 Cursor dummy = *this;
1906 bool valid_destination = false;
1907 for(; dummy.depth(); dummy.pop())
1908 if (!dummy.atFirstOrLastRow(up)) {
1909 valid_destination = true;
1913 // will a next dispatch follow and if there is a new
1914 // dispatch will it move the cursor out ?
1915 if (depth() > 1 && valid_destination) {
1916 // The cursor hasn't changed yet. This happens when
1917 // you e.g. move out of an inset. And to give the
1918 // DEPM the possibility of doing something we must
1919 // provide it with two different cursors. (Lgb, vfr)
1921 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1922 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1924 updateNeeded |= bv().checkDepm(dummy, *this);
1925 updateTextTargetOffset();
1927 forceBufferUpdate();
1932 // with and without selection are handled differently
1934 int yo = bv().getPos(*this).y_;
1936 // To next/previous row
1938 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1940 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1943 // This happens when you move out of an inset.
1944 // And to give the DEPM the possibility of doing
1945 // something we must provide it with two different
1947 Cursor dummy = *this;
1950 if (bv().checkDepm(dummy, old)) {
1951 updateNeeded = true;
1952 // Make sure that cur gets back whatever happened to dummy (Lgb)
1956 // if there is a selection, we stay out of any inset,
1957 // and just jump to the right position:
1963 } else if (pit() > 0) {
1965 TextMetrics & tm = bv_->textMetrics(text());
1966 if (!tm.contains(pit()))
1967 tm.newParMetricsUp();
1968 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1969 next_row = pmcur.rows().size() - 1;
1972 if (row + 1 < int(pm.rows().size())) {
1974 } else if (pit() + 1 < int(text()->paragraphs().size())) {
1976 TextMetrics & tm = bv_->textMetrics(text());
1977 if (!tm.contains(pit()))
1978 tm.newParMetricsDown();
1983 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
1985 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
1988 updateNeeded |= bv().checkDepm(*this, old);
1992 forceBufferUpdate();
1993 updateTextTargetOffset();
1998 void Cursor::handleFont(string const & font)
2000 LYXERR(Debug::DEBUG, font);
2004 safe = cap::grabAndEraseSelection(*this);
2009 if (lastpos() != 0) {
2010 // something left in the cell
2012 // cursor in first position
2014 } else if (pos() == lastpos()) {
2015 // cursor in last position
2018 // cursor in between. split cell
2019 MathData::iterator bt = cell().begin();
2020 MathAtom at = createInsetMath(from_utf8(font), buffer());
2021 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2022 cell().erase(bt, bt + pos());
2027 // nothing left in the cell
2036 void Cursor::message(docstring const & msg) const
2038 disp_.setMessage(msg);
2042 void Cursor::errorMessage(docstring const & msg) const
2044 disp_.setMessage(msg);
2045 disp_.setError(true);
2051 docstring parbreak(Cursor const * cur)
2053 odocstringstream os;
2055 // only add blank line if we're not in a ParbreakIsNewline situation
2056 if (!cur->inset().getLayout().parbreakIsNewline()
2057 && !cur->paragraph().layout().parbreak_is_newline)
2065 docstring Cursor::selectionAsString(bool with_label) const
2071 return cap::grabSelection(*this);
2073 int const label = with_label
2074 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2076 idx_type const startidx = selBegin().idx();
2077 idx_type const endidx = selEnd().idx();
2078 if (startidx != endidx) {
2079 // multicell selection
2080 InsetTabular * table = inset().asInsetTabular();
2081 LASSERT(table, return docstring());
2082 return table->asString(startidx, endidx);
2085 ParagraphList const & pars = text()->paragraphs();
2087 pit_type const startpit = selBegin().pit();
2088 pit_type const endpit = selEnd().pit();
2089 size_t const startpos = selBegin().pos();
2090 size_t const endpos = selEnd().pos();
2092 if (startpit == endpit)
2093 return pars[startpit].asString(startpos, endpos, label);
2095 // First paragraph in selection
2096 docstring result = pars[startpit].
2097 asString(startpos, pars[startpit].size(), label)
2100 // The paragraphs in between (if any)
2101 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2102 Paragraph const & par = pars[pit];
2103 result += par.asString(0, par.size(), label)
2107 // Last paragraph in selection
2108 result += pars[endpit].asString(0, endpos, label);
2114 docstring Cursor::currentState() const
2117 odocstringstream os;
2119 #ifdef DEVEL_VERSION
2120 InsetMath * math = inset().asInsetMath();
2122 os << _(", Inset: ") << math->id();
2123 os << _(", Cell: ") << idx();
2124 os << _(", Position: ") << pos();
2130 return text()->currentState(*this);
2136 docstring Cursor::getPossibleLabel() const
2138 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2142 Encoding const * Cursor::getEncoding() const
2146 CursorSlice const & sl = innerTextSlice();
2147 Text const & text = *sl.text();
2148 Font font = text.getPar(sl.pit()).getFont(
2149 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2150 return font.language()->encoding();
2154 void Cursor::undispatched() const
2156 disp_.dispatched(false);
2160 void Cursor::dispatched() const
2162 disp_.dispatched(true);
2166 void Cursor::screenUpdateFlags(Update::flags f) const
2168 disp_.screenUpdate(f);
2172 void Cursor::forceBufferUpdate() const
2174 disp_.forceBufferUpdate();
2178 void Cursor::clearBufferUpdate() const
2180 disp_.clearBufferUpdate();
2184 bool Cursor::needBufferUpdate() const
2186 return disp_.needBufferUpdate();
2190 void Cursor::noScreenUpdate() const
2192 disp_.screenUpdate(Update::None);
2196 Font Cursor::getFont() const
2198 // The logic here should more or less match to the
2199 // Cursor::setCurrentFont logic, i.e. the cursor height should
2200 // give a hint what will happen if a character is entered.
2202 // HACK. far from being perfect...
2204 CursorSlice const & sl = innerTextSlice();
2205 Text const & text = *sl.text();
2206 Paragraph const & par = text.getPar(sl.pit());
2208 // on boundary, so we are really at the character before
2209 pos_type pos = sl.pos();
2210 if (pos > 0 && boundary())
2213 // on space? Take the font before (only for RTL boundary stay)
2215 TextMetrics const & tm = bv().textMetrics(&text);
2216 if (pos == sl.lastpos()
2217 || (par.isSeparator(pos)
2218 && !tm.isRTLBoundary(sl.pit(), pos)))
2222 // get font at the position
2223 Font font = par.getFont(buffer()->params(), pos,
2224 text.outerFont(sl.pit()));
2230 bool Cursor::fixIfBroken()
2232 bool const broken_cursor = DocIterator::fixIfBroken();
2233 bool const broken_anchor = anchor_.fixIfBroken();
2235 if (broken_cursor || broken_anchor) {
2236 clearNewWordPosition();
2244 void Cursor::sanitize()
2246 setBuffer(&bv_->buffer());
2247 DocIterator::sanitize();
2255 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2257 // find inset in common
2259 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2260 if (&old[i].inset() != &cur[i].inset())
2264 // update words if we just moved to another paragraph
2265 if (i == old.depth() && i == cur.depth()
2266 && !cur.buffer()->isClean()
2267 && cur.inTexted() && old.inTexted()
2268 && cur.pit() != old.pit()) {
2269 old.paragraph().updateWords();
2272 // notify everything on top of the common part in old cursor,
2273 // but stop if the inset claims the cursor to be invalid now
2274 for (size_type j = i; j < old.depth(); ++j) {
2275 Cursor inset_pos = old;
2276 inset_pos.cutOff(j);
2277 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2281 // notify everything on top of the common part in new cursor,
2282 // but stop if the inset claims the cursor to be invalid now
2283 for (; i < cur.depth(); ++i) {
2284 if (cur[i].inset().notifyCursorEnters(cur))
2292 void Cursor::setCurrentFont()
2294 CursorSlice const & cs = innerTextSlice();
2295 Paragraph const & par = cs.paragraph();
2296 pos_type cpit = cs.pit();
2297 pos_type cpos = cs.pos();
2298 Text const & ctext = *cs.text();
2299 TextMetrics const & tm = bv().textMetrics(&ctext);
2301 // are we behind previous char in fact? -> go to that char
2302 if (cpos > 0 && boundary())
2305 // find position to take the font from
2307 // paragraph end? -> font of last char
2308 if (cpos == lastpos())
2310 // on space? -> look at the words in front of space
2311 else if (cpos > 0 && par.isSeparator(cpos)) {
2312 // abc| def -> font of c
2313 // abc |[WERBEH], i.e. boundary==true -> font of c
2314 // abc [WERBEH]| def, font of the space
2315 if (!tm.isRTLBoundary(cpit, cpos))
2321 BufferParams const & bufparams = buffer()->params();
2322 current_font = par.getFontSettings(bufparams, cpos);
2323 real_current_font = tm.displayFont(cpit, cpos);
2325 // special case for paragraph end
2326 if (cs.pos() == lastpos()
2327 && tm.isRTLBoundary(cpit, cs.pos())
2329 Language const * lang = par.getParLanguage(bufparams);
2330 current_font.setLanguage(lang);
2331 current_font.fontInfo().setNumber(FONT_OFF);
2332 real_current_font.setLanguage(lang);
2333 real_current_font.fontInfo().setNumber(FONT_OFF);
2338 bool Cursor::textUndo()
2340 if (!buffer()->undo().textUndo(*this))
2347 bool Cursor::textRedo()
2349 if (!buffer()->undo().textRedo(*this))
2356 void Cursor::finishUndo() const
2358 buffer()->undo().finishUndo();
2362 void Cursor::beginUndoGroup() const
2364 buffer()->undo().beginUndoGroup(*this);
2368 void Cursor::endUndoGroup() const
2370 buffer()->undo().endUndoGroup(*this);
2374 void Cursor::recordUndo(pit_type from, pit_type to) const
2376 buffer()->undo().recordUndo(*this, from, to);
2380 void Cursor::recordUndo(pit_type from) const
2382 buffer()->undo().recordUndo(*this, from, pit());
2386 void Cursor::recordUndo(UndoKind kind) const
2388 buffer()->undo().recordUndo(*this, kind);
2392 void Cursor::recordUndoInset(Inset const * in) const
2394 buffer()->undo().recordUndoInset(*this, in);
2398 void Cursor::recordUndoFullBuffer() const
2400 buffer()->undo().recordUndoFullBuffer(*this);
2404 void Cursor::recordUndoBufferParams() const
2406 buffer()->undo().recordUndoBufferParams(*this);
2410 void Cursor::recordUndoSelection() const
2413 if (cap::multipleCellsSelected(*this))
2418 buffer()->undo().recordUndo(*this,
2419 selBegin().pit(), selEnd().pit());
2424 void Cursor::checkBufferStructure()
2426 Buffer const * master = buffer()->masterBuffer();
2427 master->tocBackend().updateItem(*this);
2428 if (master != buffer() && !master->hasGuiDelegate())
2429 // In case the master has no gui associated with it,
2430 // the TocItem is not updated (part of bug 5699).
2431 buffer()->tocBackend().updateItem(*this);