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