#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>
#include <vector>
+namespace lyx {
+
class BufferParams;
class ErrorItem;
class FuncRequest;
class ParIterator;
class TeXErrors;
class TexRow;
+class TocBackend;
class Undo;
class StableDocIterator;
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
/// 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);
///
void insertStringAsLines(ParagraphList & plist,
- lyx::pit_type &, lyx::pos_type &,
- LyXFont const &, lyx::docstring 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.
*/
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;
- ///
- 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,
+ /// 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);
- ///
- void writeLaTeXSource(std::ostream & os,
+ /** 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);
///
- 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
- lyx::docstring const B_(std::string const & l10n) const;
+ docstring const B_(std::string const & l10n) const;
///
int runChktex();
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.
*/
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.
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);
///
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);
///
///
StableDocIterator getAnchor() const { return anchor_; }
///
- void changeRefsIfUnique(std::string const & from, std::string const & to);
- /// get source code (latex/docbook) 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.
//@{
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;
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_;
};
+
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff