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 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
15 #ifndef BUFFERPARAMS_H
16 #define BUFFERPARAMS_H
19 #include "BiblioInfo.h"
21 #include "TextClassPtr.h"
23 #include "insets/InsetQuotes.h"
25 #include "support/copied_ptr.h"
26 #include "support/types.h"
49 /** Buffer parameters.
50 * This class contains all the parameters for this buffer's use. Some
51 * work needs to be done on this class to make it nice. Now everything
67 /// get l10n translated to the buffers language
68 docstring const B_(std::string const & l10n) const;
70 /// read a header token, if unrecognised, return it or an unknown class name
71 std::string const readToken(Lexer & lex,
72 std::string const & token, ///< token to read.
73 support::FileName const & filepath); ///< where to look for local layout file.
76 void writeFile(std::ostream &) const;
78 /// check what features are implied by the buffer parameters.
79 void validate(LaTeXFeatures &) const;
81 /** \returns true if the babel package is used (interogates
82 * the BufferParams and a LyXRC variable).
83 * This returned value can then be passed to the insets...
85 bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
88 void useClassDefaults();
91 bool hasClassDefaults() const;
94 VSpace const & getDefSkip() const;
97 void setDefSkip(VSpace const & vs);
99 /** Whether paragraphs are separated by using a indent like in
100 * articles or by using a little skip like in letters.
102 PARSEP paragraph_separation;
104 InsetQuotes::quote_language quotes_language;
106 InsetQuotes::quote_times quotes_times;
108 std::string fontsize;
109 ///Get the LyX TextClass (that is, the layout file) this document is using.
110 textclass_type getBaseClass() const;
111 ///Set the LyX TextClass (that is, the layout file) this document is using.
112 ///NOTE This also calls makeTextClass(), to update the local
114 bool setBaseClass(textclass_type);
115 ///Returns the TextClass currently in use: the BaseClass as modified
117 TextClass const & getTextClass() const;
118 ///Returns a pointer to the TextClass currently in use: the BaseClass
119 ///as modified by modules. (See \file TextClassPtr.h for the typedef.)
120 TextClassPtr getTextClassPtr() const;
121 ///Set the LyX TextClass---layout file---this document is using.
122 ///This does NOT call makeTextClass() and so should be used with
123 ///care. This is most likely not what you want if you are operating on
124 ///BufferParams that are actually associatd with a Buffer. If, on the
125 ///other hand, you are using a temporary set of BufferParams---say, in
126 ///a controller, it may well be, since in that case the local TextClass
127 ///has nothing to do.
128 void setJustBaseClass(textclass_type);
129 /// This bypasses the baseClass and sets the textClass directly.
130 /// Should be called with care and would be better not being here,
131 /// but it seems to be needed by CutAndPaste::putClipboard().
132 void setTextClass(TextClassPtr);
133 /// List of modules in use
134 std::vector<std::string> const & getModules() const;
135 /// Add a module to the list of modules in use.
136 /// Returns true if module was successfully added.
137 bool addLayoutModule(std::string modName, bool makeClass = true);
138 /// Add a list of modules.
139 /// Returns true if all modules were successfully added.
140 bool addLayoutModules(std::vector<std::string>modNames);
142 void clearLayoutModules();
144 /// returns the main font for the buffer (document)
145 Font const getFont() const;
147 /* this are for the PaperLayout */
149 PAPER_SIZE papersize;
151 PAPER_ORIENTATION orientation;
152 /// use custom margins
155 std::string paperwidth;
157 std::string paperheight;
159 std::string leftmargin;
161 std::string topmargin;
163 std::string rightmargin;
165 std::string bottommargin;
167 std::string headheight;
171 std::string footskip;
173 /* some LaTeX options */
174 /// The graphics driver
175 std::string graphicsDriver;
177 std::string fontsRoman;
179 std::string fontsSans;
181 std::string fontsTypewriter;
182 /// the default family (rm, sf, tt)
183 std::string fontsDefaultFamily;
184 /// use expert Small Caps
186 /// use Old Style Figures
188 /// the scale factor of the sf font
190 /// the scale factor of the tt font
191 int fontsTypewriterScale;
194 Spacing const & spacing() const;
200 Language const * language;
202 BranchList & branchlist();
203 BranchList const & branchlist() const;
205 * The input encoding for LaTeX. This can be one of
206 * - \c auto: find out the input encoding from the used languages
207 * - \c default: ditto
208 * - any encoding supported by the inputenc package
209 * The encoding of the LyX file is always utf8 and has nothing to
210 * do with this setting.
211 * The difference between \c auto and \c default is that \c auto also
212 * causes loading of the inputenc package, while \c default does not.
213 * \c default will not work unless the user takes additional measures
214 * (such as using special environments like the CJK environment from
216 * \c default can be seen as an unspecified 8bit encoding, since LyX
217 * does not interpret it in any way apart from display on screen.
219 std::string inputenc;
220 /// The main encoding used by this buffer for LaTeX output.
221 /// Individual pieces of text can use different encodings.
222 Encoding const & encoding() const;
224 std::string preamble;
228 std::string float_placement;
230 unsigned int columns;
231 /// parameters for the listings package
232 std::string listings_params;
236 std::string pagestyle;
237 /// \param index should lie in the range 0 <= \c index <= 3.
238 Bullet & temp_bullet(size_type index);
239 Bullet const & temp_bullet(size_type index) const;
240 /// \param index should lie in the range 0 <= \c index <= 3.
241 Bullet & user_defined_bullet(size_type index);
242 Bullet const & user_defined_bullet(size_type index) const;
244 /// Whether to load a package such as amsmath or esint.
245 /// The enum values must not be changed (file format!)
247 /// Don't load the package. For experts only.
249 /// Load the package if needed (recommended)
251 /// Always load the package (e.g. if the document contains
252 /// some ERT that needs the package)
255 /// Whether and how to load amsmath
257 /// Whether and how to load esint
261 /// revision tracking for this buffer ?
263 /** This param decides whether change tracking marks should be used
264 * in output (irrespective of how these marks are actually defined;
265 * for instance, they may differ for DVI and PDF generation)
273 /// the author list for the document
274 AuthorList & authors();
275 AuthorList const & authors() const;
277 /// map of the file's author IDs to buffer author IDs
278 std::vector<unsigned int> author_map;
280 std::string const dvips_options() const;
282 std::string const paperSizeName() const;
283 /// set up if and how babel is called
284 std::string const babelCall(std::string const & lang_opts) const;
285 /// handle inputenc etc.
286 void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
287 TexRow & texrow) const;
288 /// set up the document fonts
289 std::string const loadFonts(std::string const & rm,
290 std::string const & sf, std::string const & tt,
291 bool const & sc, bool const & osf,
292 int const & sfscale, int const & ttscale) const;
294 /// get the appropriate cite engine (natbib handling)
295 biblio::CiteEngine getEngine() const;
298 void setCiteEngine(biblio::CiteEngine const);
300 /// options for pdf output
301 PDFOptions & pdfoptions();
302 PDFOptions const & pdfoptions() const;
306 void readPreamble(Lexer &);
308 void readLanguage(Lexer &);
310 void readGraphicsDriver(Lexer &);
312 void readBullets(Lexer &);
314 void readBulletsLaTeX(Lexer &);
316 void readModules(Lexer &);
317 /// Adds the module information to the baseClass information to
318 /// create our local TextClass.
319 void makeTextClass();
322 /// for use with natbib
323 biblio::CiteEngine cite_engine_;
324 /// the base TextClass associated with the document
325 textclass_type baseClass_;
326 /// the possibly modular TextClass actually in use
327 TextClassPtr textClass_;
329 typedef std::vector<std::string> LayoutModuleList;
331 LayoutModuleList layoutModules_;
333 /** Use the Pimpl idiom to hide those member variables that would otherwise
334 * drag in other header files.
339 static Impl * clone(Impl const *);
340 static void destroy(Impl *);
342 support::copied_ptr<Impl, MemoryTraits> pimpl_;