]> git.lyx.org Git - lyx.git/blobdiff - src/bufferparams.h
Fix event loop to no longer eat CPU
[lyx.git] / src / bufferparams.h
index 5e13ba4f72ff976fa936f72cca6212547f343e53..5951f830114577da9f71f54bc626453634044ba7 100644 (file)
 #ifndef BUFFERPARAMS_H
 #define BUFFERPARAMS_H
 
-#include "author.h"
-#include "BranchList.h"
-#include "Bullet.h"
 #include "lyxtextclass.h"
 #include "paper.h"
-#include "Spacing.h"
-#include "vspace.h"
 
 #include "insets/insetquotes.h"
 
-#include <boost/array.hpp>
+#include "support/copied_ptr.h"
+#include "support/types.h"
 
-#include "support/std_string.h"
 #include <vector>
 
+
+class AuthorList;
+class BranchList;
+class Bullet;
 class LyXLex;
 class LatexFeatures;
+class Spacing;
 class TexRow;
-struct Language;
+class VSpace;
+class Language;
+
+
+namespace lyx {
+namespace biblio {
+
+enum CiteEngine {
+       ENGINE_BASIC,
+       ENGINE_NATBIB_AUTHORYEAR,
+       ENGINE_NATBIB_NUMERICAL,
+       ENGINE_JURABIB
+};
+
+class CiteEngine_enum {
+       CiteEngine val_;
+public:
+       CiteEngine_enum(CiteEngine val) : val_(val) {}
+       operator CiteEngine() const{ return val_; }
+};
+
+} // namespace biblio
+} // namespace lyx
+
 
 /** Buffer parameters.
-   This class contains all the parameters for this a buffer uses. Some
-   work needs to be done on this class to make it nice. Now everything
-   is in public.
-*/
*  This class contains all the parameters for this a buffer uses. Some
*  work needs to be done on this class to make it nice. Now everything
*  is in public.
+ */
 class BufferParams {
 public:
        ///
@@ -51,22 +74,20 @@ public:
        };
        ///
        BufferParams();
+       ~BufferParams();
 
        /// read a header token, if unrecognised, return it or an unknown class name
-       string const readToken(LyXLex & lex, string const & token);
+       std::string const readToken(LyXLex & lex, std::string const & token);
 
        ///
        void writeFile(std::ostream &) const;
 
        /** \returns true if the babel package is used (interogates
-           the BufferParams and a LyXRC variable).
-           This returned value can then be passed to the insets...
+        *  the BufferParams and a LyXRC variable).
+        *  This returned value can then be passed to the insets...
         */
        bool writeLaTeX(std::ostream &, LaTeXFeatures &, TexRow &) const;
 
-       ///
-       void setPaperStuff();
-
        ///
        void useClassDefaults();
 
@@ -74,63 +95,63 @@ public:
        bool hasClassDefaults() const;
 
        ///
-       VSpace const & getDefSkip() const { return defskip; }
+       VSpace const & getDefSkip() const;
 
        ///
-       void setDefSkip(VSpace const & vs) { defskip = vs; }
+       void setDefSkip(VSpace const & vs);
 
        /** Wether paragraphs are separated by using a indent like in
-         articles or by using a little skip like in letters.
-         */
+         articles or by using a little skip like in letters.
+        */
        PARSEP paragraph_separation;
        ///
        InsetQuotes::quote_language quotes_language;
        ///
        InsetQuotes::quote_times quotes_times;
        ///
-       string fontsize;
+       std::string fontsize;
        ///
        lyx::textclass_type textclass;
        ///
        LyXTextClass const & getLyXTextClass() const;
 
+       /// returns the main font for the buffer (document)
+       LyXFont const getFont() const;
+
        /* this are for the PaperLayout */
-       /// the general papersize (papersize2 or paperpackage
+       /// the papersize
        PAPER_SIZE papersize;
-       ///  the selected Geometry papersize
-       VMARGIN_PAPER_TYPE papersize2;
-       /// a special paperpackage .sty-file
-       PAPER_PACKAGES paperpackage;
        ///
        PAPER_ORIENTATION orientation;
-       ///
+       /// use custom margins
        bool use_geometry;
        ///
-       string paperwidth;
+       std::string paperwidth;
        ///
-       string paperheight;
+       std::string paperheight;
        ///
-       string leftmargin;
+       std::string leftmargin;
        ///
-       string topmargin;
+       std::string topmargin;
        ///
-       string rightmargin;
+       std::string rightmargin;
        ///
-       string bottommargin;
+       std::string bottommargin;
        ///
-       string headheight;
+       std::string headheight;
        ///
-       string headsep;
+       std::string headsep;
        ///
-       string footskip;
+       std::string footskip;
 
        /* some LaTeX options */
        /// The graphics driver
-       string graphicsDriver;
+       std::string graphicsDriver;
        ///
-       string fonts;
+       std::string fonts;
        ///
-       Spacing spacing;
+       Spacing & spacing();
+       Spacing const & spacing() const;
        ///
        int secnumdepth;
        ///
@@ -138,31 +159,38 @@ public:
        ///
        Language const * language;
        /// BranchList:
-       BranchList branchlist;
+       BranchList & branchlist();
+       BranchList const & branchlist() const;
        ///
-       string inputenc;
+       std::string inputenc;
        ///
-       string preamble;
+       std::string preamble;
        ///
-       string options;
+       std::string options;
        ///
-       string float_placement;
+       std::string float_placement;
        ///
        unsigned int columns;
        ///
        LyXTextClass::PageSides sides;
        ///
-       string pagestyle;
-       ///
-       boost::array<Bullet, 4> temp_bullets;
-       ///
-       boost::array<Bullet, 4> user_defined_bullets;
+       std::string pagestyle;
+       /// \param index should lie in the range 0 <= \c index <= 3.
+       Bullet & temp_bullet(lyx::size_type index);
+       Bullet const & temp_bullet(lyx::size_type index) const;
+       /// \param index should lie in the range 0 <= \c index <= 3.
+       Bullet & user_defined_bullet(lyx::size_type index);
+       Bullet const & user_defined_bullet(lyx::size_type index) const;
        ///
        void readPreamble(LyXLex &);
        ///
        void readLanguage(LyXLex &);
        ///
        void readGraphicsDriver(LyXLex &);
+       ///
+       void readBullets(LyXLex &);
+       ///
+       void readBulletsLaTeX(LyXLex &);
 
        /// use AMS package, not, or auto
        enum AMS {
@@ -172,33 +200,48 @@ public:
        };
        AMS use_amsmath;
        ///
-       bool use_natbib;
+       lyx::biblio::CiteEngine cite_engine;
        ///
-       bool use_numerical_citations;
+       bool use_bibtopic;
        /// revision tracking for this buffer ?
        bool tracking_changes;
+       /** This param decides if change tracking marks should be output
+        *  (using the dvipost package) or if the current "state" of the
+        *  document should be output instead. Since dvipost needs dvi
+        *  specials, it only works with dvi/ps output (the param will be
+        *  ignored with other output flavors and disabled when dbipost is
+        *  not installed).
+        */
+       bool output_changes;
        /// Time ago we agreed that this was a buffer property [ale990407]
-       string parentname;
+       std::string parentname;
        ///
        bool compressed;
 
+       /// the author list for the document
+       AuthorList & authors();
+       AuthorList const & authors() const;
+
        /// map of the file's author IDs to buffer author IDs
        std::vector<int> author_map;
        ///
-       string const dvips_options() const;
+       std::string const dvips_options() const;
+       ///
+       std::string const paperSizeName() const;
        ///
-       string const paperSizeName() const;
+       std::string const babelCall(std::string const & lang_opts) const;
 
 private:
-       /// the author list
-       AuthorList authorlist;
-
-       ///
-       friend class Buffer;
-       /** This is the amount of space used for paragraph_separation "skip",
-         and for detached paragraphs in "indented" documents.
-       */
-       VSpace defskip;
+       /** Use the Pimpl idiom to hide those member variables that would otherwise
+        *  drag in other header files.
+        */
+       class Impl;
+       class MemoryTraits {
+       public:
+               static Impl * clone(Impl const *);
+               static void destroy(Impl *);
+       };
+       lyx::support::copied_ptr<Impl, MemoryTraits> pimpl_;
 };
 
 #endif