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"
32 namespace support { class FileName; }
42 class LayoutFileIndex;
49 /** Buffer parameters.
50 * This class contains all the parameters for this buffer's use. Some
51 * work needs to be done on this class to make it nice. Now everything
57 typedef std::list<std::string> LayoutModuleList;
59 enum ParagraphSeparation {
61 ParagraphIndentSeparation,
63 ParagraphSkipSeparation
68 /// get l10n translated to the buffers language
69 docstring B_(std::string const & l10n) const;
71 /// read a header token, if unrecognised, return it or an unknown class name
72 std::string readToken(Lexer & lex,
73 std::string const & token, ///< token to read.
74 support::FileName const & filepath);
77 void writeFile(std::ostream &) const;
79 /// check what features are implied by the buffer parameters.
80 void validate(LaTeXFeatures &) const;
82 /** \returns true if the babel package is used (interogates
83 * the BufferParams and a LyXRC variable).
84 * This returned value can then be passed to the insets...
86 bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
89 void useClassDefaults();
91 bool hasClassDefaults() const;
94 VSpace const & getDefSkip() const;
96 void setDefSkip(VSpace const & vs);
98 /** Whether paragraphs are separated by using a indent like in
99 * articles or by using a little skip like in letters.
101 ParagraphSeparation paragraph_separation;
103 InsetQuotes::QuoteLanguage quotes_language;
105 InsetQuotes::QuoteTimes quotes_times;
107 std::string fontsize;
108 ///Get the LayoutFile this document is using.
109 LayoutFile const * baseClass() const;
111 LayoutFileIndex const & baseClassID() const;
112 /// Set the LyX layout file this document is using.
113 /// NOTE: This does not call makeDocumentClass() to update the local
114 /// DocumentClass. That needs to be done manually.
115 /// \param filename the name of the layout file
116 bool setBaseClass(std::string const & classname);
117 /// Adds the module information to the baseClass information to
118 /// create our local DocumentClass.
119 void makeDocumentClass();
120 /// Returns the DocumentClass currently in use: the BaseClass as modified
122 DocumentClass const & documentClass() const;
123 /// \return A pointer to the DocumentClass currently in use: the BaseClass
124 /// as modified by modules.
125 DocumentClass const * documentClassPtr() const;
126 /// This bypasses the baseClass and sets the textClass directly.
127 /// Should be called with care and would be better not being here,
128 /// but it seems to be needed by CutAndPaste::putClipboard().
129 void setDocumentClass(DocumentClass const * const);
130 /// List of modules in use
131 LayoutModuleList const & getModules() const { return layoutModules_; }
132 /// List of default modules the user has removed
133 std::set<std::string> const & getRemovedModules() const
134 { return removedModules_; }
136 /// Add a module to the list of modules in use. This checks only that the
137 /// module is not already in the list, so use moduleIsCompatible first if
138 /// you want to check for compatibility.
139 /// \return true if module was successfully added.
140 bool addLayoutModule(std::string const & modName);
141 /// checks to make sure module's requriements are satisfied, that it does
142 /// not conflict with already-present modules, isn't already loaded, etc.
143 bool moduleCanBeAdded(std::string const & modName) const;
145 void addRemovedModule(std::string const & modName)
146 { removedModules_.insert(modName); }
148 void clearLayoutModules() { layoutModules_.clear(); }
149 /// Clear the removed module list
150 void clearRemovedModules() { removedModules_.clear(); }
152 /// returns the main font for the buffer (document)
153 Font const getFont() const;
155 /* this are for the PaperLayout */
157 PAPER_SIZE papersize;
159 PAPER_ORIENTATION orientation;
160 /// use custom margins
163 std::string paperwidth;
165 std::string paperheight;
167 std::string leftmargin;
169 std::string topmargin;
171 std::string rightmargin;
173 std::string bottommargin;
175 std::string headheight;
179 std::string footskip;
181 std::string columnsep;
183 /* some LaTeX options */
184 /// The graphics driver
185 std::string graphicsDriver;
187 std::string fontsRoman;
189 std::string fontsSans;
191 std::string fontsTypewriter;
192 /// the default family (rm, sf, tt)
193 std::string fontsDefaultFamily;
194 /// use expert Small Caps
196 /// use Old Style Figures
198 /// the scale factor of the sf font
200 /// the scale factor of the tt font
201 int fontsTypewriterScale;
202 /// the font used by the CJK command
203 std::string fontsCJK;
206 Spacing const & spacing() const;
212 Language const * language;
214 BranchList & branchlist();
215 BranchList const & branchlist() const;
217 * The input encoding for LaTeX. This can be one of
218 * - \c auto: find out the input encoding from the used languages
219 * - \c default: ditto
220 * - any encoding supported by the inputenc package
221 * The encoding of the LyX file is always utf8 and has nothing to
222 * do with this setting.
223 * The difference between \c auto and \c default is that \c auto also
224 * causes loading of the inputenc package, while \c default does not.
225 * \c default will not work unless the user takes additional measures
226 * (such as using special environments like the CJK environment from
228 * \c default can be seen as an unspecified 8bit encoding, since LyX
229 * does not interpret it in any way apart from display on screen.
231 std::string inputenc;
232 /// The main encoding used by this buffer for LaTeX output.
233 /// Individual pieces of text can use different encodings.
234 Encoding const & encoding() const;
236 std::string preamble;
238 std::string local_layout;
241 /// use the class options defined in the layout?
242 bool use_default_options;
246 std::string float_placement;
248 unsigned int columns;
249 /// parameters for the listings package
250 std::string listings_params;
254 std::string pagestyle;
255 /// \param index should lie in the range 0 <= \c index <= 3.
256 Bullet & temp_bullet(size_type index);
257 Bullet const & temp_bullet(size_type index) const;
258 /// \param index should lie in the range 0 <= \c index <= 3.
259 Bullet & user_defined_bullet(size_type index);
260 Bullet const & user_defined_bullet(size_type index) const;
262 /// Whether to load a package such as amsmath or esint.
263 /// The enum values must not be changed (file format!)
265 /// Don't load the package. For experts only.
267 /// Load the package if needed (recommended)
269 /// Always load the package (e.g. if the document contains
270 /// some ERT that needs the package)
273 /// Whether and how to load amsmath
275 /// Whether and how to load esint
279 /// revision tracking for this buffer ?
281 /** This param decides whether change tracking marks should be used
282 * in output (irrespective of how these marks are actually defined;
283 * for instance, they may differ for DVI and PDF generation)
289 /// the author list for the document
290 AuthorList & authors();
291 AuthorList const & authors() const;
293 /// map of the file's author IDs to buffer author IDs
294 std::vector<unsigned int> author_map;
296 std::string const dvips_options() const;
297 /** The return value of paperSizeName() depends on the
298 * purpose for which the paper size is needed, since they
299 * support different subsets of paper sizes.
301 enum PapersizePurpose {
310 std::string paperSizeName(PapersizePurpose purpose) const;
311 /// set up if and how babel is called
312 std::string babelCall(std::string const & lang_opts) const;
313 /// handle inputenc etc.
314 void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
315 TexRow & texrow) const;
316 /// set up the document fonts
317 std::string const loadFonts(std::string const & rm,
318 std::string const & sf, std::string const & tt,
319 bool const & sc, bool const & osf,
320 int const & sfscale, int const & ttscale) const;
322 /// get the appropriate cite engine (natbib handling)
323 CiteEngine citeEngine() const;
325 void setCiteEngine(CiteEngine const);
327 /// options for pdf output
328 PDFOptions & pdfoptions();
329 PDFOptions const & pdfoptions() const;
333 void readPreamble(Lexer &);
335 void readLocalLayout(Lexer &);
337 void readLanguage(Lexer &);
339 void readGraphicsDriver(Lexer &);
341 void readBullets(Lexer &);
343 void readBulletsLaTeX(Lexer &);
345 void readModules(Lexer &);
347 void readRemovedModules(Lexer &);
349 void addDefaultModules();
350 /// checks for consistency among modules: makes sure requirements
351 /// are met, no modules exclude one another, etc, and resolves any
352 /// such conflicts, leaving us with a consistent collection.
353 /// \return true if modules were consistent, false if changes had
355 bool checkModuleConsistency();
357 /// for use with natbib
358 CiteEngine cite_engine_;
360 DocumentClass * doc_class_;
362 LayoutModuleList layoutModules_;
363 /// this is for modules that are required by the document class but that
364 /// the user has chosen not to use
365 std::set<std::string> removedModules_;
367 /** Use the Pimpl idiom to hide those member variables that would otherwise
368 * drag in other header files.
373 static Impl * clone(Impl const *);
374 static void destroy(Impl *);
376 support::copied_ptr<Impl, MemoryTraits> pimpl_;