string_osx.cpp

Go to the documentation of this file.

/*
 * This file is part of OpenTTD.
 * 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.
 * 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.
 * 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/>.
 */
 
#include "../../stdafx.h"
#include "string_osx.h"
#include "../../string_func.h"
#include "../../strings_func.h"
#include "../../core/utf8.hpp"
#include "../../table/control_codes.h"
#include "../../fontcache.h"
#include "../../zoom_func.h"
#include "macos.h"
 
#include <CoreFoundation/CoreFoundation.h>
 
 
/* CTRunDelegateCreate is supported since MacOS X 10.5, but was only included in the SDKs starting with the 10.9 SDK. */
#ifndef HAVE_OSX_109_SDK
extern "C" {
  typedef const struct __CTRunDelegate * CTRunDelegateRef;
 
  typedef void (*CTRunDelegateDeallocateCallback) (void *refCon);
  typedef CGFloat (*CTRunDelegateGetAscentCallback) (void *refCon);
  typedef CGFloat (*CTRunDelegateGetDescentCallback) (void *refCon);
  typedef CGFloat (*CTRunDelegateGetWidthCallback) (void *refCon);
  typedef struct {
    CFIndex                         version;
    CTRunDelegateDeallocateCallback dealloc;
    CTRunDelegateGetAscentCallback  getAscent;
    CTRunDelegateGetDescentCallback getDescent;
    CTRunDelegateGetWidthCallback   getWidth;
  } CTRunDelegateCallbacks;
 
  enum : int32_t {
    kCTRunDelegateVersion1 = 1,
    kCTRunDelegateCurrentVersion = kCTRunDelegateVersion1
  };
 
  extern const CFStringRef kCTRunDelegateAttributeName AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
 
  CTRunDelegateRef CTRunDelegateCreate(const CTRunDelegateCallbacks *callbacks, void *refCon) AVAILABLE_MAC_OS_X_VERSION_10_5_AND_LATER;
}
#endif /* HAVE_OSX_109_SDK */
 
static CFAutoRelease<CFLocaleRef> _osx_locale;
static CFAutoRelease<CTFontRef> _font_cache[FS_END];
 
 
class CoreTextParagraphLayout : public ParagraphLayouter {
private:
  const CoreTextParagraphLayoutFactory::CharType *text_buffer;
  ptrdiff_t length;
  const FontMap &font_map;
 
  CFAutoRelease<CTTypesetterRef> typesetter;
 
  CFIndex cur_offset = 0; 
 
public:
  class CoreTextVisualRun : public ParagraphLayouter::VisualRun {
  private:
    std::vector<GlyphID> glyphs;
    std::vector<Position> positions;
    std::vector<int> glyph_to_char;
 
    int total_advance = 0;
    Font *font;
 
  public:
    CoreTextVisualRun(CTRunRef run, Font *font, const CoreTextParagraphLayoutFactory::CharType *buff);
    CoreTextVisualRun(CoreTextVisualRun &&other) = default;
 
    std::span<const GlyphID> GetGlyphs() const override { return this->glyphs; }
    std::span<const Position> GetPositions() const override { return this->positions; }
    std::span<const int> GetGlyphToCharMap() const override { return this->glyph_to_char; }
 
    const Font *GetFont() const override { return this->font;  }
    int GetLeading() const override { return this->font->fc->GetHeight(); }
    int GetGlyphCount() const override { return (int)this->glyphs.size(); }
    int GetAdvance() const { return this->total_advance; }
  };
 
  class CoreTextLine : public std::vector<CoreTextVisualRun>, public ParagraphLayouter::Line {
  public:
    CoreTextLine(CFAutoRelease<CTLineRef> line, const FontMap &font_mapping, const CoreTextParagraphLayoutFactory::CharType *buff)
    {
      CFArrayRef runs = CTLineGetGlyphRuns(line.get());
      for (CFIndex i = 0; i < CFArrayGetCount(runs); i++) {
        CTRunRef run = (CTRunRef)CFArrayGetValueAtIndex(runs, i);
 
        /* Extract font information for this run. */
        CFRange chars = CTRunGetStringRange(run);
        auto map = std::ranges::upper_bound(font_mapping, chars.location, std::less{}, &std::pair<int, Font *>::first);
 
        this->emplace_back(run, map->second, buff);
      }
    }
 
    int GetLeading() const override;
    int GetWidth() const override;
    int CountRuns() const override { return this->size(); }
    const VisualRun &GetVisualRun(int run) const override { return this->at(run);  }
 
    int GetInternalCharLength(char32_t c) const override
    {
      /* CoreText uses UTF-16 internally which means we need to account for surrogate pairs. */
      return c >= 0x010000U ? 2 : 1;
    }
  };
 
  CoreTextParagraphLayout(CFAutoRelease<CTTypesetterRef> typesetter, const CoreTextParagraphLayoutFactory::CharType *buffer, ptrdiff_t len, const FontMap &font_mapping) : text_buffer(buffer), length(len), font_map(font_mapping), typesetter(std::move(typesetter))
  {
    this->Reflow();
  }
 
  void Reflow() override
  {
    this->cur_offset = 0;
  }
 
  std::unique_ptr<const Line> NextLine(int max_width) override;
};
 
 
static CGFloat SpriteFontGetWidth(void *ref_con)
{
  FontSize fs = (FontSize)((size_t)ref_con >> 24);
  char32_t c = (char32_t)((size_t)ref_con & 0xFFFFFF);
 
  return GetGlyphWidth(fs, c);
}
 
static CTRunDelegateCallbacks _sprite_font_callback = {
  kCTRunDelegateCurrentVersion, nullptr, nullptr, nullptr,
  &SpriteFontGetWidth
};
 
/* static */ std::unique_ptr<ParagraphLayouter> CoreTextParagraphLayoutFactory::GetParagraphLayout(CharType *buff, CharType *buff_end, FontMap &font_mapping)
{
  if (!MacOSVersionIsAtLeast(10, 5, 0)) return nullptr;
 
  /* Can't layout an empty string. */
  ptrdiff_t length = buff_end - buff;
  if (length == 0) return nullptr;
 
  /* Can't layout our in-built sprite fonts. */
  for (const auto &[position, font] : font_mapping) {
    if (font->fc->IsBuiltInFont()) return nullptr;
  }
 
  /* Make attributed string with embedded font information. */
  CFAutoRelease<CFMutableAttributedStringRef> str(CFAttributedStringCreateMutable(kCFAllocatorDefault, 0));
  CFAttributedStringBeginEditing(str.get());
 
  CFAutoRelease<CFStringRef> base(CFStringCreateWithCharactersNoCopy(kCFAllocatorDefault, buff, length, kCFAllocatorNull));
  CFAttributedStringReplaceString(str.get(), CFRangeMake(0, 0), base.get());
 
  const UniChar replacment_char = 0xFFFC;
  CFAutoRelease<CFStringRef> replacment_str(CFStringCreateWithCharacters(kCFAllocatorDefault, &replacment_char, 1));
 
  /* Apply font and colour ranges to our string. This is important to make sure
   * that we get proper glyph boundaries on style changes. */
  int last = 0;
  for (const auto &[position, font] : font_mapping) {
    if (position - last == 0) continue;
 
    CTFontRef font_handle = static_cast<CTFontRef>(font->fc->GetOSHandle());
    if (font_handle == nullptr) {
      if (!_font_cache[font->fc->GetSize()]) {
        /* Cache font information. */
        CFAutoRelease<CFStringRef> font_name(CFStringCreateWithCString(kCFAllocatorDefault, font->fc->GetFontName().c_str(), kCFStringEncodingUTF8));
        _font_cache[font->fc->GetSize()].reset(CTFontCreateWithName(font_name.get(), font->fc->GetFontSize(), nullptr));
      }
      font_handle = _font_cache[font->fc->GetSize()].get();
    }
    CFAttributedStringSetAttribute(str.get(), CFRangeMake(last, position - last), kCTFontAttributeName, font_handle);
 
    CGColorRef color = CGColorCreateGenericGray((uint8_t)font->colour / 255.0f, 1.0f); // We don't care about the real colours, just that they are different.
    CFAttributedStringSetAttribute(str.get(), CFRangeMake(last, position - last), kCTForegroundColorAttributeName, color);
    CGColorRelease(color);
 
    /* Install a size callback for our special private-use sprite glyphs in case the font does not provide them. */
    for (ssize_t c = last; c < position; c++) {
      if (buff[c] >= SCC_SPRITE_START && buff[c] <= SCC_SPRITE_END && font->fc->MapCharToGlyph(buff[c], false) == 0) {
        CFAutoRelease<CTRunDelegateRef> del(CTRunDelegateCreate(&_sprite_font_callback, (void *)(size_t)(buff[c] | (font->fc->GetSize() << 24))));
        /* According to the official documentation, if a run delegate is used, the char should always be 0xFFFC. */
        CFAttributedStringReplaceString(str.get(), CFRangeMake(c, 1), replacment_str.get());
        CFAttributedStringSetAttribute(str.get(), CFRangeMake(c, 1), kCTRunDelegateAttributeName, del.get());
      }
    }
 
    last = position;
  }
  CFAttributedStringEndEditing(str.get());
 
  /* Create and return typesetter for the string. */
  CFAutoRelease<CTTypesetterRef> typesetter(CTTypesetterCreateWithAttributedString(str.get()));
 
  return typesetter ? std::make_unique<CoreTextParagraphLayout>(std::move(typesetter), buff, length, font_mapping) : nullptr;
}
 
/* virtual */ std::unique_ptr<const ParagraphLayouter::Line> CoreTextParagraphLayout::NextLine(int max_width)
{
  if (this->cur_offset >= this->length) return nullptr;
 
  /* Get line break position, trying word breaking first and breaking somewhere if that doesn't work. */
  CFIndex len = CTTypesetterSuggestLineBreak(this->typesetter.get(), this->cur_offset, max_width);
  if (len <= 0) len = CTTypesetterSuggestClusterBreak(this->typesetter.get(), this->cur_offset, max_width);
 
  /* Create line. */
  CFAutoRelease<CTLineRef> line(CTTypesetterCreateLine(this->typesetter.get(), CFRangeMake(this->cur_offset, len)));
  this->cur_offset += len;
 
  if (!line) return nullptr;
  return std::make_unique<CoreTextLine>(std::move(line), this->font_map, this->text_buffer);
}
 
CoreTextParagraphLayout::CoreTextVisualRun::CoreTextVisualRun(CTRunRef run, Font *font, const CoreTextParagraphLayoutFactory::CharType *buff) : font(font)
{
  this->glyphs.resize(CTRunGetGlyphCount(run));
 
  /* Query map of glyphs to source string index. */
  CFIndex map[this->glyphs.size()];
  CTRunGetStringIndices(run, CFRangeMake(0, 0), map);
 
  this->glyph_to_char.resize(this->glyphs.size());
  for (size_t i = 0; i < this->glyph_to_char.size(); i++) this->glyph_to_char[i] = (int)map[i];
 
  CGPoint pts[this->glyphs.size()];
  CTRunGetPositions(run, CFRangeMake(0, 0), pts);
  CGSize advs[this->glyphs.size()];
  CTRunGetAdvances(run, CFRangeMake(0, 0), advs);
  this->positions.reserve(this->glyphs.size());
 
  /* Convert glyph array to our data type. At the same time, substitute
   * the proper glyphs for our private sprite glyphs. */
  CGGlyph gl[this->glyphs.size()];
  CTRunGetGlyphs(run, CFRangeMake(0, 0), gl);
  for (size_t i = 0; i < this->glyphs.size(); i++) {
    if (buff[this->glyph_to_char[i]] >= SCC_SPRITE_START && buff[this->glyph_to_char[i]] <= SCC_SPRITE_END && (gl[i] == 0 || gl[i] == 3)) {
      /* A glyph of 0 indidicates not found, while apparently 3 is what char 0xFFFC maps to. */
      this->glyphs[i] = font->fc->MapCharToGlyph(buff[this->glyph_to_char[i]]);
      this->positions.emplace_back(pts[i].x, pts[i].x + advs[i].width - 1, (font->fc->GetHeight() - ScaleSpriteTrad(FontCache::GetDefaultFontHeight(font->fc->GetSize()))) / 2); // Align sprite font to centre
    } else {
      this->glyphs[i] = gl[i];
      this->positions.emplace_back(pts[i].x, pts[i].x + advs[i].width - 1, pts[i].y);
    }
  }
  this->total_advance = (int)std::ceil(CTRunGetTypographicBounds(run, CFRangeMake(0, 0), nullptr, nullptr, nullptr));
}
 
int CoreTextParagraphLayout::CoreTextLine::GetLeading() const
{
  int leading = 0;
  for (const auto &run : *this) {
    leading = std::max(leading, run.GetLeading());
  }
 
  return leading;
}
 
int CoreTextParagraphLayout::CoreTextLine::GetWidth() const
{
  if (this->empty()) return 0;
 
  int total_width = 0;
  for (const auto &run : *this) {
    total_width += run.GetAdvance();
  }
 
  return total_width;
}
 
 
void MacOSResetScriptCache(FontSize size)
{
  _font_cache[size].reset();
}
 
void MacOSRegisterExternalFont(const char *file_path)
{
  if (!MacOSVersionIsAtLeast(10, 6, 0)) return;
 
  CFAutoRelease<CFStringRef> path(CFStringCreateWithCString(kCFAllocatorDefault, file_path, kCFStringEncodingUTF8));
  CFAutoRelease<CFURLRef> url(CFURLCreateWithFileSystemPath(kCFAllocatorDefault, path.get(), kCFURLPOSIXPathStyle, false));
 
  CTFontManagerRegisterFontsForURL(url.get(), kCTFontManagerScopeProcess, nullptr);
}
 
void MacOSSetCurrentLocaleName(const char *iso_code)
{
  if (!MacOSVersionIsAtLeast(10, 5, 0)) return;
 
  CFAutoRelease<CFStringRef> iso(CFStringCreateWithCString(kCFAllocatorDefault, iso_code, kCFStringEncodingUTF8));
  _osx_locale.reset(CFLocaleCreate(kCFAllocatorDefault, iso.get()));
}
 
int MacOSStringCompare(std::string_view s1, std::string_view s2)
{
  static bool supported = MacOSVersionIsAtLeast(10, 5, 0);
  if (!supported) return 0;
 
  CFStringCompareFlags flags = kCFCompareCaseInsensitive | kCFCompareNumerically | kCFCompareLocalized | kCFCompareWidthInsensitive | kCFCompareForcedOrdering;
 
  CFAutoRelease<CFStringRef> cf1(CFStringCreateWithBytes(kCFAllocatorDefault, (const UInt8 *)s1.data(), s1.size(), kCFStringEncodingUTF8, false));
  CFAutoRelease<CFStringRef> cf2(CFStringCreateWithBytes(kCFAllocatorDefault, (const UInt8 *)s2.data(), s2.size(), kCFStringEncodingUTF8, false));
 
  /* If any CFString could not be created (e.g., due to UTF8 invalid chars), return OS unsupported functionality */
  if (cf1 == nullptr || cf2 == nullptr) return 0;
 
  return (int)CFStringCompareWithOptionsAndLocale(cf1.get(), cf2.get(), CFRangeMake(0, CFStringGetLength(cf1.get())), flags, _osx_locale.get()) + 2;
}
 
int MacOSStringContains(const std::string_view str, const std::string_view value, bool case_insensitive)
{
  static bool supported = MacOSVersionIsAtLeast(10, 5, 0);
  if (!supported) return -1;
 
  CFStringCompareFlags flags = kCFCompareLocalized | kCFCompareWidthInsensitive;
  if (case_insensitive) flags |= kCFCompareCaseInsensitive;
 
  CFAutoRelease<CFStringRef> cf_str(CFStringCreateWithBytes(kCFAllocatorDefault, (const UInt8 *)str.data(), str.size(), kCFStringEncodingUTF8, false));
  CFAutoRelease<CFStringRef> cf_value(CFStringCreateWithBytes(kCFAllocatorDefault, (const UInt8 *)value.data(), value.size(), kCFStringEncodingUTF8, false));
 
  /* If any CFString could not be created (e.g., due to UTF8 invalid chars), return OS unsupported functionality */
  if (cf_str == nullptr || cf_value == nullptr) return -1;
 
  return CFStringFindWithOptionsAndLocale(cf_str.get(), cf_value.get(), CFRangeMake(0, CFStringGetLength(cf_str.get())), flags, _osx_locale.get(), nullptr) ? 1 : 0;
}
 
 
/* virtual */ void OSXStringIterator::SetString(std::string_view s)
{
  this->utf16_to_utf8.clear();
  this->str_info.clear();
  this->cur_pos = 0;
 
  /* CoreText operates on UTF-16, thus we have to convert the input string.
   * To be able to return proper offsets, we have to create a mapping at the same time. */
  std::vector<UniChar> utf16_str;     
  Utf8View view(s);
  for (auto it = view.begin(), end = view.end(); it != end; ++it) {
    size_t idx = it.GetByteOffset();
    char32_t c = *it;
    if (c < 0x10000) {
      utf16_str.push_back((UniChar)c);
    } else {
      /* Make a surrogate pair. */
      utf16_str.push_back((UniChar)(0xD800 + ((c - 0x10000) >> 10)));
      utf16_str.push_back((UniChar)(0xDC00 + ((c - 0x10000) & 0x3FF)));
      this->utf16_to_utf8.push_back(idx);
    }
    this->utf16_to_utf8.push_back(idx);
  }
  this->utf16_to_utf8.push_back(s.size());
 
  /* Query CoreText for word and cluster break information. */
  this->str_info.resize(utf16_to_utf8.size());
 
  if (!utf16_str.empty()) {
    CFAutoRelease<CFStringRef> str(CFStringCreateWithCharactersNoCopy(kCFAllocatorDefault, &utf16_str[0], utf16_str.size(), kCFAllocatorNull));
 
    /* Get cluster breaks. */
    for (CFIndex i = 0; i < CFStringGetLength(str.get()); ) {
      CFRange r = CFStringGetRangeOfComposedCharactersAtIndex(str.get(), i);
      this->str_info[r.location].char_stop = true;
 
      i += r.length;
    }
 
    /* Get word breaks. */
    CFAutoRelease<CFStringTokenizerRef> tokenizer(CFStringTokenizerCreate(kCFAllocatorDefault, str.get(), CFRangeMake(0, CFStringGetLength(str.get())), kCFStringTokenizerUnitWordBoundary, _osx_locale.get()));
 
    CFStringTokenizerTokenType tokenType = kCFStringTokenizerTokenNone;
    while ((tokenType = CFStringTokenizerAdvanceToNextToken(tokenizer.get())) != kCFStringTokenizerTokenNone) {
      /* Skip tokens that are white-space or punctuation tokens. */
      if ((tokenType & kCFStringTokenizerTokenHasNonLettersMask) != kCFStringTokenizerTokenHasNonLettersMask) {
        CFRange r = CFStringTokenizerGetCurrentTokenRange(tokenizer.get());
        this->str_info[r.location].word_stop = true;
      }
    }
  }
 
  /* End-of-string is always a valid stopping point. */
  this->str_info.back().char_stop = true;
  this->str_info.back().word_stop = true;
}
 
/* virtual */ size_t OSXStringIterator::SetCurPosition(size_t pos)
{
  /* Convert incoming position to an UTF-16 string index. */
  size_t utf16_pos = 0;
  for (size_t i = 0; i < this->utf16_to_utf8.size(); i++) {
    if (this->utf16_to_utf8[i] == pos) {
      utf16_pos = i;
      break;
    }
  }
 
  /* Sanitize in case we get a position inside a grapheme cluster. */
  while (utf16_pos > 0 && !this->str_info[utf16_pos].char_stop) utf16_pos--;
  this->cur_pos = utf16_pos;
 
  return this->utf16_to_utf8[this->cur_pos];
}
 
/* virtual */ size_t OSXStringIterator::Next(IterType what)
{
  assert(this->cur_pos <= this->utf16_to_utf8.size());
  assert(what == StringIterator::ITER_CHARACTER || what == StringIterator::ITER_WORD);
 
  if (this->cur_pos == this->utf16_to_utf8.size()) return END;
 
  do {
    this->cur_pos++;
  } 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));
 
  return this->cur_pos == this->utf16_to_utf8.size() ? END : this->utf16_to_utf8[this->cur_pos];
}
 
/* virtual */ size_t OSXStringIterator::Prev(IterType what)
{
  assert(this->cur_pos <= this->utf16_to_utf8.size());
  assert(what == StringIterator::ITER_CHARACTER || what == StringIterator::ITER_WORD);
 
  if (this->cur_pos == 0) return END;
 
  do {
    this->cur_pos--;
  } while (this->cur_pos > 0 && (what == ITER_WORD ? !this->str_info[this->cur_pos].word_stop : !this->str_info[this->cur_pos].char_stop));
 
  return this->utf16_to_utf8[this->cur_pos];
}
 
/* static */ std::unique_ptr<StringIterator> OSXStringIterator::Create()
{
  if (!MacOSVersionIsAtLeast(10, 5, 0)) return nullptr;
 
  return std::make_unique<OSXStringIterator>();
}