]> git.lyx.org Git - lyx.git/blobdiff - src/BufferView.C
Fix loop when opening TOC widget in an empty document, basically by Richard Heck.
[lyx.git] / src / BufferView.C
index 78e2dc659af7434dff8ec0833f51c53ac8a35129..ada9cd1171d08a805eb03c8a73aa7088ab7343fb 100644 (file)
@@ -145,7 +145,7 @@ Buffer * BufferView::buffer() const
 
 void BufferView::setBuffer(Buffer * b)
 {
-       lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
+       LYXERR(Debug::INFO) << BOOST_CURRENT_FUNCTION
                            << "[ b = " << b << "]" << endl;
 
        if (buffer_) {
@@ -159,17 +159,22 @@ void BufferView::setBuffer(Buffer * b)
                        BookmarksSection::Bookmark const & bm = LyX::ref().session().bookmarks().bookmark(i);
                        if (buffer()->fileName() != bm.filename.absFilename())
                                continue;
-                       // if par_id or pit has been changed, reset par_pit and par_id
+                       // if top_id or bottom_pit, bottom_pos has been changed, update bookmark
                        // see http://bugzilla.lyx.org/show_bug.cgi?id=3092
                        pit_type new_pit;
+                       pos_type new_pos;
                        int new_id;
-                       boost::tie(new_pit, new_id) = moveToPosition(bm.par_pit, bm.par_id, bm.par_pos);
-                       if (bm.par_pit != new_pit || bm.par_id != new_id)
-                               const_cast<BookmarksSection::Bookmark &>(bm).setPos(new_pit, new_id);
+                       boost::tie(new_pit, new_pos, new_id) = moveToPosition(bm.bottom_pit, bm.bottom_pos, bm.top_id, bm.top_pos);
+                       if (bm.bottom_pit != new_pit || bm.bottom_pos != new_pos || bm.top_id != new_id )
+                               const_cast<BookmarksSection::Bookmark &>(bm).updatePos(new_pit, new_pos, new_id);
                }
                // current buffer is going to be switched-off, save cursor pos
+               // Ideally, the whole cursor stack should be saved, but session
+               // currently can only handle bottom (whole document) level pit and pos.
+               // That is to say, if a cursor is in a nested inset, it will be
+               // restore to the left of the top level inset.
                LyX::ref().session().lastFilePos().save(FileName(buffer_->fileName()),
-                       boost::tie(cursor_.pit(), cursor_.pos()) );
+                       boost::tie(cursor_.bottom().pit(), cursor_.bottom().pos()) );
        }
 
        // If we're quitting lyx, don't bother updating stuff
@@ -181,7 +186,7 @@ void BufferView::setBuffer(Buffer * b)
        // If we are closing current buffer, switch to the first in
        // buffer list.
        if (!b) {
-               lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
+               LYXERR(Debug::INFO) << BOOST_CURRENT_FUNCTION
                                    << " No Buffer!" << endl;
                // We are closing the buffer, use the first buffer as current
                buffer_ = theBufferList().first();
@@ -196,7 +201,7 @@ void BufferView::setBuffer(Buffer * b)
        offset_ref_ = 0;
 
        if (buffer_) {
-               lyxerr[Debug::INFO] << BOOST_CURRENT_FUNCTION
+               LYXERR(Debug::INFO) << BOOST_CURRENT_FUNCTION
                                    << "Buffer addr: " << buffer_ << endl;
                cursor_.push(buffer_->inset());
                cursor_.resetAnchor();
@@ -278,7 +283,7 @@ bool BufferView::loadLyXFile(FileName const & filename, bool tolastfiles)
                pos_type pos;
                boost::tie(pit, pos) = LyX::ref().session().lastFilePos().load(filename);
                // if successfully move to pit (returned par_id is not zero), update metrics and reset font
-               if (moveToPosition(pit, 0, pos).get<1>()) {
+               if (moveToPosition(pit, pos, 0, 0).get<1>()) {
                        if (fitCursor())
                                updateMetrics(false);
                        buffer_->text().setCurrentFont(cursor_);
@@ -297,7 +302,7 @@ void BufferView::resize()
        if (!buffer_)
                return;
 
-       lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION << endl;
+       LYXERR(Debug::DEBUG) << BOOST_CURRENT_FUNCTION << endl;
 
        updateMetrics(false);
        switchKeyMap();
@@ -338,22 +343,18 @@ bool BufferView::update(Update::flags flags)
        // causes screen update(), I reset last_inset_ to avoid such a problem.
        last_inset_ = 0;
        // This is close to a hot-path.
-       if (lyxerr.debugging(Debug::DEBUG)) {
-               lyxerr[Debug::DEBUG]
-                       << BOOST_CURRENT_FUNCTION
-                       << "[fitcursor = " << (flags & Update::FitCursor)
-                       << ", forceupdate = " << (flags & Update::Force)
-                       << ", singlepar = " << (flags & Update::SinglePar)
-                       << "]  buffer: " << buffer_ << endl;
-       }
+       LYXERR(Debug::DEBUG)
+               << BOOST_CURRENT_FUNCTION
+               << "[fitcursor = " << (flags & Update::FitCursor)
+               << ", forceupdate = " << (flags & Update::Force)
+               << ", singlepar = " << (flags & Update::SinglePar)
+               << "]  buffer: " << buffer_ << endl;
 
        // Check needed to survive LyX startup
        if (!buffer_)
                return false;
 
-       if (lyxerr.debugging(Debug::WORKAREA)) {
-               lyxerr[Debug::WORKAREA] << "BufferView::update" << std::endl;
-       }
+       LYXERR(Debug::WORKAREA) << "BufferView::update" << std::endl;
 
        // Update macro store
        buffer_->buildMacros();
@@ -409,7 +410,7 @@ bool BufferView::update(Update::flags flags)
 void BufferView::updateScrollbar()
 {
        if (!buffer_) {
-               lyxerr[Debug::DEBUG] << BOOST_CURRENT_FUNCTION
+               LYXERR(Debug::DEBUG) << BOOST_CURRENT_FUNCTION
                                     << " no text in updateScrollbar" << endl;
                scrollbarParameters_.reset();
                return;
@@ -424,13 +425,11 @@ void BufferView::updateScrollbar()
                offset_ref_ = 0;
        }
 
-       if (lyxerr.debugging(Debug::GUI)) {
-               lyxerr[Debug::GUI]
-                       << BOOST_CURRENT_FUNCTION
-                       << " Updating scrollbar: height: " << t.paragraphs().size()
-                       << " curr par: " << cursor_.bottom().pit()
-                       << " default height " << defaultRowHeight() << endl;
-       }
+       LYXERR(Debug::GUI)
+               << BOOST_CURRENT_FUNCTION
+               << " Updating scrollbar: height: " << t.paragraphs().size()
+               << " curr par: " << cursor_.bottom().pit()
+               << " default height " << defaultRowHeight() << endl;
 
        // It would be better to fix the scrollbar to understand
        // values in [0..1] and divide everything by wh
@@ -479,7 +478,7 @@ ScrollbarParameters const & BufferView::scrollbarParameters() const
 
 void BufferView::scrollDocView(int value)
 {
-       lyxerr[Debug::GUI] << BOOST_CURRENT_FUNCTION
+       LYXERR(Debug::GUI) << BOOST_CURRENT_FUNCTION
                           << "[ value = " << value << "]" << endl;
 
        if (!buffer_)
@@ -551,46 +550,70 @@ Change const BufferView::getCurrentChange() const
 }
 
 
-void BufferView::saveBookmark(bool persistent)
+void BufferView::saveBookmark(unsigned int idx)
 {
+       // tenatively save bookmark, id and pos will be used to
+       // acturately locate a bookmark in a 'live' lyx session.
+       // pit and pos will be updated with bottom level pit/pos 
+       // when lyx exits.
        LyX::ref().session().bookmarks().save(
                FileName(buffer_->fileName()),
-               cursor_.pit(),
+               cursor_.bottom().pit(),
+               cursor_.bottom().pos(),
                cursor_.paragraph().id(),
                cursor_.pos(),
-               persistent
+               idx
        );
-       if (persistent)
+       if (idx)
                // emit message signal.
                message(_("Save bookmark"));
 }
 
 
-boost::tuple<pit_type, int> BufferView::moveToPosition(pit_type par_pit, int par_id, pos_type par_pos)
+boost::tuple<pit_type, pos_type, int> BufferView::moveToPosition(pit_type bottom_pit, pos_type bottom_pos,
+       int top_id, pos_type top_pos)
 {
        cursor_.clearSelection();
 
        // if a valid par_id is given, try it first
-       if (par_id > 0) {
-               ParIterator par = buffer_->getParFromID(par_id);
+       // This is the case for a 'live' bookmark when unique paragraph ID
+       // is used to track bookmarks.
+       if (top_id > 0) {
+               ParIterator par = buffer_->getParFromID(top_id);
                if (par != buffer_->par_iterator_end()) {
-                       setCursor(makeDocIterator(par, min(par->size(), par_pos)));
-                       return boost::make_tuple(cursor_.pit(), par_id);
+                       DocIterator dit = makeDocIterator(par, min(par->size(), top_pos));
+                       // Some slices of the iterator may not be reachable (e.g. closed collapsable inset)
+                       // so the dociterator may need to be shortened. Otherwise, setCursor may
+                       // crash lyx when the cursor can not be set to these insets.
+                       size_t const n = dit.depth();
+                       for (size_t i = 0; i < n; ++i)
+                               if (dit[i].inset().editable() != InsetBase::HIGHLY_EDITABLE) {
+                                       dit.resize(i);
+                                       break;
+                               }
+                       setCursor(dit);
+                       // Note: return bottom (document) level pit.
+                       return boost::make_tuple(cursor_.bottom().pit(), cursor_.bottom().pos(), top_id);
                }
        }
-       // if par_id == 0, or searching through par_id failed
-       if (static_cast<size_t>(par_pit) < buffer_->paragraphs().size()) {
+       // if top_id == 0, or searching through top_id failed
+       // This is the case for a 'restored' bookmark when only bottom 
+       // (document level) pit was saved. Because of this, bookmark
+       // restoration is inaccurate. If a bookmark was within an inset,
+       // it will be restored to the left of the outmost inset that contains
+       // the bookmark.
+       if (static_cast<size_t>(bottom_pit) < buffer_->paragraphs().size()) {
                ParIterator it = buffer_->par_iterator_begin();
                ParIterator const end = buffer_->par_iterator_end();
                for (; it != end; ++it)
-                       if (it.pit() == par_pit) {
+                       if (it.pit() == bottom_pit) {
                                // restored pos may be bigger than it->size
-                               setCursor(makeDocIterator(it, min(par_pos, it->size())));
-                               return boost::make_tuple(par_pit, it->id());
+                               setCursor(makeDocIterator(it, min(bottom_pos, it->size())));
+                               return boost::make_tuple(bottom_pit, bottom_pos, it->id());
                        }
        }
        // both methods fail
-       return boost::make_tuple(pit_type(0), 0);
+       return boost::make_tuple(pit_type(0), pos_type(0), 0);
 }
 
 
@@ -716,7 +739,7 @@ Update::flags BufferView::dispatch(FuncRequest const & cmd)
        //       << [ cmd = " << cmd << "]" << endl;
 
        // Make sure that the cached BufferView is correct.
-       lyxerr[Debug::ACTION] << BOOST_CURRENT_FUNCTION
+       LYXERR(Debug::ACTION) << BOOST_CURRENT_FUNCTION
                << " action[" << cmd.action << ']'
                << " arg[" << to_utf8(cmd.argument()) << ']'
                << " x[" << cmd.x << ']'
@@ -786,7 +809,7 @@ Update::flags BufferView::dispatch(FuncRequest const & cmd)
                        if (inset) {
                                label = inset->getParam("reference");
                                // persistent=false: use temp_bookmark
-                               saveBookmark(false);
+                               saveBookmark(0);
                        }
                }
 
@@ -801,11 +824,11 @@ Update::flags BufferView::dispatch(FuncRequest const & cmd)
                for (Buffer * b = buffer_; i == 0 || b != buffer_; b = theBufferList().next(b)) {
                        ParIterator par = b->getParFromID(id);
                        if (par == b->par_iterator_end()) {
-                               lyxerr[Debug::INFO]
+                               LYXERR(Debug::INFO)
                                        << "No matching paragraph found! ["
                                        << id << "]." << endl;
                        } else {
-                               lyxerr[Debug::INFO]
+                               LYXERR(Debug::INFO)
                                        << "Paragraph " << par->id()
                                        << " found in buffer `"
                                        << b->fileName() << "'." << endl;
@@ -1084,7 +1107,7 @@ InsetBase const * BufferView::getCoveringInset(LyXText const & text, int x, int
        BOOST_ASSERT(pit != -1);
        Paragraph const & par = text.getPar(pit);
 
-       lyxerr[Debug::DEBUG]
+       LYXERR(Debug::DEBUG)
                << BOOST_CURRENT_FUNCTION
                << ": x: " << x
                << " y: " << y
@@ -1113,13 +1136,13 @@ InsetBase const * BufferView::getCoveringInset(LyXText const & text, int x, int
                                }
                        }
 
-                       lyxerr[Debug::DEBUG]
+                       LYXERR(Debug::DEBUG)
                                << BOOST_CURRENT_FUNCTION
                                << ": Hit inset: " << inset << endl;
                        return inset;
                }
        }
-       lyxerr[Debug::DEBUG]
+       LYXERR(Debug::DEBUG)
                << BOOST_CURRENT_FUNCTION
                << ": No inset hit. " << endl;
        return 0;
@@ -1347,14 +1370,17 @@ bool BufferView::mouseSetCursor(LCursor & cur)
 
        // Has the cursor just left the inset?
        bool badcursor = false;
-       if (&cursor_.inset() != &cur.inset())
+       bool leftinset = (&cursor_.inset() != &cur.inset());
+       if (leftinset)
                badcursor = cursor_.inset().notifyCursorLeaves(cursor_);
 
        // do the dEPM magic if needed
-       // FIXME: move this to InsetText::notifyCursorLeaves?
-       bool update = false;
+       // FIXME: (1) move this to InsetText::notifyCursorLeaves?
+       // FIXME: (2) if we had a working InsetText::notifyCursorLeaves,
+       // the leftinset bool would not be necessary (badcursor instead).
+       bool update = leftinset;
        if (!badcursor && cursor_.inTexted())
-               checkDepm(cur, cursor_);
+               update |= checkDepm(cur, cursor_);
 
        // if the cursor was in an empty script inset and the new
        // position is in the nucleus of the inset, notifyCursorLeaves
@@ -1519,7 +1545,7 @@ void BufferView::updateMetrics(bool singlepar)
                pit2 = cursor_.bottom().pit();
        }
 
-       lyxerr[Debug::DEBUG]
+       LYXERR(Debug::DEBUG)
                << BOOST_CURRENT_FUNCTION
                << " y1: " << y1
                << " y2: " << y2
@@ -1534,7 +1560,7 @@ void BufferView::updateMetrics(bool singlepar)
                singlepar? SingleParUpdate: FullScreenUpdate, size);
 
        if (lyxerr.debugging(Debug::WORKAREA)) {
-               lyxerr[Debug::WORKAREA] << "BufferView::updateMetrics" << endl;
+               LYXERR(Debug::WORKAREA) << "BufferView::updateMetrics" << endl;
                coord_cache_.dump();
        }
 }
@@ -1561,7 +1587,7 @@ void BufferView::menuInsertLyXFile(string const & filenm)
                FileDialog fileDlg(_("Select LyX document to insert"),
                        LFUN_FILE_INSERT,
                        make_pair(_("Documents|#o#O"), from_utf8(lyxrc.document_path)),
-                       make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support(), "examples"))));
+                       make_pair(_("Examples|#E#e"), from_utf8(addPath(package().system_support().absFilename(), "examples"))));
 
                FileDialog::Result result =
                        fileDlg.open(from_utf8(initpath),