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; }
46 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 HSpace const & getIndentation() const;
98 void setIndentation(HSpace const & indent);
100 VSpace const & getDefSkip() const;
102 void setDefSkip(VSpace const & vs);
104 /** Whether paragraphs are separated by using a indent like in
105 * articles or by using a little skip like in letters.
107 ParagraphSeparation paragraph_separation;
109 InsetQuotes::QuoteLanguage quotes_language;
111 std::string fontsize;
112 /// Get the LayoutFile this document is using.
113 LayoutFile const * baseClass() const;
115 LayoutFileIndex const & baseClassID() const;
116 /// Set the LyX layout file this document is using.
117 /// NOTE: This does not call makeDocumentClass() to update the local
118 /// DocumentClass. That needs to be done manually.
119 /// \param classname: the name of the layout file
120 bool setBaseClass(std::string const & classname);
121 /// Adds the module information to the baseClass information to
122 /// create our local DocumentClass.
123 /// NOTE: This should NEVER be called externally unless one immediately goes
124 /// on to class BufferView::updateDocumentClass(). The exception, of course,
125 /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
126 /// the parameters from the active Buffer.
127 void makeDocumentClass(bool const clone = false);
128 /// Returns the DocumentClass currently in use: the BaseClass as modified
130 DocumentClass const & documentClass() const;
131 /// \return A pointer to the DocumentClass currently in use: the BaseClass
132 /// as modified by modules.
133 DocumentClassConstPtr documentClassPtr() const;
134 /// This bypasses the baseClass and sets the textClass directly.
135 /// Should be called with care and would be better not being here,
136 /// but it seems to be needed by CutAndPaste::putClipboard().
137 void setDocumentClass(DocumentClassConstPtr);
138 /// List of modules in use
139 LayoutModuleList const & getModules() const { return layout_modules_; }
140 /// List of default modules the user has removed
141 std::list<std::string> const & getRemovedModules() const
142 { return removed_modules_; }
144 /// Add a module to the list of modules in use. This checks only that the
145 /// module is not already in the list, so use layoutModuleCanBeAdeed first
146 /// if you want to check for compatibility.
147 /// \return true if module was successfully added.
148 bool addLayoutModule(std::string const & modName);
149 /// checks to make sure module's requriements are satisfied, that it does
150 /// not conflict with already-present modules, isn't already loaded, etc.
151 bool layoutModuleCanBeAdded(std::string const & modName) const;
152 /// same, but for citaton modules.
153 bool citationModuleCanBeAdded(std::string const & modName) const;
155 void addRemovedModule(std::string const & modName)
156 { removed_modules_.push_back(modName); }
158 void clearLayoutModules() { layout_modules_.clear(); }
159 /// Clear the removed module list
160 void clearRemovedModules() { removed_modules_.clear(); }
161 /// Get the local layouts
162 std::string getLocalLayout(bool) const;
163 /// Set the local layouts
164 void setLocalLayout(std::string const &, bool);
166 /// returns \c true if the buffer contains a LaTeX document
167 bool isLatex() const;
168 /// returns \c true if the buffer contains a DocBook document
169 bool isDocBook() const;
170 /// returns \c true if the buffer contains a Wed document
171 bool isLiterate() const;
173 /// return the format of the buffer on a string
174 std::string bufferFormat() const;
175 /// return the default output format of the current backend
176 std::string getDefaultOutputFormat() const;
177 /// return the output flavor of \p format or the default
178 OutputParams::FLAVOR getOutputFlavor(
179 std::string const & format = std::string()) const;
181 bool isExportable(std::string const & format) const;
183 std::vector<Format const *> exportableFormats(bool only_viewable) const;
185 bool isExportableFormat(std::string const & format) const;
186 /// the backends appropriate for use with this document.
187 /// so, e.g., latex is excluded , if we're using non-TeX fonts
188 std::vector<std::string> backends() const;
190 /// List of included children (for includeonly)
191 std::list<std::string> const & getIncludedChildren() const
192 { return included_children_; }
194 void addIncludedChildren(std::string const & child)
195 { included_children_.push_back(child); }
196 /// Clear the list of included children
197 void clearIncludedChildren() { included_children_.clear(); }
199 /// update aux files of unincluded children (with \includeonly)
200 bool maintain_unincluded_children;
202 /// returns the main font for the buffer (document)
203 Font const getFont() const;
205 /// translate quote style string to enum value
206 InsetQuotes::QuoteLanguage getQuoteStyle(std::string const & qs) const;
208 /* these are for the PaperLayout */
210 PAPER_SIZE papersize;
212 PAPER_ORIENTATION orientation;
213 /// use custom margins
216 std::string paperwidth;
218 std::string paperheight;
220 std::string leftmargin;
222 std::string topmargin;
224 std::string rightmargin;
226 std::string bottommargin;
228 std::string headheight;
232 std::string footskip;
234 std::string columnsep;
236 /* some LaTeX options */
237 /// The graphics driver
238 std::string graphics_driver;
239 /// The default output format
240 std::string default_output_format;
241 /// customized bibliography processor
242 std::string bibtex_command;
243 /// customized index processor
244 std::string index_command;
245 /// font encoding(s) requested for this document
247 /// the rm font: [0] for TeX fonts, [1] for non-TeX fonts
248 std::string fonts_roman[2];
250 std::string const & fontsRoman() const { return fonts_roman[useNonTeXFonts]; }
251 /// the sf font: [0] for TeX fonts, [1] for non-TeX fonts
252 std::string fonts_sans[2];
254 std::string const & fontsSans() const { return fonts_sans[useNonTeXFonts]; }
255 /// the tt font: [0] for TeX fonts, [1] for non-TeX fonts
256 std::string fonts_typewriter[2];
258 std::string const & fontsTypewriter() const { return fonts_typewriter[useNonTeXFonts]; }
259 /// the math font: [0] for TeX fonts, [1] for non-TeX fonts
260 std::string fonts_math[2];
262 std::string const & fontsMath() const { return fonts_math[useNonTeXFonts]; }
263 /// the default family (rm, sf, tt)
264 std::string fonts_default_family;
265 /// use the fonts of the OS (OpenType, True Type) directly
267 /// use expert Small Caps
268 bool fonts_expert_sc;
269 /// use Old Style Figures
270 bool fonts_old_figures;
271 /// the scale factor of the sf font: [0] for TeX fonts, [1] for non-TeX fonts
272 int fonts_sans_scale[2];
273 /// the scale factor of the sf font
274 int fontsSansScale() const { return fonts_sans_scale[useNonTeXFonts]; }
275 /// the scale factor of the tt font: [0] for TeX fonts, [1] for non-TeX fonts
276 int fonts_typewriter_scale[2];
277 /// the scale factor of the tt font
278 int fontsTypewriterScale() const { return fonts_typewriter_scale[useNonTeXFonts]; }
279 /// the font used by the CJK command
280 std::string fonts_cjk;
283 Spacing const & spacing() const;
289 Language const * language;
291 std::string lang_package;
293 BranchList & branchlist();
294 BranchList const & branchlist() const;
296 IndicesList & indiceslist();
297 IndicesList const & indiceslist() const;
299 * The LyX name of the input encoding for LaTeX. This can be one of
300 * - \c auto: find out the input encoding from the used languages
301 * - \c default: ditto
302 * - any encoding defined in the file lib/encodings
303 * The encoding of the LyX file is always utf8 and has nothing to
304 * do with this setting.
305 * The difference between \c auto and \c default is that \c auto also
306 * causes loading of the inputenc package, while \c default does not.
307 * \c default will not work unless the user takes additional measures
308 * (such as using special environments like the CJK environment from
310 * \c default can be seen as an unspecified 8bit encoding, since LyX
311 * does not interpret it in any way apart from display on screen.
313 std::string inputenc;
314 /// The main encoding used by this buffer for LaTeX output.
315 /// Individual pieces of text can use different encodings.
316 /// Output for XeTeX with 8-bit TeX fonts uses ASCII (set at runtime)
317 /// instead of the value returned by this function.
318 Encoding const & encoding() const;
322 std::string preamble;
325 /// use the class options defined in the layout?
326 bool use_default_options;
332 std::string float_placement;
334 unsigned int columns;
337 /// parameters for the listings package
338 std::string listings_params;
342 std::string pagestyle;
344 RGBColor backgroundcolor;
346 bool isbackgroundcolor;
352 RGBColor notefontcolor;
355 /// \param index should lie in the range 0 <= \c index <= 3.
356 Bullet & temp_bullet(size_type index);
357 Bullet const & temp_bullet(size_type index) const;
358 /// \param index should lie in the range 0 <= \c index <= 3.
359 Bullet & user_defined_bullet(size_type index);
360 Bullet const & user_defined_bullet(size_type index) const;
362 /// Whether to load a package such as amsmath or esint.
363 /// The enum values must not be changed (file format!)
365 /// Don't load the package. For experts only.
367 /// Load the package if needed (recommended)
369 /// Always load the package (e.g. if the document contains
370 /// some ERT that needs the package)
373 /// Whether to load a package such as amsmath or esint.
374 Package use_package(std::string const & p) const;
375 /// Set whether to load a package such as amsmath or esint.
376 void use_package(std::string const & p, Package u);
377 /// All packages that can be switched on or off
378 static std::map<std::string, std::string> const & auto_packages();
379 /// Split bibliography?
383 /// Save trensient properties?
384 bool save_transient_properties;
385 /// revision tracking for this buffer ? (this is a transient property)
387 /** This param decides whether change tracking marks should be used
388 * in output (irrespective of how these marks are actually defined;
389 * for instance, they may differ for DVI and PDF generation)
390 * This is a transient property.
396 /// the author list for the document
397 AuthorList & authors();
398 AuthorList const & authors() const;
399 void addAuthor(Author a);
401 /// map of the file's author IDs to AuthorList indexes
402 typedef std::map<int, int> AuthorMap;
403 AuthorMap author_map_;
405 /// the buffer's active font encoding
406 std::string const font_encoding() const;
407 /// all font encodings requested by the prefs/document/main language.
408 /// This does NOT include font encodings required by secondary languages
409 std::vector<std::string> const font_encodings() const;
412 std::string const dvips_options() const;
413 /** The return value of paperSizeName() depends on the
414 * purpose for which the paper size is needed, since they
415 * support different subsets of paper sizes.
417 enum PapersizePurpose {
426 std::string paperSizeName(PapersizePurpose purpose) const;
427 /// set up if and how babel is called
428 std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
429 /// return supported drivers for specific packages
430 docstring getGraphicsDriver(std::string const & package) const;
431 /// handle inputenc etc.
432 void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) const;
434 std::string const parseFontName(std::string const & name) const;
435 /// set up the document fonts
436 std::string const loadFonts(LaTeXFeatures & features) const;
438 /// the cite engine modules
439 LayoutModuleList const & citeEngine() const
440 { return cite_engine_; }
441 /// the type of cite engine (authoryear or numerical)
442 CiteEngineType const & citeEngineType() const
443 { return cite_engine_type_; }
444 /// add the module to the cite engine modules
445 bool addCiteEngine(std::string const &);
446 /// add the modules to the cite engine modules
447 bool addCiteEngine(std::vector<std::string> const &);
448 /// clear the list of cite engine modules
449 void clearCiteEngine() { cite_engine_.clear(); }
450 /// set the cite engine module
451 void setCiteEngine(std::string const &);
452 /// set the cite engine modules
453 void setCiteEngine(std::vector<std::string> const &);
454 /// set the cite engine type
455 void setCiteEngineType(CiteEngineType const & engine_type)
456 { cite_engine_type_ = engine_type; }
458 /// the available citation commands
459 std::vector<std::string> citeCommands() const;
460 /// the available citation styles
461 std::vector<CitationStyle> citeStyles() const;
463 /// the default BibTeX style file for the document
464 std::string biblio_style;
465 /// the default BibTeX style file from the TextClass
466 std::string const & defaultBiblioStyle() const;
467 /// whether the BibTeX style supports full author lists
468 bool const & fullAuthorList() const;
470 /// options for pdf output
471 PDFOptions & pdfoptions();
472 PDFOptions const & pdfoptions() const;
474 // do not change these values. we rely upon them.
481 /// what to use for math output. present choices are above
482 MathOutput html_math_output;
483 /// whether to attempt to be XHTML 1.1 compliant or instead be
484 /// a little more mellow
487 double html_math_img_scale;
489 double display_pixel_ratio;
491 std::string html_latex_start;
493 std::string html_latex_end;
495 bool html_css_as_file;
496 /// generate output usable for reverse/forward search
498 /// custom LaTeX macro from user instead our own
499 std::string output_sync_macro;
500 /// use refstyle? or prettyref?
503 /// Return true if language could be set to lang,
504 /// otherwise return false and do not change language
505 bool setLanguage(std::string const & lang);
509 void readPreamble(Lexer &);
511 void readLocalLayout(Lexer &, bool);
513 void readLanguage(Lexer &);
515 void readGraphicsDriver(Lexer &);
517 void readBullets(Lexer &);
519 void readBulletsLaTeX(Lexer &);
521 void readModules(Lexer &);
523 void readRemovedModules(Lexer &);
525 void readIncludeonly(Lexer &);
526 /// A cache for the default flavors
527 typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
529 mutable DefaultFlavorCache default_flavors_;
530 /// the cite engine modules
531 LayoutModuleList cite_engine_;
532 /// the type of cite engine (authoryear or numerical)
533 CiteEngineType cite_engine_type_;
535 DocumentClassPtr doc_class_;
537 LayoutModuleList layout_modules_;
538 /// this is for modules that are required by the document class but that
539 /// the user has chosen not to use
540 std::list<std::string> removed_modules_;
541 /// The local layouts without the forced ones
542 std::string local_layout_;
543 /// Forced local layouts only for reading (use getLocalLayout() instead)
544 std::string forced_local_layout_;
546 /// the list of included children (for includeonly)
547 std::list<std::string> included_children_;
549 typedef std::map<std::string, Package> PackageMap;
550 /** Whether and how to load packages like amsmath, esint, mhchem,
551 * mathdots, stackrel, stmaryrd and undertilde.
553 PackageMap use_packages;
555 /** Use the Pimpl idiom to hide those member variables that would otherwise
556 * drag in other header files.
561 static Impl * clone(Impl const *);
562 static void destroy(Impl *);
564 support::copied_ptr<Impl, MemoryTraits> pimpl_;