X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=878b466797505646ba5c9e564c7f544416b8b1fb;hb=52e5755c84ceb65d935764da467c7b948672e77e;hp=c3d62de312b60008994785b162e7b917d799c597;hpb=85fa1d41baec6774f7bd801bf39ef8376888dbc7;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index c3d62de312..878b466797 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -14,32 +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.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,18 +91,20 @@ 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; - /// - bool nice() const { return nice_; }; + /// Runparams that will be used for exporting this file. + 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; @@ -94,26 +112,37 @@ private: FeaturesList features_; /// FeaturesList preamble_snippets_; + /// The available (required) packages + typedef std::list PackagesList; /// - typedef std::set LanguageList; + 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 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_; - /** 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