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 "CutAndPaste.h"
20 #include "dispatchresult.h"
22 #include "funcrequest.h"
26 #include "lyxfunc.h" // only for setMessage()
30 #include "paragraph.h"
31 #include "paragraph_funcs.h"
32 #include "pariterator.h"
34 #include "insets/updatableinset.h"
35 #include "insets/insettabular.h"
36 #include "insets/insettext.h"
38 #include "mathed/math_data.h"
39 #include "mathed/math_support.h"
40 #include "mathed/math_inset.h"
42 #include "support/limited_stack.h"
43 #include "support/std_sstream.h"
45 #include "frontends/LyXView.h"
47 #include <boost/assert.hpp>
54 #ifndef CXX_GLOBAL_CSTD
63 limited_stack<string> theCutBuffer;
68 void region(CursorSlice const & i1, CursorSlice const & i2,
69 LCursor::row_type & r1, LCursor::row_type & r2,
70 LCursor::col_type & c1, LCursor::col_type & c2)
72 InsetBase & p = i1.inset();
86 LCursor::LCursor(BufferView & bv)
87 : DocIterator(), bv_(&bv),
88 anchor_(), cached_y_(0), x_target_(-1),
89 selection_(false), mark_(false)
93 void LCursor::reset(InsetBase & inset)
96 push_back(CursorSlice(inset));
97 anchor_ = DocIterator(inset);
105 void LCursor::setCursor(DocIterator const & cur, bool sel)
107 // this (intentionally) does not touch the anchor
108 DocIterator::operator=(cur);
113 DispatchResult LCursor::dispatch(FuncRequest const & cmd0)
115 lyxerr << "\nLCursor::dispatch: cmd: " << cmd0 << endl << *this << endl;
117 return DispatchResult();
119 FuncRequest cmd = cmd0;
120 LCursor safe = *this;
122 for ( ; size(); pop()) {
123 //lyxerr << "\nLCursor::dispatch: cmd: " << cmd0 << endl << *this << endl;
124 BOOST_ASSERT(pos() <= lastpos());
125 BOOST_ASSERT(idx() <= lastidx());
126 BOOST_ASSERT(par() <= lastpar());
128 // The common case is 'LFUN handled, need update', so make the
129 // LFUN handler's life easier by assuming this as default value.
130 // The handler can reset the update and val flags if necessary.
132 disp_.dispatched(true);
133 inset().dispatch(*this, cmd);
134 if (disp_.dispatched())
137 // it completely to get a 'bomb early' behaviour in case this
138 // object will be used again.
139 if (!disp_.dispatched()) {
140 lyxerr << "RESTORING OLD CURSOR!" << endl;
147 bool LCursor::getStatus(FuncRequest const & cmd, FuncStatus & status)
149 // This is, of course, a mess. Better create a new doc iterator and use
150 // this in Inset::getStatus. This might require an additional
151 // BufferView * arg, though (which should be avoided)
152 LCursor safe = *this;
154 for ( ; size(); pop()) {
155 //lyxerr << "\nLCursor::getStatus: cmd: " << cmd << endl << *this << endl;
156 BOOST_ASSERT(pos() <= lastpos());
157 BOOST_ASSERT(idx() <= lastidx());
158 BOOST_ASSERT(par() <= lastpar());
160 // The inset's getStatus() will return 'true' if it made
161 // a definitive decision on whether it want to handle the
162 // request or not. The result of this decision is put into
163 // the 'status' parameter.
164 if (inset().getStatus(*this, cmd, status)) {
174 BufferView & LCursor::bv() const
182 BOOST_ASSERT(size() >= 1);
187 void LCursor::push(InsetBase & p)
189 push_back(CursorSlice(p));
193 void LCursor::pushLeft(InsetBase & p)
195 BOOST_ASSERT(!empty());
196 //lyxerr << "Entering inset " << t << " left" << endl;
202 bool LCursor::popLeft()
204 BOOST_ASSERT(!empty());
205 //lyxerr << "Leaving inset to the left" << endl;
206 inset().notifyCursorLeaves(*this);
214 bool LCursor::popRight()
216 BOOST_ASSERT(!empty());
217 //lyxerr << "Leaving inset to the right" << endl;
218 inset().notifyCursorLeaves(*this);
227 int LCursor::currentMode()
229 BOOST_ASSERT(!empty());
230 for (int i = size() - 1; i >= 0; --i) {
231 int res = operator[](i).inset().currentMode();
232 if (res != InsetBase::UNDECIDED_MODE)
235 return InsetBase::TEXT_MODE;
239 void LCursor::updatePos()
241 BOOST_ASSERT(!empty());
243 cached_y_ = bv().top_y() + back().inset().yo();
244 //cached_y_ = back().inset().yo();
248 void LCursor::getDim(int & asc, int & des) const
251 BOOST_ASSERT(inset().asMathInset());
252 //inset().asMathInset()->getCursorDim(asc, des);
255 } else if (inTexted()) {
256 Row const & row = textRow();
257 asc = row.baseline();
258 des = row.height() - asc;
260 lyxerr << "should this happen?" << endl;
267 void LCursor::getPos(int & x, int & y) const
272 inset().getCursorPos(back(), x, y);
273 // getCursorPos gives _screen_ coordinates. We need to add
274 // top_y to get document coordinates. This is hidden in cached_y_.
275 //y += cached_y_ - inset().yo();
276 // The rest is non-obvious. The reason we have to have these
277 // extra computation is that the getCursorPos() calls rely
278 // on the inset's own knowledge of its screen position.
279 // If we scroll up or down in a big enough increment,
280 // inset->draw() is not called: this doesn't update
281 // inset.yo_, so getCursor() returns an old value.
286 void LCursor::paste(string const & data)
288 dispatch(FuncRequest(LFUN_PASTE, data));
292 void LCursor::resetAnchor()
299 bool LCursor::posLeft()
308 bool LCursor::posRight()
310 if (pos() == lastpos())
317 CursorSlice LCursor::anchor() const
319 BOOST_ASSERT(anchor_.size() >= size());
320 CursorSlice normal = anchor_[size() - 1];
321 if (size() < anchor_.size() && back() <= normal) {
322 // anchor is behind cursor -> move anchor behind the inset
329 CursorSlice LCursor::selBegin() const
333 return anchor() < back() ? anchor() : back();
337 CursorSlice LCursor::selEnd() const
341 return anchor() > back() ? anchor() : back();
345 DocIterator LCursor::selectionBegin() const
349 return anchor() < back() ? anchor_ : *this;
353 DocIterator LCursor::selectionEnd() const
357 return anchor() > back() ? anchor_ : *this;
361 void LCursor::setSelection()
364 // a selection with no contents is not a selection
365 #warning doesnt look ok
366 if (par() == anchor().par() && pos() == anchor().pos())
371 void LCursor::setSelection(DocIterator const & where, size_t n)
373 setCursor(where, true);
379 void LCursor::clearSelection()
388 int & LCursor::x_target()
394 int LCursor::x_target() const
400 void LCursor::clearTargetX()
407 void LCursor::info(std::ostream & os) const
409 for (int i = 1, n = depth(); i < n; ++i) {
410 operator[](i).inset().infoize(os);
414 prevInset()->infoize2(os);
415 // overwite old message
420 string LCursor::grabSelection()
425 CursorSlice i1 = selBegin();
426 CursorSlice i2 = selEnd();
428 if (i1.idx() == i2.idx()) {
429 if (i1.inset().asMathInset()) {
430 MathArray::const_iterator it = i1.cell().begin();
431 return asString(MathArray(it + i1.pos(), it + i2.pos()));
433 return "unknown selection 1";
439 region(i1, i2, r1, r2, c1, c2);
442 if (i1.inset().asMathInset()) {
443 for (row_type row = r1; row <= r2; ++row) {
446 for (col_type col = c1; col <= c2; ++col) {
449 data += asString(i1.asMathInset()->cell(i1.asMathInset()->index(row, col)));
453 data = "unknown selection 2";
459 void LCursor::eraseSelection()
461 //lyxerr << "LCursor::eraseSelection" << endl;
462 CursorSlice const & i1 = selBegin();
463 CursorSlice const & i2 = selEnd();
467 if (i1.inset().asMathInset()) {
468 if (i1.idx() == i2.idx()) {
469 i1.cell().erase(i1.pos(), i2.pos());
471 MathInset * p = i1.asMathInset();
474 region(i1, i2, r1, r2, c1, c2);
475 for (row_type row = r1; row <= r2; ++row)
476 for (col_type col = c1; col <= c2; ++col)
477 p->cell(p->index(row, col)).clear();
481 lyxerr << "can't erase this selection 1" << endl;
483 //lyxerr << "LCursor::eraseSelection end" << endl;
487 string LCursor::grabAndEraseSelection()
491 string res = grabSelection();
498 void LCursor::selCopy()
501 theCutBuffer.push(grabSelection());
504 //theCutBuffer.erase();
509 void LCursor::selCut()
511 theCutBuffer.push(grabAndEraseSelection());
515 void LCursor::selDel()
517 //lyxerr << "LCursor::selDel" << endl;
525 void LCursor::selPaste(size_t n)
528 if (n < theCutBuffer.size())
529 paste(theCutBuffer[n]);
535 void LCursor::selHandle(bool sel)
537 //lyxerr << "LCursor::selHandle" << endl;
538 if (sel == selection())
545 void LCursor::selClearOrDel()
547 //lyxerr << "LCursor::selClearOrDel" << endl;
548 if (lyxrc.auto_region_delete)
555 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
557 for (size_t i = 0, n = cur.size(); i != n; ++i) {
558 os << " " << cur.operator[](i) << " | ";
559 if (i < cur.anchor_.size())
560 os << cur.anchor_[i];
562 os << "-------------------------------";
565 for (size_t i = cur.size(), n = cur.anchor_.size(); i < n; ++i) {
566 os << "------------------------------- | " << cur.anchor_[i] << "\n";
568 os << " selection: " << cur.selection_
569 << " x_target: " << cur.x_target_ << endl;
576 ///////////////////////////////////////////////////////////////////
578 // The part below is the non-integrated rest of the original math
579 // cursor. This should be either generalized for texted or moved
580 // back to mathed (in most cases to MathNestInset).
582 ///////////////////////////////////////////////////////////////////
584 #include "mathed/math_charinset.h"
585 #include "mathed/math_factory.h"
586 #include "mathed/math_gridinset.h"
587 #include "mathed/math_macroarg.h"
588 #include "mathed/math_mathmlstream.h"
589 #include "mathed/math_scriptinset.h"
590 #include "mathed/math_support.h"
591 #include "mathed/math_unknowninset.h"
593 //#define FILEDEBUG 1
596 bool LCursor::isInside(InsetBase const * p)
598 for (unsigned i = 0; i < depth(); ++i)
599 if (&operator[](i).inset() == p)
605 bool LCursor::openable(MathAtom const & t) const
616 // we can't move into anything new during selection
617 if (depth() >= anchor_.size())
619 if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
626 bool positionable(DocIterator const & cursor,
627 DocIterator const & anchor)
629 // avoid deeper nested insets when selecting
630 if (cursor.size() > anchor.size())
633 // anchor might be deeper, should have same path then
634 for (size_t i = 0; i < cursor.size(); ++i)
635 if (&cursor[i].inset() != &anchor[i].inset())
638 // position should be ok.
643 void LCursor::setScreenPos(int x, int y)
646 bruteFind(x, y, 0, bv().workWidth(), 0, bv().workHeight());
651 void LCursor::plainErase()
657 void LCursor::markInsert()
663 void LCursor::markErase()
669 void LCursor::plainInsert(MathAtom const & t)
671 cell().insert(pos(), t);
676 void LCursor::insert(string const & str)
678 //lyxerr << "LCursor::insert str '" << str << "'" << endl;
679 for (string::const_iterator it = str.begin(); it != str.end(); ++it)
684 void LCursor::insert(char c)
686 //lyxerr << "LCursor::insert char '" << c << "'" << endl;
687 BOOST_ASSERT(!empty());
690 insert(new MathCharInset(c));
692 text()->insertChar(*this, c);
697 void LCursor::insert(MathAtom const & t)
699 //lyxerr << "LCursor::insert MathAtom: " << endl;
703 lyxerr << "LCursor::insert MathAtom: cur:\n" << *this << endl;
707 void LCursor::insert(InsetBase * inset)
710 insert(MathAtom(inset));
712 text()->insertInset(*this, inset);
716 void LCursor::niceInsert(string const & t)
727 void LCursor::niceInsert(MathAtom const & t)
730 string safe = grabAndEraseSelection();
732 // enter the new inset and move the contents of the selection if possible
735 // be careful here: don't use 'pushLeft(t)' as this we need to
736 // push the clone, not the original
737 pushLeft(*nextInset());
743 void LCursor::insert(MathArray const & ar)
748 cell().insert(pos(), ar);
753 bool LCursor::backspace()
755 autocorrect() = false;
763 if (inset().nargs() == 1 && depth() == 1 && lastpos() == 0)
770 MathUnknownInset * p = activeMacro();
771 if (p->name().size() > 1) {
772 p->setName(p->name().substr(0, p->name().size() - 1));
777 if (pos() != 0 && prevAtom()->nargs() > 0) {
778 // let's require two backspaces for 'big stuff' and
779 // highlight on the first
791 bool LCursor::erase()
793 autocorrect() = false;
802 // delete empty cells if possible
803 if (pos() == lastpos() && inset().idxDelete(idx()))
806 // special behaviour when in last position of cell
807 if (pos() == lastpos()) {
808 bool one_cell = inset().nargs() == 1;
809 if (one_cell && depth() == 1 && lastpos() == 0)
815 inset().idxGlue(idx());
819 // 'clever' UI hack: only erase large items if previously slected
820 if (pos() != lastpos() && inset().nargs() > 0) {
835 DocIterator save = *this;
838 setCursor(save, false);
839 autocorrect() = false;
847 DocIterator save = *this;
850 setCursor(save, false);
851 autocorrect() = false;
856 void LCursor::macroModeClose()
860 MathUnknownInset * p = activeMacro();
862 string s = p->name();
866 // do nothing if the macro name is empty
870 string const name = s.substr(1);
872 // prevent entering of recursive macros
873 InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
874 if (macro && macro->getInsetName() == name)
875 lyxerr << "can't enter recursive macro" << endl;
877 niceInsert(createMathInset(name));
881 string LCursor::macroName()
883 return inMacroMode() ? activeMacro()->name() : string();
887 void LCursor::handleNest(MathAtom const & a, int c)
889 //lyxerr << "LCursor::handleNest: " << c << endl;
891 asArray(grabAndEraseSelection(), t.nucleus()->cell(c));
894 pushLeft(*nextInset());
898 int LCursor::targetX() const
900 if (x_target() != -1)
909 bool LCursor::inMacroMode() const
913 MathUnknownInset const * p = prevAtom()->asUnknownInset();
914 return p && !p->final();
918 MathUnknownInset * LCursor::activeMacro()
920 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
924 void LCursor::pullArg()
929 MathArray ar = cell();
930 if (popLeft() && inMathed()) {
932 cell().insert(pos(), ar);
935 //formula()->mutateToText();
940 void LCursor::touch()
946 DocIterator::const_iterator it = begin();
947 DocIterator::const_iterator et = end();
948 for ( ; it != et; ++it)
954 void LCursor::normalize()
956 if (idx() >= nargs()) {
957 lyxerr << "this should not really happen - 1: "
958 << idx() << ' ' << nargs()
959 << " in: " << &inset() << endl;
961 idx() = min(idx(), lastidx());
963 if (pos() > lastpos()) {
964 lyxerr << "this should not really happen - 2: "
965 << pos() << ' ' << lastpos() << " in idx: " << idx()
967 WriteStream wi(lyxerr, false, true);
968 inset().asMathInset()->write(wi);
971 pos() = min(pos(), lastpos());
975 bool LCursor::goUpDown(bool up)
977 // Be warned: The 'logic' implemented in this function is highly
978 // fragile. A distance of one pixel or a '<' vs '<=' _really
979 // matters. So fiddle around with it only if you think you know
980 // what you are doing!
986 // check if we had something else in mind, if not, this is the future goal
987 if (x_target() == -1)
992 // try neigbouring script insets
996 MathScriptInset const * p = prevAtom()->asScriptInset();
997 if (p && p->has(up)) {
1000 idx() = up; // the superscript has index 1
1002 //lyxerr << "updown: handled by scriptinset to the left" << endl;
1008 if (pos() != lastpos()) {
1009 MathScriptInset const * p = nextAtom()->asScriptInset();
1010 if (p && p->has(up)) {
1014 //lyxerr << "updown: handled by scriptinset to the right" << endl;
1020 // try current cell for e.g. text insets
1021 if (inset().idxUpDown2(*this, up))
1024 //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
1029 //if (bruteFind(xo, yo, xlow, xhigh, ylow, yhigh)) {
1030 // lyxerr << "updown: handled by brute find in the same cell" << endl;
1034 // try to find an inset that knows better then we
1036 //lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
1038 if (inset().idxUpDown(*this, up)) {
1039 // try to find best position within this inset
1045 // no such inset found, just take something "above"
1046 //lyxerr << "updown: handled by strange case" << endl;
1048 int ylow = up ? 0 : yo + 1;
1049 int yhigh = up ? yo - 1 : bv().workHeight();
1050 return bruteFind(xo, yo, 0, bv().workWidth(), ylow, yhigh);
1053 // any improvement so far?
1056 if (up ? ynew < yo : ynew > yo)
1062 bool LCursor::bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh)
1064 BOOST_ASSERT(!empty());
1066 CursorSlice bottom = operator[](0);
1067 LyXText * text = bottom.text();
1069 getParsInRange(text->paragraphs(), ylow, yhigh, beg, end);
1071 DocIterator it = doc_iterator_begin(bv().buffer()->inset());
1072 DocIterator et = doc_iterator_end(bv().buffer()->inset());
1073 //lyxerr << "x: " << x << " y: " << y << endl;
1074 //lyxerr << "xlow: " << xlow << " ylow: " << ylow << endl;
1075 //lyxerr << "xhigh: " << xhigh << " yhigh: " << yhigh << endl;
1078 //et.par() = text->parOffset(end);
1080 double best_dist = 10e10;
1081 DocIterator best_cursor = it;
1083 for ( ; it != et; it.forwardPos()) {
1084 // avoid invalid nesting when selecting
1085 if (!selection() || positionable(it, anchor_)) {
1087 CursorSlice & cur = it.back();
1088 cur.inset().getCursorPos(cur, xo, yo);
1089 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
1090 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
1091 //lyxerr << "xo: " << xo << " yo: " << yo << " d: " << d << endl;
1092 // '<=' in order to take the last possible position
1093 // this is important for clicking behind \sum in e.g. '\sum_i a'
1094 if (d <= best_dist) {
1095 //lyxerr << "*" << endl;
1103 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
1104 if (best_dist < 1e10)
1105 setCursor(best_cursor, false);
1106 return best_dist < 1e10;
1110 void LCursor::bruteFind2(int x, int y)
1112 double best_dist = 1e10;
1114 DocIterator it = *this;
1115 it.back().pos() = 0;
1116 DocIterator et = *this;
1117 et.back().pos() = et.back().asMathInset()->cell(et.back().idx()).size();
1118 for (int i = 0; ; ++i) {
1120 CursorSlice & cur = it.back();
1121 cur.inset().getCursorPos(cur, xo, yo);
1122 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
1123 // '<=' in order to take the last possible position
1124 // this is important for clicking behind \sum in e.g. '\sum_i a'
1125 lyxerr << "i: " << i << " d: " << d << " best: " << best_dist << endl;
1126 if (d <= best_dist) {
1128 setCursor(it, false);
1137 void LCursor::handleFont(string const & font)
1139 lyxerr << "LCursor::handleFont: " << font << endl;
1143 safe = grabAndEraseSelection();
1146 if (lastpos() != 0) {
1147 // something left in the cell
1149 // cursor in first position
1151 } else if (pos() == lastpos()) {
1152 // cursor in last position
1155 // cursor in between. split cell
1156 MathArray::iterator bt = cell().begin();
1157 MathAtom at = createMathInset(font);
1158 at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1159 cell().erase(bt, bt + pos());
1164 // nothing left in the cell
1172 void LCursor::message(string const & msg) const
1174 bv().owner()->getLyXFunc().setMessage(msg);
1178 void LCursor::errorMessage(string const & msg) const
1180 bv().owner()->getLyXFunc().setErrorMessage(msg);
1184 string LCursor::selectionAsString(bool label) const
1190 Buffer const & buffer = *bv().buffer();
1191 ParagraphList & pars = text()->paragraphs();
1193 // should be const ...
1194 par_type startpit = selBegin().par();
1195 par_type endpit = selEnd().par();
1196 size_t const startpos = selBegin().pos();
1197 size_t const endpos = selEnd().pos();
1199 if (startpit == endpit)
1200 return pars[startpit].asString(buffer, startpos, endpos, label);
1202 // First paragraph in selection
1203 string result = pars[startpit].
1204 asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1206 // The paragraphs in between (if any)
1207 for (par_type pit = startpit + 1; pit != endpit; ++pit) {
1208 Paragraph & par = pars[pit];
1209 result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1212 // Last paragraph in selection
1213 result += pars[endpit].asString(buffer, 0, endpos, label);
1218 #ifdef WITH_WARNINGS
1219 #warning and mathed?
1225 string LCursor::currentState()
1228 std::ostringstream os;
1234 return text()->currentState(*this);
1240 string LCursor::getPossibleLabel()
1242 return inMathed() ? "eq:" : text()->getPossibleLabel(*this);
1246 Encoding const * LCursor::getEncoding() const
1253 // go up until first non-0 text is hit
1254 // (innermost text is 0 in mathed)
1255 for (s = size() - 1; s >= 0; --s)
1256 if (operator[](s).text())
1258 CursorSlice const & sl = operator[](s);
1259 LyXText & text = *sl.text();
1260 LyXFont font = text.getPar(sl.par()).getFont(
1261 bv().buffer()->params(), sl.pos(), outerFont(sl.par(), text.paragraphs()));
1262 return font.language()->encoding();
1266 void LCursor::undispatched()
1268 disp_.dispatched(false);
1272 void LCursor::dispatched()
1274 disp_.dispatched(true);
1278 void LCursor::noUpdate()
1280 disp_.update(false);