Added GDI font emulation support for Flash.

content/common/font_warmup_win.cc

 // Copyright 2014 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #include "content/common/font_warmup_win.h"
 
 #include <dwrite.h>
+#include <map>
 
 #include "base/debug/alias.h"
+#include "base/files/file_path.h"
 #include "base/logging.h"
+#include "base/memory/ref_counted.h"
+#include "base/numerics/safe_conversions.h"
+#include "base/numerics/safe_math.h"
+#include "base/strings/utf_string_conversions.h"
+#include "base/synchronization/lock.h"
+#include "base/sys_byteorder.h"
 #include "base/win/iat_patch_function.h"
 #include "base/win/windows_version.h"
 #include "content/public/common/dwrite_font_platform_win.h"
 #include "skia/ext/fontmgr_default_win.h"
 #include "skia/ext/refptr.h"
 #include "third_party/WebKit/public/web/win/WebFontRendering.h"
 #include "third_party/skia/include/core/SkPaint.h"
 #include "third_party/skia/include/ports/SkFontMgr.h"
 #include "third_party/skia/include/ports/SkTypeface_win.h"
 #include "ui/gfx/hud_font.h"
@@ skipping 157 matching lines @@
 
 void PatchDWriteFactory(IDWriteFactory* factory) {
   const unsigned int kGetSystemFontCollectionVTableIndex = 3;
 
   PROC* vtable = *reinterpret_cast<PROC**>(factory);
   PROC* function_ptr = &vtable[kGetSystemFontCollectionVTableIndex];
   void* stub_function = &StubFontCollection;
   base::win::ModifyCode(function_ptr, &stub_function, sizeof(PROC));
 }
 
+// Magic values for the fake GDI objects.
+const uint32_t kFakeDCMagic = 'fkdc';
+const uint32_t kFakeFontMagic = 'fkft';
+
+// Class to fake out a DC or a Font object. Maintains a reference to a
+// SkTypeFace to emulate the simple operation of a DC and Font. We can't
+// be sure that this won't be used in a multi-threaded environment so we
+// need to ensure a lock is taken before updating the static table of
+// issued objects.
+class FakeGdiObject : public base::RefCountedThreadSafe<FakeGdiObject> {
+ public:
+  // Find a corresponding fake GDI object and verify its magic value.
+  // The returned object is either nullptr or the new object.

[nasko, 2015/09/21 15:58:20]

This method doesn't allocate an object, so the comment saying it returns "the
new object" is a bit strange. Isn't it an existing object?

[forshaw, 2015/09/21 22:06:20]

Acknowledged.

+  static scoped_refptr<FakeGdiObject> Validate(void* obj, uint32_t magic) {
+    if (obj) {
+      base::AutoLock scoped_lock(objects_lock_);
+      auto handle_entry = objects_.find(reinterpret_cast<uintptr_t>(obj));
+      if (handle_entry != objects_.end() &&
+          handle_entry->second->magic_ == magic) {
+        return handle_entry->second;
+      }
+    }
+    return nullptr;
+  }
+
+  static scoped_refptr<FakeGdiObject> Create(uint32_t magic) {
+    base::AutoLock scoped_lock(objects_lock_);
+    scoped_refptr<FakeGdiObject> object(new FakeGdiObject(magic));
+    objects_[object->handle_] = object;
+    return object;
+  }
+
+  static bool DeleteObject(void* obj, uint32_t magic) {
+    base::AutoLock scoped_lock(objects_lock_);
+    auto handle_entry = objects_.find(reinterpret_cast<uintptr_t>(obj));
+    if (handle_entry != objects_.end() &&
+        handle_entry->second->magic_ == magic) {
+      objects_.erase(handle_entry);
+      return true;
+    }
+    return false;
+  }
+
+  static size_t GetObjectCount() {
+    base::AutoLock scoped_lock(objects_lock_);
+    return objects_.size();
+  }
+
+  static void ResetObjectHandles() {
+    base::AutoLock scoped_lock(objects_lock_);
+    curr_handle_ = 0;
+    objects_.clear();
+  }
+
+  void SetTypeface(const skia::RefPtr<SkTypeface>& typeface) {
+    typeface_ = typeface;
+  }
+
+  skia::RefPtr<SkTypeface> GetTypeface() { return typeface_; }
+
+  void* GetHandle() { return reinterpret_cast<void*>(handle_); }
+
+ private:
+  friend class base::RefCountedThreadSafe<FakeGdiObject>;
+
+  skia::RefPtr<SkTypeface> typeface_;
+  uintptr_t handle_;
+  uint32_t magic_;
+
+  static base::CheckedNumeric<uintptr_t> curr_handle_;

[nasko, 2015/09/21 15:58:20]

Static members should come prior to member variables.

Also, in general, the pattern of having static class variables isn't used in
Chromium, instead a lazy instance variable in anonymous namespace is used.

[forshaw, 2015/09/21 22:06:20]

Acknowledged.

+  static std::map<uintptr_t, scoped_refptr<FakeGdiObject>> objects_;
+  static base::Lock objects_lock_;
+
+  // We don't support wrapping the fake handle value.
+  FakeGdiObject(uint32_t magic) : magic_(magic) {
+    curr_handle_++;
+    handle_ = curr_handle_.ValueOrDie();
+  }
+  ~FakeGdiObject() {}
+
+  DISALLOW_COPY_AND_ASSIGN(FakeGdiObject);
+};
+
+base::CheckedNumeric<uintptr_t> FakeGdiObject::curr_handle_(0);
+std::map<uintptr_t, scoped_refptr<FakeGdiObject>> FakeGdiObject::objects_;
+base::Lock FakeGdiObject::objects_lock_;
+
+skia::RefPtr<SkTypeface> GetTypefaceFromLOGFONT(const LOGFONTW* log_font) {
+  CHECK(g_warmup_fontmgr);
+  int weight = log_font->lfWeight;
+  if (weight == FW_DONTCARE)
+    weight = SkFontStyle::kNormal_Weight;
+
+  SkFontStyle style(weight, log_font->lfWidth,
+                    log_font->lfItalic ? SkFontStyle::kItalic_Slant
+                                       : SkFontStyle::kUpright_Slant);
+
+  std::string family_name = base::WideToUTF8(log_font->lfFaceName);
+  return skia::AdoptRef(
+      g_warmup_fontmgr->matchFamilyStyle(family_name.c_str(), style));
+}
+
+HDC WINAPI CreateCompatibleDCPatch(HDC dc_handle) {
+  scoped_refptr<FakeGdiObject> ret = FakeGdiObject::Create(kFakeDCMagic);
+  return static_cast<HDC>(ret->GetHandle());
+}
+
+HFONT WINAPI CreateFontIndirectWPatch(const LOGFONTW* log_font) {
+  if (!log_font)
+    return nullptr;
+
+  skia::RefPtr<SkTypeface> typeface = GetTypefaceFromLOGFONT(log_font);
+  if (!typeface)
+    return nullptr;
+
+  scoped_refptr<FakeGdiObject> ret = FakeGdiObject::Create(kFakeFontMagic);
+  ret->SetTypeface(typeface);
+
+  return static_cast<HFONT>(ret->GetHandle());
+}
+
+BOOL WINAPI DeleteDCPatch(HDC dc_handle) {
+  if (dc_handle)
+    return FakeGdiObject::DeleteObject(dc_handle, kFakeDCMagic);
+  return FALSE;

[nasko, 2015/09/21 15:58:20]

Lowercase false.

[forshaw, 2015/09/21 22:06:20]

Acknowledged.

+}
+
+BOOL WINAPI DeleteObjectPatch(HGDIOBJ object_handle) {
+  if (object_handle)
+    return FakeGdiObject::DeleteObject(object_handle, kFakeFontMagic);
+  return FALSE;

[nasko, 2015/09/21 15:58:20]

Lowercase false.

[forshaw, 2015/09/21 22:06:20]

Acknowledged.

+}
+
+int WINAPI EnumFontFamiliesExWPatch(HDC dc_handle,
+                                    LPLOGFONTW log_font,
+                                    FONTENUMPROCW enum_callback,
+                                    LPARAM callback_param,
+                                    DWORD flags) {
+  scoped_refptr<FakeGdiObject> dc_obj =
+      FakeGdiObject::Validate(dc_handle, kFakeDCMagic);
+  if (!dc_obj) {
+    LOG(ERROR) << "Invalid DC Object";

[nasko, 2015/09/21 15:58:20]

LOG(ERROR) is usually avoided. Please convert it to some form of D*LOG or just
remove. Same for the LOGs below.

[forshaw, 2015/09/21 22:06:20]

Acknowledged.

+    return 1;
+  }
+  if (!log_font || !enum_callback)
+    return 1;
+
+  skia::RefPtr<SkTypeface> typeface = GetTypefaceFromLOGFONT(log_font);
+  if (!typeface)
+    return 1;
+
+  ENUMLOGFONTEXDVW enum_log_font = {0};
+  enum_log_font.elfEnumLogfontEx.elfLogFont = *log_font;
+  // TODO: Fill in the rest of the text metric structure. Not yet needed for
+  // Flash support but might be in the future.
+  NEWTEXTMETRICEXW text_metric = {0};
+  text_metric.ntmTm.ntmFlags = NTM_PS_OPENTYPE;
+
+  return enum_callback(&enum_log_font.elfEnumLogfontEx.elfLogFont,
+                       reinterpret_cast<TEXTMETRIC*>(&text_metric),
+                       TRUETYPE_FONTTYPE, callback_param);
+}
+
+DWORD WINAPI GetFontDataPatch(HDC dc_handle,
+                              DWORD table_tag,
+                              DWORD table_offset,
+                              LPVOID buffer,
+                              DWORD buffer_length) {
+  scoped_refptr<FakeGdiObject> dc_obj =
+      FakeGdiObject::Validate(dc_handle, kFakeDCMagic);
+  if (!dc_obj) {
+    LOG(ERROR) << "Invalid DC Object";
+    return GDI_ERROR;
+  }
+
+  skia::RefPtr<SkTypeface> typeface = dc_obj->GetTypeface();
+  if (!typeface)
+    return GDI_ERROR;
+
+  if (buffer_length > INT32_MAX)
+    return GDI_ERROR;
+
+  // |getTableData| handles |buffer| being nullptr. However if it is nullptr
+  // then set the size to INT32_MAX otherwise |getTableData| will return the
+  // minimum value between the table entry size and the size passed in. The
+  // common Windows idiom is to pass 0 as |buffer_length| when passing nullptr,
+  // which would in this case result in |getTableData| returning 0 which isn't
+  // the correct answer for emulating GDI. |table_tag| must also have its
+  // byte order swapped to counter the swap which occurs in the called method.
+  size_t length = typeface->getTableData(
+      base::ByteSwap(base::strict_cast<uint32_t>(table_tag)), table_offset,
+      buffer ? buffer_length : INT32_MAX, buffer);
+  // We can't distinguish between an empty table and an error.
+  if (length == 0)
+    return GDI_ERROR;
+
+  return base::checked_cast<DWORD>(length);
+}
+
+HGDIOBJ WINAPI SelectObjectPatch(HDC dc_handle, HGDIOBJ object_handle) {
+  scoped_refptr<FakeGdiObject> dc_obj =
+      FakeGdiObject::Validate(dc_handle, kFakeDCMagic);
+  if (!dc_obj) {
+    LOG(ERROR) << "Invalid DC Object";
+    return nullptr;
+  }
+
+  scoped_refptr<FakeGdiObject> font_obj =
+      FakeGdiObject::Validate(object_handle, kFakeFontMagic);
+  if (!font_obj) {
+    LOG(ERROR) << "Invalid Font Object";
+    return nullptr;
+  }
+
+  // Construct a new fake font object to handle the old font if there's one.
+  scoped_refptr<FakeGdiObject> new_font_obj;
+  skia::RefPtr<SkTypeface> old_typeface = dc_obj->GetTypeface();
+  if (old_typeface) {
+    new_font_obj = FakeGdiObject::Create(kFakeFontMagic);
+    new_font_obj->SetTypeface(old_typeface);
+  }
+  dc_obj->SetTypeface(font_obj->GetTypeface());
+
+  if (new_font_obj)
+    return static_cast<HGDIOBJ>(new_font_obj->GetHandle());
+  return nullptr;
+}
+
+void DoSingleGdiPatch(base::win::IATPatchFunction& patch,
+                      const base::FilePath& path,
+                      const char* function_name,
+                      void* new_function) {
+  DWORD error = patch.Patch(path.value().c_str(), "gdi32.dll", function_name,
+                            new_function);
+  if (error != 0)
+    LOG(WARNING) << "Failed patching " << function_name << " " << error;
+}
+
+class GdiFontPatchDataImpl : public content::GdiFontPatchData {
+ public:
+  GdiFontPatchDataImpl(const base::FilePath& path);
+
+ private:
+  base::win::IATPatchFunction create_compatible_dc_patch_;
+  base::win::IATPatchFunction create_font_indirect_patch_;
+  base::win::IATPatchFunction create_delete_dc_patch_;
+  base::win::IATPatchFunction create_delete_object_patch_;
+  base::win::IATPatchFunction create_enum_font_families_patch_;
+  base::win::IATPatchFunction create_get_font_data_patch_;
+  base::win::IATPatchFunction create_select_object_patch_;
+};
+
+GdiFontPatchDataImpl::GdiFontPatchDataImpl(const base::FilePath& path) {
+  DoSingleGdiPatch(create_compatible_dc_patch_, path, "CreateCompatibleDC",
+                   CreateCompatibleDCPatch);
+  DoSingleGdiPatch(create_font_indirect_patch_, path, "CreateFontIndirectW",
+                   CreateFontIndirectWPatch);
+  DoSingleGdiPatch(create_delete_dc_patch_, path, "DeleteDC", DeleteDCPatch);
+  DoSingleGdiPatch(create_delete_object_patch_, path, "DeleteObject",
+                   DeleteObjectPatch);
+  DoSingleGdiPatch(create_enum_font_families_patch_, path,
+                   "EnumFontFamiliesExW", EnumFontFamiliesExWPatch);
+  DoSingleGdiPatch(create_get_font_data_patch_, path, "GetFontData",
+                   GetFontDataPatch);
+  DoSingleGdiPatch(create_select_object_patch_, path, "SelectObject",
+                   SelectObjectPatch);
+}
+
 }  // namespace
 
 void DoPreSandboxWarmupForTypeface(SkTypeface* typeface) {
   SkPaint paint_warmup;
   paint_warmup.setTypeface(typeface);
   wchar_t glyph = L'S';
   paint_warmup.measureText(&glyph, 2);
 }
 
 SkFontMgr* GetPreSandboxWarmupFontMgr() {
   if (!g_warmup_fontmgr) {
     IDWriteFactory* factory;
     CreateDirectWriteFactory(&factory);
 
     GetCustomFontCollection(factory);
 
     PatchDWriteFactory(factory);
 
     blink::WebFontRendering::setDirectWriteFactory(factory);
     g_warmup_fontmgr = SkFontMgr_New_DirectWrite(factory);
   }
   return g_warmup_fontmgr;
 }
 
+GdiFontPatchData* PatchGdiFontEnumeration(const base::FilePath& path) {
+  // We assume the fontmgr is already warmed up before calling this.
+  DCHECK(g_warmup_fontmgr);
+  return new GdiFontPatchDataImpl(path);
+}
+
+size_t GetEmulatedGdiHandleCount() {
+  return FakeGdiObject::GetObjectCount();
+}
+
+void ResetEmulatedGdiHandles() {
+  FakeGdiObject::ResetObjectHandles();
+}
+
+void SetPreSandboxWarmupFontMgr(SkFontMgr* fontmgr) {
+  g_warmup_fontmgr = fontmgr;
+}
+
 void WarmupDirectWrite() {
   static bool warmup_initialized = false;
   if (warmup_initialized)
     return;
   warmup_initialized = true;
   // The objects used here are intentionally not freed as we want the Skia
   // code to use these objects after warmup.
   SetDefaultSkiaFactory(GetPreSandboxWarmupFontMgr());
 
   // We need to warm up *some* font for DirectWrite. We also need to pass one
   // down for the CC HUD code, so use the same one here. Note that we don't use
   // a monospace as would be nice in an attempt to avoid a small startup time
   // regression, see http://crbug.com/463613.
   skia::RefPtr<SkTypeface> hud_typeface = skia::AdoptRef(
       GetPreSandboxWarmupFontMgr()->legacyCreateTypeface("Times New Roman", 0));
   DoPreSandboxWarmupForTypeface(hud_typeface.get());
   gfx::SetHudTypeface(hud_typeface);
 }
 
 }  // namespace content