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 #include <string>
  23
  24
  25 namespace lyx {
  26
  27 class Buffer;
  28 class BufferParams;
  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 packages needed by the document
  50         std::string const getPackages() const;
  51         /// The macros definitions needed by the document
  52         std::string const getMacros() const;
  53         ///
  54         std::string const getBabelOptions() const;
  55         /// The definitions needed by the document's textclass
  56         docstring const getTClassPreamble() const;
  57         /// The sgml definitions needed by the document (docbook)
  58         docstring const getLyXSGMLEntities() const;
  59         /// The SGML Required to include the files added with includeFile();
  60         docstring const getIncludedFiles(std::string const & fname) const;
  61         /// Include a file for use with the SGML entities
  62         void includeFile(docstring const & key, std::string const & name);
  63         /// The float definitions.
  64         void getFloatDefinitions(std::ostream & os) const;
  65         /// Print requirements to lyxerr
  66         void showStruct() const;
  67         ///
  68         void addPreambleSnippet(std::string const &);
  69         /// Provide a string name-space to the requirements
  70         void require(std::string const & name);
  71         /// Which of the required packages are installed?
  72         static void getAvailable();
  73         /// Is the (required) package available?
  74         static bool isAvailable(std::string const & name);
  75         /// Has the package been required?
  76         bool isRequired(std::string const & name) const;
  77         /* Is it necessary to load the package? This is true if
  78            isRequired is true and the feature is not provided by the
  79            textclass.
  80         */
  81         bool mustProvide(std::string const & name) const;
  82         ///
  83         void useFloat(std::string const & name);
  84         ///
  85         void useLanguage(Language const *);
  86         ///
  87         bool hasLanguages() const;
  88         ///
  89         std::string getLanguages() const;
  90         ///
  91         std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
  92         ///
  93         void useLayout(docstring const & lyt);
  94         ///
  95         Buffer const & buffer() const;
  96         ///
  97         void setBuffer(Buffer const &);
  98         ///
  99         BufferParams const & bufferParams() const;
 100         /// the return value is dependent upon both LyXRC and LaTeXFeatures.
 101         bool useBabel() const;
 102         /// Runparams that will be used for exporting this file.
 103         OutputParams const & runparams() const { return runparams_; }
 104
 105 private:
 106         std::list<docstring> usedLayouts_;
 107
 108         /// Static preamble bits from the external material insets
 109         typedef std::list<std::string> FeaturesList;
 110         ///
 111         FeaturesList features_;
 112         ///
 113         FeaturesList preamble_snippets_;
 114         /// The available (required) packages
 115         typedef std::list<std::string> PackagesList;
 116         ///
 117         static PackagesList packages_;
 118         ///
 119         typedef std::set<Language const *> LanguageList;
 120         /// used languages (only those that are supported by babel)
 121         LanguageList UsedLanguages_;
 122         ///
 123         typedef std::set<std::string> UsedFloats;
 124         ///
 125         UsedFloats usedFloats_;
 126         ///
 127         typedef std::map<docstring, std::string> FileMap;
 128         ///
 129         FileMap IncludedFiles_;
 130         /** Buffer of the file being processed.
 131          *  This may be a child buffer of the to-be-exported file and
 132          *  therefore may not be the buffer that belongs to params_.
 133          *  Only needed by InsetInclude::validate().
 134          */
 135         Buffer const * buffer_;
 136         ///
 137         BufferParams const & params_;
 138         /** Some insets need to know details about the to-be-produced file
 139          *  in validate().
 140          */
 141         OutputParams const & runparams_;
 142 };
 143
 144
 145 } // namespace lyx
 146
 147 #endif