X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FBufferParams.h;h=890d8843a7e2ae68a56c0aef76766ecadd14892a;hb=124e0fc2be2446f7182cba0e5b54961dc1cfab91;hp=8f402f870db186a776aa765ba158b9d65e1cfdd1;hpb=1933102593ec7bfa24727b53df3200a2901d2354;p=lyx.git diff --git a/src/BufferParams.h b/src/BufferParams.h index 8f402f870d..890d8843a7 100644 --- a/src/BufferParams.h +++ b/src/BufferParams.h @@ -15,17 +15,16 @@ #ifndef BUFFERPARAMS_H #define BUFFERPARAMS_H -#include "Author.h" #include "Citation.h" +#include "ColorCode.h" +#include "ColorSet.h" #include "DocumentClassPtr.h" -#include "Format.h" #include "LayoutModuleList.h" -#include "OutputParams.h" #include "paper.h" - -#include "insets/InsetQuotes.h" +#include "WordLangTuple.h" #include "support/copied_ptr.h" +#include "support/types.h" #include #include @@ -34,21 +33,30 @@ namespace lyx { namespace support { class FileName; } +class Author; +class AuthorList; class BranchList; class Bullet; +class Buffer; class DocumentClass; class Encoding; class Font; +class Format; class IndicesList; class Language; +class LaTeXFeatures; class LayoutFile; class LayoutFileIndex; class Length; class Lexer; +class otexstream; class PDFOptions; class Spacing; class VSpace; +enum class Flavor : int; +enum class QuoteStyle : int; + /** Buffer parameters. * This class contains all the parameters for this buffer's use. Some * work needs to be done on this class to make it nice. Now everything @@ -72,7 +80,7 @@ public: /// read a header token, if unrecognised, return it or an unknown class name std::string readToken(Lexer & lex, std::string const & token, ///< token to read. - support::FileName const & filepath); + support::FileName const & filename); /// void writeFile(std::ostream &, Buffer const *) const; @@ -123,7 +131,7 @@ public: */ ParagraphSeparation paragraph_separation; /// - InsetQuotesParams::QuoteStyle quotes_style; + QuoteStyle quotes_style; /// bool dynamic_quotes; /// @@ -145,7 +153,7 @@ public: /// 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); + void makeDocumentClass(bool clone = false, bool internal = false); /// Returns the DocumentClass currently in use: the BaseClass as modified /// by modules. DocumentClass const & documentClass() const; @@ -184,8 +192,6 @@ public: /// 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; @@ -194,8 +200,7 @@ public: /// 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; + Flavor getOutputFlavor(std::string const & format = std::string()) const; /// bool isExportable(std::string const & format, bool need_viewable) const; /// @@ -214,13 +219,18 @@ public: void clearIncludedChildren() { included_children_.clear(); } /// update aux files of unincluded children (with \includeonly) - bool maintain_unincluded_children; + enum ChildrenMaintenance { + CM_None, + CM_Mostly, + CM_Strict + }; + ChildrenMaintenance maintain_unincluded_children; /// 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; + QuoteStyle getQuoteStyle(std::string const & qs) const; /* these are for the PaperLayout */ /// the papersize @@ -283,16 +293,26 @@ public: 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 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 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 @@ -316,6 +336,10 @@ public: /// IndicesList: IndicesList & indiceslist(); IndicesList const & indiceslist() const; + /// + WordLangTable & spellignore(); + WordLangTable const & spellignore() const; + bool spellignored(WordLangTuple const & wl) const; /** * 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 @@ -343,6 +367,8 @@ public: std::string origin; /// docstring preamble; + /// DocumentMetadata as introduced by LaTeX 2022/06 + docstring document_metadata; /// std::string options; /// use the class options defined in the layout? @@ -366,6 +392,8 @@ public: /// std::string pagestyle; /// + std::string tablestyle; + /// RGBColor backgroundcolor; /// bool isbackgroundcolor; @@ -376,7 +404,11 @@ public: /// RGBColor notefontcolor; /// + bool isnotefontcolor; + /// RGBColor boxbgcolor; + /// + bool isboxbgcolor; /// \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; @@ -422,12 +454,16 @@ public: */ 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); + void addAuthor(Author const & a); /// map of the file's author IDs to AuthorList indexes typedef std::map AuthorMap; @@ -454,7 +490,8 @@ public: 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 @@ -483,7 +520,7 @@ public: std::vector citeStyles() const; /// Return the actual bibtex command (lyxrc or buffer param) - std::string const bibtexCommand() const; + std::string const bibtexCommand(bool const warn = false) const; /// Are we using biblatex? bool useBiblatex() const; @@ -493,7 +530,7 @@ public: /// 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; + bool fullAuthorList() const; /// Check if a citation style is an alias to another style std::string getCiteAlias(std::string const & s) const; @@ -507,6 +544,10 @@ public: 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(); @@ -534,6 +575,24 @@ public: std::string html_latex_end; /// bool html_css_as_file; + + // do not change these values. we rely upon them. + enum TableOutput { + HTMLTable = 0, + CALSTable = 1 + }; + /// what format to use for table output in DocBook. present choices are above + TableOutput docbook_table_output; + + // do not change these values. we rely upon them. + enum MathMLNameSpacePrefix { + NoPrefix = 0, + MPrefix = 1, + MMLPrefix = 2 + }; + /// what prefix to use when outputting MathML. present choices are above + MathMLNameSpacePrefix docbook_mathml_prefix; + /// allow the LaTeX backend to run external programs bool shell_escape; /// generate output usable for reverse/forward search @@ -544,6 +603,10 @@ public: 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 @@ -559,6 +622,8 @@ private: /// void readPreamble(Lexer &); /// + void readDocumentMetadata(Lexer &); + /// void readLocalLayout(Lexer &, bool); /// void readLanguage(Lexer &); @@ -575,7 +640,7 @@ private: /// void readIncludeonly(Lexer &); /// A cache for the default flavors - typedef std::map DefaultFlavorCache; + typedef std::map DefaultFlavorCache; /// mutable DefaultFlavorCache default_flavors_; /// the cite engine @@ -584,13 +649,15 @@ private: CiteEngineType cite_engine_type_; /// the default BibTeX style file for the document std::string biblio_style; - /// The encoding of the bib files, for Biblatex - /// (only one supported currently) - // FIXME: biblatex 3.12 introduces per-file - // encoding options. Update once that's spread. + /// 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; + /// Return the actual or an appropriate fallback bibtex command + std::string const getBibtexCommand(std::string const cmd, + bool const warn) const; /// DocumentClassPtr doc_class_; ///