Fulfill promise to Andre: TextClass_ptr --> TextClassPtr.

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index 586c47db022d6955b1e834f6ab24a187929f9925..7d18ab65e2870904b943a0f0750c0fbb137c75d9 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -12,9 +12,6 @@
 #ifndef BUFFER_H
 #define BUFFER_H
 
-#include "ErrorList.h"
-#include "InsetList.h"
-
 #include "DocIterator.h"
 
 #include "support/FileName.h"
@@ -28,7 +25,6 @@
 
 #include <iosfwd>
 #include <string>
-#include <map>
 #include <utility>
 #include <vector>
 
@@ -37,6 +33,7 @@ namespace lyx {
 
 class BufferParams;
 class ErrorItem;
+class ErrorList;
 class FuncRequest;
 class Inset;
 class InsetText;
@@ -52,7 +49,6 @@ class OutputParams;
 class ParConstIterator;
 class ParIterator;
 class ParagraphList;
-class StableDocIterator;
 class TeXErrors;
 class TexRow;
 class TocBackend;
@@ -85,6 +81,22 @@ public:
                wrongversion ///< The version of the file does not match ours
        };
 
+       /// Method to check if a file is externally modified, used by 
+       /// isExternallyModified()
+       /**
+        * timestamp is fast but inaccurate. For example, the granularity
+        * of timestamp on a FAT filesystem is 2 second. Also, various operations
+        * may touch the timestamp of a file even when its content is unchanged.
+        *
+        * checksum is accurate but slow, which can be a problem when it is 
+        * frequently used, or used for a large file on a slow (network) file
+        * system.
+        */
+       enum CheckMethod {
+               checksum_method,  ///< Use file check sum
+               timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
+       };
+       
        /** Constructor
            \param file
            \param b  optional \c false by default
@@ -132,6 +144,8 @@ public:
        boost::signal<void()> changed;
        /// This signal is emitted when the buffer structure is changed.
        boost::signal<void()> structureChanged;
+       /// This signal is emitted when an embedded file is changed
+       boost::signal<void()> embeddingChanged;
        /// This signal is emitted when some parsing error shows up.
        boost::signal<void(std::string)> errors;
        /// This signal is emitted when some message shows up.
@@ -145,7 +159,7 @@ public:
        /// Reset autosave timers for all users.
        boost::signal<void()> resetAutosaveTimers;
        /// This signal is emitting if the buffer is being closed.
-       boost::signal<void()> closing;
+       boost::signal<void(Buffer *)> closing;
 
 
        /** Save file.
@@ -212,6 +226,12 @@ public:
        ///
        bool isDepClean(std::string const & name) const;
 
+       /// whether or not disk file has been externally modified
+       bool isExternallyModified(CheckMethod method) const;
+
+       /// save timestamp and checksum of the given file.
+       void saveCheckSum(std::string const & file) const;
+
        /// mark the main lyx file as not needing saving
        void markClean() const;
 
@@ -284,8 +304,6 @@ public:
        */
        void validate(LaTeXFeatures &) const;
 
-       /// return all bibkeys from buffer and its childs
-       void fillWithBibKeys(std::vector<std::pair<std::string, docstring> > & keys) const;
        /// Update the cache with all bibfiles in use (including bibfiles
        /// of loaded child documents).
        void updateBibfilesCache();
@@ -366,12 +384,6 @@ public:
        ///
        void insertMacro(docstring const & name, MacroData const & data);
 
-       ///
-       void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
-       ///
-       StableDocIterator getCursor() const { return cursor_; }
-       ///
-       StableDocIterator getAnchor() const { return anchor_; }
        ///
        void changeRefsIfUnique(docstring const & from, docstring const & to,
                Inset::Code code);
@@ -389,30 +401,27 @@ public:
        TocBackend & tocBackend();
        TocBackend const & tocBackend() const;
        //@}
+       
+       //@{
+       EmbeddedFiles & embeddedFiles();
+       EmbeddedFiles const & embeddedFiles() const;
+       //@}
 
 private:
        /** Inserts a file into a document
            \return \c false if method fails.
        */
        ReadStatus readFile(Lexer &, support::FileName const & filename,
-                           bool fromString = false);
+                           bool fromString = false);
 
        /// Use the Pimpl idiom to hide the internals.
        class Impl;
        /// The pointer never changes although *pimpl_'s contents may.
        boost::scoped_ptr<Impl> const pimpl_;
 
-       /// Save the cursor Position on Buffer switch
-       /// this would not be needed if every Buffer would have
-       /// it's BufferView, this should be FIXED in future.
-       StableDocIterator cursor_;
-       StableDocIterator anchor_;
        /// A cache for the bibfiles (including bibfiles of loaded child
        /// documents), needed for appropriate update of natbib labels.
        mutable std::vector<support::FileName> bibfilesCache_;
-
-       /// Container for all sort of Buffer dependant errors.
-       std::map<std::string, ErrorList> errorLists_;
 };