last Friday's text*.C -> text_func shuffle

[lyx.git] / src / buffer.h

diff --git a/src/buffer.h b/src/buffer.h
index 8d562bd281ef3c47ee0884206b07baccddb190e1..7bed397524734cad025e3df28aabb0201902ee81 100644 (file)
--- a/src/buffer.h
+++ b/src/buffer.h
@@ -1,14 +1,13 @@
 // -*- C++ -*-
-/* This file is part of
- * ======================================================
+/**
+ * \file buffer.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
  *
- *           LyX, The Document Processor
- *           Copyright 1995 Matthias Ettrich
+ * \author Lars Gullik Bjønnes
  *
- *           This file is Copyleft 1996
- *           Lars Gullik Bjønnes
- *
- * ====================================================== */
+ * Full author contact details are available in file CREDITS
+ */
 
 #ifndef BUFFER_H
 #define BUFFER_H
@@ -21,16 +20,18 @@
 #include "bufferparams.h"
 #include "texrow.h"
 #include "ParagraphList.h"
-#include "paragraph.h"
 #include "author.h"
+#include "iterators.h"
+#include "errorlist.h"
 
-#include <boost/shared_ptr.hpp>
 #include <boost/scoped_ptr.hpp>
+#include <boost/signals/signal1.hpp>
 
 class BufferView;
 class LyXRC;
 class TeXErrors;
 class LaTeXFeatures;
+class LatexRunParams;
 class Language;
 class ParIterator;
 class ParConstIterator;
@@ -122,9 +123,14 @@ public:
        void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
                                 LyXFont const &, string const &);
        ///
-       Paragraph * getParFromID(int id) const;
+       ParIterator getParFromID(int id) const;
+       /// do we have a paragraph with this id?
+       bool hasParWithID(int id) const;
 
 public:
+       /// This signal is emitted when a parsing error shows up.
+       boost::signal1<void, ErrorItem> parseError;
+
        /** Save file.
            Takes care of auto-save files and backup file if requested.
            Returns \c true if the save is successful, \c false otherwise.
@@ -144,31 +150,29 @@ public:
        /// Just a wrapper for the method below, first creating the ofstream.
        void makeLaTeXFile(string const & filename,
                           string const & original_path,
-                          bool nice,
+                          LatexRunParams const &,
                           bool only_body = false,
                           bool only_preamble = false);
        ///
        void makeLaTeXFile(std::ostream & os,
                           string const & original_path,
-                          bool nice,
+                          LatexRunParams const &,
                           bool only_body = false,
                           bool only_preamble = false);
        ///
        void simpleDocBookOnePar(std::ostream &,
                                 ParagraphList::iterator par, int & desc_on,
-                                Paragraph::depth_type depth) const ;
+                                Paragraph::depth_type depth) const;
        ///
-       void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par,
-                                 Paragraph::depth_type depth);
+       void simpleLinuxDocOnePar(std::ostream & os,
+              ParagraphList::iterator par,
+                                Paragraph::depth_type depth) const;
        ///
        void makeLinuxDocFile(string const & filename,
                              bool nice, bool only_body = false);
        ///
        void makeDocBookFile(string const & filename,
                             bool nice, bool only_body = false);
-       ///
-       void sgmlError(ParagraphList::iterator par, int pos, string const & message) const;
-
        /// returns the main language for the buffer (document)
        Language const * getLanguage() const;
        /// get l10n translated to the buffers language
@@ -254,7 +258,7 @@ public:
        /// return all bibkeys from buffer and its childs
        void fillWithBibKeys(std::vector<std::pair<string, string> > & keys) const;
        ///
-       std::vector<string> const getLabelList() const;
+       void getLabelList(std::vector<string> &) const;
 
        /** This will clearly have to change later. Later we can have more
            than one user per buffer. */
@@ -270,10 +274,10 @@ public:
        bool isMultiLingual();
 
        /// Does this mean that this is buffer local?
-       limited_stack<boost::shared_ptr<Undo> > undostack;
+       limited_stack<Undo> undostack;
 
        /// Does this mean that this is buffer local?
-       limited_stack<boost::shared_ptr<Undo> > redostack;
+       limited_stack<Undo> redostack;
 
        ///
        BufferParams params;
@@ -365,7 +369,7 @@ public:
                pointer operator->();
 
                ///
-               Paragraph * getPar();
+               ParagraphList::iterator getPar() const;
                ///
                lyx::pos_type getPos() const;
                ///
@@ -383,25 +387,17 @@ public:
                InsetList::iterator it;
        };
 
-       ///
-       inset_iterator inset_iterator_begin() {
-               return inset_iterator(paragraphs.begin(), paragraphs.end());
-       }
+       /// return an iterator to all *top-level* insets in the buffer
+       inset_iterator inset_iterator_begin();
 
-       ///
-       inset_iterator inset_iterator_end() {
-               return inset_iterator();
-       }
+       /// return the end of all *top-level* insets in the buffer
+       inset_iterator inset_iterator_end();
 
-       ///
-       inset_iterator inset_const_iterator_begin() const {
-               return inset_iterator(paragraphs.begin(), paragraphs.end());
-       }
+       /// return a const iterator to all *top-level* insets in the buffer
+       inset_iterator inset_const_iterator_begin() const;
 
-       ///
-       inset_iterator inset_const_iterator_end() const {
-               return inset_iterator();
-       }
+       /// return the const end of all *top-level* insets in the buffer
+       inset_iterator inset_const_iterator_end() const;
 
        ///
        ParIterator par_iterator_begin();