X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=48524f30a26070ba29bc164fddcea52848df84f1;hb=35204f8f33d7400a5fefeffea533fb4cb4097211;hp=daa6231c2b3f966a6558dbfdc0e38f92efc30c38;hpb=44cd0fc9a1687cc63911c7f98d978594458e7813;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index daa6231c2b..48524f30a2 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -14,31 +14,39 @@ #define LATEXFEATURES_H +#include "outputparams.h" +#include "support/docstring.h" + #include #include #include +#include + + +namespace lyx { class Buffer; class BufferParams; -struct Language; +class Language; /** The packages and commands that a buffer needs. This class - contains a list. Each of the LaTeX packages that a buffer needs - should be added with void require(string const & name). - - i.e require("amssymb") - - To add support you should only need to require() the package name as - 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 - when you do so. -*/ + * contains a list. Each of the LaTeX packages that a buffer needs + * should be added with void require(string const & name). + * + * i.e require("amssymb") + * + * To add support you should only need to require() the package name as + * 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 + * when you do so. + */ class LaTeXFeatures { public: /// - LaTeXFeatures(Buffer const &, BufferParams const &); + 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 @@ -46,13 +54,13 @@ 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 @@ -61,8 +69,12 @@ public: void addExternalPreamble(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; /// void useFloat(std::string const & name); /// @@ -78,9 +90,13 @@ public: /// 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; + /// Runparams that will be used for exporting this file. + OutputParams const & runparams() const { return runparams_; } private: std::list usedLayouts_; @@ -91,6 +107,10 @@ private: FeaturesList features_; /// FeaturesList preamble_snippets_; + /// The available (required) packages + typedef std::list PackagesList; + /// + static PackagesList packages_; /// typedef std::set LanguageList; /// @@ -100,13 +120,24 @@ private: /// UsedFloats usedFloats_; /// - typedef std::map FileMap; + typedef std::map FileMap; /// FileMap IncludedFiles_; - /// - Buffer const & buffer_; + /** Buffer of the file being processed. + * This may be a child buffer of the to-be-exported file and + * therefore may not be the buffer that belongs to params_. + * Only needed by InsetInclude::validate(). + */ + Buffer const * buffer_; /// BufferParams const & params_; + /** Some insets need to know details about the to-be-produced file + * in validate(). + */ + OutputParams const & runparams_; }; + +} // namespace lyx + #endif