X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=6cb04bb7c0b72693b0bfe5a299554fb471ccaae6;hb=86fab2cefa122a5b0c0ee4ade472e41d9a3ff1cf;hp=ace9986f23880a6e5111f255335618e1d3ba39d8;hpb=323e3b020742127d430a83a0dfa6d391a25f3cc8;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index ace9986f23..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,25 +12,34 @@ #ifndef BUFFER_H #define BUFFER_H +#include "update_flags.h" + #include "insets/InsetCode.h" #include "support/strfwd.h" #include "support/types.h" #include "support/SignalSlot.h" +#include #include #include namespace lyx { +class BiblioInfo; class BufferParams; -class EmbeddedFileList; +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; @@ -41,6 +50,7 @@ class LaTeXFeatures; class Language; class MacroData; class MacroNameSet; +class MacroSet; class OutputParams; class Paragraph; class ParConstIterator; @@ -50,7 +60,7 @@ class TeXErrors; class TexRow; class TocBackend; class Undo; -class WordList; +class WordLangTuple; namespace frontend { class GuiBufferDelegate; @@ -59,6 +69,7 @@ class WorkAreaManager; namespace support { class FileName; +class FileNameList; } /** The buffer object. @@ -70,7 +81,7 @@ class FileName; * * 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: @@ -88,14 +99,14 @@ public: }; - /// 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. * @@ -105,26 +116,30 @@ public: 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 &); @@ -136,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 &); @@ -163,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 @@ -182,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(); @@ -208,6 +223,14 @@ public: void writeDocBookSource(odocstream & os, std::string const & filename, OutputParams const & runparams_in, 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 @@ -261,7 +284,7 @@ public: */ 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. @@ -269,13 +292,22 @@ public: /// Set document's parent Buffer. void setParent(Buffer const *); - Buffer const * parent(); + 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; + /// \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; @@ -302,10 +334,18 @@ public: /// Update the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - void updateBibfilesCache() const; + void updateBibfilesCache(UpdateScope scope = UpdateMaster) const; + /// + void invalidateBibinfoCache(); /// Return the cache with all bibfiles in use (including bibfiles /// of loaded child documents). - EmbeddedFileList 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; @@ -335,6 +375,7 @@ public: /// Used when typesetting to place errorboxes. TexRow const & texrow() const; + TexRow & texrow(); /// ParIterator par_iterator_begin(); @@ -345,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. @@ -367,12 +411,10 @@ public: /// Iterate through the whole buffer and try to resolve macros void updateMacroInstances() const; - /// List macro names of this buffer. the parent and the children + /// List macro names of this buffer, the parent and the children void listMacroNames(MacroNameSet & macros) const; - /// Write out all macros somewhere defined in the parent, - /// its parents and its children, which are visible at the beginning - /// of this buffer - void writeParentMacros(odocstream & os) 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; @@ -389,7 +431,7 @@ 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. /// This method is used only for GUI visualisation of Buffer related @@ -403,21 +445,18 @@ public: /// method is const because modifying this backend does not touch /// the document contents. TocBackend & tocBackend() const; - - //@{ - EmbeddedFileList & embeddedFiles(); - EmbeddedFileList const & embeddedFiles() const; - bool embedded() 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. @@ -429,17 +468,24 @@ public: /// void message(docstring const & msg) const; + /// void setGuiDelegate(frontend::GuiBufferDelegate * gui); + /// + bool hasGuiDelegate() const; /// void autoSave() const; /// - void loadChildDocuments() const; + void removeAutosaveFile() const; /// - void resetChildDocuments(bool close_them) 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; + /// return the default output format of the current backend + std::string getDefaultOutputFormat() const; /// bool doExport(std::string const & format, bool put_in_tempdir, @@ -453,36 +499,49 @@ public: /// std::vector exportableFormats(bool only_viewable) const; - /// Register word for completion word list. - void registerWord(docstring const & word); /// - WordList const & registeredWords() 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 in the whole text inset - \param it at the start of the text inset) - */ - void updateInsetMacros(DocIterator & it, - DocIterator & scope) const; - /** Update macro table for paragraphs until \c lastpit + /** Update macro table starting with position of it \param it in some text inset - \param lastpit last processed paragraph */ - void updateEnvironmentMacros(DocIterator & it, - pit_type lastpit, + void updateMacros(DocIterator & it, DocIterator & scope) const; - /** Update macro table for one paragraph block with - same layout and depth, until \c lastpit - \param it in some text inset - \param lastpit last processed paragraph - */ - void updateBlockMacros(DocIterator & it, - DocIterator & scope) const; - /// + /// + void collectRelatives(BufferSet & bufs) const; + + /// bool readFileHelper(support::FileName const & s); /// std::vector backends() const; @@ -492,6 +551,11 @@ 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.