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 std::string
const getMacros() const;
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 /// The sgml definitions needed by the document (docbook)
62 docstring
const getLyXSGMLEntities() const;
63 /// The SGML Required to include the files added with includeFile();
64 docstring
const getIncludedFiles(std::string
const & fname
) const;
65 /// Include a file for use with the SGML entities
66 void includeFile(docstring
const & key
, std::string
const & name
);
67 /// The float definitions.
68 void getFloatDefinitions(std::ostream
& os
) const;
69 /// Print requirements to lyxerr
70 void showStruct() const;
72 void addPreambleSnippet(std::string
const &);
73 /// Add a feature name requirements
74 void require(std::string
const & name
);
75 /// Add a set of feature names requirements
76 void require(std::set
<std::string
> const & names
);
77 /// Which of the required packages are installed?
78 static void getAvailable();
79 /// Is the (required) package available?
80 static bool isAvailable(std::string
const & name
);
81 /// Has the package been required?
82 bool isRequired(std::string
const & name
) const;
83 /* Is it necessary to load the package? This is true if
84 isRequired is true and the feature is not provided by the
87 bool mustProvide(std::string
const & name
) const;
89 void useFloat(std::string
const & name
, bool subfloat
= false);
91 void useLanguage(Language
const *);
93 bool hasLanguages() const;
95 std::string
getLanguages() const;
97 std::set
<std::string
> getEncodingSet(std::string
const & doc_encoding
) const;
99 void useLayout(docstring
const & lyt
);
101 Buffer
const & buffer() const;
103 void setBuffer(Buffer
const &);
105 BufferParams
const & bufferParams() const;
106 /// the return value is dependent upon both LyXRC and LaTeXFeatures.
107 bool useBabel() const;
108 /// are we in a float?
109 bool inFloat() const { return in_float_
; }
110 /// are we in a float?
111 void inFloat(bool const b
) { in_float_
= b
; }
112 /// Runparams that will be used for exporting this file.
113 OutputParams
const & runparams() const { return runparams_
; }
116 std::list
<docstring
> usedLayouts_
;
118 /// The features that are needed by the document
119 typedef std::set
<std::string
> Features
;
122 /// Static preamble bits from the external material insets
123 typedef std::list
<std::string
> SnippetList
;
125 SnippetList preamble_snippets_
;
126 /// The available (required) packages
127 typedef std::set
<std::string
> Packages
;
129 static Packages packages_
;
131 typedef std::set
<Language
const *> LanguageList
;
132 /// used languages (only those that are supported by babel)
133 LanguageList UsedLanguages_
;
135 typedef std::map
<std::string
, bool> UsedFloats
;
137 UsedFloats usedFloats_
;
139 typedef std::map
<docstring
, std::string
> FileMap
;
141 FileMap IncludedFiles_
;
142 /** Buffer of the file being processed.
143 * This may be a child buffer of the to-be-exported file and
144 * therefore may not be the buffer that belongs to params_.
145 * Only needed by InsetInclude::validate().
147 Buffer
const * buffer_
;
149 BufferParams
const & params_
;
150 /** Some insets need to know details about the to-be-produced file
153 OutputParams
const & runparams_
;