]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.h
DocBook: fix for nomenclature xml:id and glossary paragraphs.
[lyx.git] / src / Buffer.h
index 50d086f2876a872165f33ab992e60740dcc3f0f8..a917c6e9f74792d8185b6de18c18b08c4b9d4547 100644 (file)
@@ -17,7 +17,6 @@
 #include "support/unique_ptr.h"
 #include "support/strfwd.h"
 #include "support/types.h"
-#include "support/FileNameList.h"
 
 #include <map>
 #include <list>
@@ -39,9 +38,6 @@ class FuncRequest;
 class FuncStatus;
 class Inset;
 class InsetLabel;
-class InsetRef;
-class Font;
-class Format;
 class Lexer;
 class Text;
 class LyXVC;
@@ -52,10 +48,9 @@ class MacroNameSet;
 class MacroSet;
 class OutputParams;
 class otexstream;
-class Paragraph;
-class ParConstIterator;
-class ParIterator;
 class ParagraphList;
+class ParIterator;
+class ParConstIterator;
 class TeXErrors;
 class TexRow;
 class TocBackend;
@@ -70,7 +65,7 @@ class WorkAreaManager;
 namespace support {
 class DocFileName;
 class FileName;
-class FileNamePairList;
+class FileNameList;
 } // namespace support
 
 namespace graphics {
@@ -83,6 +78,7 @@ class Buffer;
 typedef std::list<Buffer *> ListOfBuffers;
 /// a list of Buffers we cloned
 typedef std::set<Buffer *> CloneList;
+typedef std::shared_ptr<CloneList> CloneList_ptr;
 
 
 /** The buffer object.
@@ -97,8 +93,6 @@ typedef std::set<Buffer *> CloneList;
  * \author Lars Gullik Bjønnes
  */
 
-class MarkAsExporting;
-
 class Buffer {
 public:
        /// What type of log will \c getLogName() return?
@@ -154,7 +148,7 @@ public:
 
        /// Constructor
        explicit Buffer(std::string const & file, bool readonly = false,
-               Buffer const * cloned_buffer = 0);
+               Buffer const * cloned_buffer = nullptr);
 
        /// Destructor
        ~Buffer();
@@ -232,7 +226,7 @@ private:
        ///
        typedef std::map<Buffer const *, Buffer *> BufferMap;
        ///
-       void cloneWithChildren(BufferMap &, CloneList *) const;
+       void cloneWithChildren(BufferMap &, CloneList_ptr) const;
        /// save checksum of the given file.
        void saveCheckSum() const;
        /// read a new file
@@ -265,7 +259,7 @@ public:
        bool autoSave() const;
        /// save emergency file
        /// \return a status message towards the user.
-       docstring emergencyWrite();
+       docstring emergencyWrite() const;
 
 //FIXME:The following function should be private
 //private:
@@ -288,6 +282,8 @@ private:
 public:
        /// Fill in the ErrorList with the TeXErrors
        void bufferErrors(TeXErrors const &, ErrorList &) const;
+       /// Fill in the Citation/Reference ErrorList from the TeXErrors
+       void bufferRefs(TeXErrors const &, ErrorList &) const;
 
        enum OutputWhat {
                FullSource,
@@ -303,8 +299,8 @@ public:
                           OutputParams const &,
                           OutputWhat output = FullSource) const;
        /** Export the buffer to LaTeX.
-           If \p os is a file stream, and params().inputenc is "auto" or
-           "default", and the buffer contains text in different languages
+           If \p os is a file stream, and params().inputenc is "auto-legacy" or
+           "auto-legacy-plain", and the buffer contains text in different languages
            with more than one encoding, then this method will change the
            encoding associated to \p os. Therefore you must not call this
            method with a string stream if the output is supposed to go to a
@@ -333,9 +329,9 @@ public:
                             OutputParams const & runparams_in,
                             OutputWhat output = FullSource) const;
        ///
-       ExportStatus writeDocBookSource(odocstream & os, std::string const & filename,
-                            OutputParams const & runparams_in,
-                            OutputWhat output = FullSource) const;
+       ExportStatus writeDocBookSource(odocstream & os,
+                                OutputParams const & runparams_in,
+                                OutputWhat output = FullSource) const;
        ///
        ExportStatus makeLyXHTMLFile(support::FileName const & filename,
                             OutputParams const & runparams_in) const;
@@ -346,7 +342,7 @@ public:
        /// returns the main language for the buffer (document)
        Language const * language() const;
        /// get l10n translated to the buffers language
-       docstring const B_(std::string const & l10n) const;
+       docstring B_(std::string const & l10n) const;
 
        ///
        int runChktex();
@@ -414,10 +410,10 @@ public:
                                        std::string const &, bool nice) const;
 
        /** Returns a vector of bibliography (*.bib) file paths suitable for the
-        *  output in the respective BibTeX/Biblatex macro
+        *  output in the respective BibTeX/Biblatex macro and potential individual encoding
         */
-       std::vector<docstring> const prepareBibFilePaths(OutputParams const &,
-                                   support::FileNamePairList const bibfilelist,
+       std::vector<std::pair<docstring, std::string>> const prepareBibFilePaths(OutputParams const &,
+                                   const docstring_list & bibfilelist,
                                    bool const extension = true) const;
 
        /** Returns the path where a local layout file lives.
@@ -438,7 +434,7 @@ public:
        std::string latexName(bool no_path = true) const;
 
        /// Get the name and type of the log.
-       std::string logName(LogType * type = 0) const;
+       std::string logName(LogType * type = nullptr) const;
 
        /// Set document's parent Buffer.
        void setParent(Buffer const *);
@@ -460,10 +456,10 @@ public:
        /// the children appear.
        ListOfBuffers getChildren() const;
 
-       /// \return a list of all descendents of this Buffer (children,
+       /// \return a list of all descendants of this Buffer (children,
        /// grandchildren, etc). this list has no duplicates and is in
        /// the order in which the children appear.
-       ListOfBuffers getDescendents() const;
+       ListOfBuffers getDescendants() const;
 
        /// Collect all relative buffers, in the order in which they appear.
        /// I.e., the "root" Buffer is first, then its first child, then any
@@ -501,6 +497,8 @@ public:
        /// Calling this method invalidates the cache and so requires a
        /// re-read.
        void invalidateBibinfoCache() 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.
@@ -621,7 +619,7 @@ public:
        mutable UserMacroSet usermacros;
 
        /// Replace the inset contents for insets which InsetCode is equal
-       /// to the passed \p inset_code.
+       /// to the passed \p inset_code. Handles undo.
        void changeRefsIfUnique(docstring const & from, docstring const & to);
 
        /// get source code (latex/docbook) for some paragraphs, or all paragraphs
@@ -678,7 +676,9 @@ public:
        ExportStatus preview(std::string const & format) const;
        /// true if there was a previous preview this session of this buffer and
        /// there was an error on the previous preview of this buffer.
-       bool lastPreviewError() const;
+       bool freshStartRequired() const;
+       ///
+       void requireFreshStart(bool const b) const;
 
 private:
        ///
@@ -697,18 +697,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;
@@ -722,7 +732,7 @@ public:
        /// \param output: whether we are preparing for output.
        void updateBuffer(UpdateScope scope, UpdateType utype) const;
        ///
-       void updateBuffer(ParIterator & parit, UpdateType utype) const;
+       void updateBuffer(ParIterator & parit, UpdateType utype, bool const deleted = false) const;
 
        /// Spellcheck starting from \p from.
        /// \p from initial position, will then points to the next misspelled
@@ -759,13 +769,20 @@ public:
        int wordCount() const;
        int charCount(bool with_blanks) const;
 
-       // this is const because it does not modify the buffer's real contents,
-       // only the mutable flag.
-       void setChangesPresent(bool) const;
+       /// FIXME: dummy function for now
        bool areChangesPresent() const;
-       void updateChangesPresent() const;
+
+       ///
+       void registerBibfiles(docstring_list const & bf) const;
        ///
-       void registerBibfiles(support::FileNamePairList const & bf) const;
+       support::FileName getBibfilePath(docstring const & bibid) const;
+
+       /// routines for dealing with possible self-inclusion
+       void pushIncludedBuffer(Buffer const * buf) const;
+       void popIncludedBuffer() const;
+       bool isBufferIncluded(Buffer const * buf) const;
+private:
+       void clearIncludeList() const;
 
 private:
        friend class MarkAsExporting;
@@ -784,7 +801,7 @@ private:
        void checkIfBibInfoCacheIsValid() const;
        /// Return the list with all bibfiles in use (including bibfiles
        /// of loaded child documents).
-       support::FileNamePairList const &
+       docstring_list const &
                getBibfiles(UpdateScope scope = UpdateMaster) const;
        ///
        void collectChildren(ListOfBuffers & children, bool grand_children) const;