X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=137f5d7ebf7c0cf05cf09dabc78ba7501a9700a9;hb=c26c7602e4b5139ad8a98e77d97cf47ba67588d2;hp=8ee0c1cd5a7fb7ee111a53207999d197e4cd15e9;hpb=c9f9ba315c8e475ad47c64fef6c9c755dea3d55c;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 8ee0c1cd5a..137f5d7ebf 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -4,7 +4,7 @@ * This file is part of LyX, the document processor. * Licence details can be found in the file COPYING. * - * \author Lars Gullik Bjønnes + * \author Lars Gullik Bjønnes * \author Jean-Marc Lasgouttes * * Full author contact details are available in file CREDITS. @@ -13,15 +13,21 @@ #ifndef LATEXFEATURES_H #define LATEXFEATURES_H +#include "OutputParams.h" +#include "support/docstring.h" #include #include #include -#include + + +namespace lyx { class Buffer; class BufferParams; +class InsetLayout; class Language; +struct TexString; /** The packages and commands that a buffer needs. This class * contains a list. Each of the LaTeX packages that a buffer needs @@ -33,79 +39,174 @@ 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 { public: - /// - LaTeXFeatures(Buffer const &, BufferParams const &, bool); + /// Which Language package do we use? + enum LangPackage { + LANG_PACK_NONE, + LANG_PACK_BABEL, + LANG_PACK_POLYGLOSSIA, + LANG_PACK_CUSTOM + }; + /// + LaTeXFeatures(Buffer const &, BufferParams const &, + OutputParams const &); + /// The color packages + std::string const getColorOptions() const; + /// The requested package options + std::string const getPackageOptions() const; /// The packages needed by the document std::string const getPackages() const; /// The macros definitions needed by the document - std::string const getMacros() const; - /// - std::string const getBabelOptions() const; + TexString getMacros() const; + /// Extra preamble code before babel is called + docstring const getBabelPresettings() const; + /// Extra preamble code after babel is called + docstring const getBabelPostsettings() const; + /// Do we need to pass the languages to babel directly? + bool needBabelLangOptions() const; + /// Load AMS packages when appropriate + std::string const loadAMSPackages() 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 language dependent definitions needed by the document's textclass + docstring const getTClassI18nPreamble(bool use_babel, + bool use_polyglossia, bool use_minted) const; + /// + docstring const getTClassHTMLStyles() const; + /// + docstring const getTClassHTMLPreamble() 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; + void getFloatDefinitions(otexstream & os) const; /// Print requirements to lyxerr void showStruct() const; + /// Add preamble snippet with TexRow information + void addPreambleSnippet(TexString snippet, bool allowdupes = false); + /// Add preamble snippet without TexRow information + void addPreambleSnippet(docstring const & snippet, bool allowdupes = false); + /// + TexString getPreambleSnippets() const; /// - void addExternalPreamble(std::string const &); - /// Provide a string name-space to the requirements + void addCSSSnippet(std::string const &); + /// + docstring getCSSSnippets() 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); + /// 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 this feature already provided + * e.g. by the document class? + */ + bool isProvided(std::string const & name) const; + /** Is it necessary to load the package? This is true if + isRequired is true and the feature is not already provided + */ + 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 *); /// bool hasLanguages() const; + /// check if all used languages are supported by polyglossia + bool hasOnlyPolyglossiaLanguages() const; + /// check if a language is supported only by polyglossia + bool hasPolyglossiaExclusiveLanguages() const; + /// A vector of all used languages supported only by polyglossia + std::vector getPolyglossiaExclusiveLanguages() const; + /// A vector of all used languages supported only by babel + std::vector getBabelExclusiveLanguages() const; + /// + std::string getBabelLanguages() const; /// - std::string getLanguages() const; + std::set getPolyglossiaLanguages() const; /// std::set getEncodingSet(std::string const & doc_encoding) const; /// - void useLayout(std::string const & lyt); + void getFontEncodings(std::vector & encodings) const; + /// + void useLayout(docstring const & lyt); + /// + void useInsetLayout(InsetLayout const & lay); /// 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_; }; + /** Which language package do we require? \p englishbabel determines + * if we require babel even if English is the only language. + */ + LangPackage langPackage() const; + /// Convenience function to test if we use babel + bool useBabel() const { return langPackage() == LANG_PACK_BABEL; } + /// Convenience function to test if we use polyglossia + bool usePolyglossia() const { return langPackage() == LANG_PACK_POLYGLOSSIA; } + /// are we in a float? + bool inFloat() const { return in_float_; } + /// are we in a float? + void inFloat(bool const b) { in_float_ = b; } + /// are we in a deleted inset? + bool inDeletedInset() const { return in_deleted_inset_; } + /// are we in a deleted inset? + void inDeletedInset(bool const b) { in_deleted_inset_ = b; } + /// set savenote environment (footnote package) + std::string saveNoteEnv() const { return savenote_env_; } + /// return savenote environment + void saveNoteEnv(std::string const s) { savenote_env_ = s; } + /// Runparams that will be used for exporting this file. + OutputParams const & runparams() const { return runparams_; } + /// Resolve alternatives like "esint|amsmath|wasysym" + void resolveAlternatives(); + /// Expand multiple requirements like "textcomp,lyxmathsym,amstext" + void expandMultiples(); + /// + void setHTMLTitle(docstring const & t) { htmltitle_ = t; } + /// + docstring const & htmlTitle() const { return htmltitle_; } private: - std::list usedLayouts_; - - /// Static preamble bits from the external material insets - typedef std::list FeaturesList; /// - FeaturesList features_; + void useLayout(docstring const &, int); /// - FeaturesList preamble_snippets_; + bool hasRTLLanguage() const; /// - typedef std::set LanguageList; + std::list usedLayouts_; + /// + std::list usedInsetLayouts_; + /// The features that are needed by the document + typedef std::set Features; + /// + Features features_; + /// Static preamble bits, from external templates, or anywhere else + typedef std::list SnippetList; + /// + SnippetList preamble_snippets_; /// + SnippetList css_snippets_; + /// + 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 of the file being processed. @@ -116,10 +217,21 @@ 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_; + /// + bool in_float_; + /// + bool in_deleted_inset_; + /// + docstring htmltitle_; + /// + std::string savenote_env_; }; + +} // namespace lyx + #endif