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