* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author André Pönitz
+ * \author André Pönitz
+ * \author Alfredo Braunstein
*
* Full author contact details are available in file CREDITS.
*/
#include "DocIterator.h"
-#include "debug.h"
-#include "Text.h"
+#include "Buffer.h"
+#include "InsetList.h"
#include "Paragraph.h"
+#include "LyXRC.h"
+#include "Text.h"
#include "mathed/MathData.h"
#include "mathed/InsetMath.h"
+#include "mathed/InsetMathHull.h"
#include "insets/InsetTabular.h"
-#include <boost/assert.hpp>
-#include <boost/current_function.hpp>
+#include "support/debug.h"
+#include "support/lassert.h"
+#include "support/lstrings.h"
+
+#include <ostream>
+using namespace std;
+using namespace lyx::support;
namespace lyx {
-using std::endl;
+DocIterator::DocIterator()
+ : boundary_(false), inset_(0), buffer_(0)
+{}
// We could be able to get rid of this if only every BufferView were
// associated to a buffer on construction.
-DocIterator::DocIterator()
- : boundary_(false), inset_(0)
+DocIterator::DocIterator(Buffer * buf)
+ : boundary_(false), inset_(0), buffer_(buf)
{}
-DocIterator::DocIterator(Inset & inset)
- : boundary_(false), inset_(&inset)
+DocIterator::DocIterator(Buffer * buf, Inset * inset)
+ : boundary_(false), inset_(inset), buffer_(buf)
{}
-DocIterator doc_iterator_begin(Inset & inset)
+DocIterator doc_iterator_begin(const Buffer * buf0, const Inset * inset0)
{
- DocIterator dit(inset);
+ Buffer * buf = const_cast<Buffer *>(buf0);
+ Inset * inset = const_cast<Inset *>(inset0);
+ DocIterator dit(buf, inset ? inset : &buf->inset());
dit.forwardPos();
return dit;
}
-DocIterator doc_iterator_end(Inset & inset)
+DocIterator doc_iterator_end(const Buffer * buf0, const Inset * inset0)
+{
+ Buffer * buf = const_cast<Buffer *>(buf0);
+ Inset * inset = const_cast<Inset *>(inset0);
+ return DocIterator(buf, inset ? inset : &buf->inset());
+}
+
+
+bool DocIterator::inRegexped() const
{
- return DocIterator(inset);
+ InsetMathHull * i = dynamic_cast<InsetMathHull *>(inset().asInsetMath());
+ return i && i->getType() == hullRegexp;
}
-Inset * DocIterator::nextInset()
+LyXErr & operator<<(LyXErr & os, DocIterator const & it)
{
- BOOST_ASSERT(!empty());
+ os.stream() << it;
+ return os;
+}
+
+
+Inset * DocIterator::nextInset() const
+{
+ LASSERT(!empty(), return 0);
if (pos() == lastpos())
return 0;
if (pos() > lastpos()) {
- lyxerr << "Should not happen, but it does. " << endl;
+ LYXERR0("Should not happen, but it does. ");
return 0;
}
if (inMathed())
return nextAtom().nucleus();
- return paragraph().isInset(pos()) ? paragraph().getInset(pos()) : 0;
+ return paragraph().getInset(pos());
}
-Inset * DocIterator::prevInset()
+Inset * DocIterator::prevInset() const
{
- BOOST_ASSERT(!empty());
+ LASSERT(!empty(), return 0);
if (pos() == 0)
return 0;
- if (inMathed())
- if (cell().empty())
- // FIXME: this should not happen but it does.
- // See bug 3189
- // http://bugzilla.lyx.org/show_bug.cgi?id=3189
- return 0;
- else
- return prevAtom().nucleus();
- return paragraph().isInset(pos() - 1) ? paragraph().getInset(pos() - 1) : 0;
-}
-
-
-Inset const * DocIterator::prevInset() const
-{
- BOOST_ASSERT(!empty());
- if (pos() == 0)
- return 0;
- if (inMathed())
+ if (inMathed()) {
if (cell().empty())
// FIXME: this should not happen but it does.
// See bug 3189
return 0;
else
return prevAtom().nucleus();
- return paragraph().isInset(pos() - 1) ? paragraph().getInset(pos() - 1) : 0;
+ }
+ return paragraph().getInset(pos() - 1);
}
Inset * DocIterator::realInset() const
{
- BOOST_ASSERT(inTexted());
+ LASSERT(inTexted(), /**/);
// if we are in a tabular, we need the cell
- if (inset().lyxCode() == Inset::TABULAR_CODE) {
+ if (inset().lyxCode() == TABULAR_CODE) {
InsetTabular & tabular = static_cast<InsetTabular&>(inset());
return tabular.cell(idx()).get();
}
}
-MathAtom const & DocIterator::prevAtom() const
+MathAtom & DocIterator::prevAtom() const
{
- BOOST_ASSERT(!empty());
- BOOST_ASSERT(pos() > 0);
+ LASSERT(!empty(), /**/);
+ LASSERT(pos() > 0, /**/);
return cell()[pos() - 1];
}
-MathAtom & DocIterator::prevAtom()
-{
- BOOST_ASSERT(!empty());
- BOOST_ASSERT(pos() > 0);
- return cell()[pos() - 1];
-}
-
-
-MathAtom const & DocIterator::nextAtom() const
-{
- BOOST_ASSERT(!empty());
- //lyxerr << "lastpos: " << lastpos() << " next atom:\n" << *this << endl;
- BOOST_ASSERT(pos() < lastpos());
- return cell()[pos()];
-}
-
-
-MathAtom & DocIterator::nextAtom()
+MathAtom & DocIterator::nextAtom() const
{
- BOOST_ASSERT(!empty());
+ LASSERT(!empty(), /**/);
//lyxerr << "lastpos: " << lastpos() << " next atom:\n" << *this << endl;
- BOOST_ASSERT(pos() < lastpos());
+ LASSERT(pos() < lastpos(), /**/);
return cell()[pos()];
}
-Text * DocIterator::text()
-{
- BOOST_ASSERT(!empty());
- return top().text();
-}
-
-Text const * DocIterator::text() const
+Text * DocIterator::text() const
{
- BOOST_ASSERT(!empty());
+ LASSERT(!empty(), /**/);
return top().text();
}
-Paragraph & DocIterator::paragraph()
+Paragraph & DocIterator::paragraph() const
{
if (!inTexted())
- lyxerr << *this << endl;
- BOOST_ASSERT(inTexted());
+ LYXERR0(*this);
+ LASSERT(inTexted(), /**/);
return top().paragraph();
}
-Paragraph const & DocIterator::paragraph() const
+Paragraph & DocIterator::innerParagraph() const
{
- BOOST_ASSERT(inTexted());
- return top().paragraph();
+ LASSERT(!empty(), /**/);
+ return innerTextSlice().paragraph();
}
-Paragraph const & DocIterator::innerParagraph() const
+CursorSlice const & DocIterator::innerTextSlice() const
{
- BOOST_ASSERT(!empty());
+ LASSERT(!empty(), /**/);
// go up until first non-0 text is hit
// (innermost text is 0 in mathed)
for (int i = depth() - 1; i >= 0; --i)
if (slices_[i].text())
- return slices_[i].paragraph();
+ return slices_[i];
// This case is in principe not possible. We _must_
- // be inside a Paragraph.
- BOOST_ASSERT(false);
- return paragraph();
+ // be inside a Text.
+ LASSERT(false, /**/);
+ static CursorSlice dummy;
+ return dummy;
}
}
-MathData const & DocIterator::cell() const
-{
-// BOOST_ASSERT(inMathed());
- return top().cell();
-}
-
-
-MathData & DocIterator::cell()
+MathData & DocIterator::cell() const
{
-// BOOST_ASSERT(inMathed());
+// LASSERT(inMathed(), /**/);
return top().cell();
}
-Text * DocIterator::innerText()
+Text * DocIterator::innerText() const
{
- BOOST_ASSERT(!empty());
- // Go up until first non-0 text is hit
- // (innermost text is 0 in mathed)
- for (int i = depth() - 1; i >= 0; --i)
- if (slices_[i].text())
- return slices_[i].text();
- return 0;
-}
-
-Text const * DocIterator::innerText() const
-{
- BOOST_ASSERT(!empty());
+ LASSERT(!empty(), /**/);
// go up until first non-0 text is hit
// (innermost text is 0 in mathed)
for (int i = depth() - 1; i >= 0; --i)
}
-void DocIterator::forwardPos(bool ignorecollapsed)
+// This duplicates code above, but is in the critical path.
+// So please think twice before adding stuff
+void DocIterator::forwardPos()
{
- //this dog bites his tail
+ // this dog bites his tail
if (empty()) {
push_back(CursorSlice(*inset_));
return;
}
- Inset * const nextinset = nextInset();
- // jump over collapsables if they are collapsed
- // FIXME: the check for asInsetMath() shouldn't be necessary
- // but math insets do not return a sensible editable() state yet.
- if (ignorecollapsed && nextinset && (!nextinset->asInsetMath()
- && nextinset->editable() != Inset::HIGHLY_EDITABLE)) {
- ++top().pos();
- return;
- }
-
CursorSlice & tip = top();
//lyxerr << "XXX\n" << *this << endl;
- // this is used twice and shows up in the profiler!
- pos_type const lastp = lastpos();
-
- // move into an inset to the right if possible
- Inset * n = 0;
-
- if (tip.pos() != lastp) {
- // this is impossible for pos() == size()
- if (inMathed()) {
+ // not at cell/paragraph end?
+ if (tip.pos() != tip.lastpos()) {
+ // move into an inset to the right if possible
+ Inset * n = 0;
+ if (inMathed())
n = (tip.cell().begin() + tip.pos())->nucleus();
- } else {
- if (paragraph().isInset(tip.pos()))
- n = paragraph().getInset(tip.pos());
+ else
+ n = paragraph().getInset(tip.pos());
+ if (n && n->isActive()) {
+ //lyxerr << "... descend" << endl;
+ push_back(CursorSlice(*n));
+ return;
}
}
- if (n && n->isActive()) {
- //lyxerr << "... descend" << endl;
- push_back(CursorSlice(*n));
- return;
- }
-
- // otherwise move on one position if possible
- if (tip.pos() < lastp) {
- //lyxerr << "... next pos" << endl;
- ++tip.pos();
- return;
- }
- //lyxerr << "... no next pos" << endl;
-
- // otherwise move on one paragraph if possible
- if (tip.pit() < lastpit()) {
- //lyxerr << "... next par" << endl;
- ++tip.pit();
- tip.pos() = 0;
- return;
- }
- //lyxerr << "... no next pit" << endl;
-
- // otherwise try to move on one cell if possible
- if (tip.idx() < lastidx()) {
- //lyxerr << "... next idx" << endl;
- ++tip.idx();
- tip.pit() = 0;
- tip.pos() = 0;
+ // jump to the next cell/paragraph if possible
+ if (!tip.at_end()) {
+ tip.forwardPos();
return;
}
- //lyxerr << "... no next idx" << endl;
// otherwise leave inset and jump over inset as a whole
pop_back();
- // 'top' is invalid now...
+ // 'tip' is invalid now...
if (!empty())
++top().pos();
}
-void DocIterator::forwardPosNoDescend()
+void DocIterator::forwardPosIgnoreCollapsed()
{
- CursorSlice & tip = top();
- pos_type const lastp = lastpos();
-
- // move on one position if possible
- if (tip.pos() < lastp) {
- //lyxerr << "... next pos" << endl;
- ++tip.pos();
- return;
- }
- //lyxerr << "... no next pos" << endl;
-
- // otherwise move on one paragraph if possible
- if (tip.pit() < lastpit()) {
- //lyxerr << "... next par" << endl;
- ++tip.pit();
- tip.pos() = 0;
- return;
- }
- //lyxerr << "... no next pit" << endl;
-
- // otherwise try to move on one cell if possible
- if (tip.idx() < lastidx()) {
- //lyxerr << "... next idx" << endl;
- ++tip.idx();
- tip.pit() = 0;
- tip.pos() = 0;
+ Inset * const nextinset = nextInset();
+ // FIXME: the check for asInsetMath() shouldn't be necessary
+ // but math insets do not return a sensible editable() state yet.
+ if (nextinset && !nextinset->asInsetMath()
+ && nextinset->editable() != Inset::HIGHLY_EDITABLE) {
+ ++top().pos();
return;
}
- //lyxerr << "... no next idx" << endl;
-
- // otherwise leave inset and jump over inset as a whole
- pop_back();
- // 'top' is invalid now...
- if (!empty())
- ++top().pos();
+ forwardPos();
}
pos_type const lastp = lastpos();
Paragraph const & par = paragraph();
pos_type & pos = top().pos();
- if (par.insetlist.empty())
+ if (par.insetList().empty())
pos = lastp;
else
while (pos < lastp && !par.isInset(pos))
}
-void DocIterator::forwardIdx()
-{
- CursorSlice & tip = top();
-
- //prevent endless loops
- BOOST_ASSERT(tip.idx() < lastidx());
-
- ++tip.idx();
- tip.pit() = 0;
- tip.pos() = 0;
-}
-
-
void DocIterator::forwardChar()
{
forwardPos();
return;
}
- CursorSlice & tip = top();
-
- if (tip.pos() != 0) {
- --tip.pos();
- } else if (tip.pit() != 0) {
- --tip.pit();
- tip.pos() = lastpos();
- return;
- } else if (tip.idx() != 0) {
- --tip.idx();
- tip.pit() = lastpit();
- tip.pos() = lastpos();
- return;
- } else {
+ // at inset beginning?
+ if (top().at_begin()) {
pop_back();
return;
}
- // move into an inset to the left if possible
- Inset * n = 0;
+ top().backwardPos();
- if (inMathed()) {
- n = (tip.cell().begin() + tip.pos())->nucleus();
- } else {
- if (paragraph().isInset(tip.pos()))
- n = paragraph().getInset(tip.pos());
- }
+ // entered another cell/paragraph from the right?
+ if (top().pos() == top().lastpos())
+ return;
+ // move into an inset to the left if possible
+ Inset * n = 0;
+ if (inMathed())
+ n = (top().cell().begin() + top().pos())->nucleus();
+ else
+ n = paragraph().getInset(top().pos());
if (n && n->isActive()) {
push_back(CursorSlice(*n));
top().idx() = lastidx();
void DocIterator::updateInsets(Inset * inset)
{
// this function re-creates the cache of inset pointers.
- // code taken in part from StableDocIterator::asDocIterator.
//lyxerr << "converting:\n" << *this << endl;
- DocIterator dit = DocIterator(*inset);
+ DocIterator dit = *this;
size_t const n = slices_.size();
+ slices_.resize(0);
for (size_t i = 0 ; i < n; ++i) {
- BOOST_ASSERT(inset);
- dit.push_back(slices_[i]);
- dit.top().inset_ = inset;
+ LASSERT(inset, /**/);
+ push_back(dit[i]);
+ top().inset_ = inset;
if (i + 1 != n)
- inset = dit.nextInset();
+ inset = nextInset();
}
//lyxerr << "converted:\n" << *this << endl;
- operator=(dit);
}
-std::ostream & operator<<(std::ostream & os, DocIterator const & dit)
+bool DocIterator::fixIfBroken()
{
- for (size_t i = 0, n = dit.depth(); i != n; ++i)
- os << " " << dit[i] << "\n";
- return os;
+ if (empty())
+ return false;
+
+ // Go through the slice stack from the bottom.
+ // Check that all coordinates (idx, pit, pos) are correct and
+ // that the inset is the one which is claimed to be there
+ Inset * inset = &slices_[0].inset();
+ size_t i = 0;
+ size_t n = slices_.size();
+ for (; i != n; ++i) {
+ CursorSlice & cs = slices_[i];
+ if (&cs.inset() != inset) {
+ // the whole slice is wrong, chop off this as well
+ --i;
+ LYXERR(Debug::DEBUG, "fixIfBroken(): inset changed");
+ break;
+ } else if (cs.idx() > cs.lastidx()) {
+ cs.idx() = cs.lastidx();
+ cs.pit() = cs.lastpit();
+ cs.pos() = cs.lastpos();
+ LYXERR(Debug::DEBUG, "fixIfBroken(): idx fixed");
+ break;
+ } else if (cs.pit() > cs.lastpit()) {
+ cs.pit() = cs.lastpit();
+ cs.pos() = cs.lastpos();
+ LYXERR(Debug::DEBUG, "fixIfBroken(): pit fixed");
+ break;
+ } else if (cs.pos() > cs.lastpos()) {
+ cs.pos() = cs.lastpos();
+ LYXERR(Debug::DEBUG, "fixIfBroken(): pos fixed");
+ break;
+ } else if (i != n - 1 && cs.pos() != cs.lastpos()) {
+ // get inset which is supposed to be in the next slice
+ if (cs.inset().inMathed())
+ inset = (cs.cell().begin() + cs.pos())->nucleus();
+ else if (Inset * csInset = cs.paragraph().getInset(cs.pos()))
+ inset = csInset;
+ else {
+ // there are slices left, so there must be another inset
+ break;
+ }
+ }
+ }
+
+ // Did we make it through the whole slice stack? Otherwise there
+ // was a problem at slice i, and we have to chop off above
+ if (i < n) {
+ LYXERR(Debug::DEBUG, "fixIfBroken(): cursor chopped at " << i);
+ resize(i + 1);
+ return true;
+ } else
+ return false;
}
-bool operator<(DocIterator const & p, DocIterator const & q)
+int DocIterator::find(MathData const & cell) const
{
- size_t depth = std::min(p.depth(), q.depth());
- for (size_t i = 0 ; i < depth ; ++i) {
- if (p[i] != q[i])
- return p[i] < q[i];
+ for (size_t l = 0; l != slices_.size(); ++l) {
+ if (slices_[l].asInsetMath() && &slices_[l].cell() == &cell)
+ return l;
}
- return p.depth() < q.depth();
+ return -1;
}
-bool operator>(DocIterator const & p, DocIterator const & q)
+int DocIterator::find(Inset const * inset) const
{
- return q < p;
+ for (size_t l = 0; l != slices_.size(); ++l) {
+ if (&slices_[l].inset() == inset)
+ return l;
+ }
+ return -1;
}
-bool operator<=(DocIterator const & p, DocIterator const & q)
+void DocIterator::cutOff(int above, vector<CursorSlice> & cut)
{
- return !(q < p);
+ cut = vector<CursorSlice>(slices_.begin() + above + 1, slices_.end());
+ slices_.resize(above + 1);
+}
+
+
+void DocIterator::cutOff(int above)
+{
+ slices_.resize(above + 1);
+}
+
+
+void DocIterator::append(vector<CursorSlice> const & x)
+{
+ slices_.insert(slices_.end(), x.begin(), x.end());
+}
+
+
+void DocIterator::append(DocIterator::idx_type idx, pos_type pos)
+{
+ slices_.push_back(CursorSlice());
+ top().idx() = idx;
+ top().pos() = pos;
+}
+
+
+ostream & operator<<(ostream & os, DocIterator const & dit)
+{
+ for (size_t i = 0, n = dit.depth(); i != n; ++i)
+ os << " " << dit[i] << "\n";
+ return os;
}
}
-DocIterator StableDocIterator::asDocIterator(Inset * inset) const
+DocIterator StableDocIterator::asDocIterator(Buffer * buf) const
{
// this function re-creates the cache of inset pointers
//lyxerr << "converting:\n" << *this << endl;
- DocIterator dit = DocIterator(*inset);
+ Inset * inset = &buf->inset();
+ DocIterator dit = DocIterator(buf, inset);
for (size_t i = 0, n = data_.size(); i != n; ++i) {
if (inset == 0) {
// FIXME
- lyxerr << BOOST_CURRENT_FUNCTION
- << " Should not happen, but does e.g. after C-n C-l C-z S-C-z"
+ LYXERR0(" Should not happen, but does e.g. after "
+ "C-n C-l C-z S-C-z\n"
+ << " or when a Buffer has been concurrently edited by two views"
<< '\n' << "dit: " << dit << '\n'
- << " lastpos: " << dit.lastpos() << endl;
- //break;
- BOOST_ASSERT(false);
+ << " lastpos: " << dit.lastpos());
+ dit.fixIfBroken();
+ break;
}
dit.push_back(data_[i]);
dit.top().inset_ = inset;
+ if (dit.fixIfBroken())
+ break;
if (i + 1 != n)
inset = dit.nextInset();
}
}
-std::ostream & operator<<(std::ostream & os, StableDocIterator const & dit)
+ostream & operator<<(ostream & os, StableDocIterator const & dit)
{
for (size_t i = 0, n = dit.data_.size(); i != n; ++i)
os << " " << dit.data_[i] << "\n";
}
+bool isLetter(DocIterator const & dit)
+{
+ return dit.inTexted()
+ && dit.inset().allowSpellCheck()
+ && dit.pos() != dit.lastpos()
+ && (dit.paragraph().isLetter(dit.pos())
+ // We want to pass the ' and escape chars to ispell
+ || contains(from_utf8(lyxrc.spellchecker_esc_chars + '\''),
+ dit.paragraph().getChar(dit.pos())))
+ && !dit.paragraph().isDeleted(dit.pos());
+}
+
} // namespace lyx