Improve how add_to_preamble and insert_to_preamble work, and audit the

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index d8a1c199e1226abab11b46406b35d1486bccd590..ea4eb498969287054de93bb1cfa08dcdba8a9252 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -189,19 +189,27 @@ public:
        /// tries to extract the file from version control if it
        /// cannot be found. If it can be found, it will try to
        /// read an emergency save file or an autosave file.
+       /// \sa loadThisLyXFile
        ReadStatus loadLyXFile(support::FileName const & fn);
+       /// Loads a LyX file \c fn into the buffer. If you want
+       /// to check for files in a version control container,
+       /// emergency or autosave files, one should use \c loadLyXFile.
+       /// /sa loadLyXFile
+       ReadStatus loadThisLyXFile(support::FileName const & fn);
        /// read a new document from a string
        bool readString(std::string const &);
        /// Reloads the LyX file
-       bool reload();
+       ReadStatus reload();
 //FIXME: The following two functions should be private
 //private:
-       /// read a new file
-       ReadStatus readFile(support::FileName const & fn);
        /// read the header, returns number of unknown tokens
        int readHeader(Lexer & lex);
-       
+       /// save timestamp and checksum of the given file.
+       void saveCheckSum() const;
+
 private:
+       /// read a new file
+       ReadStatus readFile(support::FileName const & fn);
        /// Reads a file without header.
        /// \param par if != 0 insert the file.
        /// \return \c true if file is not completely read.
@@ -210,7 +218,7 @@ private:
        /// before reading if the file cannot be found. This is only
        /// implemented for RCS.
        /// \sa LyXVC::file_not_found_hook
-       ReadStatus readFromVC(support::FileName const & fn);
+       ReadStatus extractFromVC(support::FileName const & fn);
        /// Reads the first tag of a LyX File and 
        /// returns the file format number.
        ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
@@ -241,14 +249,14 @@ public:
        support::FileName getAutosaveFileName() const;
        
 private:
-       /// Try to read an autosave file associated to \c fn.
-       ReadStatus readAutosave(support::FileName const & fn);
+       /// Try to load an autosave file associated to \c fn.
+       ReadStatus loadAutosave(support::FileName const & fn);
        /// Get the filename of the autosave file associated with \c fn
        support::FileName getAutosaveFileNameFor(support::FileName const & fn)
                const;
 
-       /// Try to read an emergency file associated to \c fn. 
-       ReadStatus readEmergency(support::FileName const & fn);
+       /// Try to load an emergency file associated to \c fn. 
+       ReadStatus loadEmergency(support::FileName const & fn);
        /// Get the filename of the emergency file associated with the Buffer
        support::FileName getEmergencyFileName() const;
        /// Get the filename of the emergency file associated with \c fn
@@ -322,9 +330,6 @@ public:
        /// whether or not disk file has been externally modified
        bool isExternallyModified(CheckMethod method) const;
 
-       /// save timestamp and checksum of the given file.
-       void saveCheckSum(support::FileName const & file) const;
-
        /// mark the main lyx file as not needing saving
        void markClean() const;
 
@@ -508,6 +513,11 @@ public:
        /// Set by buffer_funcs' newFile.
        void setFullyLoaded(bool);
 
+       /// Update the LaTeX preview snippets associated with this buffer
+       void updatePreviews() const;
+       /// Remove any previewed LaTeX snippets associated with this buffer
+       void removePreviews() const;
+
        /// Our main text (inside the top InsetText)
        Text & text() const;