X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=71004be4cadc73c130b057f65e79a30ef0692209;hb=1d6573a330791fb34541f4092cd49e4559972489;hp=feed7812d66342af397e41cfa109b2d1f6b3edff;hpb=85798535a19919e82cc94a177a8414c542a9c5bf;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index feed7812d6..71004be4ca 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,145 +1,207 @@ // -*- C++ -*- -/* This file is part of -* ====================================================== -* -* LyX, The Document Processor -* -* Copyright 1995 Matthias Ettrich -* Copyright 1995-2000 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" -using std::vector; -using std::set; +namespace lyx { -class BufferParams; -class LyXTextClass; -struct Language; +class Buffer; +class BufferParams; +class InsetLayout; +class Language; -/** 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(int n) ; - /// The packaes needed by the document - string getPackages(BufferParams const & params); +/** 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 packages needed by the document + std::string const getPackages() const; /// The macros definitions needed by the document - string getMacros(BufferParams const & params); + docstring const getMacros() const; + /// Extra preamble code before babel is called + std::string const getBabelPresettings() const; + /// Extra preamble code after babel is called + std::string 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 getTClassPreamble(BufferParams const & params); - - /// - void showStruct(BufferParams const & params); + docstring const getTClassPreamble() const; + /// The language dependent definitions needed by the document's textclass + docstring const getTClassI18nPreamble(bool use_babel, bool use_polyglossia) 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(odocstream & os) const; + /// Print requirements to lyxerr + void showStruct() const; + /// + void addPreambleSnippet(std::string const &); + /// + std::string getPreambleSnippets() const; + /// + void addCSSSnippet(std::string const &); + /// + std::string 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; + /// + std::string getBabelLanguages() const; + /// + std::map getPolyglossiaLanguages() const; + /// + std::set getEncodingSet(std::string const & doc_encoding) const; + /// + void useLayout(docstring const & lyt); + /// + void useInsetLayout(InsetLayout const & lay); + /// + Buffer const & buffer() const; + /// + void setBuffer(Buffer const &); + /// + 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; } + /// Runparams that will be used for exporting this file. + OutputParams const & runparams() const { return runparams_; } + /// Resolve alternatives like "esint|amsmath|wasysym" + void resolveAlternatives(); + /// + void setHTMLTitle(docstring const & t) { htmltitle_ = t; } + /// + docstring const & htmlTitle() const { return htmltitle_; } - //@Man: Packages - //@{ +private: /// - bool color; // color.sty -#ifdef USE_GRAPHICX - /// - bool graphicx; // graphicx.sty -#else - /// - bool graphics; // graphics.sty -#endif + std::list usedLayouts_; /// - bool setspace; // setspace.sty + std::list usedInsetLayouts_; + /// The features that are needed by the document + typedef std::set Features; /// - bool makeidx; // makeind.sty + Features features_; + /// Static preamble bits, from external templates, or anywhere else + typedef std::list SnippetList; /// - bool verbatim; // verbatim.sty + SnippetList preamble_snippets_; /// - bool longtable; // longtable.sty + SnippetList css_snippets_; /// - bool algorithm; // algorithm.sty + typedef std::set LanguageList; + /// used languages (only those that are supported by babel) + LanguageList UsedLanguages_; /// - bool rotating; // rotating.sty + typedef std::map UsedFloats; /// - bool amssymb; // amssymb.sty - /// - bool latexsym; // latexsym.sty - /// - bool pifont; // pifont.sty - /// - bool subfigure; // subfigure.sty - /// - bool floatflt; // floatflt.sty - /// - bool url; // url.sty - //@} - - - //@Man: Commands - //@{ + UsedFloats usedFloats_; /// - bool lyx; + typedef std::map FileMap; /// - bool lyxline; - /// \noun - bool noun; - /// \lyxarrow - bool lyxarrow; - //@} - - //@Man: Quotes - //@{ + 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_; /// - bool quotesinglbase; + BufferParams const & params_; + /** Some insets need to know details about the to-be-produced file + * in validate(). + */ + OutputParams const & runparams_; /// - bool quotedblbase; + bool in_float_; /// - bool guilsinglleft; - /// - bool guilsinglright; - /// - bool guillemotleft; - /// - bool guillemotright; - //@} - - //@Man: Math mode - //@{ - /// - bool amsstyle; - /// - bool boldsymbol; - /// - bool binom; - //@} - - //@Man: Layouts - //@{ - vector layout; - //@} - - //@Man: Special features - //@{ - bool LyXParagraphIndent; - /// - bool NeedLyXFootnoteCode; - /// - bool NeedLyXMinipageIndent; - /// - typedef set LanguageList; - /// - LanguageList UsedLanguages; - //@} + docstring htmltitle_; }; + +} // namespace lyx + #endif