]> git.lyx.org Git - lyx.git/blobdiff - src/DocIterator.cpp
Fix #10778 (issue with CJK and language nesting)
[lyx.git] / src / DocIterator.cpp
index 51d21921a0990be19c59106f7823b209b5b3f9f9..6548186fd79e6399c8e56255c885affe9a30a017 100644 (file)
@@ -3,7 +3,7 @@
  * 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 "support/debug.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 "support/debug.h"
+#include "support/ExceptionMessage.h"
+#include "support/gettext.h"
+#include "support/lassert.h"
+#include "support/lstrings.h"
 
 #include <ostream>
 
 using namespace std;
+using namespace lyx::support;
 
 namespace lyx {
 
 
+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());
+}
+
+
+DocIterator DocIterator::clone(Buffer * buffer) const
+{
+       LASSERT(buffer->isClone(), return DocIterator());
+       Inset * inset = &buffer->inset();
+       DocIterator dit(buffer);
+       size_t const n = slices_.size();
+       for (size_t i = 0 ; i != n; ++i) {
+               LBUFERR(inset);
+               dit.push_back(slices_[i]);
+               dit.top().inset_ = inset;
+               if (i + 1 != n)
+                       inset = dit.nextInset();
+       }
+       return dit;
+}
+
+
+bool DocIterator::inRegexped() const
 {
-       return DocIterator(inset);
+       InsetMath * im = inset().asInsetMath();
+       if (!im) 
+               return false;
+       InsetMathHull * hull = im->asHullInset();
+       return hull && hull->getType() == hullRegexp;
 }
 
 
@@ -68,44 +111,45 @@ LyXErr & operator<<(LyXErr & os, DocIterator const & it)
 
 Inset * DocIterator::nextInset() const
 {
-       BOOST_ASSERT(!empty());
+       LASSERT(!empty(), return 0);
        if (pos() == lastpos())
                return 0;
        if (pos() > lastpos()) {
-               LYXERR0("Should not happen, but it does. ");
+               LYXERR0("Should not happen, but it does: pos() = "
+                       << pos() << ", lastpos() = " << lastpos());
                return 0;
        }
        if (inMathed())
                return nextAtom().nucleus();
-       return paragraph().isInset(pos()) ? paragraph().getInset(pos()) : 0;
+       return paragraph().getInset(pos());
 }
 
 
 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
+                       // http://www.lyx.org/trac/ticket/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(), return 0);
        // if we are in a tabular, we need the cell
        if (inset().lyxCode() == TABULAR_CODE) {
-               InsetTabular & tabular = static_cast<InsetTabular&>(inset());
-               return tabular.cell(idx()).get();
+               InsetTabular * tabular = inset().asInsetTabular();
+               return tabular->cell(idx()).get();
        }
        return &inset();
 }
@@ -113,58 +157,81 @@ Inset * DocIterator::realInset() const
 
 MathAtom & DocIterator::prevAtom() const
 {
-       BOOST_ASSERT(!empty());
-       BOOST_ASSERT(pos() > 0);
+       LASSERT(!empty(), /**/);
+       LASSERT(pos() > 0, /**/);
        return cell()[pos() - 1];
 }
 
 
 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() const
 {
-       BOOST_ASSERT(!empty());
+       LASSERT(!empty(), return 0);
        return top().text();
 }
 
 
 Paragraph & DocIterator::paragraph() const
 {
-       if (!inTexted())
+       if (!inTexted()) {
                LYXERR0(*this);
-       BOOST_ASSERT(inTexted());
+               LBUFERR(false);
+       }
        return top().paragraph();
 }
 
 
 Paragraph & DocIterator::innerParagraph() const
 {
-       BOOST_ASSERT(!empty());
+       LBUFERR(!empty());
        return innerTextSlice().paragraph();
 }
 
 
+FontSpan DocIterator::locateWord(word_location const loc) const
+{
+       FontSpan f = FontSpan();
+
+       if (!top().text()->empty()) {
+               f.first = pos();
+               top().paragraph().locateWord(f.first, f.last, loc);
+       }
+       return f;
+}
+
+       
 CursorSlice const & DocIterator::innerTextSlice() const
 {
-       BOOST_ASSERT(!empty());
+       LBUFERR(!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];
 
-       // This case is in principe not possible. We _must_
+       // This case is in principle not possible. We _must_
        // be inside a Text.
-       BOOST_ASSERT(false);
-       static CursorSlice dummy;
-       return dummy;
+       LBUFERR(false);
+       // Squash warning
+       static const CursorSlice c;
+       return c;
+}
+
+
+DocIterator DocIterator::getInnerText() const
+{
+       DocIterator texted = *this;
+       while (!texted.inTexted()) 
+               texted.pop_back();
+       return texted;
 }
 
 
@@ -221,20 +288,15 @@ DocIterator::col_type DocIterator::col() const
 
 MathData & DocIterator::cell() const
 {
-//     BOOST_ASSERT(inMathed());
+//     LASSERT(inMathed(), /**/);
        return top().cell();
 }
 
 
 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;
+       LASSERT(!empty(), return 0);
+       return innerTextSlice().text();
 }
 
 
@@ -247,53 +309,40 @@ Inset * DocIterator::innerInsetOfType(int code) const
 }
 
 
-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;
-       }
-
+       // jump to the next cell/paragraph if possible
        if (!tip.at_end()) {
                tip.forwardPos();
                return;
        }
+
        // otherwise leave inset and jump over inset as a whole
        pop_back();
        // 'tip' is invalid now...
@@ -302,6 +351,20 @@ void DocIterator::forwardPos(bool ignorecollapsed)
 }
 
 
+void DocIterator::forwardPosIgnoreCollapsed()
+{
+       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()) {
+               ++top().pos();
+               return;
+       }
+       forwardPos();
+}
+
+
 void DocIterator::forwardPar()
 {
        forwardPos();
@@ -368,6 +431,7 @@ void DocIterator::backwardPos()
                return;
        }
 
+       // at inset beginning?
        if (top().at_begin()) {
                pop_back();
                return;
@@ -375,16 +439,16 @@ void DocIterator::backwardPos()
 
        top().backwardPos();
 
+       // 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()) {
+       if (inMathed())
                n = (top().cell().begin() + top().pos())->nucleus();
-       } else {
-               if (paragraph().isInset(top().pos()))
-                       n = paragraph().getInset(top().pos());
-       }
-
+       else
+               n = paragraph().getInset(top().pos());
        if (n && n->isActive()) {
                push_back(CursorSlice(*n));
                top().idx() = lastidx();
@@ -394,6 +458,28 @@ void DocIterator::backwardPos()
 }
 
 
+#if 0
+// works, but currently not needed
+void DocIterator::backwardInset()
+{
+       backwardPos();
+
+       while (!empty() && !nextInset()) {
+               if (inTexted()) {
+                       pos_type const lastp = lastpos();
+                       Paragraph const & par = paragraph();
+                       pos_type & pos = top().pos();
+                       while (pos > 0 && (pos == lastp || !par.isInset(pos)))
+                               --pos;
+                       if (pos > 0)
+                               break;
+               }
+               backwardPos();
+       }
+}
+#endif
+
+
 bool DocIterator::hasPart(DocIterator const & it) const
 {
        // it can't be a part if it is larger
@@ -405,6 +491,19 @@ bool DocIterator::hasPart(DocIterator const & it) const
 }
 
 
+bool DocIterator::allowSpellCheck() const
+{
+       /// spell check is disabled if the iterator position
+       /// is inside of an inset which disables the spell checker
+       size_t const n = depth();
+       for (size_t i = 0; i < n; ++i) {
+               if (!slices_[i].inset_->allowSpellCheck())
+                       return false;
+       }
+       return true;
+}
+
+
 void DocIterator::updateInsets(Inset * inset)
 {
        // this function re-creates the cache of inset pointers.
@@ -413,7 +512,7 @@ void DocIterator::updateInsets(Inset * inset)
        size_t const n = slices_.size();
        slices_.resize(0);
        for (size_t i = 0 ; i < n; ++i) {
-               BOOST_ASSERT(inset);
+               LBUFERR(inset);
                push_back(dit[i]);
                top().inset_ = inset;
                if (i + 1 != n)
@@ -425,6 +524,9 @@ void DocIterator::updateInsets(Inset * inset)
 
 bool DocIterator::fixIfBroken()
 {
+       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
@@ -433,7 +535,9 @@ bool DocIterator::fixIfBroken()
        size_t n = slices_.size();
        for (; i != n; ++i) {
                CursorSlice & cs = slices_[i];
-               if (&cs.inset() != inset) {
+               if (&cs.inset() != inset
+                   || (cs.inset().inMathed() ? ! cs.inset().isActive()
+                                             : ! cs.inset().editable())) {
                        // the whole slice is wrong, chop off this as well
                        --i;
                        LYXERR(Debug::DEBUG, "fixIfBroken(): inset changed");
@@ -457,8 +561,8 @@ bool DocIterator::fixIfBroken()
                        // get inset which is supposed to be in the next slice
                        if (cs.inset().inMathed())
                                inset = (cs.cell().begin() + cs.pos())->nucleus();
-                       else if (cs.paragraph().isInset(cs.pos()))
-                               inset = cs.paragraph().getInset(cs.pos());
+                       else if (Inset * csInset = cs.paragraph().getInset(cs.pos()))
+                               inset = csInset;
                        else {
                                // there are slices left, so there must be another inset
                                break;
@@ -477,7 +581,42 @@ bool DocIterator::fixIfBroken()
 }
 
 
-DocIterator::idx_type DocIterator::find(MathData const & cell) const
+void DocIterator::sanitize()
+{
+       // keep a copy of the slices
+       vector<CursorSlice> const sl = slices_;
+       slices_.clear();
+       if (buffer_)
+               inset_ = &buffer_->inset();
+       Inset * inset = inset_;
+       // re-add the slices one by one, and adjust the inset pointer.
+       for (size_t i = 0, n = sl.size(); i != n; ++i) {
+               if (inset == 0) {
+                       // FIXME
+                       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: " << *this << '\n'
+                               << " lastpos: " << slices_[i].lastpos());
+                       fixIfBroken();
+                       break;
+               }
+               if (!inset->isActive()) {
+                       LYXERR0("Inset found on cursor stack is not active.");
+                       fixIfBroken();
+                       break;
+               }
+               push_back(sl[i]);
+               top().inset_ = inset;
+               if (fixIfBroken())
+                       break;
+               if (i + 1 != n)
+                       inset = nextInset();
+       }
+}
+
+
+int DocIterator::find(MathData const & cell) const
 {
        for (size_t l = 0; l != slices_.size(); ++l) {
                if (slices_[l].asInsetMath() && &slices_[l].cell() == &cell)
@@ -487,24 +626,24 @@ DocIterator::idx_type DocIterator::find(MathData const & cell) const
 }
 
 
-DocIterator::idx_type DocIterator::find(InsetMath const * inset) const 
+int DocIterator::find(Inset const * inset) const 
 {
        for (size_t l = 0; l != slices_.size(); ++l) {
-               if (slices_[l].asInsetMath() == inset)
+               if (&slices_[l].inset() == inset)
                        return l;
        }
        return -1;
 }
 
 
-void DocIterator::cutOff(DocIterator::idx_type above, vector<CursorSlice> & cut)
+void DocIterator::cutOff(int above, vector<CursorSlice> & cut)
 {
        cut = vector<CursorSlice>(slices_.begin() + above + 1, slices_.end());
        slices_.resize(above + 1);
 }
 
 
-void DocIterator::cutOff(DocIterator::idx_type above) 
+void DocIterator::cutOff(int above)
 {
        slices_.resize(above + 1);
 }
@@ -542,30 +681,11 @@ StableDocIterator::StableDocIterator(DocIterator const & dit)
 }
 
 
-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);
-       for (size_t i = 0, n = data_.size(); i != n; ++i) {
-               if (inset == 0) {
-                       // FIXME
-                       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());
-                       dit.fixIfBroken();
-                       break;
-               }
-               dit.push_back(data_[i]);
-               dit.top().inset_ = inset;
-               if (dit.fixIfBroken())
-                       break;
-               if (i + 1 != n)
-                       inset = dit.nextInset();
-       }
-       //lyxerr << "convert:\n" << *this << " to:\n" << dit << endl;
+       DocIterator dit(buf);
+       dit.slices_ = data_;
+       dit.sanitize();
        return dit;
 }