]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.h
Do not error out if -geometry is used with QPA_XCB defined.
[lyx.git] / src / LaTeXFeatures.h
index dfad380279c5577a8bf0e88433a044893819f1ab..10f7c320f075e5cf0acd53dec48b32c75f829258 100644 (file)
 #ifndef LATEXFEATURES_H
 #define LATEXFEATURES_H
 
-#include "OutputParams.h"
 #include "support/docstring.h"
 
 #include <set>
 #include <list>
 #include <map>
+#include <vector>
 
 
 namespace lyx {
@@ -27,6 +27,9 @@ class Buffer;
 class BufferParams;
 class InsetLayout;
 class Language;
+class otexstream;
+class OutputParams;
+struct TexString;
 
 /** The packages and commands that a buffer needs. This class
  *  contains a list<string>.  Each of the LaTeX packages that a buffer needs
@@ -43,52 +46,76 @@ class Language;
  */
 class LaTeXFeatures {
 public:
+       /// Which Language package do we use?
+       enum LangPackage {
+               LANG_PACK_NONE,
+               LANG_PACK_BABEL,
+               LANG_PACK_POLYGLOSSIA,
+               LANG_PACK_CUSTOM
+       };
        ///
        LaTeXFeatures(Buffer const &, BufferParams const &,
                      OutputParams const &);
        /// The color packages
        std::string const getColorOptions() const;
+       /// The requested package options
+       std::string const getPackageOptions() const;
        /// The packages needed by the document
        std::string const getPackages() const;
        /// The macros definitions needed by the document
-       docstring const getMacros() const;
-       ///
-       std::string const getBabelPostsettings() const;
+       TexString getMacros() const;
+       /// Extra preamble code before babel is called
+       docstring const getBabelPresettings() const;
+       /// Extra preamble code after babel is called
+       docstring const getBabelPostsettings() const;
+       /// Load AMS packages when appropriate
+       std::string const loadAMSPackages() const;
        /// The definitions needed by the document's textclass
        docstring const getTClassPreamble() const;
        /// The language dependent definitions needed by the document's textclass
-       docstring const getTClassI18nPreamble(bool use_babel) const;
+       docstring const getTClassI18nPreamble(bool use_babel,
+                               bool use_polyglossia, bool use_minted) const;
        ///
        docstring const getTClassHTMLStyles() const;
        ///
        docstring const getTClassHTMLPreamble() const;
-       /// The sgml definitions needed by the document (docbook)
-       docstring const getLyXSGMLEntities() const;
-       /// The SGML Required to include the files added with includeFile();
-       docstring const getIncludedFiles(std::string const & fname) const;
        /// Include a file for use with the SGML entities
        void includeFile(docstring const & key, std::string const & name);
        /// The float definitions.
-       void getFloatDefinitions(odocstream & os) const;
+       void getFloatDefinitions(otexstream & os) const;
        /// Print requirements to lyxerr
        void showStruct() const;
+       /// Add preamble snippet with TexRow information
+       void addPreambleSnippet(TexString snippet, bool allowdupes = false);
+       /// Add preamble snippet without TexRow information
+       void addPreambleSnippet(docstring const & snippet, bool allowdupes = false);
        ///
-       void addPreambleSnippet(std::string const &);
+       TexString getPreambleSnippets() const;
+       /// Adds CSS information for HTML export.
+       /// Note that addPreambleSnippet is for LaTeX-type export
+       void addCSSSnippet(std::string const &);
        ///
-       std::string getPreambleSnippets() const;
+       docstring getCSSSnippets() const;
        /// Add a feature name requirements
        void require(std::string const & name);
        /// Add a set of feature names requirements
        void require(std::set<std::string> const & names);
-       /// Which of the required packages are installed?
-       static void getAvailable();
+       /// Add a feature name provision
+       void provide(std::string const & name);
        /// Is the (required) package available?
        static bool isAvailable(std::string const & name);
+       /// Is the (required) package available at least as of version
+       /// y/m/d?
+       static bool isAvailableAtLeastFrom(std::string const & name,
+                                          int const y, int const m, int const d = 1);
        /// Has the package been required?
        bool isRequired(std::string const & name) const;
-       /* Is it necessary to load the package? This is true if
-          isRequired is true and the feature is not provided by the
-          textclass.
+       /** Is this feature already provided
+        *  e.g. by the document class?
+       */
+       bool isProvided(std::string const & name) const;
+       /** Is it necessary to load the package? This is true if
+           isRequired is true and the feature is not already provided
        */
        bool mustProvide(std::string const & name) const;
        ///
@@ -97,12 +124,27 @@ public:
        void useLanguage(Language const *);
        ///
        bool hasLanguages() const;
+       /// check if all used languages are supported by polyglossia
+       bool hasOnlyPolyglossiaLanguages() const;
+       /// check if a language is supported only by polyglossia
+       bool hasPolyglossiaExclusiveLanguages() const;
+       /// A vector of all used languages supported only by polyglossia
+       std::vector<std::string> getPolyglossiaExclusiveLanguages() const;
+       /// A vector of all used languages supported only by babel
+       std::vector<std::string> getBabelExclusiveLanguages() const;
+       ///
+       std::string getBabelLanguages() const;
+       ///
+       std::set<std::string> getPolyglossiaLanguages() const;
        ///
-       std::string getLanguages() const;
+       std::string getActiveChars() const;
        ///
        std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
        ///
-       void useLayout(docstring const & lyt);
+       void getFontEncodings(std::vector<std::string> & encodings,
+                             bool const onlylangs = false) const;
+       ///
+       void useLayout(docstring const & layoutname);
        ///
        void useInsetLayout(InsetLayout const & lay);
        ///
@@ -111,36 +153,58 @@ public:
        void setBuffer(Buffer const &);
        ///
        BufferParams const & bufferParams() const;
-       /// the return value is dependent upon both LyXRC and LaTeXFeatures.
-       bool useBabel() const;
+       /** Which language package do we require? \p englishbabel determines
+        *  if we require babel even if English is the only language.
+        */
+       LangPackage langPackage() const;
+       /// Convenience function to test if we use babel
+       bool useBabel() const { return langPackage() == LANG_PACK_BABEL; }
+       /// Convenience function to test if we use polyglossia
+       bool usePolyglossia() const { return langPackage() == LANG_PACK_POLYGLOSSIA; }
        /// are we in a float?
        bool inFloat() const { return in_float_; }
        /// are we in a float?
        void inFloat(bool const b) { in_float_ = b; }
+       /// are we in a deleted inset?
+       bool inDeletedInset() const { return in_deleted_inset_; }
+       /// are we in a deleted inset?
+       void inDeletedInset(bool const b) { in_deleted_inset_ = b; }
+       /// set savenote environment (footnote package)
+       std::string saveNoteEnv() const { return savenote_env_; }
+       /// return savenote environment
+       void saveNoteEnv(std::string const & s) { savenote_env_ = s; }
        /// Runparams that will be used for exporting this file.
        OutputParams const & runparams() const { return runparams_; }
+       /// Resolve alternatives like "esint|amsmath|wasysym"
+       void resolveAlternatives();
+       /// Expand multiple requirements like "textcomp,lyxmathsym,amstext"
+       void expandMultiples();
        ///
        void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
        ///
        docstring const & htmlTitle() const { return htmltitle_; }
+       ///
+       bool hasRTLLanguage() const;
 
 private:
+       ///
+       void useLayout(docstring const &, int);
        ///
        std::list<docstring> usedLayouts_;
        ///
        std::list<docstring> usedInsetLayouts_;
-       /// The features that are needed by the document
-       typedef std::set<std::string> Features;
        ///
+       typedef std::set<std::string> Features;
+       /// The features that are needed by the document
        Features features_;
+       /// Features that are provided
+       Features provides_;
        /// Static preamble bits, from external templates, or anywhere else
-       typedef std::list<std::string> SnippetList;
+       typedef std::list<TexString> SnippetList;
        ///
        SnippetList preamble_snippets_;
-       /// The available (required) packages
-       typedef std::set<std::string> Packages;
        ///
-       static Packages packages_;
+       SnippetList css_snippets_;
        ///
        typedef std::set<Language const *> LanguageList;
        /// used languages (only those that are supported by babel)
@@ -168,7 +232,11 @@ private:
        ///
        bool in_float_;
        ///
+       bool in_deleted_inset_;
+       ///
        docstring htmltitle_;
+       ///
+       std::string savenote_env_;
 };