src/BufferParams.h

   1 // -*- C++ -*-
   2 /**
   3  * \file BufferParams.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef BUFFERPARAMS_H
  16 #define BUFFERPARAMS_H
  17
  18 #include "Citation.h"
  19 #include "Font.h"
  20 #include "LayoutModuleList.h"
  21 #include "paper.h"
  22
  23 #include "insets/InsetQuotes.h"
  24
  25 #include "support/copied_ptr.h"
  26
  27 #include <list>
  28 #include <vector>
  29
  30 namespace lyx {
  31
  32 namespace support { class FileName; }
  33
  34 class AuthorList;
  35 class BranchList;
  36 class Bullet;
  37 class DocumentClass;
  38 class Encoding;
  39 class Language;
  40 class LatexFeatures;
  41 class LayoutFile;
  42 class LayoutFileIndex;
  43 class Lexer;
  44 class PDFOptions;
  45 class Spacing;
  46 class TexRow;
  47 class VSpace;
  48
  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
  52  *  is in public.
  53  */
  54 class BufferParams {
  55 public:
  56         ///
  57         enum ParagraphSeparation {
  58                 ///
  59                 ParagraphIndentSeparation,
  60                 ///
  61                 ParagraphSkipSeparation
  62         };
  63         ///
  64         BufferParams();
  65
  66         /// get l10n translated to the buffers language
  67         docstring B_(std::string const & l10n) const;
  68
  69         /// read a header token, if unrecognised, return it or an unknown class name
  70         std::string readToken(Lexer & lex,
  71                 std::string const & token, ///< token to read.
  72                 support::FileName const & filepath);
  73
  74         ///
  75         void writeFile(std::ostream &) const;
  76
  77         /// check what features are implied by the buffer parameters.
  78         void validate(LaTeXFeatures &) const;
  79
  80         /** \returns true if the babel package is used (interogates
  81          *  the BufferParams and a LyXRC variable).
  82          *  This returned value can then be passed to the insets...
  83          */
  84         bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
  85
  86         ///
  87         void useClassDefaults();
  88         ///
  89         bool hasClassDefaults() const;
  90
  91         ///
  92         VSpace const & getDefSkip() const;
  93         ///
  94         void setDefSkip(VSpace const & vs);
  95
  96         /** Whether paragraphs are separated by using a indent like in
  97          *  articles or by using a little skip like in letters.
  98          */
  99         ParagraphSeparation paragraph_separation;
 100         ///
 101         InsetQuotes::QuoteLanguage quotes_language;
 102         ///
 103         InsetQuotes::QuoteTimes quotes_times;
 104         ///
 105         std::string fontsize;
 106         ///Get the LayoutFile this document is using.
 107         LayoutFile const * baseClass() const;
 108         ///
 109         LayoutFileIndex const & baseClassID() const;
 110         /// Set the LyX layout file this document is using.
 111         /// NOTE: This does not call makeDocumentClass() to update the local
 112         /// DocumentClass. That needs to be done manually.
 113         /// \param filename the name of the layout file
 114         bool setBaseClass(std::string const & classname);
 115         /// Adds the module information to the baseClass information to
 116         /// create our local DocumentClass.
 117         void makeDocumentClass();
 118         /// Returns the DocumentClass currently in use: the BaseClass as modified
 119         /// by modules.
 120         DocumentClass const & documentClass() const;
 121         /// \return A pointer to the DocumentClass currently in use: the BaseClass
 122         /// as modified by modules.
 123         DocumentClass const * documentClassPtr() const;
 124         /// This bypasses the baseClass and sets the textClass directly.
 125         /// Should be called with care and would be better not being here,
 126         /// but it seems to be needed by CutAndPaste::putClipboard().
 127         void setDocumentClass(DocumentClass const * const);
 128         /// List of modules in use
 129         LayoutModuleList const & getModules() const { return layoutModules_; }
 130         /// List of default modules the user has removed
 131         std::list<std::string> const & getRemovedModules() const
 132                         { return removedModules_; }
 133         ///
 134         /// Add a module to the list of modules in use. This checks only that the
 135         /// module is not already in the list, so use moduleIsCompatible first if
 136         /// you want to check for compatibility.
 137         /// \return true if module was successfully added.
 138         bool addLayoutModule(std::string const & modName);
 139         /// checks to make sure module's requriements are satisfied, that it does
 140         /// not conflict with already-present modules, isn't already loaded, etc.
 141         bool moduleCanBeAdded(std::string const & modName) const;
 142         ///
 143         void addRemovedModule(std::string const & modName)
 144                         { removedModules_.push_back(modName); }
 145         /// Clear the list
 146         void clearLayoutModules() { layoutModules_.clear(); }
 147         /// Clear the removed module list
 148         void clearRemovedModules() { removedModules_.clear(); }
 149
 150         /// returns the main font for the buffer (document)
 151         Font const getFont() const;
 152
 153         /* this are for the PaperLayout */
 154         /// the papersize
 155         PAPER_SIZE papersize;
 156         ///
 157         PAPER_ORIENTATION orientation;
 158         /// use custom margins
 159         bool use_geometry;
 160         ///
 161         std::string paperwidth;
 162         ///
 163         std::string paperheight;
 164         ///
 165         std::string leftmargin;
 166         ///
 167         std::string topmargin;
 168         ///
 169         std::string rightmargin;
 170         ///
 171         std::string bottommargin;
 172         ///
 173         std::string headheight;
 174         ///
 175         std::string headsep;
 176         ///
 177         std::string footskip;
 178         ///
 179         std::string columnsep;
 180
 181         /* some LaTeX options */
 182         /// The graphics driver
 183         std::string graphicsDriver;
 184         /// The default output format
 185         std::string defaultOutputFormat;
 186         /// the rm font
 187         std::string fontsRoman;
 188         /// the sf font
 189         std::string fontsSans;
 190         /// the tt font
 191         std::string fontsTypewriter;
 192         /// the default family (rm, sf, tt)
 193         std::string fontsDefaultFamily;
 194         /// use the XeTeX processor
 195         bool useXetex;
 196         /// use expert Small Caps
 197         bool fontsSC;
 198         /// use Old Style Figures
 199         bool fontsOSF;
 200         /// the scale factor of the sf font
 201         int fontsSansScale;
 202         /// the scale factor of the tt font
 203         int fontsTypewriterScale;
 204         /// the font used by the CJK command
 205         std::string fontsCJK;
 206         ///
 207         Spacing & spacing();
 208         Spacing const & spacing() const;
 209         ///
 210         int secnumdepth;
 211         ///
 212         int tocdepth;
 213         ///
 214         Language const * language;
 215         /// BranchList:
 216         BranchList & branchlist();
 217         BranchList const & branchlist() const;
 218         /**
 219          * The input encoding for LaTeX. This can be one of
 220          * - \c auto: find out the input encoding from the used languages
 221          * - \c default: ditto
 222          * - any encoding supported by the inputenc package
 223          * The encoding of the LyX file is always utf8 and has nothing to
 224          * do with this setting.
 225          * The difference between \c auto and \c default is that \c auto also
 226          * causes loading of the inputenc package, while \c default does not.
 227          * \c default will not work unless the user takes additional measures
 228          * (such as using special environments like the CJK environment from
 229          * CJK.sty).
 230          * \c default can be seen as an unspecified 8bit encoding, since LyX
 231          * does not interpret it in any way apart from display on screen.
 232          */
 233         std::string inputenc;
 234         /// The main encoding used by this buffer for LaTeX output.
 235         /// Individual pieces of text can use different encodings.
 236         Encoding const & encoding() const;
 237         ///
 238         std::string preamble;
 239         ///
 240         std::string local_layout;
 241         ///
 242         std::string options;
 243         /// use the class options defined in the layout?
 244         bool use_default_options;
 245         ///
 246         std::string master;
 247         ///
 248         std::string float_placement;
 249         ///
 250         unsigned int columns;
 251         /// parameters for the listings package
 252         std::string listings_params;
 253         ///
 254         PageSides sides;
 255         ///
 256         std::string pagestyle;
 257         /// \param index should lie in the range 0 <= \c index <= 3.
 258         Bullet & temp_bullet(size_type index);
 259         Bullet const & temp_bullet(size_type index) const;
 260         /// \param index should lie in the range 0 <= \c index <= 3.
 261         Bullet & user_defined_bullet(size_type index);
 262         Bullet const & user_defined_bullet(size_type index) const;
 263
 264         /// Whether to load a package such as amsmath or esint.
 265         /// The enum values must not be changed (file format!)
 266         enum Package {
 267                 /// Don't load the package. For experts only.
 268                 package_off = 0,
 269                 /// Load the package if needed (recommended)
 270                 package_auto = 1,
 271                 /// Always load the package (e.g. if the document contains
 272                 /// some ERT that needs the package)
 273                 package_on = 2
 274         };
 275         /// Whether and how to load amsmath
 276         Package use_amsmath;
 277         /// Whether and how to load esint
 278         Package use_esint;
 279         ///
 280         bool use_bibtopic;
 281         /// revision tracking for this buffer ?
 282         bool trackChanges;
 283         /** This param decides whether change tracking marks should be used
 284          *  in output (irrespective of how these marks are actually defined;
 285          *  for instance, they may differ for DVI and PDF generation)
 286          */
 287         bool outputChanges;
 288         ///
 289         bool compressed;
 290
 291         /// the author list for the document
 292         AuthorList & authors();
 293         AuthorList const & authors() const;
 294
 295         /// map of the file's author IDs to buffer author IDs
 296         std::vector<unsigned int> author_map;
 297         ///
 298         std::string const dvips_options() const;
 299         /** The return value of paperSizeName() depends on the
 300          *  purpose for which the paper size is needed, since they
 301          *  support different subsets of paper sizes.
 302         */
 303         enum PapersizePurpose {
 304                 ///
 305                 DVIPS,
 306                 ///
 307                 DVIPDFM,
 308                 ///
 309                 XDVI
 310         };
 311         ///
 312         std::string paperSizeName(PapersizePurpose purpose) const;
 313         /// set up if and how babel is called
 314         std::string babelCall(std::string const & lang_opts) const;
 315         /// return supported drivers for specific packages
 316         docstring getGraphicsDriver(std::string const & package) const;
 317         /// handle inputenc etc.
 318         void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
 319                                               TexRow & texrow) const;
 320         ///
 321         std::string const parseFontName(std::string const & name) const;
 322         /// set up the document fonts
 323         std::string const loadFonts(std::string const & rm,
 324                                      std::string const & sf, std::string const & tt,
 325                                      bool const & sc, bool const & osf,
 326                                      int const & sfscale, int const & ttscale,
 327                                      bool const & xetex) const;
 328
 329         /// get the appropriate cite engine (natbib handling)
 330         CiteEngine citeEngine() const;
 331         ///
 332         void setCiteEngine(CiteEngine const);
 333
 334         /// options for pdf output
 335         PDFOptions & pdfoptions();
 336         PDFOptions const & pdfoptions() const;
 337
 338 private:
 339         ///
 340         void readPreamble(Lexer &);
 341         ///
 342         void readLocalLayout(Lexer &);
 343         ///
 344         void readLanguage(Lexer &);
 345         ///
 346         void readGraphicsDriver(Lexer &);
 347         ///
 348         void readBullets(Lexer &);
 349         ///
 350         void readBulletsLaTeX(Lexer &);
 351         ///
 352         void readModules(Lexer &);
 353         ///
 354         void readRemovedModules(Lexer &);
 355         /// for use with natbib
 356         CiteEngine cite_engine_;
 357         ///
 358         DocumentClass * doc_class_;
 359         ///
 360         LayoutModuleList layoutModules_;
 361         /// this is for modules that are required by the document class but that
 362         /// the user has chosen not to use
 363         std::list<std::string> removedModules_;
 364
 365         /** Use the Pimpl idiom to hide those member variables that would otherwise
 366          *  drag in other header files.
 367          */
 368         class Impl;
 369         class MemoryTraits {
 370         public:
 371                 static Impl * clone(Impl const *);
 372                 static void destroy(Impl *);
 373         };
 374         support::copied_ptr<Impl, MemoryTraits> pimpl_;
 375
 376 };
 377
 378 } // namespace lyx
 379
 380 #endif