]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.h
adjust
[lyx.git] / src / Buffer.h
index 8a81bb07039e5e2c374715a9015ce7f53bb7dfea..37a2670265f32d6bcb83ee079d2d5ee2332c4b6d 100644 (file)
 #ifndef BUFFER_H
 #define BUFFER_H
 
-#include "ErrorList.h"
-#include "InsetList.h"
-
-#include "DocIterator.h"
+#include "insets/InsetCode.h"
 
 #include "support/FileName.h"
 #include "support/limited_stack.h"
 #include "support/docstring.h"
 #include "support/docstream.h"
 
-#include <boost/scoped_ptr.hpp>
-#include <boost/signal.hpp>
-
 #include <iosfwd>
 #include <string>
-#include <map>
 #include <utility>
 #include <vector>
 
 namespace lyx {
 
 class BufferParams;
+class EmbeddedFiles;
 class ErrorItem;
+class ErrorList;
 class FuncRequest;
 class Inset;
-class InsetText;
 class Font;
 class Lexer;
 class LyXRC;
@@ -52,12 +46,15 @@ class OutputParams;
 class ParConstIterator;
 class ParIterator;
 class ParagraphList;
-class StableDocIterator;
 class TeXErrors;
 class TexRow;
 class TocBackend;
 class Undo;
 
+namespace frontend {
+class GuiBufferDelegate;
+class WorkAreaManager;
+}
 
 /** The buffer object.
  * This is the buffer object. It contains all the informations about
@@ -69,7 +66,7 @@ class Undo;
  * I am not sure if the class is complete or
  * minimal, probably not.
  * \author Lars Gullik Bjønnes
 */
+ */
 class Buffer {
 public:
        /// What type of log will \c getLogName() return?
@@ -85,6 +82,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
@@ -128,25 +141,8 @@ public:
        /// do we have a paragraph with this id?
        bool hasParWithID(int id) const;
 
-       /// This signal is emitted when the buffer is changed.
-       boost::signal<void()> changed;
-       /// This signal is emitted when the buffer structure is changed.
-       boost::signal<void()> structureChanged;
-       /// 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.
-       boost::signal<void(docstring)> message;
-       /// This signal is emitted when the buffer busy status change.
-       boost::signal<void(bool)> busy;
-       /// This signal is emitted when the buffer readonly status change.
-       boost::signal<void(bool)> readonly;
-       /// Update window titles of all users.
-       boost::signal<void()> updateTitles;
-       /// Reset autosave timers for all users.
-       boost::signal<void()> resetAutosaveTimers;
-       /// This signal is emitting if the buffer is being closed.
-       boost::signal<void()> closing;
-
+       ///
+       frontend::WorkAreaManager & workAreaManager() const;
 
        /** Save file.
            Takes care of auto-save files and backup file if requested.
@@ -212,11 +208,17 @@ 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;
 
        ///
-       void markBakClean();
+       void markBakClean() const;
 
        ///
        void markDepClean(std::string const & name);
@@ -284,8 +286,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,15 +366,11 @@ 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_; }
-       ///
+       /// Replace the inset contents for insets which InsetCode is equal
+       /// to the passed \p inset_code.
        void changeRefsIfUnique(docstring const & from, docstring const & to,
-               Inset::Code code);
+               InsetCode code);
+
 /// get source code (latex/docbook) for some paragraphs, or all paragraphs
 /// including preamble
        void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, bool full_source);
@@ -389,6 +385,39 @@ public:
        TocBackend & tocBackend();
        TocBackend const & tocBackend() const;
        //@}
+       
+       //@{
+       EmbeddedFiles & embeddedFiles();
+       EmbeddedFiles const & embeddedFiles() const;
+       //@}
+       
+       /// This function is called when the buffer is changed.
+       void changed() const;
+       /// This function is called when the buffer structure is changed.
+       void structureChanged() const;
+       /// This function is called when an embedded file is changed
+       void embeddingChanged() const;
+       /// This function is called when some parsing error shows up.
+       void errors(std::string const & err) const;
+       /// This function is called when the buffer busy status change.
+       void busy(bool on) const;
+       /// This function is called when the buffer readonly status change.
+       void readonly(bool on) const;
+       /// Update window titles of all users.
+       void updateTitles() const;
+       /// Reset autosave timers for all users.
+       void resetAutosaveTimers() const;
+       ///
+       void message(docstring const & msg) const;
+
+       void setGuiDelegate(frontend::GuiBufferDelegate * gui);
+
+       ///
+       void autoSave() const;
+       ///
+       bool writeAs(std::string const & newname = std::string());
+       ///
+       bool menuWrite();
 
 private:
        /** Inserts a file into a document
@@ -400,19 +429,13 @@ private:
        /// 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_;
+       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_;
+       frontend::GuiBufferDelegate * gui_;
 };