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 bool setBaseClass(std::string const & classname);
140 /// Adds the module information to the baseClass information to
141 /// create our local DocumentClass.
142 /// NOTE: This should NEVER be called externally unless one immediately goes
143 /// on to class BufferView::updateDocumentClass(). The exception, of course,
144 /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
145 /// the parameters from the active Buffer.
146 void makeDocumentClass(bool const clone = false);
147 /// Returns the DocumentClass currently in use: the BaseClass as modified
149 DocumentClass const & documentClass() const;
150 /// \return A pointer to the DocumentClass currently in use: the BaseClass
151 /// as modified by modules.
152 DocumentClassConstPtr documentClassPtr() const;
153 /// This bypasses the baseClass and sets the textClass directly.
154 /// Should be called with care and would be better not being here,
155 /// but it seems to be needed by CutAndPaste::putClipboard().
156 void setDocumentClass(DocumentClassConstPtr);
157 /// List of modules in use
158 LayoutModuleList const & getModules() const { return layout_modules_; }
159 /// List of default modules the user has removed
160 std::list<std::string> const & getRemovedModules() const
161 { return removed_modules_; }
163 /// Add a module to the list of modules in use. This checks only that the
164 /// module is not already in the list, so use layoutModuleCanBeAdeed first
165 /// if you want to check for compatibility.
166 /// \return true if module was successfully added.
167 bool addLayoutModule(std::string const & modName);
168 /// checks to make sure module's requriements are satisfied, that it does
169 /// not conflict with already-present modules, isn't already loaded, etc.
170 bool layoutModuleCanBeAdded(std::string const & modName) const;
172 void addRemovedModule(std::string const & modName)
173 { removed_modules_.push_back(modName); }
175 void clearLayoutModules() { layout_modules_.clear(); }
176 /// Clear the removed module list
177 void clearRemovedModules() { removed_modules_.clear(); }
178 /// Get the local layouts
179 docstring getLocalLayout(bool forced) const;
180 /// Set the local layouts
181 void setLocalLayout(docstring const & layout, bool forced);
183 /// returns \c true if the buffer contains a LaTeX document
184 bool isLatex() const;
185 /// returns \c true if the buffer contains a DocBook document
186 bool isDocBook() const;
187 /// returns \c true if the buffer contains a Wed document
188 bool isLiterate() const;
190 /// return the format of the buffer on a string
191 std::string bufferFormat() const;
192 /// return the default output format of the current backend
193 std::string getDefaultOutputFormat() const;
194 /// return the output flavor of \p format or the default
195 OutputParams::FLAVOR getOutputFlavor(
196 std::string const & format = std::string()) const;
198 bool isExportable(std::string const & format, bool need_viewable) const;
200 std::vector<const Format *> const & exportableFormats(bool only_viewable) const;
201 /// the backends appropriate for use with this document.
202 /// so, e.g., latex is excluded , if we're using non-TeX fonts
203 std::vector<std::string> backends() const;
205 /// List of included children (for includeonly)
206 std::list<std::string> const & getIncludedChildren() const
207 { return included_children_; }
209 void addIncludedChildren(std::string const & child)
210 { included_children_.push_back(child); }
211 /// Clear the list of included children
212 void clearIncludedChildren() { included_children_.clear(); }
214 /// update aux files of unincluded children (with \includeonly)
215 bool maintain_unincluded_children;
217 /// returns the main font for the buffer (document)
218 Font const getFont() const;
220 /// translate quote style string to enum value
221 InsetQuotesParams::QuoteStyle getQuoteStyle(std::string const & qs) const;
223 /* these are for the PaperLayout */
225 PAPER_SIZE papersize;
227 PAPER_ORIENTATION orientation;
228 /// use custom margins
231 std::string paperwidth;
233 std::string paperheight;
235 std::string leftmargin;
237 std::string topmargin;
239 std::string rightmargin;
241 std::string bottommargin;
243 std::string headheight;
247 std::string footskip;
249 std::string columnsep;
251 /* some LaTeX options */
252 /// The graphics driver
253 std::string graphics_driver;
254 /// The default output format
255 std::string default_output_format;
256 /// customized bibliography processor
257 std::string bibtex_command;
258 /// customized index processor
259 std::string index_command;
260 /// font encoding(s) requested for this document
262 /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
263 std::string fonts_roman[2];
265 std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
266 /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
267 std::string fonts_sans[2];
269 std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
270 /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
271 std::string fonts_typewriter[2];
273 std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
274 /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
275 std::string fonts_math[2];
277 std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
278 /// the default family (rm, sf, tt)
279 std::string fonts_default_family;
280 /// use the fonts of the OS (OpenType, True Type) directly
282 /// use expert Small Caps
283 bool fonts_expert_sc;
284 /// use Old Style Figures
285 bool fonts_old_figures;
286 /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
287 int fonts_sans_scale[2];
288 /// the scale factor of the sf font
289 int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
290 /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
291 int fonts_typewriter_scale[2];
292 /// the scale factor of the tt font
293 int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
294 /// the font used by the CJK command
295 std::string fonts_cjk;
296 /// use LaTeX microtype package
298 /// use font ligatures for en- and em-dashes
299 bool use_dash_ligatures;
302 Spacing const & spacing() const;
308 Language const * language;
310 std::string lang_package;
312 BranchList & branchlist();
313 BranchList const & branchlist() const;
315 IndicesList & indiceslist();
316 IndicesList const & indiceslist() const;
318 * The LyX name of the input encoding for LaTeX. This can be one of
319 * - \c auto: find out the input encoding from the used languages
320 * - \c default: ditto
321 * - any encoding defined in the file lib/encodings
322 * The encoding of the LyX file is always utf8 and has nothing to
323 * do with this setting.
324 * The difference between \c auto and \c default is that \c auto also
325 * causes loading of the inputenc package, while \c default does not.
326 * \c default will not work unless the user takes additional measures
327 * (such as using special environments like the CJK environment from
329 * \c default can be seen as an unspecified 8bit encoding, since LyX
330 * does not interpret it in any way apart from display on screen.
332 std::string inputenc;
333 /// The main encoding used by this buffer for LaTeX output.
334 /// Individual pieces of text can use different encodings.
335 /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
336 /// instead of the value returned by this function.
337 Encoding const & encoding() const;
344 /// use the class options defined in the layout?
345 bool use_default_options;
351 std::string float_placement;
353 std::string float_alignment;
355 unsigned int columns;
358 /// parameters for the listings package
359 std::string listings_params;
363 std::string pagestyle;
365 RGBColor backgroundcolor;
367 bool isbackgroundcolor;
373 RGBColor notefontcolor;
376 /// \param index should lie in the range 0 <= \c index <= 3.
377 Bullet & temp_bullet(size_type index);
378 Bullet const & temp_bullet(size_type index) const;
379 /// \param index should lie in the range 0 <= \c index <= 3.
380 Bullet & user_defined_bullet(size_type index);
381 Bullet const & user_defined_bullet(size_type index) const;
383 /// Whether to load a package such as amsmath or esint.
384 /// The enum values must not be changed (file format!)
386 /// Don't load the package. For experts only.
388 /// Load the package if needed (recommended)
390 /// Always load the package (e.g. if the document contains
391 /// some ERT that needs the package)
394 /// Whether to load a package such as amsmath or esint.
395 Package use_package(std::string const & p) const;
396 /// Set whether to load a package such as amsmath or esint.
397 void use_package(std::string const & p, Package u);
398 /// All packages that can be switched on or off
399 static std::map<std::string, std::string> const & auto_packages();
400 /// Do we use the bibtopic package?
401 bool useBibtopic() const;
402 /// Split bibliography?
403 bool splitbib() const { return use_bibtopic; }
404 /// Set split bibliography
405 void splitbib(bool const b) { use_bibtopic = b; }
406 /// Do we have multiple bibliographies (by chapter etc.)?
407 std::string multibib;
410 /// Save transient properties?
411 bool save_transient_properties;
412 /// revision tracking for this buffer ? (this is a transient property)
414 /** This param decides whether change tracking marks should be used
415 * in output (irrespective of how these marks are actually defined;
416 * for instance, they may differ for DVI and PDF generation)
417 * This is a transient property.
423 /// the author list for the document
424 AuthorList & authors();
425 AuthorList const & authors() const;
426 void addAuthor(Author a);
428 /// map of the file's author IDs to AuthorList indexes
429 typedef std::map<int, int> AuthorMap;
430 AuthorMap author_map_;
432 /// the buffer's active font encoding
433 std::string const main_font_encoding() const;
434 /// all font encodings requested by the prefs/document/main language.
435 /// This does NOT include font encodings required by secondary languages
436 std::vector<std::string> const font_encodings() const;
439 std::string const dvips_options() const;
440 /** The return value of paperSizeName() depends on the
441 * purpose for which the paper size is needed, since they
442 * support different subsets of paper sizes.
444 enum PapersizePurpose {
453 std::string paperSizeName(PapersizePurpose purpose) const;
454 /// set up if and how babel is called
455 std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
456 /// return supported drivers for specific packages
457 docstring getGraphicsDriver(std::string const & package) const;
458 /// handle inputenc etc.
459 void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) const;
461 std::string const parseFontName(std::string const & name) const;
462 /// set up the document fonts
463 std::string const loadFonts(LaTeXFeatures & features) const;
465 /// the cite engine modules
466 std::string const & citeEngine() const { return cite_engine_; }
467 /// the type of cite engine (authoryear or numerical)
468 CiteEngineType const & citeEngineType() const
469 { return cite_engine_type_; }
470 /// add the module to the cite engine modules
471 void setCiteEngine(std::string const & eng) { cite_engine_ = eng; }
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 /// allow the LaTeX backend to run external programs
531 /// generate output usable for reverse/forward search
533 /// custom LaTeX macro from user instead our own
534 std::string output_sync_macro;
535 /// use refstyle? or prettyref?
537 /// use minted? or listings?
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_;
570 std::string 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_;