* remove outdated RC_CUSTOM_EXPORT_COMMAND and RC_CUSTOM_EXPORT_FORMAT.

[lyx.git] / src / LaTeXFeatures.h

diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h
index 84e43dbbe2b01da12d5bac27967523feb2592cd2..7f010b33ca94522ba397e4ff098683c600a7df1c 100644 (file)
--- a/src/LaTeXFeatures.h
+++ b/src/LaTeXFeatures.h
@@ -4,7 +4,7 @@
  * This file is part of LyX, the document processor.
  * Licence details can be found in the file COPYING.
  *
- * \author Lars Gullik Bjønnes
+ * \author Lars Gullik Bjønnes
  * \author Jean-Marc Lasgouttes
  *
  * Full author contact details are available in file CREDITS.
@@ -13,8 +13,7 @@
 #ifndef LATEXFEATURES_H
 #define LATEXFEATURES_H
 
-
-#include "outputparams.h"
+#include "OutputParams.h"
 #include "support/docstring.h"
 
 #include <set>
@@ -39,7 +38,7 @@ class Language;
  *  packages which don't have special requirements are handled automatically.
  *  If your new package does need special consideration you'll need to alter
  *  string const getPackages() const;
- *  Remember to update the validate function in buffer.C and paragraph.C
+ *  Remember to update the validate function in Buffer.cpp and Paragraph.cpp
  *  when you do so.
  */
 class LaTeXFeatures {
@@ -47,6 +46,8 @@ public:
        ///
        LaTeXFeatures(Buffer const &, BufferParams const &,
                      OutputParams const &);
+       /// The color packages
+       std::string const getColorOptions() const;
        /// The packages needed by the document
        std::string const getPackages() const;
        /// The macros definitions needed by the document
@@ -54,7 +55,9 @@ public:
        ///
        std::string const getBabelOptions() const;
        /// The definitions needed by the document's textclass
-       std::string const getTClassPreamble() const;
+       docstring const getTClassPreamble() const;
+       /// The language dependent definitions needed by the document's textclass
+       docstring const getTClassI18nPreamble(bool use_babel) const;
        /// The sgml definitions needed by the document (docbook)
        docstring const getLyXSGMLEntities() const;
        /// The SGML Required to include the files added with includeFile();
@@ -66,17 +69,24 @@ public:
        /// Print requirements to lyxerr
        void showStruct() const;
        ///
-       void addExternalPreamble(std::string const &);
-       /// Provide a string name-space to the requirements
+       void addPreambleSnippet(std::string 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 package required?
-       bool isRequired(std::string const & name) const;
        /// Is the (required) package available?
-       bool isAvailable(std::string const & name) const;
+       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.
+       */
+       bool mustProvide(std::string const & name) const;
        ///
-       void useFloat(std::string const & name);
+       void useFloat(std::string const & name, bool subfloat = false);
        ///
        void useLanguage(Language const *);
        ///
@@ -86,7 +96,7 @@ public:
        ///
        std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
        ///
-       void useLayout(std::string const & lyt);
+       void useLayout(docstring const & lyt);
        ///
        Buffer const & buffer() const;
        ///
@@ -95,32 +105,38 @@ public:
        BufferParams const & bufferParams() const;
        /// the return value is dependent upon both LyXRC and LaTeXFeatures.
        bool useBabel() const;
+       /// 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_; }
 
 private:
-       std::list<std::string> usedLayouts_;
+       std::list<docstring> usedLayouts_;
 
-       /// Static preamble bits from the external material insets
-       typedef std::list<std::string> FeaturesList;
+       /// The features that are needed by the document
+       typedef std::set<std::string> Features;
        ///
-       FeaturesList features_;
+       Features features_;
+       /// Static preamble bits from the external material insets
+       typedef std::list<std::string> SnippetList;
        ///
-       FeaturesList preamble_snippets_;
+       SnippetList preamble_snippets_;
        /// The available (required) packages
-       typedef std::list<std::string> PackagesList;
+       typedef std::set<std::string> Packages;
        ///
-       static PackagesList packages_;
+       static Packages packages_;
        ///
        typedef std::set<Language const *> LanguageList;
-       ///
+       /// used languages (only those that are supported by babel)
        LanguageList UsedLanguages_;
        ///
-       typedef std::set<std::string> UsedFloats;
+       typedef std::map<std::string, bool> UsedFloats;
        ///
        UsedFloats usedFloats_;
        ///
-       typedef std::map<docstring , std::string> FileMap;
+       typedef std::map<docstring, std::string> FileMap;
        ///
        FileMap IncludedFiles_;
        /** Buffer of the file being processed.
@@ -135,6 +151,8 @@ private:
         *  in validate().
         */
        OutputParams const & runparams_;
+       ///
+       bool in_float_;
 };