[Win] Remove -DUCHAR_TYPE=wchar_t stopgap and learn to live with char16_t.
[WebKit-https.git] / Source / WebCore / platform / graphics / win / UniscribeController.cpp
1 /*
2  * Copyright (C) 2007, 2008, 2009, 2010 Apple Inc. All rights reserved.
3  *
4  * Redistribution and use in source and binary forms, with or without
5  * modification, are permitted provided that the following conditions
6  * are met:
7  * 1. Redistributions of source code must retain the above copyright
8  *    notice, this list of conditions and the following disclaimer.
9  * 2. Redistributions in binary form must reproduce the above copyright
10  *    notice, this list of conditions and the following disclaimer in the
11  *    documentation and/or other materials provided with the distribution.
12  *
13  * THIS SOFTWARE IS PROVIDED BY APPLE INC. AND ITS CONTRIBUTORS ``AS IS''
14  * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO,
15  * THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
16  * PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL APPLE INC. OR ITS CONTRIBUTORS
17  * BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
18  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
19  * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
20  * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
21  * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
22  * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
23  * THE POSSIBILITY OF SUCH DAMAGE.
24  */
25
26 #include "config.h"
27 #include "UniscribeController.h"
28
29 #include "Font.h"
30 #include "FontCascade.h"
31 #include "HWndDC.h"
32 #include "TextRun.h"
33 #include <wtf/MathExtras.h>
34 #include <wtf/text/win/WCharStringExtras.h>
35
36 namespace WebCore {
37 using namespace WTF::Unicode;
38
39 // FIXME: Rearchitect this to be more like WidthIterator in Font.cpp.  Have an advance() method
40 // that does stuff in that method instead of doing everything in the constructor.  Have advance()
41 // take the GlyphBuffer as an arg so that we don't have to populate the glyph buffer when
42 // measuring.
43 UniscribeController::UniscribeController(const FontCascade* font, const TextRun& run, HashSet<const Font*>* fallbackFonts)
44     : m_font(*font)
45     , m_run(run)
46     , m_fallbackFonts(fallbackFonts)
47     , m_minGlyphBoundingBoxX(std::numeric_limits<float>::max())
48     , m_maxGlyphBoundingBoxX(std::numeric_limits<float>::min())
49     , m_minGlyphBoundingBoxY(std::numeric_limits<float>::max())
50     , m_maxGlyphBoundingBoxY(std::numeric_limits<float>::min())
51     , m_currentCharacter(0)
52     , m_end(run.length())
53     , m_runWidthSoFar(0)
54     , m_padding(run.expansion())
55     , m_computingOffsetPosition(false)
56     , m_includePartialGlyphs(false)
57     , m_offsetX(0)
58     , m_offsetPosition(0)
59 {
60     if (!m_padding)
61         m_padPerSpace = 0;
62     else {
63         float numSpaces = 0;
64         for (int s = 0; s < m_run.length(); s++) {
65             if (FontCascade::treatAsSpace(m_run[s]))
66                 numSpaces++;
67         }
68
69         if (numSpaces == 0)
70             m_padPerSpace = 0;
71         else
72             m_padPerSpace = m_padding / numSpaces;
73     }
74
75     // Null out our uniscribe structs
76     resetControlAndState();
77 }
78
79 int UniscribeController::offsetForPosition(int x, bool includePartialGlyphs)
80 {
81     m_computingOffsetPosition = true;
82     m_includePartialGlyphs = includePartialGlyphs;
83     m_offsetX = x;
84     m_offsetPosition = 0;
85     advance(m_run.length());
86     if (m_computingOffsetPosition) {
87         // The point is to the left or to the right of the entire run.
88         if ((m_offsetX >= m_runWidthSoFar && m_run.ltr()) || (m_offsetX < 0 && m_run.rtl()))
89             m_offsetPosition = m_end;
90     }
91     m_computingOffsetPosition = false;
92     return m_offsetPosition;
93 }
94
95 void UniscribeController::advance(unsigned offset, GlyphBuffer* glyphBuffer)
96 {
97     // FIXME: We really want to be using a newer version of Uniscribe that supports the new OpenType
98     // functions.  Those functions would allow us to turn off kerning and ligatures.  Without being able
99     // to do that, we will have buggy line breaking and metrics when simple and complex text are close
100     // together (the complex code path will narrow the text because of kerning and ligatures and then
101     // when bidi processing splits into multiple runs, the simple portions will get wider and cause us to
102     // spill off the edge of a line).
103     if (static_cast<int>(offset) > m_end)
104         offset = m_end;
105
106     int length = offset - m_currentCharacter;
107     if (length <= 0)
108         return;
109
110     String bufferFor16BitData;
111
112     // Itemize the string.
113     const UChar* cp = nullptr;
114     if (m_run.is8Bit()) {
115         // Uniscribe only deals with 16-bit characters. Must generate them now.
116         bufferFor16BitData = String::make16BitFrom8BitSource(m_run.data8(m_currentCharacter), length);
117         cp = bufferFor16BitData.characters16();
118     } else
119         cp = m_run.data16(m_currentCharacter);
120
121     unsigned baseCharacter = m_currentCharacter;
122
123     // We break up itemization of the string by fontData and (if needed) the use of small caps.
124
125     // FIXME: It's inconsistent that we use logical order when itemizing, since this
126     // does not match normal RTL.
127
128     // FIXME: This function should decode surrogate pairs. Currently it makes little difference that
129     // it does not because the font cache on Windows does not support non-BMP characters.
130     Vector<UChar, 256> smallCapsBuffer;
131     if (m_font.isSmallCaps())
132         smallCapsBuffer.resize(length);
133
134     unsigned indexOfFontTransition = m_run.rtl() ? length - 1 : 0;
135     const UChar* curr = m_run.rtl() ? cp + length  - 1 : cp;
136     const UChar* end = m_run.rtl() ? cp - 1 : cp + length;
137
138     const Font* fontData;
139     const Font* nextFontData = m_font.glyphDataForCharacter(*curr, false).font;
140
141     UChar newC = 0;
142
143     bool isSmallCaps;
144     bool nextIsSmallCaps = m_font.isSmallCaps() && !(U_GET_GC_MASK(*curr) & U_GC_M_MASK) && (newC = u_toupper(*curr)) != *curr;
145
146     if (nextIsSmallCaps)
147         smallCapsBuffer[curr - cp] = newC;
148
149     while (true) {
150         curr = m_run.rtl() ? curr - 1 : curr + 1;
151         if (curr == end)
152             break;
153
154         fontData = nextFontData;
155         isSmallCaps = nextIsSmallCaps;
156         int index = curr - cp;
157         UChar c = *curr;
158
159         bool forceSmallCaps = isSmallCaps && (U_GET_GC_MASK(c) & U_GC_M_MASK);
160         nextFontData = m_font.glyphDataForCharacter(*curr, false, forceSmallCaps ? SmallCapsVariant : AutoVariant).font;
161         if (m_font.isSmallCaps()) {
162             nextIsSmallCaps = forceSmallCaps || (newC = u_toupper(c)) != c;
163             if (nextIsSmallCaps)
164                 smallCapsBuffer[index] = forceSmallCaps ? c : newC;
165         }
166
167         if (m_fallbackFonts && fontData && nextFontData != fontData && fontData != &m_font.primaryFont())
168             m_fallbackFonts->add(fontData);
169
170         if (nextFontData != fontData || nextIsSmallCaps != isSmallCaps) {
171             int itemStart = m_run.rtl() ? index + 1 : indexOfFontTransition;
172             int itemLength = m_run.rtl() ? indexOfFontTransition - index : index - indexOfFontTransition;
173             m_currentCharacter = baseCharacter + itemStart;
174             itemizeShapeAndPlace((isSmallCaps ? smallCapsBuffer.data() : cp) + itemStart, itemStart, itemLength, fontData, glyphBuffer);
175             indexOfFontTransition = index;
176         }
177     }
178     
179     int itemLength = m_run.rtl() ? indexOfFontTransition + 1 : length - indexOfFontTransition;
180     if (itemLength) {
181         if (m_fallbackFonts && nextFontData && nextFontData != &m_font.primaryFont())
182             m_fallbackFonts->add(nextFontData);
183
184         int itemStart = m_run.rtl() ? 0 : indexOfFontTransition;
185         m_currentCharacter = baseCharacter + itemStart;
186         itemizeShapeAndPlace((nextIsSmallCaps ? smallCapsBuffer.data() : cp) + itemStart, itemStart, itemLength, nextFontData, glyphBuffer);
187     }
188
189     m_currentCharacter = baseCharacter + length;
190 }
191
192 void UniscribeController::itemizeShapeAndPlace(const UChar* cp, unsigned stringOffset, unsigned length, const Font* fontData, GlyphBuffer* glyphBuffer)
193 {
194     // ScriptItemize (in Windows XP versions prior to SP2) can overflow by 1.  This is why there is an extra empty item
195     // hanging out at the end of the array
196     m_items.resize(6);
197     int numItems = 0;
198     HRESULT rc = S_OK;
199     while (rc = ::ScriptItemize(wcharFrom(cp), length, m_items.size() - 1, &m_control, &m_state, m_items.data(), &numItems) == E_OUTOFMEMORY) {
200         m_items.resize(m_items.size() * 2);
201         resetControlAndState();
202     }
203     if (FAILED(rc)) {
204         WTFLogAlways("UniscribeController::itemizeShapeAndPlace: ScriptItemize failed, rc=%lx", rc);
205         return;
206     }
207     m_items.resize(numItems + 1);
208
209     if (m_run.rtl()) {
210         for (int i = m_items.size() - 2; i >= 0; i--) {
211             if (!shapeAndPlaceItem(cp, stringOffset, i, fontData, glyphBuffer))
212                 return;
213         }
214     } else {
215         for (unsigned i = 0; i < m_items.size() - 1; i++) {
216             if (!shapeAndPlaceItem(cp, stringOffset, i, fontData, glyphBuffer))
217                 return;
218         }
219     }
220 }
221
222 void UniscribeController::resetControlAndState()
223 {
224     memset(&m_control, 0, sizeof(SCRIPT_CONTROL));
225     memset(&m_state, 0, sizeof(SCRIPT_STATE));
226
227     // Set up the correct direction for the run.
228     m_state.uBidiLevel = m_run.rtl();
229     
230     // Lock the correct directional override.
231     m_state.fOverrideDirection = m_run.directionalOverride();
232 }
233
234 bool UniscribeController::shapeAndPlaceItem(const UChar* cp, unsigned stringOffset, unsigned i, const Font* fontData, GlyphBuffer* glyphBuffer)
235 {
236     // Determine the string for this item.
237     const UChar* str = cp + m_items[i].iCharPos;
238     int len = m_items[i+1].iCharPos - m_items[i].iCharPos;
239     SCRIPT_ITEM item = m_items[i];
240
241     // Set up buffers to hold the results of shaping the item.
242     Vector<WORD> glyphs;
243     Vector<WORD> clusters;
244     Vector<SCRIPT_VISATTR> visualAttributes;
245     clusters.resize(len);
246      
247     // Shape the item.
248     // The recommended size for the glyph buffer is 1.5 * the character length + 16 in the uniscribe docs.
249     // Apparently this is a good size to avoid having to make repeated calls to ScriptShape.
250     glyphs.resize(1.5 * len + 16);
251     visualAttributes.resize(glyphs.size());
252
253     if (!shape(str, len, item, fontData, glyphs, clusters, visualAttributes))
254         return true;
255
256     Vector<Optional<unsigned>> stringOffsets(glyphs.size());
257     for (unsigned i = 0; i < len; ++i) {
258         if (stringOffsets[clusters[i]])
259             stringOffsets[clusters[i]] = std::min(*stringOffsets[clusters[i]], i);
260         else
261             stringOffsets[clusters[i]] = i;
262     }
263
264     // We now have a collection of glyphs.
265     Vector<GOFFSET> offsets;
266     Vector<int> advances;
267     offsets.resize(glyphs.size());
268     advances.resize(glyphs.size());
269     HRESULT placeResult = ScriptPlace(0, fontData->scriptCache(), glyphs.data(), glyphs.size(), visualAttributes.data(),
270                                       &item.a, advances.data(), offsets.data(), 0);
271     if (placeResult == E_PENDING) {
272         // The script cache isn't primed with enough info yet.  We need to select our HFONT into
273         // a DC and pass the DC in to ScriptPlace.
274         HWndDC hdc(0);
275         HFONT hfont = fontData->platformData().hfont();
276         HFONT oldFont = (HFONT)SelectObject(hdc, hfont);
277         placeResult = ScriptPlace(hdc, fontData->scriptCache(), glyphs.data(), glyphs.size(), visualAttributes.data(),
278                                   &item.a, advances.data(), offsets.data(), 0);
279         SelectObject(hdc, oldFont);
280     }
281     
282     if (FAILED(placeResult) || glyphs.isEmpty())
283         return true;
284
285     // Convert all chars that should be treated as spaces to use the space glyph.
286     // We also create a map that allows us to quickly go from space glyphs back to their corresponding characters.
287     Vector<int> spaceCharacters(glyphs.size());
288     spaceCharacters.fill(-1);
289
290     const float cLogicalScale = fontData->platformData().useGDI() ? 1.0f : 32.0f;
291     float spaceWidth = fontData->spaceWidth() - fontData->syntheticBoldOffset();
292     unsigned logicalSpaceWidth = spaceWidth * cLogicalScale;
293
294     for (int k = 0; k < len; k++) {
295         UChar ch = *(str + k);
296         bool treatAsSpace = FontCascade::treatAsSpace(ch);
297         bool treatAsZeroWidthSpace = FontCascade::treatAsZeroWidthSpace(ch);
298         if (treatAsSpace || treatAsZeroWidthSpace) {
299             // Substitute in the space glyph at the appropriate place in the glyphs
300             // array.
301             glyphs[clusters[k]] = fontData->spaceGlyph();
302             advances[clusters[k]] = treatAsSpace ? logicalSpaceWidth : 0;
303             if (treatAsSpace)
304                 spaceCharacters[clusters[k]] = m_currentCharacter + k + item.iCharPos;
305         }
306     }
307
308     // Populate our glyph buffer with this information.
309     bool hasExtraSpacing = m_font.letterSpacing() || m_font.wordSpacing() || m_padding;
310     
311     float leftEdge = m_runWidthSoFar;
312
313     for (unsigned k = 0; k < glyphs.size(); k++) {
314         Glyph glyph = glyphs[k];
315         float advance = advances[k] / cLogicalScale;
316         float offsetX = offsets[k].du / cLogicalScale;
317         float offsetY = offsets[k].dv / cLogicalScale;
318
319         // Match AppKit's rules for the integer vs. non-integer rendering modes.
320         float roundedAdvance = roundf(advance);
321         if (!fontData->platformData().isSystemFont()) {
322             advance = roundedAdvance;
323             offsetX = roundf(offsetX);
324             offsetY = roundf(offsetY);
325         }
326
327         advance += fontData->syntheticBoldOffset();
328
329         if (hasExtraSpacing) {
330             // If we're a glyph with an advance, go ahead and add in letter-spacing.
331             // That way we weed out zero width lurkers.  This behavior matches the fast text code path.
332             if (advance && m_font.letterSpacing())
333                 advance += m_font.letterSpacing();
334
335             // Handle justification and word-spacing.
336             int characterIndex = spaceCharacters[k];
337             // characterIndex is left at the initial value of -1 for glyphs that do not map back to treated-as-space characters.
338             if (characterIndex != -1) {
339                 // Account for padding. WebCore uses space padding to justify text.
340                 // We distribute the specified padding over the available spaces in the run.
341                 if (m_padding) {
342                     // Use leftover padding if not evenly divisible by number of spaces.
343                     if (m_padding < m_padPerSpace) {
344                         advance += m_padding;
345                         m_padding = 0;
346                     } else {
347                         m_padding -= m_padPerSpace;
348                         advance += m_padPerSpace;
349                     }
350                 }
351
352                 // Account for word-spacing.
353                 if (characterIndex > 0 && m_font.wordSpacing()) {
354                     UChar candidateSpace;
355                     if (m_run.is8Bit())
356                         candidateSpace = *(m_run.data8(characterIndex - 1));
357                     else
358                         candidateSpace = *(m_run.data16(characterIndex - 1));
359
360                     if (!FontCascade::treatAsSpace(candidateSpace))
361                         advance += m_font.wordSpacing();
362                 }
363             }
364         }
365
366         m_runWidthSoFar += advance;
367
368         // FIXME: We need to take the GOFFSETS for combining glyphs and store them in the glyph buffer
369         // as well, so that when the time comes to draw those glyphs, we can apply the appropriate
370         // translation.
371         if (glyphBuffer) {
372             GlyphBufferAdvance origin(offsetX, -offsetY);
373             if (!glyphBuffer->advancesCount())
374                 glyphBuffer->setInitialAdvance(origin);
375             else
376                 glyphBuffer->expandLastAdvance(origin);
377             GlyphBufferAdvance glyphAdvance(-origin.width() + advance, -origin.height());
378             glyphBuffer->add(glyph, fontData, glyphAdvance, stringOffsets[k].valueOr(0) + stringOffset);
379         }
380
381         FloatRect glyphBounds = fontData->boundsForGlyph(glyph);
382         glyphBounds.move(m_glyphOrigin.x(), m_glyphOrigin.y());
383         m_minGlyphBoundingBoxX = std::min(m_minGlyphBoundingBoxX, glyphBounds.x());
384         m_maxGlyphBoundingBoxX = std::max(m_maxGlyphBoundingBoxX, glyphBounds.maxX());
385         m_minGlyphBoundingBoxY = std::min(m_minGlyphBoundingBoxY, glyphBounds.y());
386         m_maxGlyphBoundingBoxY = std::max(m_maxGlyphBoundingBoxY, glyphBounds.maxY());
387         m_glyphOrigin.move(advance + offsetX, -offsetY);
388
389         // Mutate the glyph array to contain our altered advances.
390         if (m_computingOffsetPosition)
391             advances[k] = advance;
392     }
393
394     while (m_computingOffsetPosition && m_offsetX >= leftEdge && m_offsetX < m_runWidthSoFar) {
395         // The position is somewhere inside this run.
396         int trailing = 0;
397         HRESULT rc = ::ScriptXtoCP(m_offsetX - leftEdge, clusters.size(), glyphs.size(), clusters.data(), visualAttributes.data(),
398                     advances.data(), &item.a, &m_offsetPosition, &trailing);
399         if (FAILED(rc)) {
400             WTFLogAlways("UniscribeController::shapeAndPlaceItem: ScriptXtoCP failed rc=%lx", rc);
401             return true;
402         }
403         if (trailing && m_includePartialGlyphs && m_offsetPosition < len - 1) {
404             m_offsetPosition += m_currentCharacter + m_items[i].iCharPos;
405             m_offsetX += m_run.rtl() ? -trailing : trailing;
406         } else {
407             m_computingOffsetPosition = false;
408             m_offsetPosition += m_currentCharacter + m_items[i].iCharPos;
409             if (trailing && m_includePartialGlyphs)
410                m_offsetPosition++;
411             return false;
412         }
413     }
414
415     return true;
416 }
417
418 bool UniscribeController::shape(const UChar* str, int len, SCRIPT_ITEM item, const Font* fontData,
419                                 Vector<WORD>& glyphs, Vector<WORD>& clusters,
420                                 Vector<SCRIPT_VISATTR>& visualAttributes)
421 {
422     HWndDC hdc;
423     HFONT oldFont = 0;
424     HRESULT shapeResult = E_PENDING;
425     int glyphCount = 0;
426
427     if (!fontData)
428         return false;
429
430     do {
431         shapeResult = ScriptShape(hdc, fontData->scriptCache(), wcharFrom(str), len, glyphs.size(), &item.a,
432                                   glyphs.data(), clusters.data(), visualAttributes.data(), &glyphCount);
433         if (shapeResult == E_PENDING) {
434             // The script cache isn't primed with enough info yet.  We need to select our HFONT into
435             // a DC and pass the DC in to ScriptShape.
436             ASSERT(!hdc);
437             hdc.setHWnd(0);
438             HFONT hfont = fontData->platformData().hfont();
439             oldFont = (HFONT)SelectObject(hdc, hfont);
440         } else if (shapeResult == E_OUTOFMEMORY) {
441             // Need to resize our buffers.
442             glyphs.resize(glyphs.size() * 2);
443             visualAttributes.resize(glyphs.size());
444         }
445     } while (shapeResult == E_PENDING || shapeResult == E_OUTOFMEMORY);
446
447     if (hdc)
448         SelectObject(hdc, oldFont);
449
450     if (FAILED(shapeResult))
451         return false;
452
453     glyphs.shrink(glyphCount);
454     visualAttributes.shrink(glyphCount);
455
456     return true;
457 }
458
459 }