#ifndef BUFFERPARAMS_H
#define BUFFERPARAMS_H
+#include "Author.h"
#include "Citation.h"
#include "DocumentClassPtr.h"
#include "Format.h"
namespace support { class FileName; }
-class AuthorList;
class BranchList;
class Bullet;
class DocumentClass;
class HSpace;
class IndicesList;
class Language;
-class LatexFeatures;
class LayoutFile;
class LayoutFileIndex;
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...
*/
///
InsetQuotes::QuoteLanguage quotes_language;
///
- InsetQuotes::QuoteTimes quotes_times;
- ///
std::string fontsize;
/// Get the LayoutFile this document is using.
LayoutFile const * baseClass() 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
+ /// \param classname: 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.
/// 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();
+ 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.
- DocumentClassConstPtr 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().
{ 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;
+ /// same, but for citaton modules.
+ bool citationModuleCanBeAdded(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
+ std::string getLocalLayout(bool) const;
+ /// Set the local layouts
+ void setLocalLayout(std::string const &, bool);
/// 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;
+ std::string const & format = std::string()) const;
///
bool isExportable(std::string const & format) const;
///
/// returns the main font for the buffer (document)
Font const getFont() const;
+ /// translate quote style string to enum value
+ InsetQuotes::QuoteLanguage 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 fonts_expert_sc;
/// use Old Style Figures
bool fonts_old_figures;
+ /// 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 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 font used by the CJK command
std::string fonts_cjk;
+ /// use LaTeX microtype package
+ bool use_microtype;
///
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
std::string inputenc;
/// The main encoding used by this buffer for LaTeX output.
/// 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.
Encoding const & encoding() const;
///
- std::string preamble;
+ std::string origin;
///
- std::string local_layout;
+ std::string preamble;
///
std::string options;
/// use the class options defined in the layout?
/// 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();
/// Split bibliography?
bool use_bibtopic;
/// 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 compressed;
/// 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
+ AuthorMap author_map_;
+
+ /// the buffer's active font encoding
std::string const 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
///
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
///
double html_math_img_scale;
///
+ double display_pixel_ratio;
+ ///
std::string html_latex_start;
///
std::string html_latex_end;
///
void readPreamble(Lexer &);
///
- void readLocalLayout(Lexer &);
+ void readLocalLayout(Lexer &, bool);
///
void readLanguage(Lexer &);
///
/// 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
+ std::string local_layout_;
+ /// Forced local layouts only for reading (use getLocalLayout() instead)
+ std::string 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;
projects / lyx.git / blobdiff