X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBuffer.h;h=d50e67bdc7582784a811dd4c849092dffe18560d;hb=f345feecede25b164502abdacf893a36de9ef4ae;hp=2a22b5c07d617126a67e8f86d56ceac7c89727ae;hpb=f1cba8ff64b369792fd49f5ddf90e8126ab476ac;p=lyx.git diff --git a/src/Buffer.h b/src/Buffer.h index 2a22b5c07d..d50e67bdc7 100644 --- a/src/Buffer.h +++ b/src/Buffer.h @@ -12,12 +12,16 @@ #ifndef BUFFER_H #define BUFFER_H +#include "OutputEnums.h" +#include "update_flags.h" + #include "insets/InsetCode.h" #include "support/strfwd.h" #include "support/types.h" -#include "support/SignalSlot.h" +#include +#include #include #include @@ -26,17 +30,19 @@ namespace lyx { class BiblioInfo; class BufferParams; +class BufferSet; +class DispatchResult; class DocIterator; -class ErrorItem; +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; @@ -53,6 +59,7 @@ class TeXErrors; class TexRow; class TocBackend; class Undo; +class WordLangTuple; namespace frontend { class GuiBufferDelegate; @@ -109,25 +116,35 @@ public: 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 &); @@ -139,14 +156,10 @@ 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 &); - /// - 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? @@ -163,11 +176,16 @@ public: /// 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; @@ -185,14 +203,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(); @@ -211,6 +229,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 @@ -221,8 +247,6 @@ public: /// 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 @@ -234,18 +258,22 @@ public: /// 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(); @@ -264,7 +292,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. @@ -272,7 +300,10 @@ 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) @@ -281,6 +312,12 @@ public: /// \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(bool grand_children = true) const; + + /// Add all children (and grandchildren) to supplied vector + void getChildren(std::vector & children, bool grand_children = true) const; /// Is buffer read-only? bool isReadonly() const; @@ -306,14 +343,23 @@ public: */ 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() const; - /// - void invalidateBibinfoCache(); - /// 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). - support::FileNameList 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; @@ -327,6 +373,8 @@ public: /// bool isMultiLingual() const; + /// + std::set getLanguages() const; /// BufferParams & params(); @@ -348,6 +396,7 @@ public: /// Used when typesetting to place errorboxes. TexRow const & texrow() const; + TexRow & texrow(); /// ParIterator par_iterator_begin(); @@ -358,6 +407,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. @@ -392,6 +444,10 @@ public: /// 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 UserMacroSet; + 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, @@ -419,17 +475,17 @@ public: 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. @@ -437,44 +493,76 @@ public: /// void message(docstring const & msg) const; + /// void setGuiDelegate(frontend::GuiBufferDelegate * gui); + /// + bool hasGuiDelegate() const; /// 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; + /// 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) const; + bool includeall, std::string & result_file) const; /// - bool doExport(std::string const & format, bool put_in_tempdir) const; + bool doExport(std::string const & format, bool put_in_tempdir, + bool includeall = false) const; /// - bool preview(std::string const & format) const; + bool preview(std::string const & format, bool includeall = false) const; /// bool isExportable(std::string const & format) const; /// std::vector exportableFormats(bool only_viewable) const; + /// + bool isExportableFormat(std::string const & format) const; /// - typedef std::vector > References; + 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; -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; + /// 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; + /// 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); /// @@ -484,24 +572,13 @@ private: */ ReadStatus readFile(Lexer &, support::FileName const & filename, bool fromString = false); + /// + void getLanguages(std::set &) const; /// 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_; };