]> git.lyx.org Git - lyx.git/blob - src/cursor.C
Don't test twice for selection()
[lyx.git] / src / cursor.C
1 /**
2  * \file cursor.C
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  *
10  * Full author contact details are available in file CREDITS.
11  */
12
13 #include <config.h>
14
15 #include "BufferView.h"
16 #include "bufferview_funcs.h"
17 #include "buffer.h"
18 #include "cursor.h"
19 #include "coordcache.h"
20 #include "CutAndPaste.h"
21 #include "debug.h"
22 #include "dispatchresult.h"
23 #include "encoding.h"
24 #include "funcrequest.h"
25 #include "language.h"
26 #include "lfuns.h"
27 #include "lyxfont.h"
28 #include "lyxfunc.h" // only for setMessage()
29 #include "lyxrc.h"
30 #include "lyxrow.h"
31 #include "lyxtext.h"
32 #include "paragraph.h"
33 #include "paragraph_funcs.h"
34 #include "pariterator.h"
35
36 #include "insets/insettabular.h"
37 #include "insets/insettext.h"
38
39 #include "mathed/MathData.h"
40 #include "mathed/InsetMath.h"
41 #include "mathed/InsetMathScript.h"
42 #include "mathed/MathMacroTable.h"
43
44 #include "support/limited_stack.h"
45
46 #include <boost/assert.hpp>
47 #include <boost/bind.hpp>
48 #include <boost/current_function.hpp>
49
50 #include <sstream>
51 #include <limits>
52 #include <map>
53
54 namespace lyx {
55
56 using std::string;
57 using std::vector;
58 using std::endl;
59 #ifndef CXX_GLOBAL_CSTD
60 using std::isalpha;
61 #endif
62 using std::min;
63 using std::for_each;
64
65 namespace {
66
67         bool
68         positionable(DocIterator const & cursor, DocIterator const & anchor)
69         {
70                 // avoid deeper nested insets when selecting
71                 if (cursor.depth() > anchor.depth())
72                         return false;
73
74                 // anchor might be deeper, should have same path then
75                 for (size_t i = 0; i < cursor.depth(); ++i)
76                         if (&cursor[i].inset() != &anchor[i].inset())
77                                 return false;
78
79                 // position should be ok.
80                 return true;
81         }
82
83
84         // Find position closest to (x, y) in cell given by iter.
85         // Used only in mathed
86         DocIterator bruteFind2(LCursor const & c, int x, int y)
87         {
88                 double best_dist = std::numeric_limits<double>::max();
89
90                 DocIterator result;
91
92                 DocIterator it = c;
93                 it.top().pos() = 0;
94                 DocIterator et = c;
95                 et.top().pos() = et.top().asInsetMath()->cell(et.top().idx()).size();
96                 for (size_t i = 0; ; ++i) {
97                         int xo;
98                         int yo;
99                         InsetBase const * inset = &it.inset();
100                         std::map<InsetBase const *, Point> const & data =
101                                 c.bv().coordCache().getInsets().getData();
102                         std::map<InsetBase const *, Point>::const_iterator I = data.find(inset);
103
104                         // FIXME: in the case where the inset is not in the cache, this
105                         // means that no part of it is visible on screen. In this case
106                         // we don't do elaborate search and we just return the forwarded
107                         // DocIterator at its beginning.
108                         if (I == data.end()) {
109                                 it.top().pos() = 0;
110                                 return it;
111                         }
112
113                         Point o = I->second;
114                         inset->cursorPos(c.bv(), it.top(), c.boundary(), xo, yo);
115                         // Convert to absolute
116                         xo += o.x_;
117                         yo += o.y_;
118                         double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
119                         // '<=' in order to take the last possible position
120                         // this is important for clicking behind \sum in e.g. '\sum_i a'
121                         lyxerr[Debug::DEBUG] << "i: " << i << " d: " << d
122                                 << " best: " << best_dist << endl;
123                         if (d <= best_dist) {
124                                 best_dist = d;
125                                 result = it;
126                         }
127                         if (it == et)
128                                 break;
129                         it.forwardPos();
130                 }
131                 return result;
132         }
133
134
135         /// moves position closest to (x, y) in given box
136         bool bruteFind(LCursor & cursor,
137                 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
138         {
139                 BOOST_ASSERT(!cursor.empty());
140                 InsetBase & inset = cursor[0].inset();
141                 BufferView & bv = cursor.bv();
142
143                 CoordCache::InnerParPosCache const & cache =
144                         bv.coordCache().getParPos().find(cursor.bottom().text())->second;
145                 // Get an iterator on the first paragraph in the cache
146                 DocIterator it(inset);
147                 it.push_back(CursorSlice(inset));
148                 it.pit() = cache.begin()->first;
149                 // Get an iterator after the last paragraph in the cache
150                 DocIterator et(inset);
151                 et.push_back(CursorSlice(inset));
152                 et.pit() = boost::prior(cache.end())->first;
153                 if (et.pit() >= et.lastpit())
154                         et = doc_iterator_end(inset);
155                 else
156                         ++et.pit();
157
158                 double best_dist = std::numeric_limits<double>::max();;
159                 DocIterator best_cursor = et;
160
161                 for ( ; it != et; it.forwardPos(true)) {
162                         // avoid invalid nesting when selecting
163                         if (!cursor.selection() || positionable(it, cursor.anchor_)) {
164                                 Point p = bv_funcs::getPos(bv, it, false);
165                                 int xo = p.x_;
166                                 int yo = p.y_;
167                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
168                                         double const dx = xo - x;
169                                         double const dy = yo - y;
170                                         double const d = dx * dx + dy * dy;
171                                         // '<=' in order to take the last possible position
172                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
173                                         if (d <= best_dist) {
174                                                 //      lyxerr << "*" << endl;
175                                                 best_dist   = d;
176                                                 best_cursor = it;
177                                         }
178                                 }
179                         }
180                 }
181
182                 if (best_cursor != et) {
183                         cursor.setCursor(best_cursor);
184                         return true;
185                 }
186
187                 return false;
188         }
189
190
191         /// moves position closest to (x, y) in given box
192         bool bruteFind3(LCursor & cur, int x, int y, bool up)
193         {
194                 BufferView & bv = cur.bv();
195                 int ylow  = up ? 0 : y + 1;
196                 int yhigh = up ? y - 1 : bv.workHeight();
197                 int xlow = 0;
198                 int xhigh = bv.workWidth();
199
200 // FIXME: bit more work needed to get 'from' and 'to' right.
201                 pit_type from = cur.bottom().pit();
202                 //pit_type to = cur.bottom().pit();
203                 //lyxerr << "Pit start: " << from << endl;
204
205                 //lyxerr << "bruteFind3: x: " << x << " y: " << y
206                 //      << " xlow: " << xlow << " xhigh: " << xhigh
207                 //      << " ylow: " << ylow << " yhigh: " << yhigh
208                 //      << endl;
209                 InsetBase & inset = bv.buffer()->inset();
210                 DocIterator it = doc_iterator_begin(inset);
211                 it.pit() = from;
212                 DocIterator et = doc_iterator_end(inset);
213
214                 double best_dist = std::numeric_limits<double>::max();
215                 DocIterator best_cursor = et;
216
217                 for ( ; it != et; it.forwardPos()) {
218                         // avoid invalid nesting when selecting
219                         if (bv_funcs::status(&bv, it) == bv_funcs::CUR_INSIDE
220                             && (!cur.selection() || positionable(it, cur.anchor_))) {
221                                 Point p = bv_funcs::getPos(bv, it, false);
222                                 int xo = p.x_;
223                                 int yo = p.y_;
224                                 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
225                                         double const dx = xo - x;
226                                         double const dy = yo - y;
227                                         double const d = dx * dx + dy * dy;
228                                         //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
229                                         //      << " dx: " << dx << " dy: " << dy
230                                         //      << " idx: " << it.idx() << " pos: " << it.pos()
231                                         //      << " it:\n" << it
232                                         //      << endl;
233                                         // '<=' in order to take the last possible position
234                                         // this is important for clicking behind \sum in e.g. '\sum_i a'
235                                         if (d <= best_dist) {
236                                                 //lyxerr << "*" << endl;
237                                                 best_dist   = d;
238                                                 best_cursor = it;
239                                         }
240                                 }
241                         }
242                 }
243
244                 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
245                 if (best_cursor == et)
246                         return false;
247                 cur.setCursor(best_cursor);
248                 return true;
249         }
250
251 } // namespace anon
252
253
254 // be careful: this is called from the bv's constructor, too, so
255 // bv functions are not yet available!
256 LCursor::LCursor(BufferView & bv)
257         : DocIterator(), bv_(&bv), anchor_(), x_target_(-1),
258           selection_(false), mark_(false), logicalpos_(false)
259 {}
260
261
262 void LCursor::reset(InsetBase & inset)
263 {
264         clear();
265         push_back(CursorSlice(inset));
266         anchor_ = DocIterator(inset);
267         clearTargetX();
268         selection_ = false;
269         mark_ = false;
270 }
271
272
273 // this (intentionally) does neither touch anchor nor selection status
274 void LCursor::setCursor(DocIterator const & cur)
275 {
276         DocIterator::operator=(cur);
277 }
278
279
280 void LCursor::dispatch(FuncRequest const & cmd0)
281 {
282         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
283                              << " cmd: " << cmd0 << '\n'
284                              << *this << endl;
285         if (empty())
286                 return;
287
288         fixIfBroken();
289         FuncRequest cmd = cmd0;
290         LCursor safe = *this;
291
292         for (; depth(); pop()) {
293                 lyxerr[Debug::DEBUG] << "LCursor::dispatch: cmd: "
294                         << cmd0 << endl << *this << endl;
295                 BOOST_ASSERT(pos() <= lastpos());
296                 BOOST_ASSERT(idx() <= lastidx());
297                 BOOST_ASSERT(pit() <= lastpit());
298
299                 // The common case is 'LFUN handled, need update', so make the
300                 // LFUN handler's life easier by assuming this as default value.
301                 // The handler can reset the update and val flags if necessary.
302                 disp_.update(Update::FitCursor | Update::Force);
303                 disp_.dispatched(true);
304                 inset().dispatch(*this, cmd);
305                 if (disp_.dispatched())
306                         break;
307         }
308         // it completely to get a 'bomb early' behaviour in case this
309         // object will be used again.
310         if (!disp_.dispatched()) {
311                 lyxerr[Debug::DEBUG] << "RESTORING OLD CURSOR!" << endl;
312                 operator=(safe);
313                 disp_.update(Update::None);
314                 disp_.dispatched(false);
315         }
316 }
317
318
319 DispatchResult LCursor::result() const
320 {
321         return disp_;
322 }
323
324
325 BufferView & LCursor::bv() const
326 {
327         BOOST_ASSERT(bv_);
328         return *bv_;
329 }
330
331
332 Buffer & LCursor::buffer() const
333 {
334         BOOST_ASSERT(bv_);
335         BOOST_ASSERT(bv_->buffer());
336         return *bv_->buffer();
337 }
338
339
340 void LCursor::pop()
341 {
342         BOOST_ASSERT(depth() >= 1);
343         pop_back();
344 }
345
346
347 void LCursor::push(InsetBase & p)
348 {
349         push_back(CursorSlice(p));
350 }
351
352
353 void LCursor::pushLeft(InsetBase & p)
354 {
355         BOOST_ASSERT(!empty());
356         //lyxerr << "Entering inset " << t << " left" << endl;
357         push(p);
358         p.idxFirst(*this);
359 }
360
361
362 bool LCursor::popLeft()
363 {
364         BOOST_ASSERT(!empty());
365         //lyxerr << "Leaving inset to the left" << endl;
366         inset().notifyCursorLeaves(*this);
367         if (depth() == 1)
368                 return false;
369         pop();
370         return true;
371 }
372
373
374 bool LCursor::popRight()
375 {
376         BOOST_ASSERT(!empty());
377         //lyxerr << "Leaving inset to the right" << endl;
378         const pos_type lp = (depth() > 1) ? (*this)[depth() - 2].lastpos() : 0;
379         inset().notifyCursorLeaves(*this);
380         if (depth() == 1)
381                 return false;
382         pop();
383         pos() += lastpos() - lp + 1;
384         return true;
385 }
386
387
388 int LCursor::currentMode()
389 {
390         BOOST_ASSERT(!empty());
391         for (int i = depth() - 1; i >= 0; --i) {
392                 int res = operator[](i).inset().currentMode();
393                 if (res != InsetBase::UNDECIDED_MODE)
394                         return res;
395         }
396         return InsetBase::TEXT_MODE;
397 }
398
399
400 void LCursor::getPos(int & x, int & y) const
401 {
402         Point p = bv_funcs::getPos(bv(), *this, boundary());
403         x = p.x_;
404         y = p.y_;
405 }
406
407
408 Row const & LCursor::textRow() const
409 {
410         ParagraphMetrics const & pm = bv().parMetrics(text(), pit());
411         BOOST_ASSERT(!pm.rows().empty());
412         return pm.getRow(pos(), boundary());
413 }
414
415
416 void LCursor::resetAnchor()
417 {
418         anchor_ = *this;
419 }
420
421
422
423 bool LCursor::posLeft()
424 {
425         if (pos() == 0)
426                 return false;
427         --pos();
428         return true;
429 }
430
431
432 bool LCursor::posRight()
433 {
434         if (pos() == lastpos())
435                 return false;
436         ++pos();
437         return true;
438 }
439
440
441 CursorSlice LCursor::anchor() const
442 {
443         BOOST_ASSERT(anchor_.depth() >= depth());
444         CursorSlice normal = anchor_[depth() - 1];
445         if (depth() < anchor_.depth() && top() <= normal) {
446                 // anchor is behind cursor -> move anchor behind the inset
447                 ++normal.pos();
448         }
449         return normal;
450 }
451
452
453 CursorSlice LCursor::selBegin() const
454 {
455         if (!selection())
456                 return top();
457         return anchor() < top() ? anchor() : top();
458 }
459
460
461 CursorSlice LCursor::selEnd() const
462 {
463         if (!selection())
464                 return top();
465         return anchor() > top() ? anchor() : top();
466 }
467
468
469 DocIterator LCursor::selectionBegin() const
470 {
471         if (!selection())
472                 return *this;
473         DocIterator di = (anchor() < top() ? anchor_ : *this);
474         di.resize(depth());
475         return di;
476 }
477
478
479 DocIterator LCursor::selectionEnd() const
480 {
481         if (!selection())
482                 return *this;
483         DocIterator di = (anchor() > top() ? anchor_ : *this);
484         if (di.depth() > depth()) {
485                 di.resize(depth());
486                 ++di.pos();
487         }
488         return di;
489 }
490
491
492 void LCursor::setSelection()
493 {
494         selection() = true;
495         // A selection with no contents is not a selection
496 #ifdef WITH_WARNINGS
497 #warning doesnt look ok
498 #endif
499         if (pit() == anchor().pit() && pos() == anchor().pos())
500                 selection() = false;
501 }
502
503
504 void LCursor::setSelection(DocIterator const & where, int n)
505 {
506         setCursor(where);
507         selection() = true;
508         anchor_ = where;
509         pos() += n;
510 }
511
512
513 void LCursor::clearSelection()
514 {
515         selection() = false;
516         mark() = false;
517         resetAnchor();
518 }
519
520
521 int & LCursor::x_target()
522 {
523         return x_target_;
524 }
525
526
527 int LCursor::x_target() const
528 {
529         return x_target_;
530 }
531
532
533 void LCursor::clearTargetX()
534 {
535         x_target_ = -1;
536 }
537
538
539
540 void LCursor::info(odocstream & os) const
541 {
542         for (int i = 1, n = depth(); i < n; ++i) {
543                 operator[](i).inset().infoize(os);
544                 os << "  ";
545         }
546         if (pos() != 0)
547                 prevInset()->infoize2(os);
548         // overwite old message
549         os << "                    ";
550 }
551
552
553 bool LCursor::selHandle(bool sel)
554 {
555         //lyxerr << "LCursor::selHandle" << endl;
556         if (sel == selection())
557                 return false;
558
559         resetAnchor();
560         selection() = sel;
561         return true;
562 }
563
564
565 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
566 {
567         os << "\n cursor:                                | anchor:\n";
568         for (size_t i = 0, n = cur.depth(); i != n; ++i) {
569                 os << " " << cur[i] << " | ";
570                 if (i < cur.anchor_.depth())
571                         os << cur.anchor_[i];
572                 else
573                         os << "-------------------------------";
574                 os << "\n";
575         }
576         for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
577                 os << "------------------------------- | " << cur.anchor_[i] << "\n";
578         }
579         os << " selection: " << cur.selection_
580            << " x_target: " << cur.x_target_ << endl;
581         return os;
582 }
583
584 } // namespace lyx
585
586
587 ///////////////////////////////////////////////////////////////////
588 //
589 // The part below is the non-integrated rest of the original math
590 // cursor. This should be either generalized for texted or moved
591 // back to mathed (in most cases to InsetMathNest).
592 //
593 ///////////////////////////////////////////////////////////////////
594
595 #include "mathed/InsetMathChar.h"
596 #include "mathed/InsetMathGrid.h"
597 #include "mathed/InsetMathScript.h"
598 #include "mathed/InsetMathUnknown.h"
599 #include "mathed/MathFactory.h"
600 #include "mathed/MathMacroArgument.h"
601 #include "mathed/MathStream.h"
602 #include "mathed/MathSupport.h"
603
604
605 namespace lyx {
606
607 //#define FILEDEBUG 1
608
609
610 bool LCursor::isInside(InsetBase const * p)
611 {
612         for (size_t i = 0; i != depth(); ++i)
613                 if (&operator[](i).inset() == p)
614                         return true;
615         return false;
616 }
617
618
619 void LCursor::leaveInset(InsetBase const & inset)
620 {
621         for (size_t i = 0; i != depth(); ++i) {
622                 if (&operator[](i).inset() == &inset) {
623                         resize(i);
624                         return;
625                 }
626         }
627 }
628
629
630 bool LCursor::openable(MathAtom const & t) const
631 {
632         if (!t->isActive())
633                 return false;
634
635         if (t->lock())
636                 return false;
637
638         if (!selection())
639                 return true;
640
641         // we can't move into anything new during selection
642         if (depth() >= anchor_.depth())
643                 return false;
644         if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
645                 return false;
646
647         return true;
648 }
649
650
651 void LCursor::setScreenPos(int x, int y)
652 {
653         x_target() = x;
654         bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
655 }
656
657
658
659 void LCursor::plainErase()
660 {
661         cell().erase(pos());
662 }
663
664
665 void LCursor::markInsert()
666 {
667         insert(char_type(0));
668 }
669
670
671 void LCursor::markErase()
672 {
673         cell().erase(pos());
674 }
675
676
677 void LCursor::plainInsert(MathAtom const & t)
678 {
679         cell().insert(pos(), t);
680         ++pos();
681 }
682
683
684 void LCursor::insert(docstring const & str)
685 {
686         for_each(str.begin(), str.end(),
687                  boost::bind(static_cast<void(LCursor::*)(char_type)>
688                              (&LCursor::insert), this, _1));
689 }
690
691
692 void LCursor::insert(char_type c)
693 {
694         //lyxerr << "LCursor::insert char '" << c << "'" << endl;
695         BOOST_ASSERT(!empty());
696         if (inMathed()) {
697                 cap::selClearOrDel(*this);
698                 insert(new InsetMathChar(c));
699         } else {
700                 text()->insertChar(*this, c);
701         }
702 }
703
704
705 void LCursor::insert(MathAtom const & t)
706 {
707         //lyxerr << "LCursor::insert MathAtom '" << t << "'" << endl;
708         macroModeClose();
709         cap::selClearOrDel(*this);
710         plainInsert(t);
711 }
712
713
714 void LCursor::insert(InsetBase * inset)
715 {
716         if (inMathed())
717                 insert(MathAtom(inset));
718         else
719                 text()->insertInset(*this, inset);
720 }
721
722
723 void LCursor::niceInsert(docstring const & t)
724 {
725         MathArray ar;
726         asArray(t, ar);
727         if (ar.size() == 1)
728                 niceInsert(ar[0]);
729         else
730                 insert(ar);
731 }
732
733
734 void LCursor::niceInsert(MathAtom const & t)
735 {
736         macroModeClose();
737         docstring const safe = cap::grabAndEraseSelection(*this);
738         plainInsert(t);
739         // enter the new inset and move the contents of the selection if possible
740         if (t->isActive()) {
741                 posLeft();
742                 // be careful here: don't use 'pushLeft(t)' as this we need to
743                 // push the clone, not the original
744                 pushLeft(*nextInset());
745                 // We may not use niceInsert here (recursion)
746                 MathArray ar;
747                 asArray(safe, ar);
748                 insert(ar);
749         }
750 }
751
752
753 void LCursor::insert(MathArray const & ar)
754 {
755         macroModeClose();
756         if (selection())
757                 cap::eraseSelection(*this);
758         cell().insert(pos(), ar);
759         pos() += ar.size();
760 }
761
762
763 bool LCursor::backspace()
764 {
765         autocorrect() = false;
766
767         if (selection()) {
768                 cap::eraseSelection(*this);
769                 return true;
770         }
771
772         if (pos() == 0) {
773                 // If empty cell, and not part of a big cell
774                 if (lastpos() == 0 && inset().nargs() == 1) {
775                         popLeft();
776                         // Directly delete empty cell: [|[]] => [|] 
777                         if (inMathed()) {
778                                 plainErase();
779                                 resetAnchor();
780                                 return true;
781                         }
782                         // [|], can not delete from inside
783                         return false;
784                 } else {
785                         // move to left
786                         popLeft();
787                         return true;
788                 }
789         }
790
791         if (inMacroMode()) {
792                 InsetMathUnknown * p = activeMacro();
793                 if (p->name().size() > 1) {
794                         p->setName(p->name().substr(0, p->name().size() - 1));
795                         return true;
796                 }
797         }
798
799         if (pos() != 0 && prevAtom()->nargs() > 0) {
800                 // let's require two backspaces for 'big stuff' and
801                 // highlight on the first
802                 resetAnchor();
803                 selection() = true;
804                 --pos();
805         } else {
806                 --pos();
807                 plainErase();
808         }
809         return true;
810 }
811
812
813 bool LCursor::erase()
814 {
815         autocorrect() = false;
816         if (inMacroMode())
817                 return true;
818
819         if (selection()) {
820                 cap::eraseSelection(*this);
821                 return true;
822         }
823
824         // delete empty cells if possible
825         if (pos() == lastpos() && inset().idxDelete(idx()))
826                 return true;
827
828         // special behaviour when in last position of cell
829         if (pos() == lastpos()) {
830                 bool one_cell = inset().nargs() == 1;
831                 if (one_cell && lastpos() == 0) {
832                         popLeft();
833                         // Directly delete empty cell: [|[]] => [|] 
834                         if (inMathed()) {
835                                 plainErase();
836                                 resetAnchor();
837                                 return true;
838                         }
839                         // [|], can not delete from inside
840                         return false;
841                 }
842                 // remove markup
843                 if (!one_cell)
844                         inset().idxGlue(idx());
845                 return true;
846         }
847
848         // 'clever' UI hack: only erase large items if previously slected
849         if (pos() != lastpos() && nextAtom()->nargs() > 0) {
850                 resetAnchor();
851                 selection() = true;
852                 ++pos();
853         } else {
854                 plainErase();
855         }
856
857         return true;
858 }
859
860
861 bool LCursor::up()
862 {
863         macroModeClose();
864         DocIterator save = *this;
865         if (goUpDown(true))
866                 return true;
867         setCursor(save);
868         autocorrect() = false;
869         return selection();
870 }
871
872
873 bool LCursor::down()
874 {
875         macroModeClose();
876         DocIterator save = *this;
877         if (goUpDown(false))
878                 return true;
879         setCursor(save);
880         autocorrect() = false;
881         return selection();
882 }
883
884
885 bool LCursor::macroModeClose()
886 {
887         if (!inMacroMode())
888                 return false;
889         InsetMathUnknown * p = activeMacro();
890         p->finalize();
891         docstring const s = p->name();
892         --pos();
893         cell().erase(pos());
894
895         // do nothing if the macro name is empty
896         if (s == "\\")
897                 return false;
898
899         // prevent entering of recursive macros
900         // FIXME: this is only a weak attempt... only prevents immediate
901         // recursion
902         docstring const name = s.substr(1);
903         InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
904         if (macro && macro->getInsetName() == name)
905                 lyxerr << "can't enter recursive macro" << endl;
906
907         InsetMathNest * const in = inset().asInsetMath()->asNestInset();
908         if (in && in->interpretString(*this, s))
909                 return true;
910         plainInsert(createInsetMath(name));
911         return true;
912 }
913
914
915 docstring LCursor::macroName()
916 {
917         return inMacroMode() ? activeMacro()->name() : docstring();
918 }
919
920
921 void LCursor::handleNest(MathAtom const & a, int c)
922 {
923         //lyxerr << "LCursor::handleNest: " << c << endl;
924         MathAtom t = a;
925         asArray(cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
926         insert(t);
927         posLeft();
928         pushLeft(*nextInset());
929 }
930
931
932 int LCursor::targetX() const
933 {
934         if (x_target() != -1)
935                 return x_target();
936         int x = 0;
937         int y = 0;
938         getPos(x, y);
939         return x;
940 }
941
942
943 void LCursor::setTargetX()
944 {
945         int x;
946         int y;
947         getPos(x, y);
948         x_target_ = x;
949 }
950
951
952 bool LCursor::inMacroMode() const
953 {
954         if (pos() == 0)
955                 return false;
956         InsetMathUnknown const * p = prevAtom()->asUnknownInset();
957         return p && !p->final();
958 }
959
960
961 InsetMathUnknown * LCursor::activeMacro()
962 {
963         return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
964 }
965
966
967 void LCursor::pullArg()
968 {
969 #ifdef WITH_WARNINGS
970 #warning Look here
971 #endif
972         MathArray ar = cell();
973         if (popLeft() && inMathed()) {
974                 plainErase();
975                 cell().insert(pos(), ar);
976                 resetAnchor();
977         } else {
978                 //formula()->mutateToText();
979         }
980 }
981
982
983 void LCursor::touch()
984 {
985 #ifdef WITH_WARNINGS
986 #warning look here
987 #endif
988 #if 0
989         DocIterator::const_iterator it = begin();
990         DocIterator::const_iterator et = end();
991         for ( ; it != et; ++it)
992                 it->cell().touch();
993 #endif
994 }
995
996
997 void LCursor::normalize()
998 {
999         if (idx() > lastidx()) {
1000                 lyxerr << "this should not really happen - 1: "
1001                        << idx() << ' ' << nargs()
1002                        << " in: " << &inset() << endl;
1003                 idx() = lastidx();
1004         }
1005
1006         if (pos() > lastpos()) {
1007                 lyxerr << "this should not really happen - 2: "
1008                         << pos() << ' ' << lastpos() <<  " in idx: " << idx()
1009                        << " in atom: '";
1010                 odocstringstream os;
1011                 WriteStream wi(os, false, true);
1012                 inset().asInsetMath()->write(wi);
1013                 lyxerr << to_utf8(os.str()) << endl;
1014                 pos() = lastpos();
1015         }
1016 }
1017
1018
1019 bool LCursor::goUpDown(bool up)
1020 {
1021         // Be warned: The 'logic' implemented in this function is highly
1022         // fragile. A distance of one pixel or a '<' vs '<=' _really
1023         // matters. So fiddle around with it only if you think you know
1024         // what you are doing!
1025
1026         int xo = 0;
1027         int yo = 0;
1028         getPos(xo, yo);
1029
1030         // check if we had something else in mind, if not, this is the future
1031         // target
1032         if (x_target() == -1)
1033                 x_target() = xo;
1034         else
1035                 xo = x_target();
1036
1037         // try neigbouring script insets
1038         if (!selection()) {
1039                 // try left
1040                 if (pos() != 0) {
1041                         InsetMathScript const * p = prevAtom()->asScriptInset();
1042                         if (p && p->has(up)) {
1043                                 --pos();
1044                                 push(*const_cast<InsetMathScript*>(p));
1045                                 idx() = p->idxOfScript(up);
1046                                 pos() = lastpos();
1047                                 return true;
1048                         }
1049                 }
1050
1051                 // try right
1052                 if (pos() != lastpos()) {
1053                         InsetMathScript const * p = nextAtom()->asScriptInset();
1054                         if (p && p->has(up)) {
1055                                 push(*const_cast<InsetMathScript*>(p));
1056                                 idx() = p->idxOfScript(up);
1057                                 pos() = 0;
1058                                 return true;
1059                         }
1060                 }
1061         }
1062
1063 // FIXME: Switch this on for more robust movement
1064 #if 0
1065
1066         return bruteFind3(*this, xo, yo, up);
1067
1068 #else
1069         //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
1070         //if (up)
1071         //      yhigh = yo - 4;
1072         //else
1073         //      ylow = yo + 4;
1074         //if (bruteFind(*this, xo, yo, xlow, xhigh, ylow, yhigh)) {
1075         //      lyxerr << "updown: handled by brute find in the same cell" << endl;
1076         //      return true;
1077         //}
1078
1079         // try to find an inset that knows better then we
1080         while (true) {
1081                 //lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
1082                 // ask inset first
1083                 if (inset().idxUpDown(*this, up)) {
1084                         //lyxerr << "idxUpDown triggered" << endl;
1085                         // try to find best position within this inset
1086                         if (!selection())
1087                                 setCursor(bruteFind2(*this, xo, yo));
1088                         return true;
1089                 }
1090
1091                 // no such inset found, just take something "above"
1092                 if (!popLeft()) {
1093                         //lyxerr << "updown: popleft failed (strange case)" << endl;
1094                         int ylow  = up ? 0 : yo + 1;
1095                         int yhigh = up ? yo - 1 : bv().workHeight();
1096                         return bruteFind(*this, xo, yo, 0, bv().workWidth(), ylow, yhigh);
1097                 }
1098
1099                 // any improvement so far?
1100                 //lyxerr << "updown: popLeft succeeded" << endl;
1101                 int xnew;
1102                 int ynew;
1103                 getPos(xnew, ynew);
1104                 if (up ? ynew < yo : ynew > yo)
1105                         return true;
1106         }
1107
1108         // we should not come here.
1109         BOOST_ASSERT(false);
1110 #endif
1111 }
1112
1113
1114 void LCursor::handleFont(string const & font)
1115 {
1116         lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << ": " << font << endl;
1117         docstring safe;
1118         if (selection()) {
1119                 macroModeClose();
1120                 safe = cap::grabAndEraseSelection(*this);
1121         }
1122
1123         if (lastpos() != 0) {
1124                 // something left in the cell
1125                 if (pos() == 0) {
1126                         // cursor in first position
1127                         popLeft();
1128                 } else if (pos() == lastpos()) {
1129                         // cursor in last position
1130                         popRight();
1131                 } else {
1132                         // cursor in between. split cell
1133                         MathArray::iterator bt = cell().begin();
1134                         MathAtom at = createInsetMath(from_utf8(font));
1135                         at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1136                         cell().erase(bt, bt + pos());
1137                         popLeft();
1138                         plainInsert(at);
1139                 }
1140         } else {
1141                 // nothing left in the cell
1142                 pullArg();
1143                 plainErase();
1144         }
1145         insert(safe);
1146 }
1147
1148
1149 void LCursor::message(docstring const & msg) const
1150 {
1151         theLyXFunc().setMessage(msg);
1152 }
1153
1154
1155 void LCursor::errorMessage(docstring const & msg) const
1156 {
1157         theLyXFunc().setErrorMessage(msg);
1158 }
1159
1160
1161 docstring LCursor::selectionAsString(bool label) const
1162 {
1163         if (!selection())
1164                 return docstring();
1165
1166         if (inTexted()) {
1167                 Buffer const & buffer = *bv().buffer();
1168                 ParagraphList const & pars = text()->paragraphs();
1169
1170                 // should be const ...
1171                 pit_type startpit = selBegin().pit();
1172                 pit_type endpit = selEnd().pit();
1173                 size_t const startpos = selBegin().pos();
1174                 size_t const endpos = selEnd().pos();
1175
1176                 if (startpit == endpit)
1177                         return pars[startpit].asString(buffer, startpos, endpos, label);
1178
1179                 // First paragraph in selection
1180                 docstring result = pars[startpit].
1181                         asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1182
1183                 // The paragraphs in between (if any)
1184                 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1185                         Paragraph const & par = pars[pit];
1186                         result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1187                 }
1188
1189                 // Last paragraph in selection
1190                 result += pars[endpit].asString(buffer, 0, endpos, label);
1191
1192                 return result;
1193         }
1194
1195         if (inMathed())
1196                 return cap::grabSelection(*this);
1197
1198         return docstring();
1199 }
1200
1201
1202 docstring LCursor::currentState()
1203 {
1204         if (inMathed()) {
1205                 odocstringstream os;
1206                 info(os);
1207                 return os.str();
1208         }
1209
1210         if (inTexted())
1211                 return text()->currentState(*this);
1212
1213         return docstring();
1214 }
1215
1216
1217 docstring LCursor::getPossibleLabel()
1218 {
1219         return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
1220 }
1221
1222
1223 Encoding const * LCursor::getEncoding() const
1224 {
1225         if (empty())
1226                 return 0;
1227         if (!bv().buffer())
1228                 return 0;
1229         int s = 0;
1230         // go up until first non-0 text is hit
1231         // (innermost text is 0 in mathed)
1232         for (s = depth() - 1; s >= 0; --s)
1233                 if (operator[](s).text())
1234                         break;
1235         CursorSlice const & sl = operator[](s);
1236         LyXText const & text = *sl.text();
1237         LyXFont font = text.getPar(sl.pit()).getFont(
1238                 bv().buffer()->params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1239         return font.language()->encoding();
1240 }
1241
1242
1243 void LCursor::undispatched()
1244 {
1245         disp_.dispatched(false);
1246 }
1247
1248
1249 void LCursor::dispatched()
1250 {
1251         disp_.dispatched(true);
1252 }
1253
1254
1255 void LCursor::updateFlags(Update::flags f)
1256 {
1257         disp_.update(f);
1258 }
1259
1260
1261 void LCursor::noUpdate()
1262 {
1263         disp_.update(Update::None);
1264 }
1265
1266
1267 LyXFont LCursor::getFont() const
1268 {
1269         // HACK. far from being perfect...
1270         int s = 0;
1271         // go up until first non-0 text is hit
1272         // (innermost text is 0 in mathed)
1273         for (s = depth() - 1; s >= 0; --s)
1274                 if (operator[](s).text())
1275                         break;
1276         CursorSlice const & sl = operator[](s);
1277         LyXText const & text = *sl.text();
1278         LyXFont font = text.getPar(sl.pit()).getFont(
1279                 bv().buffer()->params(),
1280                 sl.pos(),
1281                 outerFont(sl.pit(), text.paragraphs()));
1282
1283         return font;
1284 }
1285
1286
1287 void LCursor::fixIfBroken()
1288 {
1289         // find out last good level
1290         LCursor copy = *this;
1291         size_t newdepth = depth();
1292         while (!copy.empty()) {
1293                 if (copy.idx() > copy.lastidx()) {
1294                         lyxerr << "wrong idx " << copy.idx()
1295                                << ", max is " << copy.lastidx()
1296                                << " at level " << copy.depth()
1297                                << ". Trying to correct this."  << endl;
1298                         newdepth = copy.depth() - 1;
1299                 }
1300                 else if (copy.pit() > copy.lastpit()) {
1301                         lyxerr << "wrong pit " << copy.pit()
1302                                << ", max is " << copy.lastpit()
1303                                << " at level " << copy.depth()
1304                                << ". Trying to correct this."  << endl;
1305                         newdepth = copy.depth() - 1;
1306                 }
1307                 else if (copy.pos() > copy.lastpos()) {
1308                         lyxerr << "wrong pos " << copy.pos()
1309                                << ", max is " << copy.lastpos()
1310                                << " at level " << copy.depth()
1311                                << ". Trying to correct this."  << endl;
1312                         newdepth = copy.depth() - 1;
1313                 }
1314                 copy.pop();
1315         }
1316         // shrink cursor to a size where everything is valid, possibly
1317         // leaving insets
1318         while (depth() > newdepth) {
1319                 pop();
1320                 lyxerr << "correcting cursor to level " << depth() << endl;
1321         }
1322 }
1323
1324
1325 } // namespace lyx