* This file is part of LyX, the document processor.
* Licence details can be found in the file COPYING.
*
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
* \author Jean-Marc Lasgouttes
* \author John Levon
- * \author André Pönitz
+ * \author André Pönitz
*
* Full author contact details are available in file CREDITS.
*/
#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
-#include "BiblioInfo.h"
-#include "TextClass.h"
-#include "TextClass_ptr.h"
+#include "Citation.h"
+#include "LayoutModuleList.h"
#include "paper.h"
#include "insets/InsetQuotes.h"
#include "support/copied_ptr.h"
-#include "support/FileName.h"
-#include "support/types.h"
-#include "frontends/controllers/frontend_helpers.h"
-
-#include <vector>
+#include <map>
namespace lyx {
+namespace support { class FileName; }
+
class AuthorList;
class BranchList;
class Bullet;
+class DocumentClass;
class Encoding;
-class Lexer;
+class Font;
+class HSpace;
+class IndicesList;
+class Language;
class LatexFeatures;
+class LayoutFile;
+class LayoutFileIndex;
+class Lexer;
+class PDFOptions;
class Spacing;
class TexRow;
class VSpace;
-class Language;
/** Buffer parameters.
* This class contains all the parameters for this buffer's use. Some
class BufferParams {
public:
///
- enum PARSEP {
+ enum ParagraphSeparation {
///
- PARSEP_INDENT,
+ ParagraphIndentSeparation,
///
- PARSEP_SKIP
+ ParagraphSkipSeparation
};
///
BufferParams();
- ~BufferParams();
/// get l10n translated to the buffers language
- docstring const B_(std::string const & l10n) const;
+ docstring B_(std::string const & l10n) const;
/// read a header token, if unrecognised, return it or an unknown class name
- std::string const readToken(Lexer & lex, std::string const & token);
+ std::string readToken(Lexer & lex,
+ std::string const & token, ///< token to read.
+ support::FileName const & filepath);
///
void writeFile(std::ostream &) const;
+ /// check what features are implied by the buffer parameters.
+ void validate(LaTeXFeatures &) const;
+
/** \returns true if the babel package is used (interogates
- * the BufferParams and a LyXRC variable).
+ * the BufferParams, a LyXRC variable, and the document class).
* This returned value can then be passed to the insets...
*/
- bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
+ bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &,
+ support::FileName const &) const;
///
void useClassDefaults();
-
///
bool hasClassDefaults() const;
+ ///
+ HSpace const & getIndentation() const;
+ ///
+ void setIndentation(HSpace const & indent);
///
VSpace const & getDefSkip() const;
-
///
void setDefSkip(VSpace const & vs);
/** Whether paragraphs are separated by using a indent like in
* articles or by using a little skip like in letters.
*/
- PARSEP paragraph_separation;
+ ParagraphSeparation paragraph_separation;
///
- InsetQuotes::quote_language quotes_language;
+ InsetQuotes::QuoteLanguage quotes_language;
///
- InsetQuotes::quote_times quotes_times;
+ InsetQuotes::QuoteTimes quotes_times;
///
std::string fontsize;
- ///Get the LyX TextClass (that is, the layout file) this document is using.
- textclass_type getBaseClass() const;
- ///Set the LyX TextClass (that is, the layout file) this document is using.
- ///NOTE This also calls makeTextClass(), to update the local
- ///TextClass.
- bool setBaseClass(textclass_type);
- ///Returns the TextClass currently in use: the BaseClass as modified
- ///by modules.
- TextClass const & getTextClass() const;
- ///Returns a pointer to the TextClass currently in use: the BaseClass
- ///as modified by modules. (See \file TextClass_ptr.h for the typedef.)
- TextClass_ptr getTextClass_ptr() const;
- ///Set the LyX TextClass---layout file---this document is using.
- ///This does NOT call makeTextClass() and so should be used with
- ///care. This is most likely not what you want if you are operating on
- ///BufferParams that are actually associatd with a Buffer. If, on the
- ///other hand, you are using a temporary set of BufferParams---say, in
- ///a controller, it may well be, since in that case the local TextClass
- ///has nothing to do.
- void setJustBaseClass(textclass_type);
+ /// Get the LayoutFile this document is using.
+ LayoutFile const * baseClass() const;
+ ///
+ LayoutFileIndex const & baseClassID() const;
+ /// Set the LyX layout file this document is using.
+ /// NOTE: This does not call makeDocumentClass() to update the local
+ /// DocumentClass. That needs to be done manually.
+ /// \param filename the name of the layout file
+ bool setBaseClass(std::string const & classname);
+ /// Adds the module information to the baseClass information to
+ /// create our local DocumentClass.
+ void makeDocumentClass();
+ /// Returns the DocumentClass currently in use: the BaseClass as modified
+ /// by modules.
+ DocumentClass const & documentClass() const;
+ /// \return A pointer to the DocumentClass currently in use: the BaseClass
+ /// as modified by modules.
+ DocumentClass const * documentClassPtr() const;
/// This bypasses the baseClass and sets the textClass directly.
/// Should be called with care and would be better not being here,
/// but it seems to be needed by CutAndPaste::putClipboard().
- void setTextClass(TextClass_ptr);
+ void setDocumentClass(DocumentClass const * const);
/// List of modules in use
- std::vector<std::string> const & getModules() const;
- /// Add a module to the list of modules in use.
- /// Returns true if module was successfully added.
- bool addLayoutModule(std::string modName, bool makeClass = true);
- /// Add a list of modules.
- /// Returns true if all modules were successfully added.
- bool addLayoutModules(std::vector<std::string>modNames);
+ LayoutModuleList const & getModules() const { return layoutModules_; }
+ /// List of default modules the user has removed
+ std::list<std::string> const & getRemovedModules() const
+ { return removedModules_; }
+ ///
+ /// Add a module to the list of modules in use. This checks only that the
+ /// module is not already in the list, so use moduleIsCompatible first if
+ /// you want to check for compatibility.
+ /// \return true if module was successfully added.
+ bool addLayoutModule(std::string const & modName);
+ /// checks to make sure module's requriements are satisfied, that it does
+ /// not conflict with already-present modules, isn't already loaded, etc.
+ bool moduleCanBeAdded(std::string const & modName) const;
+ ///
+ void addRemovedModule(std::string const & modName)
+ { removedModules_.push_back(modName); }
/// Clear the list
- void clearLayoutModules();
+ void clearLayoutModules() { layoutModules_.clear(); }
+ /// Clear the removed module list
+ void clearRemovedModules() { removedModules_.clear(); }
+
+ /// List of included children (for includeonly)
+ std::list<std::string> const & getIncludedChildren() const
+ { return includedChildren_; }
+ ///
+ void addIncludedChildren(std::string const & child)
+ { includedChildren_.push_back(child); }
+ /// Clear the list of included children
+ void clearIncludedChildren() { includedChildren_.clear(); }
+
+ /// update aux files of unincluded children (with \includeonly)
+ bool maintain_unincluded_children;
/// returns the main font for the buffer (document)
Font const getFont() const;
- /* this are for the PaperLayout */
+ /* these are for the PaperLayout */
/// the papersize
PAPER_SIZE papersize;
///
std::string headsep;
///
std::string footskip;
+ ///
+ std::string columnsep;
/* some LaTeX options */
/// The graphics driver
std::string graphicsDriver;
+ /// The default output format
+ std::string defaultOutputFormat;
+ /// customized bibliography processor
+ std::string bibtex_command;
+ /// customized index processor
+ std::string index_command;
+ /// font encoding
+ std::string fontenc;
/// the rm font
std::string fontsRoman;
/// the sf font
std::string fontsTypewriter;
/// the default family (rm, sf, tt)
std::string fontsDefaultFamily;
+ /// use the XeTeX processor
+ bool useXetex;
/// use expert Small Caps
bool fontsSC;
/// use Old Style Figures
int fontsSansScale;
/// the scale factor of the tt font
int fontsTypewriterScale;
+ /// the font used by the CJK command
+ std::string fontsCJK;
///
Spacing & spacing();
Spacing const & spacing() const;
/// BranchList:
BranchList & branchlist();
BranchList const & branchlist() const;
+ /// IndicesList:
+ IndicesList & indiceslist();
+ IndicesList const & indiceslist() const;
/**
* The input encoding for LaTeX. This can be one of
* - \c auto: find out the input encoding from the used languages
///
std::string preamble;
///
+ std::string local_layout;
+ ///
std::string options;
+ /// use the class options defined in the layout?
+ bool use_default_options;
+ ///
+ std::string master;
+ ///
+ bool suppress_date;
///
std::string float_placement;
///
/// parameters for the listings package
std::string listings_params;
///
- TextClass::PageSides sides;
+ PageSides sides;
///
std::string pagestyle;
+ ///
+ RGBColor backgroundcolor;
+ ///
+ bool isbackgroundcolor;
+ ///
+ RGBColor fontcolor;
+ ///
+ bool isfontcolor;
+ ///
+ RGBColor notefontcolor;
+ ///
+ RGBColor boxbgcolor;
/// \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;
Package use_amsmath;
/// Whether and how to load esint
Package use_esint;
- ///
+ /// Whether and how to load mhchem
+ Package use_mhchem;
+ /// Whether and how to load mathdots
+ Package use_mathdots;
+ /// Split bibliography?
bool use_bibtopic;
+ /// Split the index?
+ bool use_indices;
/// revision tracking for this buffer ?
bool trackChanges;
/** This param decides whether change tracking marks should be used
* for instance, they may differ for DVI and PDF generation)
*/
bool outputChanges;
- /// Time ago we agreed that this was a buffer property [ale990407]
- std::string parentname;
///
bool compressed;
- ///
- bool embedded;
/// 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<unsigned int> author_map;
+ /// map of the file's author IDs to AuthorList indexes
+ std::map<unsigned int, int> author_map;
+ /// the buffer's font encoding
+ std::string const font_encoding() const;
///
std::string const dvips_options() const;
+ /** The return value of paperSizeName() depends on the
+ * purpose for which the paper size is needed, since they
+ * support different subsets of paper sizes.
+ */
+ enum PapersizePurpose {
+ ///
+ DVIPS,
+ ///
+ DVIPDFM,
+ ///
+ XDVI
+ };
///
- std::string const paperSizeName() const;
+ std::string paperSizeName(PapersizePurpose purpose) const;
/// set up if and how babel is called
- std::string const babelCall(std::string const & lang_opts) const;
+ std::string babelCall(std::string const & lang_opts) const;
+ /// return supported drivers for specific packages
+ docstring getGraphicsDriver(std::string const & package) const;
/// handle inputenc etc.
void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
TexRow & texrow) const;
+ ///
+ std::string const parseFontName(std::string const & name) 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;
- /// get the appropriate cite engine (natbib handling)
- biblio::CiteEngine getEngine() const;
+ int const & sfscale, int const & ttscale,
+ bool const & xetex) const;
+ /// get the appropriate cite engine (natbib handling)
+ CiteEngine citeEngine() const;
///
- void setCiteEngine(biblio::CiteEngine const);
+ void setCiteEngine(CiteEngine const);
+
+ /// options for pdf output
+ PDFOptions & pdfoptions();
+ PDFOptions const & pdfoptions() const;
+
+ enum MathOutput {
+ MathML,
+ HTML,
+ Images,
+ LaTeX
+ };
+ /// what to use for math output. present choices are above
+ MathOutput html_math_output;
+ /// whether to attempt to be XHTML 1.1 compliant or instead be
+ /// a little more mellow
+ bool html_be_strict;
+ ///
+ double html_math_img_scale;
+ ///
+ std::string html_latex_start;
+ ///
+ std::string html_latex_end;
+ /// generate output usable for reverse/forward search
+ bool output_sync;
+ /// custom LaTeX macro from user instead our own
+ std::string output_sync_macro;
+ /// use refstyle? or prettyref?
+ bool use_refstyle;
private:
///
void readPreamble(Lexer &);
///
+ void readLocalLayout(Lexer &);
+ ///
void readLanguage(Lexer &);
///
void readGraphicsDriver(Lexer &);
void readBulletsLaTeX(Lexer &);
///
void readModules(Lexer &);
- /// Adds the module information to the baseClass information to
- /// create our local TextClass.
- void makeTextClass();
-
-
+ ///
+ void readRemovedModules(Lexer &);
+ ///
+ void readIncludeonly(Lexer &);
/// for use with natbib
- biblio::CiteEngine cite_engine_;
- /// the base TextClass associated with the document
- textclass_type baseClass_;
- /// the possibly modular TextClass actually in use
- TextClass_ptr textClass_;
+ CiteEngine cite_engine_;
///
- typedef std::vector<std::string> LayoutModuleList;
+ DocumentClass * doc_class_;
///
LayoutModuleList layoutModules_;
+ /// this is for modules that are required by the document class but that
+ /// the user has chosen not to use
+ std::list<std::string> removedModules_;
+
+ /// the list of included children (for includeonly)
+ std::list<std::string> includedChildren_;
/** Use the Pimpl idiom to hide those member variables that would otherwise
* drag in other header files.