X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=bcf1ed43b82b618701684c670579ed40e48f4b69;hb=fb12b282f1300123c7f4c7f10525c29cb598e1fe;hp=daa6231c2b3f966a6558dbfdc0e38f92efc30c38;hpb=44cd0fc9a1687cc63911c7f98d978594458e7813;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index daa6231c2b..bcf1ed43b8 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -13,32 +13,39 @@ #ifndef LATEXFEATURES_H #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.cpp and Paragraph.cpp + * 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,25 +53,36 @@ 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 &); - /// Provide a string name-space to the requirements + void addPreambleSnippet(std::string const &); + /// Add a feature name requirements void require(std::string const & name); - /// Is the package required? + /// Add a set of feature names requirements + void require(std::set 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. + */ + 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 *); /// @@ -74,39 +92,60 @@ 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; /// + 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_; + std::list usedLayouts_; + /// The features that are needed by the document + typedef std::set Features; + /// + Features features_; /// Static preamble bits from the external material insets - typedef std::list FeaturesList; + typedef std::list SnippetList; /// - FeaturesList features_; + SnippetList preamble_snippets_; + /// The available (required) packages + typedef std::set Packages; /// - FeaturesList preamble_snippets_; + static Packages packages_; /// typedef std::set LanguageList; - /// + /// used languages (only those that are supported by babel) LanguageList UsedLanguages_; /// - typedef std::set UsedFloats; + typedef std::map UsedFloats; /// 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