Fix bug #12772

[lyx.git] / src / BufferParams.h

diff --git a/src/BufferParams.h b/src/BufferParams.h
index 6a5ded826013d56f8d8e089c9d7f26403c9c4280..77b4856b4d3bca7b6a435c85c467f1a510354d67 100644 (file)
--- a/src/BufferParams.h
+++ b/src/BufferParams.h
@@ -16,14 +16,15 @@
 #define BUFFERPARAMS_H
 
 #include "Citation.h"
+#include "ColorCode.h"
+#include "ColorSet.h"
 #include "DocumentClassPtr.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 <map>
 #include <vector>
@@ -36,20 +37,26 @@ 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
@@ -73,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;
@@ -124,7 +131,7 @@ public:
         */
        ParagraphSeparation paragraph_separation;
        ///
-       InsetQuotesParams::QuoteStyle quotes_style;
+       QuoteStyle quotes_style;
        ///
        bool dynamic_quotes;
        ///
@@ -146,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;
@@ -193,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;
        ///
@@ -224,7 +230,7 @@ public:
        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
@@ -330,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
@@ -357,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?
@@ -392,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;
@@ -504,7 +520,7 @@ public:
        std::vector<CitationStyle> 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;
@@ -568,6 +584,15 @@ public:
        /// 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
@@ -597,6 +622,8 @@ private:
        ///
        void readPreamble(Lexer &);
        ///
+       void readDocumentMetadata(Lexer &);
+       ///
        void readLocalLayout(Lexer &, bool);
        ///
        void readLanguage(Lexer &);
@@ -613,7 +640,7 @@ private:
        ///
        void readIncludeonly(Lexer &);
        /// A cache for the default flavors
-       typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
+       typedef std::map<std::string, Flavor> DefaultFlavorCache;
        ///
        mutable DefaultFlavorCache default_flavors_;
        /// the cite engine
@@ -628,6 +655,9 @@ private:
        std::map<std::string, std::string> 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_;
        ///
@@ -661,6 +691,10 @@ private:
        support::copied_ptr<Impl, MemoryTraits> pimpl_;
 };
 
+
+///
+BufferParams const & defaultBufferParams();
+
 } // namespace lyx
 
 #endif