Provide proper fallback if a bibliography processor is not found

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index d483de9a0839bccdc891456a46e144bc53e0f3e1..c81ba46f0dc920ae9180f28ae9fca350f6226b8c 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -17,6 +17,7 @@
 #include "support/unique_ptr.h"
 #include "support/strfwd.h"
 #include "support/types.h"
+#include "support/FileNameList.h"
 
 #include <map>
 #include <list>
@@ -64,18 +65,17 @@ class WordLangTuple;
 namespace frontend {
 class GuiBufferDelegate;
 class WorkAreaManager;
-}
+} // namespace frontend
 
 namespace support {
 class DocFileName;
 class FileName;
-class FileNamePairList;
-}
+} // namespace support
 
 namespace graphics {
 class PreviewLoader;
 class Cache;
-}
+} // namespace graphics
 
 
 class Buffer;
@@ -157,9 +157,9 @@ public:
        /// Destructor
        ~Buffer();
 
-       /// Clones the entire structure of which this Buffer is part, starting
-       /// with the master and cloning all the children, too.
-       Buffer * cloneFromMaster() const;
+       /// Clones the entire structure of which this Buffer is part, 
+       /// cloning all the children, too.
+       Buffer * cloneWithChildren() const;
        /// Just clones this single Buffer. For autosave.
        Buffer * cloneBufferOnly() const;
        ///
@@ -415,7 +415,7 @@ public:
         *  output in the respective BibTeX/Biblatex macro
         */
        std::vector<docstring> const prepareBibFilePaths(OutputParams const &,
-                                   support::FileNamePairList const bibfilelist,
+                                   const docstring_list & bibfilelist,
                                    bool const extension = true) const;
 
        /** Returns the path where a local layout file lives.
@@ -509,8 +509,8 @@ public:
        /// Calling this method invalidates the cache and so requires a
        /// re-read.
        void invalidateBibinfoCache() const;
-       /// This invalidates the cache of files we need to check.
-       void invalidateBibfileCache() const;
+       /// Clear the bibfiles cache
+       void clearBibFileCache() const;
        /// Updates the cached bibliography information, checking first to see
        /// whether the cache is valid. If so, we do nothing. If not, then we
        /// reload all the BibTeX info.
@@ -519,8 +519,10 @@ public:
        /// \return the bibliography information for this buffer's master,
        /// or just for it, if it isn't a child.
        BiblioInfo const & masterBibInfo() const;
+       /// \return this buffer's bibliography information
+       BiblioInfo const & bibInfo() const;
        /// collect bibliography info from the various insets in this buffer.
-       void collectBibKeys() const;
+       void collectBibKeys(support::FileNameList &) const;
        /// add some BiblioInfo to our cache
        void addBiblioInfo(BiblioInfo const & bi) const;
        /// add a single piece of bibliography info to our cache
@@ -528,6 +530,8 @@ public:
        ///
        void makeCitationLabels() const;
        ///
+       void invalidateCiteLabels() const;
+       ///
        bool citeLabelsValid() const;
        ///
        void getLabelList(std::vector<docstring> &) const;
@@ -703,18 +707,28 @@ public:
        ///
        bool isExporting() const;
 
-       ///
+       /// A collection of InsetRef insets and their position in the buffer
        typedef std::vector<std::pair<Inset *, ParIterator> > References;
-       ///
+       /// Get all InsetRef insets and their positions associated with
+       /// the InsetLabel with the label string \p label
        References const & references(docstring const & label) const;
-       ///
+       /// Add an InsetRef at position \p it to the Insetlabel
+       /// with the label string \p label
        void addReference(docstring const & label, Inset * inset, ParIterator it);
-       ///
+       /// Clear the whole reference cache
        void clearReferenceCache() const;
-       ///
-       void setInsetLabel(docstring const & label, InsetLabel const * il);
-       ///
-       InsetLabel const * insetLabel(docstring const & label) const;
+       /// Set the InsetLabel for a given \p label string. \p active
+       /// determines whether this is an active label (see @ref activeLabel)
+       void setInsetLabel(docstring const & label, InsetLabel const * il,
+                          bool const active);
+       /// \return the InsetLabel associated with this \p label string
+       /// If \p active is true we only return active labels
+       /// (see @ref activeLabel)
+       InsetLabel const * insetLabel(docstring const & label,
+                                     bool const active = false) const;
+       /// \return true if this \param label is an active label.
+       /// Inactive labels are currently deleted labels (in ct mode)
+       bool activeLabel(docstring const & label) const;
 
        /// return a list of all used branches (also in children)
        void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
@@ -774,6 +788,10 @@ public:
        void setChangesPresent(bool) const;
        bool areChangesPresent() const;
        void updateChangesPresent() const;
+       ///
+       void registerBibfiles(docstring_list const & bf) const;
+       ///
+       support::FileName getBibfilePath(docstring const & bibid) const;
 
 private:
        friend class MarkAsExporting;
@@ -795,8 +813,8 @@ private:
        void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
        /// Return the list with all bibfiles in use (including bibfiles
        /// of loaded child documents).
-       support::FileNamePairList const &
-               getBibfilesCache(UpdateScope scope = UpdateMaster) const;
+       docstring_list const &
+               getBibfiles(UpdateScope scope = UpdateMaster) const;
        ///
        void collectChildren(ListOfBuffers & children, bool grand_children) const;