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         ///
  47         LaTeXFeatures(Buffer const &, BufferParams const &,
  48                       OutputParams const &);
  49         /// The color packages
  50         std::string const getColorOptions() const;
  51         /// The packages needed by the document
  52         std::string const getPackages() const;
  53         /// The macros definitions needed by the document
  54         docstring const getMacros() const;
  55         ///
  56         std::string const getBabelOptions() const;
  57         /// The definitions needed by the document's textclass
  58         docstring const getTClassPreamble() const;
  59         /// The language dependent definitions needed by the document's textclass
  60         docstring const getTClassI18nPreamble(bool use_babel) const;
  61         ///
  62         docstring const getTClassHTMLStyles() const;
  63         ///
  64         docstring const getTClassHTMLPreamble() const;
  65         /// The sgml definitions needed by the document (docbook)
  66         docstring const getLyXSGMLEntities() const;
  67         /// The SGML Required to include the files added with includeFile();
  68         docstring const getIncludedFiles(std::string const & fname) const;
  69         /// Include a file for use with the SGML entities
  70         void includeFile(docstring const & key, std::string const & name);
  71         /// The float definitions.
  72         void getFloatDefinitions(odocstream & os) const;
  73         /// Print requirements to lyxerr
  74         void showStruct() const;
  75         ///
  76         void addPreambleSnippet(std::string const &);
  77         ///
  78         std::string getPreambleSnippets() const;
  79         /// Add a feature name requirements
  80         void require(std::string const & name);
  81         /// Add a set of feature names requirements
  82         void require(std::set<std::string> const & names);
  83         /// Which of the required packages are installed?
  84         static void getAvailable();
  85         /// Is the (required) package available?
  86         static bool isAvailable(std::string const & name);
  87         /// Has the package been required?
  88         bool isRequired(std::string const & name) const;
  89         /* Is it necessary to load the package? This is true if
  90            isRequired is true and the feature is not provided by the
  91            textclass.
  92         */
  93         bool mustProvide(std::string const & name) const;
  94         ///
  95         void useFloat(std::string const & name, bool subfloat = false);
  96         ///
  97         void useLanguage(Language const *);
  98         ///
  99         bool hasLanguages() const;
 100         ///
 101         std::string getLanguages() const;
 102         ///
 103         std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
 104         ///
 105         void useLayout(docstring const & lyt);
 106         ///
 107         void useInsetLayout(InsetLayout const & lay);
 108         ///
 109         Buffer const & buffer() const;
 110         ///
 111         void setBuffer(Buffer const &);
 112         ///
 113         BufferParams const & bufferParams() const;
 114         /// the return value is dependent upon both LyXRC and LaTeXFeatures.
 115         bool useBabel() const;
 116         /// are we in a float?
 117         bool inFloat() const { return in_float_; }
 118         /// are we in a float?
 119         void inFloat(bool const b) { in_float_ = b; }
 120         /// Runparams that will be used for exporting this file.
 121         OutputParams const & runparams() const { return runparams_; }
 122         ///
 123         void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
 124         ///
 125         docstring const & htmlTitle() const { return htmltitle_; }
 126
 127 private:
 128         ///
 129         std::list<docstring> usedLayouts_;
 130         ///
 131         std::list<docstring> usedInsetLayouts_;
 132         /// The features that are needed by the document
 133         typedef std::set<std::string> Features;
 134         ///
 135         Features features_;
 136         /// Static preamble bits, from external templates, or anywhere else
 137         typedef std::list<std::string> SnippetList;
 138         ///
 139         SnippetList preamble_snippets_;
 140         /// The available (required) packages
 141         typedef std::set<std::string> Packages;
 142         ///
 143         static Packages packages_;
 144         ///
 145         typedef std::set<Language const *> LanguageList;
 146         /// used languages (only those that are supported by babel)
 147         LanguageList UsedLanguages_;
 148         ///
 149         typedef std::map<std::string, bool> UsedFloats;
 150         ///
 151         UsedFloats usedFloats_;
 152         ///
 153         typedef std::map<docstring, std::string> FileMap;
 154         ///
 155         FileMap IncludedFiles_;
 156         /** Buffer of the file being processed.
 157          *  This may be a child buffer of the to-be-exported file and
 158          *  therefore may not be the buffer that belongs to params_.
 159          *  Only needed by InsetInclude::validate().
 160          */
 161         Buffer const * buffer_;
 162         ///
 163         BufferParams const & params_;
 164         /** Some insets need to know details about the to-be-produced file
 165          *  in validate().
 166          */
 167         OutputParams const & runparams_;
 168         ///
 169         bool in_float_;
 170         ///
 171         docstring htmltitle_;
 172 };
 173
 174
 175 } // namespace lyx
 176
 177 #endif