X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=df071c671b2658419f439272d086eab7ae7167c7;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=6cf6c8d159f968e9f8245cb13effe3a21391592a;hpb=5d429a45a33ef33b502f631ec58c483bafa22adb;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 6cf6c8d159..df071c671b 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,112 +1,229 @@ // -*- C++ -*- -/* This file is part of -* ====================================================== -* -* LyX, The Document Processor -* -* Copyright 1995 Matthias Ettrich -* Copyright 1995-2001 the LyX Team. -* -* ====================================================== */ +/** + * \file LaTeXFeatures.h + * This file is part of LyX, the document processor. + * Licence details can be found in the file COPYING. + * + * \author Lars Gullik Bjønnes + * \author Jean-Marc Lasgouttes + * + * Full author contact details are available in file CREDITS. + */ #ifndef LATEXFEATURES_H #define LATEXFEATURES_H -#include "support/types.h" - -#include "LString.h" +#include "OutputParams.h" +#include "support/docstring.h" #include #include #include -class BufferParams; -struct 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). +namespace lyx { - i.e require("amssymb") +class Buffer; +class BufferParams; +class InsetLayout; +class Language; +struct TexString; - 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. -*/ +/** 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.cpp and Paragraph.cpp + * when you do so. + */ class LaTeXFeatures { public: - /// - LaTeXFeatures(BufferParams const &); + /// 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 - string const getPackages() const; + std::string const getPackages() const; /// The macros definitions needed by the document - string const getMacros() const; - /// - 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 - string const getTClassPreamble() const; - /// The sgml definitions needed by the document (dobook/linuxdoc) - 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(); - string const getIncludedFiles(string const & fname) const; + docstring const getIncludedFiles(std::string const & fname) const; /// Include a file for use with the SGML entities - void includeFile(string const & key, 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; - /// - void addExternalPreamble(string const &); - /// Provide a string name-space to the requirements - void require(string const & name); - /// Is the package required? - bool isRequired(string const & name) const; - /// - void useFloat(string const & name); + /// 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 addCSSSnippet(std::string const &); + /// + docstring getCSSSnippets() const; + /// Add a feature name requirements + void require(std::string const & name); + /// 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, 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::set getPolyglossiaLanguages() const; + /// + std::set getEncodingSet(std::string const & doc_encoding) const; /// - string getLanguages() const; + void getFontEncodings(std::vector & encodings) const; /// - std::set getEncodingSet(string const & doc_encoding) const; + void useLayout(docstring const & lyt); /// - void useLayout(string 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; + /** 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; } + /// 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: - string externalPreambles; - - std::list usedLayouts; - - /// Static preamble bits from the external material insets - - - typedef std::list FeaturesList; /// - FeaturesList features; + void useLayout(docstring const &, int); + /// + 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_; /// - LanguageList UsedLanguages; + typedef std::map UsedFloats; /// - typedef std::set UsedFloats; + UsedFloats usedFloats_; /// - UsedFloats usedFloats; + typedef std::map FileMap; /// - typedef std::map FileMap; + FileMap IncludedFiles_; + /** 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_; /// - FileMap IncludedFiles; + BufferParams const & params_; + /** Some insets need to know details about the to-be-produced file + * in validate(). + */ + OutputParams const & runparams_; /// + bool in_float_; /// - BufferParams const & params; + bool in_deleted_inset_; + /// + docstring htmltitle_; }; + +} // namespace lyx + #endif