src/LaTeXFeatures.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LaTeXFeatures.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef LATEXFEATURES_H
  14 #define LATEXFEATURES_H
  15
  16 #include "OutputParams.h"
  17 #include "support/docstring.h"
  18
  19 #include <set>
  20 #include <list>
  21 #include <map>
  22
  23
  24 namespace lyx {
  25
  26 class Buffer;
  27 class BufferParams;
  28 class InsetLayout;
  29 class Language;
  30 struct TexString;
  31
  32 /** The packages and commands that a buffer needs. This class
  33  *  contains a list<string>.  Each of the LaTeX packages that a buffer needs
  34  *  should be added with void require(string const & name).
  35  *
  36  *  i.e require("amssymb")
  37  *
  38  *  To add support you should only need to require() the package name as
  39  *  packages which don't have special requirements are handled automatically.
  40  *  If your new package does need special consideration you'll need to alter
  41  *  string const getPackages() const;
  42  *  Remember to update the validate function in Buffer.cpp and Paragraph.cpp
  43  *  when you do so.
  44  */
  45 class LaTeXFeatures {
  46 public:
  47         /// Which Language package do we use?
  48         enum LangPackage {
  49                 LANG_PACK_NONE,
  50                 LANG_PACK_BABEL,
  51                 LANG_PACK_POLYGLOSSIA,
  52                 LANG_PACK_CUSTOM
  53         };
  54         ///
  55         LaTeXFeatures(Buffer const &, BufferParams const &,
  56                       OutputParams const &);
  57         /// The color packages
  58         std::string const getColorOptions() const;
  59         /// The requested package options
  60         std::string const getPackageOptions() const;
  61         /// The packages needed by the document
  62         std::string const getPackages() const;
  63         /// The macros definitions needed by the document
  64         TexString getMacros() const;
  65         /// Extra preamble code before babel is called
  66         docstring const getBabelPresettings() const;
  67         /// Extra preamble code after babel is called
  68         docstring const getBabelPostsettings() const;
  69         /// Do we need to pass the languages to babel directly?
  70         bool needBabelLangOptions() const;
  71         /// Load AMS packages when appropriate
  72         std::string const loadAMSPackages() const;
  73         /// The definitions needed by the document's textclass
  74         docstring const getTClassPreamble() const;
  75         /// The language dependent definitions needed by the document's textclass
  76         docstring const getTClassI18nPreamble(bool use_babel,
  77                                 bool use_polyglossia, bool use_minted) const;
  78         ///
  79         docstring const getTClassHTMLStyles() const;
  80         ///
  81         docstring const getTClassHTMLPreamble() const;
  82         /// The sgml definitions needed by the document (docbook)
  83         docstring const getLyXSGMLEntities() const;
  84         /// The SGML Required to include the files added with includeFile();
  85         docstring const getIncludedFiles(std::string const & fname) const;
  86         /// Include a file for use with the SGML entities
  87         void includeFile(docstring const & key, std::string const & name);
  88         /// The float definitions.
  89         void getFloatDefinitions(otexstream & os) const;
  90         /// Print requirements to lyxerr
  91         void showStruct() const;
  92         /// Add preamble snippet with TexRow information
  93         void addPreambleSnippet(TexString snippet, bool allowdupes = false);
  94         /// Add preamble snippet without TexRow information
  95         void addPreambleSnippet(docstring const & snippet, bool allowdupes = false);
  96         ///
  97         TexString getPreambleSnippets() const;
  98         /// Adds CSS information for HTML export.
  99         /// Note that addPreambleSnippet is for LaTeX-type export
 100         void addCSSSnippet(std::string const &);
 101         ///
 102         docstring getCSSSnippets() const;
 103         /// Add a feature name requirements
 104         void require(std::string const & name);
 105         /// Add a set of feature names requirements
 106         void require(std::set<std::string> const & names);
 107         /// Is the (required) package available?
 108         static bool isAvailable(std::string const & name);
 109         /// Has the package been required?
 110         bool isRequired(std::string const & name) const;
 111         /** Is this feature already provided
 112          *  e.g. by the document class?
 113         */
 114         bool isProvided(std::string const & name) const;
 115         /** Is it necessary to load the package? This is true if
 116             isRequired is true and the feature is not already provided
 117         */
 118         bool mustProvide(std::string const & name) const;
 119         ///
 120         void useFloat(std::string const & name, bool subfloat = false);
 121         ///
 122         void useLanguage(Language const *);
 123         ///
 124         bool hasLanguages() const;
 125         /// check if all used languages are supported by polyglossia
 126         bool hasOnlyPolyglossiaLanguages() const;
 127         /// check if a language is supported only by polyglossia
 128         bool hasPolyglossiaExclusiveLanguages() const;
 129         /// A vector of all used languages supported only by polyglossia
 130         std::vector<std::string> getPolyglossiaExclusiveLanguages() const;
 131         /// A vector of all used languages supported only by babel
 132         std::vector<std::string> getBabelExclusiveLanguages() const;
 133         ///
 134         std::string getBabelLanguages() const;
 135         ///
 136         std::set<std::string> getPolyglossiaLanguages() const;
 137         ///
 138         std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
 139         ///
 140         void getFontEncodings(std::vector<std::string> & encodings) const;
 141         ///
 142         void useLayout(docstring const & lyt);
 143         ///
 144         void useInsetLayout(InsetLayout const & lay);
 145         ///
 146         Buffer const & buffer() const;
 147         ///
 148         void setBuffer(Buffer const &);
 149         ///
 150         BufferParams const & bufferParams() const;
 151         /** Which language package do we require? \p englishbabel determines
 152          *  if we require babel even if English is the only language.
 153          */
 154         LangPackage langPackage() const;
 155         /// Convenience function to test if we use babel
 156         bool useBabel() const { return langPackage() == LANG_PACK_BABEL; }
 157         /// Convenience function to test if we use polyglossia
 158         bool usePolyglossia() const { return langPackage() == LANG_PACK_POLYGLOSSIA; }
 159         /// are we in a float?
 160         bool inFloat() const { return in_float_; }
 161         /// are we in a float?
 162         void inFloat(bool const b) { in_float_ = b; }
 163         /// are we in a deleted inset?
 164         bool inDeletedInset() const { return in_deleted_inset_; }
 165         /// are we in a deleted inset?
 166         void inDeletedInset(bool const b) { in_deleted_inset_ = b; }
 167         /// set savenote environment (footnote package)
 168         std::string saveNoteEnv() const { return savenote_env_; }
 169         /// return savenote environment
 170         void saveNoteEnv(std::string const s) { savenote_env_ = s; }
 171         /// Runparams that will be used for exporting this file.
 172         OutputParams const & runparams() const { return runparams_; }
 173         /// Resolve alternatives like "esint|amsmath|wasysym"
 174         void resolveAlternatives();
 175         /// Expand multiple requirements like "textcomp,lyxmathsym,amstext"
 176         void expandMultiples();
 177         ///
 178         void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
 179         ///
 180         docstring const & htmlTitle() const { return htmltitle_; }
 181         ///
 182         bool hasRTLLanguage() const;
 183
 184 private:
 185         ///
 186         void useLayout(docstring const &, int);
 187         ///
 188         std::list<docstring> usedLayouts_;
 189         ///
 190         std::list<docstring> usedInsetLayouts_;
 191         /// The features that are needed by the document
 192         typedef std::set<std::string> Features;
 193         ///
 194         Features features_;
 195         /// Static preamble bits, from external templates, or anywhere else
 196         typedef std::list<TexString> SnippetList;
 197         ///
 198         SnippetList preamble_snippets_;
 199         ///
 200         SnippetList css_snippets_;
 201         ///
 202         typedef std::set<Language const *> LanguageList;
 203         /// used languages (only those that are supported by babel)
 204         LanguageList UsedLanguages_;
 205         ///
 206         typedef std::map<std::string, bool> UsedFloats;
 207         ///
 208         UsedFloats usedFloats_;
 209         ///
 210         typedef std::map<docstring, std::string> FileMap;
 211         ///
 212         FileMap IncludedFiles_;
 213         /** Buffer of the file being processed.
 214          *  This may be a child buffer of the to-be-exported file and
 215          *  therefore may not be the buffer that belongs to params_.
 216          *  Only needed by InsetInclude::validate().
 217          */
 218         Buffer const * buffer_;
 219         ///
 220         BufferParams const & params_;
 221         /** Some insets need to know details about the to-be-produced file
 222          *  in validate().
 223          */
 224         OutputParams const & runparams_;
 225         ///
 226         bool in_float_;
 227         ///
 228         bool in_deleted_inset_;
 229         ///
 230         docstring htmltitle_;
 231         ///
 232         std::string savenote_env_;
 233 };
 234
 235
 236 } // namespace lyx
 237
 238 #endif