X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=1e8b5b00f17205ca99c3c2b100d508cab2892ef8;hb=29d80772fc832a914c73b4de3010b7f4c108a5e3;hp=caae01dfec15535e847429326491d15cfbc5e7df;hpb=5c2d04999619f8b8890d931e28c133212ce20fd0;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index caae01dfec..1e8b5b00f1 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -39,12 +39,11 @@ 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; @@ -94,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. @@ -118,7 +136,9 @@ public: /// NOTE: This does not call makeDocumentClass() to update the local /// DocumentClass. That needs to be done manually. /// \param classname: the name of the layout file - bool setBaseClass(std::string const & classname); + /// \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. /// NOTE: This should NEVER be called externally unless one immediately goes @@ -143,15 +163,13 @@ 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); /// checks to make sure module's requriements are satisfied, that it does /// not conflict with already-present modules, isn't already loaded, etc. 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); } @@ -160,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; @@ -179,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; @@ -204,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 @@ -279,6 +295,10 @@ public: 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; @@ -304,23 +324,25 @@ public: * 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. + /// instead of the value returned by this function (cf. #10600). Encoding const & encoding() const; /// std::string origin; /// - std::string preamble; + docstring preamble; /// std::string options; /// use the class options defined in the layout? @@ -332,6 +354,8 @@ public: /// std::string float_placement; /// + std::string float_alignment; + /// unsigned int columns; /// bool justification; @@ -342,6 +366,8 @@ public: /// std::string pagestyle; /// + std::string tablestyle; + /// RGBColor backgroundcolor; /// bool isbackgroundcolor; @@ -377,11 +403,17 @@ 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; - /// Save trensient properties? + /// Save transient properties? bool save_transient_properties; /// revision tracking for this buffer ? (this is a transient property) bool track_changes; @@ -404,7 +436,7 @@ public: AuthorMap author_map_; /// the buffer's active font encoding - std::string const font_encoding() const; + 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; @@ -437,21 +469,12 @@ public: 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 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 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; } @@ -461,12 +484,35 @@ 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; + /// 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(); @@ -494,16 +540,30 @@ 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; + //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: /// @@ -528,10 +588,18 @@ private: typedef std::map 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 bib_encodings; + /// Split bibliography? + bool use_bibtopic; /// DocumentClassPtr doc_class_; /// @@ -540,9 +608,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_; @@ -563,7 +631,6 @@ private: static void destroy(Impl *); }; support::copied_ptr pimpl_; - }; } // namespace lyx