]> git.lyx.org Git - lyx.git/blob - src/Cursor.cpp
ed182ace64de377e72099c7f7d49eeb634d2be34
[lyx.git] / src / Cursor.cpp
1 /**
2  * \file Cursor.cpp
3  * This file is part of LyX, the document processor.
4  * Licence details can be found in the file COPYING.
5  *
6  * \author Alejandro Aguilar Sierra
7  * \author Alfredo Braunstein
8  * \author Dov Feldstern
9  * \author André Pönitz
10  * \author Stefan Schimanski
11  *
12  * Full author contact details are available in file CREDITS.
13  */
14
15 #include <config.h>
16
17 #include "Buffer.h"
18 #include "BufferView.h"
19 #include "CoordCache.h"
20 #include "Cursor.h"
21 #include "CutAndPaste.h"
22 #include "DispatchResult.h"
23 #include "Encoding.h"
24 #include "Font.h"
25 #include "FuncCode.h"
26 #include "FuncRequest.h"
27 #include "Language.h"
28 #include "Layout.h"
29 #include "LyXAction.h"
30 #include "LyXRC.h"
31 #include "Paragraph.h"
32 #include "ParIterator.h"
33 #include "Row.h"
34 #include "Text.h"
35 #include "TextMetrics.h"
36 #include "TocBackend.h"
37
38 #include "support/debug.h"
39 #include "support/docstream.h"
40 #include "support/ExceptionMessage.h"
41 #include "support/gettext.h"
42 #include "support/lassert.h"
43
44 #include "insets/InsetTabular.h"
45 #include "insets/InsetText.h"
46
47 #include "mathed/InsetMath.h"
48 #include "mathed/InsetMathBrace.h"
49 #include "mathed/InsetMathScript.h"
50 #include "mathed/MacroTable.h"
51 #include "mathed/MathData.h"
52 #include "mathed/MathMacro.h"
53
54 #include "support/bind.h"
55
56 #include <sstream>
57 #include <limits>
58 #include <map>
59 #include <algorithm>
60
61 using namespace std;
62
63 namespace lyx {
64
65 namespace {
66
67 // Find position closest to (x, y) in cell given by iter.
68 // Used only in mathed
69 DocIterator bruteFind2(Cursor const & c, int x, int y)
70 {
71         double best_dist = numeric_limits<double>::max();
72
73         DocIterator result;
74
75         DocIterator it = c;
76         it.top().pos() = 0;
77         DocIterator et = c;
78         et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
79         for (size_t i = 0;; ++i) {
80                 int xo;
81                 int yo;
82                 Inset const * inset = &it.inset();
83                 CoordCache const & cache = c.bv().coordCache();
84
85                 // FIXME: in the case where the inset is not in the cache, this
86                 // means that no part of it is visible on screen. In this case
87                 // we don't do elaborate search and we just return the forwarded
88                 // DocIterator at its beginning.
89                 if (!cache.getInsets().has(inset)) {
90                         it.top().pos() = 0;
91                         return it;
92                 }
93
94                 Point const o = cache.getInsets().xy(inset);
95                 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
96                 // Convert to absolute
97                 xo += o.x_;
98                 yo += o.y_;
99                 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
100                 // '<=' in order to take the last possible position
101                 // this is important for clicking behind \sum in e.g. '\sum_i a'
102                 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
103                         << " best: " << best_dist);
104                 if (d <= best_dist) {
105                         best_dist = d;
106                         result = it;
107                 }
108                 if (it == et)
109                         break;
110                 it.forwardPos();
111         }
112         return result;
113 }
114
115
116 /*
117 /// moves position closest to (x, y) in given box
118 bool bruteFind(Cursor & cursor,
119         int x, int y, int xlow, int xhigh, int ylow, int yhigh)
120 {
121         LASSERT(!cursor.empty(), return false);
122         Inset & inset = cursor[0].inset();
123         BufferView & bv = cursor.bv();
124
125         CoordCache::InnerParPosCache const & cache =
126                 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
127         // Get an iterator on the first paragraph in the cache
128         DocIterator it(inset);
129         it.push_back(CursorSlice(inset));
130         it.pit() = cache.begin()->first;
131         // Get an iterator after the last paragraph in the cache
132         DocIterator et(inset);
133         et.push_back(CursorSlice(inset));
134         et.pit() = prev(cache.end(), 1)->first;
135         if (et.pit() >= et.lastpit())
136                 et = doc_iterator_end(inset);
137         else
138                 ++et.pit();
139
140         double best_dist = numeric_limits<double>::max();
141         DocIterator best_cursor = et;
142
143         for ( ; it != et; it.forwardPos(true)) {
144                 // avoid invalid nesting when selecting
145                 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
146                         Point p = bv.getPos(it, false);
147                         int xo = p.x_;
148                         int yo = p.y_;
149                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
150                                 double const dx = xo - x;
151                                 double const dy = yo - y;
152                                 double const d = dx * dx + dy * dy;
153                                 // '<=' in order to take the last possible position
154                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
155                                 if (d <= best_dist) {
156                                         //      lyxerr << "*" << endl;
157                                         best_dist   = d;
158                                         best_cursor = it;
159                                 }
160                         }
161                 }
162         }
163
164         if (best_cursor != et) {
165                 cursor.setCursor(best_cursor);
166                 return true;
167         }
168
169         return false;
170 }
171 */
172
173 /*
174 /// moves position closest to (x, y) in given box
175 bool bruteFind3(Cursor & cur, int x, int y, bool up)
176 {
177         BufferView & bv = cur.bv();
178         int ylow  = up ? 0 : y + 1;
179         int yhigh = up ? y - 1 : bv.workHeight();
180         int xlow = 0;
181         int xhigh = bv.workWidth();
182
183 // FIXME: bit more work needed to get 'from' and 'to' right.
184         pit_type from = cur.bottom().pit();
185         //pit_type to = cur.bottom().pit();
186         //lyxerr << "Pit start: " << from << endl;
187
188         //lyxerr << "bruteFind3: x: " << x << " y: " << y
189         //      << " xlow: " << xlow << " xhigh: " << xhigh
190         //      << " ylow: " << ylow << " yhigh: " << yhigh
191         //      << endl;
192         DocIterator it = doc_iterator_begin(cur.buffer());
193         it.pit() = from;
194         DocIterator et = doc_iterator_end(cur.buffer());
195
196         double best_dist = numeric_limits<double>::max();
197         DocIterator best_cursor = et;
198
199         for ( ; it != et; it.forwardPos()) {
200                 // avoid invalid nesting when selecting
201                 if (bv.cursorStatus(it) == CUR_INSIDE
202                     && (!cur.selection() || positionable(it, cur.realAnchor()))) {
203                         // If this function is ever used again, check
204                         // whether this is the same as "bv.getPos(it,
205                         // false)" with boundary = false.
206                         Point p = bv.getPos(it);
207                         int xo = p.x_;
208                         int yo = p.y_;
209                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
210                                 double const dx = xo - x;
211                                 double const dy = yo - y;
212                                 double const d = dx * dx + dy * dy;
213                                 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
214                                 //      << " dx: " << dx << " dy: " << dy
215                                 //      << " idx: " << it.idx() << " pos: " << it.pos()
216                                 //      << " it:\n" << it
217                                 //      << endl;
218                                 // '<=' in order to take the last possible position
219                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
220                                 if (d <= best_dist) {
221                                         //lyxerr << "*" << endl;
222                                         best_dist   = d;
223                                         best_cursor = it;
224                                 }
225                         }
226                 }
227         }
228
229         //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
230         if (best_cursor == et)
231                 return false;
232         cur.setCursor(best_cursor);
233         return true;
234 }
235 */
236 } // namespace anon
237
238
239 CursorData::CursorData()
240         : DocIterator(), anchor_(),
241           selection_(false), mark_(false), word_selection_(false),
242           logicalpos_(false), current_font(inherit_font),
243           autocorrect_(false), macromode_(false)
244 {}
245
246
247 CursorData::CursorData(Buffer * buffer)
248         : DocIterator(buffer), anchor_(),
249           selection_(false), mark_(false), word_selection_(false),
250           logicalpos_(false), current_font(inherit_font),
251           autocorrect_(false), macromode_(false)
252 {}
253
254
255 CursorData::CursorData(DocIterator const & dit)
256         : DocIterator(dit), anchor_(),
257           selection_(false), mark_(false), word_selection_(false),
258           logicalpos_(false), current_font(inherit_font),
259           autocorrect_(false), macromode_(false)
260 {}
261
262
263
264
265 ostream & operator<<(ostream & os, CursorData const & cur)
266 {
267         os << "\n cursor:                                | anchor:\n";
268         for (size_t i = 0, n = cur.depth(); i != n; ++i) {
269                 os << " " << cur[i] << " | ";
270                 if (i < cur.anchor_.depth())
271                         os << cur.anchor_[i];
272                 else
273                         os << "-------------------------------";
274                 os << "\n";
275         }
276         for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
277                 os << "------------------------------- | " << cur.anchor_[i] << "\n";
278         }
279         os << " selection: " << cur.selection_
280 //         << " x_target: " << cur.x_target_
281            << " boundary: " << cur.boundary() << endl;
282         return os;
283 }
284
285
286 LyXErr & operator<<(LyXErr & os, CursorData const & cur)
287 {
288         os.stream() << cur;
289         return os;
290 }
291
292
293 // be careful: this is called from the bv's constructor, too, so
294 // bv functions are not yet available!
295 Cursor::Cursor(BufferView & bv)
296         : CursorData(&bv.buffer()), bv_(&bv),
297           x_target_(-1), textTargetOffset_(0),
298           beforeDispatchPosX_(0), beforeDispatchPosY_(0)
299 {}
300
301
302 void Cursor::reset()
303 {
304         clear();
305         push_back(CursorSlice(buffer()->inset()));
306         anchor_ = doc_iterator_begin(buffer());
307         anchor_.clear();
308         new_word_ = doc_iterator_begin(buffer());
309         new_word_.clear();
310         clearTargetX();
311         selection_ = false;
312         mark_ = false;
313 }
314
315
316 // this (intentionally) does neither touch anchor nor selection status
317 void Cursor::setCursor(DocIterator const & cur)
318 {
319         DocIterator::operator=(cur);
320 }
321
322
323 void Cursor::setCursorToAnchor()
324 {
325         if (selection()) {
326                 DocIterator normal = anchor_;
327                 while (depth() < normal.depth())
328                         normal.pop_back();
329                 if (depth() < anchor_.depth() && top() <= anchor_[depth() - 1])
330                         ++normal.pos();
331                 setCursor(normal);
332         }
333 }
334
335
336 void Cursor::setCursorData(CursorData const & data)
337 {
338         CursorData::operator=(data);
339 }
340
341
342 bool Cursor::getStatus(FuncRequest const & cmd, FuncStatus & status) const
343 {
344         Cursor cur = *this;
345
346         // Try to fix cursor in case it is broken.
347         cur.fixIfBroken();
348
349         // Is this a function that acts on inset at point?
350         Inset * inset = cur.nextInset();
351         if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
352             && inset && inset->getStatus(cur, cmd, status))
353                 return true;
354
355         // This is, of course, a mess. Better create a new doc iterator and use
356         // this in Inset::getStatus. This might require an additional
357         // BufferView * arg, though (which should be avoided)
358         //Cursor safe = *this;
359         bool res = false;
360         for ( ; cur.depth(); cur.pop()) {
361                 //lyxerr << "\nCursor::getStatus: cmd: " << cmd << endl << *this << endl;
362                 // LASSERT: Is it safe to continue here, or should we return?
363                 LASSERT(cur.idx() <= cur.lastidx(), /**/);
364                 LASSERT(cur.pit() <= cur.lastpit(), /**/);
365                 LASSERT(cur.pos() <= cur.lastpos(), /**/);
366
367                 // The inset's getStatus() will return 'true' if it made
368                 // a definitive decision on whether it want to handle the
369                 // request or not. The result of this decision is put into
370                 // the 'status' parameter.
371                 if (cur.inset().getStatus(cur, cmd, status)) {
372                         res = true;
373                         break;
374                 }
375         }
376         return res;
377 }
378
379
380 void Cursor::saveBeforeDispatchPosXY()
381 {
382         getPos(beforeDispatchPosX_, beforeDispatchPosY_);
383 }
384
385
386 void Cursor::dispatch(FuncRequest const & cmd0)
387 {
388         LYXERR(Debug::ACTION, "Cursor::dispatch: cmd: " << cmd0 << '\n' << *this);
389         if (empty())
390                 return;
391
392         fixIfBroken();
393         FuncRequest cmd = cmd0;
394         Cursor safe = *this;
395         Cursor old = *this;
396         disp_ = DispatchResult();
397
398         beginUndoGroup();
399
400         // Is this a function that acts on inset at point?
401         if (lyxaction.funcHasFlag(cmd.action(), LyXAction::AtPoint)
402             && nextInset()) {
403                 disp_.dispatched(true);
404                 disp_.screenUpdate(Update::FitCursor | Update::Force);
405                 FuncRequest tmpcmd = cmd;
406                 LYXERR(Debug::DEBUG, "Cursor::dispatch: (AtPoint) cmd: "
407                         << cmd0 << endl << *this);
408                 nextInset()->dispatch(*this, tmpcmd);
409                 if (disp_.dispatched()) {
410                         endUndoGroup();
411                         return;
412                 }
413         }
414
415         // store some values to be used inside of the handlers
416         beforeDispatchCursor_ = *this;
417         for (; depth(); pop(), boundary(false)) {
418                 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
419                         << cmd0 << endl << *this);
420
421                 // In any of these cases, the cursor is invalid, and we should
422                 // try to save this document rather than crash.
423                 LBUFERR(pos() <= lastpos());
424                 LBUFERR(idx() <= lastidx());
425                 LBUFERR(pit() <= lastpit());
426
427                 // The common case is 'LFUN handled, need update', so make the
428                 // LFUN handler's life easier by assuming this as default value.
429                 // The handler can reset the update and val flags if necessary.
430                 disp_.screenUpdate(Update::FitCursor | Update::Force);
431                 disp_.dispatched(true);
432                 inset().dispatch(*this, cmd);
433                 if (disp_.dispatched())
434                         break;
435         }
436
437         // it completely to get a 'bomb early' behaviour in case this
438         // object will be used again.
439         if (!disp_.dispatched()) {
440                 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
441                 // We might have invalidated the cursor when removing an empty
442                 // paragraph while the cursor could not be moved out the inset
443                 // while we initially thought we could. This might happen when
444                 // a multiline inset becomes an inline inset when the second
445                 // paragraph is removed.
446                 if (safe.pit() > safe.lastpit()) {
447                         safe.pit() = safe.lastpit();
448                         safe.pos() = safe.lastpos();
449                 }
450                 operator=(safe);
451                 disp_.screenUpdate(Update::None);
452                 disp_.dispatched(false);
453         } else {
454                 // restore the previous one because nested Cursor::dispatch calls
455                 // are possible which would change it
456                 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
457         }
458         endUndoGroup();
459
460         // NOTE: The code below has been copied to BufferView::dispatch.
461         // If you need to modify this, please update the other one too.
462
463         // notify insets we just left
464         if (*this != old) {
465                 old.beginUndoGroup();
466                 old.fixIfBroken();
467                 bool badcursor = notifyCursorLeavesOrEnters(old, *this);
468                 if (badcursor) {
469                         fixIfBroken();
470                         bv().resetInlineCompletionPos();
471                 }
472                 old.endUndoGroup();
473         }
474 }
475
476
477 DispatchResult const & Cursor::result() const
478 {
479         return disp_;
480 }
481
482
483 BufferView & Cursor::bv() const
484 {
485         LBUFERR(bv_);
486         return *bv_;
487 }
488
489
490 void Cursor::pop()
491 {
492         LBUFERR(depth() >= 1);
493         pop_back();
494 }
495
496
497 void Cursor::push(Inset & p)
498 {
499         push_back(CursorSlice(p));
500         p.setBuffer(*buffer());
501 }
502
503
504 void Cursor::pushBackward(Inset & p)
505 {
506         LASSERT(!empty(), return);
507         //lyxerr << "Entering inset " << t << " front" << endl;
508         push(p);
509         p.idxFirst(*this);
510 }
511
512
513 bool Cursor::popBackward()
514 {
515         LASSERT(!empty(), return false);
516         if (depth() == 1)
517                 return false;
518         pop();
519         return true;
520 }
521
522
523 bool Cursor::popForward()
524 {
525         LASSERT(!empty(), return false);
526         //lyxerr << "Leaving inset from in back" << endl;
527         const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
528         if (depth() == 1)
529                 return false;
530         pop();
531         pos() += lastpos() - lp + 1;
532         return true;
533 }
534
535
536 int Cursor::currentMode()
537 {
538         LASSERT(!empty(), return Inset::UNDECIDED_MODE);
539         for (int i = depth() - 1; i >= 0; --i) {
540                 int res = operator[](i).inset().currentMode();
541                 bool locked_mode = operator[](i).inset().lockedMode();
542                 // Also return UNDECIDED_MODE when the mode is locked,
543                 // as in this case it is treated the same as TEXT_MODE
544                 if (res != Inset::UNDECIDED_MODE || locked_mode)
545                         return res;
546         }
547         return Inset::TEXT_MODE;
548 }
549
550
551 bool Cursor::inCoordCache() const
552 {
553         // the root inset is not in cache, but we do not need it.
554         if (depth() == 1)
555                 return true;
556         CoordCache::Insets const & icache = bv_->coordCache().getInsets();
557         for (size_t i = 1 ; i < depth() ; ++i)
558                 if (!icache.has(&(*this)[i].inset()))
559                         return false;
560         return true;
561 }
562
563
564 void Cursor::getPos(int & x, int & y) const
565 {
566         Point p = bv().getPos(*this);
567         x = p.x_;
568         y = p.y_;
569 }
570
571
572 Row const & Cursor::textRow() const
573 {
574         CursorSlice const & cs = innerTextSlice();
575         ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
576         return pm.getRow(pos(), boundary());
577 }
578
579
580 void Cursor::resetAnchor()
581 {
582         anchor_ = *this;
583         checkNewWordPosition();
584 }
585
586
587 void Cursor::markNewWordPosition()
588 {
589         if (lyxrc.spellcheck_continuously && inTexted() && new_word_.empty()) {
590                 FontSpan nw = locateWord(WHOLE_WORD);
591                 if (nw.size() == 1) {
592                         LYXERR(Debug::DEBUG, "start new word: "
593                                 << " par: " << pit()
594                                 << " pos: " << nw.first);
595                         new_word_ = *this;
596                 }
597         }
598 }
599
600
601 void Cursor::clearNewWordPosition()
602 {
603         if (!new_word_.empty()) {
604                 LYXERR(Debug::DEBUG, "clear new word: "
605                         << " par: " << pit()
606                         << " pos: " << pos());
607                 new_word_.resize(0);
608         }
609 }
610
611
612 void Cursor::checkNewWordPosition()
613 {
614         if (!lyxrc.spellcheck_continuously || new_word_.empty())
615                 return ;
616         if (!inTexted())
617                 clearNewWordPosition();
618         else {
619                 // forget the position of the current new word if
620                 // 1) the paragraph changes or
621                 // 2) the count of nested insets changes or
622                 // 3) the cursor pos is out of paragraph bound
623                 if (pit() != new_word_.pit() ||
624                         depth() != new_word_.depth() ||
625                         new_word_.pos() > new_word_.lastpos()) {
626                         clearNewWordPosition();
627                 } else if (new_word_.fixIfBroken())
628                         // 4) or the remembered position was "broken"
629                         clearNewWordPosition();
630                 else {
631                         FontSpan nw = locateWord(WHOLE_WORD);
632                         if (!nw.empty()) {
633                                 FontSpan ow = new_word_.locateWord(WHOLE_WORD);
634                                 if (nw.intersect(ow).empty())
635                                         clearNewWordPosition();
636                                 else
637                                         LYXERR(Debug::DEBUG, "new word: "
638                                                    << " par: " << pit()
639                                                    << " pos: " << nw.first << ".." << nw.last);
640                         } else {
641                                 clearNewWordPosition();
642                         }
643                 }
644         }
645 }
646
647
648 bool Cursor::posBackward()
649 {
650         if (pos() == 0)
651                 return false;
652         --pos();
653         return true;
654 }
655
656
657 bool Cursor::posForward()
658 {
659         if (pos() == lastpos())
660                 return false;
661         ++pos();
662         return true;
663 }
664
665
666 bool Cursor::posVisRight(bool skip_inset)
667 {
668         Cursor new_cur = *this; // where we will move to
669         pos_type left_pos; // position visually left of current cursor
670         pos_type right_pos; // position visually right of current cursor
671
672         getSurroundingPos(left_pos, right_pos);
673
674         LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
675
676         // Are we at an inset?
677         new_cur.pos() = right_pos;
678         new_cur.boundary(false);
679         if (!skip_inset &&
680                 text()->checkAndActivateInsetVisual(new_cur, right_pos >= pos(), false)) {
681                 // we actually move the cursor at the end of this
682                 // function, for now we just keep track of the new
683                 // position in new_cur...
684                 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
685         }
686
687         // Are we already at rightmost pos in row?
688         else if (text()->empty() || right_pos == -1) {
689
690                 new_cur = *this;
691                 if (!new_cur.posVisToNewRow(false)) {
692                         LYXERR(Debug::RTL, "not moving!");
693                         return false;
694                 }
695
696                 // we actually move the cursor at the end of this
697                 // function, for now just keep track of the new
698                 // position in new_cur...
699                 LYXERR(Debug::RTL, "right edge, moving: " << int(new_cur.pit()) << ","
700                         << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
701
702         }
703         // normal movement to the right
704         else {
705                 new_cur = *this;
706                 // Recall, if the cursor is at position 'x', that
707                 // means *before* the character at position 'x'. In
708                 // RTL, "before" means "to the right of", in LTR, "to
709                 // the left of". So currently our situation is this:
710                 // the position to our right is 'right_pos' (i.e.,
711                 // we're currently to the left of 'right_pos'). In
712                 // order to move to the right, it depends whether or
713                 // not the character at 'right_pos' is RTL.
714                 bool const new_pos_is_RTL = paragraph().getFontSettings(
715                         buffer()->params(), right_pos).isVisibleRightToLeft();
716                 // If the character at 'right_pos' *is* LTR, then in
717                 // order to move to the right of it, we need to be
718                 // *after* 'right_pos', i.e., move to position
719                 // 'right_pos' + 1.
720                 if (!new_pos_is_RTL) {
721                         new_cur.pos() = right_pos + 1;
722                         // set the boundary to true in two situations:
723                         if (
724                         // 1. if new_pos is now lastpos, and we're in
725                         // an RTL paragraph (this means that we're
726                         // moving right to the end of an LTR chunk
727                         // which is at the end of an RTL paragraph);
728                                 (new_cur.pos() == lastpos()
729                                  && paragraph().isRTL(buffer()->params()))
730                         // 2. if the position *after* right_pos is RTL
731                         // (we want to be *after* right_pos, not
732                         // before right_pos + 1!)
733                                 || paragraph().getFontSettings(buffer()->params(),
734                                                 new_cur.pos()).isVisibleRightToLeft()
735                         )
736                                 new_cur.boundary(true);
737                         else // set the boundary to false
738                                 new_cur.boundary(false);
739                 }
740                 // Otherwise (if the character at position 'right_pos'
741                 // is RTL), then moving to the right of it is as easy
742                 // as setting the new position to 'right_pos'.
743                 else {
744                         new_cur.pos() = right_pos;
745                         new_cur.boundary(false);
746                 }
747
748         }
749
750         bool const moved = new_cur != *this || new_cur.boundary() != boundary();
751
752         if (moved) {
753                 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
754                         << (new_cur.boundary() ? " (boundary)" : ""));
755                 *this = new_cur;
756         }
757
758         return moved;
759 }
760
761
762 bool Cursor::posVisLeft(bool skip_inset)
763 {
764         Cursor new_cur = *this; // where we will move to
765         pos_type left_pos; // position visually left of current cursor
766         pos_type right_pos; // position visually right of current cursor
767
768         getSurroundingPos(left_pos, right_pos);
769
770         LYXERR(Debug::RTL, left_pos <<"|"<< right_pos << " (pos: "<< pos() <<")");
771
772         // Are we at an inset?
773         new_cur.pos() = left_pos;
774         new_cur.boundary(false);
775         if (!skip_inset &&
776                 text()->checkAndActivateInsetVisual(new_cur, left_pos >= pos(), true)) {
777                 // we actually move the cursor at the end of this
778                 // function, for now we just keep track of the new
779                 // position in new_cur...
780                 LYXERR(Debug::RTL, "entering inset at: " << new_cur.pos());
781         }
782
783         // Are we already at leftmost pos in row?
784         else if (text()->empty() || left_pos == -1) {
785
786                 new_cur = *this;
787                 if (!new_cur.posVisToNewRow(true)) {
788                         LYXERR(Debug::RTL, "not moving!");
789                         return false;
790                 }
791
792                 // we actually move the cursor at the end of this
793                 // function, for now just keep track of the new
794                 // position in new_cur...
795                 LYXERR(Debug::RTL, "left edge, moving: " << int(new_cur.pit()) << ","
796                         << int(new_cur.pos()) << "," << (new_cur.boundary() ? 1 : 0));
797
798         }
799         // normal movement to the left
800         else {
801                 new_cur = *this;
802                 // Recall, if the cursor is at position 'x', that
803                 // means *before* the character at position 'x'. In
804                 // RTL, "before" means "to the right of", in LTR, "to
805                 // the left of". So currently our situation is this:
806                 // the position to our left is 'left_pos' (i.e., we're
807                 // currently to the right of 'left_pos'). In order to
808                 // move to the left, it depends whether or not the
809                 // character at 'left_pos' is RTL.
810                 bool const new_pos_is_RTL = paragraph().getFontSettings(
811                         buffer()->params(), left_pos).isVisibleRightToLeft();
812                 // If the character at 'left_pos' *is* RTL, then in
813                 // order to move to the left of it, we need to be
814                 // *after* 'left_pos', i.e., move to position
815                 // 'left_pos' + 1.
816                 if (new_pos_is_RTL) {
817                         new_cur.pos() = left_pos + 1;
818                         // set the boundary to true in two situations:
819                         if (
820                         // 1. if new_pos is now lastpos and we're in
821                         // an LTR paragraph (this means that we're
822                         // moving left to the end of an RTL chunk
823                         // which is at the end of an LTR paragraph);
824                                 (new_cur.pos() == lastpos()
825                                  && !paragraph().isRTL(buffer()->params()))
826                         // 2. if the position *after* left_pos is not
827                         // RTL (we want to be *after* left_pos, not
828                         // before left_pos + 1!)
829                                 || !paragraph().getFontSettings(buffer()->params(),
830                                                 new_cur.pos()).isVisibleRightToLeft()
831                         )
832                                 new_cur.boundary(true);
833                         else // set the boundary to false
834                                 new_cur.boundary(false);
835                 }
836                 // Otherwise (if the character at position 'left_pos'
837                 // is LTR), then moving to the left of it is as easy
838                 // as setting the new position to 'left_pos'.
839                 else {
840                         new_cur.pos() = left_pos;
841                         new_cur.boundary(false);
842                 }
843
844         }
845
846         bool const moved = new_cur != *this || new_cur.boundary() != boundary();
847
848         if (moved) {
849                 LYXERR(Debug::RTL, "moving to: " << new_cur.pos()
850                         << (new_cur.boundary() ? " (boundary)" : ""));
851                 *this = new_cur;
852         }
853
854         return moved;
855 }
856
857
858 namespace {
859
860 // Return true on success
861 bool findNonVirtual(Row const & row, Row::const_iterator & cit, bool onleft)
862 {
863         if (onleft) {
864                 while (cit != row.begin() && cit->isVirtual())
865                         --cit;
866         } else {
867                 while (cit != row.end() && cit->isVirtual())
868                         ++cit;
869         }
870         return cit != row.end() && !cit->isVirtual();
871 }
872
873 }
874
875 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos) const
876 {
877         // by default, we know nothing.
878         left_pos = -1;
879         right_pos = -1;
880
881         Row const & row = textRow();
882         TextMetrics const & tm = bv_->textMetrics(text());
883         double dummy = 0;
884         Row::const_iterator cit = tm.findRowElement(row, pos(), boundary(), dummy);
885         // Handle the case of empty row
886         if (cit == row.end()) {
887                 if (paragraph().isRTL(buffer()->params()))
888                         right_pos = row.pos();
889                 else
890                         left_pos = row.pos() - 1;
891                 return;
892         }
893
894         // skip virtual elements and exit if no non-virtual one exists
895         if (!findNonVirtual(row, cit, !cit->isRTL()))
896                 return;
897
898         // if the position is at the left side of the element, we have to
899         // look at the previous element
900         if (pos() == cit->left_pos()) {
901                 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
902                            << "), AT LEFT of *cit=" << *cit);
903                 // this one is easy (see common case below)
904                 right_pos = pos() - (cit->isRTL() ? 1 : 0);
905                 // at the left of the row
906                 if (cit == row.begin())
907                         return;
908                 --cit;
909                 if (!findNonVirtual(row, cit, true))
910                         return;
911                 // [...[ is the row element, | is cursor position (! with boundary)
912                 // [ 1 2 [ is a ltr row element with pos=1 and endpos=3
913                 // ] 2 1] is an rtl row element with pos=1 and endpos=3
914                 //    [ 1 2 [  [|3 4 [ => (2, 3)
915                 // or [ 1 2 [  ]!4 3 ] => (2, 4)
916                 // or ] 2 1 ]  [|3 4 [ => (1, 3)
917                 // or ] 4 3 ]  ]!2 1 ] => (3, 2)
918                 left_pos = cit->right_pos() - (cit->isRTL() ? 0 : 1);
919                 // happens with consecutive row of same direction
920                 if (left_pos == right_pos) {
921                         left_pos += cit->isRTL() ? 1 : -1;
922                 }
923         }
924         // same code but with the element at the right
925         else if (pos() == cit->right_pos()) {
926                 LYXERR(Debug::RTL, "getSurroundingPos(" << pos() << (boundary() ? "b" : "")
927                            << "), AT RIGHT of *cit=" << *cit);
928                 // this one is easy (see common case below)
929                 left_pos = pos() - (cit->isRTL() ? 0 : 1);
930                 // at the right of the row
931                 if (cit + 1 == row.end())
932                         return;
933                 ++cit;
934                 if (!findNonVirtual(row, cit, false))
935                         return;
936                 //    [ 1 2![  [ 3 4 [ => (2, 3)
937                 // or [ 1 2![  ] 4 3 ] => (2, 4)
938                 // or ] 2 1|]  [ 3 4 [ => (1, 3)
939                 // or ] 4 3|]  ] 2 1 ] => (3, 2)
940                 right_pos = cit->left_pos() - (cit->isRTL() ? 1 : 0);
941                 // happens with consecutive row of same direction
942                 if (right_pos == left_pos)
943                         right_pos += cit->isRTL() ? -1 : 1;
944         }
945         // common case: both positions are inside the row element
946         else {
947                 //    [ 1 2|3 [ => (2, 3)
948                 // or ] 3|2 1 ] => (3, 2)
949                 left_pos = pos() - (cit->isRTL() ? 0 : 1);
950                 right_pos = pos() - (cit->isRTL() ? 1 : 0);
951         }
952
953         // Note that debug message does not catch all early returns above
954         LYXERR(Debug::RTL,"getSurroundingPos(" << pos() << (boundary() ? "b" : "")
955                    << ") => (" << left_pos << ", " << right_pos <<")");
956 }
957
958
959 bool Cursor::posVisToNewRow(bool movingLeft)
960 {
961         Paragraph const & par = paragraph();
962         Buffer const & buf = *buffer();
963         Row const & row = textRow();
964         bool par_is_LTR = !par.isRTL(buf.params());
965
966         // Inside a table, determining whether to move to the next or
967         // previous row should be done based on the table's direction.
968         if (inset().asInsetTabular()) {
969                 par_is_LTR = !inset().asInsetTabular()->isRightToLeft(*this);
970                 LYXERR(Debug::RTL, "Inside table! par_is_LTR=" << (par_is_LTR ? 1 : 0));
971         }
972
973         // if moving left in an LTR paragraph or moving right in an
974         // RTL one, move to previous row
975         if (par_is_LTR == movingLeft) {
976                 if (row.pos() == 0) { // we're at first row in paragraph
977                         if (pit() == 0) // no previous paragraph! don't move
978                                 return false;
979                         // move to last pos in previous par
980                         --pit();
981                         pos() = lastpos();
982                         boundary(false);
983                 } else { // move to previous row in this par
984                         pos() = row.pos() - 1; // this is guaranteed to be in previous row
985                         boundary(false);
986                 }
987         }
988         // if moving left in an RTL paragraph or moving right in an
989         // LTR one, move to next row
990         else {
991                 if (row.endpos() == lastpos()) { // we're at last row in paragraph
992                         if (pit() == lastpit()) // last paragraph! don't move
993                                 return false;
994                         // move to first row in next par
995                         ++pit();
996                         pos() = 0;
997                         boundary(false);
998                 } else { // move to next row in this par
999                         pos() = row.endpos();
1000                         boundary(false);
1001                 }
1002         }
1003
1004         // make sure we're at left-/right-most pos in new row
1005         posVisToRowExtremity(!movingLeft);
1006
1007         return true;
1008 }
1009
1010
1011 void Cursor::posVisToRowExtremity(bool left)
1012 {
1013         LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
1014                 << (boundary() ? 1 : 0));
1015
1016         TextMetrics const & tm = bv_->textMetrics(text());
1017         // Looking for extremities is like clicking on the left or the
1018         // right of the row.
1019         int x = tm.origin().x_ + (left ? 0 : textRow().width());
1020         bool b = false;
1021         pos() = tm.getPosNearX(textRow(), x, b);
1022         boundary(b);
1023
1024         LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
1025                 << (boundary() ? 1 : 0));
1026 }
1027
1028
1029 bool Cursor::reverseDirectionNeeded() const
1030 {
1031         /*
1032          * We determine the directions based on the direction of the
1033          * bottom() --- i.e., outermost --- paragraph, because that is
1034          * the only way to achieve consistency of the arrow's movements
1035          * within a paragraph, and thus avoid situations in which the
1036          * cursor gets stuck.
1037          */
1038         return bottom().paragraph().isRTL(bv().buffer().params());
1039 }
1040
1041
1042 CursorSlice Cursor::normalAnchor() const
1043 {
1044         if (!selection())
1045                 return top();
1046         // LASSERT: There have been several bugs around this code, that seem
1047         // to involve failures to reset the anchor. We can at least not crash
1048         // in release mode by resetting it ourselves.
1049         if (anchor_.depth() < depth()) {
1050                 LYXERR0("Cursor is deeper than anchor. PLEASE REPORT.\nCursor is"
1051                         << *this);
1052                 const_cast<DocIterator &>(anchor_) = *this;
1053         }
1054
1055         CursorSlice normal = anchor_[depth() - 1];
1056         if (depth() < anchor_.depth() && top() <= normal) {
1057                 // anchor is behind cursor -> move anchor behind the inset
1058                 ++normal.pos();
1059         }
1060         return normal;
1061 }
1062
1063
1064 CursorSlice Cursor::selBegin() const
1065 {
1066         if (!selection())
1067                 return top();
1068         return normalAnchor() < top() ? normalAnchor() : top();
1069 }
1070
1071
1072 CursorSlice Cursor::selEnd() const
1073 {
1074         if (!selection())
1075                 return top();
1076         return normalAnchor() > top() ? normalAnchor() : top();
1077 }
1078
1079
1080 DocIterator Cursor::selectionBegin() const
1081 {
1082         if (!selection())
1083                 return *this;
1084
1085         DocIterator di;
1086         // FIXME: This is a work-around for the problem that
1087         // CursorSlice doesn't keep track of the boundary.
1088         if (normalAnchor() == top())
1089                 di = anchor_.boundary() > boundary() ? anchor_ : *this;
1090         else
1091                 di = normalAnchor() < top() ? anchor_ : *this;
1092         di.resize(depth());
1093         return di;
1094 }
1095
1096
1097 DocIterator Cursor::selectionEnd() const
1098 {
1099         if (!selection())
1100                 return *this;
1101
1102         DocIterator di;
1103         // FIXME: This is a work-around for the problem that
1104         // CursorSlice doesn't keep track of the boundary.
1105         if (normalAnchor() == top())
1106                 di = anchor_.boundary() < boundary() ? anchor_ : *this;
1107         else
1108                 di = normalAnchor() > top() ? anchor_ : *this;
1109
1110         if (di.depth() > depth()) {
1111                 di.resize(depth());
1112                 ++di.pos();
1113         }
1114         return di;
1115 }
1116
1117
1118 void Cursor::setSelection()
1119 {
1120         setSelection(true);
1121         if (idx() == normalAnchor().idx() &&
1122             pit() == normalAnchor().pit() &&
1123             pos() == normalAnchor().pos())
1124                 setSelection(false);
1125 }
1126
1127
1128 void Cursor::setSelection(DocIterator const & where, int n)
1129 {
1130         setCursor(where);
1131         setSelection(true);
1132         anchor_ = where;
1133         pos() += n;
1134 }
1135
1136
1137 void Cursor::clearSelection()
1138 {
1139         setSelection(false);
1140         setWordSelection(false);
1141         setMark(false);
1142         resetAnchor();
1143 }
1144
1145
1146 void Cursor::setTargetX(int x)
1147 {
1148         x_target_ = x;
1149         textTargetOffset_ = 0;
1150 }
1151
1152
1153 int Cursor::x_target() const
1154 {
1155         return x_target_;
1156 }
1157
1158
1159 void Cursor::clearTargetX()
1160 {
1161         x_target_ = -1;
1162         textTargetOffset_ = 0;
1163 }
1164
1165
1166 void Cursor::updateTextTargetOffset()
1167 {
1168         int x;
1169         int y;
1170         getPos(x, y);
1171         textTargetOffset_ = x - x_target_;
1172 }
1173
1174
1175 void Cursor::info(odocstream & os) const
1176 {
1177         for (int i = 1, n = depth(); i < n; ++i) {
1178                 operator[](i).inset().infoize(os);
1179                 os << "  ";
1180         }
1181         if (pos() != 0) {
1182                 Inset const * inset = prevInset();
1183                 // prevInset() can return 0 in certain case.
1184                 if (inset)
1185                         prevInset()->infoize2(os);
1186         }
1187 }
1188
1189
1190 bool Cursor::selHandle(bool sel)
1191 {
1192         //lyxerr << "Cursor::selHandle" << endl;
1193         if (mark())
1194                 sel = true;
1195         if (sel == selection())
1196                 return false;
1197
1198         if (!sel)
1199                 cap::saveSelection(*this);
1200
1201         resetAnchor();
1202         setSelection(sel);
1203         return true;
1204 }
1205 } // namespace lyx
1206
1207
1208 ///////////////////////////////////////////////////////////////////
1209 //
1210 // FIXME: Look here
1211 // The part below is the non-integrated rest of the original math
1212 // cursor. This should be either generalized for texted or moved
1213 // back to mathed (in most cases to InsetMathNest).
1214 //
1215 ///////////////////////////////////////////////////////////////////
1216
1217 #include "mathed/InsetMathChar.h"
1218 #include "mathed/InsetMathGrid.h"
1219 #include "mathed/InsetMathScript.h"
1220 #include "mathed/InsetMathUnknown.h"
1221 #include "mathed/MathFactory.h"
1222 #include "mathed/MathStream.h"
1223 #include "mathed/MathSupport.h"
1224
1225
1226 namespace lyx {
1227
1228 bool Cursor::isInside(Inset const * p) const
1229 {
1230         for (size_t i = 0; i != depth(); ++i)
1231                 if (&operator[](i).inset() == p)
1232                         return true;
1233         return false;
1234 }
1235
1236
1237 void Cursor::leaveInset(Inset const & inset)
1238 {
1239         for (size_t i = 0; i != depth(); ++i) {
1240                 if (&operator[](i).inset() == &inset) {
1241                         resize(i);
1242                         return;
1243                 }
1244         }
1245 }
1246
1247
1248 bool Cursor::openable(MathAtom const & t) const
1249 {
1250         if (!t->isActive())
1251                 return false;
1252
1253         if (t->lock())
1254                 return false;
1255
1256         if (!selection())
1257                 return true;
1258
1259         // we can't move into anything new during selection
1260         if (depth() >= anchor_.depth())
1261                 return false;
1262         if (t.nucleus() != &anchor_[depth()].inset())
1263                 return false;
1264
1265         return true;
1266 }
1267
1268
1269 void Cursor::setScreenPos(int x, int /*y*/)
1270 {
1271         setTargetX(x);
1272         //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
1273 }
1274
1275
1276
1277 void Cursor::plainErase()
1278 {
1279         cell().erase(pos());
1280 }
1281
1282
1283 void Cursor::markInsert()
1284 {
1285         insert(char_type(0));
1286 }
1287
1288
1289 void Cursor::markErase()
1290 {
1291         cell().erase(pos());
1292 }
1293
1294
1295 void Cursor::plainInsert(MathAtom const & t)
1296 {
1297         cell().insert(pos(), t);
1298         ++pos();
1299         inset().setBuffer(bv_->buffer());
1300         inset().initView();
1301         checkBufferStructure();
1302 }
1303
1304
1305 void Cursor::insert(docstring const & str)
1306 {
1307         for_each(str.begin(), str.end(),
1308                  bind(static_cast<void(Cursor::*)(char_type)>
1309                              (&Cursor::insert), this, _1));
1310 }
1311
1312
1313 void Cursor::insert(char_type c)
1314 {
1315         //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1316         LASSERT(!empty(), return);
1317         if (inMathed()) {
1318                 cap::selClearOrDel(*this);
1319                 insert(new InsetMathChar(c));
1320         } else {
1321                 text()->insertChar(*this, c);
1322         }
1323 }
1324
1325
1326 void Cursor::insert(MathAtom const & t)
1327 {
1328         //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1329         macroModeClose();
1330         cap::selClearOrDel(*this);
1331         plainInsert(t);
1332 }
1333
1334
1335 void Cursor::insert(Inset * inset0)
1336 {
1337         LASSERT(inset0, return);
1338         if (inMathed())
1339                 insert(MathAtom(inset0->asInsetMath()));
1340         else {
1341                 text()->insertInset(*this, inset0);
1342                 inset0->setBuffer(bv_->buffer());
1343                 inset0->initView();
1344                 if (inset0->isLabeled())
1345                         forceBufferUpdate();
1346         }
1347 }
1348
1349
1350 int Cursor::niceInsert(docstring const & t, Parse::flags f, bool enter)
1351 {
1352         MathData ar(buffer());
1353         asArray(t, ar, f);
1354         if (ar.size() == 1 && (enter || selection()))
1355                 niceInsert(ar[0]);
1356         else
1357                 insert(ar);
1358         return ar.size();
1359 }
1360
1361
1362 void Cursor::niceInsert(MathAtom const & t)
1363 {
1364         macroModeClose();
1365         docstring const safe = cap::grabAndEraseSelection(*this);
1366         plainInsert(t);
1367         // If possible, enter the new inset and move the contents of the selection
1368         if (t->isActive()) {
1369                 posBackward();
1370                 // be careful here: don't use 'pushBackward(t)' as this we need to
1371                 // push the clone, not the original
1372                 pushBackward(*nextInset());
1373                 // We may not use niceInsert here (recursion)
1374                 MathData ar(buffer());
1375                 asArray(safe, ar);
1376                 insert(ar);
1377         } else if (t->asMacro() && !safe.empty()) {
1378                 MathData ar(buffer());
1379                 asArray(safe, ar);
1380                 docstring const name = t->asMacro()->name();
1381                 MacroData const * data = buffer()->getMacro(name);
1382                 if (data && data->numargs() - data->optionals() > 0) {
1383                         plainInsert(MathAtom(new InsetMathBrace(ar)));
1384                         posBackward();
1385                 }
1386         }
1387 }
1388
1389
1390 void Cursor::insert(MathData const & ar)
1391 {
1392         macroModeClose();
1393         if (selection())
1394                 cap::eraseSelection(*this);
1395         cell().insert(pos(), ar);
1396         pos() += ar.size();
1397         // FIXME audit setBuffer calls
1398         inset().setBuffer(bv_->buffer());
1399 }
1400
1401
1402 bool Cursor::backspace()
1403 {
1404         if (selection()) {
1405                 cap::eraseSelection(*this);
1406                 return true;
1407         }
1408
1409         if (pos() == 0) {
1410                 // If empty cell, and not part of a big cell
1411                 if (lastpos() == 0 && inset().nargs() == 1) {
1412                         popBackward();
1413                         // Directly delete empty cell: [|[]] => [|]
1414                         if (inMathed()) {
1415                                 plainErase();
1416                                 resetAnchor();
1417                                 return true;
1418                         }
1419                         // [|], can not delete from inside
1420                         return false;
1421                 } else {
1422                         if (inMathed())
1423                                 pullArg();
1424                         else
1425                                 popBackward();
1426                         return true;
1427                 }
1428         }
1429
1430         if (inMacroMode()) {
1431                 InsetMathUnknown * p = activeMacro();
1432                 if (p->name().size() > 1) {
1433                         p->setName(p->name().substr(0, p->name().size() - 1));
1434                         return true;
1435                 }
1436         }
1437
1438         if (pos() != 0 && prevAtom()->nargs() > 0) {
1439                 // let's require two backspaces for 'big stuff' and
1440                 // highlight on the first
1441                 resetAnchor();
1442                 setSelection(true);
1443                 --pos();
1444         } else {
1445                 --pos();
1446                 plainErase();
1447         }
1448         return true;
1449 }
1450
1451
1452 bool Cursor::erase()
1453 {
1454         if (inMacroMode())
1455                 return true;
1456
1457         if (selection()) {
1458                 cap::eraseSelection(*this);
1459                 return true;
1460         }
1461
1462         // delete empty cells if possible
1463         if (pos() == lastpos() && inset().idxDelete(idx()))
1464                 return true;
1465
1466         // special behaviour when in last position of cell
1467         if (pos() == lastpos()) {
1468                 bool one_cell = inset().nargs() == 1;
1469                 if (one_cell && lastpos() == 0) {
1470                         popBackward();
1471                         // Directly delete empty cell: [|[]] => [|]
1472                         if (inMathed()) {
1473                                 plainErase();
1474                                 resetAnchor();
1475                                 return true;
1476                         }
1477                         // [|], can not delete from inside
1478                         return false;
1479                 }
1480                 // remove markup
1481                 if (!one_cell)
1482                         inset().idxGlue(idx());
1483                 return true;
1484         }
1485
1486         // 'clever' UI hack: only erase large items if previously slected
1487         if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1488                 resetAnchor();
1489                 setSelection(true);
1490                 ++pos();
1491         } else {
1492                 plainErase();
1493         }
1494
1495         return true;
1496 }
1497
1498
1499 bool Cursor::up()
1500 {
1501         macroModeClose();
1502         DocIterator save = *this;
1503         FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1504         this->dispatch(cmd);
1505         if (disp_.dispatched())
1506                 return true;
1507         setCursor(save);
1508         return false;
1509 }
1510
1511
1512 bool Cursor::down()
1513 {
1514         macroModeClose();
1515         DocIterator save = *this;
1516         FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1517         this->dispatch(cmd);
1518         if (disp_.dispatched())
1519                 return true;
1520         setCursor(save);
1521         return false;
1522 }
1523
1524
1525 bool Cursor::macroModeClose()
1526 {
1527         if (!inMacroMode())
1528                 return false;
1529         InsetMathUnknown * p = activeMacro();
1530         p->finalize();
1531         MathData selection(buffer());
1532         asArray(p->selection(), selection);
1533         docstring const s = p->name();
1534         --pos();
1535         cell().erase(pos());
1536
1537         // do nothing if the macro name is empty
1538         if (s == "\\")
1539                 return false;
1540
1541         // trigger updates of macros, at least, if no full
1542         // updates take place anyway
1543         screenUpdateFlags(Update::Force);
1544
1545         docstring const name = s.substr(1);
1546         InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1547         if (in && in->interpretString(*this, s))
1548                 return true;
1549         MathAtom atom = buffer()->getMacro(name, *this, false) ?
1550                 MathAtom(new MathMacro(buffer(), name)) : createInsetMath(name, buffer());
1551
1552         // try to put argument into macro, if we just inserted a macro
1553         bool macroArg = false;
1554         MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1555         if (atomAsMacro) {
1556                 // macros here are still unfolded (in init mode in fact). So
1557                 // we have to resolve the macro here manually and check its arity
1558                 // to put the selection behind it if arity > 0.
1559                 MacroData const * data = buffer()->getMacro(atomAsMacro->name());
1560                 if (!selection.empty() && data && data->numargs() - data->optionals() > 0) {
1561                         macroArg = true;
1562                         atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 1);
1563                 } else
1564                         // non-greedy case. Do not touch the arguments behind
1565                         atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT, 0);
1566         }
1567
1568         // insert remembered selection into first argument of a non-macro
1569         else if (atom.nucleus()->nargs() > 0)
1570                 atom.nucleus()->cell(0).append(selection);
1571
1572         plainInsert(atom);
1573
1574         // finally put the macro argument behind, if needed
1575         if (macroArg) {
1576                 if (selection.size() > 1 || selection[0]->asScriptInset())
1577                         plainInsert(MathAtom(new InsetMathBrace(selection)));
1578                 else
1579                         insert(selection);
1580         }
1581
1582         return true;
1583 }
1584
1585
1586 docstring Cursor::macroName()
1587 {
1588         return inMacroMode() ? activeMacro()->name() : docstring();
1589 }
1590
1591
1592 void Cursor::handleNest(MathAtom const & a, int c)
1593 {
1594         //lyxerr << "Cursor::handleNest: " << c << endl;
1595         MathAtom t = a;
1596         asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1597         insert(t);
1598         posBackward();
1599         pushBackward(*nextInset());
1600 }
1601
1602
1603 int Cursor::targetX() const
1604 {
1605         if (x_target() != -1)
1606                 return x_target();
1607         int x = 0;
1608         int y = 0;
1609         getPos(x, y);
1610         return x;
1611 }
1612
1613
1614 int Cursor::textTargetOffset() const
1615 {
1616         return textTargetOffset_;
1617 }
1618
1619
1620 void Cursor::setTargetX()
1621 {
1622         int x;
1623         int y;
1624         getPos(x, y);
1625         setTargetX(x);
1626 }
1627
1628
1629 bool Cursor::inMacroMode() const
1630 {
1631         if (!inMathed())
1632                 return false;
1633         if (pos() == 0 || cell().empty())
1634                 return false;
1635         InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1636         return p && !p->final();
1637 }
1638
1639
1640 InsetMathUnknown * Cursor::activeMacro()
1641 {
1642         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1643 }
1644
1645
1646 InsetMathUnknown const * Cursor::activeMacro() const
1647 {
1648         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1649 }
1650
1651
1652 void Cursor::pullArg()
1653 {
1654         // FIXME: Look here
1655         MathData ar = cell();
1656         if (popBackward() && inMathed()) {
1657                 plainErase();
1658                 cell().insert(pos(), ar);
1659                 resetAnchor();
1660         } else {
1661                 //formula()->mutateToText();
1662         }
1663 }
1664
1665
1666 void Cursor::touch()
1667 {
1668         // FIXME: look here
1669 #if 0
1670         DocIterator::const_iterator it = begin();
1671         DocIterator::const_iterator et = end();
1672         for ( ; it != et; ++it)
1673                 it->cell().touch();
1674 #endif
1675 }
1676
1677
1678 void Cursor::normalize()
1679 {
1680         if (idx() > lastidx()) {
1681                 lyxerr << "this should not really happen - 1: "
1682                        << idx() << ' ' << nargs()
1683                        << " in: " << &inset() << endl;
1684                 idx() = lastidx();
1685         }
1686
1687         if (pos() > lastpos()) {
1688                 lyxerr << "this should not really happen - 2: "
1689                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
1690                        << " in atom: '";
1691                 odocstringstream os;
1692                 TexRow texrow(false);
1693                 otexrowstream ots(os,texrow);
1694                 WriteStream wi(ots, false, true, WriteStream::wsDefault);
1695                 inset().asInsetMath()->write(wi);
1696                 lyxerr << to_utf8(os.str()) << endl;
1697                 pos() = lastpos();
1698         }
1699 }
1700
1701
1702 bool Cursor::upDownInMath(bool up)
1703 {
1704         // Be warned: The 'logic' implemented in this function is highly
1705         // fragile. A distance of one pixel or a '<' vs '<=' _really
1706         // matters. So fiddle around with it only if you think you know
1707         // what you are doing!
1708         int xo = 0;
1709         int yo = 0;
1710         getPos(xo, yo);
1711         xo = beforeDispatchPosX_;
1712
1713         // check if we had something else in mind, if not, this is the future
1714         // target
1715         if (x_target_ == -1)
1716                 setTargetX(xo);
1717         else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1718                 // In text mode inside the line (not left or right) possibly set a new target_x,
1719                 // but only if we are somewhere else than the previous target-offset.
1720
1721                 // We want to keep the x-target on subsequent up/down movements
1722                 // that cross beyond the end of short lines. Thus a special
1723                 // handling when the cursor is at the end of line: Use the new
1724                 // x-target only if the old one was before the end of line
1725                 // or the old one was after the beginning of the line
1726                 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1727                 bool left;
1728                 bool right;
1729                 if (inRTL) {
1730                         left = pos() == textRow().endpos();
1731                         right = pos() == textRow().pos();
1732                 } else {
1733                         left = pos() == textRow().pos();
1734                         right = pos() == textRow().endpos();
1735                 }
1736                 if ((!left && !right) ||
1737                                 (left && !right && xo < x_target_) ||
1738                                 (!left && right && x_target_ < xo))
1739                         setTargetX(xo);
1740                 else
1741                         xo = targetX();
1742         } else
1743                 xo = targetX();
1744
1745         // try neigbouring script insets
1746         Cursor old = *this;
1747         if (inMathed() && !selection()) {
1748                 // try left
1749                 if (pos() != 0) {
1750                         InsetMathScript const * p = prevAtom()->asScriptInset();
1751                         if (p && p->has(up)) {
1752                                 --pos();
1753                                 push(*const_cast<InsetMathScript*>(p));
1754                                 idx() = p->idxOfScript(up);
1755                                 pos() = lastpos();
1756
1757                                 // we went in the right direction? Otherwise don't jump into the script
1758                                 int x;
1759                                 int y;
1760                                 getPos(x, y);
1761                                 int oy = beforeDispatchPosY_;
1762                                 if ((!up && y <= oy) ||
1763                                                 (up && y >= oy))
1764                                         operator=(old);
1765                                 else
1766                                         return true;
1767                         }
1768                 }
1769
1770                 // try right
1771                 if (pos() != lastpos()) {
1772                         InsetMathScript const * p = nextAtom()->asScriptInset();
1773                         if (p && p->has(up)) {
1774                                 push(*const_cast<InsetMathScript*>(p));
1775                                 idx() = p->idxOfScript(up);
1776                                 pos() = 0;
1777
1778                                 // we went in the right direction? Otherwise don't jump into the script
1779                                 int x;
1780                                 int y;
1781                                 getPos(x, y);
1782                                 int oy = beforeDispatchPosY_;
1783                                 if ((!up && y <= oy) ||
1784                                                 (up && y >= oy))
1785                                         operator=(old);
1786                                 else
1787                                         return true;
1788                         }
1789                 }
1790         }
1791
1792         // try to find an inset that knows better then we,
1793         if (inset().idxUpDown(*this, up)) {
1794                 //lyxerr << "idxUpDown triggered" << endl;
1795                 // try to find best position within this inset
1796                 if (!selection())
1797                         setCursor(bruteFind2(*this, xo, yo));
1798                 return true;
1799         }
1800
1801         // any improvement going just out of inset?
1802         if (popBackward() && inMathed()) {
1803                 //lyxerr << "updown: popBackward succeeded" << endl;
1804                 int xnew;
1805                 int ynew;
1806                 int yold = beforeDispatchPosY_;
1807                 getPos(xnew, ynew);
1808                 if (up ? ynew < yold : ynew > yold)
1809                         return true;
1810         }
1811
1812         // no success, we are probably at the document top or bottom
1813         operator=(old);
1814         return false;
1815 }
1816
1817
1818 bool Cursor::atFirstOrLastRow(bool up)
1819 {
1820         TextMetrics const & tm = bv_->textMetrics(text());
1821         ParagraphMetrics const & pm = tm.parMetrics(pit());
1822
1823         int row;
1824         if (pos() && boundary())
1825                 row = pm.pos2row(pos() - 1);
1826         else
1827                 row = pm.pos2row(pos());
1828
1829         if (up) {
1830                 if (pit() == 0 && row == 0)
1831                         return true;
1832         } else {
1833                 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1834                                 row + 1 >= int(pm.rows().size()))
1835                         return true;
1836         }
1837         return false;
1838 }
1839
1840
1841 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1842 {
1843         LASSERT(text(), return false);
1844
1845         // where are we?
1846         int xo = 0;
1847         int yo = 0;
1848         getPos(xo, yo);
1849         xo = beforeDispatchPosX_;
1850
1851         // update the targetX - this is here before the "return false"
1852         // to set a new target which can be used by InsetTexts above
1853         // if we cannot move up/down inside this inset anymore
1854         if (x_target_ == -1)
1855                 setTargetX(xo);
1856         else if (xo - textTargetOffset() != x_target() &&
1857                                          depth() == beforeDispatchCursor_.depth()) {
1858                 // In text mode inside the line (not left or right)
1859                 // possibly set a new target_x, but only if we are
1860                 // somewhere else than the previous target-offset.
1861
1862                 // We want to keep the x-target on subsequent up/down
1863                 // movements that cross beyond the end of short lines.
1864                 // Thus a special handling when the cursor is at the
1865                 // end of line: Use the new x-target only if the old
1866                 // one was before the end of line or the old one was
1867                 // after the beginning of the line
1868                 bool inRTL = innerParagraph().isRTL(bv().buffer().params());
1869                 bool left;
1870                 bool right;
1871                 if (inRTL) {
1872                         left = pos() == textRow().endpos();
1873                         right = pos() == textRow().pos();
1874                 } else {
1875                         left = pos() == textRow().pos();
1876                         right = pos() == textRow().endpos();
1877                 }
1878                 if ((!left && !right) ||
1879                                 (left && !right && xo < x_target_) ||
1880                                 (!left && right && x_target_ < xo))
1881                         setTargetX(xo);
1882                 else
1883                         xo = targetX();
1884         } else
1885                 xo = targetX();
1886
1887         // first get the current line
1888         TextMetrics & tm = bv_->textMetrics(text());
1889         ParagraphMetrics const & pm = tm.parMetrics(pit());
1890         int row;
1891         if (pos() && boundary())
1892                 row = pm.pos2row(pos() - 1);
1893         else
1894                 row = pm.pos2row(pos());
1895
1896         if (atFirstOrLastRow(up)) {
1897                 // Is there a place for the cursor to go ? If yes, we
1898                 // can execute the DEPM, otherwise we should keep the
1899                 // paragraph to host the cursor.
1900                 Cursor dummy = *this;
1901                 bool valid_destination = false;
1902                 for(; dummy.depth(); dummy.pop())
1903                         if (!dummy.atFirstOrLastRow(up)) {
1904                                 valid_destination = true;
1905                                 break;
1906                         }
1907
1908                 // will a next dispatch follow and if there is a new
1909                 // dispatch will it move the cursor out ?
1910                 if (depth() > 1 && valid_destination) {
1911                         // The cursor hasn't changed yet. This happens when
1912                         // you e.g. move out of an inset. And to give the
1913                         // DEPM the possibility of doing something we must
1914                         // provide it with two different cursors. (Lgb, vfr)
1915                         dummy = *this;
1916                         dummy.pos() = dummy.pos() == 0 ? dummy.lastpos() : 0;
1917                         dummy.pit() = dummy.pit() == 0 ? dummy.lastpit() : 0;
1918
1919                         updateNeeded |= bv().checkDepm(dummy, *this);
1920                         updateTextTargetOffset();
1921                         if (updateNeeded)
1922                                 forceBufferUpdate();
1923                 }
1924                 return false;
1925         }
1926
1927         // with and without selection are handled differently
1928         if (!selection()) {
1929                 int yo = bv().getPos(*this).y_;
1930                 Cursor old = *this;
1931                 // To next/previous row
1932                 if (up)
1933                         tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1934                 else
1935                         tm.editXY(*this, xo, yo + textRow().descent() + 1);
1936                 clearSelection();
1937
1938                 // This happens when you move out of an inset.
1939                 // And to give the DEPM the possibility of doing
1940                 // something we must provide it with two different
1941                 // cursors. (Lgb)
1942                 Cursor dummy = *this;
1943                 if (dummy == old)
1944                         ++dummy.pos();
1945                 if (bv().checkDepm(dummy, old)) {
1946                         updateNeeded = true;
1947                         // Make sure that cur gets back whatever happened to dummy (Lgb)
1948                         operator=(dummy);
1949                 }
1950                 if (inTexted() && pos() && paragraph().isEnvSeparator(pos() - 1))
1951                         posBackward();
1952         } else {
1953                 // if there is a selection, we stay out of any inset,
1954                 // and just jump to the right position:
1955                 Cursor old = *this;
1956                 int next_row = row;
1957                 if (up) {
1958                         if (row > 0) {
1959                                 --next_row;
1960                         } else if (pit() > 0) {
1961                                 --pit();
1962                                 TextMetrics & tm = bv_->textMetrics(text());
1963                                 if (!tm.contains(pit()))
1964                                         tm.newParMetricsUp();
1965                                 ParagraphMetrics const & pmcur = tm.parMetrics(pit());
1966                                 next_row = pmcur.rows().size() - 1;
1967                         }
1968                 } else {
1969                         if (row + 1 < int(pm.rows().size())) {
1970                                 ++next_row;
1971                         } else if (pit() + 1 < int(text()->paragraphs().size())) {
1972                                 ++pit();
1973                                 TextMetrics & tm = bv_->textMetrics(text());
1974                                 if (!tm.contains(pit()))
1975                                         tm.newParMetricsDown();
1976                                 next_row = 0;
1977                         }
1978                 }
1979
1980                 Row const & real_next_row = tm.parMetrics(pit()).rows()[next_row];
1981                 bool bound = false;
1982                 top().pos() = tm.getPosNearX(real_next_row, xo, bound);
1983                 boundary(bound);
1984
1985                 updateNeeded |= bv().checkDepm(*this, old);
1986         }
1987
1988         if (updateNeeded)
1989                 forceBufferUpdate();
1990         updateTextTargetOffset();
1991         return true;
1992 }
1993
1994
1995 void Cursor::handleFont(string const & font)
1996 {
1997         LYXERR(Debug::DEBUG, font);
1998         docstring safe;
1999         if (selection()) {
2000                 macroModeClose();
2001                 safe = cap::grabAndEraseSelection(*this);
2002         }
2003
2004         recordUndoInset();
2005
2006         if (lastpos() != 0) {
2007                 // something left in the cell
2008                 if (pos() == 0) {
2009                         // cursor in first position
2010                         popBackward();
2011                 } else if (pos() == lastpos()) {
2012                         // cursor in last position
2013                         popForward();
2014                 } else {
2015                         // cursor in between. split cell
2016                         MathData::iterator bt = cell().begin();
2017                         MathAtom at = createInsetMath(from_utf8(font), buffer());
2018                         at.nucleus()->cell(0) = MathData(buffer(), bt, bt + pos());
2019                         cell().erase(bt, bt + pos());
2020                         popBackward();
2021                         plainInsert(at);
2022                 }
2023         } else {
2024                 // nothing left in the cell
2025                 popBackward();
2026                 plainErase();
2027                 resetAnchor();
2028         }
2029         insert(safe);
2030 }
2031
2032
2033 void Cursor::message(docstring const & msg) const
2034 {
2035         disp_.setMessage(msg);
2036 }
2037
2038
2039 void Cursor::errorMessage(docstring const & msg) const
2040 {
2041         disp_.setMessage(msg);
2042         disp_.setError(true);
2043 }
2044
2045
2046 namespace {
2047
2048 docstring parbreak(Cursor const * cur)
2049 {
2050         odocstringstream os;
2051         os << '\n';
2052         // only add blank line if we're not in a ParbreakIsNewline situation
2053         if (!cur->inset().getLayout().parbreakIsNewline()
2054             && !cur->paragraph().layout().parbreak_is_newline)
2055                 os << '\n';
2056         return os.str();
2057 }
2058
2059 }
2060
2061
2062 docstring Cursor::selectionAsString(bool with_label) const
2063 {
2064         if (!selection())
2065                 return docstring();
2066
2067         if (inMathed())
2068                 return cap::grabSelection(*this);
2069
2070         int const label = with_label
2071                 ? AS_STR_LABEL | AS_STR_INSETS : AS_STR_INSETS;
2072
2073         idx_type const startidx = selBegin().idx();
2074         idx_type const endidx = selEnd().idx();
2075         if (startidx != endidx) {
2076                 // multicell selection
2077                 InsetTabular * table = inset().asInsetTabular();
2078                 LASSERT(table, return docstring());
2079                 return table->asString(startidx, endidx);
2080         }
2081
2082         ParagraphList const & pars = text()->paragraphs();
2083
2084         pit_type const startpit = selBegin().pit();
2085         pit_type const endpit = selEnd().pit();
2086         size_t const startpos = selBegin().pos();
2087         size_t const endpos = selEnd().pos();
2088
2089         if (startpit == endpit)
2090                 return pars[startpit].asString(startpos, endpos, label);
2091
2092         // First paragraph in selection
2093         docstring result = pars[startpit].
2094                 asString(startpos, pars[startpit].size(), label)
2095                 + parbreak(this);
2096
2097         // The paragraphs in between (if any)
2098         for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
2099                 Paragraph const & par = pars[pit];
2100                 result += par.asString(0, par.size(), label)
2101                         + parbreak(this);
2102         }
2103
2104         // Last paragraph in selection
2105         result += pars[endpit].asString(0, endpos, label);
2106
2107         return result;
2108 }
2109
2110
2111 docstring Cursor::currentState() const
2112 {
2113         if (inMathed()) {
2114                 odocstringstream os;
2115                 info(os);
2116 #ifdef DEVEL_VERSION
2117                 InsetMath * math = inset().asInsetMath();
2118                 if (math)
2119                         os << _(", Inset: ") << math->id();
2120                 os << _(", Cell: ") << idx();
2121                 os << _(", Position: ") << pos();
2122 #endif
2123                 return os.str();
2124         }
2125
2126         if (inTexted())
2127                 return text()->currentState(*this);
2128
2129         return docstring();
2130 }
2131
2132
2133 docstring Cursor::getPossibleLabel() const
2134 {
2135         return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
2136 }
2137
2138
2139 Encoding const * Cursor::getEncoding() const
2140 {
2141         if (empty())
2142                 return 0;
2143         CursorSlice const & sl = innerTextSlice();
2144         Text const & text = *sl.text();
2145         Font font = text.getPar(sl.pit()).getFont(
2146                 bv().buffer().params(), sl.pos(), text.outerFont(sl.pit()));
2147         return font.language()->encoding();
2148 }
2149
2150
2151 void Cursor::undispatched() const
2152 {
2153         disp_.dispatched(false);
2154 }
2155
2156
2157 void Cursor::dispatched() const
2158 {
2159         disp_.dispatched(true);
2160 }
2161
2162
2163 void Cursor::screenUpdateFlags(Update::flags f) const
2164 {
2165         disp_.screenUpdate(f);
2166 }
2167
2168
2169 void Cursor::forceBufferUpdate() const
2170 {
2171         disp_.forceBufferUpdate();
2172 }
2173
2174
2175 void Cursor::clearBufferUpdate() const
2176 {
2177         disp_.clearBufferUpdate();
2178 }
2179
2180
2181 bool Cursor::needBufferUpdate() const
2182 {
2183         return disp_.needBufferUpdate();
2184 }
2185
2186
2187 void Cursor::noScreenUpdate() const
2188 {
2189         disp_.screenUpdate(Update::None);
2190 }
2191
2192
2193 Font Cursor::getFont() const
2194 {
2195         // The logic here should more or less match to the
2196         // Cursor::setCurrentFont logic, i.e. the cursor height should
2197         // give a hint what will happen if a character is entered.
2198
2199         // HACK. far from being perfect...
2200
2201         CursorSlice const & sl = innerTextSlice();
2202         Text const & text = *sl.text();
2203         Paragraph const & par = text.getPar(sl.pit());
2204
2205         // on boundary, so we are really at the character before
2206         pos_type pos = sl.pos();
2207         if (pos > 0 && boundary())
2208                 --pos;
2209
2210         // on space? Take the font before (only for RTL boundary stay)
2211         if (pos > 0) {
2212                 TextMetrics const & tm = bv().textMetrics(&text);
2213                 if (pos == sl.lastpos()
2214                         || (par.isSeparator(pos)
2215                         && !tm.isRTLBoundary(sl.pit(), pos)))
2216                         --pos;
2217         }
2218
2219         // get font at the position
2220         Font font = par.getFont(buffer()->params(), pos,
2221                 text.outerFont(sl.pit()));
2222
2223         return font;
2224 }
2225
2226
2227 bool Cursor::fixIfBroken()
2228 {
2229         bool const broken_cursor = DocIterator::fixIfBroken();
2230         bool const broken_anchor = anchor_.fixIfBroken();
2231
2232         if (broken_cursor || broken_anchor) {
2233                 clearNewWordPosition();
2234                 clearSelection();
2235                 return true;
2236         }
2237         return false;
2238 }
2239
2240
2241 void Cursor::sanitize()
2242 {
2243         setBuffer(&bv_->buffer());
2244         DocIterator::sanitize();
2245         if (selection())
2246                 anchor_.sanitize();
2247         else
2248                 resetAnchor();
2249 }
2250
2251
2252 bool notifyCursorLeavesOrEnters(Cursor const & old, Cursor & cur)
2253 {
2254         // find inset in common
2255         size_type i;
2256         for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
2257                 if (&old[i].inset() != &cur[i].inset())
2258                         break;
2259         }
2260
2261         // update words if we just moved to another paragraph
2262         if (i == old.depth() && i == cur.depth()
2263             && !cur.buffer()->isClean()
2264             && cur.inTexted() && old.inTexted()
2265             && cur.pit() != old.pit()) {
2266                 old.paragraph().updateWords();
2267         }
2268
2269         // notify everything on top of the common part in old cursor,
2270         // but stop if the inset claims the cursor to be invalid now
2271         for (size_type j = i; j < old.depth(); ++j) {
2272                 Cursor inset_pos = old;
2273                 inset_pos.cutOff(j);
2274                 if (old[j].inset().notifyCursorLeaves(inset_pos, cur))
2275                         return true;
2276         }
2277
2278         // notify everything on top of the common part in new cursor,
2279         // but stop if the inset claims the cursor to be invalid now
2280         for (; i < cur.depth(); ++i) {
2281                 if (cur[i].inset().notifyCursorEnters(cur))
2282                         return true;
2283         }
2284
2285         return false;
2286 }
2287
2288
2289 void Cursor::setCurrentFont()
2290 {
2291         CursorSlice const & cs = innerTextSlice();
2292         Paragraph const & par = cs.paragraph();
2293         pos_type cpit = cs.pit();
2294         pos_type cpos = cs.pos();
2295         Text const & ctext = *cs.text();
2296         TextMetrics const & tm = bv().textMetrics(&ctext);
2297
2298         // are we behind previous char in fact? -> go to that char
2299         if (cpos > 0 && boundary())
2300                 --cpos;
2301
2302         // find position to take the font from
2303         if (cpos != 0) {
2304                 // paragraph end? -> font of last char
2305                 if (cpos == lastpos())
2306                         --cpos;
2307                 // on space? -> look at the words in front of space
2308                 else if (cpos > 0 && par.isSeparator(cpos))     {
2309                         // abc| def -> font of c
2310                         // abc |[WERBEH], i.e. boundary==true -> font of c
2311                         // abc [WERBEH]| def, font of the space
2312                         if (!tm.isRTLBoundary(cpit, cpos))
2313                                 --cpos;
2314                 }
2315         }
2316
2317         // get font
2318         BufferParams const & bufparams = buffer()->params();
2319         current_font = par.getFontSettings(bufparams, cpos);
2320         real_current_font = tm.displayFont(cpit, cpos);
2321
2322         // special case for paragraph end
2323         if (cs.pos() == lastpos()
2324             && tm.isRTLBoundary(cpit, cs.pos())
2325             && !boundary()) {
2326                 Language const * lang = par.getParLanguage(bufparams);
2327                 current_font.setLanguage(lang);
2328                 current_font.fontInfo().setNumber(FONT_OFF);
2329                 real_current_font.setLanguage(lang);
2330                 real_current_font.fontInfo().setNumber(FONT_OFF);
2331         }
2332 }
2333
2334
2335 bool Cursor::textUndo()
2336 {
2337         if (!buffer()->undo().textUndo(*this))
2338                 return false;
2339         sanitize();
2340         return true;
2341 }
2342
2343
2344 bool Cursor::textRedo()
2345 {
2346         if (!buffer()->undo().textRedo(*this))
2347                 return false;
2348         sanitize();
2349         return true;
2350 }
2351
2352
2353 void Cursor::finishUndo() const
2354 {
2355         buffer()->undo().finishUndo();
2356 }
2357
2358
2359 void Cursor::beginUndoGroup() const
2360 {
2361         buffer()->undo().beginUndoGroup(*this);
2362 }
2363
2364
2365 void Cursor::endUndoGroup() const
2366 {
2367         buffer()->undo().endUndoGroup(*this);
2368 }
2369
2370
2371 void Cursor::recordUndo(pit_type from, pit_type to) const
2372 {
2373         buffer()->undo().recordUndo(*this, from, to);
2374 }
2375
2376
2377 void Cursor::recordUndo(pit_type from) const
2378 {
2379         buffer()->undo().recordUndo(*this, from, pit());
2380 }
2381
2382
2383 void Cursor::recordUndo(UndoKind kind) const
2384 {
2385         buffer()->undo().recordUndo(*this, kind);
2386 }
2387
2388
2389 void Cursor::recordUndoInset(Inset const * in) const
2390 {
2391         buffer()->undo().recordUndoInset(*this, in);
2392 }
2393
2394
2395 void Cursor::recordUndoFullBuffer() const
2396 {
2397         buffer()->undo().recordUndoFullBuffer(*this);
2398 }
2399
2400
2401 void Cursor::recordUndoBufferParams() const
2402 {
2403         buffer()->undo().recordUndoBufferParams(*this);
2404 }
2405
2406
2407 void Cursor::recordUndoSelection() const
2408 {
2409         if (inMathed()) {
2410                 if (cap::multipleCellsSelected(*this))
2411                         recordUndoInset();
2412                 else
2413                         recordUndo();
2414         } else {
2415                 buffer()->undo().recordUndo(*this,
2416                         selBegin().pit(), selEnd().pit());
2417         }
2418 }
2419
2420
2421 void Cursor::checkBufferStructure()
2422 {
2423         Buffer const * master = buffer()->masterBuffer();
2424         master->tocBackend().updateItem(*this);
2425         if (master != buffer() && !master->hasGuiDelegate())
2426                 // In case the master has no gui associated with it,
2427                 // the TocItem is not updated (part of bug 5699).
2428                 buffer()->tocBackend().updateItem(*this);
2429 }
2430
2431
2432 } // namespace lyx