OpenTTD Source  1.11.2
string_osx.cpp
Go to the documentation of this file.
1 /*
2  * This file is part of OpenTTD.
3  * OpenTTD is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, version 2.
4  * OpenTTD is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
5  * See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with OpenTTD. If not, see <http://www.gnu.org/licenses/>.
6  */
7 
10 #include "../../stdafx.h"
11 #include "string_osx.h"
12 #include "../../string_func.h"
13 #include "../../strings_func.h"
14 #include "../../table/control_codes.h"
15 #include "../../fontcache.h"
16 #include "macos.h"
17 
18 #include <CoreFoundation/CoreFoundation.h>
19 
20 
21 /* CTRunDelegateCreate is supported since MacOS X 10.5, but was only included in the SDKs starting with the 10.9 SDK. */
22 #ifndef HAVE_OSX_109_SDK
23 extern "C" {
24  typedef const struct __CTRunDelegate * CTRunDelegateRef;
25 
26  typedef void (*CTRunDelegateDeallocateCallback) (void* refCon);
27  typedef CGFloat (*CTRunDelegateGetAscentCallback) (void* refCon);
28  typedef CGFloat (*CTRunDelegateGetDescentCallback) (void* refCon);
29  typedef CGFloat (*CTRunDelegateGetWidthCallback) (void* refCon);
30  typedef struct {
31  CFIndex version;
32  CTRunDelegateDeallocateCallback dealloc;
33  CTRunDelegateGetAscentCallback getAscent;
34  CTRunDelegateGetDescentCallback getDescent;
35  CTRunDelegateGetWidthCallback getWidth;
37 
38  enum {
39  kCTRunDelegateVersion1 = 1,
40  kCTRunDelegateCurrentVersion = kCTRunDelegateVersion1
41  };
42 
43  extern const CFStringRef kCTRunDelegateAttributeName AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
44 
45  CTRunDelegateRef CTRunDelegateCreate(const CTRunDelegateCallbacks* callbacks, void* refCon) AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
46 }
47 #endif /* HAVE_OSX_109_SDK */
48 
53 
54 
59 private:
61  ptrdiff_t length;
62  const FontMap& font_map;
63 
65 
66  CFIndex cur_offset = 0;
67 
68 public:
71  private:
72  std::vector<GlyphID> glyphs;
73  std::vector<float> positions;
74  std::vector<int> glyph_to_char;
75 
76  int total_advance = 0;
77  Font *font;
78 
79  public:
80  CoreTextVisualRun(CTRunRef run, Font *font, const CoreTextParagraphLayoutFactory::CharType *buff);
81  CoreTextVisualRun(CoreTextVisualRun &&other) = default;
82 
83  const GlyphID *GetGlyphs() const override { return &this->glyphs[0]; }
84  const float *GetPositions() const override { return &this->positions[0]; }
85  const int *GetGlyphToCharMap() const override { return &this->glyph_to_char[0]; }
86 
87  const Font *GetFont() const override { return this->font; }
88  int GetLeading() const override { return this->font->fc->GetHeight(); }
89  int GetGlyphCount() const override { return (int)this->glyphs.size(); }
90  int GetAdvance() const { return this->total_advance; }
91  };
92 
94  class CoreTextLine : public std::vector<CoreTextVisualRun>, public ParagraphLayouter::Line {
95  public:
97  {
98  CFArrayRef runs = CTLineGetGlyphRuns(line.get());
99  for (CFIndex i = 0; i < CFArrayGetCount(runs); i++) {
100  CTRunRef run = (CTRunRef)CFArrayGetValueAtIndex(runs, i);
101 
102  /* Extract font information for this run. */
103  CFRange chars = CTRunGetStringRange(run);
104  auto map = fontMapping.begin();
105  while (map < fontMapping.end() - 1 && map->first <= chars.location) map++;
106 
107  this->emplace_back(run, map->second, buff);
108  }
109  }
110 
111  int GetLeading() const override;
112  int GetWidth() const override;
113  int CountRuns() const override { return this->size(); }
114  const VisualRun &GetVisualRun(int run) const override { return this->at(run); }
115 
116  int GetInternalCharLength(WChar c) const override
117  {
118  /* CoreText uses UTF-16 internally which means we need to account for surrogate pairs. */
119  return c >= 0x010000U ? 2 : 1;
120  }
121  };
122 
123  CoreTextParagraphLayout(CFAutoRelease<CTTypesetterRef> typesetter, const CoreTextParagraphLayoutFactory::CharType *buffer, ptrdiff_t len, const FontMap &fontMapping) : text_buffer(buffer), length(len), font_map(fontMapping), typesetter(std::move(typesetter))
124  {
125  this->Reflow();
126  }
127 
128  void Reflow() override
129  {
130  this->cur_offset = 0;
131  }
132 
133  std::unique_ptr<const Line> NextLine(int max_width) override;
134 };
135 
136 
138 static CGFloat SpriteFontGetWidth(void *ref_con)
139 {
140  FontSize fs = (FontSize)((size_t)ref_con >> 24);
141  WChar c = (WChar)((size_t)ref_con & 0xFFFFFF);
142 
143  return GetGlyphWidth(fs, c);
144 }
145 
146 static CTRunDelegateCallbacks _sprite_font_callback = {
147  kCTRunDelegateCurrentVersion, nullptr, nullptr, nullptr,
149 };
150 
152 {
153  if (!MacOSVersionIsAtLeast(10, 5, 0)) return nullptr;
154 
155  /* Can't layout an empty string. */
156  ptrdiff_t length = buff_end - buff;
157  if (length == 0) return nullptr;
158 
159  /* Can't layout our in-built sprite fonts. */
160  for (const auto &i : fontMapping) {
161  if (i.second->fc->IsBuiltInFont()) return nullptr;
162  }
163 
164  /* Make attributed string with embedded font information. */
165  CFAutoRelease<CFMutableAttributedStringRef> str(CFAttributedStringCreateMutable(kCFAllocatorDefault, 0));
166  CFAttributedStringBeginEditing(str.get());
167 
168  CFAutoRelease<CFStringRef> base(CFStringCreateWithCharactersNoCopy(kCFAllocatorDefault, buff, length, kCFAllocatorNull));
169  CFAttributedStringReplaceString(str.get(), CFRangeMake(0, 0), base.get());
170 
171  /* Apply font and colour ranges to our string. This is important to make sure
172  * that we get proper glyph boundaries on style changes. */
173  int last = 0;
174  for (const auto &i : fontMapping) {
175  if (i.first - last == 0) continue;
176 
177  CTFontRef font = (CTFontRef)i.second->fc->GetOSHandle();
178  if (font == nullptr) {
179  if (!_font_cache[i.second->fc->GetSize()]) {
180  /* Cache font information. */
181  CFAutoRelease<CFStringRef> font_name(CFStringCreateWithCString(kCFAllocatorDefault, i.second->fc->GetFontName(), kCFStringEncodingUTF8));
182  _font_cache[i.second->fc->GetSize()].reset(CTFontCreateWithName(font_name.get(), i.second->fc->GetFontSize(), nullptr));
183  }
184  font = _font_cache[i.second->fc->GetSize()].get();
185  }
186  CFAttributedStringSetAttribute(str.get(), CFRangeMake(last, i.first - last), kCTFontAttributeName, font);
187 
188  CGColorRef color = CGColorCreateGenericGray((uint8)i.second->colour / 255.0f, 1.0f); // We don't care about the real colours, just that they are different.
189  CFAttributedStringSetAttribute(str.get(), CFRangeMake(last, i.first - last), kCTForegroundColorAttributeName, color);
190  CGColorRelease(color);
191 
192  /* Install a size callback for our special sprite glyphs. */
193  for (ssize_t c = last; c < i.first; c++) {
194  if (buff[c] >= SCC_SPRITE_START && buff[c] <= SCC_SPRITE_END) {
195  CFAutoRelease<CTRunDelegateRef> del(CTRunDelegateCreate(&_sprite_font_callback, (void *)(size_t)(buff[c] | (i.second->fc->GetSize() << 24))));
196  CFAttributedStringSetAttribute(str.get(), CFRangeMake(c, 1), kCTRunDelegateAttributeName, del.get());
197  }
198  }
199 
200  last = i.first;
201  }
202  CFAttributedStringEndEditing(str.get());
203 
204  /* Create and return typesetter for the string. */
205  CFAutoRelease<CTTypesetterRef> typesetter(CTTypesetterCreateWithAttributedString(str.get()));
206 
207  return typesetter ? new CoreTextParagraphLayout(std::move(typesetter), buff, length, fontMapping) : nullptr;
208 }
209 
210 /* virtual */ std::unique_ptr<const ParagraphLayouter::Line> CoreTextParagraphLayout::NextLine(int max_width)
211 {
212  if (this->cur_offset >= this->length) return nullptr;
213 
214  /* Get line break position, trying word breaking first and breaking somewhere if that doesn't work. */
215  CFIndex len = CTTypesetterSuggestLineBreak(this->typesetter.get(), this->cur_offset, max_width);
216  if (len <= 0) len = CTTypesetterSuggestClusterBreak(this->typesetter.get(), this->cur_offset, max_width);
217 
218  /* Create line. */
219  CFAutoRelease<CTLineRef> line(CTTypesetterCreateLine(this->typesetter.get(), CFRangeMake(this->cur_offset, len)));
220  this->cur_offset += len;
221 
222  return std::unique_ptr<const Line>(line ? new CoreTextLine(std::move(line), this->font_map, this->text_buffer) : nullptr);
223 }
224 
225 CoreTextParagraphLayout::CoreTextVisualRun::CoreTextVisualRun(CTRunRef run, Font *font, const CoreTextParagraphLayoutFactory::CharType *buff) : font(font)
226 {
227  this->glyphs.resize(CTRunGetGlyphCount(run));
228 
229  /* Query map of glyphs to source string index. */
230  CFIndex map[this->glyphs.size()];
231  CTRunGetStringIndices(run, CFRangeMake(0, 0), map);
232 
233  this->glyph_to_char.resize(this->glyphs.size());
234  for (size_t i = 0; i < this->glyph_to_char.size(); i++) this->glyph_to_char[i] = (int)map[i];
235 
236  CGPoint pts[this->glyphs.size()];
237  CTRunGetPositions(run, CFRangeMake(0, 0), pts);
238  this->positions.resize(this->glyphs.size() * 2 + 2);
239 
240  /* Convert glyph array to our data type. At the same time, substitute
241  * the proper glyphs for our private sprite glyphs. */
242  CGGlyph gl[this->glyphs.size()];
243  CTRunGetGlyphs(run, CFRangeMake(0, 0), gl);
244  for (size_t i = 0; i < this->glyphs.size(); i++) {
245  if (buff[this->glyph_to_char[i]] >= SCC_SPRITE_START && buff[this->glyph_to_char[i]] <= SCC_SPRITE_END) {
246  this->glyphs[i] = font->fc->MapCharToGlyph(buff[this->glyph_to_char[i]]);
247  this->positions[i * 2 + 0] = pts[i].x;
248  this->positions[i * 2 + 1] = font->fc->GetAscender() - font->fc->GetGlyph(this->glyphs[i])->height - 1; // Align sprite glyphs to font baseline.
249  } else {
250  this->glyphs[i] = gl[i];
251  this->positions[i * 2 + 0] = pts[i].x;
252  this->positions[i * 2 + 1] = pts[i].y;
253  }
254  }
255  this->total_advance = (int)CTRunGetTypographicBounds(run, CFRangeMake(0, 0), nullptr, nullptr, nullptr);
256  this->positions[this->glyphs.size() * 2] = this->positions[0] + this->total_advance;
257 }
258 
264 {
265  int leading = 0;
266  for (const auto &run : *this) {
267  leading = std::max(leading, run.GetLeading());
268  }
269 
270  return leading;
271 }
272 
278 {
279  if (this->size() == 0) return 0;
280 
281  int total_width = 0;
282  for (const auto &run : *this) {
283  total_width += run.GetAdvance();
284  }
285 
286  return total_width;
287 }
288 
289 
292 {
293  _font_cache[size].reset();
294 }
295 
297 void MacOSRegisterExternalFont(const char *file_path)
298 {
299  if (!MacOSVersionIsAtLeast(10, 6, 0)) return;
300 
301  CFAutoRelease<CFStringRef> path(CFStringCreateWithCString(kCFAllocatorDefault, file_path, kCFStringEncodingUTF8));
302  CFAutoRelease<CFURLRef> url(CFURLCreateWithFileSystemPath(kCFAllocatorDefault, path.get(), kCFURLPOSIXPathStyle, false));
303 
304  CTFontManagerRegisterFontsForURL(url.get(), kCTFontManagerScopeProcess, nullptr);
305 }
306 
308 void MacOSSetCurrentLocaleName(const char *iso_code)
309 {
310  if (!MacOSVersionIsAtLeast(10, 5, 0)) return;
311 
312  CFAutoRelease<CFStringRef> iso(CFStringCreateWithCString(kCFAllocatorDefault, iso_code, kCFStringEncodingUTF8));
313  _osx_locale.reset(CFLocaleCreate(kCFAllocatorDefault, iso.get()));
314 }
315 
323 int MacOSStringCompare(const char *s1, const char *s2)
324 {
325  static bool supported = MacOSVersionIsAtLeast(10, 5, 0);
326  if (!supported) return 0;
327 
328  CFStringCompareFlags flags = kCFCompareCaseInsensitive | kCFCompareNumerically | kCFCompareLocalized | kCFCompareWidthInsensitive | kCFCompareForcedOrdering;
329 
330  CFAutoRelease<CFStringRef> cf1(CFStringCreateWithCString(kCFAllocatorDefault, s1, kCFStringEncodingUTF8));
331  CFAutoRelease<CFStringRef> cf2(CFStringCreateWithCString(kCFAllocatorDefault, s2, kCFStringEncodingUTF8));
332 
333  /* If any CFString could not be created (e.g., due to UTF8 invalid chars), return OS unsupported functionality */
334  if (cf1 == nullptr || cf2 == nullptr) return 0;
335 
336  return (int)CFStringCompareWithOptionsAndLocale(cf1.get(), cf2.get(), CFRangeMake(0, CFStringGetLength(cf1.get())), flags, _osx_locale.get()) + 2;
337 }
338 
339 
340 /* virtual */ void OSXStringIterator::SetString(const char *s)
341 {
342  const char *string_base = s;
343 
344  this->utf16_to_utf8.clear();
345  this->str_info.clear();
346  this->cur_pos = 0;
347 
348  /* CoreText operates on UTF-16, thus we have to convert the input string.
349  * To be able to return proper offsets, we have to create a mapping at the same time. */
350  std::vector<UniChar> utf16_str;
351  while (*s != '\0') {
352  size_t idx = s - string_base;
353 
354  WChar c = Utf8Consume(&s);
355  if (c < 0x10000) {
356  utf16_str.push_back((UniChar)c);
357  } else {
358  /* Make a surrogate pair. */
359  utf16_str.push_back((UniChar)(0xD800 + ((c - 0x10000) >> 10)));
360  utf16_str.push_back((UniChar)(0xDC00 + ((c - 0x10000) & 0x3FF)));
361  this->utf16_to_utf8.push_back(idx);
362  }
363  this->utf16_to_utf8.push_back(idx);
364  }
365  this->utf16_to_utf8.push_back(s - string_base);
366 
367  /* Query CoreText for word and cluster break information. */
368  this->str_info.resize(utf16_to_utf8.size());
369 
370  if (utf16_str.size() > 0) {
371  CFAutoRelease<CFStringRef> str(CFStringCreateWithCharactersNoCopy(kCFAllocatorDefault, &utf16_str[0], utf16_str.size(), kCFAllocatorNull));
372 
373  /* Get cluster breaks. */
374  for (CFIndex i = 0; i < CFStringGetLength(str.get()); ) {
375  CFRange r = CFStringGetRangeOfComposedCharactersAtIndex(str.get(), i);
376  this->str_info[r.location].char_stop = true;
377 
378  i += r.length;
379  }
380 
381  /* Get word breaks. */
382  CFAutoRelease<CFStringTokenizerRef> tokenizer(CFStringTokenizerCreate(kCFAllocatorDefault, str.get(), CFRangeMake(0, CFStringGetLength(str.get())), kCFStringTokenizerUnitWordBoundary, _osx_locale.get()));
383 
384  CFStringTokenizerTokenType tokenType = kCFStringTokenizerTokenNone;
385  while ((tokenType = CFStringTokenizerAdvanceToNextToken(tokenizer.get())) != kCFStringTokenizerTokenNone) {
386  /* Skip tokens that are white-space or punctuation tokens. */
387  if ((tokenType & kCFStringTokenizerTokenHasNonLettersMask) != kCFStringTokenizerTokenHasNonLettersMask) {
388  CFRange r = CFStringTokenizerGetCurrentTokenRange(tokenizer.get());
389  this->str_info[r.location].word_stop = true;
390  }
391  }
392  }
393 
394  /* End-of-string is always a valid stopping point. */
395  this->str_info.back().char_stop = true;
396  this->str_info.back().word_stop = true;
397 }
398 
399 /* virtual */ size_t OSXStringIterator::SetCurPosition(size_t pos)
400 {
401  /* Convert incoming position to an UTF-16 string index. */
402  size_t utf16_pos = 0;
403  for (size_t i = 0; i < this->utf16_to_utf8.size(); i++) {
404  if (this->utf16_to_utf8[i] == pos) {
405  utf16_pos = i;
406  break;
407  }
408  }
409 
410  /* Sanitize in case we get a position inside a grapheme cluster. */
411  while (utf16_pos > 0 && !this->str_info[utf16_pos].char_stop) utf16_pos--;
412  this->cur_pos = utf16_pos;
413 
414  return this->utf16_to_utf8[this->cur_pos];
415 }
416 
417 /* virtual */ size_t OSXStringIterator::Next(IterType what)
418 {
419  assert(this->cur_pos <= this->utf16_to_utf8.size());
421 
422  if (this->cur_pos == this->utf16_to_utf8.size()) return END;
423 
424  do {
425  this->cur_pos++;
426  } while (this->cur_pos < this->utf16_to_utf8.size() && (what == ITER_WORD ? !this->str_info[this->cur_pos].word_stop : !this->str_info[this->cur_pos].char_stop));
427 
428  return this->cur_pos == this->utf16_to_utf8.size() ? END : this->utf16_to_utf8[this->cur_pos];
429 }
430 
431 /* virtual */ size_t OSXStringIterator::Prev(IterType what)
432 {
433  assert(this->cur_pos <= this->utf16_to_utf8.size());
435 
436  if (this->cur_pos == 0) return END;
437 
438  do {
439  this->cur_pos--;
440  } while (this->cur_pos > 0 && (what == ITER_WORD ? !this->str_info[this->cur_pos].word_stop : !this->str_info[this->cur_pos].char_stop));
441 
442  return this->utf16_to_utf8[this->cur_pos];
443 }
444 
445 /* static */ StringIterator *OSXStringIterator::Create()
446 {
447  if (!MacOSVersionIsAtLeast(10, 5, 0)) return nullptr;
448 
449  return new OSXStringIterator();
450 }
GlyphID
uint32 GlyphID
Glyphs are characters from a font.
Definition: fontcache.h:17
WChar
char32_t WChar
Type for wide characters, i.e.
Definition: string_type.h:35
StringIterator::IterType
IterType
Type of the iterator.
Definition: string_base.h:17
SpriteFontGetWidth
static CGFloat SpriteFontGetWidth(void *ref_con)
Get the width of an encoded sprite font character.
Definition: string_osx.cpp:138
OSXStringIterator::Prev
size_t Prev(IterType what) override
Move the cursor back by one iteration unit.
Definition: string_osx.cpp:431
CoreTextParagraphLayout::CoreTextLine::GetLeading
int GetLeading() const override
Get the height of the line.
Definition: string_osx.cpp:263
CFAutoRelease
std::unique_ptr< typename std::remove_pointer< T >::type, CFDeleter< typename std::remove_pointer< T >::type > > CFAutoRelease
Specialisation of std::unique_ptr for CoreFoundation objects.
Definition: macos.h:52
CoreTextParagraphLayoutFactory::GetParagraphLayout
static ParagraphLayouter * GetParagraphLayout(CharType *buff, CharType *buff_end, FontMap &fontMapping)
Get the actual ParagraphLayout for the given buffer.
Definition: string_osx.cpp:151
CoreTextParagraphLayout
Wrapper for doing layouts with CoreText.
Definition: string_osx.cpp:58
StringIterator::ITER_CHARACTER
@ ITER_CHARACTER
Iterate over characters (or more exactly grapheme clusters).
Definition: string_base.h:18
OSXStringIterator
String iterator using CoreText as a backend.
Definition: string_osx.h:18
ParagraphLayouter
Interface to glue fallback and normal layouter into one.
Definition: gfx_layout.h:115
CTRunDelegateCallbacks
Definition: string_osx.cpp:30
SmallMap
Implementation of simple mapping class.
Definition: smallmap_type.hpp:26
string_osx.h
ParagraphLayouter::Line
A single line worth of VisualRuns.
Definition: gfx_layout.h:132
OSXStringIterator::SetString
void SetString(const char *s) override
Set a new iteration string.
Definition: string_osx.cpp:340
StringIterator
Class for iterating over different kind of parts of a string.
Definition: string_base.h:14
StringIterator::ITER_WORD
@ ITER_WORD
Iterate over words.
Definition: string_base.h:19
CoreTextParagraphLayout::CoreTextLine::GetWidth
int GetWidth() const override
Get the width of this line.
Definition: string_osx.cpp:277
MacOSSetCurrentLocaleName
void MacOSSetCurrentLocaleName(const char *iso_code)
Store current language locale as a CoreFoundation locale.
Definition: string_osx.cpp:308
CoreTextParagraphLayout::CoreTextLine
A single line worth of VisualRuns.
Definition: string_osx.cpp:94
ParagraphLayouter::VisualRun
Visual run contains data about the bit of text with the same font.
Definition: gfx_layout.h:120
GetGlyphWidth
static uint GetGlyphWidth(FontSize size, WChar key)
Get the width of a glyph.
Definition: fontcache.h:204
MacOSRegisterExternalFont
void MacOSRegisterExternalFont(const char *file_path)
Register an external font file with the CoreText system.
Definition: string_osx.cpp:297
MacOSVersionIsAtLeast
static bool MacOSVersionIsAtLeast(long major, long minor, long bugfix)
Check if we are at least running on the specified version of Mac OS.
Definition: macos.h:25
_font_cache
static CFAutoRelease< CTFontRef > _font_cache[FS_END]
CoreText cache for font information, cleared when OTTD changes fonts.
Definition: string_osx.cpp:52
OSXStringIterator::SetCurPosition
size_t SetCurPosition(size_t pos) override
Change the current string cursor.
Definition: string_osx.cpp:399
CoreTextParagraphLayout::cur_offset
CFIndex cur_offset
Offset from the start of the current run from where to output.
Definition: string_osx.cpp:66
CoreTextParagraphLayoutFactory::CharType
UniChar CharType
Helper for GetLayouter, to get the right type.
Definition: string_osx.h:45
CoreTextParagraphLayout::CoreTextVisualRun
Visual run contains data about the bit of text with the same font.
Definition: string_osx.cpp:70
MacOSResetScriptCache
void MacOSResetScriptCache(FontSize size)
Delete CoreText font reference for a specific font size.
Definition: string_osx.cpp:291
OSXStringIterator::Next
size_t Next(IterType what) override
Advance the cursor by one iteration unit.
Definition: string_osx.cpp:417
macos.h
_osx_locale
static CFAutoRelease< CFLocaleRef > _osx_locale
Cached current locale.
Definition: string_osx.cpp:50
FontSize
FontSize
Available font sizes.
Definition: gfx_type.h:206
MacOSStringCompare
int MacOSStringCompare(const char *s1, const char *s2)
Compares two strings using case insensitive natural sort.
Definition: string_osx.cpp:323