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"
26 #include "FuncRequest.h"
29 #include "LyXFunc.h" // only for setMessage()
31 #include "paragraph_funcs.h"
32 #include "Paragraph.h"
33 #include "ParIterator.h"
36 #include "TextMetrics.h"
37 #include "TocBackend.h"
39 #include "support/debug.h"
40 #include "support/docstream.h"
42 #include "insets/InsetTabular.h"
43 #include "insets/InsetText.h"
45 #include "mathed/InsetMath.h"
46 #include "mathed/InsetMathScript.h"
47 #include "mathed/MacroTable.h"
48 #include "mathed/MathData.h"
49 #include "mathed/MathMacro.h"
51 #include <boost/assert.hpp>
52 #include <boost/bind.hpp>
64 bool positionable(DocIterator const & cursor, DocIterator const & anchor)
66 // avoid deeper nested insets when selecting
67 if (cursor.depth() > anchor.depth())
70 // anchor might be deeper, should have same path then
71 for (size_t i = 0; i < cursor.depth(); ++i)
72 if (&cursor[i].inset() != &anchor[i].inset())
75 // position should be ok.
80 // Find position closest to (x, y) in cell given by iter.
81 // Used only in mathed
82 DocIterator bruteFind2(Cursor const & c, int x, int y)
84 double best_dist = numeric_limits<double>::max();
91 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
92 for (size_t i = 0;; ++i) {
95 Inset const * inset = &it.inset();
96 map<Inset const *, Geometry> const & data =
97 c.bv().coordCache().getInsets().getData();
98 map<Inset const *, Geometry>::const_iterator I = data.find(inset);
100 // FIXME: in the case where the inset is not in the cache, this
101 // means that no part of it is visible on screen. In this case
102 // we don't do elaborate search and we just return the forwarded
103 // DocIterator at its beginning.
104 if (I == data.end()) {
109 Point o = I->second.pos;
110 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
111 // Convert to absolute
114 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
115 // '<=' in order to take the last possible position
116 // this is important for clicking behind \sum in e.g. '\sum_i a'
117 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
118 << " best: " << best_dist);
119 if (d <= best_dist) {
132 /// moves position closest to (x, y) in given box
133 bool bruteFind(Cursor & cursor,
134 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
136 BOOST_ASSERT(!cursor.empty());
137 Inset & inset = cursor[0].inset();
138 BufferView & bv = cursor.bv();
140 CoordCache::InnerParPosCache const & cache =
141 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
142 // Get an iterator on the first paragraph in the cache
143 DocIterator it(inset);
144 it.push_back(CursorSlice(inset));
145 it.pit() = cache.begin()->first;
146 // Get an iterator after the last paragraph in the cache
147 DocIterator et(inset);
148 et.push_back(CursorSlice(inset));
149 et.pit() = boost::prior(cache.end())->first;
150 if (et.pit() >= et.lastpit())
151 et = doc_iterator_end(inset);
155 double best_dist = numeric_limits<double>::max();;
156 DocIterator best_cursor = et;
158 for ( ; it != et; it.forwardPos(true)) {
159 // avoid invalid nesting when selecting
160 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
161 Point p = bv.getPos(it, false);
164 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
165 double const dx = xo - x;
166 double const dy = yo - y;
167 double const d = dx * dx + dy * dy;
168 // '<=' in order to take the last possible position
169 // this is important for clicking behind \sum in e.g. '\sum_i a'
170 if (d <= best_dist) {
171 // lyxerr << "*" << endl;
179 if (best_cursor != et) {
180 cursor.setCursor(best_cursor);
189 /// moves position closest to (x, y) in given box
190 bool bruteFind3(Cursor & cur, int x, int y, bool up)
192 BufferView & bv = cur.bv();
193 int ylow = up ? 0 : y + 1;
194 int yhigh = up ? y - 1 : bv.workHeight();
196 int xhigh = bv.workWidth();
198 // FIXME: bit more work needed to get 'from' and 'to' right.
199 pit_type from = cur.bottom().pit();
200 //pit_type to = cur.bottom().pit();
201 //lyxerr << "Pit start: " << from << endl;
203 //lyxerr << "bruteFind3: x: " << x << " y: " << y
204 // << " xlow: " << xlow << " xhigh: " << xhigh
205 // << " ylow: " << ylow << " yhigh: " << yhigh
207 Inset & inset = bv.buffer().inset();
208 DocIterator it = doc_iterator_begin(inset);
210 DocIterator et = doc_iterator_end(inset);
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);
249 docstring parbreak(Paragraph const & par)
251 odocstringstream ods;
253 // only add blank line if we're not in an ERT or Listings inset
254 if (par.ownerCode() != ERT_CODE
255 && par.ownerCode() != LISTINGS_CODE)
263 // be careful: this is called from the bv's constructor, too, so
264 // bv functions are not yet available!
265 Cursor::Cursor(BufferView & bv)
266 : DocIterator(), bv_(&bv), anchor_(), x_target_(-1), textTargetOffset_(0),
267 selection_(false), mark_(false), logicalpos_(false),
268 current_font(inherit_font)
272 void Cursor::reset(Inset & inset)
275 push_back(CursorSlice(inset));
276 anchor_ = doc_iterator_begin(inset);
284 // this (intentionally) does neither touch anchor nor selection status
285 void Cursor::setCursor(DocIterator const & cur)
287 DocIterator::operator=(cur);
291 void Cursor::dispatch(FuncRequest const & cmd0)
293 LYXERR(Debug::DEBUG, "cmd: " << cmd0 << '\n' << *this);
298 FuncRequest cmd = cmd0;
301 // store some values to be used inside of the handlers
302 beforeDispatchCursor_ = *this;
303 for (; depth(); pop()) {
304 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
305 << cmd0 << endl << *this);
306 BOOST_ASSERT(pos() <= lastpos());
307 BOOST_ASSERT(idx() <= lastidx());
308 BOOST_ASSERT(pit() <= lastpit());
310 // The common case is 'LFUN handled, need update', so make the
311 // LFUN handler's life easier by assuming this as default value.
312 // The handler can reset the update and val flags if necessary.
313 disp_.update(Update::FitCursor | Update::Force);
314 disp_.dispatched(true);
315 inset().dispatch(*this, cmd);
316 if (disp_.dispatched())
320 // it completely to get a 'bomb early' behaviour in case this
321 // object will be used again.
322 if (!disp_.dispatched()) {
323 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
325 disp_.update(Update::None);
326 disp_.dispatched(false);
328 // restore the previous one because nested Cursor::dispatch calls
329 // are possible which would change it
330 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
335 DispatchResult Cursor::result() const
341 BufferView & Cursor::bv() const
348 Buffer & Cursor::buffer() const
351 return bv_->buffer();
357 BOOST_ASSERT(depth() >= 1);
362 void Cursor::push(Inset & p)
364 push_back(CursorSlice(p));
368 void Cursor::pushBackward(Inset & p)
370 BOOST_ASSERT(!empty());
371 //lyxerr << "Entering inset " << t << " front" << endl;
377 bool Cursor::popBackward()
379 BOOST_ASSERT(!empty());
380 //lyxerr << "Leaving inset from in front" << endl;
381 inset().notifyCursorLeaves(*this);
389 bool Cursor::popForward()
391 BOOST_ASSERT(!empty());
392 //lyxerr << "Leaving inset from in back" << endl;
393 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
394 inset().notifyCursorLeaves(*this);
398 pos() += lastpos() - lp + 1;
403 int Cursor::currentMode()
405 BOOST_ASSERT(!empty());
406 for (int i = depth() - 1; i >= 0; --i) {
407 int res = operator[](i).inset().currentMode();
408 if (res != Inset::UNDECIDED_MODE)
411 return Inset::TEXT_MODE;
415 void Cursor::getPos(int & x, int & y) const
417 Point p = bv().getPos(*this, boundary());
423 Row const & Cursor::textRow() const
425 CursorSlice const & cs = innerTextSlice();
426 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
427 BOOST_ASSERT(!pm.rows().empty());
428 return pm.getRow(pos(), boundary());
432 void Cursor::resetAnchor()
439 bool Cursor::posBackward()
448 bool Cursor::posForward()
450 if (pos() == lastpos())
457 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
459 // preparing bidi tables
460 Paragraph const & par = paragraph();
461 Buffer const & buf = buffer();
462 Row const & row = textRow();
464 bidi.computeTables(par, buf, row);
466 LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
468 // The cursor is painted *before* the character at pos(), or, if 'boundary'
469 // is true, *after* the character at (pos() - 1). So we already have one
470 // known position around the cursor:
471 pos_type known_pos = boundary() ? pos() - 1 : pos();
473 // Whether 'known_pos' is to the left or to the right of the cursor depends
474 // on whether it is an RTL or LTR character...
475 bool const cur_is_RTL =
476 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
477 // ... in the following manner:
478 // For an RTL character, "before" means "to the right" and "after" means
479 // "to the left"; and for LTR, it's the reverse. So, 'known_pos' is to the
480 // right of the cursor if (RTL && boundary) or (!RTL && !boundary):
481 bool known_pos_on_right = (cur_is_RTL == boundary());
483 // So we now know one of the positions surrounding the cursor. Let's
484 // determine the other one:
486 if (known_pos_on_right) {
487 // edge-case: we're at the end of the paragraph, there isn't really any
488 // position any further to the right
489 if (known_pos == lastpos()) {
491 left_pos = row.endpos() - 1;
495 right_pos = known_pos;
496 // *visual* position of 'left_pos':
497 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
498 // If the position we just identified as 'left_pos' is a "skipped
499 // separator" (a separator which is at the logical end of a row,
500 // except for the last row in a paragraph; such separators are not
501 // painted, so they "are not really there"; note that in bidi text,
502 // such a separator could appear visually in the middle of a row),
503 // set 'left_pos' to the *next* position to the left.
504 if (bidi.inRange(v_left_pos)
505 && bidi.vis2log(v_left_pos) + 1 == row.endpos()
506 && row.endpos() < lastpos()
507 && par.isSeparator(bidi.vis2log(v_left_pos))) {
510 // calculate the logical position of 'left_pos', if in row
511 if (!bidi.inRange(v_left_pos))
514 left_pos = bidi.vis2log(v_left_pos);
515 // If the position we identified as 'right_pos' is a "skipped
516 // separator", set 'right_pos' to the *next* position to the right.
517 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos()
518 && par.isSeparator(right_pos)) {
519 pos_type v_right_pos = bidi.log2vis(right_pos) + 1;
520 if (!bidi.inRange(v_right_pos))
523 right_pos = bidi.vis2log(v_right_pos);
526 else { // known_pos is on the left
527 // edge-case: we're at the end of the paragraph, there isn't really any
528 // position any further to the left
529 if (known_pos == lastpos()) {
531 right_pos = row.endpos() - 1;
535 left_pos = known_pos;
536 // *visual* position of 'right_pos'
537 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
538 // If the position we just identified as 'right_pos' is a "skipped
539 // separator", set 'right_pos' to the *next* position to the right.
540 if (bidi.inRange(v_right_pos)
541 && bidi.vis2log(v_right_pos) + 1 == row.endpos()
542 && row.endpos() < lastpos()
543 && par.isSeparator(bidi.vis2log(v_right_pos))) {
546 // calculate the logical position of 'right_pos', if in row
547 if (!bidi.inRange(v_right_pos))
550 right_pos = bidi.vis2log(v_right_pos);
551 // If the position we identified as 'left_pos' is a "skipped
552 // separator", set 'left_pos' to the *next* position to the left.
553 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos()
554 && par.isSeparator(left_pos)) {
555 pos_type v_left_pos = bidi.log2vis(left_pos) - 1;
556 if (!bidi.inRange(v_left_pos))
559 left_pos = bidi.vis2log(v_left_pos);
566 bool Cursor::posVisToNewRow(bool movingLeft)
568 Paragraph const & par = paragraph();
569 Buffer const & buf = buffer();
570 Row const & row = textRow();
571 bool par_is_LTR = !par.isRTL(buf.params());
573 // if moving left in an LTR paragraph or moving right in an RTL one,
574 // move to previous row
575 if (par_is_LTR == movingLeft) {
576 if (row.pos() == 0) { // we're at first row in paragraph
577 if (pit() == 0) // no previous paragraph! don't move
579 // move to last pos in previous par
583 } else { // move to previous row in this par
584 pos() = row.pos() - 1; // this is guaranteed to be in previous row
588 // if moving left in an RTL paragraph or moving right in an LTR one,
591 if (row.endpos() == lastpos()) { // we're at last row in paragraph
592 if (pit() == lastpit()) // last paragraph! don't move
594 // move to first row in next par
598 } else { // move to next row in this par
599 pos() = row.endpos();
604 // make sure we're at left-/right-most pos in new row
605 posVisToRowExtremity(!movingLeft);
611 void Cursor::posVisToRowExtremity(bool left)
613 // prepare bidi tables
614 Paragraph const & par = paragraph();
615 Buffer const & buf = buffer();
616 Row const & row = textRow();
618 bidi.computeTables(par, buf, row);
620 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
621 << (boundary() ? 1 : 0));
623 if (left) { // move to leftmost position
624 // if this is an RTL paragraph, and we're at the last row in the
625 // paragraph, move to lastpos
626 if (par.isRTL(buf.params()) && row.endpos() == lastpos())
629 pos() = bidi.vis2log(row.pos());
631 // Moving to the leftmost position in the row, the cursor should
632 // normally be placed to the *left* of the leftmost position.
633 // A very common exception, though, is if the leftmost character
634 // also happens to be the separator at the (logical) end of the row
635 // --- in this case, the separator is positioned beyond the left
636 // margin, and we don't want to move the cursor there (moving to
637 // the left of the separator is equivalent to moving to the next
638 // line). So, in this case we actually want to place the cursor
639 // to the *right* of the leftmost position (the separator).
640 // Another exception is if we're moving to the logically last
641 // position in the row, which is *not* a separator: this means
642 // that the entire row has no separators (if there were any, the
643 // row would have been broken there); and therefore in this case
644 // we also move to the *right* of the last position (this indicates
645 // to the user that there is no space after this position, and is
646 // consistent with the behavior in the middle of a row --- moving
647 // right or left moves to the next/previous character; if we were
648 // to move to the *left* of this position, that would simulate
649 // a separator which is not really there!).
650 // Finally, there is an exception to the previous exception: if
651 // this non-separator-but-last-position-in-row is an inset, then
652 // we *do* want to stay to the left of it anyway: this is the
653 // "boundary" which we simulate at insets.
655 bool right_of_pos = false; // do we want to be to the right of pos?
657 // as explained above, if at last pos in row, stay to the right
658 if ((pos() == row.endpos() - 1) && !par.isInset(pos()))
661 // Now we know if we want to be to the left or to the right of pos,
662 // let's make sure we are where we want to be.
663 bool new_pos_is_RTL =
664 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
666 if (new_pos_is_RTL == !right_of_pos) {
673 else { // move to rightmost position
674 // if this is an LTR paragraph, and we're at the last row in the
675 // paragraph, move to lastpos
676 if (!par.isRTL(buf.params()) && row.endpos() == lastpos())
679 pos() = bidi.vis2log(row.endpos() - 1);
681 // Moving to the rightmost position in the row, the cursor should
682 // normally be placed to the *right* of the rightmost position.
683 // A very common exception, though, is if the rightmost character
684 // also happens to be the separator at the (logical) end of the row
685 // --- in this case, the separator is positioned beyond the right
686 // margin, and we don't want to move the cursor there (moving to
687 // the right of the separator is equivalent to moving to the next
688 // line). So, in this case we actually want to place the cursor
689 // to the *left* of the rightmost position (the separator).
690 // Another exception is if we're moving to the logically last
691 // position in the row, which is *not* a separator: this means
692 // that the entire row has no separators (if there were any, the
693 // row would have been broken there); and therefore in this case
694 // we also move to the *left* of the last position (this indicates
695 // to the user that there is no space after this position, and is
696 // consistent with the behavior in the middle of a row --- moving
697 // right or left moves to the next/previous character; if we were
698 // to move to the *right* of this position, that would simulate
699 // a separator which is not really there!).
700 // Finally, there is an exception to the previous exception: if
701 // this non-separator-but-last-position-in-row is an inset, then
702 // we *do* want to stay to the right of it anyway: this is the
703 // "boundary" which we simulate at insets.
705 bool left_of_pos = false; // do we want to be to the left of pos?
707 // as explained above, if at last pos in row, stay to the left
708 if ((pos() == row.endpos() - 1) && !par.isInset(pos()))
711 // Now we know if we want to be to the left or to the right of pos,
712 // let's make sure we are where we want to be.
713 bool new_pos_is_RTL =
714 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
716 if (new_pos_is_RTL == left_of_pos) {
722 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
723 << (boundary() ? 1 : 0));
727 CursorSlice Cursor::anchor() const
729 BOOST_ASSERT(anchor_.depth() >= depth());
730 CursorSlice normal = anchor_[depth() - 1];
731 if (depth() < anchor_.depth() && top() <= normal) {
732 // anchor is behind cursor -> move anchor behind the inset
739 CursorSlice Cursor::selBegin() const
743 return anchor() < top() ? anchor() : top();
747 CursorSlice Cursor::selEnd() const
751 return anchor() > top() ? anchor() : top();
755 DocIterator Cursor::selectionBegin() const
759 DocIterator di = (anchor() < top() ? anchor_ : *this);
765 DocIterator Cursor::selectionEnd() const
769 DocIterator di = (anchor() > top() ? anchor_ : *this);
770 if (di.depth() > depth()) {
778 void Cursor::setSelection()
781 // A selection with no contents is not a selection
782 // FIXME: doesnt look ok
783 if (pit() == anchor().pit() && pos() == anchor().pos())
788 void Cursor::setSelection(DocIterator const & where, int n)
797 void Cursor::clearSelection()
805 void Cursor::setTargetX(int x)
808 textTargetOffset_ = 0;
812 int Cursor::x_target() const
818 void Cursor::clearTargetX()
821 textTargetOffset_ = 0;
825 void Cursor::updateTextTargetOffset()
830 textTargetOffset_ = x - x_target_;
834 void Cursor::info(odocstream & os) const
836 for (int i = 1, n = depth(); i < n; ++i) {
837 operator[](i).inset().infoize(os);
841 Inset const * inset = prevInset();
842 // prevInset() can return 0 in certain case.
844 prevInset()->infoize2(os);
846 // overwite old message
851 bool Cursor::selHandle(bool sel)
853 //lyxerr << "Cursor::selHandle" << endl;
856 if (sel == selection())
860 cap::saveSelection(*this);
868 ostream & operator<<(ostream & os, Cursor const & cur)
870 os << "\n cursor: | anchor:\n";
871 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
872 os << " " << cur[i] << " | ";
873 if (i < cur.anchor_.depth())
874 os << cur.anchor_[i];
876 os << "-------------------------------";
879 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
880 os << "------------------------------- | " << cur.anchor_[i] << "\n";
882 os << " selection: " << cur.selection_
883 << " x_target: " << cur.x_target_ << endl;
888 LyXErr & operator<<(LyXErr & os, Cursor const & cur)
898 ///////////////////////////////////////////////////////////////////
901 // The part below is the non-integrated rest of the original math
902 // cursor. This should be either generalized for texted or moved
903 // back to mathed (in most cases to InsetMathNest).
905 ///////////////////////////////////////////////////////////////////
907 #include "mathed/InsetMathChar.h"
908 #include "mathed/InsetMathGrid.h"
909 #include "mathed/InsetMathScript.h"
910 #include "mathed/InsetMathUnknown.h"
911 #include "mathed/MathFactory.h"
912 #include "mathed/MathStream.h"
913 #include "mathed/MathSupport.h"
918 //#define FILEDEBUG 1
921 bool Cursor::isInside(Inset const * p) const
923 for (size_t i = 0; i != depth(); ++i)
924 if (&operator[](i).inset() == p)
930 void Cursor::leaveInset(Inset const & inset)
932 for (size_t i = 0; i != depth(); ++i) {
933 if (&operator[](i).inset() == &inset) {
941 bool Cursor::openable(MathAtom const & t) const
952 // we can't move into anything new during selection
953 if (depth() >= anchor_.depth())
955 if (t.nucleus() != &anchor_[depth()].inset())
962 void Cursor::setScreenPos(int x, int /*y*/)
965 //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
970 void Cursor::plainErase()
976 void Cursor::markInsert()
978 insert(char_type(0));
982 void Cursor::markErase()
988 void Cursor::plainInsert(MathAtom const & t)
990 cell().insert(pos(), t);
995 void Cursor::insert(docstring const & str)
997 for_each(str.begin(), str.end(),
998 boost::bind(static_cast<void(Cursor::*)(char_type)>
999 (&Cursor::insert), this, _1));
1003 void Cursor::insert(char_type c)
1005 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1006 BOOST_ASSERT(!empty());
1008 cap::selClearOrDel(*this);
1009 insert(new InsetMathChar(c));
1011 text()->insertChar(*this, c);
1016 void Cursor::insert(MathAtom const & t)
1018 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1020 cap::selClearOrDel(*this);
1025 void Cursor::insert(Inset * inset)
1028 insert(MathAtom(inset));
1030 text()->insertInset(*this, inset);
1034 void Cursor::niceInsert(docstring const & t)
1045 void Cursor::niceInsert(MathAtom const & t)
1048 docstring const safe = cap::grabAndEraseSelection(*this);
1050 // enter the new inset and move the contents of the selection if possible
1051 if (t->isActive()) {
1053 // be careful here: don't use 'pushBackward(t)' as this we need to
1054 // push the clone, not the original
1055 pushBackward(*nextInset());
1056 // We may not use niceInsert here (recursion)
1064 void Cursor::insert(MathData const & ar)
1068 cap::eraseSelection(*this);
1069 cell().insert(pos(), ar);
1074 bool Cursor::backspace()
1076 autocorrect() = false;
1079 cap::eraseSelection(*this);
1084 // If empty cell, and not part of a big cell
1085 if (lastpos() == 0 && inset().nargs() == 1) {
1087 // Directly delete empty cell: [|[]] => [|]
1093 // [|], can not delete from inside
1104 if (inMacroMode()) {
1105 InsetMathUnknown * p = activeMacro();
1106 if (p->name().size() > 1) {
1107 p->setName(p->name().substr(0, p->name().size() - 1));
1112 if (pos() != 0 && prevAtom()->nargs() > 0) {
1113 // let's require two backspaces for 'big stuff' and
1114 // highlight on the first
1126 bool Cursor::erase()
1128 autocorrect() = false;
1133 cap::eraseSelection(*this);
1137 // delete empty cells if possible
1138 if (pos() == lastpos() && inset().idxDelete(idx()))
1141 // special behaviour when in last position of cell
1142 if (pos() == lastpos()) {
1143 bool one_cell = inset().nargs() == 1;
1144 if (one_cell && lastpos() == 0) {
1146 // Directly delete empty cell: [|[]] => [|]
1152 // [|], can not delete from inside
1157 inset().idxGlue(idx());
1161 // 'clever' UI hack: only erase large items if previously slected
1162 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1177 DocIterator save = *this;
1178 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1179 this->dispatch(cmd);
1180 if (disp_.dispatched())
1183 autocorrect() = false;
1191 DocIterator save = *this;
1192 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1193 this->dispatch(cmd);
1194 if (disp_.dispatched())
1197 autocorrect() = false;
1202 bool Cursor::macroModeClose()
1206 InsetMathUnknown * p = activeMacro();
1208 docstring const s = p->name();
1210 cell().erase(pos());
1212 // do nothing if the macro name is empty
1216 // trigger updates of macros, at least, if no full
1217 // updates take place anyway
1218 updateFlags(Update::Force);
1220 docstring const name = s.substr(1);
1221 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1222 if (in && in->interpretString(*this, s))
1224 MathAtom atom = createInsetMath(name);
1225 MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1227 // make non-greedy, i.e. don't eat parameters from the right
1228 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT);
1235 docstring Cursor::macroName()
1237 return inMacroMode() ? activeMacro()->name() : docstring();
1241 void Cursor::handleNest(MathAtom const & a, int c)
1243 //lyxerr << "Cursor::handleNest: " << c << endl;
1245 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1248 pushBackward(*nextInset());
1252 int Cursor::targetX() const
1254 if (x_target() != -1)
1263 int Cursor::textTargetOffset() const
1265 return textTargetOffset_;
1269 void Cursor::setTargetX()
1278 bool Cursor::inMacroMode() const
1284 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1285 return p && !p->final();
1289 InsetMathUnknown * Cursor::activeMacro()
1291 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1295 void Cursor::pullArg()
1298 MathData ar = cell();
1299 if (popBackward() && inMathed()) {
1301 cell().insert(pos(), ar);
1304 //formula()->mutateToText();
1309 void Cursor::touch()
1313 DocIterator::const_iterator it = begin();
1314 DocIterator::const_iterator et = end();
1315 for ( ; it != et; ++it)
1321 void Cursor::normalize()
1323 if (idx() > lastidx()) {
1324 lyxerr << "this should not really happen - 1: "
1325 << idx() << ' ' << nargs()
1326 << " in: " << &inset() << endl;
1330 if (pos() > lastpos()) {
1331 lyxerr << "this should not really happen - 2: "
1332 << pos() << ' ' << lastpos() << " in idx: " << idx()
1334 odocstringstream os;
1335 WriteStream wi(os, false, true);
1336 inset().asInsetMath()->write(wi);
1337 lyxerr << to_utf8(os.str()) << endl;
1343 bool Cursor::upDownInMath(bool up)
1345 // Be warned: The 'logic' implemented in this function is highly
1346 // fragile. A distance of one pixel or a '<' vs '<=' _really
1347 // matters. So fiddle around with it only if you think you know
1348 // what you are doing!
1352 xo = theLyXFunc().cursorBeforeDispatchX();
1354 // check if we had something else in mind, if not, this is the future
1356 if (x_target_ == -1)
1358 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1359 // In text mode inside the line (not left or right) possibly set a new target_x,
1360 // but only if we are somewhere else than the previous target-offset.
1362 // We want to keep the x-target on subsequent up/down movements
1363 // that cross beyond the end of short lines. Thus a special
1364 // handling when the cursor is at the end of line: Use the new
1365 // x-target only if the old one was before the end of line
1366 // or the old one was after the beginning of the line
1367 bool inRTL = isWithinRtlParagraph(*this);
1371 left = pos() == textRow().endpos();
1372 right = pos() == textRow().pos();
1374 left = pos() == textRow().pos();
1375 right = pos() == textRow().endpos();
1377 if ((!left && !right) ||
1378 (left && !right && xo < x_target_) ||
1379 (!left && right && x_target_ < xo))
1386 // try neigbouring script insets
1388 if (inMathed() && !selection()) {
1391 InsetMathScript const * p = prevAtom()->asScriptInset();
1392 if (p && p->has(up)) {
1394 push(*const_cast<InsetMathScript*>(p));
1395 idx() = p->idxOfScript(up);
1398 // we went in the right direction? Otherwise don't jump into the script
1402 int oy = theLyXFunc().cursorBeforeDispatchY();
1403 if ((!up && y <= oy) ||
1412 if (pos() != lastpos()) {
1413 InsetMathScript const * p = nextAtom()->asScriptInset();
1414 if (p && p->has(up)) {
1415 push(*const_cast<InsetMathScript*>(p));
1416 idx() = p->idxOfScript(up);
1419 // we went in the right direction? Otherwise don't jump into the script
1423 int oy = theLyXFunc().cursorBeforeDispatchY();
1424 if ((!up && y <= oy) ||
1433 // try to find an inset that knows better then we,
1434 if (inset().idxUpDown(*this, up)) {
1435 //lyxerr << "idxUpDown triggered" << endl;
1436 // try to find best position within this inset
1438 setCursor(bruteFind2(*this, xo, yo));
1442 // any improvement going just out of inset?
1443 if (popBackward() && inMathed()) {
1444 //lyxerr << "updown: popBackward succeeded" << endl;
1447 int yold = theLyXFunc().cursorBeforeDispatchY();
1449 if (up ? ynew < yold : ynew > yold)
1453 // no success, we are probably at the document top or bottom
1459 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1461 BOOST_ASSERT(text());
1467 xo = theLyXFunc().cursorBeforeDispatchX();
1469 // update the targetX - this is here before the "return false"
1470 // to set a new target which can be used by InsetTexts above
1471 // if we cannot move up/down inside this inset anymore
1472 if (x_target_ == -1)
1474 else if (xo - textTargetOffset() != x_target() &&
1475 depth() == beforeDispatchCursor_.depth()) {
1476 // In text mode inside the line (not left or right) possibly set a new target_x,
1477 // but only if we are somewhere else than the previous target-offset.
1479 // We want to keep the x-target on subsequent up/down movements
1480 // that cross beyond the end of short lines. Thus a special
1481 // handling when the cursor is at the end of line: Use the new
1482 // x-target only if the old one was before the end of line
1483 // or the old one was after the beginning of the line
1484 bool inRTL = isWithinRtlParagraph(*this);
1488 left = pos() == textRow().endpos();
1489 right = pos() == textRow().pos();
1491 left = pos() == textRow().pos();
1492 right = pos() == textRow().endpos();
1494 if ((!left && !right) ||
1495 (left && !right && xo < x_target_) ||
1496 (!left && right && x_target_ < xo))
1503 // first get the current line
1504 TextMetrics & tm = bv_->textMetrics(text());
1505 ParagraphMetrics const & pm = tm.parMetrics(pit());
1507 if (pos() && boundary())
1508 row = pm.pos2row(pos() - 1);
1510 row = pm.pos2row(pos());
1512 // are we not at the start or end?
1514 if (pit() == 0 && row == 0)
1517 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1518 row + 1 >= int(pm.rows().size()))
1522 // with and without selection are handled differently
1524 int yo = bv().getPos(*this, boundary()).y_;
1526 // To next/previous row
1528 tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1530 tm.editXY(*this, xo, yo + textRow().descent() + 1);
1533 // This happens when you move out of an inset.
1534 // And to give the DEPM the possibility of doing
1535 // something we must provide it with two different
1537 Cursor dummy = *this;
1540 if (bv().checkDepm(dummy, old)) {
1541 updateNeeded = true;
1542 // Make sure that cur gets back whatever happened to dummy(Lgb)
1546 // if there is a selection, we stay out of any inset, and just jump to the right position:
1550 top().pos() = min(tm.x2pos(pit(), row - 1, xo), top().lastpos());
1551 } else if (pit() > 0) {
1553 ParagraphMetrics const & pmcur = bv_->parMetrics(text(), pit());
1554 top().pos() = min(tm.x2pos(pit(), pmcur.rows().size() - 1, xo), top().lastpos());
1557 if (row + 1 < int(pm.rows().size())) {
1558 top().pos() = min(tm.x2pos(pit(), row + 1, xo), top().lastpos());
1559 } else if (pit() + 1 < int(text()->paragraphs().size())) {
1561 top().pos() = min(tm.x2pos(pit(), 0, xo), top().lastpos());
1565 updateNeeded |= bv().checkDepm(*this, old);
1568 updateTextTargetOffset();
1573 void Cursor::handleFont(string const & font)
1575 LYXERR(Debug::DEBUG, font);
1579 safe = cap::grabAndEraseSelection(*this);
1582 if (lastpos() != 0) {
1583 // something left in the cell
1585 // cursor in first position
1587 } else if (pos() == lastpos()) {
1588 // cursor in last position
1591 // cursor in between. split cell
1592 MathData::iterator bt = cell().begin();
1593 MathAtom at = createInsetMath(from_utf8(font));
1594 at.nucleus()->cell(0) = MathData(bt, bt + pos());
1595 cell().erase(bt, bt + pos());
1600 // nothing left in the cell
1608 void Cursor::message(docstring const & msg) const
1610 theLyXFunc().setMessage(msg);
1614 void Cursor::errorMessage(docstring const & msg) const
1616 theLyXFunc().setErrorMessage(msg);
1620 docstring Cursor::selectionAsString(bool label) const
1626 Buffer const & buffer = bv().buffer();
1627 ParagraphList const & pars = text()->paragraphs();
1629 // should be const ...
1630 pit_type startpit = selBegin().pit();
1631 pit_type endpit = selEnd().pit();
1632 size_t const startpos = selBegin().pos();
1633 size_t const endpos = selEnd().pos();
1635 if (startpit == endpit)
1636 return pars[startpit].asString(buffer, startpos, endpos, label);
1638 // First paragraph in selection
1639 docstring result = pars[startpit].
1640 asString(buffer, startpos, pars[startpit].size(), label)
1641 + parbreak(pars[startpit]);
1643 // The paragraphs in between (if any)
1644 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1645 Paragraph const & par = pars[pit];
1646 result += par.asString(buffer, 0, par.size(), label)
1647 + parbreak(pars[pit]);
1650 // Last paragraph in selection
1651 result += pars[endpit].asString(buffer, 0, endpos, label);
1657 return cap::grabSelection(*this);
1663 docstring Cursor::currentState()
1666 odocstringstream os;
1672 return text()->currentState(*this);
1678 docstring Cursor::getPossibleLabel()
1680 return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
1684 Encoding const * Cursor::getEncoding() const
1688 CursorSlice const & sl = innerTextSlice();
1689 Text const & text = *sl.text();
1690 Font font = text.getPar(sl.pit()).getFont(
1691 bv().buffer().params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1692 return font.language()->encoding();
1696 void Cursor::undispatched()
1698 disp_.dispatched(false);
1702 void Cursor::dispatched()
1704 disp_.dispatched(true);
1708 void Cursor::updateFlags(Update::flags f)
1714 void Cursor::noUpdate()
1716 disp_.update(Update::None);
1720 Font Cursor::getFont() const
1722 // The logic here should more or less match to the Cursor::setCurrentFont
1723 // logic, i.e. the cursor height should give a hint what will happen
1724 // if a character is entered.
1726 // HACK. far from being perfect...
1728 CursorSlice const & sl = innerTextSlice();
1729 Text const & text = *sl.text();
1730 Paragraph const & par = text.getPar(sl.pit());
1732 // on boundary, so we are really at the character before
1733 pos_type pos = sl.pos();
1734 if (pos > 0 && boundary())
1737 // on space? Take the font before (only for RTL boundary stay)
1739 TextMetrics const & tm = bv().textMetrics(&text);
1740 if (pos == sl.lastpos()
1741 || (par.isSeparator(pos)
1742 && !tm.isRTLBoundary(sl.pit(), pos)))
1746 // get font at the position
1747 Font font = par.getFont(bv().buffer().params(), pos,
1748 outerFont(sl.pit(), text.paragraphs()));
1754 bool Cursor::fixIfBroken()
1756 if (DocIterator::fixIfBroken()) {
1765 bool notifyCursorLeaves(DocIterator const & old, Cursor & cur)
1767 // find inset in common
1769 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
1770 if (&old[i].inset() != &cur[i].inset())
1774 // notify everything on top of the common part in old cursor,
1775 // but stop if the inset claims the cursor to be invalid now
1776 for (; i < old.depth(); ++i) {
1777 if (old[i].inset().notifyCursorLeaves(cur))
1785 void Cursor::setCurrentFont()
1787 CursorSlice const & cs = innerTextSlice();
1788 Paragraph const & par = cs.paragraph();
1789 pos_type cpit = cs.pit();
1790 pos_type cpos = cs.pos();
1791 Text const & ctext = *cs.text();
1792 TextMetrics const & tm = bv().textMetrics(&ctext);
1794 // are we behind previous char in fact? -> go to that char
1795 if (cpos > 0 && boundary())
1798 // find position to take the font from
1800 // paragraph end? -> font of last char
1801 if (cpos == lastpos())
1803 // on space? -> look at the words in front of space
1804 else if (cpos > 0 && par.isSeparator(cpos)) {
1805 // abc| def -> font of c
1806 // abc |[WERBEH], i.e. boundary==true -> font of c
1807 // abc [WERBEH]| def, font of the space
1808 if (!tm.isRTLBoundary(cpit, cpos))
1814 BufferParams const & bufparams = buffer().params();
1815 current_font = par.getFontSettings(bufparams, cpos);
1816 real_current_font = tm.getDisplayFont(cpit, cpos);
1818 // special case for paragraph end
1819 if (cs.pos() == lastpos()
1820 && tm.isRTLBoundary(cpit, cs.pos())
1822 Language const * lang = par.getParLanguage(bufparams);
1823 current_font.setLanguage(lang);
1824 current_font.fontInfo().setNumber(FONT_OFF);
1825 real_current_font.setLanguage(lang);
1826 real_current_font.fontInfo().setNumber(FONT_OFF);
1831 bool Cursor::textUndo()
1833 DocIterator dit = *this;
1834 // Undo::textUndo() will modify dit.
1835 if (!bv_->buffer().undo().textUndo(dit))
1839 selection() = false;
1846 bool Cursor::textRedo()
1848 DocIterator dit = *this;
1849 // Undo::textRedo() will modify dit.
1850 if (!bv_->buffer().undo().textRedo(dit))
1854 selection() = false;
1861 void Cursor::finishUndo()
1863 bv_->buffer().undo().finishUndo();
1867 void Cursor::recordUndo(UndoKind kind, pit_type from, pit_type to)
1869 bv_->buffer().undo().recordUndo(*this, kind, from, to);
1873 void Cursor::recordUndo(UndoKind kind, pit_type from)
1875 bv_->buffer().undo().recordUndo(*this, kind, from);
1879 void Cursor::recordUndo(UndoKind kind)
1881 bv_->buffer().undo().recordUndo(*this, kind);
1885 void Cursor::recordUndoInset(UndoKind kind)
1887 bv_->buffer().undo().recordUndoInset(*this, kind);
1891 void Cursor::recordUndoFullDocument()
1893 bv_->buffer().undo().recordUndoFullDocument(*this);
1897 void Cursor::recordUndoSelection()
1899 bv_->buffer().undo().recordUndo(*this, ATOMIC_UNDO,
1900 selBegin().pit(), selEnd().pit());
1904 void Cursor::checkBufferStructure()
1906 if (paragraph().layout()->toclevel == Layout::NOT_IN_TOC)
1908 Buffer const * master = buffer().masterBuffer();
1909 master->tocBackend().updateItem(ParConstIterator(*this));
1910 master->structureChanged();