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
20 #include "DocumentClassPtr.h"
22 #include "LayoutModuleList.h"
23 #include "OutputParams.h"
26 #include "insets/InsetQuotes.h"
28 #include "support/copied_ptr.h"
35 namespace support { class FileName; }
45 class LayoutFileIndex;
52 /** Buffer parameters.
53 * This class contains all the parameters for this buffer's use. Some
54 * work needs to be done on this class to make it nice. Now everything
60 enum ParagraphSeparation {
62 ParagraphIndentSeparation,
64 ParagraphSkipSeparation
69 /// get l10n translated to the buffers language
70 docstring B_(std::string const & l10n) const;
72 /// read a header token, if unrecognised, return it or an unknown class name
73 std::string readToken(Lexer & lex,
74 std::string const & token, ///< token to read.
75 support::FileName const & filepath);
78 void writeFile(std::ostream &, Buffer const *) const;
80 /// check what features are implied by the buffer parameters.
81 void validate(LaTeXFeatures &) const;
83 /** \returns true if the babel package is used (interrogates
84 * the BufferParams, a LyXRC variable, and the document class).
85 * This returned value can then be passed to the insets...
87 bool writeLaTeX(otexstream &, LaTeXFeatures &,
88 support::FileName const &) const;
91 void useClassDefaults();
93 bool hasClassDefaults() const;
96 Length const & getParIndent() const;
98 void setParIndent(Length const & indent);
100 VSpace const & getDefSkip() const;
102 void setDefSkip(VSpace const & vs);
105 Length const & getMathIndent() const;
107 void setMathIndent(Length const & indent);
109 /// Whether formulas are indented
113 /// number formulas before them
114 bool math_number_before;
116 /** Whether paragraphs are separated by using a indent like in
117 * articles or by using a little skip like in letters.
119 ParagraphSeparation paragraph_separation;
121 InsetQuotesParams::QuoteStyle quotes_style;
125 std::string fontsize;
126 /// Get the LayoutFile this document is using.
127 LayoutFile const * baseClass() const;
129 LayoutFileIndex const & baseClassID() const;
130 /// Set the LyX layout file this document is using.
131 /// NOTE: This does not call makeDocumentClass() to update the local
132 /// DocumentClass. That needs to be done manually.
133 /// \param classname: the name of the layout file
134 bool setBaseClass(std::string const & classname);
135 /// Adds the module information to the baseClass information to
136 /// create our local DocumentClass.
137 /// NOTE: This should NEVER be called externally unless one immediately goes
138 /// on to class BufferView::updateDocumentClass(). The exception, of course,
139 /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
140 /// the parameters from the active Buffer.
141 void makeDocumentClass(bool const clone = false);
142 /// Returns the DocumentClass currently in use: the BaseClass as modified
144 DocumentClass const & documentClass() const;
145 /// \return A pointer to the DocumentClass currently in use: the BaseClass
146 /// as modified by modules.
147 DocumentClassConstPtr documentClassPtr() const;
148 /// This bypasses the baseClass and sets the textClass directly.
149 /// Should be called with care and would be better not being here,
150 /// but it seems to be needed by CutAndPaste::putClipboard().
151 void setDocumentClass(DocumentClassConstPtr);
152 /// List of modules in use
153 LayoutModuleList const & getModules() const { return layout_modules_; }
154 /// List of default modules the user has removed
155 std::list<std::string> const & getRemovedModules() const
156 { return removed_modules_; }
158 /// Add a module to the list of modules in use. This checks only that the
159 /// module is not already in the list, so use layoutModuleCanBeAdeed first
160 /// if you want to check for compatibility.
161 /// \return true if module was successfully added.
162 bool addLayoutModule(std::string const & modName);
163 /// checks to make sure module's requriements are satisfied, that it does
164 /// not conflict with already-present modules, isn't already loaded, etc.
165 bool layoutModuleCanBeAdded(std::string const & modName) const;
166 /// same, but for citaton modules.
167 bool citationModuleCanBeAdded(std::string const & modName) const;
169 void addRemovedModule(std::string const & modName)
170 { removed_modules_.push_back(modName); }
172 void clearLayoutModules() { layout_modules_.clear(); }
173 /// Clear the removed module list
174 void clearRemovedModules() { removed_modules_.clear(); }
175 /// Get the local layouts
176 docstring getLocalLayout(bool forced) const;
177 /// Set the local layouts
178 void setLocalLayout(docstring const & layout, bool forced);
180 /// returns \c true if the buffer contains a LaTeX document
181 bool isLatex() const;
182 /// returns \c true if the buffer contains a DocBook document
183 bool isDocBook() const;
184 /// returns \c true if the buffer contains a Wed document
185 bool isLiterate() const;
187 /// return the format of the buffer on a string
188 std::string bufferFormat() const;
189 /// return the default output format of the current backend
190 std::string getDefaultOutputFormat() const;
191 /// return the output flavor of \p format or the default
192 OutputParams::FLAVOR getOutputFlavor(
193 std::string const & format = std::string()) const;
195 bool isExportable(std::string const & format, bool need_viewable) const;
197 std::vector<const Format *> const & exportableFormats(bool only_viewable) const;
198 /// the backends appropriate for use with this document.
199 /// so, e.g., latex is excluded , if we're using non-TeX fonts
200 std::vector<std::string> backends() const;
202 /// List of included children (for includeonly)
203 std::list<std::string> const & getIncludedChildren() const
204 { return included_children_; }
206 void addIncludedChildren(std::string const & child)
207 { included_children_.push_back(child); }
208 /// Clear the list of included children
209 void clearIncludedChildren() { included_children_.clear(); }
211 /// update aux files of unincluded children (with \includeonly)
212 bool maintain_unincluded_children;
214 /// returns the main font for the buffer (document)
215 Font const getFont() const;
217 /// translate quote style string to enum value
218 InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
220 /* these are for the PaperLayout */
222 PAPER_SIZE papersize;
224 PAPER_ORIENTATION orientation;
225 /// use custom margins
228 std::string paperwidth;
230 std::string paperheight;
232 std::string leftmargin;
234 std::string topmargin;
236 std::string rightmargin;
238 std::string bottommargin;
240 std::string headheight;
244 std::string footskip;
246 std::string columnsep;
248 /* some LaTeX options */
249 /// The graphics driver
250 std::string graphics_driver;
251 /// The default output format
252 std::string default_output_format;
253 /// customized bibliography processor
254 std::string bibtex_command;
255 /// customized index processor
256 std::string index_command;
257 /// font encoding(s) requested for this document
259 /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
260 std::string fonts_roman[2];
262 std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
263 /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
264 std::string fonts_sans[2];
266 std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
267 /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
268 std::string fonts_typewriter[2];
270 std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
271 /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
272 std::string fonts_math[2];
274 std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
275 /// the default family (rm, sf, tt)
276 std::string fonts_default_family;
277 /// use the fonts of the OS (OpenType, True Type) directly
279 /// use expert Small Caps
280 bool fonts_expert_sc;
281 /// use Old Style Figures
282 bool fonts_old_figures;
283 /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
284 int fonts_sans_scale[2];
285 /// the scale factor of the sf font
286 int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
287 /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
288 int fonts_typewriter_scale[2];
289 /// the scale factor of the tt font
290 int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
291 /// the font used by the CJK command
292 std::string fonts_cjk;
293 /// use LaTeX microtype package
295 /// use font ligatures for en- and em-dashes
296 bool use_dash_ligatures;
299 Spacing const & spacing() const;
305 Language const * language;
307 std::string lang_package;
309 BranchList & branchlist();
310 BranchList const & branchlist() const;
312 IndicesList & indiceslist();
313 IndicesList const & indiceslist() const;
315 * The LyX name of the input encoding for LaTeX. This can be one of
316 * - \c auto: find out the input encoding from the used languages
317 * - \c default: ditto
318 * - any encoding defined in the file lib/encodings
319 * The encoding of the LyX file is always utf8 and has nothing to
320 * do with this setting.
321 * The difference between \c auto and \c default is that \c auto also
322 * causes loading of the inputenc package, while \c default does not.
323 * \c default will not work unless the user takes additional measures
324 * (such as using special environments like the CJK environment from
326 * \c default can be seen as an unspecified 8bit encoding, since LyX
327 * does not interpret it in any way apart from display on screen.
329 std::string inputenc;
330 /// The main encoding used by this buffer for LaTeX output.
331 /// Individual pieces of text can use different encodings.
332 /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
333 /// instead of the value returned by this function.
334 Encoding const & encoding() const;
341 /// use the class options defined in the layout?
342 bool use_default_options;
348 std::string float_placement;
350 unsigned int columns;
353 /// parameters for the listings package
354 std::string listings_params;
358 std::string pagestyle;
360 RGBColor backgroundcolor;
362 bool isbackgroundcolor;
368 RGBColor notefontcolor;
371 /// \param index should lie in the range 0 <= \c index <= 3.
372 Bullet & temp_bullet(size_type index);
373 Bullet const & temp_bullet(size_type index) const;
374 /// \param index should lie in the range 0 <= \c index <= 3.
375 Bullet & user_defined_bullet(size_type index);
376 Bullet const & user_defined_bullet(size_type index) const;
378 /// Whether to load a package such as amsmath or esint.
379 /// The enum values must not be changed (file format!)
381 /// Don't load the package. For experts only.
383 /// Load the package if needed (recommended)
385 /// Always load the package (e.g. if the document contains
386 /// some ERT that needs the package)
389 /// Whether to load a package such as amsmath or esint.
390 Package use_package(std::string const & p) const;
391 /// Set whether to load a package such as amsmath or esint.
392 void use_package(std::string const & p, Package u);
393 /// All packages that can be switched on or off
394 static std::map<std::string, std::string> const & auto_packages();
395 /// Do we use the bibtopic package?
396 bool useBibtopic() const;
397 /// Split bibliography?
398 bool splitbib() const { return use_bibtopic; }
399 /// Set split bibliography
400 void splitbib(bool const b) { use_bibtopic = b; }
401 /// Do we have multiple bibliographies (by chapter etc.)?
402 std::string multibib;
405 /// Save transient properties?
406 bool save_transient_properties;
407 /// revision tracking for this buffer ? (this is a transient property)
409 /** This param decides whether change tracking marks should be used
410 * in output (irrespective of how these marks are actually defined;
411 * for instance, they may differ for DVI and PDF generation)
412 * This is a transient property.
418 /// the author list for the document
419 AuthorList & authors();
420 AuthorList const & authors() const;
421 void addAuthor(Author a);
423 /// map of the file's author IDs to AuthorList indexes
424 typedef std::map<int, int> AuthorMap;
425 AuthorMap author_map_;
427 /// the buffer's active font encoding
428 std::string const main_font_encoding() const;
429 /// all font encodings requested by the prefs/document/main language.
430 /// This does NOT include font encodings required by secondary languages
431 std::vector<std::string> const font_encodings() const;
434 std::string const dvips_options() const;
435 /** The return value of paperSizeName() depends on the
436 * purpose for which the paper size is needed, since they
437 * support different subsets of paper sizes.
439 enum PapersizePurpose {
448 std::string paperSizeName(PapersizePurpose purpose) const;
449 /// set up if and how babel is called
450 std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
451 /// return supported drivers for specific packages
452 docstring getGraphicsDriver(std::string const & package) const;
453 /// handle inputenc etc.
454 void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) const;
456 std::string const parseFontName(std::string const & name) const;
457 /// set up the document fonts
458 std::string const loadFonts(LaTeXFeatures & features) const;
460 /// the cite engine modules
461 LayoutModuleList const & citeEngine() const
462 { return cite_engine_; }
463 /// the type of cite engine (authoryear or numerical)
464 CiteEngineType const & citeEngineType() const
465 { return cite_engine_type_; }
466 /// add the module to the cite engine modules
467 bool addCiteEngine(std::string const &);
468 /// add the modules to the cite engine modules
469 bool addCiteEngine(std::vector<std::string> const &);
470 /// clear the list of cite engine modules
471 void clearCiteEngine() { cite_engine_.clear(); }
472 /// set the cite engine module
473 void setCiteEngine(std::string const &);
474 /// set the cite engine modules
475 void setCiteEngine(std::vector<std::string> const &);
476 /// set the cite engine type
477 void setCiteEngineType(CiteEngineType const & engine_type)
478 { cite_engine_type_ = engine_type; }
480 /// the available citation commands
481 std::vector<std::string> citeCommands() const;
482 /// the available citation styles
483 std::vector<CitationStyle> citeStyles() const;
485 /// Return the actual bibtex command (lyxrc or buffer param)
486 std::string const bibtexCommand() const;
488 /// Are we using biblatex?
489 bool useBiblatex() const;
491 /// Set the default BibTeX style file for the document
492 void setDefaultBiblioStyle(std::string const & s){ biblio_style = s; }
493 /// Get the default BibTeX style file from the TextClass
494 std::string const & defaultBiblioStyle() const;
495 /// whether the BibTeX style supports full author lists
496 bool const & fullAuthorList() const;
497 /// Check if a citation style is an alias to another style
498 std::string getCiteAlias(std::string const & s) const;
500 /// Options of the bibiography package
501 std::string biblio_opts;
502 /// The biblatex bibliography style
503 std::string biblatex_bibstyle;
504 /// The biblatex citation style
505 std::string biblatex_citestyle;
507 /// options for pdf output
508 PDFOptions & pdfoptions();
509 PDFOptions const & pdfoptions() const;
511 // do not change these values. we rely upon them.
518 /// what to use for math output. present choices are above
519 MathOutput html_math_output;
520 /// whether to attempt to be XHTML 1.1 compliant or instead be
521 /// a little more mellow
524 double html_math_img_scale;
526 double display_pixel_ratio;
528 std::string html_latex_start;
530 std::string html_latex_end;
532 bool html_css_as_file;
533 /// generate output usable for reverse/forward search
535 /// custom LaTeX macro from user instead our own
536 std::string output_sync_macro;
537 /// use refstyle? or prettyref?
540 /// Return true if language could be set to lang,
541 /// otherwise return false and do not change language
542 bool setLanguage(std::string const & lang);
544 void invalidateConverterCache() const;
548 void readPreamble(Lexer &);
550 void readLocalLayout(Lexer &, bool);
552 void readLanguage(Lexer &);
554 void readGraphicsDriver(Lexer &);
556 void readBullets(Lexer &);
558 void readBulletsLaTeX(Lexer &);
560 void readModules(Lexer &);
562 void readRemovedModules(Lexer &);
564 void readIncludeonly(Lexer &);
565 /// A cache for the default flavors
566 typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
568 mutable DefaultFlavorCache default_flavors_;
569 /// the cite engine modules
570 LayoutModuleList cite_engine_;
571 /// the type of cite engine (authoryear or numerical)
572 CiteEngineType cite_engine_type_;
573 /// the default BibTeX style file for the document
574 std::string biblio_style;
575 /// Split bibliography?
578 DocumentClassPtr doc_class_;
580 LayoutModuleList layout_modules_;
581 /// this is for modules that are required by the document class but that
582 /// the user has chosen not to use
583 std::list<std::string> removed_modules_;
584 /// The local layouts without the forced ones
585 docstring local_layout_;
586 /// Forced local layouts only for reading (use getLocalLayout() instead)
587 docstring forced_local_layout_;
589 /// the list of included children (for includeonly)
590 std::list<std::string> included_children_;
592 typedef std::map<std::string, Package> PackageMap;
593 /** Whether and how to load packages like amsmath, esint, mhchem,
594 * mathdots, stackrel, stmaryrd and undertilde.
596 PackageMap use_packages;
598 /** Use the Pimpl idiom to hide those member variables that would otherwise
599 * drag in other header files.
604 static Impl * clone(Impl const *);
605 static void destroy(Impl *);
607 support::copied_ptr<Impl, MemoryTraits> pimpl_;