]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.h
bug 183
[lyx.git] / src / buffer.h
index 021b56c74e5f2c13b446ba6b019f28fb5e67ead1..a85e04a4c151de18df0c2002f39a60320e7f53d6 100644 (file)
  *
  * ====================================================== */
  
-// Change Log:
-// =========== 
-// 23/03/98   Heinrich Bauer (heinrich.bauer@t-mobil.de)
-// Spots marked "changed Heinrich Bauer, 23/03/98" modified due to the
-// following bug: dvi file export did not work after printing (or previewing)
-// and vice versa as long as the same file was concerned. This happened
-// every time the LyX-file was left unchanged between the two actions mentioned
-// above.
-
 #ifndef BUFFER_H
 #define BUFFER_H
 
 #endif
 
 #include "LString.h"
-
-#include "BufferView.h"
+#include "undo.h"
+#include "undostack.h"
 #include "lyxvc.h"
 #include "bufferparams.h"
 #include "texrow.h"
+#include "paragraph.h"
 
-
+class BufferView;
 class LyXRC;
 class TeXErrors;
 class LaTeXFeatures;
 class Language;
+class ParIterator;
+
+// When lyx 1.3.x starts we should enable this
+// btw. we should also test this with 1.2 so that we
+// do not get any surprises. (Lgb)
+//#define NO_COMPABILITY 1
 
 ///
 struct DEPCLEAN {
@@ -50,7 +48,7 @@ struct DEPCLEAN {
 };
 
 /** The buffer object.
-  This is the buffer object. It contains all the informations about
+  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
@@ -69,27 +67,17 @@ public:
        */
        explicit Buffer(string const & file, bool b = false);
        
-       /// Destrucotr
+       /// Destructor
        ~Buffer();
 
-       /** Save the buffer's parameters as user default.
-           This function saves a file \c user_lyxdir/templates/defaults.lyx
-           which parameters are those of the current buffer. This file
-           is used as a default template when creating a new
-           file. Returns \c true on success.
-       */
-       bool saveParamsAsDefaults();
-
        /** High-level interface to buffer functionality.
            This function parses a command string and executes it
        */
-       bool Dispatch(string const & command);
+       bool dispatch(string const & command);
 
        /// Maybe we know the function already by number...
-       bool Dispatch(int ac, string const & argument);
+       bool dispatch(int ac, string const & argument);
 
-       /// Should be changed to work for a list.
-       void resize();
        /// 
        void resizeInsets(BufferView *);
 
@@ -120,22 +108,33 @@ public:
            \param par if != 0 insert the file.
            \return \c false if method fails.
        */
-       bool readFile(LyXLex &, LyXParagraph * par = 0);
+       bool readFile(LyXLex &, Paragraph * par = 0);
        
        /** Reads a file without header.
            \param par if != 0 insert the file.
            \return \c false if file is not completely read.
        */
-       bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
+       bool readLyXformat2(LyXLex &, Paragraph * par = 0);
 
        /// This parses a single LyXformat-Token.
-       bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
-                                       LyXParagraph *& return_par,
+       bool parseSingleLyXformat2Token(LyXLex &, Paragraph *& par,
+                                       Paragraph *& return_par,
                                        string const & token, int & pos,
-                                       char & depth, LyXFont &);
+                                       Paragraph::depth_type & depth, 
+                                       LyXFont &);
+       ///
+       void insertStringAsLines(Paragraph *&, lyx::pos_type &,
+                                LyXFont const &, string const &) const;
+#ifndef NO_COMPABILITY
+       ///
+       void insertErtContents(Paragraph * par, int & pos,
+                              bool set_inactive = true);
+#endif
+       ///
+       Paragraph * getParFromID(int id) const;
 private:
        /// Parse a single inset.
-       void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
+       void readInset(LyXLex &, Paragraph *& par, int & pos, LyXFont &);
 public:
        /** Save file.
            Takes care of auto-save files and backup file if requested.
@@ -151,8 +150,8 @@ public:
        ///
        void writeFileAscii(std::ostream &, int);
        ///
-       string const asciiParagraph(LyXParagraph const *,
-                                   unsigned int linelen) const;
+       string const asciiParagraph(Paragraph const *, unsigned int linelen,
+                                   bool noparbreak = false) const;
        ///
        void makeLaTeXFile(string const & filename,
                           string const & original_path,
@@ -160,26 +159,34 @@ public:
        /** LaTeX all paragraphs from par to endpar.
            \param \a endpar if == 0 then to the end
        */
-       void latexParagraphs(std::ostream & os, LyXParagraph * par,
-                            LyXParagraph * endpar, TexRow & texrow) const;
-
-        ///
-       void SimpleDocBookOnePar(std::ostream &, string & extra,
-                                LyXParagraph * par, int & desc_on,
-                                int depth) const ;
-
+       void latexParagraphs(std::ostream & os, Paragraph * par,
+                            Paragraph * endpar, TexRow & texrow) const;
        ///
-       int runChktex();
-
+       void simpleDocBookOnePar(std::ostream &,
+                                Paragraph * par, int & desc_on,
+                                Paragraph::depth_type depth) const ;
+       ///
+       void simpleLinuxDocOnePar(std::ostream & os, Paragraph * par, 
+                                 Paragraph::depth_type depth);
        ///
        void makeLinuxDocFile(string const & filename,
                              bool nice, bool only_body = false);
        ///
        void makeDocBookFile(string const & filename,
                             bool nice, bool only_body = false);
+       /// Open SGML/XML tag.
+       void sgmlOpenTag(std::ostream & os, Paragraph::depth_type depth,
+               string const & latexname) const;
+       /// Closes SGML/XML tag.
+       void sgmlCloseTag(std::ostream & os, Paragraph::depth_type depth,
+               string const & latexname) const;
+       ///
+       void sgmlError(Paragraph * par, int pos, string const & message) const;
 
        /// returns the main language for the buffer (document)
-       Language const * GetLanguage() const;
+       Language const * getLanguage() const;
+       ///
+       int runChktex();
        ///
        bool isLyxClean() const;
        ///
@@ -240,9 +247,6 @@ public:
         /// returns \c true if the buffer contains a Wed document
         bool isLiterate() const;
 
-       ///
-       void setPaperStuff();
-
        /** Validate a buffer for LaTeX.
            This validates the buffer, and returns a struct for use by
            #makeLaTeX# and others. Its main use is to figure out what
@@ -260,10 +264,10 @@ public:
        std::vector<std::pair<string, string> > const getBibkeyList();
        ///
        struct TocItem {
-               TocItem(LyXParagraph * p, int d, string const & s)
+               TocItem(Paragraph * p, int d, string const & s)
                        : par(p), depth(d), str(s) {}
                ///
-               LyXParagraph * par;
+               Paragraph * par;
                ///
                int depth;
                ///
@@ -283,15 +287,15 @@ public:
        BufferView * getUser() const;
 
        ///
-       void ChangeLanguage(Language const * from, Language const * to);
+       void changeLanguage(Language const * from, Language const * to);
        ///
        bool isMultiLingual();
 
        /// Does this mean that this is buffer local?
-        UndoStack undostack;
+       UndoStack undostack;
        
        /// Does this mean that this is buffer local? 
-        UndoStack redostack;
+       UndoStack redostack;
        
        ///
        BufferParams params;
@@ -300,7 +304,7 @@ public:
            This is a linked list of paragraph, this list holds the
            whole contents of the document.
         */
-       LyXParagraph * paragraph;
+       Paragraph * paragraph;
 
        /// LyX version control object.
        LyXVC lyxvc;
@@ -319,22 +323,6 @@ public:
        /// Used when typesetting to place errorboxes.
        TexRow texrow;
 private:
-        ///
-       void DocBookHandleCaption(std::ostream & os, string & inner_tag,
-                                 int depth, int desc_on,
-                                 LyXParagraph * & par);
-       /// Open SGML/XML tag.
-        void sgmlOpenTag(std::ostream & os, int depth,
-                        string const & latexname) const;
-        /// Closes SGML/XML tag.
-        void sgmlCloseTag(std::ostream & os, int depth,
-                         string const & latexname) const;
-       ///
-       void LinuxDocError(LyXParagraph * par, int pos,
-                          string const & message);
-        ///
-       void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par, int depth);
-
        /// is save needed
        mutable bool lyx_clean;
        
@@ -378,19 +366,18 @@ public:
                ///
                inset_iterator() : par(0) /*, it(0)*/ {}
                //
-               inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
-                       SetParagraph();
+               inset_iterator(Paragraph * paragraph) : par(paragraph) {
+                       setParagraph();
                }
                ///
-               inset_iterator(LyXParagraph * paragraph,
-                              LyXParagraph::size_type pos);
+               inset_iterator(Paragraph * paragraph, lyx::pos_type pos);
                ///
                inset_iterator & operator++() { // prefix ++
                        if (par) {
                                ++it;
                                if (it == par->inset_iterator_end()) {
                                        par = par->next();
-                                       SetParagraph();
+                                       setParagraph();
                                }
                        }
                        return *this;
@@ -402,7 +389,7 @@ public:
                                ++it;
                                if (it == par->inset_iterator_end()) {
                                        par = par->next();
-                                       SetParagraph();
+                                       setParagraph();
                                }
                        }
                        return tmp;
@@ -411,20 +398,20 @@ public:
                Inset * operator*() { return *it; }
                
                ///
-               LyXParagraph * getPar() { return par; }
+               Paragraph * getPar() { return par; }
                ///
-               LyXParagraph::size_type getPos() const { return it.getPos(); }
+               lyx::pos_type getPos() const { return it.getPos(); }
                ///
                friend
                bool operator==(inset_iterator const & iter1,
                                inset_iterator const & iter2);
        private:
                ///
-               void SetParagraph();
+               void setParagraph();
                ///
-               LyXParagraph * par;
+               Paragraph * par;
                ///
-               LyXParagraph::inset_iterator it;
+               Paragraph::inset_iterator it;
        };
 
        ///
@@ -435,6 +422,22 @@ public:
        inset_iterator inset_iterator_end() {
                return inset_iterator();
        }
+       ///
+       inset_iterator inset_const_iterator_begin() const {
+               return inset_iterator(paragraph);
+       }
+       ///
+       inset_iterator inset_const_iterator_end() const {
+               return inset_iterator();
+       }
+
+       ///
+       ParIterator par_iterator_begin();
+       ///
+       ParIterator par_iterator_end();
+
+       ///
+       Inset * getInsetFromID(int id_arg) const;
 };
 
 
@@ -453,15 +456,7 @@ void Buffer::delUser(BufferView *)
        
 
 inline
-void Buffer::redraw()
-{
-       users->redraw(); 
-       users->fitCursor(users->text); 
-}
-
-
-inline
-Language const * Buffer::GetLanguage() const
+Language const * Buffer::getLanguage() const
 {
        return params.language;
 }
@@ -561,7 +556,8 @@ void Buffer::setParentName(string const & name)
 
 ///
 inline
-bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
+bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b)
+{
        return a.par == b.par && a.str == b.str;
        // No need to compare depth.
 }
@@ -569,7 +565,8 @@ bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
 
 ///
 inline
-bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
+bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b)
+{
        return !(a == b);
        // No need to compare depth.
 }
@@ -578,7 +575,8 @@ bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
 ///
 inline
 bool operator==(Buffer::inset_iterator const & iter1,
-               Buffer::inset_iterator const & iter2) {
+               Buffer::inset_iterator const & iter2)
+{
        return iter1.par == iter2.par
                && (iter1.par == 0 || iter1.it == iter2.it);
 }
@@ -587,7 +585,9 @@ bool operator==(Buffer::inset_iterator const & iter1,
 ///
 inline
 bool operator!=(Buffer::inset_iterator const & iter1,
-               Buffer::inset_iterator const & iter2) {
+               Buffer::inset_iterator const & iter2)
+{
        return !(iter1 == iter2);
 }
+
 #endif