X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=99cfce1fe12eb160331cac29c9fb74336498e939;hb=36edbffe2f71d050a09d5231c8428dd7575573fa;hp=999b7cbf734ce75430057a4cdb169da3f0bd48dd;hpb=867cdb06624d87b03d6aa48442164db2ca2c6d96;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 999b7cbf73..99cfce1fe1 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 FileNamePairList; -} +} // namespace support namespace graphics { class PreviewLoader; class Cache; -} +} // namespace graphics class Buffer; @@ -132,6 +132,7 @@ public: // export ExportSuccess, ExportCancel, + ExportKilled, ExportError, ExportNoPathToFormat, ExportTexPathHasSpaces, @@ -144,24 +145,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 +158,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 +232,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); @@ -314,7 +297,7 @@ public: }; /// Just a wrapper for writeLaTeXSource, first creating the ofstream. - bool makeLaTeXFile(support::FileName const & filename, + ExportStatus makeLaTeXFile(support::FileName const & filename, std::string const & original_path, OutputParams const &, OutputWhat output = FullSource) const; @@ -340,23 +323,23 @@ public: ofs.close(); \endcode */ - void writeLaTeXSource(otexstream & os, + ExportStatus writeLaTeXSource(otexstream & os, std::string const & original_path, OutputParams const &, OutputWhat output = FullSource) const; /// - void makeDocBookFile(support::FileName const & filename, + ExportStatus makeDocBookFile(support::FileName const & filename, OutputParams const & runparams_in, OutputWhat output = FullSource) const; /// - void writeDocBookSource(odocstream & os, std::string const & filename, + ExportStatus writeDocBookSource(odocstream & os, std::string const & filename, OutputParams const & runparams_in, OutputWhat output = FullSource) const; /// - void makeLyXHTMLFile(support::FileName const & filename, + ExportStatus makeLyXHTMLFile(support::FileName const & filename, OutputParams const & runparams_in) const; /// - void writeLyXHTMLSource(odocstream & os, + ExportStatus writeLyXHTMLSource(odocstream & os, OutputParams const & runparams_in, OutputWhat output = FullSource) const; /// returns the main language for the buffer (document) @@ -371,8 +354,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 +407,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 +472,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); @@ -487,35 +493,27 @@ public: */ void validate(LaTeXFeatures &) const; - /// Reference information is cached in the Buffer, so we do not + /// Bibliography 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 cache exists only in the master buffer. When it is 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; + /// Clear the bibfiles cache + void clearBibFileCache() const; /// 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 reloadBibInfoCache() const; + void reloadBibInfoCache(bool const force = false) const; /// \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 +521,8 @@ public: /// void makeCitationLabels() const; /// + void invalidateCiteLabels() const; + /// bool citeLabelsValid() const; /// void getLabelList(std::vector &) const; @@ -698,26 +698,32 @@ public: /// bool isExporting() const; - /// + /// A collection of InsetRef insets and their position in the buffer typedef std::vector > References; - /// + /// Get all InsetRef insets and their positions associated with + /// the InsetLabel with the label string \p label References const & references(docstring const & label) const; - /// + /// Add an InsetRef at position \p it to the Insetlabel + /// with the label string \p label void addReference(docstring const & label, Inset * inset, ParIterator it); - /// + /// Clear the whole reference cache void clearReferenceCache() const; - /// - void setInsetLabel(docstring const & label, InsetLabel const * il); - /// - InsetLabel const * insetLabel(docstring const & label) const; + /// Set the InsetLabel for a given \p label string. \p active + /// determines whether this is an active label (see @ref activeLabel) + void setInsetLabel(docstring const & label, InsetLabel const * il, + bool const active); + /// \return the InsetLabel associated with this \p label string + /// If \p active is true we only return active labels + /// (see @ref activeLabel) + InsetLabel const * insetLabel(docstring const & label, + bool const active = false) const; + /// \return true if this \param label is an active label. + /// Inactive labels are currently deleted labels (in ct mode) + bool activeLabel(docstring const & label) const; /// return a list of all used branches (also in children) void getUsedBranches(std::list &, bool const from_master = false) const; - /// sets the buffer_ member for every inset in this buffer. - // FIXME This really shouldn't be needed, but at the moment it's not - // clear how to do it just for the individual pieces we need. - void setBuffersForInsets() const; /// Updates screen labels and some other information associated with /// insets and paragraphs. Actually, it's more like a general "recurse /// through the Buffer" routine, that visits all the insets and paragraphs. @@ -769,6 +775,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; @@ -785,13 +795,10 @@ private: /// 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; /// Return the list with all bibfiles in use (including bibfiles /// of loaded child documents). - support::FileNamePairList const & - getBibfilesCache(UpdateScope scope = UpdateMaster) const; + docstring_list const & + getBibfiles(UpdateScope scope = UpdateMaster) const; /// void collectChildren(ListOfBuffers & children, bool grand_children) const;