]> git.lyx.org Git - lyx.git/blobdiff - src/buffer.h
Small fix.
[lyx.git] / src / buffer.h
index 932fb61731d5a93781ba785336a5fca4602e63af..598ea56015991c8dd20318aef7555926083617e4 100644 (file)
@@ -1,14 +1,14 @@
 // -*- C++ -*-
 /* This file is part of
-* ====================================================== 
-* 
-*           LyX, The Document Processor         
-*          Copyright (C) 1995 Matthias Ettrich
-*
-*           This file is Copyleft (C) 1996
-*           Lars Gullik Bjønnes
-*
-* ====================================================== */
+ * ====================================================== 
+ 
+ *           LyX, The Document Processor        
+ *           Copyright 1995 Matthias Ettrich
+ *
+ *           This file is Copyleft 1996
+ *           Lars Gullik Bjønnes
+ *
+ * ====================================================== */
  
 // Change Log:
 // =========== 
 #pragma interface
 #endif
 
-#include "undo.h"
+#include "LString.h"
+
 #include "BufferView.h"
 #include "lyxvc.h"
 #include "bufferparams.h"
 #include "texrow.h"
-#include "lyxtext.h"
+
 
 class LyXRC;
 class TeXErrors;
 class LaTeXFeatures;
-
-extern void updateAllVisibleBufferRelatedPopups();
-extern void WarnReadonly();
+class auto_mem_buffer;
 
 ///
 struct DEPCLEAN {
@@ -47,7 +46,7 @@ struct DEPCLEAN {
        ///
        string master;
        ///
-       DEPCLEAN *next;
+       DEPCLEAN * next;
 };
 
 /** The buffer object.
@@ -60,7 +59,7 @@ public:
        /**@name Constructors and destructor */
        //@{
        ///
-       Buffer(string const & file, LyXRC * lyxrc = 0, bool b = false);
+       explicit Buffer(string const & file, bool b = false);
        
        ///
        ~Buffer();
@@ -70,54 +69,52 @@ public:
        //@{
 
        /** save the buffer's parameters as user default
-         This function saves a file 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 true on success.
-         */
+           This function saves a file 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 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);
+
+       /// Maybe we know the function already by number...
+       bool Dispatch(int ac, string const & argument);
+
+       /// and have an xtl buffer to work with.
+       bool Dispatch(int, auto_mem_buffer &);
+
        /// should be changed to work for a list.
-       void resize()
-       {
-               if (users) {
-                       users->resize();
-               } else if (text) {
-                       delete text;
-                       text = 0;
-               }
-       }
+       void resize();
+       void resizeInsets(BufferView *);
 
        /// Update window titles of all users
-       void updateTitles();
+       void updateTitles() const;
 
        /// Reset autosave timers for all users
-       void resetAutosaveTimers();
+       void resetAutosaveTimers() const;
 
        /** Adds the BufferView to the users list.
-         Later this func will insert the BufferView into a real list,
-         not just setting a pointer.
-         */
+           Later this func will insert the BufferView into a real list,
+           not just setting a pointer.
+       */
        void addUser(BufferView * u) { users = u; }
 
        /** Removes the BufferView from the users list.
-         Since we only can have one at the moment, we just reset it.
-         */
-       void delUser(BufferView *){ users = 0; }
-
-       ///
-       void update(signed char f);
-
+           Since we only can have one at the moment, we just reset it.
+       */
+       void delUser(BufferView *) { users = 0; }
+       
        ///
        void redraw() {
-              users->redraw(); 
-              users->fitCursor(); 
-              users->updateScrollbar();
+               users->redraw(); 
+               users->fitCursor(); 
+               //users->updateScrollbar();
        }
 
-        /// Open and lock an updatable inset
-        void open_new_inset(UpdatableInset *);
-
        ///
        void loadAutoSaveFile();
        
@@ -131,11 +128,28 @@ public:
            If par is given, the file is inserted. */
        bool readLyXformat2(LyXLex &, LyXParagraph * par = 0);
 
-       /// Inserts a lyx file at cursor position. Returns false if it fails.
-       bool insertLyXFile(string const & filename);
-
+       /* This parses a single LyXformat-Token */
+       bool parseSingleLyXformat2Token(LyXLex &, LyXParagraph *& par,
+                                       LyXParagraph *& return_par,
+                                       string const & token, int & pos,
+                                       char & depth, LyXFont &
+#ifndef NEW_INSETS
+                                       ,LyXParagraph::footnote_flag &,
+                                       LyXParagraph::footnote_kind &
+#endif
+               );
+private:
+       // Parse a single inset.
+       void readInset(LyXLex &, LyXParagraph *& par, int & pos, LyXFont &);
+public:
+       /** Save file
+           Takes care of auto-save files and backup file if requested.
+           Returns true if the save is successful, false otherwise.
+       */
+       bool save() const;
+       
        /// Write file. Returns false if unsuccesful.
-       bool writeFile(string const &, bool);
+       bool writeFile(string const &, bool) const;
        
        ///
        void writeFileAscii(string const & , int);
@@ -144,6 +158,12 @@ public:
        void makeLaTeXFile(string const & filename,
                           string const & original_path,
                           bool nice, bool only_body = false);
+       //
+       // LaTeX all paragraphs from par to endpar,
+       // if endpar == 0 then to the end
+       //
+       void latexParagraphs(std::ostream & os, LyXParagraph *par,
+                            LyXParagraph *endpar, TexRow & texrow) const;
 
        ///
        int runLaTeX();
@@ -158,9 +178,11 @@ public:
        int runChktex();
 
        ///
-       void makeLinuxDocFile(string const & filename, int column);
+       void makeLinuxDocFile(string const & filename,
+                             bool nice, bool only_body = false);
        ///
-       void makeDocBookFile(string const & filename, int column);
+       void makeDocBookFile(string const & filename,
+                            bool nice, bool only_body = false);
 
        /// returns the main language for the buffer (document)
        string GetLanguage() const {
@@ -170,9 +192,6 @@ public:
        ///
        bool isLyxClean() const { return lyx_clean; }
        
-       /// changed Heinrich Bauer, 23/03/98
-       bool isDviClean();
-       
         ///
         bool isNwClean() const { return nw_clean; }
        
@@ -183,7 +202,7 @@ public:
        bool isDepClean(string const & name) const;
        
        ///
-       void markLyxClean() { 
+       void markLyxClean() const 
                if (!lyx_clean) {
                        lyx_clean = true; 
                        updateTitles();
@@ -193,9 +212,6 @@ public:
                bak_clean = true;
        }
 
-       /// changed Heinrich Bauer, 23/03/98
-       void markDviClean();
-       
         ///
         void markNwClean() { nw_clean = true; }
        
@@ -205,23 +221,24 @@ public:
        ///
        void markDepClean(string const & name);
        
-       ///
-       void markDviDirty();
-       
         ///
         void markNwDirty() { nw_clean = false; }
-       
+
+       ///
+       void setUnnamed(bool flag=true) { unnamed = flag; }
+
+       ///
+       bool isUnnamed() { return unnamed; }
+
        ///
        void markDirty() {
                if (lyx_clean) {
                        lyx_clean = false;
                        updateTitles();
                }
-               dvi_clean_tmpd = false;
-               dvi_clean_orgd = false;
-                nw_clean = false;
+               nw_clean = false;
                bak_clean = false;
-               DEPCLEAN* tmp = dep_clean;
+               DEPCLEAN * tmp = dep_clean;
                while (tmp) {
                        tmp->clean = false;
                        tmp = tmp->next;
@@ -229,29 +246,23 @@ public:
        }
 
        ///
-       string getFileName() const { return filename; }
+       string const & fileName() const { return filename; }
+
+       /** A transformed version of the file name, adequate for LaTeX  
+           The path is stripped if no_path is true (default) */
+       string getLatexName(bool no_path = true) const;
 
        /// Change name of buffer. Updates "read-only" flag.
-       void setFileName(string const & newfile);
+       void fileName(string const & newfile);
 
        /// Name of the document's parent
        void setParentName(string const &);
 
        /// Is buffer read-only?
-       bool isReadonly() { return read_only; }
+       bool isReadonly() const { return read_only; }
 
        /// Set buffer read-only flag
-       void setReadonly(bool flag = true) 
-       {
-               if (read_only != flag) {
-                       read_only = flag; 
-                       updateTitles();
-                       updateAllVisibleBufferRelatedPopups();
-               }
-               if (read_only) {
-                       WarnReadonly();
-               }
-       }
+       void setReadonly(bool flag = true);
 
        /// returns true if the buffer contains a LaTeX document
        bool isLatex() const;
@@ -259,7 +270,8 @@ public:
        bool isLinuxDoc() const;
        /// returns true if the buffer contains a DocBook document
        bool isDocBook() const;
-       /// returns true if the buffer contains either a LinuxDoc or DocBook document
+       /** returns true if the buffer contains either a LinuxDoc
+           or DocBook document */
        bool isSGML() const;
         /// returns true if the buffer contains a Wed document
         bool isLiterate() const;
@@ -267,47 +279,52 @@ public:
        ///
        void setPaperStuff();
 
-#if 0
-       ///
-       void setOldPaperStuff();
-#endif
-       
        /** 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 commands
-         and packages need to be included in the LaTeX file. It (should)
-         also check that the needed constructs are there (i.e. that the \refs
-         points to coresponding \labels). It should perhaps inset "error"
-         insets to help the user correct obvious mistakes.
-        */
-       void validate(LaTeXFeatures &); //the correct parameters to be
-                                       //included later 
-
-       /** Insert an inset into the buffer
-         Insert inset into buffer, placing it in a layout of lout,
-         if no_table make sure that it doesn't end up in a table. */
-       void insertInset(Inset *, string const & lout = string(), 
-                        bool no_table = false);
-
-        ///
-        void setCursorFromRow (int);
+           This validates the buffer, and returns a struct for use by
+           makeLaTeX and others. Its main use is to figure out what
+           commands and packages need to be included in the LaTeX file.
+           It (should) also check that the needed constructs are there
+           (i.e. that the \refs points to coresponding \labels). It
+           should perhaps inset "error" insets to help the user correct
+           obvious mistakes.
+       */
+       void validate(LaTeXFeatures &) const;
 
        ///
        string getIncludeonlyList(char delim = ',');
        ///
-       string getReferenceList(char delim = '|');
+       std::vector<std::pair<string,string> > getBibkeyList();
        ///
-       string getBibkeyList(char delim = '|');
+       struct TocItem {
+               LyXParagraph * par;
+               int depth;
+               string str;
+       };
        ///
-       bool gotoLabel(string const &);
-
-       /// removes all autodeletable insets
-       bool removeAutoInsets();
+       enum TocType {
+               ///
+               TOC_TOC = 0,
+               ///
+               TOC_LOF,
+               ///
+               TOC_LOT,
+               ///
+               TOC_LOA
+       };
+       ///
+       std::vector<std::vector<TocItem> > getTocList();
+       ///
+       std::vector<string> getLabelList();
 
        /** This will clearly have to change later. Later we can have more
-         than one user per buffer. */
+           than one user per buffer. */
        BufferView * getUser() const { return users; }
 
+       ///
+       void ChangeLanguage(Language const * from, Language const * to);
+       ///
+       bool isMultiLingual();
+
         //@}
 
        /// Does this mean that this is buffer local?
@@ -322,14 +339,6 @@ public:
        /** is a list of paragraphs.
         */
        LyXParagraph * paragraph;
-       
-       /** This holds the mapping between buffer paragraphs and screen rows.
-           Should be moved to BufferView. (Asger)
-        */
-       LyXText * text;
-
-       ///
-       UpdatableInset * the_locking_inset;
 
        /// RCS object
        LyXVC lyxvc;
@@ -343,81 +352,60 @@ public:
        /** While writing as LaTeX, tells whether we are
            doing a 'nice' LaTeX file */
        bool niceFile;
-protected:
-       ///
-        void InsetUnlock();
-       
-       ///
-        inline void InsetSleep();
-       
-       ///
-        inline void InsetWakeup();
-       
-       ///
-        bool inset_slept;
-       
-       ///
-        int  slx;
-       ///
-       int sly;
+
+       /// Used when typesetting to place errorboxes.
+       TexRow texrow;
 private:
-       ///
-       void insertErrors(TeXErrors &);
-       
+#ifndef NEW_INSETS
         ///
-        void linuxDocHandleFootnote(FILE * file,
+        void linuxDocHandleFootnote(std::ostream & os,
                                    LyXParagraph * & par, int const depth);
+#endif
         ///
-       void DocBookHandleCaption(FILE * file, string & inner_tag,
+       void DocBookHandleCaption(std::ostream & os, string & inner_tag,
                                  int const depth, int desc_on,
-                                 LyXParagraph * &par);
+                                 LyXParagraph * & par);
+#ifndef NEW_INSETS
         ///
-       void DocBookHandleFootnote(FILE * file,
+       void DocBookHandleFootnote(std::ostream & os,
                                   LyXParagraph * & par, int const depth);
+#endif
        ///
-        void sgmlOpenTag(FILE * file, int depth,
+        void sgmlOpenTag(std::ostream & os, int depth,
                         string const & latexname) const;
         ///
-        void sgmlCloseTag(FILE * file, int depth,
+        void sgmlCloseTag(std::ostream & os, int depth,
                          string const & latexname) const;
        ///
        void LinuxDocError(LyXParagraph * par, int pos, char const * message);
         ///
-       void SimpleLinuxDocOnePar(FILE * file, LyXParagraph * par,
+       void SimpleLinuxDocOnePar(std::ostream & os, LyXParagraph * par,
                                  int desc_on, int const depth);
         ///
-       void SimpleDocBookOnePar(string & file, string & extra,
+       void SimpleDocBookOnePar(std::ostream &, string & extra,
                                 LyXParagraph * par, int & desc_on,
                                 int const depth);
 
        /// LinuxDoc.
-       void push_tag(FILE * file, char const * tag,
+       void push_tag(std::ostream & os, char const * tag,
                      int & pos, char stack[5][3]);
        
        /// LinuxDoc.
-       void pop_tag(FILE * file, char const * tag,
+       void pop_tag(std::ostream & os, char const * tag,
                     int & pos, char stack[5][3]);
 
-       ///
-       void RoffAsciiTable(FILE * file, LyXParagraph * par);
-
        /// is save needed
-       bool lyx_clean;
+       mutable bool lyx_clean;
        
        /// is autosave needed
-       bool bak_clean;
+       mutable bool bak_clean;
        
-       /** do we need to run LaTeX, changed 23/03/98, Heinrich Bauer
-           We have to distinguish between TeX-runs executed in the original
-           directory (in which the original LyX-file resides) and TeX-runs
-           executed in a temporary directory. The first situation is valid
-           for a dvi-export, the latter one for printing or previewing. */
-       bool dvi_clean_orgd;
-       bool dvi_clean_tmpd;
-
         /// do we need to run weave/tangle
         bool nw_clean;
 
+       /// is this a unnamed file (New...)
+       bool unnamed;
+
        /// is regenerating .tex necessary
        DEPCLEAN * dep_clean;
 
@@ -431,49 +419,80 @@ private:
        float format;
        
        /** A list of views using this buffer.
-         Why not keep a list of the BufferViews that use 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.
-         */
+           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;
 
+public:
+       class inset_iterator {
+       public:
+               inset_iterator() : par(0) /*, it(0)*/ {}
+               inset_iterator(LyXParagraph * paragraph) : par(paragraph) {
+                       SetParagraph();
+               }
+               inset_iterator(LyXParagraph * paragraph, LyXParagraph::size_type pos);
+               inset_iterator & operator++() {
+                       if (par) {
+                               ++it;
+                               if (it == par->inset_iterator_end()) {
+                                       par = par->next;
+                                       SetParagraph();
+                               }
+                       }
+                       return *this;
+               }
+               Inset * operator*() {return *it; }
+               LyXParagraph * getPar() { return par; }
+               LyXParagraph::size_type getPos() {return it.getPos(); }
+               friend
+               bool operator==(inset_iterator const & iter1,
+                               inset_iterator const & iter2) {
+                       return iter1.par == iter2.par
+                               && (iter1.par == 0 || iter1.it == iter2.it);
+               }
+               friend
+               bool operator!=(inset_iterator const & iter1,
+                               inset_iterator const & iter2) {
+                       return !(iter1 == iter2);
+               }
+       private:
+               void SetParagraph();
+               LyXParagraph * par;
+               LyXParagraph::inset_iterator it;
+       };
+
        ///
-       friend class BufferList;
+       inset_iterator inset_iterator_begin() {
+               return inset_iterator(paragraph);
+       }
        ///
-        friend class BufferView;
-
-       /// Used when typesetting to place errorboxes.
-       TexRow texrow;
+       inset_iterator inset_iterator_end() {
+               return inset_iterator();
+       }
 };
 
 
 inline  
-void Buffer::InsetSleep()
+void Buffer::setParentName(string const & name)
 {
-    if (the_locking_inset && !inset_slept) {
-       the_locking_inset->GetCursorPos(slx, sly);
-        the_locking_inset->InsetUnlock();
-       inset_slept = true;
-    }
+       params.parentname = name;    
 }
 
-
-inline  
-void Buffer::InsetWakeup()
-{
-    if (the_locking_inset && inset_slept) {
-       the_locking_inset->Edit(slx, sly);
-       inset_slept = false;
-    }  
+inline
+bool operator==(Buffer::TocItem const & a, Buffer::TocItem const & b) {
+       return a.par == b.par && a.str == b.str;
+       // No need to compare depth.
 }
 
 
-inline  
-void Buffer::setParentName(string const & name)
-{
-    params.parentname = name;    
+inline
+bool operator!=(Buffer::TocItem const & a, Buffer::TocItem const & b) {
+       return !(a == b);
+       // No need to compare depth.
 }
 
 #endif