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
112 /** Whether paragraphs are separated by using a indent like in
113 * articles or by using a little skip like in letters.
115 ParagraphSeparation paragraph_separation;
117 InsetQuotesParams::QuoteStyle quotes_style;
121 std::string fontsize;
122 /// Get the LayoutFile this document is using.
123 LayoutFile const * baseClass() const;
125 LayoutFileIndex const & baseClassID() const;
126 /// Set the LyX layout file this document is using.
127 /// NOTE: This does not call makeDocumentClass() to update the local
128 /// DocumentClass. That needs to be done manually.
129 /// \param classname: the name of the layout file
130 bool setBaseClass(std::string const & classname);
131 /// Adds the module information to the baseClass information to
132 /// create our local DocumentClass.
133 /// NOTE: This should NEVER be called externally unless one immediately goes
134 /// on to class BufferView::updateDocumentClass(). The exception, of course,
135 /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
136 /// the parameters from the active Buffer.
137 void makeDocumentClass(bool const clone = false);
138 /// Returns the DocumentClass currently in use: the BaseClass as modified
140 DocumentClass const & documentClass() const;
141 /// \return A pointer to the DocumentClass currently in use: the BaseClass
142 /// as modified by modules.
143 DocumentClassConstPtr documentClassPtr() const;
144 /// This bypasses the baseClass and sets the textClass directly.
145 /// Should be called with care and would be better not being here,
146 /// but it seems to be needed by CutAndPaste::putClipboard().
147 void setDocumentClass(DocumentClassConstPtr);
148 /// List of modules in use
149 LayoutModuleList const & getModules() const { return layout_modules_; }
150 /// List of default modules the user has removed
151 std::list<std::string> const & getRemovedModules() const
152 { return removed_modules_; }
154 /// Add a module to the list of modules in use. This checks only that the
155 /// module is not already in the list, so use layoutModuleCanBeAdeed first
156 /// if you want to check for compatibility.
157 /// \return true if module was successfully added.
158 bool addLayoutModule(std::string const & modName);
159 /// checks to make sure module's requriements are satisfied, that it does
160 /// not conflict with already-present modules, isn't already loaded, etc.
161 bool layoutModuleCanBeAdded(std::string const & modName) const;
162 /// same, but for citaton modules.
163 bool citationModuleCanBeAdded(std::string const & modName) const;
165 void addRemovedModule(std::string const & modName)
166 { removed_modules_.push_back(modName); }
168 void clearLayoutModules() { layout_modules_.clear(); }
169 /// Clear the removed module list
170 void clearRemovedModules() { removed_modules_.clear(); }
171 /// Get the local layouts
172 docstring getLocalLayout(bool forced) const;
173 /// Set the local layouts
174 void setLocalLayout(docstring const & layout, bool forced);
176 /// returns \c true if the buffer contains a LaTeX document
177 bool isLatex() const;
178 /// returns \c true if the buffer contains a DocBook document
179 bool isDocBook() const;
180 /// returns \c true if the buffer contains a Wed document
181 bool isLiterate() const;
183 /// return the format of the buffer on a string
184 std::string bufferFormat() const;
185 /// return the default output format of the current backend
186 std::string getDefaultOutputFormat() const;
187 /// return the output flavor of \p format or the default
188 OutputParams::FLAVOR getOutputFlavor(
189 std::string const & format = std::string()) const;
191 bool isExportable(std::string const & format, bool need_viewable) const;
193 std::vector<const Format *> const & exportableFormats(bool only_viewable) const;
194 /// the backends appropriate for use with this document.
195 /// so, e.g., latex is excluded , if we're using non-TeX fonts
196 std::vector<std::string> backends() const;
198 /// List of included children (for includeonly)
199 std::list<std::string> const & getIncludedChildren() const
200 { return included_children_; }
202 void addIncludedChildren(std::string const & child)
203 { included_children_.push_back(child); }
204 /// Clear the list of included children
205 void clearIncludedChildren() { included_children_.clear(); }
207 /// update aux files of unincluded children (with \includeonly)
208 bool maintain_unincluded_children;
210 /// returns the main font for the buffer (document)
211 Font const getFont() const;
213 /// translate quote style string to enum value
214 InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
216 /* these are for the PaperLayout */
218 PAPER_SIZE papersize;
220 PAPER_ORIENTATION orientation;
221 /// use custom margins
224 std::string paperwidth;
226 std::string paperheight;
228 std::string leftmargin;
230 std::string topmargin;
232 std::string rightmargin;
234 std::string bottommargin;
236 std::string headheight;
240 std::string footskip;
242 std::string columnsep;
244 /* some LaTeX options */
245 /// The graphics driver
246 std::string graphics_driver;
247 /// The default output format
248 std::string default_output_format;
249 /// customized bibliography processor
250 std::string bibtex_command;
251 /// customized index processor
252 std::string index_command;
253 /// font encoding(s) requested for this document
255 /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
256 std::string fonts_roman[2];
258 std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
259 /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
260 std::string fonts_sans[2];
262 std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
263 /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
264 std::string fonts_typewriter[2];
266 std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
267 /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
268 std::string fonts_math[2];
270 std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
271 /// the default family (rm, sf, tt)
272 std::string fonts_default_family;
273 /// use the fonts of the OS (OpenType, True Type) directly
275 /// use expert Small Caps
276 bool fonts_expert_sc;
277 /// use Old Style Figures
278 bool fonts_old_figures;
279 /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
280 int fonts_sans_scale[2];
281 /// the scale factor of the sf font
282 int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
283 /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
284 int fonts_typewriter_scale[2];
285 /// the scale factor of the tt font
286 int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
287 /// the font used by the CJK command
288 std::string fonts_cjk;
289 /// use LaTeX microtype package
291 /// use font ligatures for en- and em-dashes
292 bool use_dash_ligatures;
295 Spacing const & spacing() const;
301 Language const * language;
303 std::string lang_package;
305 BranchList & branchlist();
306 BranchList const & branchlist() const;
308 IndicesList & indiceslist();
309 IndicesList const & indiceslist() const;
311 * The LyX name of the input encoding for LaTeX. This can be one of
312 * - \c auto: find out the input encoding from the used languages
313 * - \c default: ditto
314 * - any encoding defined in the file lib/encodings
315 * The encoding of the LyX file is always utf8 and has nothing to
316 * do with this setting.
317 * The difference between \c auto and \c default is that \c auto also
318 * causes loading of the inputenc package, while \c default does not.
319 * \c default will not work unless the user takes additional measures
320 * (such as using special environments like the CJK environment from
322 * \c default can be seen as an unspecified 8bit encoding, since LyX
323 * does not interpret it in any way apart from display on screen.
325 std::string inputenc;
326 /// The main encoding used by this buffer for LaTeX output.
327 /// Individual pieces of text can use different encodings.
328 /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
329 /// instead of the value returned by this function.
330 Encoding const & encoding() const;
337 /// use the class options defined in the layout?
338 bool use_default_options;
344 std::string float_placement;
346 unsigned int columns;
349 /// parameters for the listings package
350 std::string listings_params;
354 std::string pagestyle;
356 RGBColor backgroundcolor;
358 bool isbackgroundcolor;
364 RGBColor notefontcolor;
367 /// \param index should lie in the range 0 <= \c index <= 3.
368 Bullet & temp_bullet(size_type index);
369 Bullet const & temp_bullet(size_type index) const;
370 /// \param index should lie in the range 0 <= \c index <= 3.
371 Bullet & user_defined_bullet(size_type index);
372 Bullet const & user_defined_bullet(size_type index) const;
374 /// Whether to load a package such as amsmath or esint.
375 /// The enum values must not be changed (file format!)
377 /// Don't load the package. For experts only.
379 /// Load the package if needed (recommended)
381 /// Always load the package (e.g. if the document contains
382 /// some ERT that needs the package)
385 /// Whether to load a package such as amsmath or esint.
386 Package use_package(std::string const & p) const;
387 /// Set whether to load a package such as amsmath or esint.
388 void use_package(std::string const & p, Package u);
389 /// All packages that can be switched on or off
390 static std::map<std::string, std::string> const & auto_packages();
391 /// Do we use the bibtopic package?
392 bool useBibtopic() const;
393 /// Split bibliography?
394 bool splitbib() const { return use_bibtopic; }
395 /// Set split bibliography
396 void splitbib(bool const b) { use_bibtopic = b; }
397 /// Do we have multiple bibliographies (by chapter etc.)?
398 std::string multibib;
401 /// Save transient properties?
402 bool save_transient_properties;
403 /// revision tracking for this buffer ? (this is a transient property)
405 /** This param decides whether change tracking marks should be used
406 * in output (irrespective of how these marks are actually defined;
407 * for instance, they may differ for DVI and PDF generation)
408 * This is a transient property.
414 /// the author list for the document
415 AuthorList & authors();
416 AuthorList const & authors() const;
417 void addAuthor(Author a);
419 /// map of the file's author IDs to AuthorList indexes
420 typedef std::map<int, int> AuthorMap;
421 AuthorMap author_map_;
423 /// the buffer's active font encoding
424 std::string const main_font_encoding() const;
425 /// all font encodings requested by the prefs/document/main language.
426 /// This does NOT include font encodings required by secondary languages
427 std::vector<std::string> const font_encodings() const;
430 std::string const dvips_options() const;
431 /** The return value of paperSizeName() depends on the
432 * purpose for which the paper size is needed, since they
433 * support different subsets of paper sizes.
435 enum PapersizePurpose {
444 std::string paperSizeName(PapersizePurpose purpose) const;
445 /// set up if and how babel is called
446 std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
447 /// return supported drivers for specific packages
448 docstring getGraphicsDriver(std::string const & package) const;
449 /// handle inputenc etc.
450 void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) const;
452 std::string const parseFontName(std::string const & name) const;
453 /// set up the document fonts
454 std::string const loadFonts(LaTeXFeatures & features) const;
456 /// the cite engine modules
457 LayoutModuleList const & citeEngine() const
458 { return cite_engine_; }
459 /// the type of cite engine (authoryear or numerical)
460 CiteEngineType const & citeEngineType() const
461 { return cite_engine_type_; }
462 /// add the module to the cite engine modules
463 bool addCiteEngine(std::string const &);
464 /// add the modules to the cite engine modules
465 bool addCiteEngine(std::vector<std::string> const &);
466 /// clear the list of cite engine modules
467 void clearCiteEngine() { cite_engine_.clear(); }
468 /// set the cite engine module
469 void setCiteEngine(std::string const &);
470 /// set the cite engine modules
471 void setCiteEngine(std::vector<std::string> const &);
472 /// set the cite engine type
473 void setCiteEngineType(CiteEngineType const & engine_type)
474 { cite_engine_type_ = engine_type; }
476 /// the available citation commands
477 std::vector<std::string> citeCommands() const;
478 /// the available citation styles
479 std::vector<CitationStyle> citeStyles() const;
481 /// Return the actual bibtex command (lyxrc or buffer param)
482 std::string const bibtexCommand() const;
484 /// Are we using biblatex?
485 bool useBiblatex() const;
487 /// Set the default BibTeX style file for the document
488 void setDefaultBiblioStyle(std::string const & s){ biblio_style = s; }
489 /// Get the default BibTeX style file from the TextClass
490 std::string const & defaultBiblioStyle() const;
491 /// whether the BibTeX style supports full author lists
492 bool const & fullAuthorList() const;
493 /// Check if a citation style is an alias to another style
494 std::string getCiteAlias(std::string const & s) const;
496 /// Options of the bibiography package
497 std::string biblio_opts;
498 /// The biblatex bibliography style
499 std::string biblatex_bibstyle;
500 /// The biblatex citation style
501 std::string biblatex_citestyle;
503 /// options for pdf output
504 PDFOptions & pdfoptions();
505 PDFOptions const & pdfoptions() const;
507 // do not change these values. we rely upon them.
514 /// what to use for math output. present choices are above
515 MathOutput html_math_output;
516 /// whether to attempt to be XHTML 1.1 compliant or instead be
517 /// a little more mellow
520 double html_math_img_scale;
522 double display_pixel_ratio;
524 std::string html_latex_start;
526 std::string html_latex_end;
528 bool html_css_as_file;
529 /// generate output usable for reverse/forward search
531 /// custom LaTeX macro from user instead our own
532 std::string output_sync_macro;
533 /// use refstyle? or prettyref?
536 /// Return true if language could be set to lang,
537 /// otherwise return false and do not change language
538 bool setLanguage(std::string const & lang);
540 void invalidateConverterCache() const;
544 void readPreamble(Lexer &);
546 void readLocalLayout(Lexer &, bool);
548 void readLanguage(Lexer &);
550 void readGraphicsDriver(Lexer &);
552 void readBullets(Lexer &);
554 void readBulletsLaTeX(Lexer &);
556 void readModules(Lexer &);
558 void readRemovedModules(Lexer &);
560 void readIncludeonly(Lexer &);
561 /// A cache for the default flavors
562 typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
564 mutable DefaultFlavorCache default_flavors_;
565 /// the cite engine modules
566 LayoutModuleList cite_engine_;
567 /// the type of cite engine (authoryear or numerical)
568 CiteEngineType cite_engine_type_;
569 /// the default BibTeX style file for the document
570 std::string biblio_style;
571 /// Split bibliography?
574 DocumentClassPtr doc_class_;
576 LayoutModuleList layout_modules_;
577 /// this is for modules that are required by the document class but that
578 /// the user has chosen not to use
579 std::list<std::string> removed_modules_;
580 /// The local layouts without the forced ones
581 docstring local_layout_;
582 /// Forced local layouts only for reading (use getLocalLayout() instead)
583 docstring forced_local_layout_;
585 /// the list of included children (for includeonly)
586 std::list<std::string> included_children_;
588 typedef std::map<std::string, Package> PackageMap;
589 /** Whether and how to load packages like amsmath, esint, mhchem,
590 * mathdots, stackrel, stmaryrd and undertilde.
592 PackageMap use_packages;
594 /** Use the Pimpl idiom to hide those member variables that would otherwise
595 * drag in other header files.
600 static Impl * clone(Impl const *);
601 static void destroy(Impl *);
603 support::copied_ptr<Impl, MemoryTraits> pimpl_;