]> git.lyx.org Git - lyx.git/blob - src/Cursor.cpp
Introduce a labels&references cache at buffer level. This cache uses the already...
[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 "FuncRequest.h"
27 #include "Language.h"
28 #include "lfuns.h"
29 #include "LyXFunc.h" // only for setMessage()
30 #include "LyXRC.h"
31 #include "paragraph_funcs.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
42 #include "insets/InsetTabular.h"
43 #include "insets/InsetText.h"
44
45 #include "mathed/InsetMath.h"
46 #include "mathed/InsetMathScript.h"
47 #include "mathed/MacroTable.h"
48 #include "mathed/MathData.h"
49 #include "mathed/MathMacro.h"
50
51 #include <boost/assert.hpp>
52 #include <boost/bind.hpp>
53
54 #include <sstream>
55 #include <limits>
56 #include <map>
57
58 using namespace std;
59
60 namespace lyx {
61
62 namespace {
63
64 bool positionable(DocIterator const & cursor, DocIterator const & anchor)
65 {
66         // avoid deeper nested insets when selecting
67         if (cursor.depth() > anchor.depth())
68                 return false;
69
70         // anchor might be deeper, should have same path then
71         for (size_t i = 0; i < cursor.depth(); ++i)
72                 if (&cursor[i].inset() != &anchor[i].inset())
73                         return false;
74
75         // position should be ok.
76         return true;
77 }
78
79
80 // Find position closest to (x, y) in cell given by iter.
81 // Used only in mathed
82 DocIterator bruteFind2(Cursor const & c, int x, int y)
83 {
84         double best_dist = numeric_limits<double>::max();
85
86         DocIterator result;
87
88         DocIterator it = c;
89         it.top().pos() = 0;
90         DocIterator et = c;
91         et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
92         for (size_t i = 0;; ++i) {
93                 int xo;
94                 int yo;
95                 Inset const * inset = &it.inset();
96                 map<Inset const *, Geometry> const & data =
97                         c.bv().coordCache().getInsets().getData();
98                 map<Inset const *, Geometry>::const_iterator I = data.find(inset);
99
100                 // FIXME: in the case where the inset is not in the cache, this
101                 // means that no part of it is visible on screen. In this case
102                 // we don't do elaborate search and we just return the forwarded
103                 // DocIterator at its beginning.
104                 if (I == data.end()) {
105                         it.top().pos() = 0;
106                         return it;
107                 }
108
109                 Point o = I->second.pos;
110                 inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
111                 // Convert to absolute
112                 xo += o.x_;
113                 yo += o.y_;
114                 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
115                 // '<=' in order to take the last possible position
116                 // this is important for clicking behind \sum in e.g. '\sum_i a'
117                 LYXERR(Debug::DEBUG, "i: " << i << " d: " << d
118                         << " best: " << best_dist);
119                 if (d <= best_dist) {
120                         best_dist = d;
121                         result = it;
122                 }
123                 if (it == et)
124                         break;
125                 it.forwardPos();
126         }
127         return result;
128 }
129
130
131 /*
132 /// moves position closest to (x, y) in given box
133 bool bruteFind(Cursor & cursor,
134         int x, int y, int xlow, int xhigh, int ylow, int yhigh)
135 {
136         BOOST_ASSERT(!cursor.empty());
137         Inset & inset = cursor[0].inset();
138         BufferView & bv = cursor.bv();
139
140         CoordCache::InnerParPosCache const & cache =
141                 bv.coordCache().getParPos().find(cursor.bottom().text())->second;
142         // Get an iterator on the first paragraph in the cache
143         DocIterator it(inset);
144         it.push_back(CursorSlice(inset));
145         it.pit() = cache.begin()->first;
146         // Get an iterator after the last paragraph in the cache
147         DocIterator et(inset);
148         et.push_back(CursorSlice(inset));
149         et.pit() = boost::prior(cache.end())->first;
150         if (et.pit() >= et.lastpit())
151                 et = doc_iterator_end(inset);
152         else
153                 ++et.pit();
154
155         double best_dist = numeric_limits<double>::max();;
156         DocIterator best_cursor = et;
157
158         for ( ; it != et; it.forwardPos(true)) {
159                 // avoid invalid nesting when selecting
160                 if (!cursor.selection() || positionable(it, cursor.anchor_)) {
161                         Point p = bv.getPos(it, false);
162                         int xo = p.x_;
163                         int yo = p.y_;
164                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
165                                 double const dx = xo - x;
166                                 double const dy = yo - y;
167                                 double const d = dx * dx + dy * dy;
168                                 // '<=' in order to take the last possible position
169                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
170                                 if (d <= best_dist) {
171                                         //      lyxerr << "*" << endl;
172                                         best_dist   = d;
173                                         best_cursor = it;
174                                 }
175                         }
176                 }
177         }
178
179         if (best_cursor != et) {
180                 cursor.setCursor(best_cursor);
181                 return true;
182         }
183
184         return false;
185 }
186 */
187
188
189 /// moves position closest to (x, y) in given box
190 bool bruteFind3(Cursor & cur, int x, int y, bool up)
191 {
192         BufferView & bv = cur.bv();
193         int ylow  = up ? 0 : y + 1;
194         int yhigh = up ? y - 1 : bv.workHeight();
195         int xlow = 0;
196         int xhigh = bv.workWidth();
197
198 // FIXME: bit more work needed to get 'from' and 'to' right.
199         pit_type from = cur.bottom().pit();
200         //pit_type to = cur.bottom().pit();
201         //lyxerr << "Pit start: " << from << endl;
202
203         //lyxerr << "bruteFind3: x: " << x << " y: " << y
204         //      << " xlow: " << xlow << " xhigh: " << xhigh
205         //      << " ylow: " << ylow << " yhigh: " << yhigh
206         //      << endl;
207         Inset & inset = bv.buffer().inset();
208         DocIterator it = doc_iterator_begin(inset);
209         it.pit() = from;
210         DocIterator et = doc_iterator_end(inset);
211
212         double best_dist = numeric_limits<double>::max();
213         DocIterator best_cursor = et;
214
215         for ( ; it != et; it.forwardPos()) {
216                 // avoid invalid nesting when selecting
217                 if (bv.cursorStatus(it) == CUR_INSIDE
218                                 && (!cur.selection() || positionable(it, cur.anchor_))) {
219                         Point p = bv.getPos(it, false);
220                         int xo = p.x_;
221                         int yo = p.y_;
222                         if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
223                                 double const dx = xo - x;
224                                 double const dy = yo - y;
225                                 double const d = dx * dx + dy * dy;
226                                 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
227                                 //      << " dx: " << dx << " dy: " << dy
228                                 //      << " idx: " << it.idx() << " pos: " << it.pos()
229                                 //      << " it:\n" << it
230                                 //      << endl;
231                                 // '<=' in order to take the last possible position
232                                 // this is important for clicking behind \sum in e.g. '\sum_i a'
233                                 if (d <= best_dist) {
234                                         //lyxerr << "*" << endl;
235                                         best_dist   = d;
236                                         best_cursor = it;
237                                 }
238                         }
239                 }
240         }
241
242         //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
243         if (best_cursor == et)
244                 return false;
245         cur.setCursor(best_cursor);
246         return true;
247 }
248
249 docstring parbreak(Paragraph const & par)
250 {
251         odocstringstream ods;
252         ods << '\n';
253         // only add blank line if we're not in an ERT or Listings inset
254         if (par.ownerCode() != ERT_CODE
255                         && par.ownerCode() != LISTINGS_CODE)
256                 ods << '\n';
257         return ods.str();
258 }
259
260 } // namespace anon
261
262
263 // be careful: this is called from the bv's constructor, too, so
264 // bv functions are not yet available!
265 Cursor::Cursor(BufferView & bv)
266         : DocIterator(), bv_(&bv), anchor_(), x_target_(-1), textTargetOffset_(0),
267           selection_(false), mark_(false), logicalpos_(false),
268           current_font(inherit_font)
269 {}
270
271
272 void Cursor::reset(Inset & inset)
273 {
274         clear();
275         push_back(CursorSlice(inset));
276         anchor_ = doc_iterator_begin(inset);
277         anchor_.clear();
278         clearTargetX();
279         selection_ = false;
280         mark_ = false;
281 }
282
283
284 // this (intentionally) does neither touch anchor nor selection status
285 void Cursor::setCursor(DocIterator const & cur)
286 {
287         DocIterator::operator=(cur);
288 }
289
290
291 void Cursor::dispatch(FuncRequest const & cmd0)
292 {
293         LYXERR(Debug::DEBUG, "cmd: " << cmd0 << '\n' << *this);
294         if (empty())
295                 return;
296
297         fixIfBroken();
298         FuncRequest cmd = cmd0;
299         Cursor safe = *this;
300         
301         // store some values to be used inside of the handlers
302         beforeDispatchCursor_ = *this;
303         for (; depth(); pop(), boundary(false)) {
304                 LYXERR(Debug::DEBUG, "Cursor::dispatch: cmd: "
305                         << cmd0 << endl << *this);
306                 BOOST_ASSERT(pos() <= lastpos());
307                 BOOST_ASSERT(idx() <= lastidx());
308                 BOOST_ASSERT(pit() <= lastpit());
309
310                 // The common case is 'LFUN handled, need update', so make the
311                 // LFUN handler's life easier by assuming this as default value.
312                 // The handler can reset the update and val flags if necessary.
313                 disp_.update(Update::FitCursor | Update::Force);
314                 disp_.dispatched(true);
315                 inset().dispatch(*this, cmd);
316                 if (disp_.dispatched())
317                         break;
318         }
319         
320         // it completely to get a 'bomb early' behaviour in case this
321         // object will be used again.
322         if (!disp_.dispatched()) {
323                 LYXERR(Debug::DEBUG, "RESTORING OLD CURSOR!");
324                 operator=(safe);
325                 disp_.update(Update::None);
326                 disp_.dispatched(false);
327         } else {
328                 // restore the previous one because nested Cursor::dispatch calls
329                 // are possible which would change it
330                 beforeDispatchCursor_ = safe.beforeDispatchCursor_;
331         }
332 }
333
334
335 DispatchResult Cursor::result() const
336 {
337         return disp_;
338 }
339
340
341 BufferView & Cursor::bv() const
342 {
343         BOOST_ASSERT(bv_);
344         return *bv_;
345 }
346
347
348 Buffer & Cursor::buffer() const
349 {
350         BOOST_ASSERT(bv_);
351         return bv_->buffer();
352 }
353
354
355 void Cursor::pop()
356 {
357         BOOST_ASSERT(depth() >= 1);
358         pop_back();
359 }
360
361
362 void Cursor::push(Inset & p)
363 {
364         push_back(CursorSlice(p));
365         p.setBuffer(bv_->buffer());
366 }
367
368
369 void Cursor::pushBackward(Inset & p)
370 {
371         BOOST_ASSERT(!empty());
372         //lyxerr << "Entering inset " << t << " front" << endl;
373         push(p);
374         p.idxFirst(*this);
375 }
376
377
378 bool Cursor::popBackward()
379 {
380         BOOST_ASSERT(!empty());
381         if (depth() == 1)
382                 return false;
383         pop();
384         return true;
385 }
386
387
388 bool Cursor::popForward()
389 {
390         BOOST_ASSERT(!empty());
391         //lyxerr << "Leaving inset from in back" << endl;
392         const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
393         if (depth() == 1)
394                 return false;
395         pop();
396         pos() += lastpos() - lp + 1;
397         return true;
398 }
399
400
401 int Cursor::currentMode()
402 {
403         BOOST_ASSERT(!empty());
404         for (int i = depth() - 1; i >= 0; --i) {
405                 int res = operator[](i).inset().currentMode();
406                 if (res != Inset::UNDECIDED_MODE)
407                         return res;
408         }
409         return Inset::TEXT_MODE;
410 }
411
412
413 void Cursor::getPos(int & x, int & y) const
414 {
415         Point p = bv().getPos(*this, boundary());
416         x = p.x_;
417         y = p.y_;
418 }
419
420
421 Row const & Cursor::textRow() const
422 {
423         CursorSlice const & cs = innerTextSlice();
424         ParagraphMetrics const & pm = bv().parMetrics(cs.text(), cs.pit());
425         BOOST_ASSERT(!pm.rows().empty());
426         return pm.getRow(pos(), boundary());
427 }
428
429
430 void Cursor::resetAnchor()
431 {
432         anchor_ = *this;
433 }
434
435
436
437 bool Cursor::posBackward()
438 {
439         if (pos() == 0)
440                 return false;
441         --pos();
442         return true;
443 }
444
445
446 bool Cursor::posForward()
447 {
448         if (pos() == lastpos())
449                 return false;
450         ++pos();
451         return true;
452 }
453
454
455 void Cursor::getSurroundingPos(pos_type & left_pos, pos_type & right_pos)
456 {
457         // preparing bidi tables
458         Paragraph const & par = paragraph();
459         Buffer const & buf = buffer();
460         Row const & row = textRow();
461         Bidi bidi;
462         bidi.computeTables(par, buf, row);
463
464         LYXERR(Debug::RTL, "bidi: " << row.pos() << "--" << row.endpos());
465
466         // The cursor is painted *before* the character at pos(), or, if 'boundary'
467         // is true, *after* the character at (pos() - 1). So we already have one
468         // known position around the cursor:
469         pos_type known_pos = boundary() ? pos() - 1 : pos();
470         
471         // edge case: if we're at the end of the paragraph, things are a little 
472         // different (because lastpos is a position which does not really "exist" 
473         // --- there's no character there yet).
474         if (known_pos == lastpos()) {
475                 if (par.isRTL(buf.params())) {
476                         left_pos = -1;
477                         right_pos = bidi.vis2log(row.pos());
478                 }
479                 else { // LTR paragraph
480                         right_pos = -1;
481                         left_pos = bidi.vis2log(row.endpos() - 1);
482                 }
483                 return;
484         }
485         
486         // Whether 'known_pos' is to the left or to the right of the cursor depends
487         // on whether it is an RTL or LTR character...
488         bool const cur_is_RTL = 
489                 par.getFontSettings(buf.params(), known_pos).isVisibleRightToLeft();
490         // ... in the following manner:
491         // For an RTL character, "before" means "to the right" and "after" means
492         // "to the left"; and for LTR, it's the reverse. So, 'known_pos' is to the
493         // right of the cursor if (RTL && boundary) or (!RTL && !boundary):
494         bool known_pos_on_right = (cur_is_RTL == boundary());
495
496         // So we now know one of the positions surrounding the cursor. Let's 
497         // determine the other one:
498         
499         if (known_pos_on_right) {
500                 right_pos = known_pos;
501                 // *visual* position of 'left_pos':
502                 pos_type v_left_pos = bidi.log2vis(right_pos) - 1;
503                 // If the position we just identified as 'left_pos' is a "skipped 
504                 // separator" (a separator which is at the logical end of a row,
505                 // except for the last row in a paragraph; such separators are not
506                 // painted, so they "are not really there"; note that in bidi text,
507                 // such a separator could appear visually in the middle of a row),
508                 // set 'left_pos' to the *next* position to the left.
509                 if (bidi.inRange(v_left_pos) 
510                                 && bidi.vis2log(v_left_pos) + 1 == row.endpos() 
511                                 && row.endpos() < lastpos()
512                                 && par.isSeparator(bidi.vis2log(v_left_pos))) {
513                         --v_left_pos;
514                 }
515                 // calculate the logical position of 'left_pos', if in row
516                 if (!bidi.inRange(v_left_pos))
517                         left_pos = -1;
518                 else
519                         left_pos = bidi.vis2log(v_left_pos);
520                 // If the position we identified as 'right_pos' is a "skipped 
521                 // separator", set 'right_pos' to the *next* position to the right.
522                 if (right_pos + 1 == row.endpos() && row.endpos() < lastpos() 
523                                 && par.isSeparator(right_pos)) {
524                         pos_type v_right_pos = bidi.log2vis(right_pos) + 1;
525                         if (!bidi.inRange(v_right_pos))
526                                 right_pos = -1;
527                         else
528                                 right_pos = bidi.vis2log(v_right_pos);
529                 }
530         } 
531         else { // known_pos is on the left
532                 left_pos = known_pos;
533                 // *visual* position of 'right_pos'
534                 pos_type v_right_pos = bidi.log2vis(left_pos) + 1;
535                 // If the position we just identified as 'right_pos' is a "skipped 
536                 // separator", set 'right_pos' to the *next* position to the right.
537                 if (bidi.inRange(v_right_pos) 
538                                 && bidi.vis2log(v_right_pos) + 1 == row.endpos() 
539                                 && row.endpos() < lastpos()
540                                 && par.isSeparator(bidi.vis2log(v_right_pos))) {
541                         ++v_right_pos;
542                 }
543                 // calculate the logical position of 'right_pos', if in row
544                 if (!bidi.inRange(v_right_pos)) 
545                         right_pos = -1;
546                 else
547                         right_pos = bidi.vis2log(v_right_pos);
548                 // If the position we identified as 'left_pos' is a "skipped 
549                 // separator", set 'left_pos' to the *next* position to the left.
550                 if (left_pos + 1 == row.endpos() && row.endpos() < lastpos() 
551                                 && par.isSeparator(left_pos)) {
552                         pos_type v_left_pos = bidi.log2vis(left_pos) - 1;
553                         if (!bidi.inRange(v_left_pos))
554                                 left_pos = -1;
555                         else
556                                 left_pos = bidi.vis2log(v_left_pos);
557                 }
558         }
559         return;
560 }
561
562
563 bool Cursor::posVisToNewRow(bool movingLeft)
564 {
565         Paragraph const & par = paragraph();
566         Buffer const & buf = buffer();
567         Row const & row = textRow();
568         bool par_is_LTR = !par.isRTL(buf.params());
569         
570         // if moving left in an LTR paragraph or moving right in an RTL one, 
571         // move to previous row
572         if (par_is_LTR == movingLeft) {
573                 if (row.pos() == 0) { // we're at first row in paragraph
574                         if (pit() == 0) // no previous paragraph! don't move
575                                 return false;
576                         // move to last pos in previous par
577                         --pit();
578                         pos() = lastpos();
579                         boundary(false);
580                 } else { // move to previous row in this par
581                         pos() = row.pos() - 1; // this is guaranteed to be in previous row
582                         boundary(false);
583                 }
584         }
585         // if moving left in an RTL paragraph or moving right in an LTR one, 
586         // move to next row
587         else {
588                 if (row.endpos() == lastpos()) { // we're at last row in paragraph
589                         if (pit() == lastpit()) // last paragraph! don't move
590                                 return false;
591                         // move to first row in next par
592                         ++pit();
593                         pos() = 0;
594                         boundary(false);
595                 } else { // move to next row in this par
596                         pos() = row.endpos();
597                         boundary(false);
598                 }
599         }
600         
601         // make sure we're at left-/right-most pos in new row
602         posVisToRowExtremity(!movingLeft);
603
604         return true;
605 }
606
607
608 void Cursor::posVisToRowExtremity(bool left)  
609 {
610         // prepare bidi tables
611         Paragraph const & par = paragraph();
612         Buffer const & buf = buffer();
613         Row const & row = textRow();
614         Bidi bidi;
615         bidi.computeTables(par, buf, row);
616
617         LYXERR(Debug::RTL, "entering extremity: " << pit() << "," << pos() << ","
618                 << (boundary() ? 1 : 0));
619
620         if (left) { // move to leftmost position
621                 // if this is an RTL paragraph, and we're at the last row in the
622                 // paragraph, move to lastpos
623                 if (par.isRTL(buf.params()) && row.endpos() == lastpos())
624                         pos() = lastpos();
625                 else {
626                         pos() = bidi.vis2log(row.pos());
627
628                         // Moving to the leftmost position in the row, the cursor should
629                         // normally be placed to the *left* of the leftmost position.
630                         // A very common exception, though, is if the leftmost character 
631                         // also happens to be the separator at the (logical) end of the row
632                         // --- in this case, the separator is positioned beyond the left 
633                         // margin, and we don't want to move the cursor there (moving to 
634                         // the left of the separator is equivalent to moving to the next
635                         // line). So, in this case we actually want to place the cursor 
636                         // to the *right* of the leftmost position (the separator). 
637                         // Another exception is if we're moving to the logically last 
638                         // position in the row, which is *not* a separator: this means
639                         // that the entire row has no separators (if there were any, the 
640                         // row would have been broken there); and therefore in this case
641                         // we also move to the *right* of the last position (this indicates
642                         // to the user that there is no space after this position, and is 
643                         // consistent with the behavior in the middle of a row --- moving
644                         // right or left moves to the next/previous character; if we were
645                         // to move to the *left* of this position, that would simulate 
646                         // a separator which is not really there!). 
647                         // Finally, there is an exception to the previous exception: if 
648                         // this non-separator-but-last-position-in-row is an inset, then
649                         // we *do* want to stay to the left of it anyway: this is the 
650                         // "boundary" which we simulate at insets.
651                         
652                         bool right_of_pos = false; // do we want to be to the right of pos?
653
654                         // as explained above, if at last pos in row, stay to the right
655                         if ((pos() == row.endpos() - 1) && !par.isInset(pos()))
656                                 right_of_pos = true;
657
658                         // Now we know if we want to be to the left or to the right of pos,
659                         // let's make sure we are where we want to be.
660                         bool new_pos_is_RTL = 
661                                 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
662
663                         if (new_pos_is_RTL == !right_of_pos) {
664                                 ++pos();
665                                 boundary(true);
666                         }
667                         
668                 }
669         }
670         else { // move to rightmost position
671                 // if this is an LTR paragraph, and we're at the last row in the
672                 // paragraph, move to lastpos
673                 if (!par.isRTL(buf.params()) && row.endpos() == lastpos())
674                         pos() = lastpos();
675                 else {
676                         pos() = bidi.vis2log(row.endpos() - 1);
677
678                         // Moving to the rightmost position in the row, the cursor should
679                         // normally be placed to the *right* of the rightmost position.
680                         // A very common exception, though, is if the rightmost character 
681                         // also happens to be the separator at the (logical) end of the row
682                         // --- in this case, the separator is positioned beyond the right 
683                         // margin, and we don't want to move the cursor there (moving to 
684                         // the right of the separator is equivalent to moving to the next
685                         // line). So, in this case we actually want to place the cursor 
686                         // to the *left* of the rightmost position (the separator). 
687                         // Another exception is if we're moving to the logically last 
688                         // position in the row, which is *not* a separator: this means
689                         // that the entire row has no separators (if there were any, the 
690                         // row would have been broken there); and therefore in this case
691                         // we also move to the *left* of the last position (this indicates
692                         // to the user that there is no space after this position, and is 
693                         // consistent with the behavior in the middle of a row --- moving
694                         // right or left moves to the next/previous character; if we were
695                         // to move to the *right* of this position, that would simulate 
696                         // a separator which is not really there!). 
697                         // Finally, there is an exception to the previous exception: if 
698                         // this non-separator-but-last-position-in-row is an inset, then
699                         // we *do* want to stay to the right of it anyway: this is the 
700                         // "boundary" which we simulate at insets.
701                         
702                         bool left_of_pos = false; // do we want to be to the left of pos?
703
704                         // as explained above, if at last pos in row, stay to the left
705                         if ((pos() == row.endpos() - 1) && !par.isInset(pos()))
706                                 left_of_pos = true;
707
708                         // Now we know if we want to be to the left or to the right of pos,
709                         // let's make sure we are where we want to be.
710                         bool new_pos_is_RTL = 
711                                 par.getFontSettings(buf.params(), pos()).isVisibleRightToLeft();
712
713                         if (new_pos_is_RTL == left_of_pos) {
714                                 ++pos();
715                                 boundary(true);
716                         }
717                 }
718         }
719         LYXERR(Debug::RTL, "leaving extremity: " << pit() << "," << pos() << ","
720                 << (boundary() ? 1 : 0));
721 }
722
723
724 CursorSlice Cursor::anchor() const
725 {
726         BOOST_ASSERT(anchor_.depth() >= depth());
727         CursorSlice normal = anchor_[depth() - 1];
728         if (depth() < anchor_.depth() && top() <= normal) {
729                 // anchor is behind cursor -> move anchor behind the inset
730                 ++normal.pos();
731         }
732         return normal;
733 }
734
735
736 CursorSlice Cursor::selBegin() const
737 {
738         if (!selection())
739                 return top();
740         return anchor() < top() ? anchor() : top();
741 }
742
743
744 CursorSlice Cursor::selEnd() const
745 {
746         if (!selection())
747                 return top();
748         return anchor() > top() ? anchor() : top();
749 }
750
751
752 DocIterator Cursor::selectionBegin() const
753 {
754         if (!selection())
755                 return *this;
756         DocIterator di = (anchor() < top() ? anchor_ : *this);
757         di.resize(depth());
758         return di;
759 }
760
761
762 DocIterator Cursor::selectionEnd() const
763 {
764         if (!selection())
765                 return *this;
766         DocIterator di = (anchor() > top() ? anchor_ : *this);
767         if (di.depth() > depth()) {
768                 di.resize(depth());
769                 ++di.pos();
770         }
771         return di;
772 }
773
774
775 void Cursor::setSelection()
776 {
777         selection() = true;
778         // A selection with no contents is not a selection
779         // FIXME: doesnt look ok
780         if (pit() == anchor().pit() && pos() == anchor().pos())
781                 selection() = false;
782 }
783
784
785 void Cursor::setSelection(DocIterator const & where, int n)
786 {
787         setCursor(where);
788         selection() = true;
789         anchor_ = where;
790         pos() += n;
791 }
792
793
794 void Cursor::clearSelection()
795 {
796         selection() = false;
797         mark() = false;
798         resetAnchor();
799 }
800
801
802 void Cursor::setTargetX(int x)
803 {
804         x_target_ = x;
805         textTargetOffset_ = 0;
806 }
807
808
809 int Cursor::x_target() const
810 {
811         return x_target_;
812 }
813
814
815 void Cursor::clearTargetX()
816 {
817         x_target_ = -1;
818         textTargetOffset_ = 0;
819 }
820
821
822 void Cursor::updateTextTargetOffset()
823 {
824         int x;
825         int y;
826         getPos(x, y);
827         textTargetOffset_ = x - x_target_;
828 }
829
830
831 void Cursor::info(odocstream & os) const
832 {
833         for (int i = 1, n = depth(); i < n; ++i) {
834                 operator[](i).inset().infoize(os);
835                 os << "  ";
836         }
837         if (pos() != 0) {
838                 Inset const * inset = prevInset();
839                 // prevInset() can return 0 in certain case.
840                 if (inset)
841                         prevInset()->infoize2(os);
842         }
843         // overwite old message
844         os << "                    ";
845 }
846
847
848 bool Cursor::selHandle(bool sel)
849 {
850         //lyxerr << "Cursor::selHandle" << endl;
851         if (mark())
852                 sel = true;
853         if (sel == selection())
854                 return false;
855
856         if (!sel)
857                 cap::saveSelection(*this);
858
859         resetAnchor();
860         selection() = sel;
861         return true;
862 }
863
864
865 ostream & operator<<(ostream & os, Cursor const & cur)
866 {
867         os << "\n cursor:                                | anchor:\n";
868         for (size_t i = 0, n = cur.depth(); i != n; ++i) {
869                 os << " " << cur[i] << " | ";
870                 if (i < cur.anchor_.depth())
871                         os << cur.anchor_[i];
872                 else
873                         os << "-------------------------------";
874                 os << "\n";
875         }
876         for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
877                 os << "------------------------------- | " << cur.anchor_[i] << "\n";
878         }
879         os << " selection: " << cur.selection_
880            << " x_target: " << cur.x_target_ << endl;
881         return os;
882 }
883
884
885 LyXErr & operator<<(LyXErr & os, Cursor const & cur)
886 {
887         os.stream() << cur;
888         return os;
889 }
890
891
892 } // namespace lyx
893
894
895 ///////////////////////////////////////////////////////////////////
896 //
897 // FIXME: Look here
898 // The part below is the non-integrated rest of the original math
899 // cursor. This should be either generalized for texted or moved
900 // back to mathed (in most cases to InsetMathNest).
901 //
902 ///////////////////////////////////////////////////////////////////
903
904 #include "mathed/InsetMathChar.h"
905 #include "mathed/InsetMathGrid.h"
906 #include "mathed/InsetMathScript.h"
907 #include "mathed/InsetMathUnknown.h"
908 #include "mathed/MathFactory.h"
909 #include "mathed/MathStream.h"
910 #include "mathed/MathSupport.h"
911
912
913 namespace lyx {
914
915 //#define FILEDEBUG 1
916
917
918 bool Cursor::isInside(Inset const * p) const
919 {
920         for (size_t i = 0; i != depth(); ++i)
921                 if (&operator[](i).inset() == p)
922                         return true;
923         return false;
924 }
925
926
927 void Cursor::leaveInset(Inset const & inset)
928 {
929         for (size_t i = 0; i != depth(); ++i) {
930                 if (&operator[](i).inset() == &inset) {
931                         resize(i);
932                         return;
933                 }
934         }
935 }
936
937
938 bool Cursor::openable(MathAtom const & t) const
939 {
940         if (!t->isActive())
941                 return false;
942
943         if (t->lock())
944                 return false;
945
946         if (!selection())
947                 return true;
948
949         // we can't move into anything new during selection
950         if (depth() >= anchor_.depth())
951                 return false;
952         if (t.nucleus() != &anchor_[depth()].inset())
953                 return false;
954
955         return true;
956 }
957
958
959 void Cursor::setScreenPos(int x, int /*y*/)
960 {
961         setTargetX(x);
962         //bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
963 }
964
965
966
967 void Cursor::plainErase()
968 {
969         cell().erase(pos());
970 }
971
972
973 void Cursor::markInsert()
974 {
975         insert(char_type(0));
976 }
977
978
979 void Cursor::markErase()
980 {
981         cell().erase(pos());
982 }
983
984
985 void Cursor::plainInsert(MathAtom const & t)
986 {
987         cell().insert(pos(), t);
988         ++pos();
989 }
990
991
992 void Cursor::insert(docstring const & str)
993 {
994         for_each(str.begin(), str.end(),
995                  boost::bind(static_cast<void(Cursor::*)(char_type)>
996                              (&Cursor::insert), this, _1));
997 }
998
999
1000 void Cursor::insert(char_type c)
1001 {
1002         //lyxerr << "Cursor::insert char '" << c << "'" << endl;
1003         BOOST_ASSERT(!empty());
1004         if (inMathed()) {
1005                 cap::selClearOrDel(*this);
1006                 insert(new InsetMathChar(c));
1007         } else {
1008                 text()->insertChar(*this, c);
1009         }
1010 }
1011
1012
1013 void Cursor::insert(MathAtom const & t)
1014 {
1015         //lyxerr << "Cursor::insert MathAtom '" << t << "'" << endl;
1016         macroModeClose();
1017         cap::selClearOrDel(*this);
1018         plainInsert(t);
1019 }
1020
1021
1022 void Cursor::insert(Inset * inset0)
1023 {
1024         BOOST_ASSERT(inset0);
1025         if (inMathed())
1026                 insert(MathAtom(inset0));
1027         else
1028                 text()->insertInset(*this, inset0);
1029         inset().setBuffer(bv_->buffer());
1030 }
1031
1032
1033 void Cursor::niceInsert(docstring const & t)
1034 {
1035         MathData ar;
1036         asArray(t, ar);
1037         if (ar.size() == 1)
1038                 niceInsert(ar[0]);
1039         else
1040                 insert(ar);
1041 }
1042
1043
1044 void Cursor::niceInsert(MathAtom const & t)
1045 {
1046         macroModeClose();
1047         docstring const safe = cap::grabAndEraseSelection(*this);
1048         plainInsert(t);
1049         // enter the new inset and move the contents of the selection if possible
1050         if (t->isActive()) {
1051                 posBackward();
1052                 // be careful here: don't use 'pushBackward(t)' as this we need to
1053                 // push the clone, not the original
1054                 pushBackward(*nextInset());
1055                 // We may not use niceInsert here (recursion)
1056                 MathData ar;
1057                 asArray(safe, ar);
1058                 insert(ar);
1059         }
1060 }
1061
1062
1063 void Cursor::insert(MathData const & ar)
1064 {
1065         macroModeClose();
1066         if (selection())
1067                 cap::eraseSelection(*this);
1068         cell().insert(pos(), ar);
1069         pos() += ar.size();
1070 }
1071
1072
1073 bool Cursor::backspace()
1074 {
1075         autocorrect() = false;
1076
1077         if (selection()) {
1078                 cap::eraseSelection(*this);
1079                 return true;
1080         }
1081
1082         if (pos() == 0) {
1083                 // If empty cell, and not part of a big cell
1084                 if (lastpos() == 0 && inset().nargs() == 1) {
1085                         popBackward();
1086                         // Directly delete empty cell: [|[]] => [|]
1087                         if (inMathed()) {
1088                                 plainErase();
1089                                 resetAnchor();
1090                                 return true;
1091                         }
1092                         // [|], can not delete from inside
1093                         return false;
1094                 } else {
1095                         if (inMathed())
1096                                 pullArg();
1097                         else
1098                                 popBackward();
1099                         return true;
1100                 }
1101         }
1102
1103         if (inMacroMode()) {
1104                 InsetMathUnknown * p = activeMacro();
1105                 if (p->name().size() > 1) {
1106                         p->setName(p->name().substr(0, p->name().size() - 1));
1107                         return true;
1108                 }
1109         }
1110
1111         if (pos() != 0 && prevAtom()->nargs() > 0) {
1112                 // let's require two backspaces for 'big stuff' and
1113                 // highlight on the first
1114                 resetAnchor();
1115                 selection() = true;
1116                 --pos();
1117         } else {
1118                 --pos();
1119                 plainErase();
1120         }
1121         return true;
1122 }
1123
1124
1125 bool Cursor::erase()
1126 {
1127         autocorrect() = false;
1128         if (inMacroMode())
1129                 return true;
1130
1131         if (selection()) {
1132                 cap::eraseSelection(*this);
1133                 return true;
1134         }
1135
1136         // delete empty cells if possible
1137         if (pos() == lastpos() && inset().idxDelete(idx()))
1138                 return true;
1139
1140         // special behaviour when in last position of cell
1141         if (pos() == lastpos()) {
1142                 bool one_cell = inset().nargs() == 1;
1143                 if (one_cell && lastpos() == 0) {
1144                         popBackward();
1145                         // Directly delete empty cell: [|[]] => [|]
1146                         if (inMathed()) {
1147                                 plainErase();
1148                                 resetAnchor();
1149                                 return true;
1150                         }
1151                         // [|], can not delete from inside
1152                         return false;
1153                 }
1154                 // remove markup
1155                 if (!one_cell)
1156                         inset().idxGlue(idx());
1157                 return true;
1158         }
1159
1160         // 'clever' UI hack: only erase large items if previously slected
1161         if (pos() != lastpos() && nextAtom()->nargs() > 0) {
1162                 resetAnchor();
1163                 selection() = true;
1164                 ++pos();
1165         } else {
1166                 plainErase();
1167         }
1168
1169         return true;
1170 }
1171
1172
1173 bool Cursor::up()
1174 {
1175         macroModeClose();
1176         DocIterator save = *this;
1177         FuncRequest cmd(selection() ? LFUN_UP_SELECT : LFUN_UP, docstring());
1178         this->dispatch(cmd);
1179         if (disp_.dispatched())
1180                 return true;
1181         setCursor(save);
1182         autocorrect() = false;
1183         return false;
1184 }
1185
1186
1187 bool Cursor::down()
1188 {
1189         macroModeClose();
1190         DocIterator save = *this;
1191         FuncRequest cmd(selection() ? LFUN_DOWN_SELECT : LFUN_DOWN, docstring());
1192         this->dispatch(cmd);
1193         if (disp_.dispatched())
1194                 return true;
1195         setCursor(save);
1196         autocorrect() = false;
1197         return false;
1198 }
1199
1200
1201 bool Cursor::macroModeClose()
1202 {
1203         if (!inMacroMode())
1204                 return false;
1205         InsetMathUnknown * p = activeMacro();
1206         p->finalize();
1207         docstring const s = p->name();
1208         --pos();
1209         cell().erase(pos());
1210
1211         // do nothing if the macro name is empty
1212         if (s == "\\")
1213                 return false;
1214
1215         // trigger updates of macros, at least, if no full
1216         // updates take place anyway
1217         updateFlags(Update::Force);
1218
1219         docstring const name = s.substr(1);
1220         InsetMathNest * const in = inset().asInsetMath()->asNestInset();
1221         if (in && in->interpretString(*this, s))
1222                 return true;
1223         MathAtom atom = createInsetMath(name);
1224         MathMacro * atomAsMacro = atom.nucleus()->asMacro();
1225         if (atomAsMacro) {
1226                 // make non-greedy, i.e. don't eat parameters from the right
1227                 atomAsMacro->setDisplayMode(MathMacro::DISPLAY_INTERACTIVE_INIT);
1228         }
1229         plainInsert(atom);
1230         return true;
1231 }
1232
1233
1234 docstring Cursor::macroName()
1235 {
1236         return inMacroMode() ? activeMacro()->name() : docstring();
1237 }
1238
1239
1240 void Cursor::handleNest(MathAtom const & a, int c)
1241 {
1242         //lyxerr << "Cursor::handleNest: " << c << endl;
1243         MathAtom t = a;
1244         asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
1245         insert(t);
1246         posBackward();
1247         pushBackward(*nextInset());
1248 }
1249
1250
1251 int Cursor::targetX() const
1252 {
1253         if (x_target() != -1)
1254                 return x_target();
1255         int x = 0;
1256         int y = 0;
1257         getPos(x, y);
1258         return x;
1259 }
1260
1261
1262 int Cursor::textTargetOffset() const
1263 {
1264         return textTargetOffset_;
1265 }
1266
1267
1268 void Cursor::setTargetX()
1269 {
1270         int x;
1271         int y;
1272         getPos(x, y);
1273         setTargetX(x);
1274 }
1275
1276
1277 bool Cursor::inMacroMode() const
1278 {
1279         if (!inMathed())
1280                 return false;
1281         if (pos() == 0)
1282                 return false;
1283         InsetMathUnknown const * p = prevAtom()->asUnknownInset();
1284         return p && !p->final();
1285 }
1286
1287
1288 InsetMathUnknown * Cursor::activeMacro()
1289 {
1290         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1291 }
1292
1293
1294 InsetMathUnknown const * Cursor::activeMacro() const
1295 {
1296         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
1297 }
1298
1299
1300 void Cursor::pullArg()
1301 {
1302         // FIXME: Look here
1303         MathData ar = cell();
1304         if (popBackward() && inMathed()) {
1305                 plainErase();
1306                 cell().insert(pos(), ar);
1307                 resetAnchor();
1308         } else {
1309                 //formula()->mutateToText();
1310         }
1311 }
1312
1313
1314 void Cursor::touch()
1315 {
1316         // FIXME: look here
1317 #if 0
1318         DocIterator::const_iterator it = begin();
1319         DocIterator::const_iterator et = end();
1320         for ( ; it != et; ++it)
1321                 it->cell().touch();
1322 #endif
1323 }
1324
1325
1326 void Cursor::normalize()
1327 {
1328         if (idx() > lastidx()) {
1329                 lyxerr << "this should not really happen - 1: "
1330                        << idx() << ' ' << nargs()
1331                        << " in: " << &inset() << endl;
1332                 idx() = lastidx();
1333         }
1334
1335         if (pos() > lastpos()) {
1336                 lyxerr << "this should not really happen - 2: "
1337                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
1338                        << " in atom: '";
1339                 odocstringstream os;
1340                 WriteStream wi(os, false, true);
1341                 inset().asInsetMath()->write(wi);
1342                 lyxerr << to_utf8(os.str()) << endl;
1343                 pos() = lastpos();
1344         }
1345 }
1346
1347
1348 bool Cursor::upDownInMath(bool up)
1349 {
1350         // Be warned: The 'logic' implemented in this function is highly
1351         // fragile. A distance of one pixel or a '<' vs '<=' _really
1352         // matters. So fiddle around with it only if you think you know
1353         // what you are doing!
1354         int xo = 0;
1355         int yo = 0;
1356         getPos(xo, yo);
1357         xo = theLyXFunc().cursorBeforeDispatchX();
1358         
1359         // check if we had something else in mind, if not, this is the future
1360         // target
1361         if (x_target_ == -1)
1362                 setTargetX(xo);
1363         else if (inset().asInsetText() && xo - textTargetOffset() != x_target()) {
1364                 // In text mode inside the line (not left or right) possibly set a new target_x,
1365                 // but only if we are somewhere else than the previous target-offset.
1366                 
1367                 // We want to keep the x-target on subsequent up/down movements
1368                 // that cross beyond the end of short lines. Thus a special
1369                 // handling when the cursor is at the end of line: Use the new
1370                 // x-target only if the old one was before the end of line
1371                 // or the old one was after the beginning of the line
1372                 bool inRTL = isWithinRtlParagraph(*this);
1373                 bool left;
1374                 bool right;
1375                 if (inRTL) {
1376                         left = pos() == textRow().endpos();
1377                         right = pos() == textRow().pos();
1378                 } else {
1379                         left = pos() == textRow().pos();
1380                         right = pos() == textRow().endpos();
1381                 }
1382                 if ((!left && !right) ||
1383                                 (left && !right && xo < x_target_) ||
1384                                 (!left && right && x_target_ < xo))
1385                         setTargetX(xo);
1386                 else
1387                         xo = targetX();
1388         } else
1389                 xo = targetX();
1390
1391         // try neigbouring script insets
1392         Cursor old = *this;
1393         if (inMathed() && !selection()) {
1394                 // try left
1395                 if (pos() != 0) {
1396                         InsetMathScript const * p = prevAtom()->asScriptInset();
1397                         if (p && p->has(up)) {
1398                                 --pos();
1399                                 push(*const_cast<InsetMathScript*>(p));
1400                                 idx() = p->idxOfScript(up);
1401                                 pos() = lastpos();
1402                                 
1403                                 // we went in the right direction? Otherwise don't jump into the script
1404                                 int x;
1405                                 int y;
1406                                 getPos(x, y);
1407                                 int oy = theLyXFunc().cursorBeforeDispatchY();
1408                                 if ((!up && y <= oy) ||
1409                                                 (up && y >= oy))
1410                                         operator=(old);
1411                                 else
1412                                         return true;
1413                         }
1414                 }
1415                 
1416                 // try right
1417                 if (pos() != lastpos()) {
1418                         InsetMathScript const * p = nextAtom()->asScriptInset();
1419                         if (p && p->has(up)) {
1420                                 push(*const_cast<InsetMathScript*>(p));
1421                                 idx() = p->idxOfScript(up);
1422                                 pos() = 0;
1423                                 
1424                                 // we went in the right direction? Otherwise don't jump into the script
1425                                 int x;
1426                                 int y;
1427                                 getPos(x, y);
1428                                 int oy = theLyXFunc().cursorBeforeDispatchY();
1429                                 if ((!up && y <= oy) ||
1430                                                 (up && y >= oy))
1431                                         operator=(old);
1432                                 else
1433                                         return true;
1434                         }
1435                 }
1436         }
1437                 
1438         // try to find an inset that knows better then we,
1439         if (inset().idxUpDown(*this, up)) {
1440                 //lyxerr << "idxUpDown triggered" << endl;
1441                 // try to find best position within this inset
1442                 if (!selection())
1443                         setCursor(bruteFind2(*this, xo, yo));
1444                 return true;
1445         }
1446         
1447         // any improvement going just out of inset?
1448         if (popBackward() && inMathed()) {
1449                 //lyxerr << "updown: popBackward succeeded" << endl;
1450                 int xnew;
1451                 int ynew;
1452                 int yold = theLyXFunc().cursorBeforeDispatchY();
1453                 getPos(xnew, ynew);
1454                 if (up ? ynew < yold : ynew > yold)
1455                         return true;
1456         }
1457         
1458         // no success, we are probably at the document top or bottom
1459         operator=(old);
1460         return false;
1461 }
1462
1463
1464 bool Cursor::upDownInText(bool up, bool & updateNeeded)
1465 {
1466         BOOST_ASSERT(text());
1467
1468         // where are we?
1469         int xo = 0;
1470         int yo = 0;
1471         getPos(xo, yo);
1472         xo = theLyXFunc().cursorBeforeDispatchX();
1473
1474         // update the targetX - this is here before the "return false"
1475         // to set a new target which can be used by InsetTexts above
1476         // if we cannot move up/down inside this inset anymore
1477         if (x_target_ == -1)
1478                 setTargetX(xo);
1479         else if (xo - textTargetOffset() != x_target() &&
1480                                          depth() == beforeDispatchCursor_.depth()) {
1481                 // In text mode inside the line (not left or right) possibly set a new target_x,
1482                 // but only if we are somewhere else than the previous target-offset.
1483                 
1484                 // We want to keep the x-target on subsequent up/down movements
1485                 // that cross beyond the end of short lines. Thus a special
1486                 // handling when the cursor is at the end of line: Use the new
1487                 // x-target only if the old one was before the end of line
1488                 // or the old one was after the beginning of the line
1489                 bool inRTL = isWithinRtlParagraph(*this);
1490                 bool left;
1491                 bool right;
1492                 if (inRTL) {
1493                         left = pos() == textRow().endpos();
1494                         right = pos() == textRow().pos();
1495                 } else {
1496                         left = pos() == textRow().pos();
1497                         right = pos() == textRow().endpos();
1498                 }
1499                 if ((!left && !right) ||
1500                                 (left && !right && xo < x_target_) ||
1501                                 (!left && right && x_target_ < xo))
1502                         setTargetX(xo);
1503                 else
1504                         xo = targetX();
1505         } else
1506                 xo = targetX();
1507                 
1508         // first get the current line
1509         TextMetrics & tm = bv_->textMetrics(text());
1510         ParagraphMetrics const & pm = tm.parMetrics(pit());
1511         int row;
1512         if (pos() && boundary())
1513                 row = pm.pos2row(pos() - 1);
1514         else
1515                 row = pm.pos2row(pos());
1516                 
1517         // are we not at the start or end?
1518         if (up) {
1519                 if (pit() == 0 && row == 0)
1520                         return false;
1521         } else {
1522                 if (pit() + 1 >= int(text()->paragraphs().size()) &&
1523                                 row + 1 >= int(pm.rows().size()))
1524                         return false;
1525         }       
1526
1527         // with and without selection are handled differently
1528         if (!selection()) {
1529                 int yo = bv().getPos(*this, boundary()).y_;
1530                 Cursor old = *this;
1531                 // To next/previous row
1532                 if (up)
1533                         tm.editXY(*this, xo, yo - textRow().ascent() - 1);
1534                 else
1535                         tm.editXY(*this, xo, yo + textRow().descent() + 1);
1536                 clearSelection();
1537                 
1538                 // This happens when you move out of an inset.
1539                 // And to give the DEPM the possibility of doing
1540                 // something we must provide it with two different
1541                 // cursors. (Lgb)
1542                 Cursor dummy = *this;
1543                 if (dummy == old)
1544                         ++dummy.pos();
1545                 if (bv().checkDepm(dummy, old)) {
1546                         updateNeeded = true;
1547                         // Make sure that cur gets back whatever happened to dummy(Lgb)
1548                         operator=(dummy);
1549                 }
1550         } else {
1551                 // if there is a selection, we stay out of any inset, and just jump to the right position:
1552                 Cursor old = *this;
1553                 if (up) {
1554                         if (row > 0) {
1555                                 top().pos() = min(tm.x2pos(pit(), row - 1, xo), top().lastpos());
1556                         } else if (pit() > 0) {
1557                                 --pit();
1558                                 ParagraphMetrics const & pmcur = bv_->parMetrics(text(), pit());
1559                                 top().pos() = min(tm.x2pos(pit(), pmcur.rows().size() - 1, xo), top().lastpos());
1560                         }
1561                 } else {
1562                         if (row + 1 < int(pm.rows().size())) {
1563                                 top().pos() = min(tm.x2pos(pit(), row + 1, xo), top().lastpos());
1564                         } else if (pit() + 1 < int(text()->paragraphs().size())) {
1565                                 ++pit();
1566                                 top().pos() = min(tm.x2pos(pit(), 0, xo), top().lastpos());
1567                         }
1568                 }
1569
1570                 updateNeeded |= bv().checkDepm(*this, old);
1571         }
1572
1573         updateTextTargetOffset();
1574         return true;
1575 }       
1576
1577
1578 void Cursor::handleFont(string const & font)
1579 {
1580         LYXERR(Debug::DEBUG, font);
1581         docstring safe;
1582         if (selection()) {
1583                 macroModeClose();
1584                 safe = cap::grabAndEraseSelection(*this);
1585         }
1586
1587         if (lastpos() != 0) {
1588                 // something left in the cell
1589                 if (pos() == 0) {
1590                         // cursor in first position
1591                         popBackward();
1592                 } else if (pos() == lastpos()) {
1593                         // cursor in last position
1594                         popForward();
1595                 } else {
1596                         // cursor in between. split cell
1597                         MathData::iterator bt = cell().begin();
1598                         MathAtom at = createInsetMath(from_utf8(font));
1599                         at.nucleus()->cell(0) = MathData(bt, bt + pos());
1600                         cell().erase(bt, bt + pos());
1601                         popBackward();
1602                         plainInsert(at);
1603                 }
1604         } else {
1605                 // nothing left in the cell
1606                 pullArg();
1607                 plainErase();
1608         }
1609         insert(safe);
1610 }
1611
1612
1613 void Cursor::message(docstring const & msg) const
1614 {
1615         theLyXFunc().setMessage(msg);
1616 }
1617
1618
1619 void Cursor::errorMessage(docstring const & msg) const
1620 {
1621         theLyXFunc().setErrorMessage(msg);
1622 }
1623
1624
1625 docstring Cursor::selectionAsString(bool label) const
1626 {
1627         if (!selection())
1628                 return docstring();
1629
1630         if (inTexted()) {
1631                 ParagraphList const & pars = text()->paragraphs();
1632
1633                 // should be const ...
1634                 pit_type startpit = selBegin().pit();
1635                 pit_type endpit = selEnd().pit();
1636                 size_t const startpos = selBegin().pos();
1637                 size_t const endpos = selEnd().pos();
1638
1639                 if (startpit == endpit)
1640                         return pars[startpit].asString(startpos, endpos, label);
1641
1642                 // First paragraph in selection
1643                 docstring result = pars[startpit].
1644                         asString(startpos, pars[startpit].size(), label)
1645                                  + parbreak(pars[startpit]);
1646
1647                 // The paragraphs in between (if any)
1648                 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1649                         Paragraph const & par = pars[pit];
1650                         result += par.asString(0, par.size(), label)
1651                                   + parbreak(pars[pit]);
1652                 }
1653
1654                 // Last paragraph in selection
1655                 result += pars[endpit].asString(0, endpos, label);
1656
1657                 return result;
1658         }
1659
1660         if (inMathed())
1661                 return cap::grabSelection(*this);
1662
1663         return docstring();
1664 }
1665
1666
1667 docstring Cursor::currentState()
1668 {
1669         if (inMathed()) {
1670                 odocstringstream os;
1671                 info(os);
1672                 return os.str();
1673         }
1674
1675         if (inTexted())
1676                 return text()->currentState(*this);
1677
1678         return docstring();
1679 }
1680
1681
1682 docstring Cursor::getPossibleLabel()
1683 {
1684         return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
1685 }
1686
1687
1688 Encoding const * Cursor::getEncoding() const
1689 {
1690         if (empty())
1691                 return 0;
1692         CursorSlice const & sl = innerTextSlice();
1693         Text const & text = *sl.text();
1694         Font font = text.getPar(sl.pit()).getFont(
1695                 bv().buffer().params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1696         return font.language()->encoding();
1697 }
1698
1699
1700 void Cursor::undispatched()
1701 {
1702         disp_.dispatched(false);
1703 }
1704
1705
1706 void Cursor::dispatched()
1707 {
1708         disp_.dispatched(true);
1709 }
1710
1711
1712 void Cursor::updateFlags(Update::flags f)
1713 {
1714         disp_.update(f);
1715 }
1716
1717
1718 void Cursor::noUpdate()
1719 {
1720         disp_.update(Update::None);
1721 }
1722
1723
1724 Font Cursor::getFont() const
1725 {
1726         // The logic here should more or less match to the Cursor::setCurrentFont
1727         // logic, i.e. the cursor height should give a hint what will happen
1728         // if a character is entered.
1729         
1730         // HACK. far from being perfect...
1731
1732         CursorSlice const & sl = innerTextSlice();
1733         Text const & text = *sl.text();
1734         Paragraph const & par = text.getPar(sl.pit());
1735         
1736         // on boundary, so we are really at the character before
1737         pos_type pos = sl.pos();
1738         if (pos > 0 && boundary())
1739                 --pos;
1740         
1741         // on space? Take the font before (only for RTL boundary stay)
1742         if (pos > 0) {
1743                 TextMetrics const & tm = bv().textMetrics(&text);
1744                 if (pos == sl.lastpos()
1745                         || (par.isSeparator(pos) 
1746                         && !tm.isRTLBoundary(sl.pit(), pos)))
1747                         --pos;
1748         }
1749         
1750         // get font at the position
1751         Font font = par.getFont(bv().buffer().params(), pos,
1752                 outerFont(sl.pit(), text.paragraphs()));
1753
1754         return font;
1755 }
1756
1757
1758 bool Cursor::fixIfBroken()
1759 {
1760         if (DocIterator::fixIfBroken()) {
1761                         clearSelection();
1762                         resetAnchor();
1763                         return true;
1764         }
1765         return false;
1766 }
1767
1768
1769 bool notifyCursorLeaves(Cursor const & old, Cursor & cur)
1770 {
1771         // find inset in common
1772         size_type i;
1773         for (i = 0; i < old.depth() && i < cur.depth(); ++i) {
1774                 if (&old[i].inset() != &cur[i].inset())
1775                         break;
1776         }
1777
1778         // update words if we just moved to another paragraph
1779         if (i == old.depth() && i == cur.depth()
1780             && !cur.buffer().isClean()
1781             && cur.inTexted() && old.inTexted()
1782             && cur.pit() != old.pit()) {
1783                 old.paragraph().updateWords(old.buffer(), old.top());
1784                 return false;
1785         }
1786         
1787         // notify everything on top of the common part in old cursor,
1788         // but stop if the inset claims the cursor to be invalid now
1789         for (; i < old.depth(); ++i) {
1790                 Cursor insetPos = old;
1791                 insetPos.cutOff(i);
1792                 if (old[i].inset().notifyCursorLeaves(insetPos, cur))
1793                         return true;
1794         }
1795         
1796         return false;
1797 }
1798
1799
1800 void Cursor::setCurrentFont()
1801 {
1802         CursorSlice const & cs = innerTextSlice();
1803         Paragraph const & par = cs.paragraph();
1804         pos_type cpit = cs.pit();
1805         pos_type cpos = cs.pos();
1806         Text const & ctext = *cs.text();
1807         TextMetrics const & tm = bv().textMetrics(&ctext);
1808
1809         // are we behind previous char in fact? -> go to that char
1810         if (cpos > 0 && boundary())
1811                 --cpos;
1812
1813         // find position to take the font from
1814         if (cpos != 0) {
1815                 // paragraph end? -> font of last char
1816                 if (cpos == lastpos())
1817                         --cpos;
1818                 // on space? -> look at the words in front of space
1819                 else if (cpos > 0 && par.isSeparator(cpos))     {
1820                         // abc| def -> font of c
1821                         // abc |[WERBEH], i.e. boundary==true -> font of c
1822                         // abc [WERBEH]| def, font of the space
1823                         if (!tm.isRTLBoundary(cpit, cpos))
1824                                 --cpos;
1825                 }
1826         }
1827
1828         // get font
1829         BufferParams const & bufparams = buffer().params();
1830         current_font = par.getFontSettings(bufparams, cpos);
1831         real_current_font = tm.displayFont(cpit, cpos);
1832
1833         // special case for paragraph end
1834         if (cs.pos() == lastpos()
1835             && tm.isRTLBoundary(cpit, cs.pos())
1836             && !boundary()) {
1837                 Language const * lang = par.getParLanguage(bufparams);
1838                 current_font.setLanguage(lang);
1839                 current_font.fontInfo().setNumber(FONT_OFF);
1840                 real_current_font.setLanguage(lang);
1841                 real_current_font.fontInfo().setNumber(FONT_OFF);
1842         }
1843 }
1844
1845
1846 bool Cursor::textUndo()
1847 {
1848         DocIterator dit = *this;
1849         // Undo::textUndo() will modify dit.
1850         if (!bv_->buffer().undo().textUndo(dit))
1851                 return false;
1852         // Set cursor
1853         setCursor(dit);
1854         selection() = false;
1855         resetAnchor();
1856         fixIfBroken();
1857         return true;
1858 }
1859
1860
1861 bool Cursor::textRedo()
1862 {
1863         DocIterator dit = *this;
1864         // Undo::textRedo() will modify dit.
1865         if (!bv_->buffer().undo().textRedo(dit))
1866                 return false;
1867         // Set cursor
1868         setCursor(dit);
1869         selection() = false;
1870         resetAnchor();
1871         fixIfBroken();
1872         return true;
1873 }
1874
1875
1876 void Cursor::finishUndo()
1877 {
1878         bv_->buffer().undo().finishUndo();
1879 }
1880
1881
1882 void Cursor::recordUndo(UndoKind kind, pit_type from, pit_type to)
1883 {
1884         bv_->buffer().undo().recordUndo(*this, kind, from, to);
1885 }
1886
1887
1888 void Cursor::recordUndo(UndoKind kind, pit_type from)
1889 {
1890         bv_->buffer().undo().recordUndo(*this, kind, from);
1891 }
1892
1893
1894 void Cursor::recordUndo(UndoKind kind)
1895 {
1896         bv_->buffer().undo().recordUndo(*this, kind);
1897 }
1898
1899
1900 void Cursor::recordUndoInset(UndoKind kind)
1901 {
1902         bv_->buffer().undo().recordUndoInset(*this, kind);
1903 }
1904
1905
1906 void Cursor::recordUndoFullDocument()
1907 {
1908         bv_->buffer().undo().recordUndoFullDocument(*this);
1909 }
1910
1911
1912 void Cursor::recordUndoSelection()
1913 {
1914         bv_->buffer().undo().recordUndo(*this, ATOMIC_UNDO,
1915                 selBegin().pit(), selEnd().pit());
1916 }
1917
1918
1919 void Cursor::checkBufferStructure()
1920 {
1921         if (paragraph().layout()->toclevel == Layout::NOT_IN_TOC)
1922                 return;
1923         Buffer const * master = buffer().masterBuffer();
1924         master->tocBackend().updateItem(ParConstIterator(*this));
1925         master->structureChanged();
1926 }
1927
1928
1929 } // namespace lyx