6eac6b19f3df7f1df7ddcc7d7920442740b1301b
[WebKit-https.git] / WebCore / platform / win / UniscribeController.cpp
1 /*
2  * Copyright (C) 2007 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  *
8  * 1.  Redistributions of source code must retain the above copyright
9  *     notice, this list of conditions and the following disclaimer. 
10  * 2.  Redistributions in binary form must reproduce the above copyright
11  *     notice, this list of conditions and the following disclaimer in the
12  *     documentation and/or other materials provided with the distribution. 
13  * 3.  Neither the name of Apple Computer, Inc. ("Apple") nor the names of
14  *     its contributors may be used to endorse or promote products derived
15  *     from this software without specific prior written permission. 
16  *
17  * THIS SOFTWARE IS PROVIDED BY APPLE AND ITS CONTRIBUTORS "AS IS" AND ANY
18  * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
19  * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
20  * DISCLAIMED. IN NO EVENT SHALL APPLE OR ITS CONTRIBUTORS BE LIABLE FOR ANY
21  * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
22  * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
23  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
24  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
25  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
26  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
27  */
28
29 #include "config.h"
30 #include "UniscribeController.h"
31 #include "Font.h"
32 #include "FontData.h"
33 #include "FontStyle.h"
34 #include <wtf/MathExtras.h>
35
36 namespace WebCore {
37
38 // FIXME: Rearchitect this to be more like WidthIterator in Font.cpp.  Have an advance() method
39 // that does stuff in that method instead of doing everything in the constructor.  Have advance()
40 // take the GlyphBuffer as an arg so that we don't have to populate the glyph buffer when
41 // measuring.
42 UniscribeController::UniscribeController(const Font* font, const TextRun& run, const FontStyle& style)
43 : m_font(*font)
44 , m_run(run)
45 , m_style(style)
46 , m_end(run.length())
47 , m_currentCharacter(0)
48 , m_runWidthSoFar(0)
49 , m_computingOffsetPosition(false)
50 , m_includePartialGlyphs(false)
51 , m_offsetX(0)
52 , m_offsetPosition(0)
53 {
54     m_padding = m_style.padding();
55     if (!m_padding)
56         m_padPerSpace = 0;
57     else {
58         float numSpaces = 0;
59         for (int s = 0; s < m_run.length(); s++)
60             if (Font::treatAsSpace(m_run[s]))
61                 numSpaces++;
62
63         if (numSpaces == 0)
64             m_padPerSpace = 0;
65         else
66             m_padPerSpace = ceilf(m_style.padding() / numSpaces);
67     }
68
69     // Null out our uniscribe structs
70     resetControlAndState();
71 }
72
73 int UniscribeController::offsetForPosition(int x, bool includePartialGlyphs)
74 {
75     m_computingOffsetPosition = true;
76     m_includePartialGlyphs = includePartialGlyphs;
77     m_offsetX = x;
78     m_offsetPosition = 0;
79     advance(m_run.length());
80     if (m_computingOffsetPosition) {
81         // The point is to the left or to the right of the entire run.
82         if (m_offsetX >= m_runWidthSoFar && m_style.ltr() || m_offsetX < 0 && m_style.rtl())
83             m_offsetPosition = m_end;
84     }
85     m_computingOffsetPosition = false;
86     return m_offsetPosition;
87 }
88
89 void UniscribeController::advance(unsigned offset, GlyphBuffer* glyphBuffer)
90 {
91     // FIXME: We really want to be using a newer version of Uniscribe that supports the new OpenType
92     // functions.  Those functions would allow us to turn off kerning and ligatures.  Without being able
93     // to do that, we will have buggy line breaking and metrics when simple and complex text are close
94     // together (the complex code path will narrow the text because of kerning and ligatures and then
95     // when bidi processing splits into multiple runs, the simple portions will get wider and cause us to
96     // spill off the edge of a line).
97     if (static_cast<int>(offset) > m_end)
98         offset = m_end;
99
100     // Itemize the string.
101     const UChar* cp = m_run.data(m_currentCharacter);
102     int length = offset - m_currentCharacter;
103     if (length <= 0)
104         return;
105
106     // We break up itemization of the string if small caps is involved.
107     // Adjust the characters to account for small caps if it is set.
108     if (m_font.isSmallCaps()) {
109         // FIXME: It's inconsistent that we use logical order when itemizing, since this
110         // does not match normal RTL.
111         Vector<UChar> smallCapsBuffer(length);
112         memcpy(smallCapsBuffer.data(), cp, length * sizeof(UChar));
113         bool isSmallCaps = false;
114         unsigned indexOfCaseShift = m_style.rtl() ? length - 1 : 0;
115         const UChar* curr = m_style.rtl() ? cp + length  - 1: cp;
116         const UChar* end = m_style.rtl() ? cp - 1: cp + length;
117         while (curr != end) {
118             int index = curr - cp;
119             UChar c = smallCapsBuffer[index];
120             UChar newC;
121             curr = m_style.rtl() ? curr - 1 : curr + 1;
122             if (U_GET_GC_MASK(c) & U_GC_M_MASK)
123                 continue;
124             if (!u_isUUppercase(c) && (newC = u_toupper(c)) != c) {
125                 smallCapsBuffer[index] = newC;
126                 if (!isSmallCaps) {
127                     isSmallCaps = true;
128                     int itemStart = m_style.rtl() ? index : indexOfCaseShift;
129                     int itemLength = m_style.rtl() ? indexOfCaseShift - index : index - indexOfCaseShift;
130                     itemizeShapeAndPlace(smallCapsBuffer.data() + itemStart, itemLength, false, glyphBuffer);
131                     indexOfCaseShift = index;
132                 }
133             } else if (isSmallCaps) {
134                 isSmallCaps = false;
135                 int itemStart = m_style.rtl() ? index : indexOfCaseShift;
136                 int itemLength = m_style.rtl() ? indexOfCaseShift - index : index - indexOfCaseShift;
137                 itemizeShapeAndPlace(smallCapsBuffer.data() + itemStart, itemLength, true, glyphBuffer);
138                 indexOfCaseShift = index;
139             }
140         }
141         
142         int itemLength = m_style.rtl() ? indexOfCaseShift + 1 : length - indexOfCaseShift;
143         if (itemLength) {
144             int itemStart = m_style.rtl() ? 0 : indexOfCaseShift;
145             itemizeShapeAndPlace(smallCapsBuffer.data() + itemStart, itemLength, isSmallCaps, glyphBuffer);
146         }
147     } else
148         itemizeShapeAndPlace(cp, length, false, glyphBuffer);
149 }
150
151 void UniscribeController::itemizeShapeAndPlace(const UChar* cp, unsigned length, bool smallCaps, GlyphBuffer* glyphBuffer)
152 {
153     // ScriptItemize (in Windows XP versions prior to SP2) can overflow by 1.  This is why there is an extra empty item
154     // hanging out at the end of the array
155     m_items.resize(6);
156     int numItems = 0;
157     while (ScriptItemize(cp, length, m_items.size() - 1, &m_control, &m_state, m_items.data(), &numItems) == E_OUTOFMEMORY) {
158         m_items.resize(m_items.size() * 2);
159         resetControlAndState();
160     }
161     m_items.resize(numItems + 1);
162
163     if (m_style.rtl()) {
164         for (int i = m_items.size() - 2; i >= 0; i--) {
165             if (!shapeAndPlaceItem(cp, i, smallCaps, glyphBuffer))
166                 return;
167         }
168     } else {
169         for (unsigned i = 0; i < m_items.size() - 1; i++) {
170             if (!shapeAndPlaceItem(cp, i, smallCaps, glyphBuffer))
171                 return;
172         }
173     }
174
175     m_currentCharacter += length;
176 }
177
178 void UniscribeController::resetControlAndState()
179 {
180     memset(&m_control, 0, sizeof(SCRIPT_CONTROL));
181     memset(&m_state, 0, sizeof(SCRIPT_STATE));
182
183     // Set up the correct direction for the run.
184     m_state.uBidiLevel = m_style.rtl();
185     
186     // Lock the correct directional override.
187     m_state.fOverrideDirection = m_style.directionalOverride();
188 }
189
190 bool UniscribeController::shapeAndPlaceItem(const UChar* cp, unsigned i, bool smallCaps, GlyphBuffer* glyphBuffer)
191 {
192     // Determine the string for this item.
193     const UChar* str = cp + m_items[i].iCharPos;
194     int len = m_items[i+1].iCharPos - m_items[i].iCharPos;
195     SCRIPT_ITEM item = m_items[i];
196
197     // Get our current FontData that we are using.
198     unsigned dataIndex = 0;
199     const FontData* fontData = m_font.fontDataAt(dataIndex);
200     if (smallCaps)
201         fontData = fontData->smallCapsFontData(m_font.fontDescription());
202
203     // Set up buffers to hold the results of shaping the item.
204     Vector<WORD> glyphs;
205     Vector<WORD> clusters;
206     Vector<SCRIPT_VISATTR> visualAttributes;
207     clusters.resize(len);
208      
209     // Shape the item.  This will provide us with glyphs for the item.  We will
210     // attempt to shape using the first available FontData.  If the shaping produces a result with missing
211     // glyphs, then we will fall back to the next FontData.
212     // FIXME: This isn't as good as per-glyph fallback, but in practice it should be pretty good, since
213     // items are broken up by "shaping engine", meaning unique scripts will be broken up into
214     // separate items.
215     bool lastResortFontTried = false;
216     while (fontData) {
217         // The recommended size for the glyph buffer is 1.5 * the character length + 16 in the uniscribe docs.
218         // Apparently this is a good size to avoid having to make repeated calls to ScriptShape.
219         glyphs.resize(1.5 * len + 16);
220         visualAttributes.resize(glyphs.size());
221    
222         if (shape(str, len, item, fontData, glyphs, clusters, visualAttributes))
223             break;
224         
225         // Try again with the next font in the list.
226         if (lastResortFontTried) {
227             fontData = 0;
228             break;
229         }
230         
231         fontData = m_font.fontDataAt(++dataIndex);
232         if (!fontData) {
233             // Out of fonts.  Get a font data based on the actual characters.
234             fontData = m_font.fontDataForCharacters(str, len);
235             lastResortFontTried = true;
236         }
237         if (smallCaps)
238             fontData = fontData->smallCapsFontData(m_font.fontDescription());
239     }
240
241     // Just give up.  We were unable to shape.
242     if (!fontData)
243         return true;
244
245     // We now have a collection of glyphs.
246     Vector<GOFFSET> offsets;
247     Vector<int> advances;
248     offsets.resize(glyphs.size());
249     advances.resize(glyphs.size());
250     int glyphCount = 0;
251     HRESULT placeResult = ScriptPlace(0, fontData->scriptCache(), glyphs.data(), glyphs.size(), visualAttributes.data(),
252                                       &item.a, advances.data(), offsets.data(), 0);
253     if (placeResult == E_PENDING) {
254         // The script cache isn't primed with enough info yet.  We need to select our HFONT into
255         // a DC and pass the DC in to ScriptPlace.
256         HDC hdc = GetDC(0);
257         HFONT hfont = fontData->platformData().hfont();
258         HFONT oldFont = (HFONT)SelectObject(hdc, hfont);
259         placeResult = ScriptPlace(hdc, fontData->scriptCache(), glyphs.data(), glyphs.size(), visualAttributes.data(),
260                                   &item.a, advances.data(), offsets.data(), 0);
261         SelectObject(hdc, oldFont);
262         ReleaseDC(0, hdc);
263     }
264     
265     if (FAILED(placeResult) || glyphs.isEmpty())
266         return true;
267
268     // Convert all chars that should be treated as spaces to use the space glyph.
269     // We also create a map that allows us to quickly go from space glyphs or rounding
270     // hack glyphs back to their corresponding characters.
271     Vector<int> spaceCharacters(glyphs.size());
272     spaceCharacters.fill(-1);
273     Vector<int> roundingHackCharacters(glyphs.size());
274     roundingHackCharacters.fill(-1);
275     Vector<int> roundingHackWordBoundaries(glyphs.size());
276     roundingHackWordBoundaries.fill(-1);
277     unsigned logicalSpaceWidth = fontData->m_spaceWidth * 32.0f;
278     float roundedSpaceWidth = roundf(fontData->m_spaceWidth);
279
280     for (int k = 0; k < len; k++) {
281         UChar ch = *(str + k);
282         if (Font::treatAsSpace(ch)) {
283             // Substitute in the space glyph at the appropriate place in the glyphs
284             // array.
285             glyphs[clusters[k]] = fontData->m_spaceGlyph;
286             advances[clusters[k]] = logicalSpaceWidth;
287             spaceCharacters[clusters[k]] = m_currentCharacter + k + m_items[i].iCharPos;
288         }
289
290         if (Font::isRoundingHackCharacter(ch))
291             roundingHackCharacters[clusters[k]] = m_currentCharacter + k + m_items[i].iCharPos;
292
293         int boundary = k + m_currentCharacter + m_items[i].iCharPos;
294         if (boundary < m_run.length() &&
295             Font::isRoundingHackCharacter(*(str + k + 1)))
296             roundingHackWordBoundaries[clusters[k]] = boundary;
297     }
298
299     // Populate our glyph buffer with this information.
300     bool hasExtraSpacing = m_font.letterSpacing() || m_font.wordSpacing() || m_padding;
301     
302     float leftEdge = m_runWidthSoFar;
303
304     for (unsigned k = 0; k < glyphs.size(); k++) {
305         Glyph glyph = glyphs[k];
306         float advance = advances[k] / 32.0f;
307         float offsetX = offsets[k].du / 32.0f;
308         float offsetY = offsets[k].dv / 32.0f;
309
310         // Match AppKit's rules for the integer vs. non-integer rendering modes.
311         float roundedAdvance = roundf(advance);
312         if (!m_font.isPrinterFont() && !fontData->isSystemFont()) {
313             advance = roundedAdvance;
314             offsetX = roundf(offsetX);
315             offsetY = roundf(offsetY);
316         }
317        
318         // We special case spaces in two ways when applying word rounding.
319         // First, we round spaces to an adjusted width in all fonts.
320         // Second, in fixed-pitch fonts we ensure that all glyphs that
321         // match the width of the space glyph have the same width as the space glyph.
322         if (roundedAdvance == roundedSpaceWidth && (fontData->m_treatAsFixedPitch || glyph == fontData->m_spaceGlyph) &&
323             m_style.applyWordRounding())
324             advance = fontData->m_adjustedSpaceWidth;
325
326         if (hasExtraSpacing) {
327             // If we're a glyph with an advance, go ahead and add in letter-spacing.
328             // That way we weed out zero width lurkers.  This behavior matches the fast text code path.
329             if (advance && m_font.letterSpacing())
330                 advance += m_font.letterSpacing();
331
332             // Handle justification and word-spacing.
333             if (glyph == fontData->m_spaceGlyph) {
334                 // Account for padding. WebCore uses space padding to justify text.
335                 // We distribute the specified padding over the available spaces in the run.
336                 if (m_padding) {
337                     // Use leftover padding if not evenly divisible by number of spaces.
338                     if (m_padding < m_padPerSpace) {
339                         advance += m_padding;
340                         m_padding = 0;
341                     } else {
342                         advance += m_padPerSpace;
343                         m_padding -= m_padPerSpace;
344                     }
345                 }
346
347                 // Account for word-spacing.
348                 int characterIndex = spaceCharacters[k];
349                 if (characterIndex > 0 && !Font::treatAsSpace(*m_run.data(characterIndex-1)) && m_font.wordSpacing())
350                     advance += m_font.wordSpacing();
351             }
352         }
353
354         // Deal with the float/integer impedance mismatch between CG and WebCore. "Words" (characters 
355         // followed by a character defined by isRoundingHackCharacter()) are always an integer width.
356         // We adjust the width of the last character of a "word" to ensure an integer width.
357         // Force characters that are used to determine word boundaries for the rounding hack
358         // to be integer width, so the following words will start on an integer boundary.
359         int roundingHackIndex = roundingHackCharacters[k];
360         if (m_style.applyWordRounding() && roundingHackIndex != -1)
361             advance = ceilf(advance);
362
363         // Check to see if the next character is a "rounding hack character", if so, adjust the
364         // width so that the total run width will be on an integer boundary.
365         int position = m_currentCharacter + len;
366         bool lastGlyph = (k == glyphs.size() - 1) && (m_style.rtl() ? i == 0 : i == m_items.size() - 2) && (position >= m_end);
367         if ((m_style.applyWordRounding() && roundingHackWordBoundaries[k] != -1) ||
368             (m_style.applyRunRounding() && lastGlyph)) { 
369             float totalWidth = m_runWidthSoFar + advance;
370             advance += ceilf(totalWidth) - totalWidth;
371         }
372
373         m_runWidthSoFar += advance;
374
375         // FIXME: We need to take the GOFFSETS for combining glyphs and store them in the glyph buffer
376         // as well, so that when the time comes to draw those glyphs, we can apply the appropriate
377         // translation.
378         if (glyphBuffer) {
379             FloatSize size(offsetX, offsetY);
380             glyphBuffer->add(glyph, fontData, advance, &size);
381         }
382
383         // Mutate the glyph array to contain our altered advances.
384         if (m_computingOffsetPosition)
385             advances[k] = advance;
386     }
387
388     while (m_computingOffsetPosition && m_offsetX >= leftEdge && m_offsetX < m_runWidthSoFar) {
389         // The position is somewhere inside this run.
390         int trailing = 0;
391         ScriptXtoCP(m_offsetX - leftEdge, clusters.size(), glyphs.size(), clusters.data(), visualAttributes.data(),
392                     advances.data(), &item.a, &m_offsetPosition, &trailing);
393         if (trailing && m_includePartialGlyphs && m_offsetPosition < len - 1) {
394             m_offsetPosition += m_currentCharacter + m_items[i].iCharPos;
395             m_offsetX += m_style.rtl() ? -trailing : trailing;
396         } else {
397             m_computingOffsetPosition = false;
398             m_offsetPosition += m_currentCharacter + m_items[i].iCharPos;
399             if (trailing && m_includePartialGlyphs)
400                m_offsetPosition++;
401             return false;
402         }
403     }
404
405     return true;
406 }
407
408 bool UniscribeController::shape(const UChar* str, int len, SCRIPT_ITEM item, const FontData* fontData,
409                                 Vector<WORD>& glyphs, Vector<WORD>& clusters,
410                                 Vector<SCRIPT_VISATTR>& visualAttributes)
411 {
412     HDC hdc = 0;
413     HFONT oldFont = 0;
414     HRESULT shapeResult = E_PENDING;
415     int glyphCount = 0;
416     do {
417         shapeResult = ScriptShape(hdc, fontData->scriptCache(), str, len, glyphs.size(), &item.a,
418                                   glyphs.data(), clusters.data(), visualAttributes.data(), &glyphCount);
419         if (shapeResult == E_PENDING) {
420             // The script cache isn't primed with enough info yet.  We need to select our HFONT into
421             // a DC and pass the DC in to ScriptShape.
422             ASSERT(!hdc);
423             hdc = GetDC(0);
424             HFONT hfont = fontData->platformData().hfont();
425             oldFont = (HFONT)SelectObject(hdc, hfont);
426         } else if (shapeResult == E_OUTOFMEMORY) {
427             // Need to resize our buffers.
428             glyphs.resize(glyphs.size() * 2);
429             visualAttributes.resize(glyphs.size());
430         }
431     } while (shapeResult == E_PENDING || shapeResult == E_OUTOFMEMORY);
432
433     if (hdc) {
434         SelectObject(hdc, oldFont);
435         ReleaseDC(0, hdc);
436     }
437
438     if (FAILED(shapeResult))
439         return false;
440     
441     // FIXME: We need to do better than this.  Falling back on the entire item is not good enough.
442     // We may still have missing glyphs even if we succeeded.  We need to treat missing glyphs as
443     // a failure so that we will fall back to another font.
444     bool containsMissingGlyphs = false;
445     SCRIPT_FONTPROPERTIES* fontProperties = fontData->scriptFontProperties();
446     for (int i = 0; i < glyphCount; i++) {
447         WORD glyph = glyphs[i];
448         if (glyph == fontProperties->wgDefault) {
449             containsMissingGlyphs = true;
450             break;
451         }
452     }
453
454     if (containsMissingGlyphs)
455         return false;
456
457     glyphs.resize(glyphCount);
458     visualAttributes.resize(glyphCount);
459
460     return true;
461 }
462
463 }