X-Git-Url: https://git.lyx.org/gitweb/?a=blobdiff_plain;f=src%2FLaTeXFeatures.h;h=a31ea3a2e5e2ab2f8f6323f0dd21090f5dcb614d;hb=660d2e98144ce7ec32867c34c411243688a53094;hp=25b1db14b8e9d6ef40a6dd0d99f19275644a30b3;hpb=89885b5fa1d24ee5275b4744ed3344bccf51df04;p=lyx.git diff --git a/src/LaTeXFeatures.h b/src/LaTeXFeatures.h index 25b1db14b8..a31ea3a2e5 100644 --- a/src/LaTeXFeatures.h +++ b/src/LaTeXFeatures.h @@ -1,167 +1,189 @@ // -*- 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" +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(BufferParams const &, int n) ; - /// The packaes needed by the document - string getPackages(); +/** 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(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(); + 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(); - /// - string getIncludedFiles(); - - /// - void showStruct(); - - /// Provide a string name-space to the requirements - void require(string const & name); - - /// Static preamble bits from the external material insets - string externalPreambles; - - //@Man: Packages - //@{ + docstring const getTClassPreamble() const; + /// The language dependent definitions needed by the document's textclass + docstring const getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const; /// - bool color; // color.sty -#ifdef USE_GRAPHICX + docstring const getTClassHTMLStyles() const; /// - bool graphicx; // graphicx.sty -#else + 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; /// - bool graphics; // graphics.sty -#endif + void addPreambleSnippet(std::string const &); /// - bool setspace; // setspace.sty + std::string getPreambleSnippets() 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); + /// 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; /// - bool makeidx; // makeind.sty + void useFloat(std::string const & name, bool subfloat = false); /// - bool verbatim; // verbatim.sty + void useLanguage(Language const *); /// - bool longtable; // longtable.sty + bool hasLanguages() const; + /// check if all used languages are supported by polyglossia + bool hasPolyglossiaLanguages() const; /// - bool algorithm; // algorithm.sty + std::string getLanguages() const; /// - bool rotating; // rotating.sty + std::map getPolyglossiaLanguages() const; /// - bool amssymb; // amssymb.sty + std::set getEncodingSet(std::string const & doc_encoding) const; /// - bool latexsym; // latexsym.sty + void useLayout(docstring const & lyt); /// - bool pifont; // pifont.sty + void useInsetLayout(InsetLayout const & lay); /// - bool subfigure; // subfigure.sty + Buffer const & buffer() const; /// - bool floatflt; // floatflt.sty + void setBuffer(Buffer const &); /// - bool url; // url.sty + BufferParams const & bufferParams() const; + /// the return value is dependent upon both LyXRC and LaTeXFeatures. + bool useBabel() const; /// - bool varioref; // varioref.sty + bool usePolyglossia() const; + /// 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_; } /// - bool prettyref; // prettyref.sty + void setHTMLTitle(docstring const & t) { htmltitle_ = t; } /// - bool chess; // chess.sty - //@} + docstring const & htmlTitle() const { return htmltitle_; } - - //@Man: Commands - //@{ - /// - bool lyx; - /// - bool lyxline; - /// \noun - bool noun; - /// \lyxarrow - bool lyxarrow; - //@} - - //@Man: Quotes - //@{ - /// - bool quotesinglbase; - /// - bool quotedblbase; - /// - bool guilsinglleft; - /// - bool guilsinglright; +private: /// - bool guillemotleft; + std::list usedLayouts_; /// - bool guillemotright; - //@} - - //@Man: Math mode - //@{ + std::list usedInsetLayouts_; + /// The features that are needed by the document + typedef std::set Features; /// - bool amsstyle; + Features features_; + /// Static preamble bits, from external templates, or anywhere else + typedef std::list SnippetList; /// - bool boldsymbol; + SnippetList preamble_snippets_; + /// The available (required) packages + typedef std::set Packages; /// - bool binom; - //@} - - //@Man: Layouts - //@{ - std::vector layout; - //@} - - //@Man: Special features - //@{ - bool LyXParagraphIndent; + static Packages packages_; /// - bool NeedLyXFootnoteCode; + typedef std::set LanguageList; + /// used languages (only those that are supported by babel) + LanguageList UsedLanguages_; /// - bool NeedLyXMinipageIndent; + typedef std::map UsedFloats; /// - typedef std::set LanguageList; + UsedFloats usedFloats_; /// - LanguageList UsedLanguages; + typedef std::map FileMap; /// - typedef std::set FloatList; + 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_; /// - FloatList usedFloats; + BufferParams const & params_; + /** Some insets need to know details about the to-be-produced file + * in validate(). + */ + OutputParams const & runparams_; /// - typedef std::map FileMap; + bool in_float_; /// - FileMap IncludedFiles; - //@} - BufferParams const & bufferParams() const; -private: - BufferParams const & params; + docstring htmltitle_; }; + +} // namespace lyx + #endif