X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=df071c671b2658419f439272d086eab7ae7167c7;hb=28be7d552f62cc02fa86d7f79201d089bfb2d7b5;hp=be168ffef28cd6ba5f5ad573ece3e2a07217de10;hpb=922ed31d7aff55d7ea764ec89aa1d9fd77c53261;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index be168ffef2..df071c671b 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,159 +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 "OutputParams.h" +#include "support/docstring.h" -#ifdef __GNUG__ -#pragma interface -#endif - -#include #include +#include +#include + -#include "LString.h" -#include "layout.h" +namespace lyx { -class BufferParams; -struct Language; +class Buffer; +class BufferParams; +class InsetLayout; +class Language; +struct TexString; -/** The packages and commands that a buffer needs. This struct - contains an entry for each of the latex packages and - commands that a buffer might need. This struct is supposed to be - extended as the need arises. Remember to update the validate function - in buffer.C and paragraph.C when you do so. -*/ -struct LaTeXFeatures { - /// - LaTeXFeatures(BufferParams const &, LyXTextClass::size_type n) ; - /// The packaes needed by the document - string const getPackages() const; +/** 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: + /// 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 - string const getMacros() 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; - /// - string const getIncludedFiles(string const & fname) const; - /// - void getFloatDefinitions(std::ostream & os) 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(); + docstring const getIncludedFiles(std::string const & fname) const; + /// Include a file for use with the SGML entities + void includeFile(docstring const & key, std::string const & name); + /// The float definitions. + void getFloatDefinitions(otexstream & os) const; + /// Print requirements to lyxerr void showStruct() const; - - /// Provide a string name-space to the requirements - void require(string const & name); - - /// Static preamble bits from the external material insets - string externalPreambles; - - /// - bool array; - /// - bool color; // color.sty - /// - bool graphicx; // graphicx.sty - /// - bool graphics; // graphics.sty - /// - bool setspace; // setspace.sty - /// - bool makeidx; // makeind.sty - /// - bool verbatim; // verbatim.sty + /// 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); /// - bool longtable; // longtable.sty + TexString getPreambleSnippets() const; /// - //bool algorithm; // algorithm.sty + void addCSSSnippet(std::string const &); /// - bool rotating; // rotating.sty + 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; /// - bool amssymb; // amssymb.sty + void useFloat(std::string const & name, bool subfloat = false); /// - bool latexsym; // latexsym.sty + void useLanguage(Language const *); /// - bool pifont; // pifont.sty + 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; /// - bool subfigure; // subfigure.sty + std::string getBabelLanguages() const; /// - bool floatflt; // floatflt.sty + std::set getPolyglossiaLanguages() const; /// - bool url; // url.sty + std::set getEncodingSet(std::string const & doc_encoding) const; /// - bool varioref; // varioref.sty + void getFontEncodings(std::vector & encodings) const; /// - bool prettyref; // prettyref.sty + void useLayout(docstring const & lyt); /// - bool chess; // chess.sty + void useInsetLayout(InsetLayout const & lay); /// - bool natbib; // natbib.sty + Buffer const & buffer() const; /// - bool floats; // float.sty - + void setBuffer(Buffer const &); /// - bool lyx; - /// - bool lyxline; - /// \noun - bool noun; - /// \lyxarrow - bool lyxarrow; - - /// - bool quotesinglbase; - /// - bool quotedblbase; - /// - bool guilsinglleft; - /// - bool guilsinglright; - /// - bool guillemotleft; - /// - bool guillemotright; + BufferParams const & bufferParams() 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: /// - bool amsstyle; + void useLayout(docstring const &, int); /// - bool boldsymbol; + std::list usedLayouts_; /// - bool binom; - - std::vector layout; - + std::list usedInsetLayouts_; + /// The features that are needed by the document + typedef std::set Features; /// - bool ParagraphIndent; + Features features_; + /// Static preamble bits, from external templates, or anywhere else + typedef std::list SnippetList; /// - bool NeedLyXFootnoteCode; + SnippetList preamble_snippets_; /// - bool NeedLyXMinipageIndent; + 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_; /// - BufferParams const & bufferParams() const; -private: + bool in_float_; + /// + bool in_deleted_inset_; /// - BufferParams const & params; + docstring htmltitle_; }; + +} // namespace lyx + #endif