]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.h
code cosmetics to the iterator fix
[lyx.git] / src / buffer.h
index 0a82f73b96cb22704aa7797892d3532aacd7ff14..ba3ec7c40c752569b620f5aad9b9cc11a6bd8aa4 100644 (file)
 #define BUFFER_H
 
 #include "InsetList.h"
-#include "ParagraphList_fwd.h"
+
+#include "dociterator.h"
 
 #include "support/limited_stack.h"
 #include "support/types.h"
 
 #include <boost/scoped_ptr.hpp>
-#include <boost/signals/signal0.hpp>
-#include <boost/signals/signal1.hpp>
+#include <boost/signal.hpp>
 
 #include <iosfwd>
 #include <map>
@@ -40,21 +40,27 @@ class LyXText;
 class LyXVC;
 class LaTeXFeatures;
 class Language;
-class Messages;
+class MacroData;
 class OutputParams;
-class ParIterator;
-class PosIterator;
+class ParagraphList;
 class ParConstIterator;
+class ParIterator;
 class TeXErrors;
 class TexRow;
 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:
@@ -87,8 +93,6 @@ public:
        /// load a new file
        bool readFile(std::string const & filename);
 
-       bool readFile(std::string const & filename, ParagraphList::iterator pit);
-
        /// read the header, returns number of unknown tokens
        int readHeader(LyXLex & lex);
 
@@ -96,30 +100,31 @@ public:
            \param par if != 0 insert the file.
            \return \c false if file is not completely read.
        */
-       bool readBody(LyXLex &);
+       bool readDocument(LyXLex &);
 
        ///
-       void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
-                                LyXFont const &, std::string const &);
+       void insertStringAsLines(ParagraphList & plist,
+               lyx::pit_type &, lyx::pos_type &,
+               LyXFont const &, std::string 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;
+       boost::signal<void(ErrorItem)> error;
        /// This signal is emitted when some message shows up.
-       boost::signal1<void, std::string> message;
+       boost::signal<void(std::string)> 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.
@@ -208,6 +213,11 @@ public:
        /// 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;
+
        /// Is buffer read-only?
        bool isReadonly() const;
 
@@ -281,66 +291,6 @@ public:
        TexRow & texrow();
        TexRow const & texrow() const;
 
-       class inset_iterator {
-       public:
-               typedef std::input_iterator_tag iterator_category;
-               typedef InsetBase value_type;
-               typedef ptrdiff_t difference_type;
-               typedef InsetBase * pointer;
-               typedef InsetBase & 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();
        ///
@@ -358,18 +308,37 @@ public:
        /// 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(std::string const & name) const;
+       ///
+       MacroData const & getMacro(std::string const & name) const;
+       ///
+       void insertMacro(std::string const & name, MacroData const & data);
+       ///
+       void saveCursor(StableDocIterator cursor, StableDocIterator anchor);
+       ///
+       StableDocIterator getCursor() const { return cursor_; }
+       ///
+       StableDocIterator getAnchor() const { return anchor_; }
+       ///
+       void changeRefsIfUnique(std::string const & from, std::string const & to);
+
 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 &, std::string const & filename);
 
        bool do_writeFile(std::ostream & ofs) const;
 
@@ -377,12 +346,12 @@ private:
        class Impl;
        /// The pointer never changes although *pimpl_'s contents may.
        boost::scoped_ptr<Impl> const pimpl_;
-};
 
-bool operator==(Buffer::inset_iterator const & iter1,
-               Buffer::inset_iterator const & iter2);
-
-bool operator!=(Buffer::inset_iterator const & iter1,
-               Buffer::inset_iterator const & iter2);
+       /// 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_;
+};
 
 #endif