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.
20 #include "BufferView.h"
21 #include "CoordCache.h"
22 #include "CutAndPaste.h"
24 #include "FuncRequest.h"
27 #include "LyXAction.h"
29 #include "Paragraph.h"
31 #include "texstream.h"
33 #include "TextMetrics.h"
34 #include "TocBackend.h"
36 #include "support/debug.h"
37 #include "support/docstream.h"
38 #include "support/gettext.h"
39 #include "support/lassert.h"
41 #include "insets/InsetLayout.h"
42 #include "insets/InsetTabular.h"
44 #include "mathed/InsetMath.h"
45 #include "mathed/InsetMathBrace.h"
46 #include "mathed/InsetMathEnsureMath.h"
47 #include "mathed/InsetMathScript.h"
48 #include "mathed/MacroTable.h"
49 #include "mathed/MathData.h"
50 #include "mathed/MathFactory.h"
51 #include "mathed/InsetMathMacro.h"
53 #include "frontends/Application.h"
66 // Find position closest to (x, y) in cell given by iter.
67 // Used only in mathed
68 DocIterator bruteFind(Cursor const & c, int x, int y)
70 double best_dist = numeric_limits<double>::max();
77 et.pos() = et.lastpos();
78 for (size_t i = 0;; ++i) {
81 Inset const * inset = &it.inset();
82 CoordCache::Insets const & insetCache = c.bv().coordCache().getInsets();
84 // FIXME: in the case where the inset is not in the cache, this
85 // means that no part of it is visible on screen. In this case
86 // we don't do elaborate search and we just return the forwarded
87 // DocIterator at its beginning.
88 if (!insetCache.has(inset)) {
93 Point const o = insetCache.xy(inset);
94 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
95 // Convert to absolute
98 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
99 // '<=' in order to take the last possible position
100 // this is important for clicking behind \sum in e.g. '\sum_i a'
101 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
102 << " best: " << best_dist);
103 if (d <= best_dist) {
123 CursorData::CursorData()
124 : DocIterator(), anchor_(), selection_(false), mark_(false),
125 word_selection_(false), current_font(inherit_font)
129 CursorData::CursorData(Buffer * buffer)
130 : DocIterator(buffer), anchor_(), selection_(false), mark_(false),
131 word_selection_(false), current_font(inherit_font)
135 CursorData::CursorData(DocIterator const & dit)
136 : DocIterator(dit), anchor_(), selection_(false), mark_(false),
137 word_selection_(false), current_font(inherit_font)
143 ostream & operator<<(ostream & os, CursorData const & cur)
145 os << "\n cursor: | anchor:\n";
146 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
147 os << " " << cur[i] << " | ";
148 if (i < cur.anchor_.depth())
149 os << cur.anchor_[i];
151 os << "-------------------------------";
154 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
155 os << "------------------------------- | " << cur.anchor_[i] << "\n";
157 os << " selection: " << cur.selection_
158 // << " x_target: " << cur.x_target_
159 << " boundary: " << cur.boundary() << endl;
164 LyXErr & operator<<(LyXErr & os, CursorData const & cur)
171 void CursorData::reset()
174 push_back(CursorSlice(buffer()->inset()));
175 anchor_ = doc_iterator_begin(buffer());
177 new_word_ = doc_iterator_begin(buffer());
184 void CursorData::setCursor(DocIterator const & cur)
186 DocIterator::operator=(cur);
190 void CursorData::setCursorSelectionTo(DocIterator dit)
194 while (i < dit.depth() && i < anchor_.depth() && dit[i] == anchor_[i])
196 if (i != dit.depth()) {
197 // otherwise the cursor is already normal
198 if (i == anchor_.depth())
199 // dit is a proper extension of the anchor_
201 else if (i + 1 < dit.depth()) {
202 // one has dit[i] != anchor_[i] but either dit[i-1] == anchor_[i-1]
203 // or i == 0. Remove excess.
205 if (dit[i] > anchor_[i])
206 // place dit after the inset it was in
215 void CursorData::setCursorToAnchor()
218 DocIterator normal = anchor_;
219 while (depth() < normal.depth())
221 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
228 CursorSlice CursorData::normalAnchor() const
232 // LASSERT: There have been several bugs around this code, that seem
233 // to involve failures to reset the anchor. We can at least not crash
234 // in release mode by resetting it ourselves.
235 if (anchor_.depth() < depth()) {
236 LYXERR0("Cursor is deeper than anchor. PLEASE REPORT.\nCursor is"
238 const_cast<DocIterator &>(anchor_) = *this;
241 CursorSlice normal = anchor_[depth() - 1];
242 if (depth() < anchor_.depth() && top() <= normal) {
243 // anchor is behind cursor -> move anchor behind the inset
250 void CursorData::setSelection()
253 if (idx() == normalAnchor().idx() &&
254 pit() == normalAnchor().pit() &&
255 pos() == normalAnchor().pos())
260 void CursorData::setSelection(DocIterator const & where, int n)
269 void CursorData::resetAnchor()
272 checkNewWordPosition();
276 CursorSlice CursorData::selBegin() const
280 return normalAnchor() < top() ? normalAnchor() : top();
284 CursorSlice CursorData::selEnd() const
288 return normalAnchor() > top() ? normalAnchor() : top();
292 DocIterator CursorData::selectionBegin() const
298 // FIXME: This is a work-around for the problem that
299 // CursorSlice doesn't keep track of the boundary.
300 if (normalAnchor() == top())
301 di = anchor_.boundary() > boundary() ? anchor_ : *this;
303 di = normalAnchor() < top() ? anchor_ : *this;
309 DocIterator CursorData::selectionEnd() const
315 // FIXME: This is a work-around for the problem that
316 // CursorSlice doesn't keep track of the boundary.
317 if (normalAnchor() == top())
318 di = anchor_.boundary() < boundary() ? anchor_ : *this;
320 di = normalAnchor() > top() ? anchor_ : *this;
322 if (di.depth() > depth()) {
332 docstring parbreak(CursorData const * cur)
334 if (cur->inset().getLayout().parbreakIgnored())
338 // only add blank line if we're not in a ParbreakIsNewline situation
339 if (!cur->inset().getLayout().parbreakIsNewline()
340 && !cur->paragraph().layout().parbreak_is_newline)
348 docstring CursorData::selectionAsString(bool const with_label, bool const skipdelete) const
354 return cap::grabSelection(*this);
356 int label = with_label
357 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
360 ? AS_STR_LABEL | AS_STR_INSETS | AS_STR_SKIPDELETE
361 : AS_STR_INSETS | AS_STR_SKIPDELETE;
363 idx_type const startidx = selBegin().idx();
364 idx_type const endidx = selEnd().idx();
365 if (startidx != endidx) {
366 // multicell selection
367 InsetTabular * table = inset().asInsetTabular();
368 LASSERT(table, return docstring());
369 return table->asString(startidx, endidx);
372 ParagraphList const & pars = text()->paragraphs();
374 pit_type const startpit = selBegin().pit();
375 pit_type const endpit = selEnd().pit();
376 size_t const startpos = selBegin().pos();
377 size_t const endpos = selEnd().pos();
379 if (startpit == endpit)
380 return pars[startpit].asString(startpos, endpos, label);
382 // First paragraph in selection
383 docstring result = pars[startpit].
384 asString(startpos, pars[startpit].size(), label)
387 // The paragraphs in between (if any)
388 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
389 Paragraph const & par = pars[pit];
390 result += par.asString(0, par.size(), label)
394 // Last paragraph in selection
395 result += pars[endpit].asString(0, endpos, label);
401 void CursorData::info(odocstream & os, bool devel_mode) const
403 for (int i = 1, n = depth(); i < n; ++i) {
404 operator[](i).inset().infoize(os);
408 Inset const * inset = prevInset();
409 // prevInset() can return 0 in certain case.
411 prevInset()->infoize2(os);
414 InsetMath * math = inset().asInsetMath();
416 os << _(", Inset: ") << math->id();
417 os << _(", Cell: ") << idx();
418 os << _(", Position: ") << pos();
423 docstring CursorData::currentState(bool devel_mode) const
427 info(os, devel_mode);
432 return text()->currentState(*this, devel_mode);
438 void CursorData::markNewWordPosition()
440 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
441 FontSpan nw = locateWord(WHOLE_WORD);
442 if (nw.size() == 1) {
443 LYXERR(Debug::DEBUG, "start new word: "
445 << " pos: " << nw.first);
452 void CursorData::clearNewWordPosition()
454 if (!new_word_.empty()) {
455 LYXERR(Debug::DEBUG, "clear new word: "
457 << " pos: " << pos());
463 void CursorData::checkNewWordPosition()
465 if (!lyxrc.spellcheck_continuously || new_word_.empty())
467 // forget the position of the current new word if
468 // 1) or the remembered position was "broken"
469 // 2) or the count of nested insets changed
470 // 3) the top-level inset is not the same anymore
471 // 4) the cell index changed
472 // 5) or the paragraph changed
473 // 6) or the cursor pos is out of paragraph bound
474 if (new_word_.fixIfBroken()
475 || depth() != new_word_.depth()
476 || &inset() != &new_word_.inset()
477 || pit() != new_word_.pit()
478 || idx() != new_word_.idx()
479 || new_word_.pos() > new_word_.lastpos())
480 clearNewWordPosition();
482 FontSpan nw = locateWord(WHOLE_WORD);
484 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
485 if (nw.intersect(ow).empty())
486 clearNewWordPosition();
488 LYXERR(Debug::DEBUG, "new word: "
490 << " pos: " << nw.first << ".." << nw.last);
492 clearNewWordPosition();
497 void CursorData::clearSelection()
500 setWordSelection(false);
506 int CursorData::countInsetsInSelection(InsetCode const & inset_code) const
511 DocIterator from, to;
512 from = selectionBegin();
517 if (!from.nextInset()) //move to closest inset
520 while (!from.empty() && from < to) {
521 Inset * inset = from.nextInset();
524 if (inset->lyxCode() == inset_code)
532 bool CursorData::insetInSelection(InsetCode const & inset_code) const
537 DocIterator from, to;
538 from = selectionBegin();
541 if (!from.nextInset()) //move to closest inset
544 while (!from.empty() && from < to) {
545 Inset * inset = from.nextInset();
548 if (inset->lyxCode() == inset_code)
556 bool CursorData::fixIfBroken()
558 bool const broken_cursor = DocIterator::fixIfBroken();
559 bool const broken_anchor = anchor_.fixIfBroken();
561 if (broken_cursor || broken_anchor) {
562 clearNewWordPosition();
570 void CursorData::sanitize()
572 DocIterator::sanitize();
573 new_word_.sanitize();
581 bool CursorData::undoAction()
583 if (!buffer()->undo().undoAction(*this))
590 bool CursorData::redoAction()
592 if (!buffer()->undo().redoAction(*this))
599 void CursorData::finishUndo() const
601 buffer()->undo().finishUndo();
605 void CursorData::beginUndoGroup() const
607 buffer()->undo().beginUndoGroup(*this);
611 void CursorData::endUndoGroup() const
613 buffer()->undo().endUndoGroup(*this);
617 void CursorData::splitUndoGroup() const
619 buffer()->undo().splitUndoGroup(*this);
623 void CursorData::recordUndo(pit_type from, pit_type to) const
625 buffer()->undo().recordUndo(*this, from, to);
629 void CursorData::recordUndo(pit_type from) const
631 buffer()->undo().recordUndo(*this, from, pit());
635 void CursorData::recordUndo(UndoKind kind) const
637 buffer()->undo().recordUndo(*this, kind);
641 void CursorData::recordUndoInset(Inset const * inset) const
643 buffer()->undo().recordUndoInset(*this, inset);
647 void CursorData::recordUndoFullBuffer() const
649 buffer()->undo().recordUndoFullBuffer(*this);
653 void CursorData::recordUndoBufferParams() const
655 buffer()->undo().recordUndoBufferParams(*this);
659 void CursorData::recordUndoSelection() const
662 if (cap::multipleCellsSelected(*this))
667 buffer()->undo().recordUndo(*this,
668 selBegin().pit(), selEnd().pit());
673 int CursorData::currentMode() const
675 LASSERT(!empty(), return Inset::UNDECIDED_MODE);
676 for (int i = depth() - 1; i >= 0; --i) {
677 int res = operator[](i).inset().currentMode();
678 bool locked_mode = operator[](i).inset().lockedMode();
679 // Also return UNDECIDED_MODE when the mode is locked,
680 // as in this case it is treated the same as TEXT_MODE
681 if (res != Inset::UNDECIDED_MODE || locked_mode)
684 return Inset::TEXT_MODE;
688 bool CursorData::confirmDeletion(bool const before) const
691 if (Inset const * inset = before ? prevInset() : nextInset())
692 return inset->confirmDeletion();
694 DocIterator dit = selectionBegin();
695 CursorSlice const end = selectionEnd().top();
696 for (; dit.top() < end; dit.top().forwardPos())
697 if (Inset const * inset = dit.nextInset())
698 if (inset->confirmDeletion())
711 // be careful: this is called from the bv's constructor, too, so
712 // bv functions are not yet available!
713 Cursor::Cursor(BufferView & bv)
714 : CursorData(&bv.buffer()), bv_(&bv),
715 x_target_(-1), textTargetOffset_(0),
716 beforeDispatchPosX_(0), beforeDispatchPosY_(0)
727 void Cursor::setCursorData(CursorData const & data)
729 CursorData::operator=(data);
733 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
737 // Try to fix cursor in case it is broken.
740 // Is this a function that acts on inset at point?
741 Inset * inset = cur.nextInset();
742 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
743 && inset && inset->getStatus(cur, cmd, status))
746 // This is, of course, a mess. Better create a new doc iterator and use
747 // this in Inset::getStatus. This might require an additional
748 // BufferView * arg, though (which should be avoided)
749 //Cursor safe = *this;
751 for ( ; cur.depth(); cur.pop()) {
752 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
753 // LASSERT: Is it safe to continue here, or should we return?
754 LASSERT(cur.idx() <= cur.lastidx(), /**/);
755 LASSERT(cur.pit() <= cur.lastpit(), /**/);
756 LASSERT(cur.pos() <= cur.lastpos(), /**/);
758 // The inset's getStatus() will return 'true' if it made
759 // a definitive decision on whether it want to handle the
760 // request or not. The result of this decision is put into
761 // the 'status' parameter.
762 if (cur.inset().getStatus(cur, cmd, status)) {
771 void Cursor::saveBeforeDispatchPosXY()
773 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
777 void Cursor::dispatch(FuncRequest const & cmd0)
779 LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
784 FuncRequest cmd = cmd0;
787 disp_ = DispatchResult();
791 // Is this a function that acts on inset at point?
792 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
794 disp_.dispatched(true);
795 disp_.screenUpdate(Update::FitCursor | Update::Force);
796 FuncRequest tmpcmd = cmd;
797 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
798 << cmd0 << endl << *this);
799 nextInset()->dispatch(*this, tmpcmd);
800 if (disp_.dispatched()) {
806 // store some values to be used inside of the handlers
807 beforeDispatchCursor_ = *this;
808 for (; depth(); pop(), boundary(false)) {
809 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
810 << cmd0 << endl << *this);
812 // In any of these cases, the cursor is invalid, and we should
813 // try to save this document rather than crash.
814 LBUFERR(pos() <= lastpos());
815 LBUFERR(idx() <= lastidx());
816 LBUFERR(pit() <= lastpit());
818 // The common case is 'LFUN handled, need update', so make the
819 // LFUN handler's life easier by assuming this as default value.
820 // The handler can reset the update and val flags if necessary.
821 disp_.screenUpdate(Update::FitCursor | Update::Force);
822 disp_.dispatched(true);
823 inset().dispatch(*this, cmd);
824 if (disp_.dispatched())
828 // it completely to get a 'bomb early' behaviour in case this
829 // object will be used again.
830 if (!disp_.dispatched()) {
831 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
832 // We might have invalidated the cursor when removing an empty
833 // paragraph while the cursor could not be moved out the inset
834 // while we initially thought we could. This might happen when
835 // a multiline inset becomes an inline inset when the second
836 // paragraph is removed.
837 if (safe.pit() > safe.lastpit()) {
838 safe.pit() = safe.lastpit();
839 safe.pos() = safe.lastpos();
842 disp_.screenUpdate(Update::None);
843 disp_.dispatched(false);
845 // restore the previous one because nested Cursor::dispatch calls
846 // are possible which would change it
847 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
851 // NOTE: The code below has been copied to BufferView::dispatch.
852 // If you need to modify this, please update the other one too.
854 // notify insets we just left
856 old.beginUndoGroup();
858 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
861 bv().resetInlineCompletionPos();
868 DispatchResult const & Cursor::result() const
874 void Cursor::message(docstring const & msg) const
876 disp_.setMessage(msg);
880 void Cursor::errorMessage(docstring const & msg) const
882 disp_.setMessage(msg);
883 disp_.setError(true);
887 BufferView & Cursor::bv() const
896 LBUFERR(depth() >= 1);
901 void Cursor::push(Inset & inset)
903 push_back(CursorSlice(inset));
904 inset.setBuffer(*buffer());
908 void Cursor::pushBackward(Inset & inset)
910 LASSERT(!empty(), return);
911 //lyxerr << "Entering inset " << t << " front" << endl;
913 inset.idxFirst(*this);
917 void Cursor::editInsertedInset()
919 LASSERT(!empty(), return);
923 InsetMath &p = prevMath();
930 // this could be a while() loop, but only one cell is not empty in
931 // cases we are interested in. The cell is not empty because we
932 // have inserted the selection in there.
933 if (!cell().empty()) {
934 // if it is not empty, move to the next one.
935 if (!inset().idxNext(*this))
936 // If there is no next one, exit the inset.
942 bool Cursor::popBackward()
944 LASSERT(!empty(), return false);
952 bool Cursor::popForward()
954 LASSERT(!empty(), return false);
955 //lyxerr << "Leaving inset from in back" << endl;
956 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
960 pos() += lastpos() - lp + 1;
965 void Cursor::getPos(int & x, int & y) const
967 Point p = bv().getPos(*this);
973 Row const & Cursor::textRow() const
975 CursorSlice const & cs = innerTextSlice();
976 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
977 return pm.getRow(pos(), boundary());
981 bool Cursor::posVisRight(bool skip_inset)
983 Cursor new_cur = *this; // where we will move to
984 pos_type left_pos; // position visually left of current cursor
985 pos_type right_pos; // position visually right of current cursor
987 getSurroundingPos(left_pos, right_pos);
989 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
991 // Are we at an inset?
992 new_cur.pos() = right_pos;
993 new_cur.boundary(false);
995 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
996 // we actually move the cursor at the end of this
997 // function, for now we just keep track of the new
998 // position in new_cur...
999 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
1002 // Are we already at rightmost pos in row?
1003 else if (text()->empty() || right_pos == -1) {
1006 if (!new_cur.posVisToNewRow(false)) {
1007 LYXERR(Debug::RTL, "not moving!");
1011 // we actually move the cursor at the end of this
1012 // function, for now just keep track of the new
1013 // position in new_cur...
1014 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
1015 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
1018 // normal movement to the right
1021 // Recall, if the cursor is at position 'x', that
1022 // means *before* the character at position 'x'. In
1023 // RTL, "before" means "to the right of", in LTR, "to
1024 // the left of". So currently our situation is this:
1025 // the position to our right is 'right_pos' (i.e.,
1026 // we're currently to the left of 'right_pos'). In
1027 // order to move to the right, it depends whether or
1028 // not the character at 'right_pos' is RTL.
1029 bool const new_pos_is_RTL = paragraph().getFontSettings(
1030 buffer()->params(), right_pos).isVisibleRightToLeft();
1031 // If the character at 'right_pos' *is* LTR, then in
1032 // order to move to the right of it, we need to be
1033 // *after* 'right_pos', i.e., move to position
1035 if (!new_pos_is_RTL) {
1036 new_cur.pos() = right_pos + 1;
1037 // set the boundary to true in two situations:
1039 // 1. if new_pos is now lastpos, and we're in
1040 // an RTL paragraph (this means that we're
1041 // moving right to the end of an LTR chunk
1042 // which is at the end of an RTL paragraph);
1043 (new_cur.pos() == lastpos()
1044 && paragraph().isRTL(buffer()->params()))
1045 // 2. if the position *after* right_pos is RTL
1046 // (we want to be *after* right_pos, not
1047 // before right_pos + 1!)
1048 || paragraph().getFontSettings(buffer()->params(),
1049 new_cur.pos()).isVisibleRightToLeft()
1051 new_cur.boundary(true);
1052 else // set the boundary to false
1053 new_cur.boundary(false);
1055 // Otherwise (if the character at position 'right_pos'
1056 // is RTL), then moving to the right of it is as easy
1057 // as setting the new position to 'right_pos'.
1059 new_cur.pos() = right_pos;
1060 new_cur.boundary(false);
1065 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
1068 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
1069 << (new_cur.boundary() ? " (boundary)" : ""));
1077 bool Cursor::posVisLeft(bool skip_inset)
1079 Cursor new_cur = *this; // where we will move to
1080 pos_type left_pos; // position visually left of current cursor
1081 pos_type right_pos; // position visually right of current cursor
1083 getSurroundingPos(left_pos, right_pos);
1085 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
1087 // Are we at an inset?
1088 new_cur.pos() = left_pos;
1089 new_cur.boundary(false);
1091 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
1092 // we actually move the cursor at the end of this
1093 // function, for now we just keep track of the new
1094 // position in new_cur...
1095 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
1098 // Are we already at leftmost pos in row?
1099 else if (text()->empty() || left_pos == -1) {
1102 if (!new_cur.posVisToNewRow(true)) {
1103 LYXERR(Debug::RTL, "not moving!");
1107 // we actually move the cursor at the end of this
1108 // function, for now just keep track of the new
1109 // position in new_cur...
1110 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
1111 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
1114 // normal movement to the left
1117 // Recall, if the cursor is at position 'x', that
1118 // means *before* the character at position 'x'. In
1119 // RTL, "before" means "to the right of", in LTR, "to
1120 // the left of". So currently our situation is this:
1121 // the position to our left is 'left_pos' (i.e., we're
1122 // currently to the right of 'left_pos'). In order to
1123 // move to the left, it depends whether or not the
1124 // character at 'left_pos' is RTL.
1125 bool const new_pos_is_RTL = paragraph().getFontSettings(
1126 buffer()->params(), left_pos).isVisibleRightToLeft();
1127 // If the character at 'left_pos' *is* RTL, then in
1128 // order to move to the left of it, we need to be
1129 // *after* 'left_pos', i.e., move to position
1131 if (new_pos_is_RTL) {
1132 new_cur.pos() = left_pos + 1;
1133 // set the boundary to true in two situations:
1135 // 1. if new_pos is now lastpos and we're in
1136 // an LTR paragraph (this means that we're
1137 // moving left to the end of an RTL chunk
1138 // which is at the end of an LTR paragraph);
1139 (new_cur.pos() == lastpos()
1140 && !paragraph().isRTL(buffer()->params()))
1141 // 2. if the position *after* left_pos is not
1142 // RTL (we want to be *after* left_pos, not
1143 // before left_pos + 1!)
1144 || !paragraph().getFontSettings(buffer()->params(),
1145 new_cur.pos()).isVisibleRightToLeft()
1147 new_cur.boundary(true);
1148 else // set the boundary to false
1149 new_cur.boundary(false);
1151 // Otherwise (if the character at position 'left_pos'
1152 // is LTR), then moving to the left of it is as easy
1153 // as setting the new position to 'left_pos'.
1155 new_cur.pos() = left_pos;
1156 new_cur.boundary(false);
1161 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
1164 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
1165 << (new_cur.boundary() ? " (boundary)" : ""));
1175 // Return true on success
1176 bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
1179 while (cit != row.begin() && cit->isVirtual())
1182 while (cit != row.end() && cit->isVirtual())
1185 return cit != row.end() && !cit->isVirtual();
1190 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
1192 // by default, we know nothing.
1196 Row const & row = textRow();
1198 Row::const_iterator cit = row.findElement(pos(), boundary(), dummy);
1199 // Handle the case of empty row
1200 if (cit == row.end()) {
1202 right_pos = row.pos();
1204 left_pos = row.pos() - 1;
1208 // skip virtual elements and exit if no non-virtual one exists
1209 if (!findNonVirtual(row, cit, !cit->isRTL()))
1212 // if the position is at the left side of the element, we have to
1213 // look at the previous element
1214 if (pos() == cit->left_pos()) {
1215 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
1216 << "), AT LEFT of *cit=" << *cit);
1217 // this one is easy (see common case below)
1218 right_pos = pos() - (cit->isRTL() ? 1 : 0);
1219 // at the left of the row
1220 if (cit == row.begin())
1223 if (!findNonVirtual(row, cit, true))
1225 // [...[ is the row element, | is cursor position (! with boundary)
1226 // [ 1 2 [ is a ltr row element with pos=1 and endpos=3
1227 // ] 2 1] is an rtl row element with pos=1 and endpos=3
1228 // [ 1 2 [ [|3 4 [ => (2, 3)
1229 // or [ 1 2 [ ]!4 3 ] => (2, 4)
1230 // or ] 2 1 ] [|3 4 [ => (1, 3)
1231 // or ] 4 3 ] ]!2 1 ] => (3, 2)
1232 left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
1233 // happens with consecutive row of same direction
1234 if (left_pos == right_pos) {
1235 left_pos += cit->isRTL() ? 1 : -1;
1238 // same code but with the element at the right
1239 else if (pos() == cit->right_pos()) {
1240 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
1241 << "), AT RIGHT of *cit=" << *cit);
1242 // this one is easy (see common case below)
1243 left_pos = pos() - (cit->isRTL() ? 0 : 1);
1244 // at the right of the row
1245 if (cit + 1 == row.end())
1248 if (!findNonVirtual(row, cit, false))
1250 // [ 1 2![ [ 3 4 [ => (2, 3)
1251 // or [ 1 2![ ] 4 3 ] => (2, 4)
1252 // or ] 2 1|] [ 3 4 [ => (1, 3)
1253 // or ] 4 3|] ] 2 1 ] => (3, 2)
1254 right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
1255 // happens with consecutive row of same direction
1256 if (right_pos == left_pos)
1257 right_pos += cit->isRTL() ? -1 : 1;
1259 // common case: both positions are inside the row element
1261 // [ 1 2|3 [ => (2, 3)
1262 // or ] 3|2 1 ] => (3, 2)
1263 left_pos = pos() - (cit->isRTL() ? 0 : 1);
1264 right_pos = pos() - (cit->isRTL() ? 1 : 0);
1267 // Note that debug message does not catch all early returns above
1268 LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
1269 << ") => (" << left_pos << ", " << right_pos <<")");
1273 bool Cursor::posVisToNewRow(bool movingLeft)
1275 Row const & row = textRow();
1276 bool par_is_LTR = !row.isRTL();
1278 // Inside a table, determining whether to move to the next or
1279 // previous row should be done based on the table's direction.
1280 if (inset().asInsetTabular()) {
1281 par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
1282 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
1285 // if moving left in an LTR paragraph or moving right in an
1286 // RTL one, move to previous row
1287 if (par_is_LTR == movingLeft) {
1288 if (row.pos() == 0) { // we're at first row in paragraph
1289 if (pit() == 0) // no previous paragraph! don't move
1291 // move to last pos in previous par
1295 } else { // move to previous row in this par
1296 pos() = row.pos() - 1; // this is guaranteed to be in previous row
1300 // if moving left in an RTL paragraph or moving right in an
1301 // LTR one, move to next row
1303 if (row.endpos() == lastpos()) { // we're at last row in paragraph
1304 if (pit() == lastpit()) // last paragraph! don't move
1306 // move to first row in next par
1310 } else { // move to next row in this par
1311 pos() = row.endpos();
1316 // make sure we're at left-/right-most pos in new row
1317 posVisToRowExtremity(!movingLeft);
1323 void Cursor::posVisToRowExtremity(bool left)
1325 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
1326 << (boundary() ? 1 : 0));
1328 TextMetrics const & tm = bv_->textMetrics(text());
1329 // Looking for extremities is like clicking on the left or the
1330 // right of the row.
1331 int x = tm.origin().x_ + (left ? 0 : textRow().width());
1333 pos() = tm.getPosNearX(textRow(), x, b);
1336 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1337 << (boundary() ? 1 : 0));
1341 bool Cursor::reverseDirectionNeeded() const
1344 * We determine the directions based on the direction of the
1345 * bottom() --- i.e., outermost --- paragraph, because that is
1346 * the only way to achieve consistency of the arrow's movements
1347 * within a paragraph, and thus avoid situations in which the
1348 * cursor gets stuck.
1350 return bottom().paragraph().isRTL(bv().buffer().params());
1354 void Cursor::setTargetX(int x)
1357 textTargetOffset_ = 0;
1361 int Cursor::x_target() const
1367 void Cursor::clearTargetX()
1370 textTargetOffset_ = 0;
1374 void Cursor::updateTextTargetOffset()
1379 textTargetOffset_ = x - x_target_;
1383 bool Cursor::selHandle(bool selecting)
1385 //lyxerr << "Cursor::selHandle" << endl;
1388 if (selecting == selection())
1392 cap::saveSelection(*this);
1395 selection(selecting);
1400 bool Cursor::atFirstOrLastRow(bool up)
1402 TextMetrics const & tm = bv_->textMetrics(text());
1403 ParagraphMetrics const & pm = tm.parMetrics(pit());
1406 if (pos() && boundary())
1407 row = pm.pos2row(pos() - 1);
1409 row = pm.pos2row(pos());
1412 if (pit() == 0 && row == 0)
1415 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1416 row + 1 >= int(pm.rows().size()))
1426 ///////////////////////////////////////////////////////////////////
1429 // The part below is the non-integrated rest of the original math
1430 // cursor. This should be either generalized for texted or moved
1431 // back to mathed (in most cases to InsetMathNest).
1433 ///////////////////////////////////////////////////////////////////
1435 #include "mathed/InsetMathChar.h"
1436 #include "mathed/InsetMathUnknown.h"
1437 #include "mathed/MathStream.h"
1438 #include "mathed/MathSupport.h"
1443 bool Cursor::openable(MathAtom const & t) const
1454 // we can't move into anything new during selection
1455 if (depth() >= realAnchor().depth())
1457 if (t.nucleus() != &realAnchor()[depth()].inset())
1464 void Cursor::plainErase()
1466 cell().erase(pos());
1470 void Cursor::plainInsert(MathAtom const & t)
1472 cell().insert(pos(), t);
1474 inset().setBuffer(bv_->buffer());
1476 checkBufferStructure();
1480 void Cursor::insert(char_type c)
1482 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1483 LASSERT(!empty(), return);
1485 cap::selClearOrDel(*this);
1486 insert(new InsetMathChar(c));
1488 text()->insertChar(*this, c);
1493 void Cursor::insert(docstring const & str)
1495 for (char_type c : str)
1500 void Cursor::insert(Inset * inset0)
1502 LASSERT(inset0, return);
1504 insert(MathAtom(inset0->asInsetMath()));
1506 text()->insertInset(*this, inset0);
1507 inset0->setBuffer(bv_->buffer());
1509 if (inset0->isLabeled())
1510 forceBufferUpdate();
1515 void Cursor::insert(MathAtom const & t)
1517 LATTEST(inMathed());
1518 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1520 cap::selClearOrDel(*this);
1525 void Cursor::insert(MathData const & ar)
1527 LATTEST(inMathed());
1530 cap::eraseSelection(*this);
1531 cell().insert(pos(), ar);
1533 // FIXME audit setBuffer calls
1534 inset().setBuffer(bv_->buffer());
1538 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1540 LATTEST(inMathed());
1541 MathData ar(buffer());
1543 if (ar.size() == 1 && (enter || selection()))
1551 void Cursor::niceInsert(MathAtom const & t)
1553 LATTEST(inMathed());
1555 docstring const safe = cap::grabAndEraseSelection(*this);
1557 // If possible, enter the new inset and move the contents of the selection
1558 if (t->isActive()) {
1559 idx_type const idx = prevMath().asNestInset()->firstIdx();
1560 MathData ar(buffer());
1562 prevMath().cell(idx).insert(0, ar);
1563 editInsertedInset();
1564 } else if (t->asMacro() && !safe.empty()) {
1565 MathData ar(buffer());
1567 docstring const name = t->asMacro()->name();
1568 MacroData const * data = buffer()->getMacro(name);
1569 if (data && data->numargs() - data->optionals() > 0) {
1570 plainInsert(MathAtom(new InsetMathBrace(ar)));
1577 bool Cursor::backspace(bool const force)
1580 cap::eraseSelection(*this);
1585 // If empty cell, and not part of a big cell
1586 if (lastpos() == 0 && inset().nargs() == 1) {
1588 // Directly delete empty cell: [|[]] => [|]
1594 // [|], can not delete from inside
1598 switch (inset().asInsetMath()->getType()) {
1602 FuncRequest cmd(LFUN_CHAR_BACKWARD);
1603 this->dispatch(cmd);
1616 if (inMacroMode()) {
1617 InsetMathUnknown * p = activeMacro();
1618 if (p->name().size() > 1) {
1619 p->setName(p->name().substr(0, p->name().size() - 1));
1624 if (pos() != 0 && !force && prevAtom()->confirmDeletion()) {
1625 // let's require two backspaces for 'big stuff' and
1626 // highlight on the first
1638 bool Cursor::erase(bool const force)
1644 cap::eraseSelection(*this);
1648 // delete empty cells if possible
1649 if (pos() == lastpos() && inset().idxDelete(idx()))
1652 // special behaviour when in last position of cell
1653 if (pos() == lastpos()) {
1654 bool one_cell = inset().nargs() == 1;
1655 if (one_cell && lastpos() == 0) {
1657 // Directly delete empty cell: [|[]] => [|]
1663 // [|], can not delete from inside
1668 inset().idxGlue(idx());
1672 // 'clever' UI hack: only erase large items if previously slected
1673 if (pos() != lastpos() && !force && nextAtom()->confirmDeletion()) {
1688 DocIterator save = *this;
1689 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1690 this->dispatch(cmd);
1691 if (disp_.dispatched())
1701 DocIterator save = *this;
1702 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1703 this->dispatch(cmd);
1704 if (disp_.dispatched())
1711 void Cursor::handleNest(MathAtom const & a)
1713 idx_type const idx = a.nucleus()->asNestInset()->firstIdx();
1714 //lyxerr << "Cursor::handleNest: " << idx << endl;
1715 InsetMath const * im = selectionBegin().inset().asInsetMath();
1716 Parse::flags const f = im && im->currentMode() != InsetMath::MATH_MODE
1717 ? Parse::TEXTMODE : Parse::NORMAL;
1719 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(idx), f);
1721 editInsertedInset();
1725 int Cursor::targetX() const
1727 if (x_target() != -1)
1736 int Cursor::textTargetOffset() const
1738 return textTargetOffset_;
1742 void Cursor::setTargetX()
1751 bool Cursor::macroModeClose(bool cancel)
1755 InsetMathUnknown * p = activeMacro();
1757 MathData selection(buffer());
1758 asArray(p->selection(), selection);
1759 docstring const s = p->name();
1761 cell().erase(pos());
1763 // trigger updates of macros, at least, if no full
1764 // updates take place anyway
1765 screenUpdateFlags(Update::Force);
1767 // do nothing if the macro name is empty
1768 if (s == "\\" || cancel) {
1772 docstring const name = s.substr(1);
1773 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1774 if (in && in->interpretString(*this, s))
1776 bool const user_macro = buffer()->getMacro(name, *this, false);
1777 MathAtom atom = user_macro ? MathAtom(new InsetMathMacro(buffer(), name))
1778 : createInsetMath(name, buffer());
1780 // try to put argument into macro, if we just inserted a macro
1781 bool macroArg = false;
1782 InsetMathMacro * atomAsMacro = atom.nucleus()->asMacro();
1783 InsetMathNest * atomAsNest = atom.nucleus()->asNestInset();
1785 // macros here are still unfolded (in init mode in fact). So
1786 // we have to resolve the macro here manually and check its arity
1787 // to put the selection behind it if arity > 0.
1788 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1789 if (!selection.empty() && data && data->numargs()) {
1791 atomAsMacro->setDisplayMode(InsetMathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1793 // non-greedy case. Do not touch the arguments behind
1794 atomAsMacro->setDisplayMode(InsetMathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1797 // insert remembered selection into first argument of a non-macro
1798 else if (atomAsNest && atomAsNest->nargs() > 0)
1799 atomAsNest->cell(atomAsNest->firstIdx()).append(selection);
1801 MathWordList const & words = mathedWordList();
1802 MathWordList::const_iterator it = words.find(name);
1803 bool keep_mathmode = user_macro
1804 || (it != words.end() && (it->second.inset == "font"
1805 || it->second.inset == "oldfont"
1806 || it->second.inset == "mbox"));
1807 bool ert_macro = !user_macro && it == words.end() && atomAsMacro;
1809 if (in && in->currentMode() == Inset::TEXT_MODE
1810 && atom.nucleus()->currentMode() == Inset::MATH_MODE
1811 && name != from_ascii("ensuremath") && !ert_macro) {
1812 MathAtom at(new InsetMathEnsureMath(buffer()));
1813 at.nucleus()->cell(0).push_back(atom);
1816 } else if (in && in->currentMode() == Inset::MATH_MODE
1817 && atom.nucleus()->currentMode() == Inset::TEXT_MODE
1818 && !keep_mathmode) {
1819 MathAtom at = createInsetMath("text", buffer());
1820 at.nucleus()->cell(0).push_back(atom);
1826 // finally put the macro argument behind, if needed
1828 if (selection.size() > 1 || selection[0]->asScriptInset())
1829 plainInsert(MathAtom(new InsetMathBrace(selection)));
1838 bool Cursor::inMacroMode() const
1842 if (pos() == 0 || cell().empty())
1844 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1845 return p && !p->final();
1849 InsetMathUnknown * Cursor::activeMacro()
1851 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : nullptr;
1855 InsetMathUnknown const * Cursor::activeMacro() const
1857 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : nullptr;
1861 docstring Cursor::macroName()
1863 return inMacroMode() ? activeMacro()->name() : docstring();
1867 void Cursor::pullArg()
1870 MathData ar = cell();
1871 if (popBackward() && inMathed()) {
1873 cell().insert(pos(), ar);
1876 //formula()->mutateToText();
1881 void Cursor::normalize()
1883 if (idx() > lastidx()) {
1884 lyxerr << "this should not really happen - 1: "
1885 << idx() << ' ' << nargs()
1886 << " in: " << &inset() << endl;
1890 if (pos() > lastpos()) {
1891 lyxerr << "this should not really happen - 2: "
1892 << pos() << ' ' << lastpos() << " in idx: " << idx()
1894 odocstringstream os;
1895 otexrowstream ots(os);
1896 TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault);
1897 inset().asInsetMath()->write(wi);
1898 lyxerr << to_utf8(os.str()) << endl;
1904 bool Cursor::upDownInMath(bool up)
1906 // Be warned: The 'logic' implemented in this function is highly
1907 // fragile. A distance of one pixel or a '<' vs '<=' _really
1908 // matters. So fiddle around with it only if you think you know
1909 // what you are doing!
1913 xo = beforeDispatchPosX_;
1915 // check if we had something else in mind, if not, this is the future
1917 if (x_target_ == -1)
1919 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1920 // In text mode inside the line (not left or right) possibly set a new target_x,
1921 // but only if we are somewhere else than the previous target-offset.
1923 // We want to keep the x-target on subsequent up/down movements
1924 // that cross beyond the end of short lines. Thus a special
1925 // handling when the cursor is at the end of line: Use the new
1926 // x-target only if the old one was before the end of line
1927 // or the old one was after the beginning of the line
1928 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1932 left = pos() == textRow().endpos();
1933 right = pos() == textRow().pos();
1935 left = pos() == textRow().pos();
1936 right = pos() == textRow().endpos();
1938 if ((!left && !right) ||
1939 (left && !right && xo < x_target_) ||
1940 (!left && right && x_target_ < xo))
1947 // try neigbouring script insets
1949 if (inMathed() && !selection()) {
1952 InsetMathScript const * p = prevAtom()->asScriptInset();
1953 if (p && p->has(up)) {
1955 push(*const_cast<InsetMathScript*>(p));
1956 idx() = p->idxOfScript(up);
1959 // we went in the right direction? Otherwise don't jump into the script
1963 int oy = beforeDispatchPosY_;
1964 if ((!up && y <= oy) ||
1973 if (pos() != lastpos()) {
1974 InsetMathScript const * p = nextAtom()->asScriptInset();
1975 if (p && p->has(up)) {
1976 push(*const_cast<InsetMathScript*>(p));
1977 idx() = p->idxOfScript(up);
1980 // we went in the right direction? Otherwise don't jump into the script
1984 int oy = beforeDispatchPosY_;
1985 if ((!up && y <= oy) ||
1994 // try to find an inset that knows better then we,
1995 if (inset().idxUpDown(*this, up)) {
1996 //lyxerr << "idxUpDown triggered" << endl;
1997 // try to find best position within this inset
1999 setCursor(bruteFind(*this, xo, yo));
2003 // any improvement going just out of inset?
2004 if (popBackward() && inMathed()) {
2005 //lyxerr << "updown: popBackward succeeded" << endl;
2008 int yold = beforeDispatchPosY_;
2010 if (up ? ynew < yold : ynew > yold)
2014 // no success, we are probably at the document top or bottom
2020 bool Cursor::mathForward(bool word)
2022 LASSERT(inMathed(), return false);
2023 if (pos() < lastpos()) {
2025 // word: skip a group of insets of the form X*(B*|R*|P*) (greedy
2026 // match) where X is any math class, B is mathbin, R is mathrel, and
2027 // P is mathpunct. Make sure that the following remains true:
2028 // mathForward(true); mathBackward(true); mathForward(true)
2029 // is the same as mathForward(true) and
2030 // mathBackward(true); mathForward(true); mathBackward(true)
2031 // is the same as mathBackward(true).
2032 MathClass mc = nextMath().mathClass();
2035 while (pos() < lastpos() && mc == nextMath().mathClass());
2036 if (pos() < lastpos() &&
2037 ((mc = nextMath().mathClass()) == MC_BIN ||
2038 mc == MC_REL || mc == MC_PUNCT))
2041 while (pos() < lastpos() && mc == nextMath().mathClass());
2042 } else if (openable(nextAtom())) {
2043 InsetMathScript const * n = nextMath().asScriptInset();
2044 bool to_brace_deco = n && !n->nuc().empty()
2045 && n->nuc().back()->lyxCode() == MATH_DECORATION_CODE
2046 && n->nuc().back()->mathClass() == MC_OP;
2047 // single step: try to enter the next inset
2048 pushBackward(nextMath());
2049 inset().idxFirst(*this);
2050 // Make sure the cursor moves directly to an
2051 // \overbrace or \underbrace inset (bug 2264)
2052 if (to_brace_deco) {
2053 pushBackward(nextMath());
2054 inset().idxFirst(*this);
2060 if (inset().idxForward(*this))
2062 InsetMath const * m = inset().asInsetMath();
2063 bool from_brace_deco = m
2064 && m->lyxCode() == MATH_DECORATION_CODE
2065 && m->mathClass() == MC_OP;
2066 // try to pop forwards --- but don't pop out of math! leave that to
2068 int s = depth() - 2;
2069 if (s >= 0 && operator[](s).inset().asInsetMath() && popForward()) {
2070 // Make sure the cursor moves directly to an
2071 // \overbrace or \underbrace inset (bug 2264)
2072 bool to_script = inset().asInsetMath()
2073 && inset().asInsetMath()->asScriptInset();
2074 return from_brace_deco && to_script ? mathForward(word) : true;
2080 bool Cursor::mathBackward(bool word)
2082 LASSERT(inMathed(), return false);
2085 // word: skip a group of insets. See the comment in mathForward.
2086 MathClass mc = prevMath().mathClass();
2089 while (pos() > 0 && mc == prevMath().mathClass());
2090 if (pos() > 0 && (mc == MC_BIN || mc == MC_REL || mc == MC_PUNCT)) {
2091 mc = prevMath().mathClass();
2094 while (pos() > 0 && mc == prevMath().mathClass());
2096 } else if (openable(prevAtom())) {
2097 InsetMathScript const * p = prevMath().asScriptInset();
2098 bool to_brace_deco = p && !p->nuc().empty()
2099 && p->nuc().back()->lyxCode() == MATH_DECORATION_CODE
2100 && p->nuc().back()->mathClass() == MC_OP;
2101 // single step: try to enter the preceding inset
2104 inset().idxLast(*this);
2105 // Make sure the cursor moves directly to an
2106 // \overbrace or \underbrace inset (bug 2264)
2107 if (to_brace_deco) {
2110 inset().idxLast(*this);
2116 if (inset().idxBackward(*this))
2118 InsetMath const * m = inset().asInsetMath();
2119 bool from_brace_deco = m
2120 && m->lyxCode() == MATH_DECORATION_CODE
2121 && m->mathClass() == MC_OP;
2122 // try to pop backwards --- but don't pop out of math! leave that to
2124 int s = depth() - 2;
2125 if (s >= 0 && operator[](s).inset().asInsetMath() && popBackward()) {
2126 // Make sure the cursor moves directly to an
2127 // \overbrace or \underbrace inset (bug 2264)
2128 bool to_script = inset().asInsetMath()
2129 && inset().asInsetMath()->asScriptInset();
2130 return from_brace_deco && to_script ? mathBackward(word) : true;
2136 bool Cursor::upDownInText(bool up, bool & updateNeeded)
2138 LASSERT(text(), return false);
2144 xo = beforeDispatchPosX_;
2146 // update the targetX - this is here before the "return false"
2147 // to set a new target which can be used by InsetTexts above
2148 // if we cannot move up/down inside this inset anymore
2149 if (x_target_ == -1)
2151 else if (xo - textTargetOffset() != x_target() &&
2152 depth() == beforeDispatchCursor_.depth()) {
2153 // In text mode inside the line (not left or right)
2154 // possibly set a new target_x, but only if we are
2155 // somewhere else than the previous target-offset.
2157 // We want to keep the x-target on subsequent up/down
2158 // movements that cross beyond the end of short lines.
2159 // Thus a special handling when the cursor is at the
2160 // end of line: Use the new x-target only if the old
2161 // one was before the end of line or the old one was
2162 // after the beginning of the line
2163 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
2167 left = pos() == textRow().endpos();
2168 right = pos() == textRow().pos();
2170 left = pos() == textRow().pos();
2171 right = pos() == textRow().endpos();
2173 if ((!left && !right) ||
2174 (left && !right && xo < x_target_) ||
2175 (!left && right && x_target_ < xo))
2182 // first get the current line
2183 TextMetrics & tm = bv_->textMetrics(text());
2184 ParagraphMetrics const & pm = tm.parMetrics(pit());
2186 if (pos() && boundary())
2187 row = pm.pos2row(pos() - 1);
2189 row = pm.pos2row(pos());
2191 if (atFirstOrLastRow(up)) {
2192 // Is there a place for the cursor to go ? If yes, we
2193 // can execute the DEPM, otherwise we should keep the
2194 // paragraph to host the cursor.
2195 Cursor dummy = *this;
2196 bool valid_destination = false;
2197 for(; dummy.depth(); dummy.pop())
2198 if (!dummy.atFirstOrLastRow(up)) {
2199 valid_destination = true;
2203 // will a next dispatch follow and if there is a new
2204 // dispatch will it move the cursor out ?
2205 if (depth() > 1 && valid_destination) {
2206 // The cursor hasn't changed yet. This happens when
2207 // you e.g. move out of an inset. And to give the
2208 // DEPM the possibility of doing something we must
2209 // provide it with two different cursors. (Lgb, vfr)
2211 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
2212 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
2214 updateNeeded |= bv().checkDepm(dummy, *this);
2215 updateTextTargetOffset();
2217 forceBufferUpdate();
2219 return valid_destination;
2222 // with and without selection are handled differently
2224 int yo1 = bv().getPos(*this).y_;
2226 // To next/previous row
2227 // FIXME: the y position is often guessed wrongly across styles and
2228 // insets, which leads to weird behaviour.
2230 tm.editXY(*this, xo, yo1 - textRow().ascent() - 1);
2232 tm.editXY(*this, xo, yo1 + textRow().descent() + 1);
2233 x_target_ = old.x_target_;
2236 // This happens when you move out of an inset.
2237 // And to give the DEPM the possibility of doing
2238 // something we must provide it with two different
2240 Cursor dummy = *this;
2243 if (bv().checkDepm(dummy, old)) {
2244 updateNeeded = true;
2245 // Make sure that cur gets back whatever happened to dummy (Lgb)
2248 if (inTexted() && pos() && paragraph().isEnvSeparator(pos() - 1))
2251 // if there is a selection, we stay out of any inset,
2252 // and just jump to the right position:
2258 } else if (pit() > 0) {
2260 TextMetrics & tm2 = bv_->textMetrics(text());
2261 if (!tm2.contains(pit()))
2262 tm2.newParMetricsUp();
2263 ParagraphMetrics const & pmcur = tm2.parMetrics(pit());
2264 next_row = pmcur.rows().size() - 1;
2267 if (row + 1 < int(pm.rows().size())) {
2269 } else if (pit() + 1 < int(text()->paragraphs().size())) {
2271 TextMetrics & tm2 = bv_->textMetrics(text());
2272 if (!tm2.contains(pit()))
2273 tm2.newParMetricsDown();
2278 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
2280 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
2282 // When selection==false, this is done by TextMetrics::editXY
2285 updateNeeded |= bv().checkDepm(*this, old);
2289 forceBufferUpdate();
2290 updateTextTargetOffset();
2295 void Cursor::handleFont(string const & font)
2297 LYXERR(Debug::DEBUG, font);
2301 safe = cap::grabAndEraseSelection(*this);
2306 if (lastpos() != 0) {
2307 // something left in the cell
2309 // cursor in first position
2311 } else if (pos() == lastpos()) {
2312 // cursor in last position
2315 // cursor in between. split cell
2316 MathData::iterator bt = cell().begin();
2317 MathAtom at = createInsetMath(from_utf8(font), buffer());
2318 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2319 cell().erase(bt, bt + pos());
2324 // nothing left in the cell
2333 void Cursor::undispatched() const
2335 disp_.dispatched(false);
2339 void Cursor::dispatched() const
2341 disp_.dispatched(true);
2345 void Cursor::screenUpdateFlags(Update::flags f) const
2347 disp_.screenUpdate(f);
2351 void Cursor::noScreenUpdate() const
2353 disp_.screenUpdate(Update::None);
2357 void Cursor::forceBufferUpdate() const
2359 disp_.forceBufferUpdate();
2363 void Cursor::clearBufferUpdate() const
2365 disp_.clearBufferUpdate();
2369 bool Cursor::needBufferUpdate() const
2371 return disp_.needBufferUpdate();
2375 Font Cursor::getFont() const
2377 // The logic here should more or less match to the
2378 // Cursor::setCurrentFont logic, i.e. the cursor height should
2379 // give a hint what will happen if a character is entered.
2380 // FIXME: this is not the case, what about removing this method ? (see #10478).
2382 // HACK. far from being perfect...
2384 CursorSlice const & sl = innerTextSlice();
2385 Text const & text = *sl.text();
2386 Paragraph const & par = text.getPar(sl.pit());
2388 // on boundary, so we are really at the character before
2389 pos_type pos = sl.pos();
2390 if (pos > 0 && boundary())
2393 // on space? Take the font before (only for RTL boundary stay)
2395 TextMetrics const & tm = bv().textMetrics(&text);
2396 if (pos == sl.lastpos()
2397 || (par.isSeparator(pos)
2398 && !tm.isRTLBoundary(sl.pit(), pos)))
2402 // get font at the position
2403 Font font = par.getFont(buffer()->params(), pos,
2404 text.outerFont(sl.pit()));
2410 void Cursor::sanitize()
2412 setBuffer(&bv_->buffer());
2413 CursorData::sanitize();
2417 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2419 // find inset in common
2421 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2422 if (&old[i].inset() != &cur[i].inset())
2426 // update words if we just moved to another paragraph
2427 if (i == old.depth() && i == cur.depth()
2428 && !cur.buffer()->isClean()
2429 && cur.inTexted() && old.inTexted()
2430 && cur.pit() != old.pit()) {
2431 old.paragraph().updateWords();
2434 // notify everything on top of the common part in old cursor,
2435 // but stop if the inset claims the cursor to be invalid now
2436 for (size_type j = i; j < old.depth(); ++j) {
2437 Cursor inset_pos = old;
2438 inset_pos.cutOff(j);
2439 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2443 // notify everything on top of the common part in new cursor,
2444 // but stop if the inset claims the cursor to be invalid now
2445 for (; i < cur.depth(); ++i) {
2446 if (cur[i].inset().notifyCursorEnters(cur))
2454 void Cursor::setLanguageFromInput()
2456 if (!lyxrc.respect_os_kbd_language
2458 || paragraph().isPassThru())
2460 string const & code = theApp()->inputLanguageCode();
2461 Language const * lang = languages.getFromCode(code, buffer()->getLanguages());
2463 current_font.setLanguage(lang);
2464 real_current_font.setLanguage(lang);
2466 LYXERR0("setLanguageFromCode: unknown language code " << code);
2470 void Cursor::setCurrentFont()
2472 CursorSlice const & cs = innerTextSlice();
2473 Paragraph const & par = cs.paragraph();
2474 pos_type cpit = cs.pit();
2475 pos_type cpos = cs.pos();
2476 Text const & ctext = *cs.text();
2477 TextMetrics const & tm = bv().textMetrics(&ctext);
2479 // are we behind previous char in fact? -> go to that char
2480 if (cpos > 0 && boundary())
2483 // find position to take the font from
2485 // paragraph end? -> font of last char
2486 if (cpos == lastpos())
2488 // on space? -> look at the words in front of space
2489 else if (cpos > 0 && par.isSeparator(cpos)) {
2490 // abc| def -> font of c
2491 // abc |[WERBEH], i.e. boundary==true -> font of c
2492 // abc [WERBEH]| def, font of the space
2493 if (!tm.isRTLBoundary(cpit, cpos))
2499 BufferParams const & bufparams = buffer()->params();
2500 current_font = par.getFontSettings(bufparams, cpos);
2501 real_current_font = tm.displayFont(cpit, cpos);
2503 // set language to input language
2504 setLanguageFromInput();
2506 // special case for paragraph end
2507 if (cs.pos() == lastpos()
2508 && tm.isRTLBoundary(cpit, cs.pos())
2510 Language const * lang = par.getParLanguage(bufparams);
2511 current_font.setLanguage(lang);
2512 current_font.fontInfo().setNumber(FONT_OFF);
2513 real_current_font.setLanguage(lang);
2514 real_current_font.fontInfo().setNumber(FONT_OFF);
2517 // No language in pass thru situations
2518 if (cs.paragraph().isPassThru()) {
2519 current_font.setLanguage(latex_language);
2520 real_current_font.setLanguage(latex_language);
2525 void Cursor::checkBufferStructure()
2527 if (buffer()->isInternal())
2530 Buffer const * master = buffer()->masterBuffer();
2531 master->tocBackend().updateItem(*this);
2532 if (master != buffer() && !master->hasGuiDelegate())
2533 // In case the master has no gui associated with it,
2534 // the TocItem is not updated (part of bug 5699).
2535 buffer()->tocBackend().updateItem(*this);
2539 void Cursor::moveToClosestEdge(int const x, bool const edit)
2541 if (Inset const * inset = nextInset()) {
2542 // stay in front of insets for which we want to open the dialog
2543 // (e.g. InsetMathSpace).
2544 if (edit && (inset->hasSettings() || !inset->contextMenuName().empty()))
2546 CoordCache::Insets const & insetCache = bv().coordCache().getInsets();
2547 if (!insetCache.has(inset))
2549 int const wid = insetCache.dim(inset).wid;
2550 Point p = insetCache.xy(inset);
2551 if (x > p.x_ + (wid + 1) / 2)