3 * \file LaTeXFeatures.h
4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
13 #ifndef LATEXFEATURES_H
14 #define LATEXFEATURES_H
16 #include "OutputParams.h"
17 #include "support/docstring.h"
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).
35 * i.e require("amssymb")
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
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 /// Extra preamble code before babel is called
56 std::string const getBabelPresettings() const;
57 /// Extra preamble code after babel is called
58 std::string const getBabelPostsettings() const;
59 /// Do we need to pass the languages to babel directly?
60 bool needBabelLangOptions() const;
61 /// The definitions needed by the document's textclass
62 docstring const getTClassPreamble() const;
63 /// The language dependent definitions needed by the document's textclass
64 docstring const getTClassI18nPreamble(bool use_babel) const;
66 docstring const getTClassHTMLStyles() const;
68 docstring const getTClassHTMLPreamble() const;
69 /// The sgml definitions needed by the document (docbook)
70 docstring const getLyXSGMLEntities() const;
71 /// The SGML Required to include the files added with includeFile();
72 docstring const getIncludedFiles(std::string const & fname) const;
73 /// Include a file for use with the SGML entities
74 void includeFile(docstring const & key, std::string const & name);
75 /// The float definitions.
76 void getFloatDefinitions(odocstream & os) const;
77 /// Print requirements to lyxerr
78 void showStruct() const;
80 void addPreambleSnippet(std::string const &);
82 std::string getPreambleSnippets() const;
83 /// Add a feature name requirements
84 void require(std::string const & name);
85 /// Add a set of feature names requirements
86 void require(std::set<std::string> const & names);
87 /// Which of the required packages are installed?
88 static void getAvailable();
89 /// Is the (required) package available?
90 static bool isAvailable(std::string const & name);
91 /// Has the package been required?
92 bool isRequired(std::string const & name) const;
93 /* Is it necessary to load the package? This is true if
94 isRequired is true and the feature is not provided by the
97 bool mustProvide(std::string const & name) const;
99 void useFloat(std::string const & name, bool subfloat = false);
101 void useLanguage(Language const *);
103 bool hasLanguages() const;
104 /// check if all used languages are supported by polyglossia
105 bool hasPolyglossiaLanguages() const;
107 std::string getLanguages() const;
109 std::map<std::string, std::string> getPolyglossiaLanguages() const;
111 std::set<std::string> getEncodingSet(std::string const & doc_encoding) const;
113 void useLayout(docstring const & lyt);
115 void useInsetLayout(InsetLayout const & lay);
117 Buffer const & buffer() const;
119 void setBuffer(Buffer const &);
121 BufferParams const & bufferParams() const;
122 /// the return value is dependent upon both LyXRC and LaTeXFeatures.
123 bool useBabel() const;
125 bool usePolyglossia() const;
126 /// are we in a float?
127 bool inFloat() const { return in_float_; }
128 /// are we in a float?
129 void inFloat(bool const b) { in_float_ = b; }
130 /// Runparams that will be used for exporting this file.
131 OutputParams const & runparams() const { return runparams_; }
133 void setHTMLTitle(docstring const & t) { htmltitle_ = t; }
135 docstring const & htmlTitle() const { return htmltitle_; }
139 std::list<docstring> usedLayouts_;
141 std::list<docstring> usedInsetLayouts_;
142 /// The features that are needed by the document
143 typedef std::set<std::string> Features;
146 /// Static preamble bits, from external templates, or anywhere else
147 typedef std::list<std::string> SnippetList;
149 SnippetList preamble_snippets_;
150 /// The available (required) packages
151 typedef std::set<std::string> Packages;
153 static Packages packages_;
155 typedef std::set<Language const *> LanguageList;
156 /// used languages (only those that are supported by babel)
157 LanguageList UsedLanguages_;
159 typedef std::map<std::string, bool> UsedFloats;
161 UsedFloats usedFloats_;
163 typedef std::map<docstring, std::string> FileMap;
165 FileMap IncludedFiles_;
166 /** Buffer of the file being processed.
167 * This may be a child buffer of the to-be-exported file and
168 * therefore may not be the buffer that belongs to params_.
169 * Only needed by InsetInclude::validate().
171 Buffer const * buffer_;
173 BufferParams const & params_;
174 /** Some insets need to know details about the to-be-produced file
177 OutputParams const & runparams_;
181 docstring htmltitle_;