X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=165f5d8795a1ae218c3fe2de406cd06e4ce04567;hb=e040ccb0e86d8a928037e8b4b99f5ee786503abd;hp=e945fb3ba790439d6f48b6657e2cec5137be46b7;hpb=fd7b13f5ae1493a5af26e305ce47af06f9f5c3e2;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index e945fb3ba7..165f5d8795 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -13,8 +13,8 @@ #define BUFFER_H #include "OutputEnums.h" -#include "OutputParams.h" +#include "support/unique_ptr.h" #include "support/strfwd.h" #include "support/types.h" @@ -50,6 +50,7 @@ class MacroData; class MacroNameSet; class MacroSet; class OutputParams; +class otexstream; class Paragraph; class ParConstIterator; class ParIterator; @@ -63,16 +64,18 @@ class WordLangTuple; namespace frontend { class GuiBufferDelegate; class WorkAreaManager; -} +} // namespace frontend namespace support { +class DocFileName; class FileName; -class FileNameList; -} +class FileNamePairList; +} // namespace support namespace graphics { class PreviewLoader; -} +class Cache; +} // namespace graphics class Buffer; @@ -141,24 +144,6 @@ public: PreviewError }; - /// 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 seconds. 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. - * - * FIXME: replace this method with support/FileMonitor. - */ - enum CheckMethod { - checksum_method, ///< Use file checksum - timestamp_method ///< Use timestamp, and checksum if timestamp has changed - }; - /// enum UpdateScope { UpdateMaster, @@ -246,7 +231,7 @@ private: typedef std::map BufferMap; /// void cloneWithChildren(BufferMap &, CloneList *) const; - /// save timestamp and checksum of the given file. + /// save checksum of the given file. void saveCheckSum() const; /// read a new file ReadStatus readFile(support::FileName const & fn); @@ -267,6 +252,8 @@ private: /// of the temporary file to be read ReadStatus convertLyXFormat(support::FileName const & fn, support::FileName & tmpfile, int from_format); + /// get appropriate name for backing up files from older versions + support::FileName getBackupName() const; //@} public: @@ -321,13 +308,13 @@ public: method with a string stream if the output is supposed to go to a file. \code ofdocstream ofs; - otexstream os(ofs, texrow); + otexstream os(ofs); ofs.open("test.tex"); writeLaTeXSource(os, ...); ofs.close(); \endcode is NOT equivalent to \code odocstringstream oss; - otexstream os(oss, texrow); + otexstream os(oss); writeLaTeXSource(os, ...); ofdocstream ofs; ofs.open("test.tex"); @@ -366,8 +353,15 @@ public: /// bool isDepClean(std::string const & name) const; - /// whether or not disk file has been externally modified - bool isExternallyModified(CheckMethod method) const; + /// Whether or not disk file has been externally modified. Uses a checksum + /// which 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. + bool isChecksumModified() const; + + /// Flag set by the FileSystemWatcher. + /// Fast but (not so) inaccurate, can be cleared by the user. + bool notifiesExternalModification() const; + void clearExternalModification() const; /// mark the main lyx file as not needing saving void markClean() const; @@ -403,12 +397,26 @@ public: /// It is always an absolute path. std::string filePath() const; - /** Returns the path where the document was last saved. - * It may be different from filePath() if the document was later - * manually moved to a different location. - * It is always an absolute path. + /** Contructs a file name of a referenced file (child doc, included graphics etc). + * Absolute names are returned as is. If the name is relative, it is + * interpreted relative to filePath() if the file exists, otherwise + * relative to the original path where the document was last saved. + * The original path may be different from filePath() if the document was + * later manually moved to a different location. + */ + support::DocFileName getReferencedFileName(std::string const & fn) const; + + /// Format a file name for LaTeX output (absolute or relative or filename only, + /// depending on file and context) + std::string const prepareFileNameForLaTeX(std::string const &, + std::string const &, bool nice) const; + + /** Returns a vector of bibliography (*.bib) file paths suitable for the + * output in the respective BibTeX/Biblatex macro */ - std::string originFilePath() const; + std::vector const prepareBibFilePaths(OutputParams const &, + support::FileNamePairList const bibfilelist, + bool const extension = true) const; /** Returns the path where a local layout file lives. * An empty string is returned for standard system and user layouts. @@ -463,9 +471,13 @@ public: /// thing from whichever Buffer it is called. ListOfBuffers allRelatives() const; - /// Is buffer read-only? + /// Is buffer read-only? True if it has either the read-only flag or the + /// externally modified flag. bool isReadonly() const; + /// Does the buffer have the read-only flag? + bool hasReadonlyFlag() const; + /// Set buffer read-only flag void setReadonly(bool flag = true); @@ -581,6 +593,8 @@ public: void updatePreviews() const; /// Remove any previewed LaTeX snippets associated with this buffer void removePreviews() const; + /// + graphics::Cache & graphicsCache() const; /// Our main text (inside the top InsetText) Text & text() const; @@ -618,8 +632,8 @@ public: /// get source code (latex/docbook) for some paragraphs, or all paragraphs /// including preamble - /// returns NULL if Id to Row conversion is unsupported - std::auto_ptr getSourceCode(odocstream & os, + /// returns nullptr if Id to Row conversion is unsupported + unique_ptr getSourceCode(odocstream & os, std::string const & format, pit_type par_begin, pit_type par_end, OutputWhat output, bool master) const; @@ -681,7 +695,7 @@ private: ExportStatus doExport(std::string const & target, bool put_in_tempdir, bool includeall, std::string & result_file) const; /// - ExportStatus preview(std::string const & format, bool includeall = false) const; + ExportStatus preview(std::string const & format, bool includeall) const; /// void setMathFlavor(OutputParams & op) const; @@ -755,6 +769,12 @@ public: int wordCount() const; int charCount(bool with_blanks) const; + // this is const because it does not modify the buffer's real contents, + // only the mutable flag. + void setChangesPresent(bool) const; + bool areChangesPresent() const; + void updateChangesPresent() const; + private: friend class MarkAsExporting; /// mark the buffer as busy exporting something, or not @@ -775,7 +795,7 @@ private: void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; /// Return the list with all bibfiles in use (including bibfiles /// of loaded child documents). - support::FileNameList const & + support::FileNamePairList const & getBibfilesCache(UpdateScope scope = UpdateMaster) const; /// void collectChildren(ListOfBuffers & children, bool grand_children) const;