#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
+#include "Author.h"
#include "Citation.h"
+#include "DocumentClassPtr.h"
#include "Format.h"
#include "LayoutModuleList.h"
#include "OutputParams.h"
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 LayoutFileIndex;
+class Length;
class Lexer;
class PDFOptions;
class Spacing;
-class TexRow;
class VSpace;
/** Buffer parameters.
support::FileName const & filepath);
///
- void writeFile(std::ostream &) const;
+ void writeFile(std::ostream &, Buffer const *) const;
/// check what features are implied by the buffer parameters.
void validate(LaTeXFeatures &) const;
- /** \returns true if the babel package is used (interogates
+ /** \returns true if the babel package is used (interrogates
* the BufferParams, a LyXRC variable, and the document class).
* This returned value can then be passed to the insets...
*/
bool hasClassDefaults() const;
///
- HSpace const & getIndentation() const;
+ Length const & getParIndent() const;
///
- void setIndentation(HSpace const & indent);
+ void setParIndent(Length const & indent);
///
VSpace const & getDefSkip() const;
///
void setDefSkip(VSpace const & vs);
+ ///
+ Length const & getMathIndent() const;
+ ///
+ void setMathIndent(Length const & indent);
+
+ /// Whether formulas are indented
+ bool is_math_indent;
+
+
+ enum MathNumber { DEFAULT, LEFT, RIGHT };
+ /// number formulas on left/right/default
+ MathNumber math_numbering_side;
+
+ /// Convenience function for display: like math_number, but
+ /// DEFAULT is replaced by the best guess we have.
+ MathNumber getMathNumber() const;
+
/** Whether paragraphs are separated by using a indent like in
* articles or by using a little skip like in letters.
*/
ParagraphSeparation paragraph_separation;
///
- InsetQuotes::QuoteLanguage quotes_language;
+ InsetQuotesParams::QuoteStyle quotes_style;
///
- InsetQuotes::QuoteTimes quotes_times;
+ bool dynamic_quotes;
///
std::string fontsize;
/// Get the LayoutFile this document is using.
/// 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);
+ /// \param classname: the name of the layout file
+ /// \param path: non-empty only for local layout files
+ bool setBaseClass(std::string const & classname,
+ std::string const & path = std::string());
/// Adds the module information to the baseClass information to
/// create our local DocumentClass.
- void makeDocumentClass();
+ /// NOTE: This should NEVER be called externally unless one immediately goes
+ /// on to class BufferView::updateDocumentClass(). The exception, of course,
+ /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
+ /// the parameters from the active Buffer.
+ void makeDocumentClass(bool const clone = false);
/// 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;
+ DocumentClassConstPtr 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);
+ void setDocumentClass(DocumentClassConstPtr);
/// List of modules in use
LayoutModuleList const & getModules() const { return layout_modules_; }
/// List of default modules the user has removed
{ 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.
+ /// module is not already in the list, so use layoutModuleCanBeAdeed 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;
+ bool layoutModuleCanBeAdded(std::string const & modName) const;
///
void addRemovedModule(std::string const & modName)
{ removed_modules_.push_back(modName); }
void clearLayoutModules() { layout_modules_.clear(); }
/// Clear the removed module list
void clearRemovedModules() { removed_modules_.clear(); }
+ /// Get the local layouts
+ docstring getLocalLayout(bool forced) const;
+ /// Set the local layouts
+ void setLocalLayout(docstring const & layout, bool forced);
/// returns \c true if the buffer contains a LaTeX document
bool isLatex() const;
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::string const & format = std::string()) const;
///
- std::vector<Format const *> exportableFormats(bool only_viewable) const;
- ///
- bool isExportableFormat(std::string const & format) const;
+ bool isExportable(std::string const & format, bool need_viewable) const;
///
+ std::vector<const Format *> const & exportableFormats(bool only_viewable) const;
+ /// the backends appropriate for use with this document.
+ /// so, e.g., latex is excluded , if we're using non-TeX fonts
std::vector<std::string> backends() const;
/// List of included children (for includeonly)
/// returns the main font for the buffer (document)
Font const getFont() const;
+ /// translate quote style string to enum value
+ InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
+
/* these are for the PaperLayout */
/// the papersize
PAPER_SIZE papersize;
std::string bibtex_command;
/// customized index processor
std::string index_command;
- /// font encoding
+ /// font encoding(s) requested for this document
std::string fontenc;
+ /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_roman[2];
/// the rm font
- std::string fonts_roman;
+ std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
+ /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_sans[2];
/// the sf font
- std::string fonts_sans;
+ std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
+ /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_typewriter[2];
/// the tt font
- std::string fonts_typewriter;
+ std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
+ /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
+ std::string fonts_math[2];
+ /// the math font
+ std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
/// the default family (rm, sf, tt)
std::string fonts_default_family;
/// use the fonts of the OS (OpenType, True Type) directly
bool useNonTeXFonts;
/// use expert Small Caps
bool fonts_expert_sc;
- /// use Old Style Figures
- bool fonts_old_figures;
+ /// use Old Style Figures (rm)
+ bool fonts_roman_osf;
+ /// use Old Style Figures (sf)
+ bool fonts_sans_osf;
+ /// use Old Style Figures (tt)
+ bool fonts_typewriter_osf;
+ /// the options for the roman font
+ std::string font_roman_opts;
+ /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
+ int fonts_sans_scale[2];
/// the scale factor of the sf font
- int fonts_sans_scale;
+ int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
+ // the options for the sans font
+ std::string font_sans_opts;
+ /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
+ int fonts_typewriter_scale[2];
/// the scale factor of the tt font
- int fonts_typewriter_scale;
+ int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
+ // the options for the typewriter font
+ std::string font_typewriter_opts;
/// the font used by the CJK command
std::string fonts_cjk;
+ /// use LaTeX microtype package
+ bool use_microtype;
+ /// use font ligatures for en- and em-dashes
+ bool use_dash_ligatures;
///
Spacing & spacing();
Spacing const & spacing() const;
IndicesList & indiceslist();
IndicesList const & indiceslist() const;
/**
- * The input encoding for LaTeX. This can be one of
+ * The LyX name of the input encoding for LaTeX. This can be one of
* - \c auto: find out the input encoding from the used languages
* - \c default: ditto
- * - any encoding supported by the inputenc package
+ * - any encoding defined in the file lib/encodings
* The encoding of the LyX file is always utf8 and has nothing to
* do with this setting.
* The difference between \c auto and \c default is that \c auto also
- * causes loading of the inputenc package, while \c default does not.
+ * causes loading of the inputenc package and writes a \inputenc{} command
+ * to the file when switching to another encoding, while \c default does not.
* \c default will not work unless the user takes additional measures
* (such as using special environments like the CJK environment from
* CJK.sty).
- * \c default can be seen as an unspecified 8bit encoding, since LyX
+ * \c default can be seen as an unspecified mix of 8bit encodings, since LyX
* does not interpret it in any way apart from display on screen.
*/
std::string inputenc;
/// The main encoding used by this buffer for LaTeX output.
- /// Individual pieces of text can use different encodings.
+ /// If the main encoding is \c auto or \c default,
+ /// individual pieces of text can use different encodings.
+ /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
+ /// instead of the value returned by this function (cf. #10600).
Encoding const & encoding() const;
///
- std::string preamble;
+ std::string origin;
///
- std::string local_layout;
+ docstring preamble;
///
std::string options;
/// use the class options defined in the layout?
///
std::string float_placement;
///
+ std::string float_alignment;
+ ///
unsigned int columns;
///
bool justification;
///
std::string pagestyle;
///
+ std::string tablestyle;
+ ///
RGBColor backgroundcolor;
///
bool isbackgroundcolor;
/// Set whether to load a package such as amsmath or esint.
void use_package(std::string const & p, Package u);
/// All packages that can be switched on or off
- static std::vector<std::string> const & auto_packages();
+ static std::map<std::string, std::string> const & auto_packages();
+ /// Do we use the bibtopic package?
+ bool useBibtopic() const;
/// Split bibliography?
- bool use_bibtopic;
+ bool splitbib() const { return use_bibtopic; }
+ /// Set split bibliography
+ void splitbib(bool const b) { use_bibtopic = b; }
+ /// Do we have multiple bibliographies (by chapter etc.)?
+ std::string multibib;
/// Split the index?
bool use_indices;
- /// revision tracking for this buffer ?
- bool trackChanges;
+ /// Save transient properties?
+ bool save_transient_properties;
+ /// revision tracking for this buffer ? (this is a transient property)
+ bool track_changes;
/** This param decides whether change tracking marks should be used
* in output (irrespective of how these marks are actually defined;
* for instance, they may differ for DVI and PDF generation)
+ * This is a transient property.
*/
- bool outputChanges;
+ bool output_changes;
+ ///
+ bool change_bars;
///
bool compressed;
+ ///
+ bool postpone_fragile_content;
/// the author list for the document
AuthorList & authors();
AuthorList const & authors() const;
+ void addAuthor(Author a);
/// 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;
+ AuthorMap author_map_;
+
+ /// the buffer's active font encoding
+ std::string const main_font_encoding() const;
+ /// all font encodings requested by the prefs/document/main language.
+ /// This does NOT include font encodings required by secondary languages
+ std::vector<std::string> const font_encodings() const;
+
///
std::string const dvips_options() const;
/** The return value of paperSizeName() depends on the
XDVI
};
///
- std::string paperSizeName(PapersizePurpose purpose) const;
+ std::string paperSizeName(PapersizePurpose purpose,
+ std::string const & psize = std::string()) const;
/// set up if and how babel is called
std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
/// return supported drivers for specific packages
///
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,
- bool const & use_nonlatexfonts,
- LaTeXFeatures & features) const;
+ std::string const loadFonts(LaTeXFeatures & features) const;
/// the cite engine modules
- LayoutModuleList const & citeEngine() const
- { return cite_engine_; }
+ std::string const & citeEngine() const { return cite_engine_; }
/// the type of cite engine (authoryear or numerical)
CiteEngineType const & citeEngineType() const
{ return cite_engine_type_; }
/// add the module to the cite engine modules
- bool addCiteEngine(std::string const &);
- /// add the modules to the cite engine modules
- bool addCiteEngine(std::vector<std::string> const &);
- /// clear the list of cite engine modules
- void clearCiteEngine() { cite_engine_.clear(); }
- /// set the cite engine module
- void setCiteEngine(std::string const &);
- /// set the cite engine modules
- void setCiteEngine(std::vector<std::string> const &);
+ void setCiteEngine(std::string const & eng) { cite_engine_ = eng; }
/// set the cite engine type
void setCiteEngineType(CiteEngineType const & engine_type)
{ cite_engine_type_ = engine_type; }
/// the available citation styles
std::vector<CitationStyle> citeStyles() const;
- /// the default BibTeX style file for the document
- std::string biblio_style;
- /// the default BibTeX style file from the TextClass
+ /// Return the actual bibtex command (lyxrc or buffer param)
+ std::string const bibtexCommand() const;
+
+ /// Are we using biblatex?
+ bool useBiblatex() const;
+
+ /// Set the default BibTeX style file for the document
+ void setDefaultBiblioStyle(std::string const & s){ biblio_style = s; }
+ /// Get the default BibTeX style file from the TextClass
std::string const & defaultBiblioStyle() const;
/// whether the BibTeX style supports full author lists
bool const & fullAuthorList() const;
+ /// Check if a citation style is an alias to another style
+ std::string getCiteAlias(std::string const & s) const;
+
+ /// Options of the bibiography package
+ std::string biblio_opts;
+ /// The biblatex bibliography style
+ std::string biblatex_bibstyle;
+ /// The biblatex citation style
+ std::string biblatex_citestyle;
+ /// Set the bib file encoding (for biblatex)
+ void setBibEncoding(std::string const & s) { bib_encoding = s; }
+ /// Get the bib file encoding (for biblatex)
+ std::string const & bibEncoding() const { return bib_encoding; }
+ /// Set encoding for individual bib file (for biblatex)
+ void setBibFileEncoding(std::string const & file, std::string const & enc);
+ ///
+ std::string const bibFileEncoding(std::string const & file) const;
/// options for pdf output
PDFOptions & pdfoptions();
///
double html_math_img_scale;
///
+ double display_pixel_ratio;
+ ///
std::string html_latex_start;
///
std::string html_latex_end;
///
bool html_css_as_file;
+ /// allow the LaTeX backend to run external programs
+ bool shell_escape;
/// 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;
+ /// use minted? or listings?
+ bool use_minted;
+ //output line numbering
+ bool use_lineno;
+ //optional params for lineno package
+ std::string lineno_opts;
/// Return true if language could be set to lang,
/// otherwise return false and do not change language
bool setLanguage(std::string const & lang);
+ ///
+ void invalidateConverterCache() const;
+ /// Copies over some of the settings from \param bp,
+ /// namely the ones need by Advanced F&R. We don't want
+ /// to copy them all, e.g., not the default master.
+ void copyForAdvFR(BufferParams const & bp);
private:
///
void readPreamble(Lexer &);
///
- void readLocalLayout(Lexer &);
+ void readLocalLayout(Lexer &, bool);
///
void readLanguage(Lexer &);
///
typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
///
mutable DefaultFlavorCache default_flavors_;
- /// the cite engine modules
- LayoutModuleList cite_engine_;
+ /// the cite engine
+ std::string cite_engine_;
/// the type of cite engine (authoryear or numerical)
CiteEngineType cite_engine_type_;
+ /// the default BibTeX style file for the document
+ std::string biblio_style;
+ /// The main encoding of the bib files, for Biblatex
+ std::string bib_encoding;
+ /// Individual file encodings, for Biblatex
+ std::map<std::string, std::string> bib_encodings;
+ /// Split bibliography?
+ bool use_bibtopic;
///
- DocumentClass * doc_class_;
+ DocumentClassPtr doc_class_;
///
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 local layouts without the forced ones
+ docstring local_layout_;
+ /// Forced local layouts only for reading (use getLocalLayout() instead)
+ docstring forced_local_layout_;
/// the list of included children (for includeonly)
std::list<std::string> included_children_;
typedef std::map<std::string, Package> PackageMap;
/** Whether and how to load packages like amsmath, esint, mhchem,
- * mathdots and undertilde.
+ * mathdots, stackrel, stmaryrd and undertilde.
*/
PackageMap use_packages;
static void destroy(Impl *);
};
support::copied_ptr<Impl, MemoryTraits> pimpl_;
-
};
} // namespace lyx
projects / lyx.git / blobdiff