// -*- C++ -*-
-/* This file is part of
- * ======================================================
- *
- * LyX, The Document Processor
- *
- * Copyright (C) 1995 1996 Matthias Ettrich
- * and the LyX Team.
+/**
+ * \file bufferparams.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author André Pönitz
*
- *======================================================*/
+ * Full author contact details are available in file CREDITS.
+ */
-#ifndef _BUFFERPARAMS_H
-#define _BUFFERPARAMS_H
+#ifndef BUFFERPARAMS_H
+#define BUFFERPARAMS_H
-#ifdef __GNUG__
-#pragma interface
-#endif
+#include "lyxtextclass.h"
+#include "paper.h"
-#include "LString.h"
-#include "lyxlex.h"
-#include "vspace.h"
-#include "Spacing.h"
-#include "Bullet.h"
#include "insets/insetquotes.h"
-/**
- 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.
- */
+#include "support/copied_ptr.h"
+#include "support/types.h"
+
+#include <vector>
+
+
+class AuthorList;
+class BranchList;
+class Bullet;
+class LyXLex;
+class LatexFeatures;
+class Spacing;
+class TexRow;
+class VSpace;
+struct Language;
+
+
+/** 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.
+ */
class BufferParams {
public:
- //@Man: Constructors and Deconstructors
- //@{
+ ///
+ enum PARSEP {
+ ///
+ PARSEP_INDENT,
+ ///
+ PARSEP_SKIP
+ };
///
BufferParams();
- // ///
- //BufferParams(const BufferParams&);
- //@}
+ ~BufferParams();
+
+ /// read a header token, if unrecognised, return it or an unknown class name
+ std::string const readToken(LyXLex & lex, std::string const & token);
- /// Dummy destructor to shut up gcc
- virtual ~BufferParams() {}
-
///
- void writeFile(FILE *);
+ 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...
+ */
+ bool writeLaTeX(std::ostream &, LaTeXFeatures &, TexRow &) const;
+
+ ///
+ void setPaperStuff();
///
void useClassDefaults();
///
- VSpace getDefSkip() const { return defskip; }
+ bool hasClassDefaults() const;
///
- void setDefSkip(VSpace vs) { defskip = vs; }
-
+ VSpace const & getDefSkip() const;
+
+ ///
+ 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.
- */
- char paragraph_separation; // add approp. signedness
+ * articles or by using a little skip like in letters.
+ */
+ PARSEP paragraph_separation;
///
- InsetQuotes::quote_language quotes_language;
+ InsetQuotes::quote_language quotes_language;
///
- InsetQuotes::quote_times quotes_times;
+ InsetQuotes::quote_times quotes_times;
///
- LString fontsize;
+ std::string fontsize;
///
- signed char textclass;
+ lyx::textclass_type textclass;
+ ///
+ LyXTextClass const & getLyXTextClass() const;
/* this are for the PaperLayout */
- ///
- char papersize; /* the general papersize (papersize2 or paperpackage */ // add approp. signedness
- ///
- char papersize2; /* the selected Geometry papersize */ // add approp. signedness
- ///
- char paperpackage; /* a special paperpackage .sty-file */ // add approp. signedness
- ///
- char orientation; // add approp. signedness
- ///
- bool use_geometry;
- ///
- LString paperwidth;
- ///
- LString paperheight;
- ///
- LString leftmargin;
- ///
- LString topmargin;
- ///
- LString rightmargin;
- ///
- LString bottommargin;
- ///
- LString headheight;
- ///
- LString headsep;
- ///
- LString footskip;
-
- /* some LaTeX options */
- /// The graphics driver
- LString graphicsDriver;
+ /// the general papersize (papersize2 or paperpackage
+ PAPER_SIZE papersize;
+ /// the selected Geometry papersize
+ VMARGIN_PAPER_TYPE papersize2;
+ /// a special paperpackage .sty-file
+ PAPER_PACKAGES paperpackage;
///
- LString fonts;
+ PAPER_ORIENTATION orientation;
///
- Spacing spacing;
+ bool use_geometry;
///
- signed char secnumdepth;
+ std::string paperwidth;
///
- signed char tocdepth;
+ std::string paperheight;
///
- LString language;
+ std::string leftmargin;
///
- LString inputenc;
+ std::string topmargin;
///
- LString preamble;
+ std::string rightmargin;
///
- LString options;
+ std::string bottommargin;
///
- LString float_placement;
+ std::string headheight;
///
- char columns; // add approp. signedness
+ std::string headsep;
///
- char sides; // add approp. signedness
+ std::string footskip;
+
+ /* some LaTeX options */
+ /// The graphics driver
+ std::string graphicsDriver;
+ ///
+ std::string fonts;
+ ///
+ Spacing & spacing();
+ Spacing const & spacing() const;
+ ///
+ int secnumdepth;
+ ///
+ int tocdepth;
+ ///
+ Language const * language;
+ /// BranchList:
+ BranchList & branchlist();
+ BranchList const & branchlist() const;
+ ///
+ std::string inputenc;
+ ///
+ std::string preamble;
///
- LString pagestyle;
+ std::string options;
///
- Bullet temp_bullets[4];
+ std::string float_placement;
///
- Bullet user_defined_bullets[4];
+ unsigned int columns;
///
- void Copy(BufferParams const &p);
+ LyXTextClass::PageSides sides;
///
- virtual void readPreamble(LyXLex &);
+ 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;
///
- virtual void readLanguage(LyXLex &);
+ void readPreamble(LyXLex &);
///
- virtual void readGraphicsDriver(LyXLex &);
- /// do we allow accents on all chars in this buffer
- bool allowAccents;
+ void readLanguage(LyXLex &);
///
- bool use_amsmath;
+ void readGraphicsDriver(LyXLex &);
+
+ /// use AMS package, not, or auto
+ enum AMS {
+ AMS_OFF,
+ AMS_AUTO,
+ AMS_ON
+ };
+ AMS use_amsmath;
+ ///
+ bool use_natbib;
+ ///
+ bool use_numerical_citations;
+ /// revision tracking for this buffer ?
+ bool tracking_changes;
/// Time ago we agreed that this was a buffer property [ale990407]
- LString parentname;
-protected:
-private:
+ 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::string const dvips_options() const;
///
- friend class Buffer;
- /** This is the amount of space used for paragraph_separation "skip",
- and for detached paragraphs in "indented" documents. */
- VSpace defskip;
+ std::string const paperSizeName() const;
+
+private:
+ /** Use the Pimpl idiom to hide those member variables that would otherwise
+ * drag in other header files.
+ */
+ class Impl;
+ struct MemoryTraits {
+ static Impl * clone(Impl const *);
+ static void destroy(Impl *);
+ };
+ lyx::support::copied_ptr<Impl, MemoryTraits> pimpl_;
};
#endif