#define BUFFER_H
#include "OutputEnums.h"
-#include "OutputParams.h"
#include "support/unique_ptr.h"
#include "support/strfwd.h"
#include "support/types.h"
+#include "support/FileNameList.h"
#include <map>
#include <list>
class MacroNameSet;
class MacroSet;
class OutputParams;
+class otexstream;
class Paragraph;
class ParConstIterator;
class ParIterator;
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;
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,
/// 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;
///
typedef std::map<Buffer const *, Buffer *> 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);
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");
///
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;
*/
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<docstring> 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.
/// 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);
/// 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.
/// \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
///
void makeCitationLabels() const;
///
+ void invalidateCiteLabels() const;
+ ///
bool citeLabelsValid() const;
///
void getLabelList(std::vector<docstring> &) const;
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;
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;
///
bool isExporting() const;
- ///
+ /// A collection of InsetRef insets and their position in the buffer
typedef std::vector<std::pair<Inset *, ParIterator> > 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<docstring> &, bool const from_master = false) const;
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;
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;
projects / lyx.git / blobdiff