X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2Fbufferparams.h;h=5951f830114577da9f71f54bc626453634044ba7;hb=65ca7003ba47b7348610393a9a0d2d309b4e9702;hp=1940b5f0f4d277f73a44195e75904bc4fc9bf93a;hpb=dfe1bc44b44903faf77ef454c98c4c3e56c1d5e3;p=lyx.git diff --git a/src/bufferparams.h b/src/bufferparams.h index 1940b5f0f4..5951f83011 100644 --- a/src/bufferparams.h +++ b/src/bufferparams.h @@ -1,153 +1,247 @@ // -*- C++ -*- -/* This file is part of - * ====================================================== - * - * LyX, The Document Processor - * - * Copyright 1995 Matthias Ettrich - * Copyright 1995-1999 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 +#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" -#include "layout.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 + + +class AuthorList; +class BranchList; +class Bullet; +class LyXLex; +class LatexFeatures; +class Spacing; +class TexRow; +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. + */ class BufferParams { public: - //@Man: Constructors and Deconstructors - //@{ + /// + enum PARSEP { + /// + PARSEP_INDENT, + /// + PARSEP_SKIP + }; /// 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 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; /// - string fontsize; + std::string fontsize; /// - LyXTextClassList::ClassList::size_type textclass; + 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 */ - /// - 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; - /// - string paperwidth; - /// - string paperheight; - /// - string leftmargin; - /// - string topmargin; - /// - string rightmargin; - /// - string bottommargin; - /// - string headheight; - /// - string headsep; - /// - string footskip; - - /* some LaTeX options */ + /// the papersize + PAPER_SIZE papersize; + /// + PAPER_ORIENTATION orientation; + /// use custom margins + bool use_geometry; + /// + std::string paperwidth; + /// + std::string paperheight; + /// + std::string leftmargin; + /// + std::string topmargin; + /// + std::string rightmargin; + /// + std::string bottommargin; + /// + std::string headheight; + /// + std::string headsep; + /// + 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; /// int tocdepth; /// - string language; + Language const * language; + /// 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; + 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; /// - Bullet temp_bullets[4]; + void readPreamble(LyXLex &); /// - Bullet user_defined_bullets[4]; + void readLanguage(LyXLex &); /// - void Copy(BufferParams const &p); + void readGraphicsDriver(LyXLex &); /// - virtual void readPreamble(LyXLex &); + void readBullets(LyXLex &); /// - virtual void readLanguage(LyXLex &); + void readBulletsLaTeX(LyXLex &); + + /// use AMS package, not, or auto + enum AMS { + AMS_OFF, + AMS_AUTO, + AMS_ON + }; + AMS use_amsmath; + /// + lyx::biblio::CiteEngine cite_engine; + /// + 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] + std::string parentname; /// - virtual void readGraphicsDriver(LyXLex &); - /// do we allow accents on all chars in this buffer - bool allowAccents; + 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 author_map; /// - bool use_amsmath; - /// Time ago we agreed that this was a buffer property [ale990407] - string parentname; -protected: -private: + std::string const dvips_options() const; + /// + std::string const paperSizeName() 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 babelCall(std::string const & lang_opts) const; + +private: + /** 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 pimpl_; }; #endif