Routines for calculating numerical labels for BibTeX citations.

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index af69950eb1a74443136eac2624d64a353c617ef7..f52bb828b8de79914c90e46451c5b0e866954453 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -21,6 +21,7 @@
 #include "support/SignalSlot.h"
 
 #include <list>
+#include <set>
 #include <string>
 #include <vector>
 
@@ -124,11 +125,17 @@ public:
        };
 
        /// Constructor
-       explicit Buffer(std::string const & file, bool b = false);
+       explicit Buffer(std::string const & file, bool readonly = false,
+               Buffer const * cloned_buffer = 0);
 
        /// Destructor
        ~Buffer();
 
+       ///
+       Buffer * clone() const;
+       ///
+       bool isClone() const;
+
        /** High-level interface to buffer functionality.
            This function parses a command string and executes it.
        */
@@ -177,8 +184,10 @@ public:
        /// Write file. Returns \c false if unsuccesful.
        bool writeFile(support::FileName const &) const;
 
-       /// Loads LyX file \c filename into buffer, *  and \return success
+       /// Loads LyX file \c filename into buffer, *  and return success
        bool loadLyXFile(support::FileName const & s);
+       /// Reloads the LyX file
+       bool reload();
 
        /// Fill in the ErrorList with the TeXErrors
        void bufferErrors(TeXErrors const &, ErrorList &) const;
@@ -311,8 +320,11 @@ public:
        /// \return true if \p child is a child of this \c Buffer.
        bool isChild(Buffer * child) const;
        
-       /// return a vector with all children and grandchildren
-       std::vector<Buffer *> getChildren() const;
+       /// return a vector with all children (and grandchildren)
+       std::vector<Buffer *> getChildren(bool grand_children = true) const;
+
+       /// Add all children (and grandchildren) to supplied vector
+       void getChildren(std::vector<Buffer *> & children, bool grand_children = true) const;
 
        /// Is buffer read-only?
        bool isReadonly() const;
@@ -429,6 +441,10 @@ public:
        /// Return macro defined before the inclusion of the child
        MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
 
+       /// Collect user macro names at loading time
+       typedef std::set<docstring> UserMacroSet;
+       UserMacroSet usermacros;
+
        /// Replace the inset contents for insets which InsetCode is equal
        /// to the passed \p inset_code.
        void changeRefsIfUnique(docstring const & from, docstring const & to,
@@ -456,7 +472,7 @@ public:
        Undo & undo();
 
        /// This function is called when the buffer is changed.
-       void changed() const;
+       void changed(bool update_metrics) const;
        ///
        void updateTocItem(std::string const &, DocIterator const &) const;
        /// This function is called when the buffer structure is changed.
@@ -504,6 +520,8 @@ public:
        bool isExportable(std::string const & format) const;
        ///
        std::vector<Format const *> exportableFormats(bool only_viewable) const;
+       ///
+       bool isExportableFormat(std::string const & format) const;
 
        ///
        typedef std::vector<std::pair<InsetRef *, ParIterator> > References;
@@ -520,10 +538,16 @@ public:
        // FIXME This really shouldn't be needed, but at the moment it's not
        // clear how to do it just for the individual pieces we need.
        void setBuffersForInsets() const;
-       ///
-       void updateLabels(UpdateScope = UpdateMaster) const;
-       ///
-       void updateLabels(ParIterator & parit) const;
+       /// Updates screen labels and some other information associated with
+       /// insets and paragraphs. Actually, it's more like a general "recurse
+       /// through the Buffer" routine, that visits all the insets and paragraphs.
+       void updateLabels() const { updateLabels(UpdateMaster, false); }
+       /// \param scope: whether to start with the master document or just
+       /// do this one.
+       /// \param output: whether we are preparing for output.
+       void updateLabels(UpdateScope scope, bool output) const;
+       /// 
+       void updateLabels(ParIterator & parit, bool output) const;
 
        /// Spellcheck starting from \p from.
        /// \p from initial position, will then points to the next misspelled
@@ -543,7 +567,10 @@ private:
        */
        void updateMacros(DocIterator & it,
                                     DocIterator & scope) const;
-
+       ///
+       void checkBibInfoCache() const;
+       ///
+       void setLabel(ParIterator & it) const;
        ///
        void collectRelatives(BufferSet & bufs) const;
 
@@ -566,7 +593,7 @@ private:
        class Impl;
        /// The pointer never changes although *pimpl_'s contents may.
        Impl * const d;
-
+       ///
        frontend::GuiBufferDelegate * gui_;
 
        /// This function is called when the buffer structure is changed.