#define BUFFER_H
#include "OutputEnums.h"
+#include "OutputParams.h"
#include "insets/InsetCode.h"
#include "support/strfwd.h"
#include "support/types.h"
+#include <map>
#include <list>
#include <set>
#include <string>
namespace lyx {
class BiblioInfo;
+class BibTeXInfo;
class BufferParams;
-class BufferSet;
class DispatchResult;
class DocIterator;
class docstring_list;
class FileNameList;
}
+
+class Buffer;
+typedef std::list<Buffer *> ListOfBuffers;
+
+
/** The buffer object.
* This is the buffer object. It contains all the informations about
* a document loaded into LyX.
/// Result of \c readFile()
enum ReadStatus {
- failure, ///< The file could not be read
- success, ///< The file could not be read
- wrongversion ///< The version of the file does not match ours
+ ReadSuccess,
+ ReadCancel,
+ // failures
+ ReadFailure,
+ ReadWrongVersion,
+ ReadFileNotFound,
+ ReadVCError,
+ ReadAutosaveFailure,
+ ReadEmergencyFailure,
+ ReadNoLyXFormat,
+ ReadDocumentFailure,
+ // lyx2lyx
+ LyX2LyXNoTempFile,
+ LyX2LyXNotFound,
+ LyX2LyXOlderFormat,
+ LyX2LyXNewerFormat,
+ // other
+ ReadOriginal
};
* FIXME: replace this method with support/FileMonitor.
*/
enum CheckMethod {
- checksum_method, ///< Use file checksum
- timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
+ checksum_method, ///< Use file checksum
+ timestamp_method ///< Use timestamp, and checksum if timestamp has changed
};
///
/// \return true if we made a decision
bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
- /// read a new document from a string
- bool readString(std::string const &);
- /// load a new file
- bool readFile(support::FileName const & filename);
-
- /// read the header, returns number of unknown tokens
- int readHeader(Lexer & lex);
-
- /** Reads a file without header.
- \param par if != 0 insert the file.
- \return \c true if file is not completely read.
- */
- bool readDocument(Lexer &);
-
///
DocIterator getParFromID(int id) const;
/// do we have a paragraph with this id?
Returns \c true if the save is successful, \c false otherwise.
*/
bool save() const;
+ /// Renames and saves the buffer
+ bool saveAs(support::FileName const & fn);
- /// Write document to stream. Returns \c false if unsuccesful.
+ /// Write document to stream. Returns \c false if unsuccessful.
bool write(std::ostream &) const;
+ /// Write file. Returns \c false if unsuccessful.
+ bool writeFile(support::FileName const &) const;
+
+ /// \name Functions involved in reading files/strings.
+ //@{
+ /// Loads the LyX file into the buffer. This function
+ /// 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();
+ /// Loads the 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
+ ReadStatus reload();
+//FIXME: The following function should be private
+//private:
+ /// read the header, returns number of unknown tokens
+ int readHeader(Lexer & lex);
+
+private:
+ /// save timestamp and checksum of the given file.
+ void saveCheckSum() const;
+ /// 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.
+ bool readDocument(Lexer &);
+ /// Try to extract the file from a version control container
+ /// before reading if the file cannot be found. This is only
+ /// implemented for RCS.
+ /// \sa LyXVC::file_not_found_hook
+ ReadStatus extractFromVC();
+ /// Reads the first tag of a LyX File and
+ /// returns the file format number.
+ ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn,
+ int & file_format) const;
+ /// Convert the LyX file to the LYX_FORMAT using
+ /// the lyx2lyx script and returns the filename
+ /// of the temporary file to be read
+ ReadStatus convertLyXFormat(support::FileName const & fn,
+ support::FileName & tmpfile, int from_format);
+ //@}
+
+public:
+ /// \name Functions involved in autosave and emergency files.
+ //@{
+ /// Save an autosave file to #filename.lyx#
+ bool autoSave() const;
/// save emergency file
/// \return a status message towards the user.
docstring emergencyWrite();
- /// Write file. Returns \c false if unsuccesful.
- bool writeFile(support::FileName const &) const;
- /// Loads LyX file \c filename into buffer, * and return success
- bool loadLyXFile(support::FileName const & s);
- /// Reloads the LyX file
- bool reload();
+//FIXME:The following function should be private
+//private:
+ ///
+ void removeAutosaveFile() const;
+
+private:
+ /// Try to load an autosave file associated to \c fn.
+ ReadStatus loadAutosave();
+ /// Try to load an emergency file associated to \c fn.
+ ReadStatus loadEmergency();
+ /// Get the filename of the emergency file associated with the Buffer
+ support::FileName getEmergencyFileName() const;
+ /// Get the filename of the autosave file associated with the Buffer
+ support::FileName getAutosaveFileName() const;
+ ///
+ void moveAutosaveFile(support::FileName const & old) const;
+ //@}
+public:
/// Fill in the ErrorList with the TeXErrors
void bufferErrors(TeXErrors const &, ErrorList &) const;
method with a string stream if the output is supposed to go to a
file. \code
ofdocstream ofs;
+ otexstream os(ofs, texrow);
ofs.open("test.tex");
- writeLaTeXSource(ofs, ...);
+ writeLaTeXSource(os, ...);
ofs.close();
\endcode is NOT equivalent to \code
odocstringstream oss;
- writeLaTeXSource(oss, ...);
+ otexstream os(oss, texrow);
+ writeLaTeXSource(os, ...);
ofdocstream ofs;
ofs.open("test.tex");
ofs << oss.str();
ofs.close();
\endcode
*/
- void writeLaTeXSource(odocstream & os,
+ void writeLaTeXSource(otexstream & os,
std::string const & original_path,
OutputParams const &,
bool output_preamble = true,
/// 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;
/// Get the name and type of the log.
std::string logName(LogType * type = 0) const;
- /// Change name of buffer. Updates "read-only" flag.
- void setFileName(std::string const & newfile);
-
/// Set document's parent Buffer.
void setParent(Buffer const *);
Buffer const * parent() const;
- // Collect all relative buffer
- std::vector<Buffer const *> allRelatives() const;
-
/** Get the document's master (or \c this if this is not a
child document)
*/
/// \return true if \p child is a child of this \c Buffer.
bool isChild(Buffer * child) const;
- /// return a vector with all children (and grandchildren)
- std::vector<Buffer *> getChildren(bool grand_children = true) const;
-
- /// Add all children (and grandchildren) to supplied vector
- void getChildren(std::vector<Buffer *> & children, bool grand_children = true) const;
+ /// \return true if this \c Buffer has children
+ bool hasChildren() const;
+
+ /// \return a list of the direct children of this Buffer.
+ /// this list has no duplicates and is in the order in which
+ /// the children appear.
+ ListOfBuffers getChildren() const;
+
+ /// \return a list of all descendents of this Buffer (children,
+ /// grandchildren, etc). this list has no duplicates and is in
+ /// the order in which the children appear.
+ ListOfBuffers getDescendents() 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
+ /// of its children, etc. However, there are no duplicates in this
+ /// list.
+ /// This is "stable", too, in the sense that it returns the same
+ /// thing from whichever Buffer it is called.
+ ListOfBuffers allRelatives() const;
/// Is buffer read-only?
bool isReadonly() const;
*/
void validate(LaTeXFeatures &) const;
- /// Information from BibTeX databases is cached in the Buffer, so
- /// we do not have to read the file over and over.
+ /// Reference information is cached in the Buffer, so we do not
+ /// have to check or read things over and over.
+ ///
+ /// There are two caches.
+ ///
+ /// One is a cache of the BibTeX files from which reference info is
+ /// being gathered. This cache is PER BUFFER, and the cache for the
+ /// master essentially includes the cache for its children. This gets
+ /// invalidated when an InsetBibtex is created, deleted, or modified.
+ ///
+ /// The other is a cache of the reference information itself. This
+ /// exists only in the master buffer, and when it needs to be updated,
+ /// the children add their information to the master's cache.
+
/// Calling this method invalidates the cache and so requires a
/// re-read.
void invalidateBibinfoCache() const;
/// This invalidates the cache of files we need to check.
void invalidateBibfileCache() const;
- /// Updates the cached bibliography information.
- /// Note that you MUST call this method to update the cache. It will
- /// not happen otherwise. (Currently, it is called at the start of
- /// updateBuffer() and from GuiCitation.)
+ /// 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.
/// Note that this operates on the master document.
- void checkBibInfoCache() const;
+ void reloadBibInfoCache() const;
/// \return the bibliography information for this buffer's master,
/// or just for it, if it isn't a child.
BiblioInfo const & masterBibInfo() const;
- ///
- void fillWithBibKeys(BiblioInfo & keys) const;
+ /// collect bibliography info from the various insets in this buffer.
+ void collectBibKeys() const;
+ /// add some BiblioInfo to our cache
+ void addBiblioInfo(BiblioInfo const & bi) const;
+ /// add a single piece of bibliography info to our cache
+ void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
///
void getLabelList(std::vector<docstring> &) const;
/// 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;
/// Collect user macro names at loading time
typedef std::set<docstring> UserMacroSet;
- UserMacroSet usermacros;
+ mutable UserMacroSet usermacros;
/// Replace the inset contents for insets which InsetCode is equal
/// to the passed \p inset_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) const;
+ void getSourceCode(odocstream & os, std::string const format,
+ pit_type par_begin, pit_type par_end, bool full_source) const;
/// Access to error list.
/// This method is used only for GUI visualisation of Buffer related
///
bool hasGuiDelegate() const;
- ///
- void autoSave() const;
- ///
- void removeAutosaveFile() const;
- ///
- void moveAutosaveFile(support::FileName const & old) const;
- ///
- support::FileName getAutosaveFileName() const;
+
/// return the format of the buffer on a string
std::string bufferFormat() const;
/// return the default output format of the current backend
std::string getDefaultOutputFormat() const;
+ /// return the output flavor of \p format or the default
+ OutputParams::FLAVOR getOutputFlavor(
+ std::string const format = std::string()) const;
///
bool doExport(std::string const & format, bool put_in_tempdir,
void checkChildBuffers();
private:
- ///
- bool readFileHelper(support::FileName const & s);
+ /// Change name of buffer. Updates "read-only" flag.
+ void setFileName(support::FileName const & fname);
///
std::vector<std::string> backends() const;
- /** Inserts a file into a document
- \return \c false if method fails.
- */
- ReadStatus readFile(Lexer &, support::FileName const & filename,
- bool fromString = false);
+ /// A cache for the default flavors
+ typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
+ ///
+ mutable DefaultFlavorCache default_flavors_;
///
void getLanguages(std::set<Language const *> &) const;
+ /// Checks whether any of the referenced bibfiles have changed since the
+ /// last time we loaded the cache. Note that this does NOT update the
+ /// cached information.
+ void checkIfBibInfoCacheIsValid() const;
/// Update the list of all bibfiles in use (including bibfiles
/// of loaded child documents).
void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
/// of loaded child documents).
support::FileNameList const &
getBibfilesCache(UpdateScope scope = UpdateMaster) const;
+ ///
+ void collectChildren(ListOfBuffers & children, bool grand_children) const;
+
/// Use the Pimpl idiom to hide the internals.
class Impl;
/// The pointer never changes although *pimpl_'s contents may.
projects / lyx.git / blobdiff