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_inset.h"
40 #include "mathed/math_macrotable.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
61 LCursor::LCursor(BufferView & bv)
62 : DocIterator(), bv_(&bv), anchor_(), x_target_(-1),
63 selection_(false), mark_(false)
67 void LCursor::reset(InsetBase & inset)
70 push_back(CursorSlice(inset));
71 anchor_ = DocIterator(inset);
78 void LCursor::setCursor(DocIterator const & cur, bool sel)
80 // this (intentionally) does not touch the anchor
81 DocIterator::operator=(cur);
86 DispatchResult LCursor::dispatch(FuncRequest const & cmd0)
88 lyxerr << "\nLCursor::dispatch: cmd: " << cmd0 << endl << *this << endl;
90 return DispatchResult();
92 FuncRequest cmd = cmd0;
95 for ( ; size(); pop()) {
96 //lyxerr << "\nLCursor::dispatch: cmd: " << cmd0 << endl << *this << endl;
97 BOOST_ASSERT(pos() <= lastpos());
98 BOOST_ASSERT(idx() <= lastidx());
99 BOOST_ASSERT(par() <= lastpar());
101 // The common case is 'LFUN handled, need update', so make the
102 // LFUN handler's life easier by assuming this as default value.
103 // The handler can reset the update and val flags if necessary.
105 disp_.dispatched(true);
106 inset().dispatch(*this, cmd);
107 if (disp_.dispatched())
110 // it completely to get a 'bomb early' behaviour in case this
111 // object will be used again.
112 if (!disp_.dispatched()) {
113 lyxerr << "RESTORING OLD CURSOR!" << endl;
115 disp_.dispatched(false);
121 bool LCursor::getStatus(FuncRequest const & cmd, FuncStatus & status)
123 // This is, of course, a mess. Better create a new doc iterator and use
124 // this in Inset::getStatus. This might require an additional
125 // BufferView * arg, though (which should be avoided)
126 LCursor safe = *this;
128 for ( ; size(); pop()) {
129 //lyxerr << "\nLCursor::getStatus: cmd: " << cmd << endl << *this << endl;
130 BOOST_ASSERT(pos() <= lastpos());
131 BOOST_ASSERT(idx() <= lastidx());
132 BOOST_ASSERT(par() <= lastpar());
134 // The inset's getStatus() will return 'true' if it made
135 // a definitive decision on whether it want to handle the
136 // request or not. The result of this decision is put into
137 // the 'status' parameter.
138 if (inset().getStatus(*this, cmd, status)) {
148 BufferView & LCursor::bv() const
155 Buffer & LCursor::buffer() const
158 BOOST_ASSERT(bv_->buffer());
159 return *bv_->buffer();
165 BOOST_ASSERT(size() >= 1);
170 void LCursor::push(InsetBase & p)
172 push_back(CursorSlice(p));
176 void LCursor::pushLeft(InsetBase & p)
178 BOOST_ASSERT(!empty());
179 //lyxerr << "Entering inset " << t << " left" << endl;
185 bool LCursor::popLeft()
187 BOOST_ASSERT(!empty());
188 //lyxerr << "Leaving inset to the left" << endl;
189 inset().notifyCursorLeaves(*this);
197 bool LCursor::popRight()
199 BOOST_ASSERT(!empty());
200 //lyxerr << "Leaving inset to the right" << endl;
201 inset().notifyCursorLeaves(*this);
210 int LCursor::currentMode()
212 BOOST_ASSERT(!empty());
213 for (int i = size() - 1; i >= 0; --i) {
214 int res = operator[](i).inset().currentMode();
215 if (res != InsetBase::UNDECIDED_MODE)
218 return InsetBase::TEXT_MODE;
222 void LCursor::getDim(int & asc, int & des) const
225 BOOST_ASSERT(inset().asMathInset());
226 //inset().asMathInset()->getCursorDim(asc, des);
229 } else if (inTexted()) {
230 Row const & row = textRow();
231 asc = row.baseline();
232 des = row.height() - asc;
234 lyxerr << "should this happen?" << endl;
241 void LCursor::getPos(int & x, int & y) const
246 inset().getCursorPos(*this, x, y);
250 void LCursor::paste(string const & data)
252 dispatch(FuncRequest(LFUN_PASTE, data));
256 void LCursor::resetAnchor()
263 bool LCursor::posLeft()
272 bool LCursor::posRight()
274 if (pos() == lastpos())
281 CursorSlice LCursor::anchor() const
283 BOOST_ASSERT(anchor_.size() >= size());
284 CursorSlice normal = anchor_[size() - 1];
285 if (size() < anchor_.size() && back() <= normal) {
286 // anchor is behind cursor -> move anchor behind the inset
293 CursorSlice LCursor::selBegin() const
297 return anchor() < back() ? anchor() : back();
301 CursorSlice LCursor::selEnd() const
305 return anchor() > back() ? anchor() : back();
309 DocIterator LCursor::selectionBegin() const
313 return anchor() < back() ? anchor_ : *this;
317 DocIterator LCursor::selectionEnd() const
321 return anchor() > back() ? anchor_ : *this;
325 void LCursor::setSelection()
328 // a selection with no contents is not a selection
330 #warning doesnt look ok
332 if (par() == anchor().par() && pos() == anchor().pos())
337 void LCursor::setSelection(DocIterator const & where, size_t n)
339 setCursor(where, true);
345 void LCursor::clearSelection()
354 int & LCursor::x_target()
360 int LCursor::x_target() const
366 void LCursor::clearTargetX()
373 void LCursor::info(std::ostream & os) const
375 for (int i = 1, n = depth(); i < n; ++i) {
376 operator[](i).inset().infoize(os);
380 prevInset()->infoize2(os);
381 // overwite old message
386 void LCursor::selHandle(bool sel)
388 //lyxerr << "LCursor::selHandle" << endl;
389 if (sel == selection()) {
391 #warning Alfredo: This is too strong (Andre)
403 std::ostream & operator<<(std::ostream & os, LCursor const & cur)
405 for (size_t i = 0, n = cur.size(); i != n; ++i) {
406 os << " " << cur.operator[](i) << " | ";
407 if (i < cur.anchor_.size())
408 os << cur.anchor_[i];
410 os << "-------------------------------";
413 for (size_t i = cur.size(), n = cur.anchor_.size(); i < n; ++i) {
414 os << "------------------------------- | " << cur.anchor_[i] << "\n";
416 os << " selection: " << cur.selection_
417 << " x_target: " << cur.x_target_ << endl;
424 ///////////////////////////////////////////////////////////////////
426 // The part below is the non-integrated rest of the original math
427 // cursor. This should be either generalized for texted or moved
428 // back to mathed (in most cases to MathNestInset).
430 ///////////////////////////////////////////////////////////////////
432 #include "mathed/math_charinset.h"
433 #include "mathed/math_factory.h"
434 #include "mathed/math_gridinset.h"
435 #include "mathed/math_macroarg.h"
436 #include "mathed/math_mathmlstream.h"
437 #include "mathed/math_scriptinset.h"
438 #include "mathed/math_support.h"
439 #include "mathed/math_unknowninset.h"
441 //#define FILEDEBUG 1
444 bool LCursor::isInside(InsetBase const * p)
446 for (unsigned i = 0; i < depth(); ++i)
447 if (&operator[](i).inset() == p)
453 bool LCursor::openable(MathAtom const & t) const
464 // we can't move into anything new during selection
465 if (depth() >= anchor_.size())
467 if (!ptr_cmp(t.nucleus(), &anchor_[depth()].inset()))
474 bool positionable(DocIterator const & cursor,
475 DocIterator const & anchor)
477 // avoid deeper nested insets when selecting
478 if (cursor.size() > anchor.size())
481 // anchor might be deeper, should have same path then
482 for (size_t i = 0; i < cursor.size(); ++i)
483 if (&cursor[i].inset() != &anchor[i].inset())
486 // position should be ok.
491 void LCursor::setScreenPos(int x, int y)
494 bruteFind(x, y, 0, bv().workWidth(), 0, bv().workHeight());
499 void LCursor::plainErase()
505 void LCursor::markInsert()
511 void LCursor::markErase()
517 void LCursor::plainInsert(MathAtom const & t)
519 cell().insert(pos(), t);
524 void LCursor::insert(string const & str)
526 //lyxerr << "LCursor::insert str '" << str << "'" << endl;
527 for (string::const_iterator it = str.begin(); it != str.end(); ++it)
532 void LCursor::insert(char c)
534 //lyxerr << "LCursor::insert char '" << c << "'" << endl;
535 BOOST_ASSERT(!empty());
537 lyx::cap::selClearOrDel(*this);
538 insert(new MathCharInset(c));
540 text()->insertChar(*this, c);
545 void LCursor::insert(MathAtom const & t)
547 //lyxerr << "LCursor::insert MathAtom: " << endl;
549 lyx::cap::selClearOrDel(*this);
551 lyxerr << "LCursor::insert MathAtom: cur:\n" << *this << endl;
555 void LCursor::insert(InsetBase * inset)
558 insert(MathAtom(inset));
560 text()->insertInset(*this, inset);
564 void LCursor::niceInsert(string const & t)
575 void LCursor::niceInsert(MathAtom const & t)
578 string safe = lyx::cap::grabAndEraseSelection(*this);
580 // enter the new inset and move the contents of the selection if possible
583 // be careful here: don't use 'pushLeft(t)' as this we need to
584 // push the clone, not the original
585 pushLeft(*nextInset());
591 void LCursor::insert(MathArray const & ar)
595 lyx::cap::eraseSelection(*this);
596 cell().insert(pos(), ar);
601 bool LCursor::backspace()
603 autocorrect() = false;
606 lyx::cap::selDel(*this);
611 if (inset().nargs() == 1 && depth() == 1 && lastpos() == 0)
618 MathUnknownInset * p = activeMacro();
619 if (p->name().size() > 1) {
620 p->setName(p->name().substr(0, p->name().size() - 1));
625 if (pos() != 0 && prevAtom()->nargs() > 0) {
626 // let's require two backspaces for 'big stuff' and
627 // highlight on the first
639 bool LCursor::erase()
641 autocorrect() = false;
646 lyx::cap::selDel(*this);
650 // delete empty cells if possible
651 if (pos() == lastpos() && inset().idxDelete(idx()))
654 // special behaviour when in last position of cell
655 if (pos() == lastpos()) {
656 bool one_cell = inset().nargs() == 1;
657 if (one_cell && depth() == 1 && lastpos() == 0)
663 inset().idxGlue(idx());
667 // 'clever' UI hack: only erase large items if previously slected
668 if (pos() != lastpos() && inset().nargs() > 0) {
683 DocIterator save = *this;
686 setCursor(save, false);
687 autocorrect() = false;
695 DocIterator save = *this;
698 setCursor(save, false);
699 autocorrect() = false;
704 void LCursor::macroModeClose()
708 MathUnknownInset * p = activeMacro();
710 string s = p->name();
714 // do nothing if the macro name is empty
718 string const name = s.substr(1);
720 // prevent entering of recursive macros
721 InsetBase const * macro = innerInsetOfType(InsetBase::MATHMACRO_CODE);
722 if (macro && macro->getInsetName() == name)
723 lyxerr << "can't enter recursive macro" << endl;
725 niceInsert(createMathInset(name));
729 string LCursor::macroName()
731 return inMacroMode() ? activeMacro()->name() : string();
735 void LCursor::handleNest(MathAtom const & a, int c)
737 //lyxerr << "LCursor::handleNest: " << c << endl;
739 asArray(lyx::cap::grabAndEraseSelection(*this), t.nucleus()->cell(c));
742 pushLeft(*nextInset());
746 int LCursor::targetX() const
748 if (x_target() != -1)
757 bool LCursor::inMacroMode() const
761 MathUnknownInset const * p = prevAtom()->asUnknownInset();
762 return p && !p->final();
766 MathUnknownInset * LCursor::activeMacro()
768 return inMacroMode() ? prevAtom().nucleus()->asUnknownInset() : 0;
772 void LCursor::pullArg()
777 MathArray ar = cell();
778 if (popLeft() && inMathed()) {
780 cell().insert(pos(), ar);
783 //formula()->mutateToText();
788 void LCursor::touch()
794 DocIterator::const_iterator it = begin();
795 DocIterator::const_iterator et = end();
796 for ( ; it != et; ++it)
802 void LCursor::normalize()
804 if (idx() >= nargs()) {
805 lyxerr << "this should not really happen - 1: "
806 << idx() << ' ' << nargs()
807 << " in: " << &inset() << endl;
809 idx() = min(idx(), lastidx());
811 if (pos() > lastpos()) {
812 lyxerr << "this should not really happen - 2: "
813 << pos() << ' ' << lastpos() << " in idx: " << idx()
815 WriteStream wi(lyxerr, false, true);
816 inset().asMathInset()->write(wi);
819 pos() = min(pos(), lastpos());
823 bool LCursor::goUpDown(bool up)
825 // Be warned: The 'logic' implemented in this function is highly
826 // fragile. A distance of one pixel or a '<' vs '<=' _really
827 // matters. So fiddle around with it only if you think you know
828 // what you are doing!
834 // check if we had something else in mind, if not, this is the future goal
835 if (x_target() == -1)
840 // try neigbouring script insets
844 MathScriptInset const * p = prevAtom()->asScriptInset();
845 if (p && p->has(up)) {
848 idx() = up; // the superscript has index 1
850 //lyxerr << "updown: handled by scriptinset to the left" << endl;
856 if (pos() != lastpos()) {
857 MathScriptInset const * p = nextAtom()->asScriptInset();
858 if (p && p->has(up)) {
862 //lyxerr << "updown: handled by scriptinset to the right" << endl;
868 // try current cell for e.g. text insets
869 if (inset().idxUpDown2(*this, up))
872 //xarray().boundingBox(xlow, xhigh, ylow, yhigh);
877 //if (bruteFind(xo, yo, xlow, xhigh, ylow, yhigh)) {
878 // lyxerr << "updown: handled by brute find in the same cell" << endl;
882 // try to find an inset that knows better then we
884 //lyxerr << "updown: We are in " << &inset() << " idx: " << idx() << endl;
886 if (inset().idxUpDown(*this, up)) {
887 // try to find best position within this inset
893 // no such inset found, just take something "above"
894 //lyxerr << "updown: handled by strange case" << endl;
896 int ylow = up ? 0 : yo + 1;
897 int yhigh = up ? yo - 1 : bv().workHeight();
898 return bruteFind(xo, yo, 0, bv().workWidth(), ylow, yhigh);
901 // any improvement so far?
904 if (up ? ynew < yo : ynew > yo)
910 bool LCursor::bruteFind(int x, int y, int xlow, int xhigh, int ylow, int yhigh)
912 BOOST_ASSERT(!empty());
914 CursorSlice bottom = operator[](0);
915 LyXText * text = bottom.text();
917 getParsInRange(text->paragraphs(), ylow, yhigh, beg, end);
919 DocIterator it = doc_iterator_begin(bv().buffer()->inset());
920 DocIterator et = doc_iterator_end(bv().buffer()->inset());
921 //lyxerr << "x: " << x << " y: " << y << endl;
922 //lyxerr << "xlow: " << xlow << " ylow: " << ylow << endl;
923 //lyxerr << "xhigh: " << xhigh << " yhigh: " << yhigh << endl;
926 //et.par() = text->parOffset(end);
928 double best_dist = 10e10;
929 DocIterator best_cursor = it;
931 for ( ; it != et; it.forwardPos()) {
932 // avoid invalid nesting when selecting
933 if (!selection() || positionable(it, anchor_)) {
936 cur.setCursor(it, false);
937 cur.inset().getCursorPos(cur, xo, yo);
938 if (xlow <= xo && xo <= xhigh && ylow <= yo && yo <= yhigh) {
939 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
940 //lyxerr << "xo: " << xo << " yo: " << yo << " d: " << d << endl;
941 // '<=' in order to take the last possible position
942 // this is important for clicking behind \sum in e.g. '\sum_i a'
943 if (d <= best_dist) {
944 //lyxerr << "*" << endl;
952 //lyxerr << "best_dist: " << best_dist << " cur:\n" << best_cursor << endl;
953 if (best_dist < 1e10)
954 setCursor(best_cursor, false);
955 return best_dist < 1e10;
959 void LCursor::bruteFind2(int x, int y)
961 double best_dist = 1e10;
963 DocIterator it = *this;
965 DocIterator et = *this;
966 et.back().pos() = et.back().asMathInset()->cell(et.back().idx()).size();
967 for (int i = 0; ; ++i) {
970 cur.setCursor(it, false);
971 cur.inset().getCursorPos(cur, xo, yo);
972 double d = (x - xo) * (x - xo) + (y - yo) * (y - yo);
973 // '<=' in order to take the last possible position
974 // this is important for clicking behind \sum in e.g. '\sum_i a'
975 lyxerr << "i: " << i << " d: " << d << " best: " << best_dist << endl;
976 if (d <= best_dist) {
978 setCursor(it, false);
987 void LCursor::handleFont(string const & font)
989 lyxerr << "LCursor::handleFont: " << font << endl;
993 safe = lyx::cap::grabAndEraseSelection(*this);
996 if (lastpos() != 0) {
997 // something left in the cell
999 // cursor in first position
1001 } else if (pos() == lastpos()) {
1002 // cursor in last position
1005 // cursor in between. split cell
1006 MathArray::iterator bt = cell().begin();
1007 MathAtom at = createMathInset(font);
1008 at.nucleus()->cell(0) = MathArray(bt, bt + pos());
1009 cell().erase(bt, bt + pos());
1014 // nothing left in the cell
1022 void LCursor::message(string const & msg) const
1024 bv().owner()->getLyXFunc().setMessage(msg);
1028 void LCursor::errorMessage(string const & msg) const
1030 bv().owner()->getLyXFunc().setErrorMessage(msg);
1034 string LCursor::selectionAsString(bool label) const
1040 Buffer const & buffer = *bv().buffer();
1041 ParagraphList & pars = text()->paragraphs();
1043 // should be const ...
1044 par_type startpit = selBegin().par();
1045 par_type endpit = selEnd().par();
1046 size_t const startpos = selBegin().pos();
1047 size_t const endpos = selEnd().pos();
1049 if (startpit == endpit)
1050 return pars[startpit].asString(buffer, startpos, endpos, label);
1052 // First paragraph in selection
1053 string result = pars[startpit].
1054 asString(buffer, startpos, pars[startpit].size(), label) + "\n\n";
1056 // The paragraphs in between (if any)
1057 for (par_type pit = startpit + 1; pit != endpit; ++pit) {
1058 Paragraph & par = pars[pit];
1059 result += par.asString(buffer, 0, par.size(), label) + "\n\n";
1062 // Last paragraph in selection
1063 result += pars[endpit].asString(buffer, 0, endpos, label);
1068 #ifdef WITH_WARNINGS
1069 #warning and mathed?
1075 string LCursor::currentState()
1078 std::ostringstream os;
1084 return text()->currentState(*this);
1090 string LCursor::getPossibleLabel()
1092 return inMathed() ? "eq:" : text()->getPossibleLabel(*this);
1096 Encoding const * LCursor::getEncoding() const
1103 // go up until first non-0 text is hit
1104 // (innermost text is 0 in mathed)
1105 for (s = size() - 1; s >= 0; --s)
1106 if (operator[](s).text())
1108 CursorSlice const & sl = operator[](s);
1109 LyXText & text = *sl.text();
1110 LyXFont font = text.getPar(sl.par()).getFont(
1111 bv().buffer()->params(), sl.pos(), outerFont(sl.par(), text.paragraphs()));
1112 return font.language()->encoding();
1116 void LCursor::undispatched()
1118 disp_.dispatched(false);
1122 void LCursor::dispatched()
1124 disp_.dispatched(true);
1128 void LCursor::noUpdate()
1130 disp_.update(false);