]> git.lyx.org Git - lyx.git/blobdiff - src/DocIterator.cpp
Remove profiling.py
[lyx.git] / src / DocIterator.cpp
index 3af7dcba93b96762e5055b8a8c6479ae89cdb38b..ace4498a56e91d6f4e8af525f77c567ec74544b0 100644 (file)
 #include "DocIterator.h"
 
 #include "Buffer.h"
+#include "BufferParams.h"
+#include "Encoding.h"
+#include "Font.h"
 #include "InsetList.h"
+#include "Language.h"
 #include "Paragraph.h"
-#include "LyXRC.h"
 #include "Text.h"
 
 #include "mathed/MathData.h"
 
 #include "insets/InsetTabular.h"
 
+#include "support/convert.h"
 #include "support/debug.h"
+#include "support/ExceptionMessage.h"
+#include "support/gettext.h"
 #include "support/lassert.h"
 #include "support/lstrings.h"
 
@@ -38,25 +44,9 @@ 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(Buffer * buf)
-       : boundary_(false), inset_(0), buffer_(buf)
-{}
-
-
-DocIterator::DocIterator(Buffer * buf, Inset * inset)
-       : boundary_(false), inset_(inset), buffer_(buf)
-{}
-
-
 DocIterator doc_iterator_begin(const Buffer * buf0, const Inset * inset0)
 {
-       Buffer * buf = const_cast<Buffer *>(buf0);      
+       Buffer * buf = const_cast<Buffer *>(buf0);
        Inset * inset = const_cast<Inset *>(inset0);
        DocIterator dit(buf, inset ? inset : &buf->inset());
        dit.forwardPos();
@@ -66,7 +56,7 @@ DocIterator doc_iterator_begin(const Buffer * buf0, const Inset * inset0)
 
 DocIterator doc_iterator_end(const Buffer * buf0, const Inset * inset0)
 {
-       Buffer * buf = const_cast<Buffer *>(buf0);      
+       Buffer * buf = const_cast<Buffer *>(buf0);
        Inset * inset = const_cast<Inset *>(inset0);
        return DocIterator(buf, inset ? inset : &buf->inset());
 }
@@ -79,7 +69,7 @@ DocIterator DocIterator::clone(Buffer * buffer) const
        DocIterator dit(buffer);
        size_t const n = slices_.size();
        for (size_t i = 0 ; i != n; ++i) {
-               LASSERT(inset, /**/);
+               LBUFERR(inset);
                dit.push_back(slices_[i]);
                dit.top().inset_ = inset;
                if (i + 1 != n)
@@ -92,7 +82,7 @@ DocIterator DocIterator::clone(Buffer * buffer) const
 bool DocIterator::inRegexped() const
 {
        InsetMath * im = inset().asInsetMath();
-       if (!im) 
+       if (!im)
                return false;
        InsetMathHull * hull = im->asHullInset();
        return hull && hull->getType() == hullRegexp;
@@ -108,13 +98,13 @@ LyXErr & operator<<(LyXErr & os, DocIterator const & it)
 
 Inset * DocIterator::nextInset() const
 {
-       LASSERT(!empty(), return 0);
+       LASSERT(!empty(), return nullptr);
        if (pos() == lastpos())
-               return 0;
+               return nullptr;
        if (pos() > lastpos()) {
                LYXERR0("Should not happen, but it does: pos() = "
                        << pos() << ", lastpos() = " << lastpos());
-               return 0;
+               return nullptr;
        }
        if (inMathed())
                return nextAtom().nucleus();
@@ -124,15 +114,15 @@ Inset * DocIterator::nextInset() const
 
 Inset * DocIterator::prevInset() const
 {
-       LASSERT(!empty(), return 0);
+       LASSERT(!empty(), return nullptr);
        if (pos() == 0)
-               return 0;
+               return nullptr;
        if (inMathed()) {
                if (cell().empty())
                        // FIXME: this should not happen but it does.
                        // See bug 3189
                        // http://www.lyx.org/trac/ticket/3189
-                       return 0;
+                       return nullptr;
                else
                        return prevAtom().nucleus();
        }
@@ -142,7 +132,7 @@ Inset * DocIterator::prevInset() const
 
 Inset * DocIterator::realInset() const
 {
-       LASSERT(inTexted(), /**/);
+       LASSERT(inTexted(), return nullptr);
        // if we are in a tabular, we need the cell
        if (inset().lyxCode() == TABULAR_CODE) {
                InsetTabular * tabular = inset().asInsetTabular();
@@ -152,6 +142,18 @@ Inset * DocIterator::realInset() const
 }
 
 
+InsetMath & DocIterator::nextMath()
+{
+       return *nextAtom().nucleus();
+}
+
+
+InsetMath & DocIterator::prevMath()
+{
+       return *prevAtom().nucleus();
+}
+
+
 MathAtom & DocIterator::prevAtom() const
 {
        LASSERT(!empty(), /**/);
@@ -171,41 +173,72 @@ MathAtom & DocIterator::nextAtom() const
 
 Text * DocIterator::text() const
 {
-       LASSERT(!empty(), /**/);
+       LASSERT(!empty(), return nullptr);
        return top().text();
 }
 
 
 Paragraph & DocIterator::paragraph() const
 {
-       if (!inTexted())
+       if (!inTexted()) {
                LYXERR0(*this);
-       LASSERT(inTexted(), /**/);
+               LBUFERR(false);
+       }
        return top().paragraph();
 }
 
 
 Paragraph & DocIterator::innerParagraph() const
 {
-       LASSERT(!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
 {
-       LASSERT(!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.
-       LASSERT(false, /**/);
-       static CursorSlice dummy;
-       return dummy;
+       LBUFERR(false);
+       // Squash warning
+       static const CursorSlice c;
+       return c;
+}
+
+
+docstring DocIterator::paragraphGotoArgument() const
+{
+       CursorSlice const & s = innerTextSlice();
+       return convert<docstring>(s.paragraph().id()) + ' ' +
+               convert<docstring>(s.pos());
+}
+
+
+DocIterator DocIterator::getInnerText() const
+{
+       DocIterator texted = *this;
+       while (!texted.inTexted())
+               texted.pop_back();
+       return texted;
 }
 
 
@@ -221,7 +254,7 @@ pos_type DocIterator::lastpos() const
 }
 
 
-DocIterator::idx_type DocIterator::lastidx() const
+idx_type DocIterator::lastidx() const
 {
        return top().lastidx();
 }
@@ -248,13 +281,13 @@ size_t DocIterator::nrows() const
 }
 
 
-DocIterator::row_type DocIterator::row() const
+row_type DocIterator::row() const
 {
        return top().row();
 }
 
 
-DocIterator::col_type DocIterator::col() const
+col_type DocIterator::col() const
 {
        return top().col();
 }
@@ -269,7 +302,7 @@ MathData & DocIterator::cell() const
 
 Text * DocIterator::innerText() const
 {
-       LASSERT(!empty(), /**/);
+       LASSERT(!empty(), return nullptr);
        return innerTextSlice().text();
 }
 
@@ -279,7 +312,25 @@ Inset * DocIterator::innerInsetOfType(int code) const
        for (int i = depth() - 1; i >= 0; --i)
                if (slices_[i].inset_->lyxCode() == code)
                        return slices_[i].inset_;
-       return 0;
+       return nullptr;
+}
+
+
+bool DocIterator::posBackward()
+{
+       if (pos() == 0)
+               return false;
+       --pos();
+       return true;
+}
+
+
+bool DocIterator::posForward()
+{
+       if (pos() == lastpos())
+               return false;
+       ++pos();
+       return true;
 }
 
 
@@ -299,7 +350,7 @@ void DocIterator::forwardPos()
        // not at cell/paragraph end?
        if (tip.pos() != tip.lastpos()) {
                // move into an inset to the right if possible
-               Inset * n = 0;
+               Inset * n = nullptr;
                if (inMathed())
                        n = (tip.cell().begin() + tip.pos())->nucleus();
                else
@@ -418,7 +469,7 @@ void DocIterator::backwardPos()
                return;
 
        // move into an inset to the left if possible
-       Inset * n = 0;
+       Inset * n = nullptr;
        if (inMathed())
                n = (top().cell().begin() + top().pos())->nucleus();
        else
@@ -432,6 +483,37 @@ void DocIterator::backwardPos()
 }
 
 
+void DocIterator::backwardPosIgnoreCollapsed()
+{
+       backwardPos();
+       if (inTexted()) {
+               Inset const * ins = realInset();
+               if (ins && !ins->editable()) {
+                       pop_back(); // move out of collapsed inset
+               }
+       }
+}
+
+
+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();
+       }
+}
+
+
 bool DocIterator::hasPart(DocIterator const & it) const
 {
        // it can't be a part if it is larger
@@ -443,6 +525,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.
@@ -451,7 +546,12 @@ void DocIterator::updateInsets(Inset * inset)
        size_t const n = slices_.size();
        slices_.resize(0);
        for (size_t i = 0 ; i < n; ++i) {
-               LASSERT(inset, /**/);
+               if (dit[i].empty() && pos() > 0 && prevMath().lyxCode() == MATH_SCRIPT_CODE)
+                       // Workaround: With empty optional argument and a trailing script,
+                       // we have empty slices in math macro args (#11676)
+                       // FIXME: Find real cause!
+                       continue;
+               LBUFERR(inset);
                push_back(dit[i]);
                top().inset_ = inset;
                if (i + 1 != n)
@@ -466,7 +566,7 @@ bool DocIterator::fixIfBroken()
        if (empty())
                return false;
 
-       // Go through the slice stack from the bottom. 
+       // 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();
@@ -474,7 +574,7 @@ 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().isActive()) {
                        // the whole slice is wrong, chop off this as well
                        --i;
                        LYXERR(Debug::DEBUG, "fixIfBroken(): inset changed");
@@ -518,6 +618,57 @@ bool DocIterator::fixIfBroken()
 }
 
 
+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 == nullptr) {
+                       // FIXME
+                       LYXERR0("Null inset on cursor stack.");
+                       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();
+       }
+}
+
+
+bool DocIterator::isInside(Inset const * p) const
+{
+       for (CursorSlice const & sl : slices_)
+               if (&sl.inset() == p)
+                       return true;
+       return false;
+}
+
+
+void DocIterator::leaveInset(Inset const & inset)
+{
+       for (size_t i = 0; i != slices_.size(); ++i) {
+               if (&slices_[i].inset() == &inset) {
+                       resize(i);
+                       return;
+               }
+       }
+}
+
+
 int DocIterator::find(MathData const & cell) const
 {
        for (size_t l = 0; l != slices_.size(); ++l) {
@@ -528,7 +679,7 @@ int DocIterator::find(MathData const & cell) const
 }
 
 
-int DocIterator::find(Inset const * inset) const 
+int DocIterator::find(Inset const * inset) const
 {
        for (size_t l = 0; l != slices_.size(); ++l) {
                if (&slices_[l].inset() == inset)
@@ -551,13 +702,13 @@ void DocIterator::cutOff(int above)
 }
 
 
-void DocIterator::append(vector<CursorSlice> const & x) 
+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) 
+void DocIterator::append(idx_type idx, pos_type pos)
 {
        slices_.push_back(CursorSlice());
        top().idx() = idx;
@@ -565,6 +716,73 @@ void DocIterator::append(DocIterator::idx_type idx, pos_type pos)
 }
 
 
+docstring DocIterator::getPossibleLabel() const
+{
+       return inMathed() ? from_ascii("eq:") : text()->getPossibleLabel(*this);
+}
+
+
+Encoding const * DocIterator::getEncoding() const
+{
+       if (empty())
+               return nullptr;
+
+       BufferParams const & bp = buffer()->params();
+       if (bp.useNonTeXFonts)
+               return encodings.fromLyXName("utf8-plain");
+
+       // With platex, we don't switch encodings (not even if forced).
+       if (bp.encoding().package() == Encoding::japanese)
+               return &bp.encoding();
+
+       CursorSlice const & sl = innerTextSlice();
+       Text const & text = *sl.text();
+       Language const * lang =
+               text.getPar(sl.pit()).getFont(bp, sl.pos(), text.outerFont(sl.pit())).language();
+       // If we have a custom encoding for the buffer, we don't switch
+       // encodings (see output_latex::switchEncoding())
+       bool const customenc = bp.inputenc != "auto-legacy" && bp.inputenc != "auto-legacy-plain";
+       Encoding const * enc = customenc ? &bp.encoding() : lang->encoding();
+
+       // Some insets force specific encodings sometimes (e.g., listings in
+       // multibyte context forces singlebyte).
+       if (inset().forcedEncoding(enc, encodings.fromLyXName("iso8859-1"))) {
+               // Get the language outside the inset
+               size_t const n = depth();
+               for (size_t i = 0; i < n; ++i) {
+                       Text const & otext = *slices_[i].text();
+                       Language const * olang =
+                                       otext.getPar(slices_[i].pit()).getFont(bp, slices_[i].pos(),
+                                                                              otext.outerFont(slices_[i].pit())).language();
+                       Encoding const * oenc = olang->encoding();
+                       if (oenc->name() != "inherit")
+                               return inset().forcedEncoding(enc, oenc);
+               }
+               // Fall back to buffer encoding if no outer lang was found.
+               return inset().forcedEncoding(enc, &bp.encoding());
+       }
+
+       // Inherited encoding (latex_language) is determined by the context
+       // Look for the first outer encoding that is not itself "inherit"
+       if (lang->encoding()->name() == "inherit") {
+               size_t const n = depth();
+               for (size_t i = 0; i < n; ++i) {
+                       Text const & otext = *slices_[i].text();
+                       Language const * olang =
+                                       otext.getPar(slices_[i].pit()).getFont(bp, slices_[i].pos(),
+                                                                              otext.outerFont(slices_[i].pit())).language();
+                       // Again, if we have a custom encoding, this is used
+                       // instead of the language's.
+                       Encoding const * oenc = customenc ? &bp.encoding() : olang->encoding();
+                       if (olang->encoding()->name() != "inherit")
+                               return oenc;
+               }
+       }
+
+       return enc;
+}
+
+
 ostream & operator<<(ostream & os, DocIterator const & dit)
 {
        for (size_t i = 0, n = dit.depth(); i != n; ++i)
@@ -575,39 +793,19 @@ ostream & operator<<(ostream & os, DocIterator const & dit)
 
 ///////////////////////////////////////////////////////
 
-StableDocIterator::StableDocIterator(DocIterator const & dit)
+StableDocIterator::StableDocIterator(DocIterator const & dit) :
+       data_(dit.internalData())
 {
-       data_ = dit.internalData();
        for (size_t i = 0, n = data_.size(); i != n; ++i)
-               data_[i].inset_ = 0;
+               data_[i].inset_ = nullptr;
 }
 
 
 DocIterator StableDocIterator::asDocIterator(Buffer * buf) const
 {
-       // this function re-creates the cache of inset pointers
-       //lyxerr << "converting:\n" << *this << endl;
-       Inset * inset = &buf->inset();
-       DocIterator dit = DocIterator(buf, 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;
 }