src/frontends/qt/GuiFontMetrics.h

   1 // -*- C++ -*-
   2 /**
   3  * \file GuiFontMetrics.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #ifndef GUI_FONT_METRICS_H
  13 #define GUI_FONT_METRICS_H
  14
  15 #include "frontends/FontMetrics.h"
  16
  17 #include "support/Cache.h"
  18 #include "support/docstring.h"
  19
  20 #include <QFont>
  21 #include <QFontMetrics>
  22 #include <QHash>
  23 #include <QTextLayout>
  24
  25 #include <memory>
  26
  27 namespace lyx {
  28 namespace frontend {
  29
  30 class GuiFontMetrics : public FontMetrics
  31 {
  32 public:
  33         GuiFontMetrics(QFont const & font);
  34
  35         virtual ~GuiFontMetrics() {}
  36
  37         virtual int maxAscent() const;
  38         virtual int maxDescent() const;
  39         virtual Dimension const defaultDimension() const;
  40         virtual int em() const;
  41         virtual int xHeight() const;
  42         virtual int lineWidth() const;
  43         virtual int underlinePos() const;
  44         virtual int strikeoutPos() const;
  45         virtual bool italic() const;
  46         virtual double italicSlope() const;
  47         virtual int width(char_type c) const;
  48         virtual int ascent(char_type c) const;
  49         virtual int descent(char_type c) const;
  50         virtual int lbearing(char_type c) const;
  51         virtual int rbearing(char_type c) const;
  52         virtual int width(docstring const & s) const;
  53         virtual int signedWidth(docstring const & s) const;
  54         virtual int pos2x(docstring const & s, int pos, bool rtl, double ws) const;
  55         virtual int x2pos(docstring const & s, int & x, bool rtl, double ws) const;
  56         virtual bool breakAt(docstring & s, int & x, bool rtl, bool force) const;
  57         virtual Dimension const dimension(char_type c) const;
  58
  59         virtual void rectText(docstring const & str,
  60                 int & width,
  61                 int & ascent,
  62                 int & descent) const;
  63         virtual void buttonText(docstring const & str,
  64                 const int offset,
  65                 int & width,
  66                 int & ascent,
  67                 int & descent) const;
  68
  69         int countExpanders(docstring const & str) const;
  70         ///
  71         int width(QString const & str) const;
  72
  73         /// Return a pointer to a cached QTextLayout object
  74         std::shared_ptr<QTextLayout const>
  75         getTextLayout(docstring const & s, bool const rtl,
  76                       double const wordspacing) const;
  77
  78 private:
  79
  80         std::pair<int, int> breakAt_helper(docstring const & s, int const x,
  81                                            bool const rtl, bool const force) const;
  82
  83         /// The font
  84         QFont font_;
  85
  86         /// Metrics on the font
  87         QFontMetrics metrics_;
  88
  89         /// Slope of italic font
  90         double slope_;
  91
  92         /// Cache of char widths
  93         mutable QHash<char_type, int> width_cache_;
  94         /// Cache of string widths
  95         mutable Cache<docstring, int> strwidth_cache_;
  96         /// Cache for breakAt
  97         mutable Cache<docstring, std::pair<int, int>> breakat_cache_;
  98         /// Cache for QTextLayout
  99         mutable Cache<docstring, std::shared_ptr<QTextLayout>> qtextlayout_cache_;
 100
 101         struct AscendDescend {
 102                 int ascent;
 103                 int descent;
 104         };
 105         /// Cache of char ascends and descends
 106         mutable QHash<char_type, AscendDescend> metrics_cache_;
 107         /// fill in \c metrics_cache_ at specified value.
 108         AscendDescend const fillMetricsCache(char_type) const;
 109
 110         /// Cache of char left bearings
 111         mutable QHash<char_type, int> lbearing_cache_;
 112         /// Cache of char right bearings
 113         mutable QHash<char_type, int> rbearing_cache_;
 114
 115 };
 116
 117 } // namespace frontend
 118 } // namespace lyx
 119
 120 #endif // GUI_FONT_METRICS_H