src/Font.h

   1 // -*- C++ -*-
   2 /**
   3  * \file src/Font.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 Angus Leeming
  10  * \author Dekel Tsur
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef FONT_H
  16 #define FONT_H
  17
  18 #include "FontInfo.h"
  19
  20 #include "support/strfwd.h"
  21
  22
  23 namespace lyx {
  24
  25 class BufferParams;
  26 class Language;
  27 class LaTeXFeatures;
  28 class OutputParams;
  29 class otexstream;
  30
  31 ///
  32 class Font {
  33
  34 public:
  35         ///
  36         explicit Font(FontInfo = sane_font, Language const * l = nullptr);
  37
  38         ///
  39         FontInfo & fontInfo() { return bits_; }
  40         ///
  41         FontInfo const & fontInfo() const { return bits_; }
  42         ///
  43         Language const * language() const { return lang_; }
  44         ///
  45         bool isRightToLeft() const;
  46         ///
  47         bool isVisibleRightToLeft() const;
  48         ///
  49         void setLanguage(Language const * l);
  50
  51         /// Returns size of font in LaTeX text notation
  52         std::string const latexSize() const;
  53
  54         /** Updates font settings according to request.
  55             If an attribute is IGNORE, the attribute is left as it is.
  56             When toggleall = true, all properties that matches the font in use
  57             will have the effect that the properties is reset to the
  58             default.  If we have a text that is TYPEWRITER_FAMILY, and is
  59             update()'ed with TYPEWRITER_FAMILY, the operation will be as if
  60             a INHERIT_FAMILY was asked for.  This is necessary for the
  61             toggle-user-defined-style button on the toolbar.
  62         */
  63         void update(Font const & newfont,
  64                     Language const * default_lang,
  65                     bool toggleall = false);
  66
  67         /// Writes the changes from this font to orgfont in .lyx format in file
  68         void lyxWriteChanges(Font const & orgfont, std::ostream &) const;
  69
  70         /** Writes the head of the LaTeX needed to change to this font.
  71             Writes to string, the head of the LaTeX needed to change
  72             to this font. Returns number of chars written. Base is the
  73             font state active now.
  74         */
  75         int latexWriteStartChanges(otexstream &, BufferParams const & bparams,
  76                                    OutputParams const & runparams,
  77                                    Font const & base,
  78                                    Font const & prev,
  79                                    bool const & non_inherit_inset = false,
  80                                    bool const & needs_cprotection = false) const;
  81
  82         /** Writes the tail of the LaTeX needed to change to this font.
  83             Returns number of chars written. Base is the font state we want
  84             to achieve.
  85         */
  86         int latexWriteEndChanges(otexstream &, BufferParams const & bparams,
  87                                  OutputParams const & runparams,
  88                                  Font const & base,
  89                                  Font const & next,
  90                                  bool & needPar,
  91                                  bool const & closeLanguage = true) const;
  92
  93
  94         /// Build GUI description of font state
  95         docstring const stateText(BufferParams * params = nullptr, bool const terse = false) const;
  96
  97         ///
  98         void validate(LaTeXFeatures & features) const;
  99
 100         ///
 101         friend
 102         bool operator==(Font const & font1, Font const & font2);
 103         ///
 104         friend
 105         std::ostream & operator<<(std::ostream & os, Font const & font);
 106
 107         /// Set \param data using \param font and \param toggle.
 108         std::string toString(bool toggle) const;
 109
 110         /// Set \param font and \param toggle using \param data. Return success.
 111         bool fromString(std::string const & data, bool & toggle);
 112
 113 private:
 114         ///
 115         FontInfo bits_;
 116         ///
 117         Language const * lang_;
 118         /// Did latexWriteStartChanges open an encoding environment?
 119         mutable bool open_encoding_;
 120 };
 121
 122
 123 ///
 124 inline
 125 bool operator==(Font const & font1, Font const & font2)
 126 {
 127         return font1.bits_ == font2.bits_ && font1.lang_ == font2.lang_;
 128 }
 129
 130 ///
 131 inline
 132 bool operator!=(Font const & font1, Font const & font2)
 133 {
 134         return !(font1 == font2);
 135 }
 136
 137 } // namespace lyx
 138
 139 #endif