Disable CheckTeX while buffer is processed

[lyx.git] / src / BufferList.h

diff --git a/src/BufferList.h b/src/BufferList.h
index 1943c16ba3a5046e7f704e4bc86c8295c0a6ed2b..ca55abe8c9fdd63ce9be84fb947f53a3641fa394 100644 (file)
--- a/src/BufferList.h
+++ b/src/BufferList.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  *
  * Full author contact details are available in file CREDITS.
  */
@@ -19,9 +19,15 @@
 
 namespace lyx {
 
+class Author;
 class Buffer;
 class OutputParams;
 
+namespace support {
+class FileName;
+class FileNameList;
+} // namespace support
+
 /**
  * The class holds all all open buffers, and handles construction
  * and deletions of new ones.
@@ -33,6 +39,7 @@ public:
 
 public:
        BufferList();
+       ~BufferList();
 
        iterator begin();
        const_iterator begin() const;
@@ -40,34 +47,27 @@ public:
        iterator end();
        const_iterator end() const;
 
-       /// create a new buffer
+       /// create a new buffer and add it to the buffer list
+       /// \return 0 if the Buffer creation is not possible for whatever reason.
+       Buffer * newBuffer(std::string const & s);
+
+       /// create an internal buffer and add it to the internal buffer list
        /// \return 0 if the Buffer creation is not possible for whatever reason.
-       Buffer * newBuffer(std::string const & s, bool ronly = false);
+       Buffer * newInternalBuffer(std::string const & s);
+
+       /// Is child a child of some Buffer other than parent?
+       /// NOTE: child must be a child of parent, and both must be non-null.
+       /// Otherwise we assert.
+       bool isOthersChild(Buffer * parent, Buffer * child);
 
        /// delete a buffer
        void release(Buffer * b);
 
-       /// Release \p child if it really is a child and is not used elsewhere.
-       /// \return true is the file was closed.
-       bool releaseChild(Buffer * parent, Buffer * child);
-
        /// Close all open buffers.
        void closeAll();
 
        /// returns a vector with all the buffers filenames
-       std::vector<std::string> const getFileNames() const;
-
-       /// FIXME
-       void updateIncludedTeXfiles(std::string const &, OutputParams const &);
-
-       /// emergency save for all buffers
-       void emergencyWriteAll();
-
-       /// save emergency file for the given buffer
-       /**
-         * \return a status message towards the user.
-         */
-       docstring emergencyWrite(Buffer * buf);
+       support::FileNameList fileNames() const;
 
        /// return true if no buffers loaded
        bool empty() const;
@@ -79,19 +79,29 @@ public:
        Buffer * last();
 
        /// returns true if the buffer exists already
-       bool exists(std::string const &) const;
+       bool exists(support::FileName const &) const;
 
        /// returns true if the buffer is loaded
        bool isLoaded(Buffer const * b) const;
 
-       /// return index of named buffer in buffer list
-       int bufferNum(std::string const & name) const;
-       /// returns a pointer to the buffer with the given name.
-       Buffer * getBuffer(std::string const &);
-       /// returns a pointer to the buffer with the given number.
+       /// returns true if the buffer is known as internal buffer
+       bool isInternal(Buffer const * b) const;
+
+       /// \return index of named buffer in buffer list
+       int bufferNum(support::FileName const & name) const;
+
+       /** returns a pointer to the buffer with the given name
+        *
+        *  \param internal
+        *    If true, the buffer is searched also among internal buffers
+        */
+       Buffer * getBuffer(support::FileName const & name, bool internal = false) const;
+
+       /// \return a pointer to the buffer with the given number
        Buffer * getBuffer(unsigned int);
-       /// returns a pointer to the buffer whose temppath matches the string
-       Buffer * getBufferFromTmp(std::string const &);
+
+       /// \return a pointer to the buffer whose temppath matches the given path
+       Buffer * getBufferFromTmp(std::string const & path);
 
        /** returns a pointer to the buffer that follows argument in
         * buffer list. The buffer following the last in list is the
@@ -105,10 +115,27 @@ public:
         */
        Buffer * previous(Buffer const *) const;
 
+       /// \name Functions that just operate on all buffers
+       //@{
        /// reset current author for all buffers
-       void setCurrentAuthor(docstring const & name, docstring const & email);
+       void recordCurrentAuthor(Author const & author);
+       /// update previews for all buffers, e.g. for Prefs update
+       void updatePreviews();
+       /// Call changed() on all buffers, internal or not
+       void changed(bool update_metrics) const;
+       /// emergency save for all buffers
+       void emergencyWriteAll();
+       /// FIXME
+       void updateIncludedTeXfiles(std::string const &, OutputParams const &);
+       ///
+       void invalidateConverterCache() const;
+       //@}
 
 private:
+       /// create a new buffer
+       /// \return 0 if the Buffer creation is not possible for whatever reason.
+       Buffer * createNewBuffer(std::string const & s);
+
        /// noncopiable
        BufferList(BufferList const &);
        void operator=(BufferList const &);
@@ -117,6 +144,8 @@ private:
 
        /// storage of all buffers
        BufferStorage bstore;
+       /// storage of all internal buffers used for cut&paste, etc.
+       BufferStorage binternal;
 };
 
 /// Implementation is in LyX.cpp