Rename isSpace to treatAsSpace. Move it and the rounding hack function into
[WebKit-https.git] / WebCore / platform / Font.cpp
1 /**
2  * This file is part of the html renderer for KDE.
3  *
4  * Copyright (C) 1999 Lars Knoll (knoll@kde.org)
5  *           (C) 1999 Antti Koivisto (koivisto@kde.org)
6  *           (C) 2000 Dirk Mueller (mueller@kde.org)
7  * Copyright (C) 2003, 2006 Apple Computer, Inc.
8  *
9  * This library is free software; you can redistribute it and/or
10  * modify it under the terms of the GNU Library General Public
11  * License as published by the Free Software Foundation; either
12  * version 2 of the License, or (at your option) any later version.
13  *
14  * This library is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
17  * Library General Public License for more details.
18  *
19  * You should have received a copy of the GNU Library General Public License
20  * along with this library; see the file COPYING.LIB.  If not, write to
21  * the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
22  * Boston, MA 02111-1307, USA.
23  *
24  */
25
26 #include "config.h"
27 #include "Font.h"
28 #include "FontData.h"
29
30 #include "FontFallbackList.h"
31 #include "GraphicsContext.h"
32 #include "KWQKHTMLSettings.h"
33
34 #include "GlyphBuffer.h"
35
36 #include <unicode/umachine.h>
37
38 namespace WebCore {
39
40 #if __APPLE__
41
42 // FIXME: Cross-platform eventually, but for now we compile only on OS X.
43
44 // According to http://www.unicode.org/Public/UNIDATA/UCD.html#Canonical_Combining_Class_Values
45 #define HIRAGANA_KATAKANA_VOICING_MARKS 8
46
47 const uint8_t Font::gRoundingHackCharacterTable[256] = {
48     0, 0, 0, 0, 0, 0, 0, 0, 0, 1 /*\t*/, 1 /*\n*/, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
49     1 /*space*/, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 /*-*/, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 1 /*?*/,
50     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
51     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
52     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
53     1 /*no-break space*/, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
54     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0,
55     0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0, 0
56 };
57
58 struct WidthIterator {
59     WidthIterator(const Font* font, const UChar* str, int from, int to, int len,
60                   int tabWidth, int xpos, int toAdd, TextDirection dir, bool visuallyOrdered,
61                   bool applyWordRounding, bool applyRunRounding, const FontData* substituteFontData);
62
63     void advance(int to, GlyphBuffer* glyphBuffer = 0);
64
65     const Font* m_font;
66
67     const UChar* m_characters;
68     int m_from;
69     int m_to;
70     int m_len;
71     int m_tabWidth;
72     int m_xPos;
73     int m_toAdd;
74     TextDirection m_dir;
75     bool m_visuallyOrdered;
76     bool m_applyWordRounding;
77     bool m_applyRunRounding;
78     const FontData* m_substituteFontData;
79
80     unsigned m_currentCharacter;
81     float m_runWidthSoFar;
82     float m_widthToStart;
83     float m_padding;
84     float m_padPerSpace;
85     float m_finalRoundingWidth;
86     
87 private:
88     UChar32 normalizeVoicingMarks();
89 };
90
91 WidthIterator::WidthIterator(const Font* font, const UChar* str, int from, int to, int len,
92                              int tabWidth, int xpos, int toAdd, TextDirection dir, bool visuallyOrdered,
93                              bool applyWordRounding, bool applyRunRounding, const FontData* substituteFontData)
94 :m_font(font), m_characters((const UChar*)str), m_from(from), m_to(to), m_len(len),
95  m_tabWidth(tabWidth), m_xPos(xpos), m_toAdd(toAdd), m_dir(dir), m_visuallyOrdered(visuallyOrdered),
96  m_applyWordRounding(applyWordRounding), m_applyRunRounding(applyRunRounding), m_substituteFontData(substituteFontData),
97  m_currentCharacter(from), m_runWidthSoFar(0), m_finalRoundingWidth(0)
98 {
99     // If the padding is non-zero, count the number of spaces in the run
100     // and divide that by the padding for per space addition.
101     if (!toAdd) {
102         m_padding = 0;
103         m_padPerSpace = 0;
104     } else {
105         float numSpaces = 0;
106         for (int i = from; i < to; i++)
107             if (Font::treatAsSpace(m_characters[i]))
108                 numSpaces++;
109
110         m_padding = toAdd;
111         m_padPerSpace = ceilf(m_padding / numSpaces);
112     }
113     
114     // Calculate width up to starting position of the run.  This is
115     // necessary to ensure that our rounding hacks are always consistently
116     // applied.
117     if (m_from == 0)
118         m_widthToStart = 0;
119     else {
120         WidthIterator startPositionIterator(font, str, 0, len, len, tabWidth, xpos, toAdd, dir, visuallyOrdered,
121                                             applyWordRounding, applyRunRounding, substituteFontData);
122         startPositionIterator.advance(from);
123         m_widthToStart = startPositionIterator.m_runWidthSoFar;
124     }
125 }
126
127 void WidthIterator::advance(int offset, GlyphBuffer* glyphBuffer)
128 {
129     if (offset > m_to)
130         offset = m_to;
131
132     int currentCharacter = m_currentCharacter;
133     const UChar* cp = &m_characters[currentCharacter];
134
135     bool rtl = (m_dir == RTL);
136     bool needCharTransform = rtl || m_font->isSmallCaps();
137     bool hasExtraSpacing = m_font->letterSpacing() || m_font->wordSpacing() || m_padding;
138
139     float runWidthSoFar = m_runWidthSoFar;
140     float lastRoundingWidth = m_finalRoundingWidth;
141
142     const FontData* primaryFontData = m_font->primaryFont();
143     
144     while (currentCharacter < offset) {
145         UChar32 c = *cp;
146         unsigned clusterLength = 1;
147         if (c >= 0x3041) {
148             if (c <= 0x30FE) {
149                 // Deal with Hiragana and Katakana voiced and semi-voiced syllables.
150                 // Normalize into composed form, and then look for glyph with base + combined mark.
151                 // Check above for character range to minimize performance impact.
152                 UChar32 normalized = normalizeVoicingMarks();
153                 if (normalized) {
154                     c = normalized;
155                     clusterLength = 2;
156                 }
157             } else if (U16_IS_SURROGATE(c)) {
158                 if (!U16_IS_SURROGATE_LEAD(c))
159                     break;
160
161                 // Do we have a surrogate pair?  If so, determine the full Unicode (32 bit)
162                 // code point before glyph lookup.
163                 // Make sure we have another character and it's a low surrogate.
164                 if (currentCharacter + 1 >= m_len)
165                     break;
166                 UniChar low = cp[1];
167                 if (!U16_IS_TRAIL(low))
168                     break;
169                 c = U16_GET_SUPPLEMENTARY(c, low);
170                 clusterLength = 2;
171             }
172         }
173
174         const FontData* fontData = m_substituteFontData ? m_substituteFontData :primaryFontData;
175
176         if (needCharTransform) {
177             if (rtl)
178                 c = u_charMirror(c);
179
180             // If small-caps, convert lowercase to upper.
181             if (m_font->isSmallCaps() && !u_isUUppercase(c)) {
182                 UChar32 upperC = u_toupper(c);
183                 if (upperC != c) {
184                     c = upperC;
185                     fontData = fontData->smallCapsFontData();
186                 }
187             }
188         }
189
190         // FIXME: Should go through fallback list eventually when we rework the glyph map.
191         Glyph glyph = fontData->glyphForCharacter(&fontData, c);
192
193         // Try to find a substitute font if this font didn't have a glyph for a character in the
194         // string. If one isn't found we end up drawing and measuring the 0 glyph, usually a box.
195         if (glyph == 0 && !m_substituteFontData) {
196             // FIXME: Should go through fallback list eventually.
197             const FontData* substituteFontData = fontData->findSubstituteFontData(cp, clusterLength, m_font->fontDescription());
198             if (substituteFontData) {
199                 GlyphBuffer localGlyphBuffer;
200                 m_font->floatWidthForSimpleText((UChar*)cp, clusterLength, 0, clusterLength, 0, 0, 0, m_dir, m_visuallyOrdered, 
201                                                  m_applyWordRounding, false, substituteFontData, 0, &localGlyphBuffer);
202                 if (localGlyphBuffer.size() == 1) {
203                     assert(substituteFontData == localGlyphBuffer.fontDataAt(0));
204                     glyph = localGlyphBuffer.glyphAt(0);
205                     fontData->updateGlyphMapEntry(c, glyph, substituteFontData);
206                     fontData = substituteFontData;
207                 }
208             }
209         }
210
211         // Now that we have a glyph and font data, get its width.
212         float width;
213         if (c == '\t' && m_tabWidth)
214             width = m_tabWidth - fmodf(m_xPos + runWidthSoFar, m_tabWidth);
215         else {
216             width = fontData->widthForGlyph(glyph);
217             // We special case spaces in two ways when applying word rounding.
218             // First, we round spaces to an adjusted width in all fonts.
219             // Second, in fixed-pitch fonts we ensure that all characters that
220             // match the width of the space character have the same width as the space character.
221             if (width == fontData->m_spaceWidth && (fontData->m_treatAsFixedPitch || glyph == fontData->m_spaceGlyph) && m_applyWordRounding)
222                 width = fontData->m_adjustedSpaceWidth;
223         }
224
225         if (hasExtraSpacing) {
226             // Account for letter-spacing.
227             if (width && m_font->letterSpacing())
228                 width += m_font->letterSpacing();
229
230             if (Font::treatAsSpace(c)) {
231                 // Account for padding. WebCore uses space padding to justify text.
232                 // We distribute the specified padding over the available spaces in the run.
233                 if (m_padding) {
234                     // Use left over padding if not evenly divisible by number of spaces.
235                     if (m_padding < m_padPerSpace) {
236                         width += m_padding;
237                         m_padding = 0;
238                     } else {
239                         width += m_padPerSpace;
240                         m_padding -= m_padPerSpace;
241                     }
242                 }
243
244                 // Account for word spacing.
245                 // We apply additional space between "words" by adding width to the space character.
246                 if (currentCharacter != 0 && !Font::treatAsSpace(cp[-1]) && m_font->wordSpacing())
247                     width += m_font->wordSpacing();
248             }
249         }
250
251         // Advance past the character we just dealt with.
252         cp += clusterLength;
253         currentCharacter += clusterLength;
254
255         // Account for float/integer impedance mismatch between CG and KHTML. "Words" (characters 
256         // followed by a character defined by isRoundingHackCharacter()) are always an integer width.
257         // We adjust the width of the last character of a "word" to ensure an integer width.
258         // If we move KHTML to floats we can remove this (and related) hacks.
259
260         float oldWidth = width;
261
262         // Force characters that are used to determine word boundaries for the rounding hack
263         // to be integer width, so following words will start on an integer boundary.
264         if (m_applyWordRounding && Font::isRoundingHackCharacter(c))
265             width = ceilf(width);
266
267         // Check to see if the next character is a "rounding hack character", if so, adjust
268         // width so that the total run width will be on an integer boundary.
269         if ((m_applyWordRounding && currentCharacter < m_len && Font::isRoundingHackCharacter(*cp))
270                 || (m_applyRunRounding && currentCharacter >= m_to)) {
271             float totalWidth = m_widthToStart + runWidthSoFar + width;
272             width += ceilf(totalWidth) - totalWidth;
273         }
274
275         runWidthSoFar += width;
276
277         if (glyphBuffer)
278             glyphBuffer->add(glyph, fontData, (rtl ? oldWidth + lastRoundingWidth : width));
279
280         lastRoundingWidth = width - oldWidth;
281     }
282
283     m_currentCharacter = currentCharacter;
284     m_runWidthSoFar = runWidthSoFar;
285     m_finalRoundingWidth = lastRoundingWidth;
286 }
287
288 UChar32 WidthIterator::normalizeVoicingMarks()
289 {
290     int currentCharacter = m_currentCharacter;
291     if (currentCharacter + 1 < m_to) {
292         if (u_getCombiningClass(m_characters[currentCharacter + 1]) == HIRAGANA_KATAKANA_VOICING_MARKS) {
293             // Normalize into composed form using 3.2 rules.
294             UChar normalizedCharacters[2] = { 0, 0 };
295             UErrorCode uStatus = (UErrorCode)0;  
296             int32_t resultLength = unorm_normalize(&m_characters[currentCharacter], 2,
297                 UNORM_NFC, UNORM_UNICODE_3_2, &normalizedCharacters[0], 2, &uStatus);
298             if (resultLength == 1 && uStatus == 0)
299                 return normalizedCharacters[0];
300         }
301     }
302     return 0;
303 }
304 #endif
305
306 // ============================================================================================
307 // Font Implementation (Cross-Platform Portion)
308 // ============================================================================================
309
310 Font::Font() :m_fontList(0), m_letterSpacing(0), m_wordSpacing(0) {}
311 Font::Font(const FontDescription& fd, short letterSpacing, short wordSpacing) 
312 : m_fontDescription(fd),
313   m_fontList(0),
314   m_letterSpacing(letterSpacing),
315   m_wordSpacing(wordSpacing)
316 {}
317
318 Font::Font(const Font& other)
319 {
320     m_fontDescription = other.m_fontDescription;
321     m_fontList = other.m_fontList;
322     m_letterSpacing = other.m_letterSpacing;
323     m_wordSpacing = other.m_wordSpacing;
324 }
325
326 Font& Font::operator=(const Font& other)
327 {
328     if (&other != this) {
329         m_fontDescription = other.m_fontDescription;
330         m_fontList = other.m_fontList;
331         m_letterSpacing = other.m_letterSpacing;
332         m_wordSpacing = other.m_wordSpacing;
333     }
334     return *this;
335 }
336
337 Font::~Font()
338 {
339 }
340
341 const FontData* Font::primaryFont() const
342 {
343     assert(m_fontList);
344     return m_fontList->primaryFont(m_fontDescription);
345 }
346
347 void Font::update() const
348 {
349     // FIXME: It is pretty crazy that we are willing to just poke into a RefPtr, but it ends up 
350     // being reasonably safe (because inherited fonts in the render tree pick up the new
351     // style anyway.  Other copies are transient, e.g., the state in the GraphicsContext, and
352     // won't stick around long enough to get you in trouble).  Still, this is pretty disgusting,
353     // and could eventually be rectified by using RefPtrs for Fonts themselves.
354     if (!m_fontList)
355         m_fontList = new FontFallbackList();
356     m_fontList->invalidate();
357 }
358
359 int Font::width(const UChar* chs, int slen, int pos, int len, int tabWidth, int xpos) const
360 {
361     // FIXME: Want to define an lroundf for win32.
362 #if __APPLE__
363     return lroundf(floatWidth(chs + pos, slen - pos, 0, len, tabWidth, xpos));
364 #else
365     return floatWidth(chs + pos, slen - pos, 0, len, tabWidth, xpos) + 0.5f;
366 #endif
367 }
368
369 int Font::ascent() const
370 {
371     assert(m_fontList);
372     return m_fontList->primaryFont(fontDescription())->ascent();
373 }
374
375 int Font::descent() const
376 {
377     assert(m_fontList);
378     return m_fontList->primaryFont(fontDescription())->descent();
379 }
380
381 int Font::lineSpacing() const
382 {
383     assert(m_fontList);
384     return m_fontList->primaryFont(fontDescription())->lineSpacing();
385 }
386
387 float Font::xHeight() const
388 {
389     assert(m_fontList);
390     return m_fontList->primaryFont(fontDescription())->xHeight();
391 }
392
393 bool Font::isFixedPitch() const
394 {
395     assert(m_fontList);
396     return m_fontList->isFixedPitch(fontDescription());
397 }
398
399 #if __APPLE__
400 // FIXME: These methods will eventually be cross-platform, but to keep Windows compiling we'll make this Apple-only for now.
401 bool Font::gAlwaysUseComplexPath = false;
402 void Font::setAlwaysUseComplexPath(bool alwaysUse)
403 {
404     gAlwaysUseComplexPath = alwaysUse;
405 }
406
407 bool Font::canUseGlyphCache(const UChar* str, int to) const
408 {
409     if (gAlwaysUseComplexPath)
410         return false;
411     
412     // Start from 0 since drawing and highlighting also measure the characters before run->from
413     for (int i = 0; i < to; i++) {
414         UChar c = str[i];
415         if (c < 0x300)      // U+0300 through U+036F Combining diacritical marks
416             continue;
417         if (c <= 0x36F)
418             return false;
419
420         if (c < 0x0591 || c == 0x05BE)     // U+0591 through U+05CF excluding U+05BE Hebrew combining marks, Hebrew punctuation Paseq, Sof Pasuq and Nun Hafukha
421             continue;
422         if (c <= 0x05CF)
423             return false;
424
425         if (c < 0x0600)     // U+0600 through U+1059 Arabic, Syriac, Thaana, Devanagari, Bengali, Gurmukhi, Gujarati, Oriya, Tamil, Telugu, Kannada, Malayalam, Sinhala, Thai, Lao, Tibetan, Myanmar
426             continue;
427         if (c <= 0x1059)
428             return false;
429
430         if (c < 0x1100)     // U+1100 through U+11FF Hangul Jamo (only Ancient Korean should be left here if you precompose; Modern Korean will be precomposed as a result of step A)
431             continue;
432         if (c <= 0x11FF)
433             return false;
434
435         if (c < 0x1780)     // U+1780 through U+18AF Khmer, Mongolian
436             continue;
437         if (c <= 0x18AF)
438             return false;
439
440         if (c < 0x1900)     // U+1900 through U+194F Limbu (Unicode 4.0)
441             continue;
442         if (c <= 0x194F)
443             return false;
444
445         if (c < 0x20D0)     // U+20D0 through U+20FF Combining marks for symbols
446             continue;
447         if (c <= 0x20FF)
448             return false;
449
450         if (c < 0xFE20)     // U+FE20 through U+FE2F Combining half marks
451             continue;
452         if (c <= 0xFE2F)
453             return false;
454     }
455
456     return true;
457
458 }
459
460 void Font::drawSimpleText(GraphicsContext* context, const IntPoint& point, int tabWidth, int xpos, const UChar* str, int len, int from, int to,
461                           int toAdd, TextDirection dir, bool visuallyOrdered) const
462 {
463     // This glyph buffer holds our glyphs+advances+font data for each glyph.
464     GlyphBuffer glyphBuffer;
465
466     // Our measuring code will generate glyphs and advances for us.
467     float startX;
468     floatWidthForSimpleText(str, len, from, to, tabWidth, xpos, toAdd, dir, visuallyOrdered, 
469                             true, true, 0,
470                             &startX, &glyphBuffer);
471     
472     // We couldn't generate any glyphs for the run.  Give up.
473     if (glyphBuffer.isEmpty())
474         return;
475     
476     // Calculate the starting point of the glyphs to be displayed by adding
477     // all the advances up to the first glyph.
478     startX += point.x();
479     FloatPoint startPoint(startX, point.y());
480
481     // Swap the order of the glyphs if right-to-left.
482     if (dir == RTL)
483         for (int i = 0, end = glyphBuffer.size() - 1; i < glyphBuffer.size() / 2; ++i, --end)
484             glyphBuffer.swap(i, end);
485
486     // Draw each contiguous run of glyphs that use the same font data.
487     const FontData* fontData = glyphBuffer.fontDataAt(0);
488     float nextX = startX;
489     int lastFrom = 0;
490     int nextGlyph = 0;
491     while (nextGlyph < glyphBuffer.size()) {
492         const FontData* nextFontData = glyphBuffer.fontDataAt(nextGlyph);
493         if (nextFontData != fontData) {
494             drawGlyphs(context, fontData, glyphBuffer, lastFrom, nextGlyph - lastFrom, startPoint);
495             lastFrom = nextGlyph;
496             fontData = nextFontData;
497             startPoint.setX(nextX);
498         }
499         nextX += glyphBuffer.advanceAt(nextGlyph);
500         nextGlyph++;
501     }
502     drawGlyphs(context, fontData, glyphBuffer, lastFrom, nextGlyph - lastFrom, startPoint);
503 }
504
505 void Font::drawText(GraphicsContext* context, const IntPoint& point, int tabWidth, int xpos, const UChar* str, int len, int from, int to,
506                     int toAdd, TextDirection d, bool visuallyOrdered) const
507 {
508     if (len == 0)
509         return;
510
511     if (from < 0)
512         from = 0;
513     if (to < 0)
514         to = len;
515
516     if (canUseGlyphCache(str, to))
517         drawSimpleText(context, point, tabWidth, xpos, str, len, from, to, toAdd, d, visuallyOrdered);
518     else
519         drawComplexText(context, point, tabWidth, xpos, str, len, from, to, toAdd, d, visuallyOrdered);
520 }
521
522 float Font::floatWidth(const UChar* str, int slen, int from, int len, int tabWidth, int xpos, bool runRounding) const
523 {
524     int to = from + len;
525     if (canUseGlyphCache(str, to))
526         return floatWidthForSimpleText(str, slen, from, to, tabWidth, xpos, 0, LTR, false, true, runRounding, 0, 0, 0);
527     else
528         return floatWidthForComplexText(str, slen, from, to, tabWidth, xpos, runRounding);
529 }
530
531 float Font::floatWidthForSimpleText(const UChar* str, int len, int from, int to, int tabWidth, int xpos, int toAdd, 
532                                     TextDirection dir, bool visuallyOrdered, 
533                                     bool applyWordRounding, bool applyRunRounding,
534                                     const FontData* substituteFont,
535                                     float* startPosition, GlyphBuffer* glyphBuffer) const
536 {
537     WidthIterator it(this, str, from, dir == LTR ? to : len, len, tabWidth, xpos, toAdd, dir, visuallyOrdered, 
538                      applyWordRounding, applyRunRounding, substituteFont);
539     it.advance(to, glyphBuffer);
540     float runWidth = it.m_runWidthSoFar;
541     if (startPosition) {
542         if (dir == LTR)
543             *startPosition = it.m_widthToStart;
544         else {
545             float finalRoundingWidth = it.m_finalRoundingWidth;
546             it.advance(len);
547             *startPosition = it.m_runWidthSoFar - runWidth + finalRoundingWidth;
548         }
549     }
550     return runWidth;
551 }
552 #endif
553
554 }