2 * \file DocIterator.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Alfredo Braunstein
9 * Full author contact details are available in file CREDITS.
15 #include "DocIterator.h"
18 #include "InsetList.h"
19 #include "Paragraph.h"
23 #include "mathed/MathData.h"
24 #include "mathed/InsetMath.h"
25 #include "mathed/InsetMathHull.h"
27 #include "insets/InsetTabular.h"
29 #include "support/debug.h"
30 #include "support/lassert.h"
31 #include "support/lstrings.h"
36 using namespace lyx::support;
41 DocIterator::DocIterator()
42 : boundary_(false), inset_(0), buffer_(0)
45 // We could be able to get rid of this if only every BufferView were
46 // associated to a buffer on construction.
47 DocIterator::DocIterator(Buffer * buf)
48 : boundary_(false), inset_(0), buffer_(buf)
52 DocIterator::DocIterator(Buffer * buf, Inset * inset)
53 : boundary_(false), inset_(inset), buffer_(buf)
57 DocIterator doc_iterator_begin(const Buffer * buf0, const Inset * inset0)
59 Buffer * buf = const_cast<Buffer *>(buf0);
60 Inset * inset = const_cast<Inset *>(inset0);
61 DocIterator dit(buf, inset ? inset : &buf->inset());
67 DocIterator doc_iterator_end(const Buffer * buf0, const Inset * inset0)
69 Buffer * buf = const_cast<Buffer *>(buf0);
70 Inset * inset = const_cast<Inset *>(inset0);
71 return DocIterator(buf, inset ? inset : &buf->inset());
75 bool DocIterator::inRegexped() const
77 InsetMathHull * i = dynamic_cast<InsetMathHull *>(inset().asInsetMath());
78 return i && i->getType() == hullRegexp;
82 LyXErr & operator<<(LyXErr & os, DocIterator const & it)
89 Inset * DocIterator::nextInset() const
91 LASSERT(!empty(), return 0);
92 if (pos() == lastpos())
94 if (pos() > lastpos()) {
95 LYXERR0("Should not happen, but it does: pos() = "
96 << pos() << ", lastpos() = " << lastpos());
100 return nextAtom().nucleus();
101 return paragraph().getInset(pos());
105 Inset * DocIterator::prevInset() const
107 LASSERT(!empty(), return 0);
112 // FIXME: this should not happen but it does.
114 // http://bugzilla.lyx.org/show_bug.cgi?id=3189
117 return prevAtom().nucleus();
119 return paragraph().getInset(pos() - 1);
123 Inset * DocIterator::realInset() const
125 LASSERT(inTexted(), /**/);
126 // if we are in a tabular, we need the cell
127 if (inset().lyxCode() == TABULAR_CODE) {
128 InsetTabular & tabular = static_cast<InsetTabular&>(inset());
129 return tabular.cell(idx()).get();
135 MathAtom & DocIterator::prevAtom() const
137 LASSERT(!empty(), /**/);
138 LASSERT(pos() > 0, /**/);
139 return cell()[pos() - 1];
143 MathAtom & DocIterator::nextAtom() const
145 LASSERT(!empty(), /**/);
146 //lyxerr << "lastpos: " << lastpos() << " next atom:\n" << *this << endl;
147 LASSERT(pos() < lastpos(), /**/);
148 return cell()[pos()];
152 Text * DocIterator::text() const
154 LASSERT(!empty(), /**/);
159 Paragraph & DocIterator::paragraph() const
163 LASSERT(inTexted(), /**/);
164 return top().paragraph();
168 Paragraph & DocIterator::innerParagraph() const
170 LASSERT(!empty(), /**/);
171 return innerTextSlice().paragraph();
175 CursorSlice const & DocIterator::innerTextSlice() const
177 LASSERT(!empty(), /**/);
178 // go up until first non-0 text is hit
179 // (innermost text is 0 in mathed)
180 for (int i = depth() - 1; i >= 0; --i)
181 if (slices_[i].text())
184 // This case is in principe not possible. We _must_
186 LASSERT(false, /**/);
187 static CursorSlice dummy;
192 pit_type DocIterator::lastpit() const
194 return inMathed() ? 0 : text()->paragraphs().size() - 1;
198 pos_type DocIterator::lastpos() const
200 return inMathed() ? cell().size() : paragraph().size();
204 DocIterator::idx_type DocIterator::lastidx() const
206 return top().lastidx();
210 size_t DocIterator::nargs() const
212 // assume 1x1 grid for main text
213 return top().nargs();
217 size_t DocIterator::ncols() const
219 // assume 1x1 grid for main text
220 return top().ncols();
224 size_t DocIterator::nrows() const
226 // assume 1x1 grid for main text
227 return top().nrows();
231 DocIterator::row_type DocIterator::row() const
237 DocIterator::col_type DocIterator::col() const
243 MathData & DocIterator::cell() const
245 // LASSERT(inMathed(), /**/);
250 Text * DocIterator::innerText() const
252 LASSERT(!empty(), /**/);
253 return innerTextSlice().text();
257 Inset * DocIterator::innerInsetOfType(int code) const
259 for (int i = depth() - 1; i >= 0; --i)
260 if (slices_[i].inset_->lyxCode() == code)
261 return slices_[i].inset_;
266 // This duplicates code above, but is in the critical path.
267 // So please think twice before adding stuff
268 void DocIterator::forwardPos()
270 // this dog bites his tail
272 push_back(CursorSlice(*inset_));
276 CursorSlice & tip = top();
277 //lyxerr << "XXX\n" << *this << endl;
279 // not at cell/paragraph end?
280 if (tip.pos() != tip.lastpos()) {
281 // move into an inset to the right if possible
284 n = (tip.cell().begin() + tip.pos())->nucleus();
286 n = paragraph().getInset(tip.pos());
287 if (n && n->isActive()) {
288 //lyxerr << "... descend" << endl;
289 push_back(CursorSlice(*n));
294 // jump to the next cell/paragraph if possible
300 // otherwise leave inset and jump over inset as a whole
302 // 'tip' is invalid now...
308 void DocIterator::forwardPosIgnoreCollapsed()
310 Inset * const nextinset = nextInset();
311 // FIXME: the check for asInsetMath() shouldn't be necessary
312 // but math insets do not return a sensible editable() state yet.
313 if (nextinset && !nextinset->asInsetMath()
314 && !nextinset->editable()) {
322 void DocIterator::forwardPar()
326 while (!empty() && (!inTexted() || pos() != 0)) {
328 pos_type const lastp = lastpos();
329 Paragraph const & par = paragraph();
330 pos_type & pos = top().pos();
331 if (par.insetList().empty())
334 while (pos < lastp && !par.isInset(pos))
342 void DocIterator::forwardChar()
345 while (!empty() && pos() == lastpos())
350 void DocIterator::forwardInset()
354 while (!empty() && !nextInset()) {
356 pos_type const lastp = lastpos();
357 Paragraph const & par = paragraph();
358 pos_type & pos = top().pos();
359 while (pos < lastp && !par.isInset(pos))
369 void DocIterator::backwardChar()
372 while (!empty() && pos() == lastpos())
377 void DocIterator::backwardPos()
379 //this dog bites his tail
381 push_back(CursorSlice(*inset_));
382 top().idx() = lastidx();
383 top().pit() = lastpit();
384 top().pos() = lastpos();
388 // at inset beginning?
389 if (top().at_begin()) {
396 // entered another cell/paragraph from the right?
397 if (top().pos() == top().lastpos())
400 // move into an inset to the left if possible
403 n = (top().cell().begin() + top().pos())->nucleus();
405 n = paragraph().getInset(top().pos());
406 if (n && n->isActive()) {
407 push_back(CursorSlice(*n));
408 top().idx() = lastidx();
409 top().pit() = lastpit();
410 top().pos() = lastpos();
415 bool DocIterator::hasPart(DocIterator const & it) const
417 // it can't be a part if it is larger
418 if (it.depth() > depth())
421 // as inset adresses are the 'last' level
422 return &it.top().inset() == &slices_[it.depth() - 1].inset();
426 void DocIterator::updateInsets(Inset * inset)
428 // this function re-creates the cache of inset pointers.
429 //lyxerr << "converting:\n" << *this << endl;
430 DocIterator dit = *this;
431 size_t const n = slices_.size();
433 for (size_t i = 0 ; i < n; ++i) {
434 LASSERT(inset, /**/);
436 top().inset_ = inset;
440 //lyxerr << "converted:\n" << *this << endl;
444 bool DocIterator::fixIfBroken()
449 // Go through the slice stack from the bottom.
450 // Check that all coordinates (idx, pit, pos) are correct and
451 // that the inset is the one which is claimed to be there
452 Inset * inset = &slices_[0].inset();
454 size_t n = slices_.size();
455 for (; i != n; ++i) {
456 CursorSlice & cs = slices_[i];
457 if (&cs.inset() != inset) {
458 // the whole slice is wrong, chop off this as well
460 LYXERR(Debug::DEBUG, "fixIfBroken(): inset changed");
462 } else if (cs.idx() > cs.lastidx()) {
463 cs.idx() = cs.lastidx();
464 cs.pit() = cs.lastpit();
465 cs.pos() = cs.lastpos();
466 LYXERR(Debug::DEBUG, "fixIfBroken(): idx fixed");
468 } else if (cs.pit() > cs.lastpit()) {
469 cs.pit() = cs.lastpit();
470 cs.pos() = cs.lastpos();
471 LYXERR(Debug::DEBUG, "fixIfBroken(): pit fixed");
473 } else if (cs.pos() > cs.lastpos()) {
474 cs.pos() = cs.lastpos();
475 LYXERR(Debug::DEBUG, "fixIfBroken(): pos fixed");
477 } else if (i != n - 1 && cs.pos() != cs.lastpos()) {
478 // get inset which is supposed to be in the next slice
479 if (cs.inset().inMathed())
480 inset = (cs.cell().begin() + cs.pos())->nucleus();
481 else if (Inset * csInset = cs.paragraph().getInset(cs.pos()))
484 // there are slices left, so there must be another inset
490 // Did we make it through the whole slice stack? Otherwise there
491 // was a problem at slice i, and we have to chop off above
493 LYXERR(Debug::DEBUG, "fixIfBroken(): cursor chopped at " << i);
501 int DocIterator::find(MathData const & cell) const
503 for (size_t l = 0; l != slices_.size(); ++l) {
504 if (slices_[l].asInsetMath() && &slices_[l].cell() == &cell)
511 int DocIterator::find(Inset const * inset) const
513 for (size_t l = 0; l != slices_.size(); ++l) {
514 if (&slices_[l].inset() == inset)
521 void DocIterator::cutOff(int above, vector<CursorSlice> & cut)
523 cut = vector<CursorSlice>(slices_.begin() + above + 1, slices_.end());
524 slices_.resize(above + 1);
528 void DocIterator::cutOff(int above)
530 slices_.resize(above + 1);
534 void DocIterator::append(vector<CursorSlice> const & x)
536 slices_.insert(slices_.end(), x.begin(), x.end());
540 void DocIterator::append(DocIterator::idx_type idx, pos_type pos)
542 slices_.push_back(CursorSlice());
548 ostream & operator<<(ostream & os, DocIterator const & dit)
550 for (size_t i = 0, n = dit.depth(); i != n; ++i)
551 os << " " << dit[i] << "\n";
556 ///////////////////////////////////////////////////////
558 StableDocIterator::StableDocIterator(DocIterator const & dit)
560 data_ = dit.internalData();
561 for (size_t i = 0, n = data_.size(); i != n; ++i)
566 DocIterator StableDocIterator::asDocIterator(Buffer * buf) const
568 // this function re-creates the cache of inset pointers
569 //lyxerr << "converting:\n" << *this << endl;
570 Inset * inset = &buf->inset();
571 DocIterator dit = DocIterator(buf, inset);
572 for (size_t i = 0, n = data_.size(); i != n; ++i) {
575 LYXERR0(" Should not happen, but does e.g. after "
576 "C-n C-l C-z S-C-z\n"
577 << " or when a Buffer has been concurrently edited by two views"
578 << '\n' << "dit: " << dit << '\n'
579 << " lastpos: " << dit.lastpos());
583 dit.push_back(data_[i]);
584 dit.top().inset_ = inset;
585 if (dit.fixIfBroken())
588 inset = dit.nextInset();
590 //lyxerr << "convert:\n" << *this << " to:\n" << dit << endl;
595 ostream & operator<<(ostream & os, StableDocIterator const & dit)
597 for (size_t i = 0, n = dit.data_.size(); i != n; ++i)
598 os << " " << dit.data_[i] << "\n";
603 bool operator==(StableDocIterator const & dit1, StableDocIterator const & dit2)
605 return dit1.data_ == dit2.data_;