X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=6cb04bb7c0b72693b0bfe5a299554fb471ccaae6;hb=86fab2cefa122a5b0c0ee4ade472e41d9a3ff1cf;hp=568a28d162818e1372a12d0afddf44e498b6c9a8;hpb=a8cd9a4b8fd325b00c75f601c66c6d618ba276db;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 568a28d162..6cb04bb7c0 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -4,7 +4,7 @@ * 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. */ @@ -12,24 +12,34 @@ #ifndef BUFFER_H #define BUFFER_H +#include "update_flags.h" + #include "insets/InsetCode.h" -#include "support/FileName.h" #include "support/strfwd.h" #include "support/types.h" +#include "support/SignalSlot.h" +#include #include #include namespace lyx { +class BiblioInfo; class BufferParams; -class EmbeddedFiles; +class BufferSet; +class DispatchResult; +class DocIterator; +class docstring_list; class ErrorItem; class ErrorList; class FuncRequest; +class FuncStatus; class Inset; +class InsetRef; +class InsetLabel; class Font; class Format; class Lexer; @@ -39,6 +49,8 @@ class LyXVC; class LaTeXFeatures; class Language; class MacroData; +class MacroNameSet; +class MacroSet; class OutputParams; class Paragraph; class ParConstIterator; @@ -48,12 +60,18 @@ class TeXErrors; 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. @@ -63,7 +81,7 @@ class WorkAreaManager; * * 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: @@ -80,41 +98,48 @@ 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 - */ + + /// + enum UpdateScope { + UpdateMaster, + UpdateChildOnly + }; + + /// Constructor 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 + 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 &); @@ -126,7 +151,7 @@ public: /** 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 &); @@ -135,7 +160,7 @@ public: 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; @@ -153,7 +178,7 @@ public: /// 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); /// Fill in the ErrorList with the TeXErrors @@ -164,7 +189,7 @@ public: 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 @@ -172,14 +197,14 @@ public: 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(); @@ -189,15 +214,23 @@ public: 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 @@ -236,35 +269,44 @@ public: /// 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. + /// 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 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 getChildren() const; /// Is buffer read-only? bool isReadonly() const; @@ -292,10 +334,18 @@ public: /// Update the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - void updateBibfilesCache(); + void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; + /// + void invalidateBibinfoCache(); /// Return the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - std::vector const & getBibfilesCache() const; + support::FileNameList const & + getBibfilesCache(UpdateScope scope = UpdateMaster) 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 &) const; @@ -321,11 +371,11 @@ public: 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(); @@ -336,6 +386,9 @@ public: /// 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. @@ -353,16 +406,22 @@ public: // // Macro handling // - /// Collect macros in paragraphs - void updateMacros(); - /// Look for macro defined before par (or in the master buffer) - bool hasMacro(docstring const & name, Paragraph const & par) const; - /// Look for macro defined anywhere in the buffer (or in the master buffer) - bool hasMacro(docstring const & name) const; - /// Return macro defined before par (or in the master buffer) - MacroData const & getMacro(docstring const & name, Paragraph const & par) const; + /// 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) const; + 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. @@ -372,30 +431,32 @@ public: /// 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 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. @@ -407,33 +468,80 @@ public: /// 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); + 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 exportableFormats(bool only_viewable) const; + /// + typedef std::vector > 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 &, 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; + /// + void updateLabels(UpdateScope = UpdateMaster) const; + /// + void updateLabels(ParIterator & parit) 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: - /// + /// 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); /// std::vector backends() const; @@ -443,16 +551,28 @@ private: ReadStatus readFile(Lexer &, support::FileName const & filename, bool fromString = false); + /** If we have branches that use the file suffix + feature, return the file name with suffix appended. + */ + support::FileName exportFileName() 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 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_; };