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()) {
333 docstring parbreak(CursorData const * cur)
335 if (cur->inset().getLayout().parbreakIgnored())
339 // only add blank line if we're not in a ParbreakIsNewline situation
340 if (!cur->inset().getLayout().parbreakIsNewline()
341 && !cur->paragraph().layout().parbreak_is_newline)
349 docstring CursorData::selectionAsString(bool const with_label, bool const skipdelete) const
355 return cap::grabSelection(*this);
357 int label = with_label
358 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
361 ? AS_STR_LABEL | AS_STR_INSETS | AS_STR_SKIPDELETE
362 : AS_STR_INSETS | AS_STR_SKIPDELETE;
364 idx_type const startidx = selBegin().idx();
365 idx_type const endidx = selEnd().idx();
366 if (startidx != endidx) {
367 // multicell selection
368 InsetTabular * table = inset().asInsetTabular();
369 LASSERT(table, return docstring());
370 return table->asString(startidx, endidx);
373 ParagraphList const & pars = text()->paragraphs();
375 pit_type const startpit = selBegin().pit();
376 pit_type const endpit = selEnd().pit();
377 size_t const startpos = selBegin().pos();
378 size_t const endpos = selEnd().pos();
380 if (startpit == endpit)
381 return pars[startpit].asString(startpos, endpos, label);
383 // First paragraph in selection
384 docstring result = pars[startpit].
385 asString(startpos, pars[startpit].size(), label)
388 // The paragraphs in between (if any)
389 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
390 Paragraph const & par = pars[pit];
391 result += par.asString(0, par.size(), label)
395 // Last paragraph in selection
396 result += pars[endpit].asString(0, endpos, label);
402 void CursorData::info(odocstream & os, bool devel_mode) const
404 for (int i = 1, n = depth(); i < n; ++i) {
405 operator[](i).inset().infoize(os);
409 Inset const * inset = prevInset();
410 // prevInset() can return 0 in certain case.
412 prevInset()->infoize2(os);
415 InsetMath * math = inset().asInsetMath();
417 os << _(", Inset: ") << math->id();
418 os << _(", Cell: ") << idx();
419 os << _(", Position: ") << pos();
424 docstring CursorData::currentState(bool devel_mode) const
428 info(os, devel_mode);
433 return text()->currentState(*this, devel_mode);
439 void CursorData::markNewWordPosition()
441 if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
442 FontSpan nw = locateWord(WHOLE_WORD);
443 if (nw.size() == 1) {
444 LYXERR(Debug::DEBUG, "start new word: "
446 << " pos: " << nw.first);
453 void CursorData::clearNewWordPosition()
455 if (!new_word_.empty()) {
456 LYXERR(Debug::DEBUG, "clear new word: "
458 << " pos: " << pos());
464 void CursorData::checkNewWordPosition()
466 if (!lyxrc.spellcheck_continuously || new_word_.empty())
468 // forget the position of the current new word if
469 // 1) or the remembered position was "broken"
470 // 2) or the count of nested insets changed
471 // 3) the top-level inset is not the same anymore
472 // 4) the cell index changed
473 // 5) or the paragraph changed
474 // 6) or the cursor pos is out of paragraph bound
475 if (new_word_.fixIfBroken()
476 || depth() != new_word_.depth()
477 || &inset() != &new_word_.inset()
478 || pit() != new_word_.pit()
479 || idx() != new_word_.idx()
480 || new_word_.pos() > new_word_.lastpos())
481 clearNewWordPosition();
483 FontSpan nw = locateWord(WHOLE_WORD);
485 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
486 if (nw.intersect(ow).empty())
487 clearNewWordPosition();
489 LYXERR(Debug::DEBUG, "new word: "
491 << " pos: " << nw.first << ".." << nw.last);
493 clearNewWordPosition();
498 void CursorData::clearSelection()
501 setWordSelection(false);
507 int CursorData::countInsetsInSelection(InsetCode const & inset_code) const
512 DocIterator from, to;
513 from = selectionBegin();
518 if (!from.nextInset()) //move to closest inset
521 while (!from.empty() && from < to) {
522 Inset * inset = from.nextInset();
525 if (inset->lyxCode() == inset_code)
533 bool CursorData::insetInSelection(InsetCode const & inset_code) const
538 DocIterator from, to;
539 from = selectionBegin();
542 if (!from.nextInset()) //move to closest inset
545 while (!from.empty() && from < to) {
546 Inset * inset = from.nextInset();
549 if (inset->lyxCode() == inset_code)
557 bool CursorData::fixIfBroken()
559 bool const broken_cursor = DocIterator::fixIfBroken();
560 bool const broken_anchor = anchor_.fixIfBroken();
562 if (broken_cursor || broken_anchor) {
563 clearNewWordPosition();
571 void CursorData::sanitize()
573 DocIterator::sanitize();
574 new_word_.sanitize();
582 bool CursorData::undoAction()
584 if (!buffer()->undo().undoAction(*this))
591 bool CursorData::redoAction()
593 if (!buffer()->undo().redoAction(*this))
600 void CursorData::finishUndo() const
602 buffer()->undo().finishUndo();
606 void CursorData::beginUndoGroup() const
608 buffer()->undo().beginUndoGroup(*this);
612 void CursorData::endUndoGroup() const
614 buffer()->undo().endUndoGroup(*this);
618 void CursorData::splitUndoGroup() const
620 buffer()->undo().splitUndoGroup(*this);
624 void CursorData::recordUndo(pit_type from, pit_type to) const
626 buffer()->undo().recordUndo(*this, from, to);
630 void CursorData::recordUndo(pit_type from) const
632 buffer()->undo().recordUndo(*this, from, pit());
636 void CursorData::recordUndo(UndoKind kind) const
638 buffer()->undo().recordUndo(*this, kind);
642 void CursorData::recordUndoInset(Inset const * inset) const
644 buffer()->undo().recordUndoInset(*this, inset);
648 void CursorData::recordUndoFullBuffer() const
650 buffer()->undo().recordUndoFullBuffer(*this);
654 void CursorData::recordUndoBufferParams() const
656 buffer()->undo().recordUndoBufferParams(*this);
660 void CursorData::recordUndoSelection() const
663 if (cap::multipleCellsSelected(*this))
668 buffer()->undo().recordUndo(*this,
669 selBegin().pit(), selEnd().pit());
674 int CursorData::currentMode() const
676 LASSERT(!empty(), return Inset::UNDECIDED_MODE);
677 for (int i = depth() - 1; i >= 0; --i) {
678 int res = operator[](i).inset().currentMode();
679 bool locked_mode = operator[](i).inset().lockedMode();
680 // Also return UNDECIDED_MODE when the mode is locked,
681 // as in this case it is treated the same as TEXT_MODE
682 if (res != Inset::UNDECIDED_MODE || locked_mode)
685 return Inset::TEXT_MODE;
689 bool CursorData::confirmDeletion(bool const before) const
692 if (Inset const * inset = before ? prevInset() : nextInset())
693 return inset->confirmDeletion();
695 DocIterator dit = selectionBegin();
696 CursorSlice const end = selectionEnd().top();
697 for (; dit.top() < end; dit.top().forwardPos())
698 if (Inset const * inset = dit.nextInset())
699 if (inset->confirmDeletion())
712 // be careful: this is called from the bv's constructor, too, so
713 // bv functions are not yet available!
714 Cursor::Cursor(BufferView & bv)
715 : CursorData(&bv.buffer()), bv_(&bv),
716 x_target_(-1), textTargetOffset_(0),
717 beforeDispatchPosX_(0), beforeDispatchPosY_(0)
728 void Cursor::setCursorData(CursorData const & data)
730 CursorData::operator=(data);
734 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
738 // Try to fix cursor in case it is broken.
741 // Is this a function that acts on inset at point?
742 Inset * inset = cur.nextInset();
743 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
744 && inset && inset->getStatus(cur, cmd, status))
747 // This is, of course, a mess. Better create a new doc iterator and use
748 // this in Inset::getStatus. This might require an additional
749 // BufferView * arg, though (which should be avoided)
750 //Cursor safe = *this;
752 for ( ; cur.depth(); cur.pop()) {
753 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
754 // LASSERT: Is it safe to continue here, or should we return?
755 LASSERT(cur.idx() <= cur.lastidx(), /**/);
756 LASSERT(cur.pit() <= cur.lastpit(), /**/);
757 LASSERT(cur.pos() <= cur.lastpos(), /**/);
759 // The inset's getStatus() will return 'true' if it made
760 // a definitive decision on whether it want to handle the
761 // request or not. The result of this decision is put into
762 // the 'status' parameter.
763 if (cur.inset().getStatus(cur, cmd, status)) {
772 void Cursor::saveBeforeDispatchPosXY()
774 getPos(beforeDispatchPosX_, beforeDispatchPosY_);
778 void Cursor::dispatch(FuncRequest const & cmd0)
780 LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
785 FuncRequest cmd = cmd0;
788 disp_ = DispatchResult();
792 // Is this a function that acts on inset at point?
793 if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
795 disp_.dispatched(true);
796 disp_.screenUpdate(Update::FitCursor | Update::Force);
797 FuncRequest tmpcmd = cmd;
798 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
799 << cmd0 << endl << *this);
800 nextInset()->dispatch(*this, tmpcmd);
801 if (disp_.dispatched()) {
807 // store some values to be used inside of the handlers
808 beforeDispatchCursor_ = *this;
809 for (; depth(); pop(), boundary(false)) {
810 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
811 << cmd0 << endl << *this);
813 // In any of these cases, the cursor is invalid, and we should
814 // try to save this document rather than crash.
815 LBUFERR(pos() <= lastpos());
816 LBUFERR(idx() <= lastidx());
817 LBUFERR(pit() <= lastpit());
819 // The common case is 'LFUN handled, need update', so make the
820 // LFUN handler's life easier by assuming this as default value.
821 // The handler can reset the update and val flags if necessary.
822 disp_.screenUpdate(Update::FitCursor | Update::Force);
823 disp_.dispatched(true);
824 inset().dispatch(*this, cmd);
825 if (disp_.dispatched())
829 // it completely to get a 'bomb early' behaviour in case this
830 // object will be used again.
831 if (!disp_.dispatched()) {
832 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
833 // We might have invalidated the cursor when removing an empty
834 // paragraph while the cursor could not be moved out the inset
835 // while we initially thought we could. This might happen when
836 // a multiline inset becomes an inline inset when the second
837 // paragraph is removed.
838 if (safe.pit() > safe.lastpit()) {
839 safe.pit() = safe.lastpit();
840 safe.pos() = safe.lastpos();
843 disp_.screenUpdate(Update::None);
844 disp_.dispatched(false);
846 // restore the previous one because nested Cursor::dispatch calls
847 // are possible which would change it
848 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
852 // NOTE: The code below has been copied to BufferView::dispatch.
853 // If you need to modify this, please update the other one too.
855 // notify insets we just left
857 old.beginUndoGroup();
859 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
862 bv().resetInlineCompletionPos();
869 DispatchResult const & Cursor::result() const
875 void Cursor::message(docstring const & msg) const
877 disp_.setMessage(msg);
881 void Cursor::errorMessage(docstring const & msg) const
883 disp_.setMessage(msg);
884 disp_.setError(true);
888 BufferView & Cursor::bv() const
897 LBUFERR(depth() >= 1);
902 void Cursor::push(Inset & inset)
904 push_back(CursorSlice(inset));
905 inset.setBuffer(*buffer());
909 void Cursor::pushBackward(Inset & inset)
911 LASSERT(!empty(), return);
912 //lyxerr << "Entering inset " << t << " front" << endl;
914 inset.idxFirst(*this);
918 void Cursor::editInsertedInset()
920 LASSERT(!empty(), return);
924 InsetMath &p = prevMath();
931 // this could be a while() loop, but only one cell is not empty in
932 // cases we are interested in. The cell is not empty because we
933 // have inserted the selection in there.
934 if (!cell().empty()) {
935 // if it is not empty, move to the next one.
936 if (!inset().idxNext(*this))
937 // If there is no next one, exit the inset.
943 bool Cursor::popBackward()
945 LASSERT(!empty(), return false);
953 bool Cursor::popForward()
955 LASSERT(!empty(), return false);
956 //lyxerr << "Leaving inset from in back" << endl;
957 const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
961 pos() += lastpos() - lp + 1;
966 void Cursor::getPos(int & x, int & y) const
968 Point p = bv().getPos(*this);
974 Row const & Cursor::textRow() const
976 CursorSlice const & cs = innerTextSlice();
977 ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
978 return pm.getRow(pos(), boundary());
982 bool Cursor::posVisRight(bool skip_inset)
984 Cursor new_cur = *this; // where we will move to
985 pos_type left_pos; // position visually left of current cursor
986 pos_type right_pos; // position visually right of current cursor
988 getSurroundingPos(left_pos, right_pos);
990 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
992 // Are we at an inset?
993 new_cur.pos() = right_pos;
994 new_cur.boundary(false);
996 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
997 // we actually move the cursor at the end of this
998 // function, for now we just keep track of the new
999 // position in new_cur...
1000 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
1003 // Are we already at rightmost pos in row?
1004 else if (text()->empty() || right_pos == -1) {
1007 if (!new_cur.posVisToNewRow(false)) {
1008 LYXERR(Debug::RTL, "not moving!");
1012 // we actually move the cursor at the end of this
1013 // function, for now just keep track of the new
1014 // position in new_cur...
1015 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
1016 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
1019 // normal movement to the right
1022 // Recall, if the cursor is at position 'x', that
1023 // means *before* the character at position 'x'. In
1024 // RTL, "before" means "to the right of", in LTR, "to
1025 // the left of". So currently our situation is this:
1026 // the position to our right is 'right_pos' (i.e.,
1027 // we're currently to the left of 'right_pos'). In
1028 // order to move to the right, it depends whether or
1029 // not the character at 'right_pos' is RTL.
1030 bool const new_pos_is_RTL = paragraph().getFontSettings(
1031 buffer()->params(), right_pos).isVisibleRightToLeft();
1032 // If the character at 'right_pos' *is* LTR, then in
1033 // order to move to the right of it, we need to be
1034 // *after* 'right_pos', i.e., move to position
1036 if (!new_pos_is_RTL) {
1037 new_cur.pos() = right_pos + 1;
1038 // set the boundary to true in two situations:
1040 // 1. if new_pos is now lastpos, and we're in
1041 // an RTL paragraph (this means that we're
1042 // moving right to the end of an LTR chunk
1043 // which is at the end of an RTL paragraph);
1044 (new_cur.pos() == lastpos()
1045 && paragraph().isRTL(buffer()->params()))
1046 // 2. if the position *after* right_pos is RTL
1047 // (we want to be *after* right_pos, not
1048 // before right_pos + 1!)
1049 || paragraph().getFontSettings(buffer()->params(),
1050 new_cur.pos()).isVisibleRightToLeft()
1052 new_cur.boundary(true);
1053 else // set the boundary to false
1054 new_cur.boundary(false);
1056 // Otherwise (if the character at position 'right_pos'
1057 // is RTL), then moving to the right of it is as easy
1058 // as setting the new position to 'right_pos'.
1060 new_cur.pos() = right_pos;
1061 new_cur.boundary(false);
1066 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
1069 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
1070 << (new_cur.boundary() ? " (boundary)" : ""));
1078 bool Cursor::posVisLeft(bool skip_inset)
1080 Cursor new_cur = *this; // where we will move to
1081 pos_type left_pos; // position visually left of current cursor
1082 pos_type right_pos; // position visually right of current cursor
1084 getSurroundingPos(left_pos, right_pos);
1086 LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
1088 // Are we at an inset?
1089 new_cur.pos() = left_pos;
1090 new_cur.boundary(false);
1092 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
1093 // we actually move the cursor at the end of this
1094 // function, for now we just keep track of the new
1095 // position in new_cur...
1096 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
1099 // Are we already at leftmost pos in row?
1100 else if (text()->empty() || left_pos == -1) {
1103 if (!new_cur.posVisToNewRow(true)) {
1104 LYXERR(Debug::RTL, "not moving!");
1108 // we actually move the cursor at the end of this
1109 // function, for now just keep track of the new
1110 // position in new_cur...
1111 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
1112 << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
1115 // normal movement to the left
1118 // Recall, if the cursor is at position 'x', that
1119 // means *before* the character at position 'x'. In
1120 // RTL, "before" means "to the right of", in LTR, "to
1121 // the left of". So currently our situation is this:
1122 // the position to our left is 'left_pos' (i.e., we're
1123 // currently to the right of 'left_pos'). In order to
1124 // move to the left, it depends whether or not the
1125 // character at 'left_pos' is RTL.
1126 bool const new_pos_is_RTL = paragraph().getFontSettings(
1127 buffer()->params(), left_pos).isVisibleRightToLeft();
1128 // If the character at 'left_pos' *is* RTL, then in
1129 // order to move to the left of it, we need to be
1130 // *after* 'left_pos', i.e., move to position
1132 if (new_pos_is_RTL) {
1133 new_cur.pos() = left_pos + 1;
1134 // set the boundary to true in two situations:
1136 // 1. if new_pos is now lastpos and we're in
1137 // an LTR paragraph (this means that we're
1138 // moving left to the end of an RTL chunk
1139 // which is at the end of an LTR paragraph);
1140 (new_cur.pos() == lastpos()
1141 && !paragraph().isRTL(buffer()->params()))
1142 // 2. if the position *after* left_pos is not
1143 // RTL (we want to be *after* left_pos, not
1144 // before left_pos + 1!)
1145 || !paragraph().getFontSettings(buffer()->params(),
1146 new_cur.pos()).isVisibleRightToLeft()
1148 new_cur.boundary(true);
1149 else // set the boundary to false
1150 new_cur.boundary(false);
1152 // Otherwise (if the character at position 'left_pos'
1153 // is LTR), then moving to the left of it is as easy
1154 // as setting the new position to 'left_pos'.
1156 new_cur.pos() = left_pos;
1157 new_cur.boundary(false);
1162 bool const moved = new_cur != *this || new_cur.boundary() != boundary();
1165 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
1166 << (new_cur.boundary() ? " (boundary)" : ""));
1176 // Return true on success
1177 bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
1180 while (cit != row.begin() && cit->isVirtual())
1183 while (cit != row.end() && cit->isVirtual())
1186 return cit != row.end() && !cit->isVirtual();
1191 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
1193 // by default, we know nothing.
1197 Row const & row = textRow();
1199 Row::const_iterator cit = row.findElement(pos(), boundary(), dummy);
1200 // Handle the case of empty row
1201 if (cit == row.end()) {
1203 right_pos = row.pos();
1205 left_pos = row.pos() - 1;
1209 // skip virtual elements and exit if no non-virtual one exists
1210 if (!findNonVirtual(row, cit, !cit->isRTL()))
1213 // if the position is at the left side of the element, we have to
1214 // look at the previous element
1215 if (pos() == cit->left_pos()) {
1216 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
1217 << "), AT LEFT of *cit=" << *cit);
1218 // this one is easy (see common case below)
1219 right_pos = pos() - (cit->isRTL() ? 1 : 0);
1220 // at the left of the row
1221 if (cit == row.begin())
1224 if (!findNonVirtual(row, cit, true))
1226 // [...[ is the row element, | is cursor position (! with boundary)
1227 // [ 1 2 [ is a ltr row element with pos=1 and endpos=3
1228 // ] 2 1] is an rtl row element with pos=1 and endpos=3
1229 // [ 1 2 [ [|3 4 [ => (2, 3)
1230 // or [ 1 2 [ ]!4 3 ] => (2, 4)
1231 // or ] 2 1 ] [|3 4 [ => (1, 3)
1232 // or ] 4 3 ] ]!2 1 ] => (3, 2)
1233 left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
1234 // happens with consecutive row of same direction
1235 if (left_pos == right_pos) {
1236 left_pos += cit->isRTL() ? 1 : -1;
1239 // same code but with the element at the right
1240 else if (pos() == cit->right_pos()) {
1241 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
1242 << "), AT RIGHT of *cit=" << *cit);
1243 // this one is easy (see common case below)
1244 left_pos = pos() - (cit->isRTL() ? 0 : 1);
1245 // at the right of the row
1246 if (cit + 1 == row.end())
1249 if (!findNonVirtual(row, cit, false))
1251 // [ 1 2![ [ 3 4 [ => (2, 3)
1252 // or [ 1 2![ ] 4 3 ] => (2, 4)
1253 // or ] 2 1|] [ 3 4 [ => (1, 3)
1254 // or ] 4 3|] ] 2 1 ] => (3, 2)
1255 right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
1256 // happens with consecutive row of same direction
1257 if (right_pos == left_pos)
1258 right_pos += cit->isRTL() ? -1 : 1;
1260 // common case: both positions are inside the row element
1262 // [ 1 2|3 [ => (2, 3)
1263 // or ] 3|2 1 ] => (3, 2)
1264 left_pos = pos() - (cit->isRTL() ? 0 : 1);
1265 right_pos = pos() - (cit->isRTL() ? 1 : 0);
1268 // Note that debug message does not catch all early returns above
1269 LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
1270 << ") => (" << left_pos << ", " << right_pos <<")");
1274 bool Cursor::posVisToNewRow(bool movingLeft)
1276 Row const & row = textRow();
1277 bool par_is_LTR = !row.isRTL();
1279 // Inside a table, determining whether to move to the next or
1280 // previous row should be done based on the table's direction.
1281 if (inset().asInsetTabular()) {
1282 par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
1283 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
1286 // if moving left in an LTR paragraph or moving right in an
1287 // RTL one, move to previous row
1288 if (par_is_LTR == movingLeft) {
1289 if (row.pos() == 0) { // we're at first row in paragraph
1290 if (pit() == 0) // no previous paragraph! don't move
1292 // move to last pos in previous par
1296 } else { // move to previous row in this par
1297 pos() = row.pos() - 1; // this is guaranteed to be in previous row
1301 // if moving left in an RTL paragraph or moving right in an
1302 // LTR one, move to next row
1304 if (row.endpos() == lastpos()) { // we're at last row in paragraph
1305 if (pit() == lastpit()) // last paragraph! don't move
1307 // move to first row in next par
1311 } else { // move to next row in this par
1312 pos() = row.endpos();
1317 // make sure we're at left-/right-most pos in new row
1318 posVisToRowExtremity(!movingLeft);
1324 void Cursor::posVisToRowExtremity(bool left)
1326 LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
1327 << (boundary() ? 1 : 0));
1329 TextMetrics const & tm = bv_->textMetrics(text());
1330 // Looking for extremities is like clicking on the left or the
1331 // right of the row.
1332 int x = tm.origin().x_ + (left ? 0 : textRow().width());
1334 pos() = tm.getPosNearX(textRow(), x, b);
1337 LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1338 << (boundary() ? 1 : 0));
1342 bool Cursor::reverseDirectionNeeded() const
1345 * We determine the directions based on the direction of the
1346 * bottom() --- i.e., outermost --- paragraph, because that is
1347 * the only way to achieve consistency of the arrow's movements
1348 * within a paragraph, and thus avoid situations in which the
1349 * cursor gets stuck.
1351 return bottom().paragraph().isRTL(bv().buffer().params());
1355 void Cursor::setTargetX(int x)
1358 textTargetOffset_ = 0;
1362 int Cursor::x_target() const
1368 void Cursor::clearTargetX()
1371 textTargetOffset_ = 0;
1375 void Cursor::updateTextTargetOffset()
1380 textTargetOffset_ = x - x_target_;
1384 bool Cursor::selHandle(bool selecting)
1386 //lyxerr << "Cursor::selHandle" << endl;
1389 if (selecting == selection())
1393 cap::saveSelection(*this);
1396 selection(selecting);
1401 bool Cursor::atFirstOrLastRow(bool up)
1403 TextMetrics const & tm = bv_->textMetrics(text());
1404 ParagraphMetrics const & pm = tm.parMetrics(pit());
1407 if (pos() && boundary())
1408 row = pm.pos2row(pos() - 1);
1410 row = pm.pos2row(pos());
1413 if (pit() == 0 && row == 0)
1416 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1417 row + 1 >= int(pm.rows().size()))
1427 ///////////////////////////////////////////////////////////////////
1430 // The part below is the non-integrated rest of the original math
1431 // cursor. This should be either generalized for texted or moved
1432 // back to mathed (in most cases to InsetMathNest).
1434 ///////////////////////////////////////////////////////////////////
1436 #include "mathed/InsetMathChar.h"
1437 #include "mathed/InsetMathUnknown.h"
1438 #include "mathed/MathStream.h"
1439 #include "mathed/MathSupport.h"
1444 bool Cursor::openable(MathAtom const & t) const
1455 // we can't move into anything new during selection
1456 if (depth() >= realAnchor().depth())
1458 if (t.nucleus() != &realAnchor()[depth()].inset())
1465 void Cursor::plainErase()
1467 cell().erase(pos());
1471 void Cursor::plainInsert(MathAtom const & t)
1473 cell().insert(pos(), t);
1475 inset().setBuffer(bv_->buffer());
1477 checkBufferStructure();
1481 void Cursor::insert(char_type c)
1483 //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1484 LASSERT(!empty(), return);
1486 cap::selClearOrDel(*this);
1487 insert(new InsetMathChar(c));
1489 text()->insertChar(*this, c);
1494 void Cursor::insert(docstring const & str)
1496 for (char_type c : str)
1501 void Cursor::insert(Inset * inset0)
1503 LASSERT(inset0, return);
1505 insert(MathAtom(inset0->asInsetMath()));
1507 text()->insertInset(*this, inset0);
1508 inset0->setBuffer(bv_->buffer());
1510 if (inset0->isLabeled())
1511 forceBufferUpdate();
1516 void Cursor::insert(MathAtom const & t)
1518 LATTEST(inMathed());
1519 //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1521 cap::selClearOrDel(*this);
1526 void Cursor::insert(MathData const & ar)
1528 LATTEST(inMathed());
1531 cap::eraseSelection(*this);
1532 cell().insert(pos(), ar);
1534 // FIXME audit setBuffer calls
1535 inset().setBuffer(bv_->buffer());
1539 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1541 LATTEST(inMathed());
1542 MathData ar(buffer());
1544 if (ar.size() == 1 && (enter || selection()))
1552 void Cursor::niceInsert(MathAtom const & t)
1554 LATTEST(inMathed());
1556 docstring const safe = cap::grabAndEraseSelection(*this);
1558 // If possible, enter the new inset and move the contents of the selection
1559 if (t->isActive()) {
1560 idx_type const idx = prevMath().asNestInset()->firstIdx();
1561 MathData ar(buffer());
1563 prevMath().cell(idx).insert(0, ar);
1564 editInsertedInset();
1565 } else if (t->asMacro() && !safe.empty()) {
1566 MathData ar(buffer());
1568 docstring const name = t->asMacro()->name();
1569 MacroData const * data = buffer()->getMacro(name);
1570 if (data && data->numargs() - data->optionals() > 0) {
1571 plainInsert(MathAtom(new InsetMathBrace(ar)));
1578 bool Cursor::backspace(bool const force)
1581 cap::eraseSelection(*this);
1586 // If empty cell, and not part of a big cell
1587 if (lastpos() == 0 && inset().nargs() == 1) {
1589 // Directly delete empty cell: [|[]] => [|]
1595 // [|], can not delete from inside
1599 switch (inset().asInsetMath()->getType()) {
1603 FuncRequest cmd(LFUN_CHAR_BACKWARD);
1604 this->dispatch(cmd);
1617 if (inMacroMode()) {
1618 InsetMathUnknown * p = activeMacro();
1619 if (p->name().size() > 1) {
1620 p->setName(p->name().substr(0, p->name().size() - 1));
1625 if (pos() != 0 && !force && prevAtom()->confirmDeletion()) {
1626 // let's require two backspaces for 'big stuff' and
1627 // highlight on the first
1639 bool Cursor::erase(bool const force)
1645 cap::eraseSelection(*this);
1649 // delete empty cells if possible
1650 if (pos() == lastpos() && inset().idxDelete(idx()))
1653 // special behaviour when in last position of cell
1654 if (pos() == lastpos()) {
1655 bool one_cell = inset().nargs() == 1;
1656 if (one_cell && lastpos() == 0) {
1658 // Directly delete empty cell: [|[]] => [|]
1664 // [|], can not delete from inside
1669 inset().idxGlue(idx());
1673 // 'clever' UI hack: only erase large items if previously slected
1674 if (pos() != lastpos() && !force && nextAtom()->confirmDeletion()) {
1689 DocIterator save = *this;
1690 FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1691 this->dispatch(cmd);
1692 if (disp_.dispatched())
1702 DocIterator save = *this;
1703 FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1704 this->dispatch(cmd);
1705 if (disp_.dispatched())
1712 void Cursor::handleNest(MathAtom const & a)
1714 idx_type const idx = a.nucleus()->asNestInset()->firstIdx();
1715 //lyxerr << "Cursor::handleNest: " << idx << endl;
1716 InsetMath const * im = selectionBegin().inset().asInsetMath();
1717 Parse::flags const f = im && im->currentMode() != InsetMath::MATH_MODE
1718 ? Parse::TEXTMODE : Parse::NORMAL;
1720 asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(idx), f);
1722 editInsertedInset();
1726 int Cursor::targetX() const
1728 if (x_target() != -1)
1737 int Cursor::textTargetOffset() const
1739 return textTargetOffset_;
1743 void Cursor::setTargetX()
1752 bool Cursor::macroModeClose(bool cancel)
1756 InsetMathUnknown * p = activeMacro();
1758 MathData selection(buffer());
1759 asArray(p->selection(), selection);
1760 docstring const s = p->name();
1762 cell().erase(pos());
1764 // trigger updates of macros, at least, if no full
1765 // updates take place anyway
1766 screenUpdateFlags(Update::Force);
1768 // do nothing if the macro name is empty
1769 if (s == "\\" || cancel) {
1773 docstring const name = s.substr(1);
1774 InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1775 if (in && in->interpretString(*this, s))
1777 bool const user_macro = buffer()->getMacro(name, *this, false);
1778 MathAtom atom = user_macro ? MathAtom(new InsetMathMacro(buffer(), name))
1779 : createInsetMath(name, buffer());
1781 // try to put argument into macro, if we just inserted a macro
1782 bool macroArg = false;
1783 InsetMathMacro * atomAsMacro = atom.nucleus()->asMacro();
1784 InsetMathNest * atomAsNest = atom.nucleus()->asNestInset();
1786 // macros here are still unfolded (in init mode in fact). So
1787 // we have to resolve the macro here manually and check its arity
1788 // to put the selection behind it if arity > 0.
1789 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1790 if (!selection.empty() && data && data->numargs()) {
1792 atomAsMacro->setDisplayMode(InsetMathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1794 // non-greedy case. Do not touch the arguments behind
1795 atomAsMacro->setDisplayMode(InsetMathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1798 // insert remembered selection into first argument of a non-macro
1799 else if (atomAsNest && atomAsNest->nargs() > 0)
1800 atomAsNest->cell(atomAsNest->firstIdx()).append(selection);
1802 MathWordList const & words = mathedWordList();
1803 MathWordList::const_iterator it = words.find(name);
1804 bool keep_mathmode = user_macro
1805 || (it != words.end() && (it->second.inset == "font"
1806 || it->second.inset == "oldfont"
1807 || it->second.inset == "mbox"));
1808 bool ert_macro = !user_macro && it == words.end() && atomAsMacro;
1810 if (in && in->currentMode() == Inset::TEXT_MODE
1811 && atom.nucleus()->currentMode() == Inset::MATH_MODE
1812 && name != from_ascii("ensuremath") && !ert_macro) {
1813 MathAtom at(new InsetMathEnsureMath(buffer()));
1814 at.nucleus()->cell(0).push_back(atom);
1817 } else if (in && in->currentMode() == Inset::MATH_MODE
1818 && atom.nucleus()->currentMode() == Inset::TEXT_MODE
1819 && !keep_mathmode) {
1820 MathAtom at = createInsetMath("text", buffer());
1821 at.nucleus()->cell(0).push_back(atom);
1827 // finally put the macro argument behind, if needed
1829 if (selection.size() > 1 || selection[0]->asScriptInset())
1830 plainInsert(MathAtom(new InsetMathBrace(selection)));
1839 bool Cursor::inMacroMode() const
1843 if (pos() == 0 || cell().empty())
1845 InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1846 return p && !p->final();
1850 InsetMathUnknown * Cursor::activeMacro()
1852 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : nullptr;
1856 InsetMathUnknown const * Cursor::activeMacro() const
1858 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : nullptr;
1862 docstring Cursor::macroName()
1864 return inMacroMode() ? activeMacro()->name() : docstring();
1868 void Cursor::pullArg()
1871 MathData ar = cell();
1872 if (popBackward() && inMathed()) {
1874 cell().insert(pos(), ar);
1877 //formula()->mutateToText();
1882 void Cursor::normalize()
1884 if (idx() > lastidx()) {
1885 lyxerr << "this should not really happen - 1: "
1886 << idx() << ' ' << nargs()
1887 << " in: " << &inset() << endl;
1891 if (pos() > lastpos()) {
1892 lyxerr << "this should not really happen - 2: "
1893 << pos() << ' ' << lastpos() << " in idx: " << idx()
1895 odocstringstream os;
1896 otexrowstream ots(os);
1897 TeXMathStream wi(ots, false, true, TeXMathStream::wsDefault);
1898 inset().asInsetMath()->write(wi);
1899 lyxerr << to_utf8(os.str()) << endl;
1905 bool Cursor::upDownInMath(bool up)
1907 // Be warned: The 'logic' implemented in this function is highly
1908 // fragile. A distance of one pixel or a '<' vs '<=' _really
1909 // matters. So fiddle around with it only if you think you know
1910 // what you are doing!
1914 xo = beforeDispatchPosX_;
1916 // check if we had something else in mind, if not, this is the future
1918 if (x_target_ == -1)
1920 else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1921 // In text mode inside the line (not left or right) possibly set a new target_x,
1922 // but only if we are somewhere else than the previous target-offset.
1924 // We want to keep the x-target on subsequent up/down movements
1925 // that cross beyond the end of short lines. Thus a special
1926 // handling when the cursor is at the end of line: Use the new
1927 // x-target only if the old one was before the end of line
1928 // or the old one was after the beginning of the line
1929 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1933 left = pos() == textRow().endpos();
1934 right = pos() == textRow().pos();
1936 left = pos() == textRow().pos();
1937 right = pos() == textRow().endpos();
1939 if ((!left && !right) ||
1940 (left && !right && xo < x_target_) ||
1941 (!left && right && x_target_ < xo))
1948 // try neigbouring script insets
1950 if (inMathed() && !selection()) {
1953 InsetMathScript const * p = prevAtom()->asScriptInset();
1954 if (p && p->has(up)) {
1956 push(*const_cast<InsetMathScript*>(p));
1957 idx() = p->idxOfScript(up);
1960 // we went in the right direction? Otherwise don't jump into the script
1964 int oy = beforeDispatchPosY_;
1965 if ((!up && y <= oy) ||
1974 if (pos() != lastpos()) {
1975 InsetMathScript const * p = nextAtom()->asScriptInset();
1976 if (p && p->has(up)) {
1977 push(*const_cast<InsetMathScript*>(p));
1978 idx() = p->idxOfScript(up);
1981 // we went in the right direction? Otherwise don't jump into the script
1985 int oy = beforeDispatchPosY_;
1986 if ((!up && y <= oy) ||
1995 // try to find an inset that knows better then we,
1996 if (inset().idxUpDown(*this, up)) {
1997 //lyxerr << "idxUpDown triggered" << endl;
1998 // try to find best position within this inset
2000 setCursor(bruteFind(*this, xo, yo));
2004 // any improvement going just out of inset?
2005 if (popBackward() && inMathed()) {
2006 //lyxerr << "updown: popBackward succeeded" << endl;
2009 int yold = beforeDispatchPosY_;
2011 if (up ? ynew < yold : ynew > yold)
2015 // no success, we are probably at the document top or bottom
2021 bool Cursor::mathForward(bool word)
2023 LASSERT(inMathed(), return false);
2024 if (pos() < lastpos()) {
2026 // word: skip a group of insets of the form X*(B*|R*|P*) (greedy
2027 // match) where X is any math class, B is mathbin, R is mathrel, and
2028 // P is mathpunct. Make sure that the following remains true:
2029 // mathForward(true); mathBackward(true); mathForward(true)
2030 // is the same as mathForward(true) and
2031 // mathBackward(true); mathForward(true); mathBackward(true)
2032 // is the same as mathBackward(true).
2033 MathClass mc = nextMath().mathClass();
2036 while (pos() < lastpos() && mc == nextMath().mathClass());
2037 if (pos() < lastpos() &&
2038 ((mc = nextMath().mathClass()) == MC_BIN ||
2039 mc == MC_REL || mc == MC_PUNCT))
2042 while (pos() < lastpos() && mc == nextMath().mathClass());
2043 } else if (openable(nextAtom())) {
2044 InsetMathScript const * n = nextMath().asScriptInset();
2045 bool to_brace_deco = n && !n->nuc().empty()
2046 && n->nuc().back()->lyxCode() == MATH_DECORATION_CODE
2047 && n->nuc().back()->mathClass() == MC_OP;
2048 // single step: try to enter the next inset
2049 pushBackward(nextMath());
2050 inset().idxFirst(*this);
2051 // Make sure the cursor moves directly to an
2052 // \overbrace or \underbrace inset (bug 2264)
2053 if (to_brace_deco) {
2054 pushBackward(nextMath());
2055 inset().idxFirst(*this);
2061 if (inset().idxForward(*this))
2063 InsetMath const * m = inset().asInsetMath();
2064 bool from_brace_deco = m
2065 && m->lyxCode() == MATH_DECORATION_CODE
2066 && m->mathClass() == MC_OP;
2067 // try to pop forwards --- but don't pop out of math! leave that to
2069 int s = depth() - 2;
2070 if (s >= 0 && operator[](s).inset().asInsetMath() && popForward()) {
2071 // Make sure the cursor moves directly to an
2072 // \overbrace or \underbrace inset (bug 2264)
2073 bool to_script = inset().asInsetMath()
2074 && inset().asInsetMath()->asScriptInset();
2075 return from_brace_deco && to_script ? mathForward(word) : true;
2081 bool Cursor::mathBackward(bool word)
2083 LASSERT(inMathed(), return false);
2086 // word: skip a group of insets. See the comment in mathForward.
2087 MathClass mc = prevMath().mathClass();
2090 while (pos() > 0 && mc == prevMath().mathClass());
2091 if (pos() > 0 && (mc == MC_BIN || mc == MC_REL || mc == MC_PUNCT)) {
2092 mc = prevMath().mathClass();
2095 while (pos() > 0 && mc == prevMath().mathClass());
2097 } else if (openable(prevAtom())) {
2098 InsetMathScript const * p = prevMath().asScriptInset();
2099 bool to_brace_deco = p && !p->nuc().empty()
2100 && p->nuc().back()->lyxCode() == MATH_DECORATION_CODE
2101 && p->nuc().back()->mathClass() == MC_OP;
2102 // single step: try to enter the preceding inset
2105 inset().idxLast(*this);
2106 // Make sure the cursor moves directly to an
2107 // \overbrace or \underbrace inset (bug 2264)
2108 if (to_brace_deco) {
2111 inset().idxLast(*this);
2117 if (inset().idxBackward(*this))
2119 InsetMath const * m = inset().asInsetMath();
2120 bool from_brace_deco = m
2121 && m->lyxCode() == MATH_DECORATION_CODE
2122 && m->mathClass() == MC_OP;
2123 // try to pop backwards --- but don't pop out of math! leave that to
2125 int s = depth() - 2;
2126 if (s >= 0 && operator[](s).inset().asInsetMath() && popBackward()) {
2127 // Make sure the cursor moves directly to an
2128 // \overbrace or \underbrace inset (bug 2264)
2129 bool to_script = inset().asInsetMath()
2130 && inset().asInsetMath()->asScriptInset();
2131 return from_brace_deco && to_script ? mathBackward(word) : true;
2137 bool Cursor::upDownInText(bool up, bool & updateNeeded)
2139 LASSERT(text(), return false);
2145 xo = beforeDispatchPosX_;
2147 // update the targetX - this is here before the "return false"
2148 // to set a new target which can be used by InsetTexts above
2149 // if we cannot move up/down inside this inset anymore
2150 if (x_target_ == -1)
2152 else if (xo - textTargetOffset() != x_target() &&
2153 depth() == beforeDispatchCursor_.depth()) {
2154 // In text mode inside the line (not left or right)
2155 // possibly set a new target_x, but only if we are
2156 // somewhere else than the previous target-offset.
2158 // We want to keep the x-target on subsequent up/down
2159 // movements that cross beyond the end of short lines.
2160 // Thus a special handling when the cursor is at the
2161 // end of line: Use the new x-target only if the old
2162 // one was before the end of line or the old one was
2163 // after the beginning of the line
2164 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
2168 left = pos() == textRow().endpos();
2169 right = pos() == textRow().pos();
2171 left = pos() == textRow().pos();
2172 right = pos() == textRow().endpos();
2174 if ((!left && !right) ||
2175 (left && !right && xo < x_target_) ||
2176 (!left && right && x_target_ < xo))
2183 // first get the current line
2184 TextMetrics & tm = bv_->textMetrics(text());
2185 ParagraphMetrics const & pm = tm.parMetrics(pit());
2187 if (pos() && boundary())
2188 row = pm.pos2row(pos() - 1);
2190 row = pm.pos2row(pos());
2192 if (atFirstOrLastRow(up)) {
2193 // Is there a place for the cursor to go ? If yes, we
2194 // can execute the DEPM, otherwise we should keep the
2195 // paragraph to host the cursor.
2196 Cursor dummy = *this;
2197 bool valid_destination = false;
2198 for(; dummy.depth(); dummy.pop())
2199 if (!dummy.atFirstOrLastRow(up)) {
2200 valid_destination = true;
2204 // will a next dispatch follow and if there is a new
2205 // dispatch will it move the cursor out ?
2206 if (depth() > 1 && valid_destination) {
2207 // The cursor hasn't changed yet. This happens when
2208 // you e.g. move out of an inset. And to give the
2209 // DEPM the possibility of doing something we must
2210 // provide it with two different cursors. (Lgb, vfr)
2212 dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
2213 dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
2215 updateNeeded |= bv().checkDepm(dummy, *this);
2216 updateTextTargetOffset();
2218 forceBufferUpdate();
2223 // with and without selection are handled differently
2225 int yo1 = bv().getPos(*this).y_;
2227 // To next/previous row
2228 // FIXME: the y position is often guessed wrongly across styles and
2229 // insets, which leads to weird behaviour.
2231 tm.editXY(*this, xo, yo1 - textRow().ascent() - 1);
2233 tm.editXY(*this, xo, yo1 + textRow().descent() + 1);
2234 x_target_ = old.x_target_;
2237 // This happens when you move out of an inset.
2238 // And to give the DEPM the possibility of doing
2239 // something we must provide it with two different
2241 Cursor dummy = *this;
2244 if (bv().checkDepm(dummy, old)) {
2245 updateNeeded = true;
2246 // Make sure that cur gets back whatever happened to dummy (Lgb)
2249 if (inTexted() && pos() && paragraph().isEnvSeparator(pos() - 1))
2252 // if there is a selection, we stay out of any inset,
2253 // and just jump to the right position:
2259 } else if (pit() > 0) {
2261 TextMetrics & tm2 = bv_->textMetrics(text());
2262 if (!tm2.contains(pit()))
2263 tm2.newParMetricsUp();
2264 ParagraphMetrics const & pmcur = tm2.parMetrics(pit());
2265 next_row = pmcur.rows().size() - 1;
2268 if (row + 1 < int(pm.rows().size())) {
2270 } else if (pit() + 1 < int(text()->paragraphs().size())) {
2272 TextMetrics & tm2 = bv_->textMetrics(text());
2273 if (!tm2.contains(pit()))
2274 tm2.newParMetricsDown();
2279 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
2281 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
2283 // When selection==false, this is done by TextMetrics::editXY
2286 updateNeeded |= bv().checkDepm(*this, old);
2290 forceBufferUpdate();
2291 updateTextTargetOffset();
2296 void Cursor::handleFont(string const & font)
2298 LYXERR(Debug::DEBUG, font);
2302 safe = cap::grabAndEraseSelection(*this);
2307 if (lastpos() != 0) {
2308 // something left in the cell
2310 // cursor in first position
2312 } else if (pos() == lastpos()) {
2313 // cursor in last position
2316 // cursor in between. split cell
2317 MathData::iterator bt = cell().begin();
2318 MathAtom at = createInsetMath(from_utf8(font), buffer());
2319 at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2320 cell().erase(bt, bt + pos());
2325 // nothing left in the cell
2334 void Cursor::undispatched() const
2336 disp_.dispatched(false);
2340 void Cursor::dispatched() const
2342 disp_.dispatched(true);
2346 void Cursor::screenUpdateFlags(Update::flags f) const
2348 disp_.screenUpdate(f);
2352 void Cursor::noScreenUpdate() const
2354 disp_.screenUpdate(Update::None);
2358 void Cursor::forceBufferUpdate() const
2360 disp_.forceBufferUpdate();
2364 void Cursor::clearBufferUpdate() const
2366 disp_.clearBufferUpdate();
2370 bool Cursor::needBufferUpdate() const
2372 return disp_.needBufferUpdate();
2376 Font Cursor::getFont() const
2378 // The logic here should more or less match to the
2379 // Cursor::setCurrentFont logic, i.e. the cursor height should
2380 // give a hint what will happen if a character is entered.
2381 // FIXME: this is not the case, what about removing this method ? (see #10478).
2383 // HACK. far from being perfect...
2385 CursorSlice const & sl = innerTextSlice();
2386 Text const & text = *sl.text();
2387 Paragraph const & par = text.getPar(sl.pit());
2389 // on boundary, so we are really at the character before
2390 pos_type pos = sl.pos();
2391 if (pos > 0 && boundary())
2394 // on space? Take the font before (only for RTL boundary stay)
2396 TextMetrics const & tm = bv().textMetrics(&text);
2397 if (pos == sl.lastpos()
2398 || (par.isSeparator(pos)
2399 && !tm.isRTLBoundary(sl.pit(), pos)))
2403 // get font at the position
2404 Font font = par.getFont(buffer()->params(), pos,
2405 text.outerFont(sl.pit()));
2411 void Cursor::sanitize()
2413 setBuffer(&bv_->buffer());
2414 CursorData::sanitize();
2418 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2420 // find inset in common
2422 for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2423 if (&old[i].inset() != &cur[i].inset())
2427 // update words if we just moved to another paragraph
2428 if (i == old.depth() && i == cur.depth()
2429 && !cur.buffer()->isClean()
2430 && cur.inTexted() && old.inTexted()
2431 && cur.pit() != old.pit()) {
2432 old.paragraph().updateWords();
2435 // notify everything on top of the common part in old cursor,
2436 // but stop if the inset claims the cursor to be invalid now
2437 for (size_type j = i; j < old.depth(); ++j) {
2438 Cursor inset_pos = old;
2439 inset_pos.cutOff(j);
2440 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2444 // notify everything on top of the common part in new cursor,
2445 // but stop if the inset claims the cursor to be invalid now
2446 for (; i < cur.depth(); ++i) {
2447 if (cur[i].inset().notifyCursorEnters(cur))
2455 void Cursor::setLanguageFromInput()
2457 if (!lyxrc.respect_os_kbd_language
2459 || paragraph().isPassThru())
2461 string const & code = theApp()->inputLanguageCode();
2462 Language const * lang = languages.getFromCode(code, buffer()->getLanguages());
2464 current_font.setLanguage(lang);
2465 real_current_font.setLanguage(lang);
2467 LYXERR0("setLanguageFromCode: unknown language code " << code);
2471 void Cursor::setCurrentFont()
2473 CursorSlice const & cs = innerTextSlice();
2474 Paragraph const & par = cs.paragraph();
2475 pos_type cpit = cs.pit();
2476 pos_type cpos = cs.pos();
2477 Text const & ctext = *cs.text();
2478 TextMetrics const & tm = bv().textMetrics(&ctext);
2480 // are we behind previous char in fact? -> go to that char
2481 if (cpos > 0 && boundary())
2484 // find position to take the font from
2486 // paragraph end? -> font of last char
2487 if (cpos == lastpos())
2489 // on space? -> look at the words in front of space
2490 else if (cpos > 0 && par.isSeparator(cpos)) {
2491 // abc| def -> font of c
2492 // abc |[WERBEH], i.e. boundary==true -> font of c
2493 // abc [WERBEH]| def, font of the space
2494 if (!tm.isRTLBoundary(cpit, cpos))
2500 BufferParams const & bufparams = buffer()->params();
2501 current_font = par.getFontSettings(bufparams, cpos);
2502 real_current_font = tm.displayFont(cpit, cpos);
2504 // set language to input language
2505 setLanguageFromInput();
2507 // special case for paragraph end
2508 if (cs.pos() == lastpos()
2509 && tm.isRTLBoundary(cpit, cs.pos())
2511 Language const * lang = par.getParLanguage(bufparams);
2512 current_font.setLanguage(lang);
2513 current_font.fontInfo().setNumber(FONT_OFF);
2514 real_current_font.setLanguage(lang);
2515 real_current_font.fontInfo().setNumber(FONT_OFF);
2518 // No language in pass thru situations
2519 if (cs.paragraph().isPassThru()) {
2520 current_font.setLanguage(latex_language);
2521 real_current_font.setLanguage(latex_language);
2526 void Cursor::checkBufferStructure()
2528 if (buffer()->isInternal())
2531 Buffer const * master = buffer()->masterBuffer();
2532 master->tocBackend().updateItem(*this);
2533 if (master != buffer() && !master->hasGuiDelegate())
2534 // In case the master has no gui associated with it,
2535 // the TocItem is not updated (part of bug 5699).
2536 buffer()->tocBackend().updateItem(*this);
2540 void Cursor::moveToClosestEdge(int const x, bool const edit)
2542 if (Inset const * inset = nextInset()) {
2543 // stay in front of insets for which we want to open the dialog
2544 // (e.g. InsetMathSpace).
2545 if (edit && (inset->hasSettings() || !inset->contextMenuName().empty()))
2547 CoordCache::Insets const & insetCache = bv().coordCache().getInsets();
2548 if (!insetCache.has(inset))
2550 int const wid = insetCache.dim(inset).wid;
2551 Point p = insetCache.xy(inset);
2552 if (x > p.x_ + (wid + 1) / 2)