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