* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFER_H
#define BUFFER_H
+#include "OutputEnums.h"
+#include "update_flags.h"
+
#include "insets/InsetCode.h"
-#include "support/FileName.h"
-#include "support/docstring.h"
-#include "support/docstream.h"
+#include "support/strfwd.h"
#include "support/types.h"
-#include <iosfwd>
+#include <list>
+#include <set>
#include <string>
-#include <utility>
#include <vector>
namespace lyx {
+class BiblioInfo;
class BufferParams;
-class EmbeddedFiles;
-class ErrorItem;
+class BufferSet;
+class DispatchResult;
+class DocIterator;
+class docstring_list;
class ErrorList;
class FuncRequest;
+class FuncStatus;
class Inset;
+class InsetRef;
+class InsetLabel;
class Font;
class Format;
class Lexer;
-class LyXRC;
class Text;
class LyXVC;
class LaTeXFeatures;
class Language;
class MacroData;
+class MacroNameSet;
+class MacroSet;
class OutputParams;
+class Paragraph;
class ParConstIterator;
class ParIterator;
class ParagraphList;
class TexRow;
class TocBackend;
class Undo;
+class WordLangTuple;
namespace frontend {
class GuiBufferDelegate;
class WorkAreaManager;
}
+namespace support {
+class FileName;
+class FileNameList;
+}
+
/** The buffer object.
* This is the buffer object. It contains all the informations about
* a document loaded into LyX.
*
* I am not sure if the class is complete or
* minimal, probably not.
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
*/
class Buffer {
public:
wrongversion ///< The version of the file does not match ours
};
- /// Method to check if a file is externally modified, used by
+
+ /// 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
+ * 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 check sum
+ checksum_method, ///< Use file checksum
timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
};
-
- /** Constructor
- \param file
- \param b optional \c false by default
- */
- explicit Buffer(std::string const & file, bool b = false);
+
+ ///
+ enum UpdateScope {
+ UpdateMaster,
+ UpdateChildOnly
+ };
+
+ /// Constructor
+ 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
+ This function parses a command string and executes it.
*/
- bool dispatch(std::string const & command, bool * result = 0);
+ void dispatch(std::string const & command, DispatchResult & result);
/// Maybe we know the function already by number...
- bool dispatch(FuncRequest const & func, bool * result = 0);
+ void dispatch(FuncRequest const & func, DispatchResult & result);
- /// Load the autosaved file.
- void loadAutoSaveFile();
+ /// Can this function be exectued?
+ /// \return true if we made a decision
+ bool getStatus(FuncRequest const & cmd, FuncStatus & flag);
/// read a new document from a string
bool readString(std::string const &);
/** Reads a file without header.
\param par if != 0 insert the file.
- \return \c false if file is not completely read.
+ \return \c true if file is not completely read.
*/
bool readDocument(Lexer &);
///
- void insertStringAsLines(ParagraphList & plist,
- pit_type &, pos_type &,
- Font const &, docstring const &, bool);
- ///
- ParIterator getParFromID(int id) const;
+ DocIterator getParFromID(int id) const;
/// do we have a paragraph with this id?
bool hasParWithID(int id) const;
/// 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;
std::string const & original_path,
OutputParams const &,
bool output_preamble = true,
- bool output_body = true);
+ bool output_body = true) const;
/** Export the buffer to LaTeX.
If \p os is a file stream, and params().inputenc is "auto" or
"default", and the buffer contains text in different languages
encoding associated to \p os. Therefore you must not call this
method with a string stream if the output is supposed to go to a
file. \code
- odocfstream ofs;
+ ofdocstream ofs;
ofs.open("test.tex");
writeLaTeXSource(ofs, ...);
ofs.close();
\endcode is NOT equivalent to \code
odocstringstream oss;
writeLaTeXSource(oss, ...);
- odocfstream ofs;
+ ofdocstream ofs;
ofs.open("test.tex");
ofs << oss.str();
ofs.close();
std::string const & original_path,
OutputParams const &,
bool output_preamble = true,
- bool output_body = true);
+ bool output_body = true) const;
///
void makeDocBookFile(support::FileName const & filename,
OutputParams const & runparams_in,
- bool only_body = false);
+ bool only_body = false) const;
///
void writeDocBookSource(odocstream & os, std::string const & filename,
OutputParams const & runparams_in,
- bool only_body = false);
+ bool only_body = false) const;
+ ///
+ void makeLyXHTMLFile(support::FileName const & filename,
+ OutputParams const & runparams_in,
+ bool only_body = false) const;
+ ///
+ void writeLyXHTMLSource(odocstream & os,
+ OutputParams const & runparams_in,
+ bool only_body = false) const;
/// returns the main language for the buffer (document)
Language const * language() const;
/// get l10n translated to the buffers language
/// 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();
+ /// Returns the buffer's filename. It is always an absolute path.
+ support::FileName fileName() const;
+
/// Returns the buffer's filename. It is always an absolute path.
std::string absFileName() const;
/// Returns the the path where the buffer lives.
/// It is always an absolute path.
- std::string const & filePath() const;
+ std::string filePath() const;
/** A transformed version of the file name, adequate for LaTeX.
\param no_path optional if \c true then the path is stripped.
*/
std::string latexName(bool no_path = true) const;
- /// Get thee name and type of the log.
- std::pair<LogType, std::string> logName() const;
+ /// Get the name and type of the log.
+ std::string logName(LogType * type = 0) const;
/// Change name of buffer. Updates "read-only" flag.
void setFileName(std::string const & newfile);
- /// Name of the document's parent
- void setParentName(std::string const &);
+ /// Set document's parent Buffer.
+ void setParent(Buffer const *);
+ Buffer const * parent() const;
+
+ // Collect all relative buffer
+ std::vector<Buffer const *> allRelatives() const;
/** Get the document's master (or \c this if this is not a
child document)
*/
Buffer const * masterBuffer() const;
- /** Get the document's master (or \c this if this is not a
- child document)
- */
- Buffer * masterBuffer();
+
+ /// \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(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();
- /// Return the cache with all bibfiles in use (including bibfiles
+ void updateBibfilesCache(UpdateScope scope = UpdateMaster) const;
+ /// Return the list with all bibfiles in use (including bibfiles
/// of loaded child documents).
- std::vector<support::FileName> const & getBibfilesCache() const;
+ 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 the bibliography information for this buffer ONLY.
+ BiblioInfo const & localBibInfo() const;
///
void getLabelList(std::vector<docstring> &) const;
///
bool isMultiLingual() const;
+ ///
+ std::set<Language const *> getLanguages() const;
///
BufferParams & params();
LyXVC const & lyxvc() const;
/// Where to put temporary files.
- std::string const & temppath() const;
+ std::string const temppath() const;
/// Used when typesetting to place errorboxes.
- TexRow & texrow();
TexRow const & texrow() const;
+ TexRow & texrow();
///
ParIterator par_iterator_begin();
///
ParConstIterator par_iterator_end() const;
+ // Position of the child buffer where it appears first in the master.
+ DocIterator firstChildPosition(Buffer const * child);
+
/** \returns true only when the file is fully loaded.
* Used to prevent the premature generation of previews
* and by the citation inset.
//
// Macro handling
//
- ///
- void buildMacros();
- ///
- bool hasMacro(docstring const & name) const;
- ///
- MacroData const & getMacro(docstring const & name) const;
- ///
- void insertMacro(docstring const & name, MacroData const & data);
+ /// Collect macro definitions in paragraphs
+ void updateMacros() const;
+ /// Iterate through the whole buffer and try to resolve macros
+ void updateMacroInstances() const;
+
+ /// List macro names of this buffer, the parent and the children
+ void listMacroNames(MacroNameSet & macros) const;
+ /// Collect macros of the parent and its children in front of this buffer.
+ void listParentMacros(MacroSet & macros, LaTeXFeatures & features) const;
+
+ /// Return macro defined before pos (or in the master buffer)
+ MacroData const * getMacro(docstring const & name, DocIterator const & pos, bool global = true) const;
+ /// Return macro defined anywhere in the buffer (or in the master buffer)
+ MacroData const * getMacro(docstring const & name, bool global = true) 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.
/// 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);
+ bool full_source) const;
- /// Access to error list
- ErrorList const & errorList(std::string const & type) const;
- ErrorList & errorList(std::string const & type);
+ /// Access to error list.
+ /// This method is used only for GUI visualisation of Buffer related
+ /// errors (like parsing or LateX compilation). This method is const
+ /// because modifying the returned ErrorList does not touch the document
+ /// contents.
+ ErrorList & errorList(std::string const & type) const;
- //@{
- TocBackend & tocBackend();
- TocBackend const & tocBackend() const;
- //@}
-
- //@{
- EmbeddedFiles & embeddedFiles();
- EmbeddedFiles const & embeddedFiles() const;
- //@}
+ /// The Toc backend.
+ /// This is useful only for screen visualisation of the Buffer. This
+ /// method is const because modifying this backend does not touch
+ /// the document contents.
+ TocBackend & tocBackend() const;
+ ///
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 structureChanged() const;
/// This function is called when some parsing error shows up.
- void errors(std::string const & err) const;
+ 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.
///
void message(docstring const & msg) const;
+ ///
void setGuiDelegate(frontend::GuiBufferDelegate * gui);
+ ///
+ bool hasGuiDelegate() const;
///
void autoSave() const;
///
- bool writeAs(std::string const & newname = std::string());
+ void removeAutosaveFile() const;
///
- bool menuWrite();
+ void moveAutosaveFile(support::FileName const & old) const;
///
- void loadChildDocuments() const;
+ support::FileName getAutosaveFilename() const;
+
/// return the format of the buffer on a string
std::string bufferFormat() const;
+ /// return the default output format of the current backend
+ std::string getDefaultOutputFormat() const;
///
bool doExport(std::string const & format, bool put_in_tempdir,
- std::string & result_file);
+ bool includeall, std::string & result_file) const;
///
- bool doExport(std::string const & format, bool put_in_tempdir);
+ bool doExport(std::string const & format, bool put_in_tempdir,
+ bool includeall = false) const;
///
- bool preview(std::string const & format);
+ 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<Inset *, ParIterator> > References;
+ References & references(docstring const & label);
+ References const & references(docstring const & label) const;
+ 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)
+ void getUsedBranches(std::list<docstring> &, bool const from_master = false) const;
+
+ /// sets the buffer_ member for every inset in this buffer.
+ // 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;
+ /// 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
+ /// word.
+ /// \p to will points to the end of the next misspelled word.
+ /// \p word_lang will contain the found misspelled word.
+ /// \return progress if a new word was found.
+ int spellCheck(DocIterator & from, DocIterator & to,
+ WordLangTuple & word_lang, docstring_list & suggestions) const;
private:
- ///
+ ///
bool readFileHelper(support::FileName const & s);
///
std::vector<std::string> backends() const;
*/
ReadStatus readFile(Lexer &, support::FileName const & filename,
bool fromString = false);
+ ///
+ void getLanguages(std::set<Language const *> &) const;
/// Use the Pimpl idiom to hide the internals.
class Impl;
/// The pointer never changes although *pimpl_'s contents may.
- Impl * const pimpl_;
-
- /// A cache for the bibfiles (including bibfiles of loaded child
- /// documents), needed for appropriate update of natbib labels.
- mutable std::vector<support::FileName> bibfilesCache_;
-
- frontend::GuiBufferDelegate * gui_;
+ Impl * const d;
};
projects / lyx.git / blobdiff