]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.cpp
Correct the mess introduced in r33250.
[lyx.git] / src / Buffer.cpp
index 6568fab364f54b1e49c508bbc237bada3a1a827a..1b52e248d9d5cf2d01a48b5b5add6109d5d6c89d 100644 (file)
@@ -147,7 +147,7 @@ class BufferSet : public std::set<Buffer const *> {};
 class Buffer::Impl
 {
 public:
-       Impl(Buffer & parent, FileName const & file, bool readonly, Buffer const * cloned_buffer);
+       Impl(Buffer * owner, FileName const & file, bool readonly, Buffer const * cloned_buffer);
 
        ~Impl()
        {
@@ -158,6 +158,25 @@ public:
                delete inset;
        }
 
+       /// search for macro in local (buffer) table or in children
+       MacroData const * getBufferMacro(docstring const & name,
+               DocIterator const & pos) const;
+
+       /// Update macro table starting with position of it \param it in some
+       /// text inset.
+       void updateMacros(DocIterator & it, DocIterator & scope);
+       ///
+       void setLabel(ParIterator & it, UpdateType utype) const;
+       ///
+       void collectRelatives(BufferSet & bufs) const;
+
+       /** If we have branches that use the file suffix
+           feature, return the file name with suffix appended.
+       */
+       support::FileName exportFileName() const;
+
+       Buffer * owner_;
+
        BufferParams params;
        LyXVC lyxvc;
        FileName temppath;
@@ -197,7 +216,8 @@ public:
        /// map from the macro name to the position map,
        /// which maps the macro definition position to the scope and the MacroData.
        NamePositionScopeMacroMap macros;
-       bool macro_lock;
+       /// This seem to change the way Buffer::getMacro() works
+       mutable bool macro_lock;
 
        /// positions of child buffers in the buffer
        typedef map<Buffer const * const, DocIterator> BufferPositionMap;
@@ -218,6 +238,8 @@ public:
 
        ///
        frontend::WorkAreaManager * wa_;
+       ///
+       frontend::GuiBufferDelegate * gui_;
 
        ///
        Undo undo_;
@@ -292,17 +314,17 @@ static FileName createBufferTmpDir()
 }
 
 
-Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_,
+Buffer::Impl::Impl(Buffer * owner, FileName const & file, bool readonly_,
        Buffer const * cloned_buffer)
-       : lyx_clean(true), bak_clean(true), unnamed(false),
+       : owner_(owner), lyx_clean(true), bak_clean(true), unnamed(false),
          read_only(readonly_), filename(file), file_fully_loaded(false),
-         toc_backend(&parent), macro_lock(false), timestamp_(0),
-         checksum_(0), wa_(0), undo_(parent), bibinfo_cache_valid_(false),
+         toc_backend(owner), macro_lock(false), timestamp_(0),
+         checksum_(0), wa_(0), gui_(0), undo_(*owner), bibinfo_cache_valid_(false),
          cloned_buffer_(cloned_buffer), parent_buffer(0)
 {
        if (!cloned_buffer_) {
                temppath = createBufferTmpDir();
-               lyxvc.setBuffer(&parent);
+               lyxvc.setBuffer(owner_);
                if (use_gui)
                        wa_ = new frontend::WorkAreaManager;
                return;
@@ -318,7 +340,7 @@ Buffer::Impl::Impl(Buffer & parent, FileName const & file, bool readonly_,
 
 
 Buffer::Buffer(string const & file, bool readonly, Buffer const * cloned_buffer)
-       : d(new Impl(*this, FileName(file), readonly, cloned_buffer)), gui_(0)
+       : d(new Impl(this, FileName(file), readonly, cloned_buffer))
 {
        LYXERR(Debug::INFO, "Buffer::Buffer()");
        if (cloned_buffer) {
@@ -344,7 +366,7 @@ Buffer::~Buffer()
        // saved properly, before it goes into the void.
 
        // GuiView already destroyed
-       gui_ = 0;
+       d->gui_ = 0;
 
        if (isInternal()) {
                // No need to do additional cleanups for internal buffer.
@@ -522,23 +544,23 @@ void Buffer::setChild(DocIterator const & dit, Buffer * child)
 string Buffer::latexName(bool const no_path) const
 {
        FileName latex_name =
-               makeLatexName(exportFileName());
+               makeLatexName(d->exportFileName());
        return no_path ? latex_name.onlyFileName()
                : latex_name.absFilename();
 }
 
 
-FileName Buffer::exportFileName() const
+FileName Buffer::Impl::exportFileName() const
 {
        docstring const branch_suffix =
-               params().branchlist().getFilenameSuffix();
+               params.branchlist().getFilenameSuffix();
        if (branch_suffix.empty())
-               return fileName();
+               return filename;
 
-       string const name = fileName().onlyFileNameWithoutExt()
+       string const name = filename.onlyFileNameWithoutExt()
                + to_utf8(branch_suffix);
-       FileName res(fileName().onlyPath().absFilename() + "/" + name);
-       res.changeExtension(fileName().extension());
+       FileName res(filename.onlyPath().absFilename() + "/" + name);
+       res.changeExtension(filename.extension());
 
        return res;
 }
@@ -603,7 +625,7 @@ void Buffer::setReadonly(bool const flag)
 {
        if (d->read_only != flag) {
                d->read_only = flag;
-               setReadOnly(flag);
+               changed(false);
        }
 }
 
@@ -1498,7 +1520,7 @@ void Buffer::writeLyXHTMLSource(odocstream & os,
 {
        LaTeXFeatures features(*this, params(), runparams);
        validate(features);
-       updateLabels(UpdateMaster, true);
+       updateLabels(UpdateMaster, OutputUpdate);
        checkBibInfoCache();
        d->bibinfo_.makeCitationLabels(*this);
        updateMacros();
@@ -2214,12 +2236,6 @@ bool Buffer::isClean() const
 }
 
 
-bool Buffer::isBakClean() const
-{
-       return d->bak_clean;
-}
-
-
 bool Buffer::isExternallyModified(CheckMethod method) const
 {
        LASSERT(d->filename.exists(), /**/);
@@ -2255,12 +2271,6 @@ void Buffer::markClean() const
 }
 
 
-void Buffer::markBakClean() const
-{
-       d->bak_clean = true;
-}
-
-
 void Buffer::setUnnamed(bool flag)
 {
        d->unnamed = flag;
@@ -2338,15 +2348,15 @@ Buffer const * Buffer::parent() const
 }
 
 
-void Buffer::collectRelatives(BufferSet & bufs) const
+void Buffer::Impl::collectRelatives(BufferSet & bufs) const
 {
-       bufs.insert(this);
+       bufs.insert(owner_);
        if (parent())
-               parent()->collectRelatives(bufs);
+               parent()->d->collectRelatives(bufs);
 
        // loop over children
-       Impl::BufferPositionMap::iterator it = d->children_positions.begin();
-       Impl::BufferPositionMap::iterator end = d->children_positions.end();
+       BufferPositionMap::const_iterator it = children_positions.begin();
+       BufferPositionMap::const_iterator end = children_positions.end();
        for (; it != end; ++it)
                bufs.insert(const_cast<Buffer *>(it->first));
 }
@@ -2355,7 +2365,7 @@ void Buffer::collectRelatives(BufferSet & bufs) const
 std::vector<Buffer const *> Buffer::allRelatives() const
 {
        BufferSet bufs;
-       collectRelatives(bufs);
+       d->collectRelatives(bufs);
        BufferSet::iterator it = bufs.begin();
        std::vector<Buffer const *> ret;
        for (; it != bufs.end(); ++it)
@@ -2418,12 +2428,12 @@ std::vector<Buffer *> Buffer::getChildren(bool grand_children) const
 
 
 template<typename M>
-typename M::iterator greatest_below(M & m, typename M::key_type const & x)
+typename M::const_iterator greatest_below(M & m, typename M::key_type const & x)
 {
        if (m.empty())
                return m.end();
 
-       typename M::iterator it = m.lower_bound(x);
+       typename M::const_iterator it = m.lower_bound(x);
        if (it == m.begin())
                return m.end();
 
@@ -2432,7 +2442,7 @@ typename M::iterator greatest_below(M & m, typename M::key_type const & x)
 }
 
 
-MacroData const * Buffer::getBufferMacro(docstring const & name,
+MacroData const * Buffer::Impl::getBufferMacro(docstring const & name,
                                         DocIterator const & pos) const
 {
        LYXERR(Debug::MACROS, "Searching for " << to_ascii(name) << " at " << pos);
@@ -2442,15 +2452,14 @@ MacroData const * Buffer::getBufferMacro(docstring const & name,
                return 0;
 
        // we haven't found anything yet
-       DocIterator bestPos = par_iterator_begin();
+       DocIterator bestPos = owner_->par_iterator_begin();
        MacroData const * bestData = 0;
 
        // find macro definitions for name
-       Impl::NamePositionScopeMacroMap::iterator nameIt
-               = d->macros.find(name);
-       if (nameIt != d->macros.end()) {
+       NamePositionScopeMacroMap::const_iterator nameIt = macros.find(name);
+       if (nameIt != macros.end()) {
                // find last definition in front of pos or at pos itself
-               Impl::PositionScopeMacroMap::const_iterator it
+               PositionScopeMacroMap::const_iterator it
                        = greatest_below(nameIt->second, pos);
                if (it != nameIt->second.end()) {
                        while (true) {
@@ -2473,9 +2482,9 @@ MacroData const * Buffer::getBufferMacro(docstring const & name,
        }
 
        // find macros in included files
-       Impl::PositionScopeBufferMap::const_iterator it
-               = greatest_below(d->position_to_children, pos);
-       if (it == d->position_to_children.end())
+       PositionScopeBufferMap::const_iterator it
+               = greatest_below(position_to_children, pos);
+       if (it == position_to_children.end())
                // no children before
                return bestData;
 
@@ -2487,10 +2496,10 @@ MacroData const * Buffer::getBufferMacro(docstring const & name,
                // scope ends behind pos?
                if (pos < it->second.first) {
                        // look for macro in external file
-                       d->macro_lock = true;
+                       macro_lock = true;
                        MacroData const * data
-                       = it->second.second->getMacro(name, false);
-                       d->macro_lock = false;
+                               = it->second.second->getMacro(name, false);
+                       macro_lock = false;
                        if (data) {
                                bestPos = it->first;
                                bestData = data;
@@ -2499,7 +2508,7 @@ MacroData const * Buffer::getBufferMacro(docstring const & name,
                }
 
                // try previous file if there is one
-               if (it == d->position_to_children.begin())
+               if (it == position_to_children.begin())
                        break;
                --it;
        }
@@ -2516,7 +2525,7 @@ MacroData const * Buffer::getMacro(docstring const & name,
                return 0;
 
        // query buffer macros
-       MacroData const * data = getBufferMacro(name, pos);
+       MacroData const * data = d->getBufferMacro(name, pos);
        if (data != 0)
                return data;
 
@@ -2564,7 +2573,7 @@ MacroData const * Buffer::getMacro(docstring const & name,
 }
 
 
-void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
+void Buffer::Impl::updateMacros(DocIterator & it, DocIterator & scope)
 {
        pit_type const lastpit = it.lastpit();
 
@@ -2601,20 +2610,20 @@ void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
                                // get buffer of external file
                                InsetInclude const & inset =
                                        static_cast<InsetInclude const &>(*iit->inset);
-                               d->macro_lock = true;
+                               macro_lock = true;
                                Buffer * child = inset.getChildBuffer();
-                               d->macro_lock = false;
+                               macro_lock = false;
                                if (!child)
                                        continue;
 
                                // register its position, but only when it is
                                // included first in the buffer
-                               if (d->children_positions.find(child) ==
-                                       d->children_positions.end())
-                                               d->children_positions[child] = it;
+                               if (children_positions.find(child) ==
+                                       children_positions.end())
+                                               children_positions[child] = it;
 
                                // register child with its scope
-                               d->position_to_children[it] = Impl::ScopeBuffer(scope, child);
+                               position_to_children[it] = Impl::ScopeBuffer(scope, child);
                                continue;
                        }
 
@@ -2624,7 +2633,7 @@ void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
                        // get macro data
                        MathMacroTemplate & macroTemplate =
                                static_cast<MathMacroTemplate &>(*iit->inset);
-                       MacroContext mc(this, it);
+                       MacroContext mc(owner_, it);
                        macroTemplate.updateToContext(mc);
 
                        // valid?
@@ -2638,8 +2647,8 @@ void Buffer::updateMacros(DocIterator & it, DocIterator & scope) const
                        // register macro
                        // FIXME (Abdel), I don't understandt why we pass 'it' here
                        // instead of 'macroTemplate' defined above... is this correct?
-                       d->macros[macroTemplate.name()][it] =
-                               Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(this), it));
+                       macros[macroTemplate.name()][it] =
+                               Impl::ScopeMacro(scope, MacroData(const_cast<Buffer *>(owner_), it));
                }
 
                // next paragraph
@@ -2668,7 +2677,7 @@ void Buffer::updateMacros() const
        DocIterator it = par_iterator_begin();
        DocIterator outerScope = it;
        outerScope.pit() = outerScope.lastpit() + 2;
-       updateMacros(it, outerScope);
+       d->updateMacros(it, outerScope);
 }
 
 
@@ -2919,43 +2928,36 @@ ErrorList & Buffer::errorList(string const & type) const
 void Buffer::updateTocItem(std::string const & type,
        DocIterator const & dit) const
 {
-       if (gui_)
-               gui_->updateTocItem(type, dit);
+       if (d->gui_)
+               d->gui_->updateTocItem(type, dit);
 }
 
 
 void Buffer::structureChanged() const
 {
-       if (gui_)
-               gui_->structureChanged();
+       if (d->gui_)
+               d->gui_->structureChanged();
 }
 
 
 void Buffer::errors(string const & err, bool from_master) const
 {
-       if (gui_)
-               gui_->errors(err, from_master);
+       if (d->gui_)
+               d->gui_->errors(err, from_master);
 }
 
 
 void Buffer::message(docstring const & msg) const
 {
-       if (gui_)
-               gui_->message(msg);
+       if (d->gui_)
+               d->gui_->message(msg);
 }
 
 
 void Buffer::setBusy(bool on) const
 {
-       if (gui_)
-               gui_->setBusy(on);
-}
-
-
-void Buffer::setReadOnly(bool on) const
-{
-       if (d->wa_)
-               d->wa_->setReadOnly(on);
+       if (d->gui_)
+               d->gui_->setBusy(on);
 }
 
 
@@ -2968,20 +2970,20 @@ void Buffer::updateTitles() const
 
 void Buffer::resetAutosaveTimers() const
 {
-       if (gui_)
-               gui_->resetAutosaveTimers();
+       if (d->gui_)
+               d->gui_->resetAutosaveTimers();
 }
 
 
 bool Buffer::hasGuiDelegate() const
 {
-       return gui_;
+       return d->gui_;
 }
 
 
 void Buffer::setGuiDelegate(frontend::GuiBufferDelegate * gui)
 {
-       gui_ = gui;
+       d->gui_ = gui;
 }
 
 
@@ -3104,7 +3106,7 @@ void Buffer::moveAutosaveFile(support::FileName const & oldauto) const
 // Perfect target for a thread...
 void Buffer::autoSave() const
 {
-       if (isBakClean() || isReadonly()) {
+       if (d->bak_clean || isReadonly()) {
                // We don't save now, but we'll try again later
                resetAutosaveTimers();
                return;
@@ -3115,7 +3117,8 @@ void Buffer::autoSave() const
        AutoSaveBuffer autosave(*this, getAutosaveFilename());
        autosave.start();
 
-       markBakClean();
+       d->bak_clean = true;
+
        resetAutosaveTimers();
 }
 
@@ -3266,20 +3269,23 @@ bool Buffer::doExport(string const & format, bool put_in_tempdir,
                return true;
        }
 
-       result_file = changeExtension(exportFileName().absFilename(), ext);
+       result_file = changeExtension(d->exportFileName().absFilename(), ext);
        // We need to copy referenced files (e. g. included graphics
        // if format == "dvi") to the result dir.
        vector<ExportedFile> const files =
                runparams.exportdata->externalFiles(format);
        string const dest = onlyPath(result_file);
        CopyStatus status = SUCCESS;
-       for (vector<ExportedFile>::const_iterator it = files.begin();
-               it != files.end() && status != CANCEL; ++it) {
+       
+       vector<ExportedFile>::const_iterator it = files.begin();
+       vector<ExportedFile>::const_iterator const en = files.end();
+       for (; it != en && status != CANCEL; ++it) {
                string const fmt = formats.getFormatFromFile(it->sourceName);
                status = copyFile(fmt, it->sourceName,
                        makeAbsPath(it->exportName, dest),
                        it->exportName, status == FORCE);
        }
+
        if (status == CANCEL) {
                message(_("Document export cancelled."));
        } else if (tmp_result_file.exists()) {
@@ -3500,7 +3506,7 @@ void Buffer::setBuffersForInsets() const
 }
 
 
-void Buffer::updateLabels(UpdateScope scope, bool out) const
+void Buffer::updateLabels(UpdateScope scope, UpdateType utype) const
 {
        // Use the master text class also for child documents
        Buffer const * const master = masterBuffer();
@@ -3518,10 +3524,10 @@ void Buffer::updateLabels(UpdateScope scope, bool out) const
                // If this is a child document start with the master
                if (master != this) {
                        bufToUpdate.insert(this);
-                       master->updateLabels(UpdateMaster, out);
+                       master->updateLabels(UpdateMaster, utype);
                        // Do this here in case the master has no gui associated with it. Then, 
                        // the TocModel is not updated and TocModel::toc_ is invalid (bug 5699).
-                       if (!master->gui_)
+                       if (!master->d->gui_)
                                structureChanged();
 
                        // was buf referenced from the master (i.e. not in bufToUpdate anymore)?
@@ -3546,7 +3552,7 @@ void Buffer::updateLabels(UpdateScope scope, bool out) const
 
        // do the real work
        ParIterator parit = cbuf.par_iterator_begin();
-       updateLabels(parit, out);
+       updateLabels(parit, utype);
 
        if (master != this)
                // TocBackend update will be done later.
@@ -3628,9 +3634,9 @@ static bool needEnumCounterReset(ParIterator const & it)
 
 
 // set the label of a paragraph. This includes the counters.
-void Buffer::setLabel(ParIterator & it, bool for_output) const
+void Buffer::Impl::setLabel(ParIterator & it, UpdateType utype) const
 {
-       BufferParams const & bp = this->masterBuffer()->params();
+       BufferParams const & bp = owner_->masterBuffer()->params();
        DocumentClass const & textclass = bp.documentClass();
        Paragraph & par = it.paragraph();
        Layout const & layout = par.layout();
@@ -3660,7 +3666,7 @@ void Buffer::setLabel(ParIterator & it, bool for_output) const
                if (layout.toclevel <= bp.secnumdepth
                    && (layout.latextype != LATEX_ENVIRONMENT
                        || it.text()->isFirstInSequence(it.pit()))) {
-                       counters.step(layout.counter, for_output);
+                       counters.step(layout.counter, utype);
                        par.params().labelString(
                                par.expandLabel(layout, bp));
                } else
@@ -3714,7 +3720,7 @@ void Buffer::setLabel(ParIterator & it, bool for_output) const
                // Maybe we have to reset the enumeration counter.
                if (needEnumCounterReset(it))
                        counters.reset(enumcounter);
-               counters.step(enumcounter, for_output);
+               counters.step(enumcounter, utype);
 
                string const & lang = par.getParLanguage(bp)->code();
                par.params().labelString(counters.theCounter(enumcounter, lang));
@@ -3726,12 +3732,12 @@ void Buffer::setLabel(ParIterator & it, bool for_output) const
                string const & type = counters.current_float();
                docstring full_label;
                if (type.empty())
-                       full_label = this->B_("Senseless!!! ");
+                       full_label = owner_->B_("Senseless!!! ");
                else {
-                       docstring name = this->B_(textclass.floats().getType(type).name());
+                       docstring name = owner_->B_(textclass.floats().getType(type).name());
                        if (counters.hasCounter(from_utf8(type))) {
                                string const & lang = par.getParLanguage(bp)->code();
-                               counters.step(from_utf8(type), for_output);
+                               counters.step(from_utf8(type), utype);
                                full_label = bformat(from_ascii("%1$s %2$s:"), 
                                                     name, 
                                                     counters.theCounter(from_utf8(type), lang));
@@ -3757,7 +3763,7 @@ void Buffer::setLabel(ParIterator & it, bool for_output) const
 }
 
 
-void Buffer::updateLabels(ParIterator & parit, bool out) const
+void Buffer::updateLabels(ParIterator & parit, UpdateType utype) const
 {
        LASSERT(parit.pit() == 0, /**/);
 
@@ -3774,7 +3780,7 @@ void Buffer::updateLabels(ParIterator & parit, bool out) const
                parit->params().depth(min(parit->params().depth(), maxdepth));
                maxdepth = parit->getMaxDepthAfter();
 
-               if (out) {
+               if (utype == OutputUpdate) {
                        // track the active counters
                        // we have to do this for the master buffer, since the local
                        // buffer isn't tracking anything.
@@ -3783,14 +3789,14 @@ void Buffer::updateLabels(ParIterator & parit, bool out) const
                }
                
                // set the counter for this paragraph
-               setLabel(parit, out);
+               d->setLabel(parit, utype);
 
                // now the insets
                InsetList::const_iterator iit = parit->insetList().begin();
                InsetList::const_iterator end = parit->insetList().end();
                for (; iit != end; ++iit) {
                        parit.pos() = iit->pos;
-                       iit->inset->updateLabels(parit, out);
+                       iit->inset->updateLabels(parit, utype);
                }
        }
 }