#ifndef BUFFER_H
#define BUFFER_H
+#include "errorlist.h"
#include "InsetList.h"
+
+#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/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
+#include <boost/signal.hpp>
#include <iosfwd>
+#include <string>
#include <map>
#include <utility>
#include <vector>
+namespace lyx {
+
class BufferParams;
class ErrorItem;
class FuncRequest;
+class InsetBase;
+class InsetText;
class LyXFont;
class LyXLex;
class LyXRC;
+class LyXText;
class LyXVC;
class LaTeXFeatures;
-class LatexRunParams;
class Language;
-class Messages;
-class ParIterator;
-class PosIterator;
+class MacroData;
+class OutputParams;
class ParConstIterator;
+class ParIterator;
class TeXErrors;
class TexRow;
+class TocBackend;
class Undo;
+class StableDocIterator;
/** The buffer object.
- This is the buffer object. It contains all the informations about
- a document loaded into LyX. I am not sure if the class is complete or
- minimal, probably not.
- \author Lars Gullik Bjønnes
+ * This is the buffer object. It contains all the informations about
+ * a document loaded into LyX.
+ * The buffer object owns the LyXText (wrapped in an InsetText), which
+ * contains the individual paragraphs of the document.
+ *
+ *
+ * I am not sure if the class is complete or
+ * minimal, probably not.
+ * \author Lars Gullik Bjønnes
*/
class Buffer {
public:
void loadAutoSaveFile();
/// load a new file
- bool readFile(std::string const & filename);
-
- bool readFile(std::string const & filename, ParagraphList::iterator pit);
+ bool readFile(support::FileName const & filename);
/// read the header, returns number of unknown tokens
int readHeader(LyXLex & lex);
\param par if != 0 insert the file.
\return \c false if file is not completely read.
*/
- bool readBody(LyXLex &, ParagraphList::iterator pit);
-
- /// This parses a single token
- int readParagraph(LyXLex &, std::string const & token,
- ParagraphList & pars,
- ParagraphList::iterator & pit,
- lyx::depth_type & depth);
+ bool readDocument(LyXLex &);
///
- void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
- LyXFont const &, std::string const &);
+ void insertStringAsLines(ParagraphList & plist,
+ 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 a parsing error shows up.
- boost::signal1<void, ErrorItem> error;
+ /// 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::signal1<void, std::string> message;
+ boost::signal<void(docstring)> message;
/// This signal is emitted when the buffer busy status change.
- boost::signal1<void, bool> busy;
+ boost::signal<void(bool)> busy;
/// This signal is emitted when the buffer readonly status change.
- boost::signal1<void, bool> readonly;
+ boost::signal<void(bool)> readonly;
/// Update window titles of all users.
- boost::signal0<void> updateTitles;
+ boost::signal<void()> updateTitles;
/// Reset autosave timers for all users.
- boost::signal0<void> resetAutosaveTimers;
+ boost::signal<void()> resetAutosaveTimers;
/// This signal is emitting if the buffer is being closed.
- boost::signal0<void> closing;
+ boost::signal<void()> closing;
/** Save file.
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 &, LatexRunParams const &);
- ///
- void writeFileAscii(std::ostream &, LatexRunParams 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,
- LatexRunParams const &,
+ OutputParams const &,
bool output_preamble = true,
bool output_body = true);
///
- void makeLaTeXFile(std::ostream & os,
+ void writeLaTeXSource(odocstream & os,
std::string const & original_path,
- LatexRunParams const &,
+ OutputParams const &,
bool output_preamble = true,
bool output_body = true);
///
- void makeLinuxDocFile(std::string const & filename,
- LatexRunParams const & runparams_in,
- bool only_body = false);
+ void makeDocBookFile(support::FileName const & filename,
+ OutputParams const & runparams_in,
+ bool only_body = false);
///
- void makeDocBookFile(std::string const & filename,
- LatexRunParams const & runparams_in,
+ 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();
void setUnnamed(bool flag = true);
///
- bool isUnnamed();
+ bool isUnnamed() const;
/// Mark this buffer as dirty.
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.
/// Name of the document's parent
void setParentName(std::string const &);
+ /** Get the document's master (or \c this if this is not a
+ child document)
+ */
+ Buffer const * getMasterBuffer() const;
+ /** Get the document's master (or \c this if this is not a
+ child document)
+ */
+ Buffer * getMasterBuffer();
+
/// Is buffer read-only?
bool isReadonly() const;
/// 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;
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<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 updateDocLang(Language const * nlang);
///
- bool isMultiLingual();
+ bool isMultiLingual() const;
/// Does this mean that this is buffer local?
limited_stack<Undo> & undostack();
/// Where to put temporary files.
std::string const & temppath() const;
- /** If we are writing a nice LaTeX file or not.
- While writing as LaTeX, tells whether we are
- doing a 'nice' LaTeX file */
- bool & niceFile();
- bool niceFile() const;
-
/// Used when typesetting to place errorboxes.
TexRow & texrow();
TexRow const & texrow() const;
- class inset_iterator {
- public:
- typedef std::input_iterator_tag iterator_category;
- typedef InsetOld value_type;
- typedef ptrdiff_t difference_type;
- typedef InsetOld * pointer;
- typedef InsetOld & reference;
- typedef ParagraphList::iterator base_type;
-
- ///
- inset_iterator();
- ///
- inset_iterator(base_type p, base_type e);
- ///
- inset_iterator(base_type p, lyx::pos_type pos, base_type e);
-
- /// prefix ++
- inset_iterator & operator++();
- /// postfix ++
- inset_iterator operator++(int);
- ///
- reference operator*();
- ///
- pointer operator->();
-
- ///
- ParagraphList::iterator getPar() const;
- ///
- lyx::pos_type getPos() const;
- ///
- friend
- bool operator==(inset_iterator const & iter1,
- inset_iterator const & iter2);
- private:
- ///
- void setParagraph();
- ///
- ParagraphList::iterator pit;
- ///
- ParagraphList::iterator pend;
- ///
- InsetList::iterator it;
- };
-
- /// return an iterator to all *top-level* insets in the buffer
- inset_iterator inset_iterator_begin();
-
- /// return the end of all *top-level* insets in the buffer
- inset_iterator inset_iterator_end();
-
- /// return a const iterator to all *top-level* insets in the buffer
- inset_iterator inset_const_iterator_begin() const;
-
- /// return the const end of all *top-level* insets in the buffer
- inset_iterator inset_const_iterator_end() const;
-
- ///
- PosIterator pos_iterator_begin();
- ///
- PosIterator pos_iterator_end();
///
ParIterator par_iterator_begin();
///
///
ParConstIterator par_iterator_end() const;
- ///
- InsetOld * getInsetFromID(int id_arg) const;
-
/** \returns true only when the file is fully loaded.
* Used to prevent the premature generation of previews
* and by the citation inset.
/// Set by buffer_funcs' newFile.
void fully_loaded(bool);
+ /// Our main text (inside the top InsetText)
+ LyXText & text() const;
+
+ /// Our top InsetText!
+ InsetBase & inset() const;
+
+ //
+ // Macro handling
+ //
+ ///
+ void buildMacros();
+ ///
+ bool hasMacro(docstring const & name) const;
+ ///
+ MacroData const & getMacro(docstring const & name) const;
+ ///
+ void insertMacro(docstring const & name, MacroData const & data);
+
+ ///
+ void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
+ ///
+ StableDocIterator getCursor() const { return cursor_; }
+ ///
+ StableDocIterator getAnchor() const { return anchor_; }
+ ///
+ 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 const & errorList(std::string const & type) const;
+ ErrorList & errorList(std::string const & type);
+ //@}
+
+ //@{
+ TocBackend & tocBackend();
+ TocBackend const & tocBackend() const;
+ //@}
+
private:
/** Inserts a file into a document
- \param par if != 0 insert the file.
\return \c false if method fails.
*/
- bool readFile(LyXLex &, std::string const & filename,
- ParagraphList::iterator pit);
+ bool readFile(LyXLex &, support::FileName const & filename);
bool do_writeFile(std::ostream & ofs) const;
class Impl;
/// The pointer never changes although *pimpl_'s contents may.
boost::scoped_ptr<Impl> const pimpl_;
+
+ /// Save the cursor Position on Buffer switch
+ /// this would not be needed if every Buffer would have
+ /// it's BufferView, this should be FIXED in future.
+ StableDocIterator cursor_;
+ StableDocIterator anchor_;
+ /// A cache for the bibfiles (including bibfiles of loaded child
+ /// documents), needed for appropriate update of natbib labels.
+ std::vector<support::FileName> bibfilesCache_;
+
+ /// Container for all sort of Buffer dependant errors.
+ std::map<std::string, ErrorList> errorLists_;
};
-bool operator==(Buffer::inset_iterator const & iter1,
- Buffer::inset_iterator const & iter2);
-bool operator!=(Buffer::inset_iterator const & iter1,
- Buffer::inset_iterator const & iter2);
+} // namespace lyx
#endif
projects / lyx.git / blobdiff