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
22 #include "insets/InsetQuotes.h"
24 #include "support/copied_ptr.h"
31 namespace support { class FileName; }
41 class LayoutFileIndex;
48 /** Buffer parameters.
49 * This class contains all the parameters for this buffer's use. Some
50 * work needs to be done on this class to make it nice. Now everything
56 typedef std::vector<std::string> LayoutModuleList;
58 enum ParagraphSeparation {
60 ParagraphIndentSeparation,
62 ParagraphSkipSeparation
67 /// get l10n translated to the buffers language
68 docstring B_(std::string const & l10n) const;
70 /// read a header token, if unrecognised, return it or an unknown class name
71 std::string readToken(Lexer & lex,
72 std::string const & token, ///< token to read.
73 support::FileName const & filepath);
76 void writeFile(std::ostream &) const;
78 /// check what features are implied by the buffer parameters.
79 void validate(LaTeXFeatures &) const;
81 /** \returns true if the babel package is used (interogates
82 * the BufferParams and a LyXRC variable).
83 * This returned value can then be passed to the insets...
85 bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
88 void useClassDefaults();
90 bool hasClassDefaults() const;
93 VSpace const & getDefSkip() const;
95 void setDefSkip(VSpace const & vs);
97 /** Whether paragraphs are separated by using a indent like in
98 * articles or by using a little skip like in letters.
100 ParagraphSeparation paragraph_separation;
102 InsetQuotes::QuoteLanguage quotes_language;
104 InsetQuotes::QuoteTimes quotes_times;
106 std::string fontsize;
107 ///Get the LayoutFile this document is using.
108 LayoutFile const * baseClass() const;
110 LayoutFileIndex const & baseClassID() const;
111 /// Set the LyX layout file this document is using.
112 /// NOTE: This does not call makeDocumentClass() to update the local
113 /// DocumentClass. That needs to be done manually.
114 /// \param filename the name of the layout file
115 bool setBaseClass(std::string const & classname);
116 /// Adds the module information to the baseClass information to
117 /// create our local DocumentClass.
118 void makeDocumentClass();
119 /// Returns the DocumentClass currently in use: the BaseClass as modified
121 DocumentClass const & documentClass() const;
122 /// \return A pointer to the DocumentClass currently in use: the BaseClass
123 /// as modified by modules.
124 DocumentClass const * documentClassPtr() const;
125 /// This bypasses the baseClass and sets the textClass directly.
126 /// Should be called with care and would be better not being here,
127 /// but it seems to be needed by CutAndPaste::putClipboard().
128 void setDocumentClass(DocumentClass const * const);
129 /// List of modules in use
130 LayoutModuleList const & getModules() const { return layoutModules_; }
131 /// List of default modules the user has removed
132 std::set<std::string> const & getRemovedModules() const
133 { return removedModules_; }
135 /// Add a module to the list of modules in use.
136 /// Returns true if module was successfully added.
137 /// The makeClass variable signals whether to call makeDocumentClass. This
138 /// need not be done if we know this isn't the final time through, or if
139 /// the BufferParams do not represent the parameters for an actual buffer
140 /// (as in GuiDocument).
141 bool addLayoutModule(std::string const & modName);
143 void addRemovedModule(std::string const & modName)
144 { removedModules_.insert(modName); }
146 void clearLayoutModules() { layoutModules_.clear(); }
147 /// Clear the removed module list
148 void clearRemovedModules() { removedModules_.clear(); }
150 /// returns the main font for the buffer (document)
151 Font const getFont() const;
153 /* this are for the PaperLayout */
155 PAPER_SIZE papersize;
157 PAPER_ORIENTATION orientation;
158 /// use custom margins
161 std::string paperwidth;
163 std::string paperheight;
165 std::string leftmargin;
167 std::string topmargin;
169 std::string rightmargin;
171 std::string bottommargin;
173 std::string headheight;
177 std::string footskip;
179 std::string columnsep;
181 /* some LaTeX options */
182 /// The graphics driver
183 std::string graphicsDriver;
185 std::string fontsRoman;
187 std::string fontsSans;
189 std::string fontsTypewriter;
190 /// the default family (rm, sf, tt)
191 std::string fontsDefaultFamily;
192 /// use expert Small Caps
194 /// use Old Style Figures
196 /// the scale factor of the sf font
198 /// the scale factor of the tt font
199 int fontsTypewriterScale;
200 /// the font used by the CJK command
201 std::string fontsCJK;
204 Spacing const & spacing() const;
210 Language const * language;
212 BranchList & branchlist();
213 BranchList const & branchlist() const;
215 * The input encoding for LaTeX. This can be one of
216 * - \c auto: find out the input encoding from the used languages
217 * - \c default: ditto
218 * - any encoding supported by the inputenc package
219 * The encoding of the LyX file is always utf8 and has nothing to
220 * do with this setting.
221 * The difference between \c auto and \c default is that \c auto also
222 * causes loading of the inputenc package, while \c default does not.
223 * \c default will not work unless the user takes additional measures
224 * (such as using special environments like the CJK environment from
226 * \c default can be seen as an unspecified 8bit encoding, since LyX
227 * does not interpret it in any way apart from display on screen.
229 std::string inputenc;
230 /// The main encoding used by this buffer for LaTeX output.
231 /// Individual pieces of text can use different encodings.
232 Encoding const & encoding() const;
234 std::string preamble;
236 std::string local_layout;
239 /// use the class options defined in the layout?
240 bool use_default_options;
244 std::string float_placement;
246 unsigned int columns;
247 /// parameters for the listings package
248 std::string listings_params;
252 std::string pagestyle;
253 /// \param index should lie in the range 0 <= \c index <= 3.
254 Bullet & temp_bullet(size_type index);
255 Bullet const & temp_bullet(size_type index) const;
256 /// \param index should lie in the range 0 <= \c index <= 3.
257 Bullet & user_defined_bullet(size_type index);
258 Bullet const & user_defined_bullet(size_type index) const;
260 /// Whether to load a package such as amsmath or esint.
261 /// The enum values must not be changed (file format!)
263 /// Don't load the package. For experts only.
265 /// Load the package if needed (recommended)
267 /// Always load the package (e.g. if the document contains
268 /// some ERT that needs the package)
271 /// Whether and how to load amsmath
273 /// Whether and how to load esint
277 /// revision tracking for this buffer ?
279 /** This param decides whether change tracking marks should be used
280 * in output (irrespective of how these marks are actually defined;
281 * for instance, they may differ for DVI and PDF generation)
287 /// the author list for the document
288 AuthorList & authors();
289 AuthorList const & authors() const;
291 /// map of the file's author IDs to buffer author IDs
292 std::vector<unsigned int> author_map;
294 std::string const dvips_options() const;
295 /** The return value of paperSizeName() depends on the
296 * purpose for which the paper size is needed, since they
297 * support different subsets of paper sizes.
299 enum PapersizePurpose {
308 std::string paperSizeName(PapersizePurpose purpose) const;
309 /// handle inputenc etc.
310 void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
311 TexRow & texrow) const;
312 /// set up the document fonts
313 std::string const loadFonts(std::string const & rm,
314 std::string const & sf, std::string const & tt,
315 bool const & sc, bool const & osf,
316 int const & sfscale, int const & ttscale) const;
318 /// get the appropriate cite engine (natbib handling)
319 CiteEngine citeEngine() const;
321 void setCiteEngine(CiteEngine const);
323 /// options for pdf output
324 PDFOptions & pdfoptions();
325 PDFOptions const & pdfoptions() const;
329 void readPreamble(Lexer &);
331 void readLocalLayout(Lexer &);
333 void readLanguage(Lexer &);
335 void readGraphicsDriver(Lexer &);
337 void readBullets(Lexer &);
339 void readBulletsLaTeX(Lexer &);
341 void readModules(Lexer &);
343 void readRemovedModules(Lexer &);
345 /// for use with natbib
346 CiteEngine cite_engine_;
348 DocumentClass * doc_class_;
350 LayoutModuleList layoutModules_;
351 /// this is for modules that are required by the document class but that
352 /// the user has chosen not to use
353 std::set<std::string> removedModules_;
355 /** Use the Pimpl idiom to hide those member variables that would otherwise
356 * drag in other header files.
361 static Impl * clone(Impl const *);
362 static void destroy(Impl *);
364 support::copied_ptr<Impl, MemoryTraits> pimpl_;