X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=fd17ac14f0a40ab611bd22a3d3413db1c07eea51;hb=dc7c7ca03eca25cf7a6395c155b70dac1594e481;hp=6c5d0d12209bfa4141568d5e99737576dad560fb;hpb=eff06951a91000be9778f205bf284d129dce9369;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 6c5d0d1220..fd17ac14f0 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -13,12 +13,14 @@ #define BUFFER_H #include "OutputEnums.h" +#include "OutputParams.h" #include "insets/InsetCode.h" #include "support/strfwd.h" #include "support/types.h" +#include #include #include #include @@ -28,6 +30,7 @@ namespace lyx { class BiblioInfo; +class BibTeXInfo; class BufferParams; class DispatchResult; class DocIterator; @@ -130,8 +133,8 @@ public: * 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 }; /// @@ -177,21 +180,23 @@ public: 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 unsuccesful. + /// Write file. Returns \c false if unsuccessful. bool writeFile(support::FileName const &) const; /// \name Functions involved in reading files/strings. //@{ - /// Loads a LyX file \c fn into the buffer. This function + /// 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(support::FileName const & fn); - /// Loads a LyX file \c fn into the buffer. If you want + 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 @@ -204,8 +209,10 @@ public: //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. @@ -216,7 +223,7 @@ private: /// before reading if the file cannot be found. This is only /// implemented for RCS. /// \sa LyXVC::file_not_found_hook - ReadStatus extractFromVC(support::FileName const & fn); + ReadStatus extractFromVC(); /// Reads the first tag of a LyX File and /// returns the file format number. ReadStatus parseLyXFormat(Lexer & lex, support::FileName const & fn, @@ -231,35 +238,28 @@ private: public: /// \name Functions involved in autosave and emergency files. //@{ - /// - void autoSave() const; + /// Save an autosave file to #filename.lyx# + bool autoSave() const; /// save emergency file /// \return a status message towards the user. docstring emergencyWrite(); -//FIXME:The following three functions should be private +//FIXME:The following function should be private //private: /// void removeAutosaveFile() const; - /// - void moveAutosaveFile(support::FileName const & old) const; - /// Get the filename of the autosave file associated with the Buffer - support::FileName getAutosaveFileName() const; private: /// 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; - + ReadStatus loadAutosave(); /// Try to load an emergency file associated to \c fn. - ReadStatus loadEmergency(support::FileName const & fn); + ReadStatus loadEmergency(); /// 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 - support::FileName getEmergencyFileNameFor(support::FileName const & fn) - const; + /// Get the filename of the autosave file associated with the Buffer + support::FileName getAutosaveFileName() const; + /// + void moveAutosaveFile(support::FileName const & old) const; //@} public: @@ -280,19 +280,21 @@ public: 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, @@ -328,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() const; - /// mark the main lyx file as not needing saving void markClean() const; @@ -371,9 +370,6 @@ public: /// 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; @@ -450,17 +446,20 @@ public: 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 &) const; @@ -547,7 +546,7 @@ public: /// Collect user macro names at loading time typedef std::set UserMacroSet; - UserMacroSet usermacros; + mutable UserMacroSet usermacros; /// Replace the inset contents for insets which InsetCode is equal /// to the passed \p inset_code. @@ -556,8 +555,8 @@ public: /// 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 @@ -605,6 +604,9 @@ public: 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, @@ -663,10 +665,20 @@ public: void checkChildBuffers(); private: + /// Change name of buffer. Updates "read-only" flag. + void setFileName(support::FileName const & fname); /// std::vector backends() const; + /// A cache for the default flavors + typedef std::map DefaultFlavorCache; + /// + mutable DefaultFlavorCache default_flavors_; /// void getLanguages(std::set &) 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;