2 * \file GuiFontMetrics.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
9 * Full author contact details are available in file CREDITS.
14 #include "GuiFontMetrics.h"
16 #include "qt_helpers.h"
19 #include "Dimension.h"
21 #include "support/unicode.h"
23 #include <boost/assert.hpp>
31 * Convert a UCS4 character into a QChar.
32 * This is a hack (it does only make sense for the common part of the UCS4
33 * and UTF16 encodings) and should not be used.
34 * This does only exist because of performance reasons (a real conversion
35 * using iconv is too slow on windows).
37 static inline QChar const ucs4_to_qchar(char_type const ucs4)
39 BOOST_ASSERT(is_utf16(ucs4));
40 return QChar(static_cast<unsigned short>(ucs4));
44 // Caution: When using ucs4_to_qchar() in these methods, this is no
45 // real conversion but a simple cast in reality. This is the reason
46 // why this works well for symbol fonts used in mathed too, even though
47 // these are not real ucs4 characters. These are codepoints in the
48 // modern fonts used, nothing unicode related.
49 // See comment in QLPainter::text() for more explanation.
51 GuiFontMetrics::GuiFontMetrics(QFont const & font)
52 : metrics_(font), smallcaps_metrics_(font), smallcaps_shape_(false)
57 GuiFontMetrics::GuiFontMetrics(QFont const & font, QFont const & smallcaps_font)
58 : metrics_(font), smallcaps_metrics_(smallcaps_font), smallcaps_shape_(true)
63 int GuiFontMetrics::maxAscent() const
65 return metrics_.ascent();
69 int GuiFontMetrics::maxDescent() const
71 // We add 1 as the value returned by QT is different than X
72 // See http://doc.trolltech.com/2.3/qfontmetrics.html#200b74
73 return metrics_.descent() + 1;
77 int GuiFontMetrics::lbearing(char_type c) const
80 // FIXME: QFontMetrics::leftBearingdoes not support the
81 // full unicode range. Once it does, we could use:
82 //return metrics_.leftBearing(toqstr(docstring(1,c)));
85 return metrics_.leftBearing(ucs4_to_qchar(c));
90 int const outOfLimitMetric = -10000;
94 int GuiFontMetrics::rbearing(char_type c) const
96 int value = rbearing_cache_.value(c, outOfLimitMetric);
97 if (value != outOfLimitMetric)
100 // Qt rbearing is from the right edge of the char's width().
102 QChar sc = ucs4_to_qchar(c);
103 value = width(c) - metrics_.rightBearing(sc);
105 // FIXME: QFontMetrics::leftBearingdoes not support the
106 // full unicode range. Once it does, we could use:
107 // metrics_.rightBearing(toqstr(docstring(1,c)));
110 rbearing_cache_.insert(c, value);
116 int GuiFontMetrics::smallcapsWidth(char_type c) const
118 // FIXME: Optimisation probably needed: we don't use the width cache.
120 QChar const qc = ucs4_to_qchar(c);
121 QChar const uc = qc.toUpper();
123 return smallcaps_metrics_.width(uc);
125 return metrics_.width(qc);
127 QString const s = toqstr(docstring(1,c));
128 QString const us = s.toUpper();
130 return smallcaps_metrics_.width(us);
132 return metrics_.width(s);
137 int GuiFontMetrics::width(docstring const & s) const
139 size_t ls = s.size();
141 for (unsigned int i = 0; i < ls; ++i) {
142 //FIXME: we need to detect surrogate pairs and act accordingly
144 if isSurrogateBase(s[i]) {
146 if (smallcaps_shape_)
147 w += metrics_.width(toqstr(c + s[i + 1]));
149 w += smallcaps_metrics_.width(toqstr(c + s[i + 1]));
161 int GuiFontMetrics::width(QString const & ucs2) const
163 return width(qstring_to_ucs4(ucs2));
167 int GuiFontMetrics::signedWidth(docstring const & s) const
173 return -width(s.substr(1, s.size() - 1));
179 void GuiFontMetrics::rectText(docstring const & str,
180 int & w, int & ascent, int & descent) const
182 static int const d = 2;
183 w = width(str) + d * 2 + 2;
184 ascent = metrics_.ascent() + d;
185 descent = metrics_.descent() + d;
190 void GuiFontMetrics::buttonText(docstring const & str,
191 int & w, int & ascent, int & descent) const
193 static int const d = 3;
194 w = width(str) + d * 2 + 2;
195 ascent = metrics_.ascent() + d;
196 descent = metrics_.descent() + d;
200 Dimension const GuiFontMetrics::defaultDimension() const
202 return Dimension(0, maxAscent(), maxDescent());
206 Dimension const GuiFontMetrics::dimension(char_type c) const
208 return Dimension(width(c), ascent(c), descent(c));
212 GuiFontMetrics::AscendDescend const GuiFontMetrics::fillMetricsCache(
217 r = metrics_.boundingRect(ucs4_to_qchar(c));
219 r = metrics_.boundingRect(toqstr(docstring(1,c)));
221 AscendDescend ad = { -r.top(), r.bottom() + 1};
222 // We could as well compute the width but this is not really
223 // needed for now as it is done directly in width() below.
224 metrics_cache_.insert(c, ad);
230 int GuiFontMetrics::width(char_type c) const
232 if (smallcaps_shape_)
233 return smallcapsWidth(c);
235 int value = width_cache_.value(c, outOfLimitMetric);
236 if (value != outOfLimitMetric)
240 value = metrics_.width(ucs4_to_qchar(c));
242 value = metrics_.width(toqstr(docstring(1, c)));
244 width_cache_.insert(c, value);
250 int GuiFontMetrics::ascent(char_type c) const
252 static AscendDescend const outOfLimitAD =
253 {outOfLimitMetric, outOfLimitMetric};
254 AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
255 if (value.ascent != outOfLimitMetric)
258 value = fillMetricsCache(c);
263 int GuiFontMetrics::descent(char_type c) const
265 static AscendDescend const outOfLimitAD =
266 {outOfLimitMetric, outOfLimitMetric};
267 AscendDescend value = metrics_cache_.value(c, outOfLimitAD);
268 if (value.descent != outOfLimitMetric)
269 return value.descent;
271 value = fillMetricsCache(c);
272 return value.descent;