* 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 "Font.h"
-#include "BiblioInfo.h"
+#include "Citation.h"
+#include "Format.h"
+#include "LayoutModuleList.h"
+#include "OutputParams.h"
#include "paper.h"
#include "insets/InsetQuotes.h"
#include "support/copied_ptr.h"
+#include <map>
#include <vector>
namespace lyx {
-namespace support {
-class FileName;
-}
+namespace support { class FileName; }
class AuthorList;
class BranchList;
class Bullet;
class DocumentClass;
class Encoding;
+class Font;
+class HSpace;
+class IndicesList;
class Language;
class LatexFeatures;
class LayoutFile;
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 readToken(Lexer & lex,
std::string const & token, ///< token to read.
- support::FileName const & filepath,
- support::FileName const & temppath); ///< where to look for local layout file.
+ support::FileName const & filepath);
///
void writeFile(std::ostream &) const;
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(otexstream &, LaTeXFeatures &,
+ 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 LayoutFile this document is using.
+ /// 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
+ /// 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);
/// 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 * documentClassPtr() 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 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.
- /// The makeClass variable signals whether to call makeDocumentClass. This
- /// need not be done if we know this isn't the final time through, or if
- /// the BufferParams do not represent the parameters for an actual buffer
- /// (as in GuiDocument).
+ LayoutModuleList const & getModules() const { return layout_modules_; }
+ /// List of default modules the user has removed
+ std::list<std::string> const & getRemovedModules() const
+ { return removed_modules_; }
+ ///
+ /// 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)
+ { removed_modules_.push_back(modName); }
/// Clear the list
- void clearLayoutModules();
+ void clearLayoutModules() { layout_modules_.clear(); }
+ /// Clear the removed module list
+ void clearRemovedModules() { removed_modules_.clear(); }
+
+ /// returns \c true if the buffer contains a LaTeX document
+ bool isLatex() const;
+ /// returns \c true if the buffer contains a DocBook document
+ bool isDocBook() const;
+ /// returns \c true if the buffer contains a Wed document
+ bool isLiterate() const;
+
+ /// return the format of the buffer on a string
+ std::string bufferFormat() const;
+ /// return the default output format of the current backend
+ std::string getDefaultOutputFormat() const;
+ /// return the output flavor of \p format or the default
+ OutputParams::FLAVOR getOutputFlavor(
+ std::string const format = std::string()) const;
+ ///
+ bool isExportable(std::string const & format) const;
+ ///
+ std::vector<Format const *> exportableFormats(bool only_viewable) const;
+ ///
+ bool isExportableFormat(std::string const & format) const;
+ ///
+ std::vector<std::string> backends() const;
+
+ /// List of included children (for includeonly)
+ std::list<std::string> const & getIncludedChildren() const
+ { return included_children_; }
+ ///
+ void addIncludedChildren(std::string const & child)
+ { included_children_.push_back(child); }
+ /// Clear the list of included children
+ void clearIncludedChildren() { included_children_.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;
///
/* some LaTeX options */
/// The graphics driver
- std::string graphicsDriver;
+ std::string graphics_driver;
+ /// The default output format
+ std::string default_output_format;
+ /// 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;
+ std::string fonts_roman;
/// the sf font
- std::string fontsSans;
+ std::string fonts_sans;
/// the tt font
- std::string fontsTypewriter;
+ std::string fonts_typewriter;
/// the default family (rm, sf, tt)
- std::string fontsDefaultFamily;
+ std::string fonts_default_family;
+ /// use the fonts of the OS (OpenType, True Type) directly
+ bool useNonTeXFonts;
/// use expert Small Caps
- bool fontsSC;
+ bool fonts_expert_sc;
/// use Old Style Figures
- bool fontsOSF;
+ bool fonts_old_figures;
/// the scale factor of the sf font
- int fontsSansScale;
+ int fonts_sans_scale;
/// the scale factor of the tt font
- int fontsTypewriterScale;
+ int fonts_typewriter_scale;
+ /// the font used by the CJK command
+ std::string fonts_cjk;
///
Spacing & spacing();
Spacing const & spacing() const;
int tocdepth;
///
Language const * language;
+ /// language package
+ std::string lang_package;
/// 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;
///
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;
+ /// Whether and how to load undertilde
+ Package use_undertilde;
+ /// 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
bool outputChanges;
///
bool compressed;
- ///
- bool embedded;
- ///
- std::vector<std::string> & extraEmbeddedFiles();
- std::vector<std::string> const & extraEmbeddedFiles() const;
/// 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
+ typedef std::map<int, int> AuthorMap;
+ AuthorMap 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 Papersize_Purpose {
+ enum PapersizePurpose {
///
DVIPS,
///
XDVI
};
///
- std::string const paperSizeName(Papersize_Purpose const & purpose) 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, bool const langoptions) 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;
+ void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) 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;
+ int const & sfscale, int const & ttscale,
+ bool const & use_nonlatexfonts,
+ LaTeXFeatures & features) const;
/// get the appropriate cite engine (natbib handling)
- biblio::CiteEngine getEngine() const;
-
+ CiteEngine citeEngine() const;
///
- void setCiteEngine(biblio::CiteEngine const);
+ void setCiteEngine(CiteEngine const);
/// options for pdf output
PDFOptions & pdfoptions();
PDFOptions const & pdfoptions() const;
+ // do not change these values. we rely upon them.
+ enum MathOutput {
+ MathML = 0,
+ HTML = 1,
+ Images = 2,
+ LaTeX = 3
+ };
+ /// 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;
+ ///
+ bool html_css_as_file;
+ /// 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;
+
+ /// Return true if language could be set to lang,
+ /// otherwise return false and do not change language
+ bool setLanguage(std::string const & lang);
+
private:
///
void readPreamble(Lexer &);
///
+ void readLocalLayout(Lexer &);
+ ///
void readLanguage(Lexer &);
///
void readGraphicsDriver(Lexer &);
void readBulletsLaTeX(Lexer &);
///
void readModules(Lexer &);
-
+ ///
+ void readRemovedModules(Lexer &);
+ ///
+ void readIncludeonly(Lexer &);
+ /// A cache for the default flavors
+ typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
+ ///
+ mutable DefaultFlavorCache default_flavors_;
/// for use with natbib
- biblio::CiteEngine cite_engine_;
+ CiteEngine cite_engine_;
///
DocumentClass * doc_class_;
///
- typedef std::vector<std::string> LayoutModuleList;
- ///
- LayoutModuleList layoutModules_;
+ LayoutModuleList layout_modules_;
+ /// this is for modules that are required by the document class but that
+ /// the user has chosen not to use
+ std::list<std::string> removed_modules_;
+
+ /// the list of included children (for includeonly)
+ std::list<std::string> included_children_;
/** Use the Pimpl idiom to hide those member variables that would otherwise
* drag in other header files.
projects / lyx.git / blobdiff