X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;ds=sidebyside;f=src%2FLaTeXFeatures.h;h=878b466797505646ba5c9e564c7f544416b8b1fb;hb=021d238288bed034079d5f51c7d7260683e9470b;hp=927dc312e620b7f450f49931c312b01229e0dcd9;hpb=5a0176a6ebab29cee7959420a0b3a1768d9273ec;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 927dc312e6..878b466797 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -14,13 +14,17 @@ #define LATEXFEATURES_H -#include "outputparams.h" +#include "OutputParams.h" +#include "support/docstring.h" #include #include #include #include + +namespace lyx { + class Buffer; class BufferParams; class Language; @@ -35,7 +39,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 { @@ -50,27 +54,32 @@ public: /// std::string const getBabelOptions() const; /// The definitions needed by the document's textclass - std::string const getTClassPreamble() const; + docstring const getTClassPreamble() const; /// The sgml definitions needed by the document (docbook) - std::string const getLyXSGMLEntities() const; + 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); /// 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); /// @@ -82,7 +91,7 @@ public: /// std::set getEncodingSet(std::string const & doc_encoding) const; /// - void useLayout(std::string const & lyt); + void useLayout(docstring const & lyt); /// Buffer const & buffer() const; /// @@ -95,7 +104,7 @@ public: OutputParams const & runparams() const { return runparams_; } private: - std::list usedLayouts_; + std::list usedLayouts_; /// Static preamble bits from the external material insets typedef std::list FeaturesList; @@ -109,14 +118,14 @@ private: static PackagesList packages_; /// typedef std::set LanguageList; - /// + /// used languages (only those that are supported by babel) LanguageList UsedLanguages_; /// typedef std::set UsedFloats; /// UsedFloats usedFloats_; /// - typedef std::map FileMap; + typedef std::map FileMap; /// FileMap IncludedFiles_; /** Buffer of the file being processed. @@ -133,4 +142,7 @@ private: OutputParams const & runparams_; }; + +} // namespace lyx + #endif