* output_plaintext.C: cosmetics in comment: line length cannot be < 0

[lyx.git] / src / buffer.h

diff --git a/src/buffer.h b/src/buffer.h
index 90a36be7ef097f2d1620cba82f420cee5777497b..499293976fe7dc61980cab859f1e46478a35a4c5 100644 (file)
--- a/src/buffer.h
+++ b/src/buffer.h
@@ -18,6 +18,7 @@
 #include "dociterator.h"
 #include "ParagraphList_fwd.h"
 
+#include "support/filename.h"
 #include "support/limited_stack.h"
 #include "support/types.h"
 #include "support/docstring.h"
@@ -35,7 +36,6 @@
 
 namespace lyx {
 
-
 class BufferParams;
 class ErrorItem;
 class FuncRequest;
@@ -54,6 +54,7 @@ class ParConstIterator;
 class ParIterator;
 class TeXErrors;
 class TexRow;
+class TocBackend;
 class Undo;
 class StableDocIterator;
 
@@ -77,6 +78,13 @@ public:
                buildlog  ///< Literate build log
        };
 
+       /// Result of \c readFile()
+       enum ReadStatus {
+               failure, ///< The file could not be read
+               success, ///< The file could not be read
+               wrongversion ///< The version of the file does not match ours
+       };
+
        /** Constructor
            \param file
            \param b  optional \c false by default
@@ -97,8 +105,10 @@ public:
        /// Load the autosaved file.
        void loadAutoSaveFile();
 
+       /// read a new document from a string
+       bool readString(std::string const &);
        /// load a new file
-       bool readFile(std::string const & filename);
+       bool readFile(support::FileName const & filename);
 
        /// read the header, returns number of unknown tokens
        int readHeader(LyXLex & lex);
@@ -142,23 +152,44 @@ public:
        */
        bool save() const;
 
+       /// Write document to stream. Returns \c false if unsuccesful.
+       bool write(std::ostream &) const;
        /// Write file. Returns \c false if unsuccesful.
-       bool writeFile(std::string const &) const;
+       bool writeFile(support::FileName const &) const;
 
-       /// Just a wrapper for the method below, first creating the ofstream.
-       void makeLaTeXFile(std::string const & filename,
+       /// Just a wrapper for writeLaTeXSource, first creating the ofstream.
+       bool makeLaTeXFile(support::FileName const & filename,
                           std::string const & original_path,
                           OutputParams const &,
                           bool output_preamble = true,
                           bool output_body = true);
-       ///
+       /** 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
+           with more than one encoding, then this method will change the
+           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;
+           ofs.open("test.tex");
+           writeLaTeXSource(ofs, ...);
+           ofs.close();
+           \endcode is NOT equivalent to \code
+           odocstringstream oss;
+           writeLaTeXSource(oss, ...);
+           odocfstream ofs;
+           ofs.open("test.tex");
+           ofs << oss.str();
+           ofs.close();
+           \endcode
+        */
        void writeLaTeXSource(odocstream & os,
                           std::string const & original_path,
                           OutputParams const &,
                           bool output_preamble = true,
                           bool output_body = true);
        ///
-       void makeDocBookFile(std::string const & filename,
+       void makeDocBookFile(support::FileName const & filename,
                             OutputParams const & runparams_in,
                             bool only_body = false);
        ///
@@ -198,7 +229,7 @@ public:
        void markDirty();
 
        /// Returns the buffer's filename. It is always an absolute path.
-       std::string const & fileName() const;
+       std::string const fileName() const;
 
        /// Returns the the path where the buffer lives.
        /// It is always an absolute path.
@@ -252,13 +283,13 @@ public:
        void validate(LaTeXFeatures &) const;
 
        /// return all bibkeys from buffer and its childs
-       void fillWithBibKeys(std::vector<std::pair<std::string, std::string> > & keys) const;
+       void fillWithBibKeys(std::vector<std::pair<std::string, docstring> > & keys) const;
        /// Update the cache with all bibfiles in use (including bibfiles
        /// of loaded child documents).
        void updateBibfilesCache();
        /// Return the cache with all bibfiles in use (including bibfiles
        /// of loaded child documents).
-       std::vector<std::string> const & getBibfilesCache() const;
+       std::vector<support::FileName> const & getBibfilesCache() const;
        ///
        void getLabelList(std::vector<docstring> &) const;
 
@@ -343,9 +374,10 @@ public:
        ///
        StableDocIterator getAnchor() const { return anchor_; }
        ///
-       void changeRefsIfUnique(std::string const & from, std::string const & to, InsetBase::Code code);
-       /// get source code (latex/docbook) for some paragraphs, or all paragraphs
-       /// including preamble
+       void changeRefsIfUnique(docstring const & from, docstring const & to,
+               InsetBase::Code code);
+/// 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);
 
        /// errorLists_ accessors.
@@ -354,13 +386,17 @@ public:
        ErrorList & errorList(std::string const & type);
        //@}
 
+       //@{
+       TocBackend & tocBackend();
+       TocBackend const & tocBackend() const;
+       //@}
+
 private:
        /** Inserts a file into a document
            \return \c false if method fails.
        */
-       bool readFile(LyXLex &, std::string const & filename);
-
-       bool do_writeFile(std::ostream & ofs) const;
+       ReadStatus readFile(LyXLex &, support::FileName const & filename,
+                           bool fromString = false);
 
        /// Use the Pimpl idiom to hide the internals.
        class Impl;
@@ -374,7 +410,7 @@ private:
        StableDocIterator anchor_;
        /// A cache for the bibfiles (including bibfiles of loaded child
        /// documents), needed for appropriate update of natbib labels.
-       std::vector<std::string> bibfilesCache_;
+       mutable std::vector<support::FileName> bibfilesCache_;
 
        /// Container for all sort of Buffer dependant errors.
        std::map<std::string, ErrorList> errorLists_;