]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.h
split LyXText::rowlist_ into individual Paragraph::rows_ chunks
[lyx.git] / src / buffer.h
index ff59d967ba75b7d93baa166b76c38184b302e2ad..75f6e0530f2a0c35e10c1c8100ac8d6f75b6169c 100644 (file)
@@ -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
 #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/signal0.hpp>
+#include <boost/signals/signal1.hpp>
 
-class BufferView;
 class LyXRC;
 class TeXErrors;
 class LaTeXFeatures;
+class LatexRunParams;
 class Language;
 class ParIterator;
 class ParConstIterator;
+class Messages;
 
 
 /** The buffer object.
@@ -66,59 +69,58 @@ public:
        /// Maybe we know the function already by number...
        bool dispatch(int ac, string const & argument, bool * result = 0);
 
-       ///
-       void resizeInsets(BufferView *);
-
-       /// Update window titles of all users.
-       void updateTitles() const;
-
-       /// Reset autosave timers for all users.
-       void resetAutosaveTimers() const;
-
-       /** Adds the BufferView to the users list.
-           Later this func will insert the \c BufferView into a real list,
-           not just setting a pointer.
-       */
-       void addUser(BufferView * u);
-
-       /** Removes the #BufferView# from the users list.
-           Since we only can have one at the moment, we just reset it.
-       */
-       void delUser(BufferView *);
-
-       ///
-       void redraw();
-
        /// Load the autosaved file.
        void loadAutoSaveFile();
 
-       /** Reads a file.
+       /** Inserts a file into a document
            \param par if != 0 insert the file.
            \return \c false if method fails.
        */
-       bool readFile(LyXLex &, string const &, Paragraph * par = 0);
+       bool readFile(LyXLex &, string const &, ParagraphList::iterator pit);
+
+       // FIXME: it's very silly to pass a lex in here
+       /// load a new file
+       bool readFile(string const &);
+
+       /// read the header, returns number of unknown tokens
+       int readHeader(LyXLex & lex);
 
        /** Reads a file without header.
            \param par if != 0 insert the file.
            \return \c false if file is not completely read.
        */
-       bool readLyXformat2(LyXLex &, Paragraph * par = 0);
-
-       /// This parses a single LyXformat-Token.
-       bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
-                                       Paragraph *& return_par,
-                                       string const & token, int & pos,
-                                       Paragraph::depth_type & depth,
-                                       LyXFont &);
+       bool readBody(LyXLex &, ParagraphList::iterator pit);
+
+       /// This parses a single token
+       int readParagraph(LyXLex &, string const & token,
+                     ParagraphList & pars, ParagraphList::iterator & pit,
+                     Paragraph::depth_type & depth);
+
        ///
-       void insertStringAsLines(Paragraph *&, lyx::pos_type &,
-                                LyXFont const &, string const &) const;
+       void insertStringAsLines(ParagraphList::iterator &, lyx::pos_type &,
+                                LyXFont const &, string const &);
        ///
-       Paragraph * getParFromID(int id) const;
-private:
-       /// Parse a single inset.
-       void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
+       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> error;
+       /// This signal is emitted when some message shows up.
+       boost::signal1<void, string> message;
+       /// This signal is emitted when the buffer busy status change.
+       boost::signal1<void, bool> busy;
+       /// This signal is emitted when the buffer readonly status change.
+       boost::signal1<void, bool> readonly;
+       /// Update window titles of all users.
+       boost::signal0<void> updateTitles;
+       /// Reset autosave timers for all users.
+       boost::signal0<void> resetAutosaveTimers;
+       /// This signal is emitting if the buffer is being closed.
+       boost::signal0<void> closing;
+
+
        /** Save file.
            Takes care of auto-save files and backup file if requested.
            Returns \c true if the save is successful, \c false otherwise.
@@ -138,38 +140,34 @@ public:
        /// Just a wrapper for the method below, first creating the ofstream.
        void makeLaTeXFile(string const & filename,
                           string const & original_path,
-                          bool nice,
-                          bool only_body = false,
-                          bool only_preamble = false);
+                          LatexRunParams const &,
+                          bool output_preamble = true,
+                          bool output_body = true);
        ///
        void makeLaTeXFile(std::ostream & os,
                           string const & original_path,
-                          bool nice,
-                          bool only_body = false,
-                          bool only_preamble = false);
-       /** LaTeX all paragraphs from par to endpar.
-           \param \a endpar if == 0 then to the end
-       */
-       void latexParagraphs(std::ostream & os, Paragraph * par,
-                            Paragraph * endpar, TexRow & texrow, bool moving_arg = false) const;
+                          LatexRunParams const &,
+                          bool output_preamble = true,
+                          bool output_body = true);
        ///
        void simpleDocBookOnePar(std::ostream &,
-                                Paragraph * par, int & desc_on,
-                                Paragraph::depth_type depth) const ;
+                                ParagraphList::iterator par, int & desc_on,
+                                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(Paragraph * 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
+       string const B_(string const & l10n) const;
+
        ///
        int runChktex();
        /// return true if the main lyx file does not need saving
@@ -250,22 +248,22 @@ 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;
-
-       /** This will clearly have to change later. Later we can have more
-           than one user per buffer. */
-       BufferView * getUser() const;
+       void getLabelList(std::vector<string> &) const;
 
        ///
        void changeLanguage(Language const * from, Language const * to);
+
+       ///
+       void updateDocLang(Language const * nlang);
+
        ///
        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;
@@ -294,13 +292,12 @@ public:
        AuthorList & authors();
 
 private:
+       bool do_writeFile(std::ostream & ofs) const;
+
        typedef std::map<string, bool> DepClean;
 
        /// need to regenerate .tex ?
        DepClean dep_clean_;
-       /// the author list
-       AuthorList authorlist;
 
        /// is save needed
        mutable bool lyx_clean;
@@ -320,25 +317,17 @@ private:
        /// The path to the document file.
        string filepath_;
 
-       /// Format number of buffer
-       int file_format;
-       /** A list of views using this buffer.
-           Why not keep a list of the BufferViews that use this buffer?
-
-           At least then we don't have to do a lot of magic like:
-           #buffer->lyx_gui->bufferview->updateLayoutChoice#. Just ask each
-           of the buffers in the list of users to do a #updateLayoutChoice#.
-       */
-       BufferView * users;
+       ///
+       boost::scoped_ptr<Messages> messages_;
 public:
        ///
        class inset_iterator {
        public:
                typedef std::input_iterator_tag iterator_category;
-               typedef Inset value_type;
+               typedef InsetOld value_type;
                typedef ptrdiff_t difference_type;
-               typedef Inset * pointer;
-               typedef Inset & reference;
+               typedef InsetOld * pointer;
+               typedef InsetOld & reference;
                typedef ParagraphList::iterator base_type;
 
                ///
@@ -358,7 +347,7 @@ public:
                pointer operator->();
 
                ///
-               Paragraph * getPar();
+               ParagraphList::iterator getPar() const;
                ///
                lyx::pos_type getPos() const;
                ///
@@ -376,25 +365,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();
@@ -406,7 +387,7 @@ public:
        ParConstIterator par_iterator_end() const;
 
        ///
-       Inset * getInsetFromID(int id_arg) const;
+       InsetOld * getInsetFromID(int id_arg) const;
 };
 
 bool operator==(Buffer::inset_iterator const & iter1,