// -*- 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
-
-#ifdef __GNUG__
-#pragma interface
-#endif
+#ifndef BUFFERPARAMS_H
+#define BUFFERPARAMS_H
#include "LString.h"
-#include "lyxlex.h"
#include "vspace.h"
#include "Spacing.h"
#include "Bullet.h"
+#include "lyxtextclass.h"
+#include "LaTeXFeatures.h"
+#include "texrow.h"
+#include "author.h"
+#include "paper.h"
+#include "BranchList.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 <boost/array.hpp>
+#include <vector>
+
+class LyXLex;
+class LatexFeatures;
+class TexRow;
+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&);
- //@}
- /// Dummy destructor to shut up gcc
- virtual ~BufferParams() {}
-
+ /// read a header token, if unrecognised, return it or an unknown class name
+ string const readToken(LyXLex & lex, string const & token);
+
///
- 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;
+
+ ///
+ VSpace const & getDefSkip() const { return defskip; }
///
- void setDefSkip(VSpace vs) { defskip = vs; }
-
+ void setDefSkip(VSpace const & vs) { defskip = 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
+ PARSEP paragraph_separation;
+ ///
+ InsetQuotes::quote_language quotes_language;
///
- InsetQuotes::quote_language quotes_language;
+ InsetQuotes::quote_times quotes_times;
///
- InsetQuotes::quote_times quotes_times;
+ string fontsize;
///
- LString fontsize;
+ lyx::textclass_type textclass;
///
- signed char 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 general papersize (papersize2 or paperpackage
+ PAPER_SIZE papersize;
+ /// the selected Geometry papersize
+ VMARGIN_PAPER_TYPE papersize2;
+ /// a special paperpackage .sty-file
+ PAPER_PACKAGES paperpackage;
+ ///
+ PAPER_ORIENTATION orientation;
+ ///
+ bool use_geometry;
+ ///
+ string paperwidth;
+ ///
+ string paperheight;
+ ///
+ string leftmargin;
+ ///
+ string topmargin;
+ ///
+ string rightmargin;
+ ///
+ string bottommargin;
+ ///
+ string headheight;
+ ///
+ string headsep;
+ ///
+ string footskip;
+
+ /* some LaTeX options */
/// The graphics driver
- LString graphicsDriver;
+ string graphicsDriver;
///
- LString fonts;
+ string fonts;
///
Spacing spacing;
///
- signed char secnumdepth;
+ int secnumdepth;
+ ///
+ int tocdepth;
///
- signed char tocdepth;
+ Language const * language;
+ /// BranchList:
+ BranchList branchlist;
///
- LString language;
+ string inputenc;
///
- LString inputenc;
+ string preamble;
///
- LString preamble;
+ string options;
///
- LString options;
+ string float_placement;
///
- LString float_placement;
+ unsigned int columns;
///
- char columns; // add approp. signedness
+ LyXTextClass::PageSides sides;
///
- char sides; // add approp. signedness
+ string pagestyle;
///
- LString pagestyle;
+ boost::array<Bullet, 4> temp_bullets;
///
- Bullet temp_bullets[4];
+ boost::array<Bullet, 4> user_defined_bullets;
///
- Bullet user_defined_bullets[4];
+ void readPreamble(LyXLex &);
///
- void Copy(BufferParams const &p);
+ void readLanguage(LyXLex &);
///
- virtual void readPreamble(LyXLex &);
+ 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]
+ string parentname;
///
- virtual void readLanguage(LyXLex &);
+ bool compressed;
+
+ /// map of the file's author IDs to buffer author IDs
+ std::vector<int> author_map;
///
- virtual void readGraphicsDriver(LyXLex &);
- /// do we allow accents on all chars in this buffer
- bool allowAccents;
+ string const dvips_options() const;
///
- bool use_amsmath;
- /// Time ago we agreed that this was a buffer property [ale990407]
- LString parentname;
-protected:
+ string const paperSizeName() 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. */
+ and for detached paragraphs in "indented" documents.
+ */
VSpace defskip;
};
projects / lyx.git / blobdiff