]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.h
Convert filenames to local encoding for running lyx2lyx
[lyx.git] / src / buffer.h
index f26e6a6feeba53243bec5ff360882fad8630b41a..018ee81457dc354ad7b4894870abd2c4f962c21a 100644 (file)
 #include "dociterator.h"
 #include "ParagraphList_fwd.h"
 
+#include "support/filename.h"
 #include "support/limited_stack.h"
 #include "support/types.h"
+#include "support/docstring.h"
+#include "support/docstream.h"
 
 #include <boost/scoped_ptr.hpp>
 #include <boost/signal.hpp>
@@ -31,6 +34,8 @@
 #include <vector>
 
 
+namespace lyx {
+
 class BufferParams;
 class ErrorItem;
 class FuncRequest;
@@ -49,6 +54,7 @@ class ParConstIterator;
 class ParIterator;
 class TeXErrors;
 class TexRow;
+class TocBackend;
 class Undo;
 class StableDocIterator;
 
@@ -93,7 +99,7 @@ public:
        void loadAutoSaveFile();
 
        /// 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);
@@ -106,17 +112,19 @@ public:
 
        ///
        void insertStringAsLines(ParagraphList & plist,
-               lyx::pit_type &, lyx::pos_type &,
-               LyXFont const &, std::string const &, bool);
+               pit_type &, pos_type &,
+               LyXFont const &, docstring const &, bool);
        ///
        ParIterator getParFromID(int id) const;
        /// do we have a paragraph with this id?
        bool hasParWithID(int id) const;
 
+       /// This signal is emitted when the buffer is changed.
+       boost::signal<void()> changed;
        /// This signal is emitted when some parsing error shows up.
        boost::signal<void(std::string)> errors;
        /// This signal is emitted when some message shows up.
-       boost::signal<void(std::string)> message;
+       boost::signal<void(docstring)> message;
        /// This signal is emitted when the buffer busy status change.
        boost::signal<void(bool)> busy;
        /// This signal is emitted when the buffer readonly status change.
@@ -136,44 +144,34 @@ public:
        bool save() const;
 
        /// Write file. Returns \c false if unsuccesful.
-       bool writeFile(std::string const &) const;
+       bool writeFile(support::FileName const &) const;
 
-       ///
-       void writeFileAscii(std::string const &, OutputParams const &);
-       ///
-       void writeFileAscii(std::ostream &, OutputParams const &);
        /// Just a wrapper for the method below, first creating the ofstream.
-       void makeLaTeXFile(std::string const & filename,
+       bool makeLaTeXFile(support::FileName const & filename,
                           std::string const & original_path,
                           OutputParams const &,
                           bool output_preamble = true,
                           bool output_body = true);
        ///
-       void writeLaTeXSource(std::ostream & os,
+       void writeLaTeXSource(odocstream & os,
                           std::string const & original_path,
                           OutputParams const &,
                           bool output_preamble = true,
                           bool output_body = true);
        ///
-       void makeLinuxDocFile(std::string const & filename,
-                             OutputParams const & runparams_in,
-                             bool only_body = false);
-       ///
-       void writeLinuxDocSource(std::ostream & os, std::string const & filename,
-                             OutputParams const & runparams_in,
-                             bool only_body = false);
-       ///
-       void makeDocBookFile(std::string const & filename,
+       void makeDocBookFile(support::FileName const & filename,
                             OutputParams const & runparams_in,
                             bool only_body = false);
        ///
-       void writeDocBookSource(std::ostream & os, std::string const & filename,
+       void writeDocBookSource(odocstream & os, std::string const & filename,
                             OutputParams const & runparams_in,
                             bool only_body = false);
        /// returns the main language for the buffer (document)
        Language const * getLanguage() const;
        /// get l10n translated to the buffers language
-       std::string const B_(std::string const & l10n) const;
+       docstring const B_(std::string const & l10n) const;
+       /// translate \p label to the buffer language if possible
+       docstring const translateLabel(docstring const & label) const;
 
        ///
        int runChktex();
@@ -203,7 +201,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.
@@ -214,7 +212,7 @@ public:
        */
        std::string const getLatexName(bool no_path = true) const;
 
-       /// Get the name and type of the log.
+       /// Get thee name and type of the log.
        std::pair<LogType, std::string> const getLogName() const;
 
        /// Change name of buffer. Updates "read-only" flag.
@@ -240,13 +238,8 @@ public:
 
        /// returns \c true if the buffer contains a LaTeX document
        bool isLatex() const;
-       /// returns \c true if the buffer contains a LinuxDoc document
-       bool isLinuxDoc() const;
        /// returns \c true if the buffer contains a DocBook document
        bool isDocBook() const;
-       /** returns \c true if the buffer contains either a LinuxDoc
-           or DocBook document */
-       bool isSGML() const;
        /// returns \c true if the buffer contains a Wed document
        bool isLiterate() const;
 
@@ -262,15 +255,15 @@ 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<std::string> &) const;
+       void getLabelList(std::vector<docstring> &) const;
 
        ///
        void changeLanguage(Language const * from, Language const * to);
@@ -340,11 +333,12 @@ public:
        ///
        void buildMacros();
        ///
-       bool hasMacro(std::string const & name) const;
+       bool hasMacro(docstring const & name) const;
        ///
-       MacroData const & getMacro(std::string const & name) const;
+       MacroData const & getMacro(docstring const & name) const;
        ///
-       void insertMacro(std::string const & name, MacroData const & data);
+       void insertMacro(docstring const & name, MacroData const & data);
+
        ///
        void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
        ///
@@ -352,10 +346,11 @@ public:
        ///
        StableDocIterator getAnchor() const { return anchor_; }
        ///
-       void changeRefsIfUnique(std::string const & from, std::string const & to);
-       /// get source code (latex/docbook/linuxdoc) for some paragraphs, or all paragraphs
-       /// including preamble
-       void getSourceCode(std::ostream & os, lyx::pit_type par_begin, lyx::pit_type par_end, bool full_source);
+       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.
        //@{
@@ -363,11 +358,16 @@ 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 readFile(LyXLex &, support::FileName const & filename);
 
        bool do_writeFile(std::ostream & ofs) const;
 
@@ -383,10 +383,13 @@ 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_;
+       std::vector<support::FileName> bibfilesCache_;
 
        /// Container for all sort of Buffer dependant errors.
        std::map<std::string, ErrorList> errorLists_;
 };
 
+
+} // namespace lyx
+
 #endif