Changed a '1.4.4' to '1.4.5'

[lyx.git] / src / LaTeXFeatures.h

diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h
index 1a10e7f662f6164b3f147ceabd92e023fcf7a8a5..878b466797505646ba5c9e564c7f544416b8b1fb 100644 (file)
--- a/src/LaTeXFeatures.h
+++ b/src/LaTeXFeatures.h
@@ -14,14 +14,20 @@
 #define LATEXFEATURES_H
 
 
+#include "OutputParams.h"
+#include "support/docstring.h"
+
 #include <set>
 #include <list>
 #include <map>
 #include <string>
 
+
+namespace lyx {
+
 class Buffer;
 class BufferParams;
-struct Language;
+class Language;
 
 /** The packages and commands that a buffer needs. This class
  *  contains a list<string>.  Each of the LaTeX packages that a buffer needs
@@ -33,13 +39,14 @@ struct 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 {
 public:
        ///
-       LaTeXFeatures(Buffer const &, BufferParams const &, bool);
+       LaTeXFeatures(Buffer const &, BufferParams const &,
+                     OutputParams const &);
        /// The packages needed by the document
        std::string const getPackages() const;
        /// The macros definitions needed by the document
@@ -47,23 +54,32 @@ public:
        ///
        std::string const getBabelOptions() const;
        /// The definitions needed by the document's textclass
-       std::string const getTClassPreamble() const;
-       /// The sgml definitions needed by the document (dobook/linuxdoc)
-       std::string const getLyXSGMLEntities() const;
+       docstring const getTClassPreamble() const;
+       /// The sgml definitions needed by the document (docbook)
+       docstring const getLyXSGMLEntities() const;
        /// The SGML Required to include the files added with includeFile();
-       std::string const getIncludedFiles(std::string const & fname) const;
+       docstring const getIncludedFiles(std::string const & fname) const;
        /// Include a file for use with the SGML entities
-       void includeFile(std::string const & key, std::string const & name);
+       void includeFile(docstring const & key, std::string const & name);
        /// The float definitions.
        void getFloatDefinitions(std::ostream & os) const;
        /// Print requirements to lyxerr
        void showStruct() const;
        ///
-       void addExternalPreamble(std::string const &);
+       void addPreambleSnippet(std::string const &);
        /// Provide a string name-space to the requirements
        void require(std::string const & name);
-       /// Is the package required?
+       /// 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.
+       */
+       bool mustProvide(std::string const & name) const;
        ///
        void useFloat(std::string const & name);
        ///
@@ -75,7 +91,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;
        ///
@@ -84,11 +100,11 @@ public:
        BufferParams const & bufferParams() const;
        /// the return value is dependent upon both LyXRC and LaTeXFeatures.
        bool useBabel() const;
-       ///
-       bool nice() const { return nice_; };
+       /// 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;
@@ -96,16 +112,20 @@ private:
        FeaturesList features_;
        ///
        FeaturesList preamble_snippets_;
+       /// The available (required) packages
+       typedef std::list<std::string> PackagesList;
        ///
-       typedef std::set<Language const *> LanguageList;
+       static PackagesList packages_;
        ///
+       typedef std::set<Language const *> LanguageList;
+       /// used languages (only those that are supported by babel)
        LanguageList UsedLanguages_;
        ///
        typedef std::set<std::string> UsedFloats;
        ///
        UsedFloats usedFloats_;
        ///
-       typedef std::map<std::string , std::string> FileMap;
+       typedef std::map<docstring , std::string> FileMap;
        ///
        FileMap IncludedFiles_;
        /** Buffer of the file being processed.
@@ -116,10 +136,13 @@ private:
        Buffer const * buffer_;
        ///
        BufferParams const & params_;
-       /** If we are writing a nice LaTeX file or not.
-        *  Only needed by InsetInclude::validate().
+       /** Some insets need to know details about the to-be-produced file
+        *  in validate().
         */
-       bool nice_;
+       OutputParams const & runparams_;
 };
 
+
+} // namespace lyx
+
 #endif