3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Alejandro Aguilar Sierra
7 * \author Alfredo Braunstein
10 * Full author contact details are available in file CREDITS.
15 #include "BufferView.h"
18 #include "coordcache.h"
19 #include "CutAndPaste.h"
21 #include "dispatchresult.h"
23 #include "funcrequest.h"
27 #include "lyxfunc.h" // only for setMessage()
31 #include "paragraph.h"
32 #include "paragraph_funcs.h"
33 #include "pariterator.h"
35 #include "insets/insettabular.h"
36 #include "insets/insettext.h"
38 #include "mathed/math_data.h"
39 #include "mathed/math_inset.h"
40 #include "mathed/math_scriptinset.h"
41 #include "mathed/math_macrotable.h"
43 #include "support/limited_stack.h"
45 #include "frontends/LyXView.h"
46 #include "frontends/font_metrics.h"
48 #include <boost/assert.hpp>
49 #include <boost/bind.hpp>
50 #include <boost/current_function.hpp>
60 #ifndef CXX_GLOBAL_CSTD
69 positionable(DocIterator const & cursor, DocIterator const & anchor)
71 // avoid deeper nested insets when selecting
72 if (cursor.depth() > anchor.depth())
75 // anchor might be deeper, should have same path then
76 for (size_t i = 0; i < cursor.depth(); ++i)
77 if (&cursor[i].inset() != &anchor[i].inset())
80 // position should be ok.
85 // Find position closest to (x, y) in cell given by iter.
86 // Used only in mathed
87 DocIterator bruteFind2(LCursor const & c, int x, int y)
89 double best_dist = std::numeric_limits<double>::max();
96 et.top().pos() = et.top().asMathInset()->cell(et.top().idx()).size();
97 for (int i = 0; ; ++i) {
100 it.inset().cursorPos(it.top(), c.boundary() && ((i+1) == it.depth()), xo, yo);
101 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
102 // '<=' in order to take the last possible position
103 // this is important for clicking behind \sum in e.g. '\sum_i a'
104 lyxerr[Debug::DEBUG] << "i: " << i << " d: " << d
105 << " best: " << best_dist << endl;
106 if (d <= best_dist) {
118 /// moves position closest to (x, y) in given box
119 bool bruteFind(LCursor & cursor,
120 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
122 BOOST_ASSERT(!cursor.empty());
123 InsetBase & inset = cursor[0].inset();
125 DocIterator it = doc_iterator_begin(inset);
126 DocIterator const et = doc_iterator_end(inset);
128 double best_dist = std::numeric_limits<double>::max();;
129 DocIterator best_cursor = et;
131 for ( ; it != et; it.forwardPos()) {
132 // avoid invalid nesting when selecting
133 if (bv_funcs::status(&cursor.bv(), it) == bv_funcs::CUR_INSIDE
134 && (!cursor.selection() || positionable(it, cursor.anchor_))) {
135 Point p = bv_funcs::getPos(it, false);
138 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
139 double const dx = xo - x;
140 double const dy = yo - y;
141 double const d = dx * dx + dy * dy;
142 // '<=' in order to take the last possible position
143 // this is important for clicking behind \sum in e.g. '\sum_i a'
144 if (d <= best_dist) {
145 lyxerr << "*" << endl;
153 if (best_cursor != et) {
154 cursor.setCursor(best_cursor);
162 /// moves position closest to (x, y) in given box
163 bool bruteFind3(LCursor & cur, int x, int y, bool up)
165 BufferView & bv = cur.bv();
166 int ylow = up ? 0 : y + 1;
167 int yhigh = up ? y - 1 : bv.workHeight();
169 int xhigh = bv.workWidth();
171 // FIXME: bit more work needed to get 'from' and 'to' right.
172 pit_type from = cur.bottom().pit();
173 pit_type to = cur.bottom().pit();
174 //lyxerr << "Pit start: " << from << endl;
176 //lyxerr << "bruteFind3: x: " << x << " y: " << y
177 // << " xlow: " << xlow << " xhigh: " << xhigh
178 // << " ylow: " << ylow << " yhigh: " << yhigh
180 InsetBase & inset = bv.buffer()->inset();
181 DocIterator it = doc_iterator_begin(inset);
183 DocIterator et = doc_iterator_end(inset);
185 double best_dist = std::numeric_limits<double>::max();
186 DocIterator best_cursor = et;
188 for ( ; it != et; it.forwardPos()) {
189 // avoid invalid nesting when selecting
190 if (bv_funcs::status(&bv, it) == bv_funcs::CUR_INSIDE
191 && (!cur.selection() || positionable(it, cur.anchor_))) {
192 Point p = bv_funcs::getPos(it, false);
195 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
196 double const dx = xo - x;
197 double const dy = yo - y;
198 double const d = dx * dx + dy * dy;
199 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
200 // << " dx: " << dx << " dy: " << dy
201 // << " idx: " << it.idx() << " pos: " << it.pos()
204 // '<=' in order to take the last possible position
205 // this is important for clicking behind \sum in e.g. '\sum_i a'
206 if (d <= best_dist) {
207 //lyxerr << "*" << endl;
215 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
216 if (best_cursor == et)
218 cur.setCursor(best_cursor);
225 // be careful: this is called from the bv's constructor, too, so
226 // bv functions are not yet available!
227 LCursor::LCursor(BufferView & bv)
228 : DocIterator(), bv_(&bv), anchor_(), x_target_(-1),
229 selection_(false), mark_(false), logicalpos_(false)
233 void LCursor::reset(InsetBase & inset)
236 push_back(CursorSlice(inset));
237 anchor_ = DocIterator(inset);
244 // this (intentionally) does neither touch anchor nor selection status
245 void LCursor::setCursor(DocIterator const & cur)
247 DocIterator::operator=(cur);
251 void LCursor::dispatch(FuncRequest const & cmd0)
253 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
254 << " cmd: " << cmd0 << '\n'
260 FuncRequest cmd = cmd0;
261 LCursor safe = *this;
263 for (; depth(); pop()) {
264 lyxerr[Debug::DEBUG] << "LCursor::dispatch: cmd: "
265 << cmd0 << endl << *this << endl;
266 BOOST_ASSERT(pos() <= lastpos());
267 BOOST_ASSERT(idx() <= lastidx());
268 BOOST_ASSERT(pit() <= lastpit());
270 // The common case is 'LFUN handled, need update', so make the
271 // LFUN handler's life easier by assuming this as default value.
272 // The handler can reset the update and val flags if necessary.
274 disp_.dispatched(true);
275 inset().dispatch(*this, cmd);
276 if (disp_.dispatched())
279 // it completely to get a 'bomb early' behaviour in case this
280 // object will be used again.
281 if (!disp_.dispatched()) {
282 lyxerr[Debug::DEBUG] << "RESTORING OLD CURSOR!" << endl;
284 disp_.dispatched(false);
289 DispatchResult LCursor::result() const
295 BufferView & LCursor::bv() const
302 Buffer & LCursor::buffer() const
305 BOOST_ASSERT(bv_->buffer());
306 return *bv_->buffer();
312 BOOST_ASSERT(depth() >= 1);
317 void LCursor::push(InsetBase & p)
319 push_back(CursorSlice(p));
323 void LCursor::pushLeft(InsetBase & p)
325 BOOST_ASSERT(!empty());
326 //lyxerr << "Entering inset " << t << " left" << endl;
332 bool LCursor::popLeft()
334 BOOST_ASSERT(!empty());
335 //lyxerr << "Leaving inset to the left" << endl;
336 inset().notifyCursorLeaves(*this);
344 bool LCursor::popRight()
346 BOOST_ASSERT(!empty());
347 //lyxerr << "Leaving inset to the right" << endl;
348 inset().notifyCursorLeaves(*this);
357 int LCursor::currentMode()
359 BOOST_ASSERT(!empty());
360 for (int i = depth() - 1; i >= 0; --i) {
361 int res = operator[](i).inset().currentMode();
362 if (res != InsetBase::UNDECIDED_MODE)
365 return InsetBase::TEXT_MODE;
369 void LCursor::getPos(int & x, int & y) const
371 Point p = bv_funcs::getPos(*this, boundary());
377 void LCursor::paste(string const & data)
379 dispatch(FuncRequest(LFUN_PASTE, data));
383 void LCursor::resetAnchor()
390 bool LCursor::posLeft()
399 bool LCursor::posRight()
401 if (pos() == lastpos())
408 CursorSlice LCursor::anchor() const
410 BOOST_ASSERT(anchor_.depth() >= depth());
411 CursorSlice normal = anchor_[depth() - 1];
412 if (depth() < anchor_.depth() && top() <= normal) {
413 // anchor is behind cursor -> move anchor behind the inset
420 CursorSlice LCursor::selBegin() const
424 return anchor() < top() ? anchor() : top();
428 CursorSlice LCursor::selEnd() const
432 return anchor() > top() ? anchor() : top();
436 DocIterator LCursor::selectionBegin() const
440 return anchor() < top() ? anchor_ : *this;
444 DocIterator LCursor::selectionEnd() const
448 return anchor() > top() ? anchor_ : *this;
452 void LCursor::setSelection()
455 // A selection with no contents is not a selection
457 #warning doesnt look ok
459 if (pit() == anchor().pit() && pos() == anchor().pos())
464 void LCursor::setSelection(DocIterator const & where, size_t n)
470 // Open all collapsed insets
471 for (int i = depth() - 1; i >= 0; --i)
472 operator[](i).inset().setStatus(*this, InsetBase::Open);
476 void LCursor::clearSelection()
485 int & LCursor::x_target()
491 int LCursor::x_target() const
497 void LCursor::clearTargetX()
504 void LCursor::info(std::ostream & os) const
506 for (int i = 1, n = depth(); i < n; ++i) {
507 operator[](i).inset().infoize(os);
511 prevInset()->infoize2(os);
512 // overwite old message
517 void LCursor::selHandle(bool sel)
519 //lyxerr << "LCursor::selHandle" << endl;
520 if (sel == selection())
528 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
530 os << "\n cursor: | anchor:\n";
531 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
532 os << " " << cur[i] << " | ";
533 if (i < cur.anchor_.depth())
534 os << cur.anchor_[i];
536 os << "-------------------------------";
539 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
540 os << "------------------------------- | " << cur.anchor_[i] << "\n";
542 os << " selection: " << cur.selection_
543 << " x_target: " << cur.x_target_ << endl;
550 ///////////////////////////////////////////////////////////////////
552 // The part below is the non-integrated rest of the original math
553 // cursor. This should be either generalized for texted or moved
554 // back to mathed (in most cases to MathNestInset).
556 ///////////////////////////////////////////////////////////////////
558 #include "mathed/math_charinset.h"
559 #include "mathed/math_factory.h"
560 #include "mathed/math_gridinset.h"
561 #include "mathed/math_macroarg.h"
562 #include "mathed/math_mathmlstream.h"
563 #include "mathed/math_scriptinset.h"
564 #include "mathed/math_support.h"
565 #include "mathed/math_unknowninset.h"
567 //#define FILEDEBUG 1
570 bool LCursor::isInside(InsetBase const * p)
572 for (size_t i = 0; i != depth(); ++i)
573 if (&operator[](i).inset() == p)
579 void LCursor::leaveInset(InsetBase const & inset)
581 for (size_t i = 0; i != depth(); ++i) {
582 if (&operator[](i).inset() == &inset) {
590 bool LCursor::openable(MathAtom const & t) const
601 // we can't move into anything new during selection
602 if (depth() >= anchor_.depth())
604 if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
611 void LCursor::setScreenPos(int x, int y)
614 bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
619 void LCursor::plainErase()
625 void LCursor::markInsert()
631 void LCursor::markErase()
637 void LCursor::plainInsert(MathAtom const & t)
639 cell().insert(pos(), t);
644 void LCursor::insert(string const & str)
646 for_each(str.begin(), str.end(),
647 boost::bind(static_cast<void(LCursor::*)(char)>
648 (&LCursor::insert), this, _1));
652 void LCursor::insert(char c)
654 //lyxerr << "LCursor::insert char '" << c << "'" << endl;
655 BOOST_ASSERT(!empty());
657 lyx::cap::selClearOrDel(*this);
658 insert(new MathCharInset(c));
660 text()->insertChar(*this, c);
665 void LCursor::insert(MathAtom const & t)
667 //lyxerr << "LCursor::insert MathAtom '" << t << "'" << endl;
669 lyx::cap::selClearOrDel(*this);
674 void LCursor::insert(InsetBase * inset)
677 insert(MathAtom(inset));
679 text()->insertInset(*this, inset);
683 void LCursor::niceInsert(string const & t)
694 void LCursor::niceInsert(MathAtom const & t)
697 string const safe = lyx::cap::grabAndEraseSelection(*this);
699 // enter the new inset and move the contents of the selection if possible
702 // be careful here: don't use 'pushLeft(t)' as this we need to
703 // push the clone, not the original
704 pushLeft(*nextInset());
710 void LCursor::insert(MathArray const & ar)
714 lyx::cap::eraseSelection(*this);
715 cell().insert(pos(), ar);
720 bool LCursor::backspace()
722 autocorrect() = false;
725 lyx::cap::selDel(*this);
730 if (inset().nargs() == 1 && depth() == 1 && lastpos() == 0)
737 MathUnknownInset * p = activeMacro();
738 if (p->name().size() > 1) {
739 p->setName(p->name().substr(0, p->name().size() - 1));
744 if (pos() != 0 && prevAtom()->nargs() > 0) {
745 // let's require two backspaces for 'big stuff' and
746 // highlight on the first
758 bool LCursor::erase()
760 autocorrect() = false;
765 lyx::cap::selDel(*this);
769 // delete empty cells if possible
770 if (pos() == lastpos() && inset().idxDelete(idx()))
773 // special behaviour when in last position of cell
774 if (pos() == lastpos()) {
775 bool one_cell = inset().nargs() == 1;
776 if (one_cell && depth() == 1 && lastpos() == 0)
782 inset().idxGlue(idx());
786 // 'clever' UI hack: only erase large items if previously slected
787 if (pos() != lastpos() && inset().nargs() > 0) {
802 DocIterator save = *this;
806 autocorrect() = false;
814 DocIterator save = *this;
818 autocorrect() = false;
823 void LCursor::macroModeClose()
827 MathUnknownInset * p = activeMacro();
829 string const s = p->name();
833 // do nothing if the macro name is empty
837 string const name = s.substr(1);
839 // prevent entering of recursive macros
840 // FIXME: this is only a weak attempt... only prevents immediate
842 InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
843 if (macro && macro->getInsetName() == name)
844 lyxerr << "can't enter recursive macro" << endl;
846 plainInsert(createMathInset(name));
850 string LCursor::macroName()
852 return inMacroMode() ? activeMacro()->name() : string();
856 void LCursor::handleNest(MathAtom const & a, int c)
858 //lyxerr << "LCursor::handleNest: " << c << endl;
860 asArray(lyx::cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
863 pushLeft(*nextInset());
867 int LCursor::targetX() const
869 if (x_target() != -1)
878 void LCursor::setTargetX()
880 // For now this is good enough. A better solution would be to
881 // avoid this rebreak by setting cursorX only after drawing
882 bottom().text()->redoParagraph(bottom().pit());
890 bool LCursor::inMacroMode() const
894 MathUnknownInset const * p = prevAtom()->asUnknownInset();
895 return p && !p->final();
899 MathUnknownInset * LCursor::activeMacro()
901 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
905 void LCursor::pullArg()
910 MathArray ar = cell();
911 if (popLeft() && inMathed()) {
913 cell().insert(pos(), ar);
916 //formula()->mutateToText();
921 void LCursor::touch()
927 DocIterator::const_iterator it = begin();
928 DocIterator::const_iterator et = end();
929 for ( ; it != et; ++it)
935 void LCursor::normalize()
937 if (idx() > lastidx()) {
938 lyxerr << "this should not really happen - 1: "
939 << idx() << ' ' << nargs()
940 << " in: " << &inset() << endl;
944 if (pos() > lastpos()) {
945 lyxerr << "this should not really happen - 2: "
946 << pos() << ' ' << lastpos() << " in idx: " << idx()
948 WriteStream wi(lyxerr, false, true);
949 inset().asMathInset()->write(wi);
956 bool LCursor::goUpDown(bool up)
958 // Be warned: The 'logic' implemented in this function is highly
959 // fragile. A distance of one pixel or a '<' vs '<=' _really
960 // matters. So fiddle around with it only if you think you know
961 // what you are doing!
967 // check if we had something else in mind, if not, this is the future goal
968 if (x_target() == -1)
973 // try neigbouring script insets
977 MathScriptInset const * p = prevAtom()->asScriptInset();
978 if (p && p->has(up)) {
980 push(*const_cast<MathScriptInset*>(p));
981 idx() = p->idxOfScript(up);
988 if (pos() != lastpos()) {
989 MathScriptInset const * p = nextAtom()->asScriptInset();
990 if (p && p->has(up)) {
991 push(*const_cast<MathScriptInset*>(p));
992 idx() = p->idxOfScript(up);
999 // FIXME: Switch this on for more robust movement
1002 return bruteFind3(*this, xo, yo, up);
1005 //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
1010 //if (bruteFind(*this, xo, yo, xlow, xhigh, ylow, yhigh)) {
1011 // lyxerr << "updown: handled by brute find in the same cell" << endl;
1015 // try to find an inset that knows better then we
1017 lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
1019 if (inset().idxUpDown(*this, up)) {
1020 lyxerr << "idxUpDown triggered" << endl;
1021 // try to find best position within this inset
1023 setCursor(bruteFind2(*this, xo, yo));
1027 // no such inset found, just take something "above"
1029 lyxerr << "updown: popleft failed (strange case)" << endl;
1030 int ylow = up ? 0 : yo + 1;
1031 int yhigh = up ? yo - 1 : bv().workHeight();
1032 return bruteFind(*this, xo, yo, 0, bv().workWidth(), ylow, yhigh);
1035 // any improvement so far?
1036 lyxerr << "updown: popLeft succeeded" << endl;
1040 if (up ? ynew < yo : ynew > yo)
1044 // we should not come here.
1045 BOOST_ASSERT(false);
1050 void LCursor::handleFont(string const & font)
1052 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << ": " << font << endl;
1056 safe = lyx::cap::grabAndEraseSelection(*this);
1059 if (lastpos() != 0) {
1060 // something left in the cell
1062 // cursor in first position
1064 } else if (pos() == lastpos()) {
1065 // cursor in last position
1068 // cursor in between. split cell
1069 MathArray::iterator bt = cell().begin();
1070 MathAtom at = createMathInset(font);
1071 at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1072 cell().erase(bt, bt + pos());
1077 // nothing left in the cell
1085 void LCursor::message(string const & msg) const
1087 bv().owner()->getLyXFunc().setMessage(msg);
1091 void LCursor::errorMessage(string const & msg) const
1093 bv().owner()->getLyXFunc().setErrorMessage(msg);
1097 string LCursor::selectionAsString(bool label) const
1103 Buffer const & buffer = *bv().buffer();
1104 ParagraphList const & pars = text()->paragraphs();
1106 // should be const ...
1107 pit_type startpit = selBegin().pit();
1108 pit_type endpit = selEnd().pit();
1109 size_t const startpos = selBegin().pos();
1110 size_t const endpos = selEnd().pos();
1112 if (startpit == endpit)
1113 return pars[startpit].asString(buffer, startpos, endpos, label);
1115 // First paragraph in selection
1116 string result = pars[startpit].
1117 asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1119 // The paragraphs in between (if any)
1120 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1121 Paragraph const & par = pars[pit];
1122 result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1125 // Last paragraph in selection
1126 result += pars[endpit].asString(buffer, 0, endpos, label);
1131 #ifdef WITH_WARNINGS
1132 #warning and mathed?
1138 string LCursor::currentState()
1141 std::ostringstream os;
1147 return text()->currentState(*this);
1153 string LCursor::getPossibleLabel()
1155 return inMathed() ? "eq:" : text()->getPossibleLabel(*this);
1159 Encoding const * LCursor::getEncoding() const
1166 // go up until first non-0 text is hit
1167 // (innermost text is 0 in mathed)
1168 for (s = depth() - 1; s >= 0; --s)
1169 if (operator[](s).text())
1171 CursorSlice const & sl = operator[](s);
1172 LyXText const & text = *sl.text();
1173 LyXFont font = text.getPar(sl.pit()).getFont(
1174 bv().buffer()->params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1175 return font.language()->encoding();
1179 void LCursor::undispatched()
1181 disp_.dispatched(false);
1185 void LCursor::dispatched()
1187 disp_.dispatched(true);
1191 void LCursor::needsUpdate()
1197 void LCursor::noUpdate()
1199 disp_.update(false);
1203 LyXFont LCursor::getFont() const
1205 // HACK. far from being perfect...
1207 // go up until first non-0 text is hit
1208 // (innermost text is 0 in mathed)
1209 for (s = depth() - 1; s >= 0; --s)
1210 if (operator[](s).text())
1212 CursorSlice const & sl = operator[](s);
1213 LyXText const & text = *sl.text();
1214 LyXFont font = text.getPar(sl.pit()).getFont(
1215 bv().buffer()->params(),
1217 outerFont(sl.pit(), text.paragraphs()));
1223 void LCursor::fixIfBroken()
1225 // find out last good level
1226 LCursor copy = *this;
1227 size_t newdepth = depth();
1228 while (!copy.empty()) {
1229 if (copy.idx() > copy.lastidx()) {
1230 lyxerr << "wrong idx " << copy.idx()
1231 << ", max is " << copy.lastidx()
1232 << " at level " << copy.depth()
1233 << ". Trying to correct this." << endl;
1234 newdepth = copy.depth() - 1;
1236 else if (copy.pit() > copy.lastpit()) {
1237 lyxerr << "wrong pit " << copy.pit()
1238 << ", max is " << copy.lastpit()
1239 << " at level " << copy.depth()
1240 << ". Trying to correct this." << endl;
1241 newdepth = copy.depth() - 1;
1243 else if (copy.pos() > copy.lastpos()) {
1244 lyxerr << "wrong pos " << copy.pos()
1245 << ", max is " << copy.lastpos()
1246 << " at level " << copy.depth()
1247 << ". Trying to correct this." << endl;
1248 newdepth = copy.depth() - 1;
1252 // shrink cursor to a size where everything is valid, possibly
1254 while (depth() > newdepth) {
1256 lyxerr << "correcting cursor to level " << depth() << endl;