#ifndef BUFFER_H
#define BUFFER_H
+#include "OutputEnums.h"
#include "update_flags.h"
#include "insets/InsetCode.h"
#include "support/strfwd.h"
#include "support/types.h"
-#include "support/SignalSlot.h"
#include <list>
+#include <set>
#include <string>
#include <vector>
};
/// Constructor
- explicit Buffer(std::string const & file, bool b = false);
+ explicit Buffer(std::string const & file, bool readonly = false,
+ Buffer const * cloned_buffer = 0);
/// Destructor
~Buffer();
+ ///
+ Buffer * clone() const;
+ ///
+ bool isClone() const;
+
/** High-level interface to buffer functionality.
This function parses a command string and executes it.
*/
*/
bool readDocument(Lexer &);
- ///
- void insertStringAsLines(ParagraphList & plist,
- pit_type &, pos_type &,
- Font const &, docstring const &, bool);
///
DocIterator getParFromID(int id) const;
/// do we have a paragraph with this id?
/// Write document to stream. Returns \c false if unsuccesful.
bool write(std::ostream &) const;
+ /// save emergency file
+ /// \return a status message towards the user.
+ docstring emergencyWrite();
/// Write file. Returns \c false if unsuccesful.
bool writeFile(support::FileName const &) const;
- /// Loads LyX file \c filename into buffer, * and \return success
+ /// Loads LyX file \c filename into buffer, * and return success
bool loadLyXFile(support::FileName const & s);
+ /// Reloads the LyX file
+ bool reload();
/// Fill in the ErrorList with the TeXErrors
void bufferErrors(TeXErrors const &, ErrorList &) const;
/// return true if the main lyx file does not need saving
bool isClean() const;
///
- bool isBakClean() const;
- ///
bool isDepClean(std::string const & name) const;
/// whether or not disk file has been externally modified
/// mark the main lyx file as not needing saving
void markClean() const;
- ///
- void markBakClean() const;
-
///
void markDepClean(std::string const & name);
///
void setUnnamed(bool flag = true);
- ///
+ /// Whether or not a filename has been assigned to this buffer
bool isUnnamed() const;
+ /// Whether or not this buffer is internal.
+ ///
+ /// An internal buffer does not contain a real document, but some auxiliary text segment.
+ /// It is not associated with a filename, it is never saved, thus it does not need to be
+ /// automatically saved, nor it needs to trigger any "do you want to save ?" question.
+ bool isInternal() const;
+
/// Mark this buffer as dirty.
void markDirty();
/// \return true if \p child is a child of this \c Buffer.
bool isChild(Buffer * child) const;
- /// return a vector with all children and grandchildren
- std::vector<Buffer *> getChildren() const;
+ /// return a vector with all children (and grandchildren)
+ std::vector<Buffer *> getChildren(bool grand_children = true) const;
+
+ /// Add all children (and grandchildren) to supplied vector
+ void getChildren(std::vector<Buffer *> & children, bool grand_children = true) const;
/// Is buffer read-only?
bool isReadonly() const;
*/
void validate(LaTeXFeatures &) const;
- /// Update the cache with all bibfiles in use (including bibfiles
+ /// Update the list of all bibfiles in use (including bibfiles
/// of loaded child documents).
void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
- ///
- void invalidateBibinfoCache();
- /// Return the cache with all bibfiles in use (including bibfiles
+ /// Return the list with all bibfiles in use (including bibfiles
/// of loaded child documents).
support::FileNameList const &
getBibfilesCache(UpdateScope scope = UpdateMaster) const;
+ /// Information from BibTeX databases is cached in the Buffer, so
+ /// we do not have to read the file over and over.
+ /// Calling this method invalidates the cache and so requires a
+ /// re-read.
+ void invalidateBibinfoCache();
+ /// Updates the cached bibliography information.
+ /// Note that you MUST call this method to update the cache. It will
+ /// not happen otherwise. (Currently, it is called at the start of
+ /// updateLabels() and from GuiCitation.)
+ void checkBibInfoCache() 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 macro defined before the inclusion of the child
MacroData const * getMacro(docstring const & name, Buffer const & child, bool global = true) const;
+ /// Collect user macro names at loading time
+ typedef std::set<docstring> UserMacroSet;
+ UserMacroSet usermacros;
+
/// Replace the inset contents for insets which InsetCode is equal
/// to the passed \p inset_code.
void changeRefsIfUnique(docstring const & from, docstring const & to,
Undo & undo();
/// This function is called when the buffer is changed.
- void changed() const;
+ void changed(bool update_metrics) const;
+ ///
+ void setChild(DocIterator const & dit, Buffer * child);
///
void updateTocItem(std::string const &, DocIterator const &) const;
/// This function is called when the buffer structure is changed.
void errors(std::string const & err, bool from_master = false) const;
/// This function is called when the buffer busy status change.
void setBusy(bool on) const;
- /// This function is called when the buffer readonly status change.
- void setReadOnly(bool on) const;
/// Update window titles of all users.
void updateTitles() const;
/// Reset autosave timers for all users.
///
bool doExport(std::string const & format, bool put_in_tempdir,
- std::string & result_file) const;
+ bool includeall, std::string & result_file) const;
///
- bool doExport(std::string const & format, bool put_in_tempdir) const;
+ bool doExport(std::string const & format, bool put_in_tempdir,
+ bool includeall = false) const;
///
- bool preview(std::string const & format) const;
+ bool preview(std::string const & format, bool includeall = false) const;
///
bool isExportable(std::string const & format) const;
///
std::vector<Format const *> exportableFormats(bool only_viewable) const;
+ ///
+ bool isExportableFormat(std::string const & format) const;
///
typedef std::vector<std::pair<InsetRef *, ParIterator> > References;
// 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;
- ///
- void updateLabels(UpdateScope = UpdateMaster) const;
- ///
- void updateLabels(ParIterator & parit) 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.
+ void updateLabels() const { updateLabels(UpdateMaster, InternalUpdate); }
+ /// \param scope: whether to start with the master document or just
+ /// do this one.
+ /// \param output: whether we are preparing for output.
+ void updateLabels(UpdateScope scope, UpdateType utype) const;
+ ///
+ void updateLabels(ParIterator & parit, UpdateType utype) const;
/// Spellcheck starting from \p from.
/// \p from initial position, will then points to the next misspelled
WordLangTuple & word_lang, docstring_list & suggestions) const;
private:
- /// search for macro in local (buffer) table or in children
- MacroData const * getBufferMacro(docstring const & name,
- DocIterator const & pos) const;
- /** Update macro table starting with position of it
- \param it in some text inset
- */
- void updateMacros(DocIterator & it,
- DocIterator & scope) const;
-
- ///
- void collectRelatives(BufferSet & bufs) const;
-
///
bool readFileHelper(support::FileName const & s);
///
class Impl;
/// The pointer never changes although *pimpl_'s contents may.
Impl * const d;
-
- frontend::GuiBufferDelegate * gui_;
-
- /// This function is called when the buffer structure is changed.
- Signal structureChanged_;
- /// This function is called when some parsing error shows up.
- //Signal errors(std::string const &) = 0;
- /// This function is called when some message shows up.
- //Signal message(docstring const &) = 0;
- /// This function is called when the buffer busy status change.
- //Signal setBusy(bool) = 0;
- /// Reset autosave timers for all users.
- Signal resetAutosaveTimers_;
};
projects / lyx.git / blobdiff