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 <set>
  29 #include <vector>
  30
  31 namespace lyx {
  32
  33 namespace support { class FileName; }
  34
  35 class AuthorList;
  36 class BranchList;
  37 class Bullet;
  38 class DocumentClass;
  39 class Encoding;
  40 class Language;
  41 class LatexFeatures;
  42 class LayoutFile;
  43 class LayoutFileIndex;
  44 class Lexer;
  45 class PDFOptions;
  46 class Spacing;
  47 class TexRow;
  48 class VSpace;
  49
  50 /** Buffer parameters.
  51  *  This class contains all the parameters for this buffer's use. Some
  52  *  work needs to be done on this class to make it nice. Now everything
  53  *  is in public.
  54  */
  55 class BufferParams {
  56 public:
  57         ///
  58         enum ParagraphSeparation {
  59                 ///
  60                 ParagraphIndentSeparation,
  61                 ///
  62                 ParagraphSkipSeparation
  63         };
  64         ///
  65         BufferParams();
  66
  67         /// get l10n translated to the buffers language
  68         docstring B_(std::string const & l10n) const;
  69
  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);
  74
  75         ///
  76         void writeFile(std::ostream &) const;
  77
  78         /// check what features are implied by the buffer parameters.
  79         void validate(LaTeXFeatures &) const;
  80
  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...
  84          */
  85         bool writeLaTeX(odocstream &, LaTeXFeatures &, TexRow &) const;
  86
  87         ///
  88         void useClassDefaults();
  89         ///
  90         bool hasClassDefaults() const;
  91
  92         ///
  93         VSpace const & getDefSkip() const;
  94         ///
  95         void setDefSkip(VSpace const & vs);
  96
  97         /** Whether paragraphs are separated by using a indent like in
  98          *  articles or by using a little skip like in letters.
  99          */
 100         ParagraphSeparation paragraph_separation;
 101         ///
 102         InsetQuotes::QuoteLanguage quotes_language;
 103         ///
 104         InsetQuotes::QuoteTimes quotes_times;
 105         ///
 106         std::string fontsize;
 107         ///Get the LayoutFile this document is using.
 108         LayoutFile const * baseClass() const;
 109         ///
 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
 120         /// by modules.
 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_; }
 134         ///
 135         /// Add a module to the list of modules in use. This checks only that the
 136         /// module is not already in the list, so use moduleIsCompatible first if
 137         /// you want to check for compatibility.
 138         /// \return true if module was successfully added.
 139         bool addLayoutModule(std::string const & modName);
 140         /// checks to make sure module's requriements are satisfied, that it does
 141         /// not conflict with already-present modules, isn't already loaded, etc.
 142         bool moduleCanBeAdded(std::string const & modName) const;
 143         ///
 144         void addRemovedModule(std::string const & modName)
 145                         { removedModules_.insert(modName); }
 146         /// Clear the list
 147         void clearLayoutModules() { layoutModules_.clear(); }
 148         /// Clear the removed module list
 149         void clearRemovedModules() { removedModules_.clear(); }
 150
 151         /// returns the main font for the buffer (document)
 152         Font const getFont() const;
 153
 154         /* this are for the PaperLayout */
 155         /// the papersize
 156         PAPER_SIZE papersize;
 157         ///
 158         PAPER_ORIENTATION orientation;
 159         /// use custom margins
 160         bool use_geometry;
 161         ///
 162         std::string paperwidth;
 163         ///
 164         std::string paperheight;
 165         ///
 166         std::string leftmargin;
 167         ///
 168         std::string topmargin;
 169         ///
 170         std::string rightmargin;
 171         ///
 172         std::string bottommargin;
 173         ///
 174         std::string headheight;
 175         ///
 176         std::string headsep;
 177         ///
 178         std::string footskip;
 179         ///
 180         std::string columnsep;
 181
 182         /* some LaTeX options */
 183         /// The graphics driver
 184         std::string graphicsDriver;
 185         /// the rm font
 186         std::string fontsRoman;
 187         /// the sf font
 188         std::string fontsSans;
 189         /// the tt font
 190         std::string fontsTypewriter;
 191         /// the default family (rm, sf, tt)
 192         std::string fontsDefaultFamily;
 193         /// use expert Small Caps
 194         bool fontsSC;
 195         /// use Old Style Figures
 196         bool fontsOSF;
 197         /// the scale factor of the sf font
 198         int fontsSansScale;
 199         /// the scale factor of the tt font
 200         int fontsTypewriterScale;
 201         /// the font used by the CJK command
 202         std::string fontsCJK;
 203         ///
 204         Spacing & spacing();
 205         Spacing const & spacing() const;
 206         ///
 207         int secnumdepth;
 208         ///
 209         int tocdepth;
 210         ///
 211         Language const * language;
 212         /// BranchList:
 213         BranchList & branchlist();
 214         BranchList const & branchlist() const;
 215         /**
 216          * The input encoding for LaTeX. This can be one of
 217          * - \c auto: find out the input encoding from the used languages
 218          * - \c default: ditto
 219          * - any encoding supported by the inputenc package
 220          * The encoding of the LyX file is always utf8 and has nothing to
 221          * do with this setting.
 222          * The difference between \c auto and \c default is that \c auto also
 223          * causes loading of the inputenc package, while \c default does not.
 224          * \c default will not work unless the user takes additional measures
 225          * (such as using special environments like the CJK environment from
 226          * CJK.sty).
 227          * \c default can be seen as an unspecified 8bit encoding, since LyX
 228          * does not interpret it in any way apart from display on screen.
 229          */
 230         std::string inputenc;
 231         /// The main encoding used by this buffer for LaTeX output.
 232         /// Individual pieces of text can use different encodings.
 233         Encoding const & encoding() const;
 234         ///
 235         std::string preamble;
 236         ///
 237         std::string local_layout;
 238         ///
 239         std::string options;
 240         /// use the class options defined in the layout?
 241         bool use_default_options;
 242         ///
 243         std::string master;
 244         ///
 245         std::string float_placement;
 246         ///
 247         unsigned int columns;
 248         /// parameters for the listings package
 249         std::string listings_params;
 250         ///
 251         PageSides sides;
 252         ///
 253         std::string pagestyle;
 254         /// \param index should lie in the range 0 <= \c index <= 3.
 255         Bullet & temp_bullet(size_type index);
 256         Bullet const & temp_bullet(size_type index) const;
 257         /// \param index should lie in the range 0 <= \c index <= 3.
 258         Bullet & user_defined_bullet(size_type index);
 259         Bullet const & user_defined_bullet(size_type index) const;
 260
 261         /// Whether to load a package such as amsmath or esint.
 262         /// The enum values must not be changed (file format!)
 263         enum Package {
 264                 /// Don't load the package. For experts only.
 265                 package_off = 0,
 266                 /// Load the package if needed (recommended)
 267                 package_auto = 1,
 268                 /// Always load the package (e.g. if the document contains
 269                 /// some ERT that needs the package)
 270                 package_on = 2
 271         };
 272         /// Whether and how to load amsmath
 273         Package use_amsmath;
 274         /// Whether and how to load esint
 275         Package use_esint;
 276         ///
 277         bool use_bibtopic;
 278         /// revision tracking for this buffer ?
 279         bool trackChanges;
 280         /** This param decides whether change tracking marks should be used
 281          *  in output (irrespective of how these marks are actually defined;
 282          *  for instance, they may differ for DVI and PDF generation)
 283          */
 284         bool outputChanges;
 285         ///
 286         bool compressed;
 287
 288         /// the author list for the document
 289         AuthorList & authors();
 290         AuthorList const & authors() const;
 291
 292         /// map of the file's author IDs to buffer author IDs
 293         std::vector<unsigned int> author_map;
 294         ///
 295         std::string const dvips_options() const;
 296         /** The return value of paperSizeName() depends on the
 297          *  purpose for which the paper size is needed, since they
 298          *  support different subsets of paper sizes.
 299         */
 300         enum PapersizePurpose {
 301                 ///
 302                 DVIPS,
 303                 ///
 304                 DVIPDFM,
 305                 ///
 306                 XDVI
 307         };
 308         ///
 309         std::string paperSizeName(PapersizePurpose purpose) const;
 310         /// set up if and how babel is called
 311         std::string babelCall(std::string const & lang_opts) const;
 312         /// return supported drivers for specific packages
 313         docstring getGraphicsDriver(std::string const & package) const;
 314         /// handle inputenc etc.
 315         void writeEncodingPreamble(odocstream & os, LaTeXFeatures & features,
 316                                               TexRow & texrow) const;
 317         /// set up the document fonts
 318         std::string const loadFonts(std::string const & rm,
 319                                      std::string const & sf, std::string const & tt,
 320                                      bool const & sc, bool const & osf,
 321                                      int const & sfscale, int const & ttscale) const;
 322
 323         /// get the appropriate cite engine (natbib handling)
 324         CiteEngine citeEngine() const;
 325         ///
 326         void setCiteEngine(CiteEngine const);
 327
 328         /// options for pdf output
 329         PDFOptions & pdfoptions();
 330         PDFOptions const & pdfoptions() const;
 331
 332 private:
 333         ///
 334         void readPreamble(Lexer &);
 335         ///
 336         void readLocalLayout(Lexer &);
 337         ///
 338         void readLanguage(Lexer &);
 339         ///
 340         void readGraphicsDriver(Lexer &);
 341         ///
 342         void readBullets(Lexer &);
 343         ///
 344         void readBulletsLaTeX(Lexer &);
 345         ///
 346         void readModules(Lexer &);
 347         ///
 348         void readRemovedModules(Lexer &);
 349         /// Called when the document class changes. Removes modules
 350         /// excluded by, provided by, etc, the document class.
 351         /// \return true if modules were consistent, false if changes had
 352         /// to be made.
 353         bool removeBadModules();
 354         /// Adds default modules, if they're addable.
 355         void addDefaultModules();
 356         /// checks for consistency among modules: makes sure requirements
 357         /// are met, no modules exclude one another, etc, and resolves any
 358         /// such conflicts, leaving us with a consistent collection.
 359         /// \return true if modules were consistent, false if changes had
 360         /// to be made.
 361         bool checkModuleConsistency();
 362
 363         /// for use with natbib
 364         CiteEngine cite_engine_;
 365         ///
 366         DocumentClass * doc_class_;
 367         ///
 368         LayoutModuleList layoutModules_;
 369         /// this is for modules that are required by the document class but that
 370         /// the user has chosen not to use
 371         std::set<std::string> removedModules_;
 372
 373         /** Use the Pimpl idiom to hide those member variables that would otherwise
 374          *  drag in other header files.
 375          */
 376         class Impl;
 377         class MemoryTraits {
 378         public:
 379                 static Impl * clone(Impl const *);
 380                 static void destroy(Impl *);
 381         };
 382         support::copied_ptr<Impl, MemoryTraits> pimpl_;
 383
 384 };
 385
 386 } // namespace lyx
 387
 388 #endif