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. ");
99 return nextAtom().nucleus();
100 return paragraph().getInset(pos());
104 Inset * DocIterator::prevInset() const
106 LASSERT(!empty(), return 0);
111 // FIXME: this should not happen but it does.
113 // http://bugzilla.lyx.org/show_bug.cgi?id=3189
116 return prevAtom().nucleus();
118 return paragraph().getInset(pos() - 1);
122 Inset * DocIterator::realInset() const
124 LASSERT(inTexted(), /**/);
125 // if we are in a tabular, we need the cell
126 if (inset().lyxCode() == TABULAR_CODE) {
127 InsetTabular & tabular = static_cast<InsetTabular&>(inset());
128 return tabular.cell(idx()).get();
134 MathAtom & DocIterator::prevAtom() const
136 LASSERT(!empty(), /**/);
137 LASSERT(pos() > 0, /**/);
138 return cell()[pos() - 1];
142 MathAtom & DocIterator::nextAtom() const
144 LASSERT(!empty(), /**/);
145 //lyxerr << "lastpos: " << lastpos() << " next atom:\n" << *this << endl;
146 LASSERT(pos() < lastpos(), /**/);
147 return cell()[pos()];
151 Text * DocIterator::text() const
153 LASSERT(!empty(), /**/);
158 Paragraph & DocIterator::paragraph() const
162 LASSERT(inTexted(), /**/);
163 return top().paragraph();
167 Paragraph & DocIterator::innerParagraph() const
169 LASSERT(!empty(), /**/);
170 return innerTextSlice().paragraph();
174 CursorSlice const & DocIterator::innerTextSlice() const
176 LASSERT(!empty(), /**/);
177 // go up until first non-0 text is hit
178 // (innermost text is 0 in mathed)
179 for (int i = depth() - 1; i >= 0; --i)
180 if (slices_[i].text())
183 // This case is in principe not possible. We _must_
185 LASSERT(false, /**/);
186 static CursorSlice dummy;
191 pit_type DocIterator::lastpit() const
193 return inMathed() ? 0 : text()->paragraphs().size() - 1;
197 pos_type DocIterator::lastpos() const
199 return inMathed() ? cell().size() : paragraph().size();
203 DocIterator::idx_type DocIterator::lastidx() const
205 return top().lastidx();
209 size_t DocIterator::nargs() const
211 // assume 1x1 grid for main text
212 return top().nargs();
216 size_t DocIterator::ncols() const
218 // assume 1x1 grid for main text
219 return top().ncols();
223 size_t DocIterator::nrows() const
225 // assume 1x1 grid for main text
226 return top().nrows();
230 DocIterator::row_type DocIterator::row() const
236 DocIterator::col_type DocIterator::col() const
242 MathData & DocIterator::cell() const
244 // LASSERT(inMathed(), /**/);
249 Text * DocIterator::innerText() const
251 LASSERT(!empty(), /**/);
252 // go up until first non-0 text is hit
253 // (innermost text is 0 in mathed)
254 for (int i = depth() - 1; i >= 0; --i)
255 if (slices_[i].text())
256 return slices_[i].text();
261 Inset * DocIterator::innerInsetOfType(int code) const
263 for (int i = depth() - 1; i >= 0; --i)
264 if (slices_[i].inset_->lyxCode() == code)
265 return slices_[i].inset_;
270 // This duplicates code above, but is in the critical path.
271 // So please think twice before adding stuff
272 void DocIterator::forwardPos()
274 // this dog bites his tail
276 push_back(CursorSlice(*inset_));
280 CursorSlice & tip = top();
281 //lyxerr << "XXX\n" << *this << endl;
283 // not at cell/paragraph end?
284 if (tip.pos() != tip.lastpos()) {
285 // move into an inset to the right if possible
288 n = (tip.cell().begin() + tip.pos())->nucleus();
290 n = paragraph().getInset(tip.pos());
291 if (n && n->isActive()) {
292 //lyxerr << "... descend" << endl;
293 push_back(CursorSlice(*n));
298 // jump to the next cell/paragraph if possible
304 // otherwise leave inset and jump over inset as a whole
306 // 'tip' is invalid now...
312 void DocIterator::forwardPosIgnoreCollapsed()
314 Inset * const nextinset = nextInset();
315 // FIXME: the check for asInsetMath() shouldn't be necessary
316 // but math insets do not return a sensible editable() state yet.
317 if (nextinset && !nextinset->asInsetMath()
318 && !nextinset->editable()) {
326 void DocIterator::forwardPar()
330 while (!empty() && (!inTexted() || pos() != 0)) {
332 pos_type const lastp = lastpos();
333 Paragraph const & par = paragraph();
334 pos_type & pos = top().pos();
335 if (par.insetList().empty())
338 while (pos < lastp && !par.isInset(pos))
346 void DocIterator::forwardChar()
349 while (!empty() && pos() == lastpos())
354 void DocIterator::forwardInset()
358 while (!empty() && !nextInset()) {
360 pos_type const lastp = lastpos();
361 Paragraph const & par = paragraph();
362 pos_type & pos = top().pos();
363 while (pos < lastp && !par.isInset(pos))
373 void DocIterator::backwardChar()
376 while (!empty() && pos() == lastpos())
381 void DocIterator::backwardPos()
383 //this dog bites his tail
385 push_back(CursorSlice(*inset_));
386 top().idx() = lastidx();
387 top().pit() = lastpit();
388 top().pos() = lastpos();
392 // at inset beginning?
393 if (top().at_begin()) {
400 // entered another cell/paragraph from the right?
401 if (top().pos() == top().lastpos())
404 // move into an inset to the left if possible
407 n = (top().cell().begin() + top().pos())->nucleus();
409 n = paragraph().getInset(top().pos());
410 if (n && n->isActive()) {
411 push_back(CursorSlice(*n));
412 top().idx() = lastidx();
413 top().pit() = lastpit();
414 top().pos() = lastpos();
419 bool DocIterator::hasPart(DocIterator const & it) const
421 // it can't be a part if it is larger
422 if (it.depth() > depth())
425 // as inset adresses are the 'last' level
426 return &it.top().inset() == &slices_[it.depth() - 1].inset();
430 void DocIterator::updateInsets(Inset * inset)
432 // this function re-creates the cache of inset pointers.
433 //lyxerr << "converting:\n" << *this << endl;
434 DocIterator dit = *this;
435 size_t const n = slices_.size();
437 for (size_t i = 0 ; i < n; ++i) {
438 LASSERT(inset, /**/);
440 top().inset_ = inset;
444 //lyxerr << "converted:\n" << *this << endl;
448 bool DocIterator::fixIfBroken()
453 // Go through the slice stack from the bottom.
454 // Check that all coordinates (idx, pit, pos) are correct and
455 // that the inset is the one which is claimed to be there
456 Inset * inset = &slices_[0].inset();
458 size_t n = slices_.size();
459 for (; i != n; ++i) {
460 CursorSlice & cs = slices_[i];
461 if (&cs.inset() != inset) {
462 // the whole slice is wrong, chop off this as well
464 LYXERR(Debug::DEBUG, "fixIfBroken(): inset changed");
466 } else if (cs.idx() > cs.lastidx()) {
467 cs.idx() = cs.lastidx();
468 cs.pit() = cs.lastpit();
469 cs.pos() = cs.lastpos();
470 LYXERR(Debug::DEBUG, "fixIfBroken(): idx fixed");
472 } else if (cs.pit() > cs.lastpit()) {
473 cs.pit() = cs.lastpit();
474 cs.pos() = cs.lastpos();
475 LYXERR(Debug::DEBUG, "fixIfBroken(): pit fixed");
477 } else if (cs.pos() > cs.lastpos()) {
478 cs.pos() = cs.lastpos();
479 LYXERR(Debug::DEBUG, "fixIfBroken(): pos fixed");
481 } else if (i != n - 1 && cs.pos() != cs.lastpos()) {
482 // get inset which is supposed to be in the next slice
483 if (cs.inset().inMathed())
484 inset = (cs.cell().begin() + cs.pos())->nucleus();
485 else if (Inset * csInset = cs.paragraph().getInset(cs.pos()))
488 // there are slices left, so there must be another inset
494 // Did we make it through the whole slice stack? Otherwise there
495 // was a problem at slice i, and we have to chop off above
497 LYXERR(Debug::DEBUG, "fixIfBroken(): cursor chopped at " << i);
505 int DocIterator::find(MathData const & cell) const
507 for (size_t l = 0; l != slices_.size(); ++l) {
508 if (slices_[l].asInsetMath() && &slices_[l].cell() == &cell)
515 int DocIterator::find(Inset const * inset) const
517 for (size_t l = 0; l != slices_.size(); ++l) {
518 if (&slices_[l].inset() == inset)
525 void DocIterator::cutOff(int above, vector<CursorSlice> & cut)
527 cut = vector<CursorSlice>(slices_.begin() + above + 1, slices_.end());
528 slices_.resize(above + 1);
532 void DocIterator::cutOff(int above)
534 slices_.resize(above + 1);
538 void DocIterator::append(vector<CursorSlice> const & x)
540 slices_.insert(slices_.end(), x.begin(), x.end());
544 void DocIterator::append(DocIterator::idx_type idx, pos_type pos)
546 slices_.push_back(CursorSlice());
552 ostream & operator<<(ostream & os, DocIterator const & dit)
554 for (size_t i = 0, n = dit.depth(); i != n; ++i)
555 os << " " << dit[i] << "\n";
560 ///////////////////////////////////////////////////////
562 StableDocIterator::StableDocIterator(DocIterator const & dit)
564 data_ = dit.internalData();
565 for (size_t i = 0, n = data_.size(); i != n; ++i)
570 DocIterator StableDocIterator::asDocIterator(Buffer * buf) const
572 // this function re-creates the cache of inset pointers
573 //lyxerr << "converting:\n" << *this << endl;
574 Inset * inset = &buf->inset();
575 DocIterator dit = DocIterator(buf, inset);
576 for (size_t i = 0, n = data_.size(); i != n; ++i) {
579 LYXERR0(" Should not happen, but does e.g. after "
580 "C-n C-l C-z S-C-z\n"
581 << " or when a Buffer has been concurrently edited by two views"
582 << '\n' << "dit: " << dit << '\n'
583 << " lastpos: " << dit.lastpos());
587 dit.push_back(data_[i]);
588 dit.top().inset_ = inset;
589 if (dit.fixIfBroken())
592 inset = dit.nextInset();
594 //lyxerr << "convert:\n" << *this << " to:\n" << dit << endl;
599 ostream & operator<<(ostream & os, StableDocIterator const & dit)
601 for (size_t i = 0, n = dit.data_.size(); i != n; ++i)
602 os << " " << dit.data_[i] << "\n";
607 bool operator==(StableDocIterator const & dit1, StableDocIterator const & dit2)
609 return dit1.data_ == dit2.data_;