#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 "support/SignalSlot.h"
-#include <iosfwd>
#include <string>
-#include <utility>
#include <vector>
namespace lyx {
class BufferParams;
-class EmbeddedFiles;
+class EmbeddedFileList;
+class DocIterator;
class ErrorItem;
class ErrorList;
class FuncRequest;
class Inset;
+class InsetRef;
+class InsetLabel;
class Font;
class Format;
class Lexer;
class LaTeXFeatures;
class Language;
class MacroData;
+class MacroNameSet;
+class MacroSet;
class OutputParams;
+class Paragraph;
class ParConstIterator;
class ParIterator;
class ParagraphList;
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.
wrongversion ///< The version of the file does not match ours
};
+
/// Method to check if a file is externally modified, used by
/// isExternallyModified()
/**
* 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
};
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;
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
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;
/// returns the main language for the buffer (document)
Language const * language() const;
/// get l10n translated to the buffers language
/// 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;
+ 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();
/** 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();
/// Is buffer read-only?
bool isReadonly() const;
/// Update the cache with all bibfiles in use (including bibfiles
/// of loaded child documents).
- void updateBibfilesCache();
+ void updateBibfilesCache() const;
/// Return the cache with all bibfiles in use (including bibfiles
/// of loaded child documents).
- std::vector<support::FileName> const & getBibfilesCache() const;
+ support::FileNameList const & getBibfilesCache() const;
///
void getLabelList(std::vector<docstring> &) const;
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;
///
//
// 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;
/// Replace the inset contents for insets which InsetCode is equal
/// to the passed \p inset_code.
void getSourceCode(odocstream & os, pit_type par_begin, pit_type par_end,
bool full_source);
- /// Access to error list
- ErrorList const & errorList(std::string const & type) const;
- ErrorList & errorList(std::string const & type);
-
- //@{
- TocBackend & tocBackend();
- TocBackend const & tocBackend() const;
- //@}
+ /// 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;
+
+ /// 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;
//@{
- EmbeddedFiles & embeddedFiles();
- EmbeddedFiles const & embeddedFiles() const;
+ EmbeddedFileList & embeddedFiles();
+ EmbeddedFileList const & embeddedFiles() const;
+ bool embedded() const;
//@}
Undo & undo();
/// 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 readonly(bool on) const;
+ void setReadOnly(bool on) const;
/// Update window titles of all users.
void updateTitles() const;
/// Reset autosave timers for all users.
///
void autoSave() const;
- ///
- bool writeAs(std::string const & newname = std::string());
- ///
- bool menuWrite();
- ///
- void loadChildDocuments() const;
+
/// return the format of the buffer on a string
std::string bufferFormat() const;
///
bool doExport(std::string const & format, bool put_in_tempdir,
- std::string & result_file);
+ 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) const;
///
- bool preview(std::string const & format);
+ bool preview(std::string const & format) const;
///
bool isExportable(std::string const & format) const;
///
std::vector<Format const *> exportableFormats(bool only_viewable) const;
+ ///
+ typedef std::vector<std::pair<InsetRef *, 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;
+
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;
+
+ ///
bool readFileHelper(support::FileName const & s);
///
std::vector<std::string> backends() 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_;
+ 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