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 enum MathNumber { DEFAULT, LEFT, RIGHT };
114 /// number formulas on left/right/default
115 MathNumber math_numbering_side;
117 /// Convenience function for display: like math_number, but
118 /// DEFAULT is replaced by the best guess we have.
119 MathNumber getMathNumber() const;
121 /** Whether paragraphs are separated by using a indent like in
122 * articles or by using a little skip like in letters.
124 ParagraphSeparation paragraph_separation;
126 InsetQuotesParams::QuoteStyle quotes_style;
130 std::string fontsize;
131 /// Get the LayoutFile this document is using.
132 LayoutFile const * baseClass() const;
134 LayoutFileIndex const & baseClassID() const;
135 /// Set the LyX layout file this document is using.
136 /// NOTE: This does not call makeDocumentClass() to update the local
137 /// DocumentClass. That needs to be done manually.
138 /// \param classname: the name of the layout file
139 /// \param path: non-empty only for local layout files
140 bool setBaseClass(std::string const & classname,
141 std::string const & path = std::string());
142 /// Adds the module information to the baseClass information to
143 /// create our local DocumentClass.
144 /// NOTE: This should NEVER be called externally unless one immediately goes
145 /// on to class BufferView::updateDocumentClass(). The exception, of course,
146 /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
147 /// the parameters from the active Buffer.
148 void makeDocumentClass(bool const clone = false);
149 /// Returns the DocumentClass currently in use: the BaseClass as modified
151 DocumentClass const & documentClass() const;
152 /// \return A pointer to the DocumentClass currently in use: the BaseClass
153 /// as modified by modules.
154 DocumentClassConstPtr documentClassPtr() const;
155 /// This bypasses the baseClass and sets the textClass directly.
156 /// Should be called with care and would be better not being here,
157 /// but it seems to be needed by CutAndPaste::putClipboard().
158 void setDocumentClass(DocumentClassConstPtr);
159 /// List of modules in use
160 LayoutModuleList const & getModules() const { return layout_modules_; }
161 /// List of default modules the user has removed
162 std::list<std::string> const & getRemovedModules() const
163 { return removed_modules_; }
165 /// Add a module to the list of modules in use. This checks only that the
166 /// module is not already in the list, so use layoutModuleCanBeAdeed first
167 /// if you want to check for compatibility.
168 /// \return true if module was successfully added.
169 bool addLayoutModule(std::string const & modName);
170 /// checks to make sure module's requriements are satisfied, that it does
171 /// not conflict with already-present modules, isn't already loaded, etc.
172 bool layoutModuleCanBeAdded(std::string const & modName) const;
174 void addRemovedModule(std::string const & modName)
175 { removed_modules_.push_back(modName); }
177 void clearLayoutModules() { layout_modules_.clear(); }
178 /// Clear the removed module list
179 void clearRemovedModules() { removed_modules_.clear(); }
180 /// Get the local layouts
181 docstring getLocalLayout(bool forced) const;
182 /// Set the local layouts
183 void setLocalLayout(docstring const & layout, bool forced);
185 /// returns \c true if the buffer contains a LaTeX document
186 bool isLatex() const;
187 /// returns \c true if the buffer contains a DocBook document
188 bool isDocBook() const;
189 /// returns \c true if the buffer contains a Wed document
190 bool isLiterate() const;
192 /// return the format of the buffer on a string
193 std::string bufferFormat() const;
194 /// return the default output format of the current backend
195 std::string getDefaultOutputFormat() const;
196 /// return the output flavor of \p format or the default
197 OutputParams::FLAVOR getOutputFlavor(
198 std::string const & format = std::string()) const;
200 bool isExportable(std::string const & format, bool need_viewable) const;
202 std::vector<const Format *> const & exportableFormats(bool only_viewable) const;
203 /// the backends appropriate for use with this document.
204 /// so, e.g., latex is excluded , if we're using non-TeX fonts
205 std::vector<std::string> backends() const;
207 /// List of included children (for includeonly)
208 std::list<std::string> const & getIncludedChildren() const
209 { return included_children_; }
211 void addIncludedChildren(std::string const & child)
212 { included_children_.push_back(child); }
213 /// Clear the list of included children
214 void clearIncludedChildren() { included_children_.clear(); }
216 /// update aux files of unincluded children (with \includeonly)
217 bool maintain_unincluded_children;
219 /// returns the main font for the buffer (document)
220 Font const getFont() const;
222 /// translate quote style string to enum value
223 InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
225 /* these are for the PaperLayout */
227 PAPER_SIZE papersize;
229 PAPER_ORIENTATION orientation;
230 /// use custom margins
233 std::string paperwidth;
235 std::string paperheight;
237 std::string leftmargin;
239 std::string topmargin;
241 std::string rightmargin;
243 std::string bottommargin;
245 std::string headheight;
249 std::string footskip;
251 std::string columnsep;
253 /* some LaTeX options */
254 /// The graphics driver
255 std::string graphics_driver;
256 /// The default output format
257 std::string default_output_format;
258 /// customized bibliography processor
259 std::string bibtex_command;
260 /// customized index processor
261 std::string index_command;
262 /// font encoding(s) requested for this document
264 /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
265 std::string fonts_roman[2];
267 std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
268 /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
269 std::string fonts_sans[2];
271 std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
272 /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
273 std::string fonts_typewriter[2];
275 std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
276 /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
277 std::string fonts_math[2];
279 std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
280 /// the default family (rm, sf, tt)
281 std::string fonts_default_family;
282 /// use the fonts of the OS (OpenType, True Type) directly
284 /// use expert Small Caps
285 bool fonts_expert_sc;
286 /// use Old Style Figures
287 bool fonts_old_figures;
288 /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
289 int fonts_sans_scale[2];
290 /// the scale factor of the sf font
291 int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
292 /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
293 int fonts_typewriter_scale[2];
294 /// the scale factor of the tt font
295 int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
296 /// the font used by the CJK command
297 std::string fonts_cjk;
298 /// use LaTeX microtype package
300 /// use font ligatures for en- and em-dashes
301 bool use_dash_ligatures;
304 Spacing const & spacing() const;
310 Language const * language;
312 std::string lang_package;
314 BranchList & branchlist();
315 BranchList const & branchlist() const;
317 IndicesList & indiceslist();
318 IndicesList const & indiceslist() const;
320 * The LyX name of the input encoding for LaTeX. This can be one of
321 * - \c auto: find out the input encoding from the used languages
322 * - \c default: ditto
323 * - any encoding defined in the file lib/encodings
324 * The encoding of the LyX file is always utf8 and has nothing to
325 * do with this setting.
326 * The difference between \c auto and \c default is that \c auto also
327 * causes loading of the inputenc package, while \c default does not.
328 * \c default will not work unless the user takes additional measures
329 * (such as using special environments like the CJK environment from
331 * \c default can be seen as an unspecified 8bit encoding, since LyX
332 * does not interpret it in any way apart from display on screen.
334 std::string inputenc;
335 /// The main encoding used by this buffer for LaTeX output.
336 /// Individual pieces of text can use different encodings.
337 /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
338 /// instead of the value returned by this function.
339 Encoding const & encoding() const;
346 /// use the class options defined in the layout?
347 bool use_default_options;
353 std::string float_placement;
355 std::string float_alignment;
357 unsigned int columns;
360 /// parameters for the listings package
361 std::string listings_params;
365 std::string pagestyle;
367 RGBColor backgroundcolor;
369 bool isbackgroundcolor;
375 RGBColor notefontcolor;
378 /// \param index should lie in the range 0 <= \c index <= 3.
379 Bullet & temp_bullet(size_type index);
380 Bullet const & temp_bullet(size_type index) const;
381 /// \param index should lie in the range 0 <= \c index <= 3.
382 Bullet & user_defined_bullet(size_type index);
383 Bullet const & user_defined_bullet(size_type index) const;
385 /// Whether to load a package such as amsmath or esint.
386 /// The enum values must not be changed (file format!)
388 /// Don't load the package. For experts only.
390 /// Load the package if needed (recommended)
392 /// Always load the package (e.g. if the document contains
393 /// some ERT that needs the package)
396 /// Whether to load a package such as amsmath or esint.
397 Package use_package(std::string const & p) const;
398 /// Set whether to load a package such as amsmath or esint.
399 void use_package(std::string const & p, Package u);
400 /// All packages that can be switched on or off
401 static std::map<std::string, std::string> const & auto_packages();
402 /// Do we use the bibtopic package?
403 bool useBibtopic() const;
404 /// Split bibliography?
405 bool splitbib() const { return use_bibtopic; }
406 /// Set split bibliography
407 void splitbib(bool const b) { use_bibtopic = b; }
408 /// Do we have multiple bibliographies (by chapter etc.)?
409 std::string multibib;
412 /// Save transient properties?
413 bool save_transient_properties;
414 /// revision tracking for this buffer ? (this is a transient property)
416 /** This param decides whether change tracking marks should be used
417 * in output (irrespective of how these marks are actually defined;
418 * for instance, they may differ for DVI and PDF generation)
419 * This is a transient property.
425 /// the author list for the document
426 AuthorList & authors();
427 AuthorList const & authors() const;
428 void addAuthor(Author a);
430 /// map of the file's author IDs to AuthorList indexes
431 typedef std::map<int, int> AuthorMap;
432 AuthorMap author_map_;
434 /// the buffer's active font encoding
435 std::string const main_font_encoding() const;
436 /// all font encodings requested by the prefs/document/main language.
437 /// This does NOT include font encodings required by secondary languages
438 std::vector<std::string> const font_encodings() const;
441 std::string const dvips_options() const;
442 /** The return value of paperSizeName() depends on the
443 * purpose for which the paper size is needed, since they
444 * support different subsets of paper sizes.
446 enum PapersizePurpose {
455 std::string paperSizeName(PapersizePurpose purpose) const;
456 /// set up if and how babel is called
457 std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
458 /// return supported drivers for specific packages
459 docstring getGraphicsDriver(std::string const & package) const;
460 /// handle inputenc etc.
461 void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) const;
463 std::string const parseFontName(std::string const & name) const;
464 /// set up the document fonts
465 std::string const loadFonts(LaTeXFeatures & features) const;
467 /// the cite engine modules
468 std::string const & citeEngine() const { return cite_engine_; }
469 /// the type of cite engine (authoryear or numerical)
470 CiteEngineType const & citeEngineType() const
471 { return cite_engine_type_; }
472 /// add the module to the cite engine modules
473 void setCiteEngine(std::string const & eng) { cite_engine_ = eng; }
474 /// set the cite engine type
475 void setCiteEngineType(CiteEngineType const & engine_type)
476 { cite_engine_type_ = engine_type; }
478 /// the available citation commands
479 std::vector<std::string> citeCommands() const;
480 /// the available citation styles
481 std::vector<CitationStyle> citeStyles() const;
483 /// Return the actual bibtex command (lyxrc or buffer param)
484 std::string const bibtexCommand() const;
486 /// Are we using biblatex?
487 bool useBiblatex() const;
489 /// Set the default BibTeX style file for the document
490 void setDefaultBiblioStyle(std::string const & s){ biblio_style = s; }
491 /// Get the default BibTeX style file from the TextClass
492 std::string const & defaultBiblioStyle() const;
493 /// whether the BibTeX style supports full author lists
494 bool const & fullAuthorList() const;
495 /// Check if a citation style is an alias to another style
496 std::string getCiteAlias(std::string const & s) const;
498 /// Options of the bibiography package
499 std::string biblio_opts;
500 /// The biblatex bibliography style
501 std::string biblatex_bibstyle;
502 /// The biblatex citation style
503 std::string biblatex_citestyle;
504 /// Set the bib file encoding (for biblatex)
505 void setBibEncoding(std::string const & s) { bib_encoding = s; }
506 /// Get the bib file encoding (for biblatex)
507 std::string const & bibEncoding() const { return bib_encoding; }
509 /// options for pdf output
510 PDFOptions & pdfoptions();
511 PDFOptions const & pdfoptions() const;
513 // do not change these values. we rely upon them.
520 /// what to use for math output. present choices are above
521 MathOutput html_math_output;
522 /// whether to attempt to be XHTML 1.1 compliant or instead be
523 /// a little more mellow
526 double html_math_img_scale;
528 double display_pixel_ratio;
530 std::string html_latex_start;
532 std::string html_latex_end;
534 bool html_css_as_file;
535 /// allow the LaTeX backend to run external programs
537 /// generate output usable for reverse/forward search
539 /// custom LaTeX macro from user instead our own
540 std::string output_sync_macro;
541 /// use refstyle? or prettyref?
543 /// use minted? or listings?
546 /// Return true if language could be set to lang,
547 /// otherwise return false and do not change language
548 bool setLanguage(std::string const & lang);
550 void invalidateConverterCache() const;
551 /// Copies over some of the settings from \param bp,
552 /// namely the ones need by Advanced F&R. We don't want
553 /// to copy them all, e.g., not the default master.
554 void copyForAdvFR(BufferParams const & bp);
558 void readPreamble(Lexer &);
560 void readLocalLayout(Lexer &, bool);
562 void readLanguage(Lexer &);
564 void readGraphicsDriver(Lexer &);
566 void readBullets(Lexer &);
568 void readBulletsLaTeX(Lexer &);
570 void readModules(Lexer &);
572 void readRemovedModules(Lexer &);
574 void readIncludeonly(Lexer &);
575 /// A cache for the default flavors
576 typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
578 mutable DefaultFlavorCache default_flavors_;
580 std::string cite_engine_;
581 /// the type of cite engine (authoryear or numerical)
582 CiteEngineType cite_engine_type_;
583 /// the default BibTeX style file for the document
584 std::string biblio_style;
585 /// The encoding of the bib files, for Biblatex
586 /// (only one supported currently)
587 // FIXME: biblatex 3.12 introduces per-file
588 // encoding options. Update once that's spread.
589 std::string bib_encoding;
590 /// Split bibliography?
593 DocumentClassPtr doc_class_;
595 LayoutModuleList layout_modules_;
596 /// this is for modules that are required by the document class but that
597 /// the user has chosen not to use
598 std::list<std::string> removed_modules_;
599 /// The local layouts without the forced ones
600 docstring local_layout_;
601 /// Forced local layouts only for reading (use getLocalLayout() instead)
602 docstring forced_local_layout_;
604 /// the list of included children (for includeonly)
605 std::list<std::string> included_children_;
607 typedef std::map<std::string, Package> PackageMap;
608 /** Whether and how to load packages like amsmath, esint, mhchem,
609 * mathdots, stackrel, stmaryrd and undertilde.
611 PackageMap use_packages;
613 /** Use the Pimpl idiom to hide those member variables that would otherwise
614 * drag in other header files.
619 static Impl * clone(Impl const *);
620 static void destroy(Impl *);
622 support::copied_ptr<Impl, MemoryTraits> pimpl_;