X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=bc5c10d194a9c70d9af0b7ed1b8beca8817a7230;hb=c8230ab0d0a919530c43c29395f4d9961498bf15;hp=2ff8ece309f26eaedc236fff3316928413fae2ad;hpb=9448e89879ebe52f077fa001b4cb768e31525ba1;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 2ff8ece309..bc5c10d194 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,6 +15,7 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H +#include "Author.h" #include "Citation.h" #include "DocumentClassPtr.h" #include "Format.h" @@ -33,22 +34,19 @@ namespace lyx { 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. @@ -77,12 +75,12 @@ public: 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... */ @@ -95,20 +93,39 @@ public: 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; + /// + bool dynamic_quotes; /// std::string fontsize; /// Get the LayoutFile this document is using. @@ -144,7 +161,7 @@ public: { 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 layoutModuleCanBeAdeed first + /// 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); @@ -161,9 +178,9 @@ public: /// Clear the removed module list void clearRemovedModules() { removed_modules_.clear(); } /// Get the local layouts - std::string getLocalLayout(bool) const; + docstring getLocalLayout(bool forced) const; /// Set the local layouts - void setLocalLayout(std::string const &, bool); + void setLocalLayout(docstring const & layout, bool forced); /// returns \c true if the buffer contains a LaTeX document bool isLatex() const; @@ -180,11 +197,9 @@ public: OutputParams::FLAVOR getOutputFlavor( std::string const & format = std::string()) const; /// - bool isExportable(std::string const & format) const; - /// - std::vector exportableFormats(bool only_viewable) const; + bool isExportable(std::string const & format, bool need_viewable) const; /// - bool isExportableFormat(std::string const & format) const; + std::vector 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 backends() const; @@ -205,7 +220,7 @@ public: Font const getFont() const; /// translate quote style string to enum value - InsetQuotes::QuoteLanguage getQuoteStyle(std::string const & qs) const; + InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const; /* these are for the PaperLayout */ /// the papersize @@ -244,16 +259,24 @@ public: 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 fonts_math; + 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 @@ -262,12 +285,20 @@ public: 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; + /// use font ligatures for en- and em-dashes + bool use_dash_ligatures; /// Spacing & spacing(); Spacing const & spacing() const; @@ -303,9 +334,13 @@ public: 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; + /// + docstring preamble; /// std::string options; /// use the class options defined in the layout? @@ -362,15 +397,24 @@ public: void use_package(std::string const & p, Package u); /// All packages that can be switched on or off static std::map 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 ? + /// 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 output_changes; /// @@ -379,12 +423,18 @@ public: /// 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 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 const font_encodings() const; + /// std::string const dvips_options() const; /** The return value of paperSizeName() depends on the @@ -437,12 +487,27 @@ public: /// the available citation styles std::vector 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; /// options for pdf output PDFOptions & pdfoptions(); @@ -470,16 +535,22 @@ public: 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; /// 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; private: /// @@ -508,6 +579,10 @@ private: LayoutModuleList 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; + /// Split bibliography? + bool use_bibtopic; /// DocumentClassPtr doc_class_; /// @@ -516,9 +591,9 @@ private: /// the user has chosen not to use std::list removed_modules_; /// The local layouts without the forced ones - std::string local_layout_; + docstring local_layout_; /// Forced local layouts only for reading (use getLocalLayout() instead) - std::string forced_local_layout_; + docstring forced_local_layout_; /// the list of included children (for includeonly) std::list included_children_;