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 does not call makeTextClass() to update the local TextClass.
113 /// That needs to be done manually.
114 bool setBaseClass(textclass_type);
115 /// Adds the module information to the baseClass information to
116 /// create our local TextClass.
117 void makeTextClass();
118 /// Returns the TextClass currently in use: the BaseClass as modified
120 TextClass const & getTextClass() const;
121 /// Returns a pointer to the TextClass currently in use: the BaseClass
122 /// as modified by modules. (See \file TextClassPtr.h for the typedef.)
123 TextClassPtr getTextClassPtr() const;
124 /// This bypasses the baseClass and sets the textClass directly.
125 /// Should be called with care and would be better not being here,
126 /// but it seems to be needed by CutAndPaste::putClipboard().
127 void setTextClass(TextClassPtr);
128 /// List of modules in use
129 std::vector<std::string> const & getModules() const;
130 /// Add a module to the list of modules in use.
131 /// Returns true if module was successfully added.
132 /// The makeClass variable signals whether to call makeTextClass. This
133 /// need not be done if we know this isn't the final time through, or if
134 /// the BufferParams do not represent the parameters for an actual buffer
135 /// (as in GuiDocument).
136 bool addLayoutModule(std::string const & modName);
138 void clearLayoutModules();
140 /// returns the main font for the buffer (document)
141 Font const getFont() const;
143 /* this are for the PaperLayout */
145 PAPER_SIZE papersize;
147 PAPER_ORIENTATION orientation;
148 /// use custom margins
151 std::string paperwidth;
153 std::string paperheight;
155 std::string leftmargin;
157 std::string topmargin;
159 std::string rightmargin;
161 std::string bottommargin;
163 std::string headheight;
167 std::string footskip;
169 /* some LaTeX options */
170 /// The graphics driver
171 std::string graphicsDriver;
173 std::string fontsRoman;
175 std::string fontsSans;
177 std::string fontsTypewriter;
178 /// the default family (rm, sf, tt)
179 std::string fontsDefaultFamily;
180 /// use expert Small Caps
182 /// use Old Style Figures
184 /// the scale factor of the sf font
186 /// the scale factor of the tt font
187 int fontsTypewriterScale;
190 Spacing const & spacing() const;
196 Language const * language;
198 BranchList & branchlist();
199 BranchList const & branchlist() const;
201 * The input encoding for LaTeX. This can be one of
202 * - \c auto: find out the input encoding from the used languages
203 * - \c default: ditto
204 * - any encoding supported by the inputenc package
205 * The encoding of the LyX file is always utf8 and has nothing to
206 * do with this setting.
207 * The difference between \c auto and \c default is that \c auto also
208 * causes loading of the inputenc package, while \c default does not.
209 * \c default will not work unless the user takes additional measures
210 * (such as using special environments like the CJK environment from
212 * \c default can be seen as an unspecified 8bit encoding, since LyX
213 * does not interpret it in any way apart from display on screen.
215 std::string inputenc;
216 /// The main encoding used by this buffer for LaTeX output.
217 /// Individual pieces of text can use different encodings.
218 Encoding const & encoding() const;
220 std::string preamble;
224 std::string float_placement;
226 unsigned int columns;
227 /// parameters for the listings package
228 std::string listings_params;
232 std::string pagestyle;
233 /// \param index should lie in the range 0 <= \c index <= 3.
234 Bullet & temp_bullet(size_type index);
235 Bullet const & temp_bullet(size_type index) const;
236 /// \param index should lie in the range 0 <= \c index <= 3.
237 Bullet & user_defined_bullet(size_type index);
238 Bullet const & user_defined_bullet(size_type index) const;
240 /// Whether to load a package such as amsmath or esint.
241 /// The enum values must not be changed (file format!)
243 /// Don't load the package. For experts only.
245 /// Load the package if needed (recommended)
247 /// Always load the package (e.g. if the document contains
248 /// some ERT that needs the package)
251 /// Whether and how to load amsmath
253 /// Whether and how to load esint
257 /// revision tracking for this buffer ?
259 /** This param decides whether change tracking marks should be used
260 * in output (irrespective of how these marks are actually defined;
261 * for instance, they may differ for DVI and PDF generation)
269 /// the author list for the document
270 AuthorList & authors();
271 AuthorList const & authors() const;
273 /// map of the file's author IDs to buffer author IDs
274 std::vector<unsigned int> author_map;
276 std::string const dvips_options() const;
278 std::string const paperSizeName() const;
279 /// set up if and how babel is called
280 std::string const babelCall(std::string const & lang_opts) const;
281 /// handle inputenc etc.
282 void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
283 TexRow & texrow) const;
284 /// set up the document fonts
285 std::string const loadFonts(std::string const & rm,
286 std::string const & sf, std::string const & tt,
287 bool const & sc, bool const & osf,
288 int const & sfscale, int const & ttscale) const;
290 /// get the appropriate cite engine (natbib handling)
291 biblio::CiteEngine getEngine() const;
294 void setCiteEngine(biblio::CiteEngine const);
296 /// options for pdf output
297 PDFOptions & pdfoptions();
298 PDFOptions const & pdfoptions() const;
302 void readPreamble(Lexer &);
304 void readLanguage(Lexer &);
306 void readGraphicsDriver(Lexer &);
308 void readBullets(Lexer &);
310 void readBulletsLaTeX(Lexer &);
312 void readModules(Lexer &);
314 /// for use with natbib
315 biblio::CiteEngine cite_engine_;
316 /// the base TextClass associated with the document
317 textclass_type baseClass_;
318 /// the possibly modular TextClass actually in use
319 TextClassPtr textClass_;
321 typedef std::vector<std::string> LayoutModuleList;
323 LayoutModuleList layoutModules_;
325 /** Use the Pimpl idiom to hide those member variables that would otherwise
326 * drag in other header files.
331 static Impl * clone(Impl const *);
332 static void destroy(Impl *);
334 support::copied_ptr<Impl, MemoryTraits> pimpl_;