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 (size_t i = 0; ; ++i) {
100 InsetBase const * inset = &it.inset();
101 Point o = theCoords.getInsets().xy(inset);
102 inset->cursorPos(it.top(), c.boundary(), xo, yo);
103 // Convert to absolute
106 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
107 // '<=' in order to take the last possible position
108 // this is important for clicking behind \sum in e.g. '\sum_i a'
109 lyxerr[Debug::DEBUG] << "i: " << i << " d: " << d
110 << " best: " << best_dist << endl;
111 if (d <= best_dist) {
123 /// moves position closest to (x, y) in given box
124 bool bruteFind(LCursor & cursor,
125 int x, int y, int xlow, int xhigh, int ylow, int yhigh)
127 BOOST_ASSERT(!cursor.empty());
128 InsetBase & inset = cursor[0].inset();
130 DocIterator it = doc_iterator_begin(inset);
131 DocIterator const et = doc_iterator_end(inset);
133 double best_dist = std::numeric_limits<double>::max();;
134 DocIterator best_cursor = et;
136 for ( ; it != et; it.forwardPos(true)) {
137 // avoid invalid nesting when selecting
138 if (bv_funcs::status(&cursor.bv(), it) == bv_funcs::CUR_INSIDE
139 && (!cursor.selection() || positionable(it, cursor.anchor_))) {
140 Point p = bv_funcs::getPos(it, false);
143 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
144 double const dx = xo - x;
145 double const dy = yo - y;
146 double const d = dx * dx + dy * dy;
147 // '<=' in order to take the last possible position
148 // this is important for clicking behind \sum in e.g. '\sum_i a'
149 if (d <= best_dist) {
150 lyxerr << "*" << endl;
158 if (best_cursor != et) {
159 cursor.setCursor(best_cursor);
167 /// moves position closest to (x, y) in given box
168 bool bruteFind3(LCursor & cur, int x, int y, bool up)
170 BufferView & bv = cur.bv();
171 int ylow = up ? 0 : y + 1;
172 int yhigh = up ? y - 1 : bv.workHeight();
174 int xhigh = bv.workWidth();
176 // FIXME: bit more work needed to get 'from' and 'to' right.
177 pit_type from = cur.bottom().pit();
178 //pit_type to = cur.bottom().pit();
179 //lyxerr << "Pit start: " << from << endl;
181 //lyxerr << "bruteFind3: x: " << x << " y: " << y
182 // << " xlow: " << xlow << " xhigh: " << xhigh
183 // << " ylow: " << ylow << " yhigh: " << yhigh
185 InsetBase & inset = bv.buffer()->inset();
186 DocIterator it = doc_iterator_begin(inset);
188 DocIterator et = doc_iterator_end(inset);
190 double best_dist = std::numeric_limits<double>::max();
191 DocIterator best_cursor = et;
193 for ( ; it != et; it.forwardPos()) {
194 // avoid invalid nesting when selecting
195 if (bv_funcs::status(&bv, it) == bv_funcs::CUR_INSIDE
196 && (!cur.selection() || positionable(it, cur.anchor_))) {
197 Point p = bv_funcs::getPos(it, false);
200 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
201 double const dx = xo - x;
202 double const dy = yo - y;
203 double const d = dx * dx + dy * dy;
204 //lyxerr << "itx: " << xo << " ity: " << yo << " d: " << d
205 // << " dx: " << dx << " dy: " << dy
206 // << " idx: " << it.idx() << " pos: " << it.pos()
209 // '<=' in order to take the last possible position
210 // this is important for clicking behind \sum in e.g. '\sum_i a'
211 if (d <= best_dist) {
212 //lyxerr << "*" << endl;
220 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
221 if (best_cursor == et)
223 cur.setCursor(best_cursor);
230 // be careful: this is called from the bv's constructor, too, so
231 // bv functions are not yet available!
232 LCursor::LCursor(BufferView & bv)
233 : DocIterator(), bv_(&bv), anchor_(), x_target_(-1),
234 selection_(false), mark_(false), logicalpos_(false)
238 void LCursor::reset(InsetBase & inset)
241 push_back(CursorSlice(inset));
242 anchor_ = DocIterator(inset);
249 // this (intentionally) does neither touch anchor nor selection status
250 void LCursor::setCursor(DocIterator const & cur)
252 DocIterator::operator=(cur);
256 void LCursor::dispatch(FuncRequest const & cmd0)
258 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
259 << " cmd: " << cmd0 << '\n'
265 FuncRequest cmd = cmd0;
266 LCursor safe = *this;
268 for (; depth(); pop()) {
269 lyxerr[Debug::DEBUG] << "LCursor::dispatch: cmd: "
270 << cmd0 << endl << *this << endl;
271 BOOST_ASSERT(pos() <= lastpos());
272 BOOST_ASSERT(idx() <= lastidx());
273 BOOST_ASSERT(pit() <= lastpit());
275 // The common case is 'LFUN handled, need update', so make the
276 // LFUN handler's life easier by assuming this as default value.
277 // The handler can reset the update and val flags if necessary.
279 disp_.dispatched(true);
280 inset().dispatch(*this, cmd);
281 if (disp_.dispatched())
284 // it completely to get a 'bomb early' behaviour in case this
285 // object will be used again.
286 if (!disp_.dispatched()) {
287 lyxerr[Debug::DEBUG] << "RESTORING OLD CURSOR!" << endl;
289 disp_.dispatched(false);
294 DispatchResult LCursor::result() const
300 BufferView & LCursor::bv() const
307 Buffer & LCursor::buffer() const
310 BOOST_ASSERT(bv_->buffer());
311 return *bv_->buffer();
317 BOOST_ASSERT(depth() >= 1);
322 void LCursor::push(InsetBase & p)
324 push_back(CursorSlice(p));
328 void LCursor::pushLeft(InsetBase & p)
330 BOOST_ASSERT(!empty());
331 //lyxerr << "Entering inset " << t << " left" << endl;
337 bool LCursor::popLeft()
339 BOOST_ASSERT(!empty());
340 //lyxerr << "Leaving inset to the left" << endl;
341 inset().notifyCursorLeaves(*this);
349 bool LCursor::popRight()
351 BOOST_ASSERT(!empty());
352 //lyxerr << "Leaving inset to the right" << endl;
353 inset().notifyCursorLeaves(*this);
362 int LCursor::currentMode()
364 BOOST_ASSERT(!empty());
365 for (int i = depth() - 1; i >= 0; --i) {
366 int res = operator[](i).inset().currentMode();
367 if (res != InsetBase::UNDECIDED_MODE)
370 return InsetBase::TEXT_MODE;
374 void LCursor::getPos(int & x, int & y) const
376 Point p = bv_funcs::getPos(*this, boundary());
382 // Don't use this routine. It is erroneous: LFUN_PASTE should be called with
383 // buffer number, not data to be inserted -- MV 26.02.2006
384 void LCursor::paste(string const & data)
387 dispatch(FuncRequest(LFUN_PASTE, data));
391 void LCursor::resetAnchor()
398 bool LCursor::posLeft()
407 bool LCursor::posRight()
409 if (pos() == lastpos())
416 CursorSlice LCursor::anchor() const
418 BOOST_ASSERT(anchor_.depth() >= depth());
419 CursorSlice normal = anchor_[depth() - 1];
420 if (depth() < anchor_.depth() && top() <= normal) {
421 // anchor is behind cursor -> move anchor behind the inset
428 CursorSlice LCursor::selBegin() const
432 return anchor() < top() ? anchor() : top();
436 CursorSlice LCursor::selEnd() const
440 return anchor() > top() ? anchor() : top();
444 DocIterator LCursor::selectionBegin() const
448 DocIterator di = (anchor() < top() ? anchor_ : *this);
454 DocIterator LCursor::selectionEnd() const
458 DocIterator di = (anchor() > top() ? anchor_ : *this);
459 if (di.depth() > depth()) {
467 void LCursor::setSelection()
470 // A selection with no contents is not a selection
472 #warning doesnt look ok
474 if (pit() == anchor().pit() && pos() == anchor().pos())
479 void LCursor::setSelection(DocIterator const & where, size_t n)
488 void LCursor::clearSelection()
497 int & LCursor::x_target()
503 int LCursor::x_target() const
509 void LCursor::clearTargetX()
516 void LCursor::info(std::ostream & os) const
518 for (int i = 1, n = depth(); i < n; ++i) {
519 operator[](i).inset().infoize(os);
523 prevInset()->infoize2(os);
524 // overwite old message
529 void LCursor::selHandle(bool sel)
531 //lyxerr << "LCursor::selHandle" << endl;
532 if (sel == selection())
540 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
542 os << "\n cursor: | anchor:\n";
543 for (size_t i = 0, n = cur.depth(); i != n; ++i) {
544 os << " " << cur[i] << " | ";
545 if (i < cur.anchor_.depth())
546 os << cur.anchor_[i];
548 os << "-------------------------------";
551 for (size_t i = cur.depth(), n = cur.anchor_.depth(); i < n; ++i) {
552 os << "------------------------------- | " << cur.anchor_[i] << "\n";
554 os << " selection: " << cur.selection_
555 << " x_target: " << cur.x_target_ << endl;
562 ///////////////////////////////////////////////////////////////////
564 // The part below is the non-integrated rest of the original math
565 // cursor. This should be either generalized for texted or moved
566 // back to mathed (in most cases to MathNestInset).
568 ///////////////////////////////////////////////////////////////////
570 #include "mathed/math_charinset.h"
571 #include "mathed/math_factory.h"
572 #include "mathed/math_gridinset.h"
573 #include "mathed/math_macroarg.h"
574 #include "mathed/math_mathmlstream.h"
575 #include "mathed/math_scriptinset.h"
576 #include "mathed/math_support.h"
577 #include "mathed/math_unknowninset.h"
579 //#define FILEDEBUG 1
582 bool LCursor::isInside(InsetBase const * p)
584 for (size_t i = 0; i != depth(); ++i)
585 if (&operator[](i).inset() == p)
591 void LCursor::leaveInset(InsetBase const & inset)
593 for (size_t i = 0; i != depth(); ++i) {
594 if (&operator[](i).inset() == &inset) {
602 bool LCursor::openable(MathAtom const & t) const
613 // we can't move into anything new during selection
614 if (depth() >= anchor_.depth())
616 if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
623 void LCursor::setScreenPos(int x, int y)
626 bruteFind(*this, x, y, 0, bv().workWidth(), 0, bv().workHeight());
631 void LCursor::plainErase()
637 void LCursor::markInsert()
643 void LCursor::markErase()
649 void LCursor::plainInsert(MathAtom const & t)
651 cell().insert(pos(), t);
656 void LCursor::insert(string const & str)
658 for_each(str.begin(), str.end(),
659 boost::bind(static_cast<void(LCursor::*)(char)>
660 (&LCursor::insert), this, _1));
664 void LCursor::insert(char c)
666 //lyxerr << "LCursor::insert char '" << c << "'" << endl;
667 BOOST_ASSERT(!empty());
669 lyx::cap::selClearOrDel(*this);
670 insert(new MathCharInset(c));
672 text()->insertChar(*this, c);
677 void LCursor::insert(MathAtom const & t)
679 //lyxerr << "LCursor::insert MathAtom '" << t << "'" << endl;
681 lyx::cap::selClearOrDel(*this);
686 void LCursor::insert(InsetBase * inset)
689 insert(MathAtom(inset));
691 text()->insertInset(*this, inset);
695 void LCursor::niceInsert(string const & t)
706 void LCursor::niceInsert(MathAtom const & t)
709 string const safe = lyx::cap::grabAndEraseSelection(*this);
711 // enter the new inset and move the contents of the selection if possible
714 // be careful here: don't use 'pushLeft(t)' as this we need to
715 // push the clone, not the original
716 pushLeft(*nextInset());
717 // We may not use niceInsert here (recursion)
725 void LCursor::insert(MathArray const & ar)
729 lyx::cap::eraseSelection(*this);
730 cell().insert(pos(), ar);
735 bool LCursor::backspace()
737 autocorrect() = false;
740 lyx::cap::selDel(*this);
745 if (inset().nargs() == 1 && depth() == 1 && lastpos() == 0)
752 MathUnknownInset * p = activeMacro();
753 if (p->name().size() > 1) {
754 p->setName(p->name().substr(0, p->name().size() - 1));
759 if (pos() != 0 && prevAtom()->nargs() > 0) {
760 // let's require two backspaces for 'big stuff' and
761 // highlight on the first
773 bool LCursor::erase()
775 autocorrect() = false;
780 lyx::cap::selDel(*this);
784 // delete empty cells if possible
785 if (pos() == lastpos() && inset().idxDelete(idx()))
788 // special behaviour when in last position of cell
789 if (pos() == lastpos()) {
790 bool one_cell = inset().nargs() == 1;
791 if (one_cell && depth() == 1 && lastpos() == 0)
797 inset().idxGlue(idx());
801 // 'clever' UI hack: only erase large items if previously slected
802 if (pos() != lastpos() && nextAtom()->nargs() > 0) {
817 DocIterator save = *this;
821 autocorrect() = false;
829 DocIterator save = *this;
833 autocorrect() = false;
838 bool LCursor::macroModeClose()
842 MathUnknownInset * p = activeMacro();
844 string const s = p->name();
848 // do nothing if the macro name is empty
852 // prevent entering of recursive macros
853 // FIXME: this is only a weak attempt... only prevents immediate
855 string const name = s.substr(1);
856 InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
857 if (macro && macro->getInsetName() == name)
858 lyxerr << "can't enter recursive macro" << endl;
860 plainInsert(createMathInset(name));
865 string LCursor::macroName()
867 return inMacroMode() ? activeMacro()->name() : string();
871 void LCursor::handleNest(MathAtom const & a, int c)
873 //lyxerr << "LCursor::handleNest: " << c << endl;
875 asArray(lyx::cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
878 pushLeft(*nextInset());
882 int LCursor::targetX() const
884 if (x_target() != -1)
893 void LCursor::setTargetX()
895 // For now this is good enough. A better solution would be to
896 // avoid this rebreak by setting cursorX only after drawing
897 bottom().text()->redoParagraph(bottom().pit());
905 bool LCursor::inMacroMode() const
909 MathUnknownInset const * p = prevAtom()->asUnknownInset();
910 return p && !p->final();
914 MathUnknownInset * LCursor::activeMacro()
916 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
920 void LCursor::pullArg()
925 MathArray ar = cell();
926 if (popLeft() && inMathed()) {
928 cell().insert(pos(), ar);
931 //formula()->mutateToText();
936 void LCursor::touch()
942 DocIterator::const_iterator it = begin();
943 DocIterator::const_iterator et = end();
944 for ( ; it != et; ++it)
950 void LCursor::normalize()
952 if (idx() > lastidx()) {
953 lyxerr << "this should not really happen - 1: "
954 << idx() << ' ' << nargs()
955 << " in: " << &inset() << endl;
959 if (pos() > lastpos()) {
960 lyxerr << "this should not really happen - 2: "
961 << pos() << ' ' << lastpos() << " in idx: " << idx()
963 WriteStream wi(lyxerr, false, true);
964 inset().asMathInset()->write(wi);
971 bool LCursor::goUpDown(bool up)
973 // Be warned: The 'logic' implemented in this function is highly
974 // fragile. A distance of one pixel or a '<' vs '<=' _really
975 // matters. So fiddle around with it only if you think you know
976 // what you are doing!
982 // check if we had something else in mind, if not, this is the future goal
983 if (x_target() == -1)
988 // try neigbouring script insets
992 MathScriptInset const * p = prevAtom()->asScriptInset();
993 if (p && p->has(up)) {
995 push(*const_cast<MathScriptInset*>(p));
996 idx() = p->idxOfScript(up);
1003 if (pos() != lastpos()) {
1004 MathScriptInset const * p = nextAtom()->asScriptInset();
1005 if (p && p->has(up)) {
1006 push(*const_cast<MathScriptInset*>(p));
1007 idx() = p->idxOfScript(up);
1014 // FIXME: Switch this on for more robust movement
1017 return bruteFind3(*this, xo, yo, up);
1020 //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
1025 //if (bruteFind(*this, xo, yo, xlow, xhigh, ylow, yhigh)) {
1026 // lyxerr << "updown: handled by brute find in the same cell" << endl;
1030 // try to find an inset that knows better then we
1032 //lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
1034 if (inset().idxUpDown(*this, up)) {
1035 //lyxerr << "idxUpDown triggered" << endl;
1036 // try to find best position within this inset
1038 setCursor(bruteFind2(*this, xo, yo));
1042 // no such inset found, just take something "above"
1044 //lyxerr << "updown: popleft failed (strange case)" << endl;
1045 int ylow = up ? 0 : yo + 1;
1046 int yhigh = up ? yo - 1 : bv().workHeight();
1047 return bruteFind(*this, xo, yo, 0, bv().workWidth(), ylow, yhigh);
1050 // any improvement so far?
1051 //lyxerr << "updown: popLeft succeeded" << endl;
1055 if (up ? ynew < yo : ynew > yo)
1059 // we should not come here.
1060 BOOST_ASSERT(false);
1065 void LCursor::handleFont(string const & font)
1067 lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << ": " << font << endl;
1071 safe = lyx::cap::grabAndEraseSelection(*this);
1074 if (lastpos() != 0) {
1075 // something left in the cell
1077 // cursor in first position
1079 } else if (pos() == lastpos()) {
1080 // cursor in last position
1083 // cursor in between. split cell
1084 MathArray::iterator bt = cell().begin();
1085 MathAtom at = createMathInset(font);
1086 at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1087 cell().erase(bt, bt + pos());
1092 // nothing left in the cell
1100 void LCursor::message(string const & msg) const
1102 bv().owner()->getLyXFunc().setMessage(msg);
1106 void LCursor::errorMessage(string const & msg) const
1108 bv().owner()->getLyXFunc().setErrorMessage(msg);
1112 string LCursor::selectionAsString(bool label) const
1118 Buffer const & buffer = *bv().buffer();
1119 ParagraphList const & pars = text()->paragraphs();
1121 // should be const ...
1122 pit_type startpit = selBegin().pit();
1123 pit_type endpit = selEnd().pit();
1124 size_t const startpos = selBegin().pos();
1125 size_t const endpos = selEnd().pos();
1127 if (startpit == endpit)
1128 return pars[startpit].asString(buffer, startpos, endpos, label);
1130 // First paragraph in selection
1131 string result = pars[startpit].
1132 asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1134 // The paragraphs in between (if any)
1135 for (pit_type pit = startpit + 1; pit != endpit; ++pit) {
1136 Paragraph const & par = pars[pit];
1137 result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1140 // Last paragraph in selection
1141 result += pars[endpit].asString(buffer, 0, endpos, label);
1147 return lyx::cap::grabSelection(*this);
1153 string LCursor::currentState()
1156 std::ostringstream os;
1162 return text()->currentState(*this);
1168 string LCursor::getPossibleLabel()
1170 return inMathed() ? "eq:" : text()->getPossibleLabel(*this);
1174 Encoding const * LCursor::getEncoding() const
1181 // go up until first non-0 text is hit
1182 // (innermost text is 0 in mathed)
1183 for (s = depth() - 1; s >= 0; --s)
1184 if (operator[](s).text())
1186 CursorSlice const & sl = operator[](s);
1187 LyXText const & text = *sl.text();
1188 LyXFont font = text.getPar(sl.pit()).getFont(
1189 bv().buffer()->params(), sl.pos(), outerFont(sl.pit(), text.paragraphs()));
1190 return font.language()->encoding();
1194 void LCursor::undispatched()
1196 disp_.dispatched(false);
1200 void LCursor::dispatched()
1202 disp_.dispatched(true);
1206 void LCursor::needsUpdate()
1212 void LCursor::noUpdate()
1214 disp_.update(false);
1218 LyXFont LCursor::getFont() const
1220 // HACK. far from being perfect...
1222 // go up until first non-0 text is hit
1223 // (innermost text is 0 in mathed)
1224 for (s = depth() - 1; s >= 0; --s)
1225 if (operator[](s).text())
1227 CursorSlice const & sl = operator[](s);
1228 LyXText const & text = *sl.text();
1229 LyXFont font = text.getPar(sl.pit()).getFont(
1230 bv().buffer()->params(),
1232 outerFont(sl.pit(), text.paragraphs()));
1238 void LCursor::fixIfBroken()
1240 // find out last good level
1241 LCursor copy = *this;
1242 size_t newdepth = depth();
1243 while (!copy.empty()) {
1244 if (copy.idx() > copy.lastidx()) {
1245 lyxerr << "wrong idx " << copy.idx()
1246 << ", max is " << copy.lastidx()
1247 << " at level " << copy.depth()
1248 << ". Trying to correct this." << endl;
1249 newdepth = copy.depth() - 1;
1251 else if (copy.pit() > copy.lastpit()) {
1252 lyxerr << "wrong pit " << copy.pit()
1253 << ", max is " << copy.lastpit()
1254 << " at level " << copy.depth()
1255 << ". Trying to correct this." << endl;
1256 newdepth = copy.depth() - 1;
1258 else if (copy.pos() > copy.lastpos()) {
1259 lyxerr << "wrong pos " << copy.pos()
1260 << ", max is " << copy.lastpos()
1261 << " at level " << copy.depth()
1262 << ". Trying to correct this." << endl;
1263 newdepth = copy.depth() - 1;
1267 // shrink cursor to a size where everything is valid, possibly
1269 while (depth() > newdepth) {
1271 lyxerr << "correcting cursor to level " << depth() << endl;