]> git.lyx.org Git - lyx.git/blobdiff - src/Buffer.h
GuiDocument.cpp: remove unneeded conversion
[lyx.git] / src / Buffer.h
index e91f7e82732c5c894ba412d4cf741dc064561694..dd1a2b4c84501335a376cd99074322e5ac81146f 100644 (file)
@@ -12,6 +12,8 @@
 #ifndef BUFFER_H
 #define BUFFER_H
 
+#include "update_flags.h"
+
 #include "insets/InsetCode.h"
 
 #include "support/strfwd.h"
@@ -27,10 +29,13 @@ namespace lyx {
 class BiblioInfo;
 class BufferParams;
 class BufferSet;
+class DispatchResult;
 class DocIterator;
+class docstring_list;
 class ErrorItem;
 class ErrorList;
 class FuncRequest;
+class FuncStatus;
 class Inset;
 class InsetRef;
 class InsetLabel;
@@ -54,6 +59,7 @@ class TeXErrors;
 class TexRow;
 class TocBackend;
 class Undo;
+class WordLangTuple;
 
 namespace frontend {
 class GuiBufferDelegate;
@@ -110,6 +116,12 @@ public:
                timestamp_method, ///< Use timestamp, and checksum if timestamp has changed
        };
 
+       ///
+       enum UpdateScope {
+               UpdateMaster,
+               UpdateChildOnly
+       };
+
        /// Constructor
        explicit Buffer(std::string const & file, bool b = false);
 
@@ -117,15 +129,16 @@ public:
        ~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 &);
@@ -282,6 +295,9 @@ 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<Buffer *> getChildren() const;
 
        /// Is buffer read-only?
        bool isReadonly() const;
@@ -309,12 +325,13 @@ 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).
-       support::FileNameList 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;
@@ -442,13 +459,20 @@ public:
        ///
        void message(docstring const & msg) const;
 
+       ///
        void setGuiDelegate(frontend::GuiBufferDelegate * gui);
+       ///
+       bool hasGuiDelegate() const;
 
        ///
        void autoSave() const;
+       ///
+       void removeAutosaveFile() 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,
@@ -470,12 +494,27 @@ public:
        void setInsetLabel(docstring const & label, InsetLabel const * il);
        InsetLabel const * insetLabel(docstring const & label) const;
 
-       // FIXME: buf should should be const because updateLabels() modifies
-       // the contents of the paragraphs.
-       void updateLabels(bool childonly = 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;
 
+       /// Find next word starting from \p from.
+       /// \p from initial position to search, will then points to the next
+       ///    word.
+       /// \p to will points to the end of the next word.
+       /// \p word will contain the found word if any.
+       /// \return true if a new word was found.
+       bool nextWord(DocIterator & from, DocIterator & to,
+               docstring & word) const;
+
+       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,
@@ -498,6 +537,8 @@ private:
        */
        ReadStatus readFile(Lexer &, support::FileName const & filename,
                            bool fromString = false);
+       ///
+       support::FileName getAutosaveFilename() const;
 
        /// Use the Pimpl idiom to hide the internals.
        class Impl;