#include "OutputEnums.h"
#include "OutputParams.h"
-#include "insets/InsetCode.h"
-
#include "support/strfwd.h"
#include "support/types.h"
/** The buffer object.
- * This is the buffer object. It contains all the informations about
+ * This is the buffer object. It contains all the information about
* a document loaded into LyX.
* The buffer object owns the Text (wrapped in an InsetText), which
* contains the individual paragraphs of the document.
* minimal, probably not.
* \author Lars Gullik Bjønnes
*/
+
+class MarkAsExporting;
+
class Buffer {
public:
/// What type of log will \c getLogName() return?
/// isExternallyModified()
/**
* timestamp is fast but inaccurate. For example, the granularity
- * of timestamp on a FAT filesystem is 2 second. Also, various operations
+ * 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
/// 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
- ReadStatus reload();
+ /// \param clearUndo if false, leave alone the undo stack.
+ ReadStatus reload(bool clearUndo = true);
//FIXME: The following function should be private
//private:
/// read the header, returns number of unknown tokens
/// \return \c true if file is not completely read.
bool readDocument(Lexer &);
/// Try to extract the file from a version control container
- /// before reading if the file cannot be found. This is only
- /// implemented for RCS.
+ /// before reading if the file cannot be found.
/// \sa LyXVC::file_not_found_hook
ReadStatus extractFromVC();
/// Reads the first tag of a LyX File and
enum OutputWhat {
FullSource,
OnlyBody,
+ IncludedFile,
OnlyPreamble,
CurrentParagraph
};
/// automatically saved, nor it needs to trigger any "do you want to save ?" question.
bool isInternal() const;
+ void setInternal(bool flag);
+
/// Mark this buffer as dirty.
void markDirty();
/// 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;
/// add a single piece of bibliography info to our cache
void addBibTeXInfo(docstring const & key, BibTeXInfo const & bi) const;
///
+ void makeCitationLabels() const;
+ ///
bool citeLabelsValid() const;
///
void getLabelList(std::vector<docstring> &) const;
/// 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) const;
+ 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
bool includeall) const;
///
ExportStatus preview(std::string const & format, bool includeall = false) const;
+ ///
+ void setMathFlavor(OutputParams & op) const;
public:
///
///
typedef std::vector<std::pair<Inset *, ParIterator> > 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)
WordLangTuple & word_lang, docstring_list & suggestions) const;
///
void checkChildBuffers();
+ ///
+ void checkMasterBuffer();
+
+ /// compute statistics between \p from and \p to
+ /// \p from initial position
+ /// \p to points to the end position
+ /// \p skipNoOutput if notes etc. should be ignored
+ void updateStatistics(DocIterator & from, DocIterator & to,
+ bool skipNoOutput = true) const;
+ /// statistics accessor functions
+ int wordCount() const;
+ int charCount(bool with_blanks) 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);
///
};
+/// 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
projects / lyx.git / blobdiff