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
  31 /** The packages and commands that a buffer needs. This class
  32  *  contains a list<string>.  Each of the LaTeX packages that a buffer needs
  33  *  should be added with void require(string const & name).
  34  *
  35  *  i.e require("amssymb")
  36  *
  37  *  To add support you should only need to require() the package name as
  38  *  packages which don't have special requirements are handled automatically.
  39  *  If your new package does need special consideration you'll need to alter
  40  *  string const getPackages() const;
  41  *  Remember to update the validate function in Buffer.cpp and Paragraph.cpp
  42  *  when you do so.
  43  */
  44 class LaTeXFeatures {
  45 public:
  46         /// Which Language package do we use?
  47         enum LangPackage {
  48                 LANG_PACK_NONE,
  49                 LANG_PACK_BABEL,
  50                 LANG_PACK_POLYGLOSSIA,
  51                 LANG_PACK_CUSTOM
  52         };
  53         ///
  54         LaTeXFeatures(Buffer const &, BufferParams const &,
  55                       OutputParams const &);
  56         /// The color packages
  57         std::string const getColorOptions() const;
  58         /// The packages needed by the document
  59         std::string const getPackages() const;
  60         /// The macros definitions needed by the document
  61         docstring const getMacros() const;
  62         /// Extra preamble code before babel is called
  63         std::string const getBabelPresettings() const;
  64         /// Extra preamble code after babel is called
  65         std::string const getBabelPostsettings() const;
  66         /// Do we need to pass the languages to babel directly?
  67         bool needBabelLangOptions() const;
  68         /// Load AMS packages when appropriate
  69         std::string const loadAMSPackages() const;
  70         /// The definitions needed by the document's textclass
  71         docstring const getTClassPreamble() const;
  72         /// The language dependent definitions needed by the document's textclass
  73         docstring const getTClassI18nPreamble(bool use_babel, bool use_polyglossia) const;
  74         ///
  75         docstring const getTClassHTMLStyles() const;
  76         ///
  77         docstring const getTClassHTMLPreamble() const;
  78         /// The sgml definitions needed by the document (docbook)
  79         docstring const getLyXSGMLEntities() const;
  80         /// The SGML Required to include the files added with includeFile();
  81         docstring const getIncludedFiles(std::string const & fname) const;
  82         /// Include a file for use with the SGML entities
  83         void includeFile(docstring const & key, std::string const & name);
  84         /// The float definitions.
  85         void getFloatDefinitions(odocstream & os) const;
  86         /// Print requirements to lyxerr
  87         void showStruct() const;
  88         ///
  89         void addPreambleSnippet(std::string const &);
  90         ///
  91         std::string getPreambleSnippets() const;
  92         ///
  93         void addCSSSnippet(std::string const &);
  94         ///
  95         std::string getCSSSnippets() const;
  96         /// Add a feature name requirements
  97         void require(std::string const & name);
  98         /// Add a set of feature names requirements
  99         void require(std::set<std::string> const & names);
 100         /// Is the (required) package available?
 101         static bool isAvailable(std::string const & name);
 102         /// Has the package been required?
 103         bool isRequired(std::string const & name) const;
 104         /** Is it necessary to load the package? This is true if
 105             isRequired is true and the feature is not provided by the
 106             textclass.
 107         */
 108         bool mustProvide(std::string const & name) const;
 109         ///
 110         void useFloat(std::string const & name, bool subfloat = false);
 111         ///
 112         void useLanguage(Language const *);
 113         ///
 114         bool hasLanguages() const;
 115         /// check if all used languages are supported by polyglossia
 116         bool hasOnlyPolyglossiaLanguages() const;
 117         /// check if a language is supported only by polyglossia
 118         bool hasPolyglossiaExclusiveLanguages() const;
 119         ///
 120         std::string getBabelLanguages() const;
 121         ///
 122         std::map<std::string, std::string> getPolyglossiaLanguages() const;
 123         ///
 124         std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
 125         ///
 126         void useLayout(docstring const & lyt);
 127         ///
 128         void useInsetLayout(InsetLayout const & lay);
 129         ///
 130         Buffer const & buffer() const;
 131         ///
 132         void setBuffer(Buffer const &);
 133         ///
 134         BufferParams const & bufferParams() const;
 135         /** Which language package do we require? \p englishbabel determines
 136          *  if we require babel even if English is the only language.
 137          */
 138         LangPackage langPackage(bool englishbabel = false) const;
 139         /// Convenience function to test if we use babel
 140         bool useBabel(bool englishbabel = false) const { return langPackage(englishbabel) == LANG_PACK_BABEL; }
 141         /// Convenience function to test if we use polyglossia
 142         bool usePolyglossia() const { return langPackage() == LANG_PACK_POLYGLOSSIA; }
 143         /// are we in a float?
 144         bool inFloat() const { return in_float_; }
 145         /// are we in a float?
 146         void inFloat(bool const b) { in_float_ = b; }
 147         /// Runparams that will be used for exporting this file.
 148         OutputParams const & runparams() const { return runparams_; }
 149         /// Resolve alternatives like "esint|amsmath|wasysym"
 150         void resolveAlternatives();
 151         ///
 152         void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
 153         ///
 154         docstring const & htmlTitle() const { return htmltitle_; }
 155
 156 private:
 157         ///
 158         std::list<docstring> usedLayouts_;
 159         ///
 160         std::list<docstring> usedInsetLayouts_;
 161         /// The features that are needed by the document
 162         typedef std::set<std::string> Features;
 163         ///
 164         Features features_;
 165         /// Static preamble bits, from external templates, or anywhere else
 166         typedef std::list<std::string> SnippetList;
 167         ///
 168         SnippetList preamble_snippets_;
 169         ///
 170         SnippetList css_snippets_;
 171         ///
 172         typedef std::set<Language const *> LanguageList;
 173         /// used languages (only those that are supported by babel)
 174         LanguageList UsedLanguages_;
 175         ///
 176         typedef std::map<std::string, bool> UsedFloats;
 177         ///
 178         UsedFloats usedFloats_;
 179         ///
 180         typedef std::map<docstring, std::string> FileMap;
 181         ///
 182         FileMap IncludedFiles_;
 183         /** Buffer of the file being processed.
 184          *  This may be a child buffer of the to-be-exported file and
 185          *  therefore may not be the buffer that belongs to params_.
 186          *  Only needed by InsetInclude::validate().
 187          */
 188         Buffer const * buffer_;
 189         ///
 190         BufferParams const & params_;
 191         /** Some insets need to know details about the to-be-produced file
 192          *  in validate().
 193          */
 194         OutputParams const & runparams_;
 195         ///
 196         bool in_float_;
 197         ///
 198         docstring htmltitle_;
 199 };
 200
 201
 202 } // namespace lyx
 203
 204 #endif