lyx_mirror/src/Buffer.h

528 lines
15 KiB
C
Raw Normal View History

// -*- C++ -*-
/**
* \file Buffer.h
* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
* \author Lars Gullik Bj<EFBFBD>nnes
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFER_H
#define BUFFER_H
#include "insets/InsetCode.h"
#include "support/strfwd.h"
#include "support/types.h"
#include "support/SignalSlot.h"
#include <set>
#include <string>
#include <vector>
namespace lyx {
class BiblioInfo;
class BufferParams;
class DocIterator;
class ErrorItem;
class ErrorList;
class FuncRequest;
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;
the stuff from the sneak preview: For one, it still contains a few things that are already in CVS (the 'brown paperbag' changes). Secondly, this changes the ParagraphList to a std::vector but does not yet take full advantage of it except removing LyXText::parOffset() and similar. I had an extensive talk with my profiler and we are happy nevertheless. This also moves almost all Cut&Paste specific stuff from text.C to CutAndPaste.C. Much smaller interface now... Namespace CutAndPaste is now lyx::cap::. Was inconsistent with the rest.... Make ParagraphList a proper class. We'll need this later for a specialized erase/insert. Remove some unneeded prototypes and function declarations Use ParameterStruct directly instead of ShareContainer<ParameterStruct> Inline a few accesses to CursorSlice members as suggested by the profiler. Fix commandline conversion crash reported by Kayvan. Replace PosIterator by DocumentIterator. The latter can also iterate through math and nested text in math... Remove math specific hack from Documentiterator Derive InsetCollapsable from InsetText instead of using an InsetText member. This give us the opportunity to get rid of the InsetOld::owner_ backpointer. Cosmetics in CutAndPaste.C and cursor.C. Fix nasty crash (popping slices off an empty selection anchor). Add a few asserts. Remove all 'manual' update calls. We do now one per user interaction which is completely sufficient. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@8527 a592a061-630c-0410-9148-cb99ea01b6c8
2004-03-25 09:16:36 +00:00
class ParIterator;
class ParagraphList;
class TeXErrors;
class TexRow;
class TocBackend;
class Undo;
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.
* The buffer object owns the Text (wrapped in an InsetText), which
* contains the individual paragraphs of the document.
*
*
* I am not sure if the class is complete or
* minimal, probably not.
* \author Lars Gullik Bj<EFBFBD>nnes
*/
class Buffer {
public:
/// What type of log will \c getLogName() return?
enum LogType {
latexlog, ///< LaTeX log
buildlog ///< Literate build log
};
Fix bug 2138: copy and paste should preserve formatting between different LyX instances. This re-enables copy/paste from the internal clipboard on OS X (currently broken since Clipboard::isInternal() always returns false for some reason). * src/insets/insettabular.C (InsetTabular::doDispatch): adjust to clipboard interface change (InsetTabular::copySelection): ditto * src/mathed/InsetMathGrid.C (InsetMathGrid::doDispatch): ditto * src/mathed/InsetMathNest.C (InsetMathNest::doDispatch): ditto * src/buffer.[Ch] (Buffer::readString): New method: Read document from a string (Buffer::readFile): Change return value from bool to enum (needed for readString). Return wrongversion if we are reading from a string and the version does not match. (Buffer::do_writeFile): make public and rename to write * src/CutAndPaste.C (putClipboard): New helper, put stuff to the system clipboard (void copySelectionHelper): Use putClipboard instead of theClipboard().put() (void copySelection): ditto (void pasteClipboard): new method for pasting in text (void pasteParagraphList): * src/frontends/Clipboard.h (Clipboard::get): Rename to getAsText (Clipboard::getAsLyX): New method for getting the system clipboard in LyX format (Clipboard::hasLyXContents): New method telling whether there is LyX contents in the clipboard * src/frontends/qt4/GuiClipboard.[Ch]: Implement the new methods * src/text3.C (LyXText::dispatch): Use pasteClipboard for pasting the system clipboard git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16669 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-13 18:29:50 +00:00
/// Result of \c readFile()
enum ReadStatus {
failure, ///< The file could not be read
success, ///< The file could not be read
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.
*
* FIXME: replace this method with support/FileMonitor.
*/
enum CheckMethod {
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);
/// Destructor
~Buffer();
/** High-level interface to buffer functionality.
This function parses a command string and executes it
*/
bool dispatch(std::string const & command, bool * result = 0);
/// Maybe we know the function already by number...
bool dispatch(FuncRequest const & func, bool * result = 0);
Fix bug 2138: copy and paste should preserve formatting between different LyX instances. This re-enables copy/paste from the internal clipboard on OS X (currently broken since Clipboard::isInternal() always returns false for some reason). * src/insets/insettabular.C (InsetTabular::doDispatch): adjust to clipboard interface change (InsetTabular::copySelection): ditto * src/mathed/InsetMathGrid.C (InsetMathGrid::doDispatch): ditto * src/mathed/InsetMathNest.C (InsetMathNest::doDispatch): ditto * src/buffer.[Ch] (Buffer::readString): New method: Read document from a string (Buffer::readFile): Change return value from bool to enum (needed for readString). Return wrongversion if we are reading from a string and the version does not match. (Buffer::do_writeFile): make public and rename to write * src/CutAndPaste.C (putClipboard): New helper, put stuff to the system clipboard (void copySelectionHelper): Use putClipboard instead of theClipboard().put() (void copySelection): ditto (void pasteClipboard): new method for pasting in text (void pasteParagraphList): * src/frontends/Clipboard.h (Clipboard::get): Rename to getAsText (Clipboard::getAsLyX): New method for getting the system clipboard in LyX format (Clipboard::hasLyXContents): New method telling whether there is LyX contents in the clipboard * src/frontends/qt4/GuiClipboard.[Ch]: Implement the new methods * src/text3.C (LyXText::dispatch): Use pasteClipboard for pasting the system clipboard git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16669 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-13 18:29:50 +00:00
/// read a new document from a string
bool readString(std::string const &);
/// load a new file
bool readFile(support::FileName const & filename);
/// read the header, returns number of unknown tokens
int readHeader(Lexer & lex);
/** Reads a file without header.
\param par if != 0 insert the file.
\return \c true if file is not completely read.
*/
bool readDocument(Lexer &);
///
the stuff from the sneak preview: For one, it still contains a few things that are already in CVS (the 'brown paperbag' changes). Secondly, this changes the ParagraphList to a std::vector but does not yet take full advantage of it except removing LyXText::parOffset() and similar. I had an extensive talk with my profiler and we are happy nevertheless. This also moves almost all Cut&Paste specific stuff from text.C to CutAndPaste.C. Much smaller interface now... Namespace CutAndPaste is now lyx::cap::. Was inconsistent with the rest.... Make ParagraphList a proper class. We'll need this later for a specialized erase/insert. Remove some unneeded prototypes and function declarations Use ParameterStruct directly instead of ShareContainer<ParameterStruct> Inline a few accesses to CursorSlice members as suggested by the profiler. Fix commandline conversion crash reported by Kayvan. Replace PosIterator by DocumentIterator. The latter can also iterate through math and nested text in math... Remove math specific hack from Documentiterator Derive InsetCollapsable from InsetText instead of using an InsetText member. This give us the opportunity to get rid of the InsetOld::owner_ backpointer. Cosmetics in CutAndPaste.C and cursor.C. Fix nasty crash (popping slices off an empty selection anchor). Add a few asserts. Remove all 'manual' update calls. We do now one per user interaction which is completely sufficient. git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@8527 a592a061-630c-0410-9148-cb99ea01b6c8
2004-03-25 09:16:36 +00:00
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?
bool hasParWithID(int id) const;
///
frontend::WorkAreaManager & workAreaManager() const;
/** Save file.
Takes care of auto-save files and backup file if requested.
Returns \c true if the save is successful, \c false otherwise.
*/
bool save() const;
Fix bug 2138: copy and paste should preserve formatting between different LyX instances. This re-enables copy/paste from the internal clipboard on OS X (currently broken since Clipboard::isInternal() always returns false for some reason). * src/insets/insettabular.C (InsetTabular::doDispatch): adjust to clipboard interface change (InsetTabular::copySelection): ditto * src/mathed/InsetMathGrid.C (InsetMathGrid::doDispatch): ditto * src/mathed/InsetMathNest.C (InsetMathNest::doDispatch): ditto * src/buffer.[Ch] (Buffer::readString): New method: Read document from a string (Buffer::readFile): Change return value from bool to enum (needed for readString). Return wrongversion if we are reading from a string and the version does not match. (Buffer::do_writeFile): make public and rename to write * src/CutAndPaste.C (putClipboard): New helper, put stuff to the system clipboard (void copySelectionHelper): Use putClipboard instead of theClipboard().put() (void copySelection): ditto (void pasteClipboard): new method for pasting in text (void pasteParagraphList): * src/frontends/Clipboard.h (Clipboard::get): Rename to getAsText (Clipboard::getAsLyX): New method for getting the system clipboard in LyX format (Clipboard::hasLyXContents): New method telling whether there is LyX contents in the clipboard * src/frontends/qt4/GuiClipboard.[Ch]: Implement the new methods * src/text3.C (LyXText::dispatch): Use pasteClipboard for pasting the system clipboard git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16669 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-13 18:29:50 +00:00
/// 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
bool loadLyXFile(support::FileName const & s);
/// Fill in the ErrorList with the TeXErrors
void bufferErrors(TeXErrors const &, ErrorList &) const;
Make the output of \inputencoding commands (and the change of output encodings) more fine grained: From paragraph level to individual character level. The inputenc package supports that since at least 2000. * src/insets/insetbase.h (latex): Document the differences between output to a string stream and a file stream * src/buffer.h (writeLaTeXSource): ditto * src/output_latex.h (latexParagraphs): ditto (switchEncoding): new function to change the encoding of a stream (and output \inputencoding commands) * src/paragraph_pimpl.C (Paragraph::Pimpl::simpleTeXSpecialC): Adjust to latexWriteEndChanges changes * src/support/docstream.[Ch] (setEncoding, operator<<): New stream modifier that changes the encoding of file streams * src/lyxfont.[Ch] (LyXFont::latexWriteStartChanges): Change stream encoding if needed (LyXFont::latexWriteEndChanges): Change stream encoding if needed * src/lyxfont.h (public:): * src/paragraph.C (Paragraph::simpleTeXOnePar): Adjust to latexWriteStartChanges and latexWriteEndChanges changes (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): * src/output_latex.C (TeXOnePar): Remove the ugly hack to for wencoding changes and use switchEncoding instead. A nice side effect is that the old hack would not work if the main language encoding is latin1 and a character would be mapped to a cedilla in the "fake ucs4" encoding, because iconv refuses to convert such a character to latin1, although it exists in latin1 (it wants to attach it to a base character). git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16633 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-09 19:25:40 +00:00
/// Just a wrapper for writeLaTeXSource, first creating the ofstream.
bool makeLaTeXFile(support::FileName const & filename,
std::string const & original_path,
OutputParams const &,
bool output_preamble = true,
bool output_body = true) const;
Make the output of \inputencoding commands (and the change of output encodings) more fine grained: From paragraph level to individual character level. The inputenc package supports that since at least 2000. * src/insets/insetbase.h (latex): Document the differences between output to a string stream and a file stream * src/buffer.h (writeLaTeXSource): ditto * src/output_latex.h (latexParagraphs): ditto (switchEncoding): new function to change the encoding of a stream (and output \inputencoding commands) * src/paragraph_pimpl.C (Paragraph::Pimpl::simpleTeXSpecialC): Adjust to latexWriteEndChanges changes * src/support/docstream.[Ch] (setEncoding, operator<<): New stream modifier that changes the encoding of file streams * src/lyxfont.[Ch] (LyXFont::latexWriteStartChanges): Change stream encoding if needed (LyXFont::latexWriteEndChanges): Change stream encoding if needed * src/lyxfont.h (public:): * src/paragraph.C (Paragraph::simpleTeXOnePar): Adjust to latexWriteStartChanges and latexWriteEndChanges changes (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): * src/output_latex.C (TeXOnePar): Remove the ugly hack to for wencoding changes and use switchEncoding instead. A nice side effect is that the old hack would not work if the main language encoding is latin1 and a character would be mapped to a cedilla in the "fake ucs4" encoding, because iconv refuses to convert such a character to latin1, although it exists in latin1 (it wants to attach it to a base character). git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16633 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-09 19:25:40 +00:00
/** 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
with more than one encoding, then this method will change the
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
ofdocstream ofs;
Make the output of \inputencoding commands (and the change of output encodings) more fine grained: From paragraph level to individual character level. The inputenc package supports that since at least 2000. * src/insets/insetbase.h (latex): Document the differences between output to a string stream and a file stream * src/buffer.h (writeLaTeXSource): ditto * src/output_latex.h (latexParagraphs): ditto (switchEncoding): new function to change the encoding of a stream (and output \inputencoding commands) * src/paragraph_pimpl.C (Paragraph::Pimpl::simpleTeXSpecialC): Adjust to latexWriteEndChanges changes * src/support/docstream.[Ch] (setEncoding, operator<<): New stream modifier that changes the encoding of file streams * src/lyxfont.[Ch] (LyXFont::latexWriteStartChanges): Change stream encoding if needed (LyXFont::latexWriteEndChanges): Change stream encoding if needed * src/lyxfont.h (public:): * src/paragraph.C (Paragraph::simpleTeXOnePar): Adjust to latexWriteStartChanges and latexWriteEndChanges changes (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): * src/output_latex.C (TeXOnePar): Remove the ugly hack to for wencoding changes and use switchEncoding instead. A nice side effect is that the old hack would not work if the main language encoding is latin1 and a character would be mapped to a cedilla in the "fake ucs4" encoding, because iconv refuses to convert such a character to latin1, although it exists in latin1 (it wants to attach it to a base character). git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16633 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-09 19:25:40 +00:00
ofs.open("test.tex");
writeLaTeXSource(ofs, ...);
ofs.close();
\endcode is NOT equivalent to \code
odocstringstream oss;
writeLaTeXSource(oss, ...);
ofdocstream ofs;
Make the output of \inputencoding commands (and the change of output encodings) more fine grained: From paragraph level to individual character level. The inputenc package supports that since at least 2000. * src/insets/insetbase.h (latex): Document the differences between output to a string stream and a file stream * src/buffer.h (writeLaTeXSource): ditto * src/output_latex.h (latexParagraphs): ditto (switchEncoding): new function to change the encoding of a stream (and output \inputencoding commands) * src/paragraph_pimpl.C (Paragraph::Pimpl::simpleTeXSpecialC): Adjust to latexWriteEndChanges changes * src/support/docstream.[Ch] (setEncoding, operator<<): New stream modifier that changes the encoding of file streams * src/lyxfont.[Ch] (LyXFont::latexWriteStartChanges): Change stream encoding if needed (LyXFont::latexWriteEndChanges): Change stream encoding if needed * src/lyxfont.h (public:): * src/paragraph.C (Paragraph::simpleTeXOnePar): Adjust to latexWriteStartChanges and latexWriteEndChanges changes (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): (bool Paragraph::simpleTeXOnePar): * src/output_latex.C (TeXOnePar): Remove the ugly hack to for wencoding changes and use switchEncoding instead. A nice side effect is that the old hack would not work if the main language encoding is latin1 and a character would be mapped to a cedilla in the "fake ucs4" encoding, because iconv refuses to convert such a character to latin1, although it exists in latin1 (it wants to attach it to a base character). git-svn-id: svn://svn.lyx.org/lyx/lyx-devel/trunk@16633 a592a061-630c-0410-9148-cb99ea01b6c8
2007-01-09 19:25:40 +00:00
ofs.open("test.tex");
ofs << oss.str();
ofs.close();
\endcode
*/
void writeLaTeXSource(odocstream & os,
std::string const & original_path,
OutputParams const &,
bool output_preamble = true,
bool output_body = true) const;
///
void makeDocBookFile(support::FileName const & filename,
OutputParams const & runparams_in,
bool only_body = false) const;
///
void writeDocBookSource(odocstream & os, std::string const & filename,
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
docstring const B_(std::string const & l10n) const;
///
int runChktex();
/// 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
bool isExternallyModified(CheckMethod method) const;
/// save timestamp and checksum of the given file.
void saveCheckSum(support::FileName const & file) const;
/// 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);
///
bool isUnnamed() 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 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::string logName(LogType * type = 0) const;
/// Change name of buffer. Updates "read-only" flag.
void setFileName(std::string const & newfile);
/// 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;
/// \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;
/// Is buffer read-only?
bool isReadonly() const;
/// Set buffer read-only flag
void setReadonly(bool flag = true);
/// returns \c true if the buffer contains a LaTeX document
bool isLatex() const;
/// returns \c true if the buffer contains a DocBook document
bool isDocBook() const;
/// returns \c true if the buffer contains a Wed document
bool isLiterate() const;
/** Validate a buffer for LaTeX.
This validates the buffer, and returns a struct for use by
#makeLaTeX# and others. Its main use is to figure out what
commands and packages need to be included in the LaTeX file.
It (should) also check that the needed constructs are there
(i.e. that the \refs points to coresponding \labels). It
should perhaps inset "error" insets to help the user correct
obvious mistakes.
*/
void validate(LaTeXFeatures &) const;
/// Update the cache with all bibfiles in use (including bibfiles
/// of loaded child documents).
void updateBibfilesCache() const;
///
void invalidateBibinfoCache();
/// Return the cache with all bibfiles in use (including bibfiles
/// of loaded child documents).
support::FileNameList const & getBibfilesCache() 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;
///
void changeLanguage(Language const * from, Language const * to);
///
bool isMultiLingual() const;
///
BufferParams & params();
BufferParams const & params() const;
/** The list of paragraphs.
This is a linked list of paragraph, this list holds the
whole contents of the document.
*/
ParagraphList & paragraphs();
ParagraphList const & paragraphs() const;
/// LyX version control object.
LyXVC & lyxvc();
LyXVC const & lyxvc() const;
/// Where to put temporary files.
std::string const temppath() const;
/// Used when typesetting to place errorboxes.
TexRow const & texrow() const;
///
ParIterator par_iterator_begin();
///
ParConstIterator par_iterator_begin() const;
///
ParIterator par_iterator_end();
///
ParConstIterator par_iterator_end() const;
/** \returns true only when the file is fully loaded.
* Used to prevent the premature generation of previews
* and by the citation inset.
*/
bool isFullyLoaded() const;
/// Set by buffer_funcs' newFile.
void setFullyLoaded(bool);
/// Our main text (inside the top InsetText)
Text & text() const;
/// Our top InsetText
Inset & inset() const;
//
// Macro handling
//
/// 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;
mutable 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,
InsetCode 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) 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;
///
Undo & undo();
/// This function is called when the buffer is changed.
void changed() const;
///
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;
/// 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 resetAutosaveTimers() const;
///
void message(docstring const & msg) const;
///
void setGuiDelegate(frontend::GuiBufferDelegate * gui);
///
frontend::GuiBufferDelegate * guiDelegate() const { return gui_; }
///
void autoSave() const;
///
void removeAutosaveFile() const;
///
void moveAutosaveFile(support::FileName const & old) const;
///
support::FileName getAutosaveFilename() 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) const;
///
bool doExport(std::string const & format, bool put_in_tempdir) const;
///
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;
/** Inserts a file into a document
\return \c false if method fails.
*/
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.
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_;
};
} // namespace lyx
#endif