X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=165f5d8795a1ae218c3fe2de406cd06e4ce04567;hb=e040ccb0e86d8a928037e8b4b99f5ee786503abd;hp=cd0540cb7bfd029d6694448274840f7c2ecdbc68;hpb=cc1ce047984292b0509043f82165c506d15eb020;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index cd0540cb7b..165f5d8795 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -13,10 +13,8 @@ #define BUFFER_H #include "OutputEnums.h" -#include "OutputParams.h" - -#include "insets/InsetCode.h" +#include "support/unique_ptr.h" #include "support/strfwd.h" #include "support/types.h" @@ -52,6 +50,7 @@ class MacroData; class MacroNameSet; class MacroSet; class OutputParams; +class otexstream; class Paragraph; class ParConstIterator; class ParIterator; @@ -65,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; @@ -94,6 +95,9 @@ typedef std::set CloneList; * minimal, probably not. * \author Lars Gullik Bjønnes */ + +class MarkAsExporting; + class Buffer { public: /// What type of log will \c getLogName() return? @@ -133,28 +137,13 @@ public: ExportTexPathHasSpaces, ExportConverterError, // preview + // Implies ExportSuccess. PreviewSuccess, + // The exported file exists but there was an error when opening + // it in a viewer. 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, @@ -222,22 +211,27 @@ public: /// emergency or autosave files, one should use \c loadLyXFile. /// /sa loadLyXFile ReadStatus loadThisLyXFile(support::FileName const & fn); + /// import a new document from a string + bool importString(std::string const &, docstring const &, ErrorList &); + /// import a new file + bool importFile(std::string const &, support::FileName const &, ErrorList &); /// read a new document from a string bool readString(std::string const &); /// Reloads the LyX file - /// \param clearUndo if false, leave alone the undo stack. - ReadStatus reload(bool clearUndo = true); + ReadStatus reload(); //FIXME: The following function should be private //private: /// read the header, returns number of unknown tokens int readHeader(Lexer & lex); + double fontScalingFactor() const; + 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); @@ -258,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: @@ -312,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"); @@ -357,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; @@ -390,10 +393,43 @@ public: /// Returns the buffer's filename. It is always an absolute path. std::string absFileName() const; - /// Returns the the path where the buffer lives. + /// Returns the path where the buffer lives. /// It is always an absolute path. std::string filePath() const; + /** 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::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. + * If possible, it is always relative to the buffer path. + */ + std::string layoutPos() const; + + /** Set the path to a local layout file. + * This must be an absolute path but, if possible, it is always + * stored as relative to the buffer path. + */ + void setLayoutPos(std::string const & path); + /** A transformed version of the file name, adequate for LaTeX. \param no_path optional if \c true then the path is stripped. */ @@ -435,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); @@ -506,6 +546,8 @@ public: /// BufferParams & params(); BufferParams const & params() const; + /// + BufferParams const & masterParams() const; /** The list of paragraphs. This is a linked list of paragraph, this list holds the @@ -551,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; @@ -584,14 +628,14 @@ public: /// Replace the inset contents for insets which InsetCode is equal /// to the passed \p inset_code. - void changeRefsIfUnique(docstring const & from, docstring const & to, - InsetCode code); + void changeRefsIfUnique(docstring const & from, docstring const & to); /// get source code (latex/docbook) for some paragraphs, or all paragraphs /// including preamble - void getSourceCode(odocstream & os, std::string const format, - pit_type par_begin, pit_type par_end, OutputWhat output, - bool master) const; + /// 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; /// Access to error list. /// This method is used only for GUI visualisation of Buffer related @@ -635,22 +679,23 @@ public: /// ExportStatus doExport(std::string const & target, bool put_in_tempdir) const; - /// - ExportStatus doExport(std::string const & target, bool put_in_tempdir, - std::string & result_file) const; - /// + /// Export buffer to format \p format and open the result in a suitable viewer. + /// Note: This has nothing to do with preview of graphics or math formulas. ExportStatus preview(std::string const & format) const; + /// true if there was a previous preview this session of this buffer and + /// there was an error on the previous preview of this buffer. + bool lastPreviewError() const; private: + /// + ExportStatus doExport(std::string const & target, bool put_in_tempdir, + std::string & result_file) const; /// target is a format name optionally followed by a space /// and a destination file-name ExportStatus doExport(std::string const & target, bool put_in_tempdir, bool includeall, std::string & result_file) const; /// - ExportStatus doExport(std::string const & target, bool put_in_tempdir, - bool includeall) 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; @@ -660,10 +705,15 @@ public: /// typedef std::vector > References; - References & references(docstring const & label); + /// References const & references(docstring const & label) const; + /// + void addReference(docstring const & label, Inset * inset, ParIterator it); + /// void clearReferenceCache() const; + /// void setInsetLabel(docstring const & label, InsetLabel const * il); + /// InsetLabel const * insetLabel(docstring const & label) const; /// return a list of all used branches (also in children) @@ -697,6 +747,18 @@ public: /// void checkMasterBuffer(); + /// If the document is being saved to a new location and the named file + /// exists at the old location, return its updated path relative to the + /// new buffer path if possible, otherwise return its absolute path. + /// In all other cases, this is a no-op and name is returned unchanged. + /// If a non-empty ext is given, the existence of name.ext is checked + /// but the returned path will not contain this extension. + /// Similarly, when loading a document that was moved from the location + /// where it was saved, return the correct path relative to the new + /// location. + std::string includedFilePath(std::string const & name, + std::string const & ext = empty_string()) const; + /// compute statistics between \p from and \p to /// \p from initial position /// \p to points to the end position @@ -707,12 +769,19 @@ 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: - class MarkAsExporting; friend class MarkAsExporting; /// mark the buffer as busy exporting something, or not void setExportStatus(bool e) const; + /// + References & getReferenceCache(docstring const & label); /// Change name of buffer. Updates "read-only" flag. void setFileName(support::FileName const & fname); /// @@ -726,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; @@ -742,6 +811,25 @@ private: }; +/// Helper class, to guarantee that the export status +/// gets reset properly. To use, simply create a local variable: +/// MarkAsExporting mex(bufptr); +/// and leave the rest to us. +class MarkAsExporting { +public: + MarkAsExporting(Buffer const * buf) : buf_(buf) + { + buf_->setExportStatus(true); + } + ~MarkAsExporting() + { + buf_->setExportStatus(false); + } +private: + Buffer const * const buf_; +}; + + } // namespace lyx #endif