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