X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=57efb8d00333064955ce516448fe1528759f9799;hb=5d13d8c78372c1cd5a0f6c3f451bacac55015cb3;hp=0cb70266374682815ac5f271ff957329c09e62d6;hpb=244de5d2c10a990828eafdd72283fc87742dc133;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 0cb7026637..57efb8d003 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -17,6 +17,7 @@ #include "support/unique_ptr.h" #include "support/strfwd.h" #include "support/types.h" +#include "support/FileNameList.h" #include #include @@ -64,18 +65,17 @@ class WordLangTuple; namespace frontend { class GuiBufferDelegate; class WorkAreaManager; -} +} // namespace frontend namespace support { class DocFileName; class FileName; -class FileNameList; -} +} // namespace support namespace graphics { class PreviewLoader; class Cache; -} +} // namespace graphics class Buffer; @@ -144,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, @@ -175,9 +157,9 @@ public: /// Destructor ~Buffer(); - /// Clones the entire structure of which this Buffer is part, starting - /// with the master and cloning all the children, too. - Buffer * cloneFromMaster() const; + /// Clones the entire structure of which this Buffer is part, + /// cloning all the children, too. + Buffer * cloneWithChildren() const; /// Just clones this single Buffer. For autosave. Buffer * cloneBufferOnly() const; /// @@ -249,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); @@ -371,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; @@ -417,6 +406,18 @@ public: */ 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::vector const prepareBibFilePaths(OutputParams const &, + const docstring_list & 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. * If possible, it is always relative to the buffer path. @@ -470,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); @@ -514,8 +519,10 @@ public: /// \return the bibliography information for this buffer's master, /// or just for it, if it isn't a child. BiblioInfo const & masterBibInfo() const; + /// \return this buffer's bibliography information + BiblioInfo const & bibInfo() const; /// collect bibliography info from the various insets in this buffer. - void collectBibKeys() const; + void collectBibKeys(support::FileNameList &) const; /// add some BiblioInfo to our cache void addBiblioInfo(BiblioInfo const & bi) const; /// add a single piece of bibliography info to our cache @@ -523,6 +530,8 @@ public: /// void makeCitationLabels() const; /// + void invalidateCiteLabels() const; + /// bool citeLabelsValid() const; /// void getLabelList(std::vector &) const; @@ -769,6 +778,10 @@ public: void setChangesPresent(bool) const; bool areChangesPresent() const; void updateChangesPresent() const; + /// + void registerBibfiles(docstring_list const & bf) const; + /// + support::FileName getBibfilePath(docstring const & bibid) const; private: friend class MarkAsExporting; @@ -790,8 +803,8 @@ private: void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; /// Return the list with all bibfiles in use (including bibfiles /// of loaded child documents). - support::FileNameList const & - getBibfilesCache(UpdateScope scope = UpdateMaster) const; + docstring_list const & + getBibfiles(UpdateScope scope = UpdateMaster) const; /// void collectChildren(ListOfBuffers & children, bool grand_children) const;