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
19 #include "DocumentClassPtr.h"
21 #include "LayoutModuleList.h"
22 #include "OutputParams.h"
25 #include "insets/InsetQuotes.h"
27 #include "support/copied_ptr.h"
34 namespace support { class FileName; }
47 class LayoutFileIndex;
54 /** Buffer parameters.
55 * This class contains all the parameters for this buffer's use. Some
56 * work needs to be done on this class to make it nice. Now everything
62 enum ParagraphSeparation {
64 ParagraphIndentSeparation,
66 ParagraphSkipSeparation
71 /// get l10n translated to the buffers language
72 docstring B_(std::string const & l10n) const;
74 /// read a header token, if unrecognised, return it or an unknown class name
75 std::string readToken(Lexer & lex,
76 std::string const & token, ///< token to read.
77 support::FileName const & filepath);
80 void writeFile(std::ostream &) const;
82 /// check what features are implied by the buffer parameters.
83 void validate(LaTeXFeatures &) const;
85 /** \returns true if the babel package is used (interogates
86 * the BufferParams, a LyXRC variable, and the document class).
87 * This returned value can then be passed to the insets...
89 bool writeLaTeX(otexstream &, LaTeXFeatures &,
90 support::FileName const &) const;
93 void useClassDefaults();
95 bool hasClassDefaults() const;
98 HSpace const & getIndentation() const;
100 void setIndentation(HSpace const & indent);
102 VSpace const & getDefSkip() const;
104 void setDefSkip(VSpace const & vs);
106 /** Whether paragraphs are separated by using a indent like in
107 * articles or by using a little skip like in letters.
109 ParagraphSeparation paragraph_separation;
111 InsetQuotes::QuoteLanguage quotes_language;
113 InsetQuotes::QuoteTimes quotes_times;
115 std::string fontsize;
116 /// Get the LayoutFile this document is using.
117 LayoutFile const * baseClass() const;
119 LayoutFileIndex const & baseClassID() const;
120 /// Set the LyX layout file this document is using.
121 /// NOTE: This does not call makeDocumentClass() to update the local
122 /// DocumentClass. That needs to be done manually.
123 /// \param filename the name of the layout file
124 bool setBaseClass(std::string const & classname);
125 /// Adds the module information to the baseClass information to
126 /// create our local DocumentClass.
127 /// NOTE: This should NEVER be called externally unless one immediately goes
128 /// on to class BufferView::updateDocumentClass(). The exception, of course,
129 /// is in GuiDocument, where we use a BufferParams simply to hold a copy of
130 /// the parameters from the active Buffer.
131 void makeDocumentClass();
132 /// Returns the DocumentClass currently in use: the BaseClass as modified
134 DocumentClass const & documentClass() const;
135 /// \return A pointer to the DocumentClass currently in use: the BaseClass
136 /// as modified by modules.
137 DocumentClassConstPtr documentClassPtr() const;
138 /// This bypasses the baseClass and sets the textClass directly.
139 /// Should be called with care and would be better not being here,
140 /// but it seems to be needed by CutAndPaste::putClipboard().
141 void setDocumentClass(DocumentClassConstPtr);
142 /// List of modules in use
143 LayoutModuleList const & getModules() const { return layout_modules_; }
144 /// List of default modules the user has removed
145 std::list<std::string> const & getRemovedModules() const
146 { return removed_modules_; }
148 /// Add a module to the list of modules in use. This checks only that the
149 /// module is not already in the list, so use layoutModuleCanBeAdeed first
150 /// if you want to check for compatibility.
151 /// \return true if module was successfully added.
152 bool addLayoutModule(std::string const & modName);
153 /// checks to make sure module's requriements are satisfied, that it does
154 /// not conflict with already-present modules, isn't already loaded, etc.
155 bool layoutModuleCanBeAdded(std::string const & modName) const;
156 /// same, but for citaton modules.
157 bool citationModuleCanBeAdded(std::string const & modName) const;
159 void addRemovedModule(std::string const & modName)
160 { removed_modules_.push_back(modName); }
162 void clearLayoutModules() { layout_modules_.clear(); }
163 /// Clear the removed module list
164 void clearRemovedModules() { removed_modules_.clear(); }
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;
248 std::string fonts_roman;
250 std::string fonts_sans;
252 std::string fonts_typewriter;
254 std::string fonts_math;
255 /// the default family (rm, sf, tt)
256 std::string fonts_default_family;
257 /// use the fonts of the OS (OpenType, True Type) directly
259 /// use expert Small Caps
260 bool fonts_expert_sc;
261 /// use Old Style Figures
262 bool fonts_old_figures;
263 /// the scale factor of the sf font
264 int fonts_sans_scale;
265 /// the scale factor of the tt font
266 int fonts_typewriter_scale;
267 /// the font used by the CJK command
268 std::string fonts_cjk;
271 Spacing const & spacing() const;
277 Language const * language;
279 std::string lang_package;
281 BranchList & branchlist();
282 BranchList const & branchlist() const;
284 IndicesList & indiceslist();
285 IndicesList const & indiceslist() const;
287 * The input encoding for LaTeX. This can be one of
288 * - \c auto: find out the input encoding from the used languages
289 * - \c default: ditto
290 * - any encoding supported by the inputenc package
291 * The encoding of the LyX file is always utf8 and has nothing to
292 * do with this setting.
293 * The difference between \c auto and \c default is that \c auto also
294 * causes loading of the inputenc package, while \c default does not.
295 * \c default will not work unless the user takes additional measures
296 * (such as using special environments like the CJK environment from
298 * \c default can be seen as an unspecified 8bit encoding, since LyX
299 * does not interpret it in any way apart from display on screen.
301 std::string inputenc;
302 /// The main encoding used by this buffer for LaTeX output.
303 /// Individual pieces of text can use different encodings.
304 Encoding const & encoding() const;
306 std::string preamble;
308 std::string local_layout;
311 /// use the class options defined in the layout?
312 bool use_default_options;
318 std::string float_placement;
320 unsigned int columns;
323 /// parameters for the listings package
324 std::string listings_params;
328 std::string pagestyle;
330 RGBColor backgroundcolor;
332 bool isbackgroundcolor;
338 RGBColor notefontcolor;
341 /// \param index should lie in the range 0 <= \c index <= 3.
342 Bullet & temp_bullet(size_type index);
343 Bullet const & temp_bullet(size_type index) const;
344 /// \param index should lie in the range 0 <= \c index <= 3.
345 Bullet & user_defined_bullet(size_type index);
346 Bullet const & user_defined_bullet(size_type index) const;
348 /// Whether to load a package such as amsmath or esint.
349 /// The enum values must not be changed (file format!)
351 /// Don't load the package. For experts only.
353 /// Load the package if needed (recommended)
355 /// Always load the package (e.g. if the document contains
356 /// some ERT that needs the package)
359 /// Whether to load a package such as amsmath or esint.
360 Package use_package(std::string const & p) const;
361 /// Set whether to load a package such as amsmath or esint.
362 void use_package(std::string const & p, Package u);
363 /// All packages that can be switched on or off
364 static std::vector<std::string> const & auto_packages();
365 /// Split bibliography?
369 /// revision tracking for this buffer ?
371 /** This param decides whether change tracking marks should be used
372 * in output (irrespective of how these marks are actually defined;
373 * for instance, they may differ for DVI and PDF generation)
379 /// the author list for the document
380 AuthorList & authors();
381 AuthorList const & authors() const;
383 /// map of the file's author IDs to AuthorList indexes
384 typedef std::map<int, int> AuthorMap;
385 AuthorMap author_map;
386 /// the buffer's font encoding
387 std::string const font_encoding() const;
389 std::string const dvips_options() const;
390 /** The return value of paperSizeName() depends on the
391 * purpose for which the paper size is needed, since they
392 * support different subsets of paper sizes.
394 enum PapersizePurpose {
403 std::string paperSizeName(PapersizePurpose purpose) const;
404 /// set up if and how babel is called
405 std::string babelCall(std::string const & lang_opts, bool const langoptions) const;
406 /// return supported drivers for specific packages
407 docstring getGraphicsDriver(std::string const & package) const;
408 /// handle inputenc etc.
409 void writeEncodingPreamble(otexstream & os, LaTeXFeatures & features) const;
411 std::string const parseFontName(std::string const & name) const;
412 /// set up the document fonts
413 std::string const loadFonts(LaTeXFeatures & features) const;
415 /// the cite engine modules
416 LayoutModuleList const & citeEngine() const
417 { return cite_engine_; }
418 /// the type of cite engine (authoryear or numerical)
419 CiteEngineType const & citeEngineType() const
420 { return cite_engine_type_; }
421 /// add the module to the cite engine modules
422 bool addCiteEngine(std::string const &);
423 /// add the modules to the cite engine modules
424 bool addCiteEngine(std::vector<std::string> const &);
425 /// clear the list of cite engine modules
426 void clearCiteEngine() { cite_engine_.clear(); }
427 /// set the cite engine module
428 void setCiteEngine(std::string const &);
429 /// set the cite engine modules
430 void setCiteEngine(std::vector<std::string> const &);
431 /// set the cite engine type
432 void setCiteEngineType(CiteEngineType const & engine_type)
433 { cite_engine_type_ = engine_type; }
435 /// the available citation commands
436 std::vector<std::string> citeCommands() const;
437 /// the available citation styles
438 std::vector<CitationStyle> citeStyles() const;
440 /// the default BibTeX style file for the document
441 std::string biblio_style;
442 /// the default BibTeX style file from the TextClass
443 std::string const & defaultBiblioStyle() const;
444 /// whether the BibTeX style supports full author lists
445 bool const & fullAuthorList() const;
447 /// options for pdf output
448 PDFOptions & pdfoptions();
449 PDFOptions const & pdfoptions() const;
451 // do not change these values. we rely upon them.
458 /// what to use for math output. present choices are above
459 MathOutput html_math_output;
460 /// whether to attempt to be XHTML 1.1 compliant or instead be
461 /// a little more mellow
464 double html_math_img_scale;
466 std::string html_latex_start;
468 std::string html_latex_end;
470 bool html_css_as_file;
471 /// generate output usable for reverse/forward search
473 /// custom LaTeX macro from user instead our own
474 std::string output_sync_macro;
475 /// use refstyle? or prettyref?
478 /// Return true if language could be set to lang,
479 /// otherwise return false and do not change language
480 bool setLanguage(std::string const & lang);
484 void readPreamble(Lexer &);
486 void readLocalLayout(Lexer &);
488 void readLanguage(Lexer &);
490 void readGraphicsDriver(Lexer &);
492 void readBullets(Lexer &);
494 void readBulletsLaTeX(Lexer &);
496 void readModules(Lexer &);
498 void readRemovedModules(Lexer &);
500 void readIncludeonly(Lexer &);
501 /// A cache for the default flavors
502 typedef std::map<std::string, OutputParams::FLAVOR> DefaultFlavorCache;
504 mutable DefaultFlavorCache default_flavors_;
505 /// the cite engine modules
506 LayoutModuleList cite_engine_;
507 /// the type of cite engine (authoryear or numerical)
508 CiteEngineType cite_engine_type_;
510 DocumentClassPtr doc_class_;
512 LayoutModuleList layout_modules_;
513 /// this is for modules that are required by the document class but that
514 /// the user has chosen not to use
515 std::list<std::string> removed_modules_;
517 /// the list of included children (for includeonly)
518 std::list<std::string> included_children_;
520 typedef std::map<std::string, Package> PackageMap;
521 /** Whether and how to load packages like amsmath, esint, mhchem,
522 * mathdots, stackrel, stmaryrd and undertilde.
524 PackageMap use_packages;
526 /** Use the Pimpl idiom to hide those member variables that would otherwise
527 * drag in other header files.
532 static Impl * clone(Impl const *);
533 static void destroy(Impl *);
535 support::copied_ptr<Impl, MemoryTraits> pimpl_;