* Add possibility to append active branch names to the output file name (#3105).

[lyx.git] / src / Buffer.h

diff --git a/src/Buffer.h b/src/Buffer.h
index f6543a8e8dfad214e5f6732cce6d8b258a789519..6cb04bb7c0b72693b0bfe5a299554fb471ccaae6 100644 (file)
--- a/src/Buffer.h
+++ b/src/Buffer.h
@@ -12,12 +12,15 @@
 #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 <list>
 #include <string>
 #include <vector>
 
@@ -27,10 +30,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 +60,7 @@ class TeXErrors;
 class TexRow;
 class TocBackend;
 class Undo;
+class WordLangTuple;
 
 namespace frontend {
 class GuiBufferDelegate;
@@ -123,12 +130,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);
+
+       /// 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 &);
@@ -212,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
@@ -265,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.
@@ -437,7 +456,7 @@ public:
        /// 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.
@@ -456,9 +475,17 @@ public:
 
        ///
        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,
@@ -480,6 +507,9 @@ public:
        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<docstring> &, 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.
@@ -489,14 +519,14 @@ public:
        ///
        void updateLabels(ParIterator & parit) const;
 
-       /// Find next word starting from \p from.
-       /// \p from initial position to search, will then points to the next
+       /// 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 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;
+       /// \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
@@ -521,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.