#ifndef BUFFER_H
#define BUFFER_H
-#include "ErrorList.h"
-#include "InsetList.h"
-
#include "DocIterator.h"
#include "support/FileName.h"
#include <iosfwd>
#include <string>
-#include <map>
#include <utility>
#include <vector>
class BufferParams;
class ErrorItem;
+class ErrorList;
class FuncRequest;
-class InsetBase;
+class Inset;
class InsetText;
-class LyXFont;
-class LyXLex;
+class Font;
+class Lexer;
class LyXRC;
-class LyXText;
+class Text;
class LyXVC;
class LaTeXFeatures;
class Language;
class ParConstIterator;
class ParIterator;
class ParagraphList;
-class StableDocIterator;
class TeXErrors;
class TexRow;
class TocBackend;
/** The buffer object.
* This is the buffer object. It contains all the informations about
* a document loaded into LyX.
- * The buffer object owns the LyXText (wrapped in an InsetText), which
+ * The buffer object owns the Text (wrapped in an InsetText), which
* contains the individual paragraphs of the document.
*
*
wrongversion ///< The version of the file does not match ours
};
+ /// 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 second. 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.
+ */
+ enum CheckMethod {
+ checksum_method, ///< Use file check sum
+ timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
+ };
+
/** Constructor
\param file
\param b optional \c false by default
bool readFile(support::FileName const & filename);
/// read the header, returns number of unknown tokens
- int readHeader(LyXLex & lex);
+ int readHeader(Lexer & lex);
/** Reads a file without header.
\param par if != 0 insert the file.
\return \c false if file is not completely read.
*/
- bool readDocument(LyXLex &);
+ bool readDocument(Lexer &);
///
void insertStringAsLines(ParagraphList & plist,
pit_type &, pos_type &,
- LyXFont const &, docstring const &, bool);
+ Font const &, docstring const &, bool);
///
ParIterator getParFromID(int id) const;
/// do we have a paragraph with this id?
boost::signal<void()> changed;
/// This signal is emitted when the buffer structure is changed.
boost::signal<void()> structureChanged;
+ /// This signal is emitted when an embedded file is changed
+ boost::signal<void()> embeddingChanged;
/// This signal is emitted when some parsing error shows up.
boost::signal<void(std::string)> errors;
/// This signal is emitted when some message shows up.
/// Reset autosave timers for all users.
boost::signal<void()> resetAutosaveTimers;
/// This signal is emitting if the buffer is being closed.
- boost::signal<void()> closing;
+ boost::signal<void(Buffer *)> closing;
/** Save file.
///
bool isDepClean(std::string const & name) const;
+ /// whether or not disk file has been externally modified
+ bool isExternallyModified(CheckMethod method) const;
+
+ /// save timestamp and checksum of the given file.
+ void saveCheckSum(std::string const & file) const;
+
/// mark the main lyx file as not needing saving
void markClean() const;
*/
void validate(LaTeXFeatures &) const;
- /// return all bibkeys from buffer and its childs
- void fillWithBibKeys(std::vector<std::pair<std::string, docstring> > & keys) const;
/// Update the cache with all bibfiles in use (including bibfiles
/// of loaded child documents).
void updateBibfilesCache();
void fully_loaded(bool);
/// Our main text (inside the top InsetText)
- LyXText & text() const;
+ Text & text() const;
/// Our top InsetText!
- InsetBase & inset() const;
+ Inset & inset() const;
//
// Macro handling
///
void insertMacro(docstring const & name, MacroData const & data);
- ///
- void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
- ///
- StableDocIterator getCursor() const { return cursor_; }
- ///
- StableDocIterator getAnchor() const { return anchor_; }
///
void changeRefsIfUnique(docstring const & from, docstring const & to,
- InsetBase::Code code);
+ Inset::Code code);
/// get source code (latex/docbook) for some paragraphs, or all paragraphs
/// including preamble
void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end, bool full_source);
TocBackend & tocBackend();
TocBackend const & tocBackend() const;
//@}
+
+ //@{
+ EmbeddedFiles & embeddedFiles();
+ EmbeddedFiles const & embeddedFiles() const;
+ //@}
private:
/** Inserts a file into a document
\return \c false if method fails.
*/
- ReadStatus readFile(LyXLex &, support::FileName const & filename,
- bool fromString = false);
+ ReadStatus readFile(Lexer &, support::FileName const & filename,
+ bool fromString = false);
/// Use the Pimpl idiom to hide the internals.
class Impl;
/// The pointer never changes although *pimpl_'s contents may.
boost::scoped_ptr<Impl> const pimpl_;
- /// Save the cursor Position on Buffer switch
- /// this would not be needed if every Buffer would have
- /// it's BufferView, this should be FIXED in future.
- StableDocIterator cursor_;
- StableDocIterator anchor_;
/// A cache for the bibfiles (including bibfiles of loaded child
/// documents), needed for appropriate update of natbib labels.
mutable std::vector<support::FileName> bibfilesCache_;
-
- /// Container for all sort of Buffer dependant errors.
- std::map<std::string, ErrorList> errorLists_;
};
projects / lyx.git / blobdiff