]> git.lyx.org Git - lyx.git/blobdiff - src/LaTeXFeatures.h
prepare Qt 5.6 builds
[lyx.git] / src / LaTeXFeatures.h
index 635376c8a12359a87e47b940d5e61501eb11a217..0d417bd9d2a02d9c233b546b25ec78f80fa2dcf9 100644 (file)
 #include <set>
 #include <list>
 #include <map>
-#include <string>
 
 
 namespace lyx {
 
 class Buffer;
 class BufferParams;
+class InsetLayout;
 class Language;
 
 /** The packages and commands that a buffer needs. This class
@@ -43,19 +43,40 @@ 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
-       std::string const getMacros() const;
-       ///
-       std::string const getBabelOptions() const;
+       docstring const getMacros() const;
+       /// Extra preamble code before babel is called
+       std::string const getBabelPresettings() const;
+       /// Extra preamble code after babel is called
+       std::string const getBabelPostsettings() const;
+       /// Do we need to pass the languages to babel directly?
+       bool needBabelLangOptions() 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, bool use_polyglossia) 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();
@@ -63,24 +84,31 @@ public:
        /// Include a file for use with the SGML entities
        void includeFile(docstring const & key, std::string const & name);
        /// The float definitions.
-       void getFloatDefinitions(std::ostream & os) const;
+       void getFloatDefinitions(odocstream & os) const;
        /// Print requirements to lyxerr
        void showStruct() const;
        ///
        void addPreambleSnippet(std::string const &);
+       ///
+       std::string getPreambleSnippets() const;
+       ///
+       void addCSSSnippet(std::string const &);
+       ///
+       std::string 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();
        /// Is the (required) package available?
        static bool isAvailable(std::string const & name);
        /// 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;
        ///
@@ -89,38 +117,66 @@ 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;
+       ///
+       std::string getBabelLanguages() const;
        ///
-       std::string getLanguages() const;
+       std::map<std::string, std::string> getPolyglossiaLanguages() const;
        ///
        std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
        ///
+       void getFontEncodings(std::vector<std::string> & encodings) const;
+       ///
        void useLayout(docstring const & lyt);
        ///
+       void useInsetLayout(InsetLayout const & lay);
+       ///
        Buffer const & buffer() const;
        ///
        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; }
        /// Runparams that will be used for exporting this file.
        OutputParams const & runparams() const { return runparams_; }
+       /// Resolve alternatives like "esint|amsmath|wasysym"
+       void resolveAlternatives();
+       ///
+       void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
+       ///
+       docstring const & htmlTitle() const { return htmltitle_; }
 
 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;
        ///
        Features features_;
-       /// Static preamble bits from the external material insets
+       /// Static preamble bits, from external templates, or anywhere else
        typedef std::list<std::string> 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)
@@ -145,6 +201,10 @@ private:
         *  in validate().
         */
        OutputParams const & runparams_;
+       ///
+       bool in_float_;
+       ///
+       docstring htmltitle_;
 };