src/LaTeXFonts.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LaTeXFonts.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jürgen Spitzmüller
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef LATEXFONTS_H
  13 #define LATEXFONTS_H
  14
  15 #include "support/docstring.h"
  16
  17 #include <map>
  18 #include <vector>
  19
  20
  21 namespace lyx {
  22
  23 class Lexer;
  24
  25 /// LaTeX Font definition
  26 class LaTeXFont {
  27 public:
  28         /// TeX font
  29         LaTeXFont() : switchdefault_(false) {}
  30         /// The font name
  31         docstring const & name() { return name_; }
  32         /// The name to appear in the document dialog
  33         docstring const & guiname() { return guiname_; }
  34         /// Font family (rm, sf, tt)
  35         docstring const & family() { return family_; }
  36         /// The package that provides this font
  37         docstring const & package() { return package_; }
  38         /// Alternative packages if package() is not available
  39         std::vector<docstring> const & altpackages() { return altpackages_; }
  40         /// A package that provides all families
  41         docstring const & completepackage() { return completepackage_; }
  42         /// A package specifically needed for OT1 font encoding
  43         docstring const & ot1package() { return ot1package_; }
  44         /// A package that provides Old Style Figures for this font
  45         docstring const & osfpackage() { return osfpackage_; }
  46         /// A package option needed to load this font
  47         docstring const & packageoption() { return packageoption_; }
  48         /// A package option for Old Style Figures
  49         docstring const & osfoption() { return osfoption_; }
  50         /// A package option for true SmallCaps
  51         docstring const & scoption() { return scoption_; }
  52         /// A package option for both Old Style Figures and SmallCaps
  53         docstring const & osfscoption() { return osfscoption_; }
  54         /// A package option for font scaling
  55         docstring const & scaleoption() { return scaleoption_; }
  56         /// Alternative requirement to test for
  57         docstring const & requires() { return requires_; }
  58         /// Issue the familydefault switch
  59         bool switchdefault() const { return switchdefault_; }
  60         /// Is this font available?
  61         bool available(bool ot1 = false) const;
  62         /// Does this font provide Old Style Figures?
  63         bool providesOSF(bool ot1 = false) const;
  64         /// Does this font provide optional true SmallCaps?
  65         bool providesSC(bool ot1 = false) const;
  66         /// Does this font provide scaling?
  67         bool providesScale(bool ot1 = false) const;
  68         /// Return the LaTeX Code
  69         std::string const getLaTeXCode(bool dryrun, bool ot1, bool complete,
  70                                        bool sc, bool osf,
  71                                        int const & scale = 100);
  72         ///
  73         bool read(Lexer & lex);
  74         ///
  75         bool readFont(Lexer & lex);
  76 private:
  77         /// Return the preferred available package
  78         std::string const getAvailablePackage(bool dryrun,
  79                                               bool ot1,
  80                                               bool complete,
  81                                               bool & alt);
  82         /// Return the package options
  83         std::string const getPackageOptions(bool ot1,
  84                                             bool sc,
  85                                             bool osf,
  86                                             int scale);
  87         ///
  88         docstring name_;
  89         ///
  90         docstring guiname_;
  91         ///
  92         docstring family_;
  93         ///
  94         docstring package_;
  95         ///
  96         std::vector<docstring> altpackages_;
  97         ///
  98         docstring completepackage_;
  99         ///
 100         docstring ot1package_;
 101         ///
 102         docstring osfpackage_;
 103         ///
 104         docstring packageoption_;
 105         ///
 106         docstring osfoption_;
 107         ///
 108         docstring scoption_;
 109         ///
 110         docstring osfscoption_;
 111         ///
 112         docstring scaleoption_;
 113         ///
 114         docstring requires_;
 115         ///
 116         bool switchdefault_;
 117         ///
 118         bool available_;
 119         ///
 120         bool available_ot1_;
 121 };
 122
 123
 124 /** The list of available LaTeX fonts
 125  */
 126 class LaTeXFonts {
 127 public:
 128         ///
 129         typedef std::map<docstring, LaTeXFont> TexFontMap;
 130         /// Get all LaTeXFonts
 131         TexFontMap getLaTeXFonts();
 132         /// Get a specific LaTeXFont \p name
 133         LaTeXFont getLaTeXFont(docstring const & name);
 134 private:
 135         ///
 136         void readLaTeXFonts();
 137         ///
 138         TexFontMap texfontmap_;
 139 };
 140
 141 /// Implementation is in LyX.cpp
 142 extern LaTeXFonts & theLaTeXFonts();
 143
 144
 145 } // namespace lyx
 146
 147 #endif