#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>
+
+namespace lyx {
+
+class AuthorList;
+class BranchList;
+class Bullet;
+class Encoding;
class LyXLex;
class LatexFeatures;
+class Spacing;
class TexRow;
-struct Language;
+class VSpace;
+class Language;
+
+
+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
+
/** 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:
///
};
///
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();
+ bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
///
void useClassDefaults();
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;
+ 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;
- ///
- string fonts;
- ///
- Spacing spacing;
+ std::string graphicsDriver;
+ /// the rm font
+ std::string fontsRoman;
+ /// the sf font
+ std::string fontsSans;
+ /// the tt font
+ std::string fontsTypewriter;
+ /// the default family (rm, sf, tt)
+ std::string fontsDefaultFamily;
+ /// use expert Small Caps
+ bool fontsSC;
+ /// use Old Style Figures
+ bool fontsOSF;
+ /// the scale factor of the sf font
+ int fontsSansScale;
+ /// the scale factor of the tt font
+ int fontsTypewriterScale;
+ ///
+ Spacing & spacing();
+ Spacing const & spacing() const;
///
int secnumdepth;
///
///
Language const * language;
/// BranchList:
- BranchList branchlist;
- ///
- string inputenc;
+ BranchList & branchlist();
+ BranchList const & branchlist() const;
+ /**
+ * The input encoding for LaTeX. This can be one of
+ * - \c auto: find out the input encoding from the used languages
+ * - \c default: ditto
+ * - any encoding supported by the inputenc package
+ * The encoding of the LyX file is always utf8 and has nothing to
+ * do with this setting.
+ * The difference between \c auto and \c default is that \c auto also
+ * causes loading of the inputenc package, while \c default does not.
+ * \c default will not work unless the user takes additional measures
+ * (such as using special environments like the CJK environment from
+ * CJK.sty).
+ * \c default can be seen as an unspecified 8bit encoding, since LyX
+ * does not interpret it in any way apart from display on screen.
+ */
+ std::string inputenc;
+ /// The main encoding used by this buffer for LaTeX output.
+ /// Individual pieces of text can use different encodings.
+ Encoding const & encoding() const;
///
- 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(size_type index);
+ Bullet const & temp_bullet(size_type index) const;
+ /// \param index should lie in the range 0 <= \c index <= 3.
+ Bullet & user_defined_bullet(size_type index);
+ Bullet const & user_defined_bullet(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 {
- AMS_OFF,
- AMS_AUTO,
- AMS_ON
+ /// Whether to load a package such as amsmath or esint.
+ /// The enum values must not be changed (file format!)
+ enum Package {
+ /// Don't load the package. For experts only.
+ package_off = 0,
+ /// Load the package if needed (recommended)
+ package_auto = 1,
+ /// Always load the package (e.g. if the document contains
+ /// some ERT that needs the package)
+ package_on = 2
};
- AMS use_amsmath;
+ /// Whether and how to load amsmath
+ Package use_amsmath;
+ /// Whether and how to load esint
+ Package use_esint;
///
- bool use_natbib;
+ biblio::CiteEngine cite_engine;
///
- bool use_numerical_citations;
+ bool use_bibtopic;
/// revision tracking for this buffer ?
- bool tracking_changes;
+ bool trackChanges;
+ /** This param decides whether 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 dvipost is
+ * not installed).
+ */
+ bool outputChanges;
/// 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;
+ std::vector<unsigned int> author_map;
///
- string const dvips_options() const;
+ std::string const dvips_options() const;
///
- string const paperSizeName() const;
+ std::string const paperSizeName() const;
+ ///
+ std::string const babelCall(std::string const & lang_opts) const;
+ /// set up the document fonts
+ std::string const loadFonts(std::string const & rm,
+ std::string const & sf, std::string const & tt,
+ bool const & sc, bool const & osf,
+ int const & sfscale, int const & ttscale) const;
+ /// path of the current buffer
+ std::string filepath;
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 *);
+ };
+ support::copied_ptr<Impl, MemoryTraits> pimpl_;
};
+} // namespace lyx
+
#endif
projects / lyx.git / blobdiff