path: root/pango2/pangodwrite-fontmap.cpp

/* Pango
 * pangodwrite-fontmap.cpp: Fontmap using DirectWrite
 *
 * Copyright (C) 2022 the GTK team
 *
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Library General Public
 * License as published by the Free Software Foundation; either
 * version 2 of the License, or (at your option) any later version.
 *
 * This library 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
 * Library General Public License for more details.
 *
 * You should have received a copy of the GNU Library General Public
 * License along with this library; if not, write to the
 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
 * Boston, MA 02111-1307, USA.
 */

#include "config.h"

#include <windows.h>
#include <initguid.h>
#include <dwrite.h>

#include <hb-ot.h>
#include <hb-directwrite.h>

#include "pangodwrite-fontmap.h"
#include "pango-fontmap-private.h"
#include "pango-hbface-private.h"
#include "pango-hbfont-private.h"
#include "pango-context.h"
#include "pango-trace-private.h"
#include "pangowin32-utils-private.h"


/**
 * Pango2DirectWriteFontMap:
 *
 * `Pango2DirectWriteFontMap` is a subclass of `Pango2FontMap` that
 * uses DirectWrite to populate the fontmap with the available fonts.
 */

/**
 * PANGO2_HAS_DIRECT_WRITE_FONTMAP:
 *
 * Defined to 1 at compile time if Pango2 was built with DirectWrite support.
 */


struct _Pango2DirectWriteFontMap
{
  Pango2FontMap parent_instance;

  IDWriteFactory *dwrite_factory;
  IDWriteGdiInterop *gdi_interop;
};

struct _Pango2DirectWriteFontMapClass
{
  Pango2FontMapClass parent_class;
};

#ifdef _MSC_VER
# define UUID_OF_IDWriteFactory __uuidof (IDWriteFactory)
#else
# define UUID_OF_IDWriteFactory IID_IDWriteFactory
#endif

/* {{{ DirectWrite utilities */

static Pango2Stretch
util_to_pango2_stretch (DWRITE_FONT_STRETCH stretch)
{
  Pango2Stretch pango2_stretch = PANGO2_STRETCH_NORMAL;

  switch (stretch)
    {
      case DWRITE_FONT_STRETCH_ULTRA_CONDENSED:
        pango2_stretch = PANGO2_STRETCH_ULTRA_CONDENSED;
        break;
      case DWRITE_FONT_STRETCH_EXTRA_CONDENSED:
        pango2_stretch = PANGO2_STRETCH_EXTRA_CONDENSED;
        break;
      case DWRITE_FONT_STRETCH_CONDENSED:
        pango2_stretch = PANGO2_STRETCH_CONDENSED;
        break;
      case DWRITE_FONT_STRETCH_SEMI_CONDENSED:
        pango2_stretch = PANGO2_STRETCH_SEMI_CONDENSED;
        break;
      case DWRITE_FONT_STRETCH_NORMAL:
        /* also DWRITE_FONT_STRETCH_MEDIUM */
        pango2_stretch = PANGO2_STRETCH_NORMAL;
        break;
      case DWRITE_FONT_STRETCH_SEMI_EXPANDED:
        pango2_stretch = PANGO2_STRETCH_SEMI_EXPANDED;
        break;
      case DWRITE_FONT_STRETCH_EXPANDED:
        pango2_stretch = PANGO2_STRETCH_EXPANDED;
        break;
      case DWRITE_FONT_STRETCH_EXTRA_EXPANDED:
        pango2_stretch = PANGO2_STRETCH_EXTRA_EXPANDED;
        break;
      case DWRITE_FONT_STRETCH_ULTRA_EXPANDED:
        pango2_stretch = PANGO2_STRETCH_ULTRA_EXPANDED;
        break;
      case DWRITE_FONT_STRETCH_UNDEFINED:
      default:
        pango2_stretch = PANGO2_STRETCH_NORMAL;
    }

  return pango2_stretch;
}

static Pango2Style
util_to_pango2_style (DWRITE_FONT_STYLE style)
{
  switch (style)
    {
    case DWRITE_FONT_STYLE_NORMAL:
      return PANGO2_STYLE_NORMAL;
    case DWRITE_FONT_STYLE_OBLIQUE:
      return PANGO2_STYLE_OBLIQUE;
    case DWRITE_FONT_STYLE_ITALIC:
      return PANGO2_STYLE_ITALIC;
    default:
      g_assert_not_reached ();
      return PANGO2_STYLE_NORMAL;
    }
}

static int
util_map_weight (int weight)
{
  if G_UNLIKELY (weight < 100)
    weight = 100;

  if G_UNLIKELY (weight > 1000)
    weight = 1000;

  return weight;
}

static Pango2Weight
util_to_pango2_weight (DWRITE_FONT_WEIGHT weight)
{
  /* DirectWrite weight values range from 1 to 999, Pango2 weight values
   * range from 100 to 1000. */

  return (Pango2Weight) util_map_weight (weight);
}

static Pango2FontDescription*
util_get_pango2_font_description (IDWriteFont *font,
                                  const char *family_name)
{
  DWRITE_FONT_STRETCH stretch = font->GetStretch ();
  DWRITE_FONT_STYLE style = font->GetStyle ();
  DWRITE_FONT_WEIGHT weight = font->GetWeight ();
  Pango2FontDescription *description;

  description = pango2_font_description_new ();
  pango2_font_description_set_family (description, family_name);
  pango2_font_description_set_stretch (description, util_to_pango2_stretch (stretch));
  pango2_font_description_set_style (description, util_to_pango2_style (style));
  pango2_font_description_set_weight (description, util_to_pango2_weight (weight));

  return description;
}

static char*
util_free_to_string (IDWriteLocalizedStrings *strings)
{
  char *string = NULL;
  HRESULT hr;

  if (strings->GetCount() > 0)
    {
      UINT32 index = 0;
      BOOL exists = FALSE;
      UINT32 length = 0;

      hr = strings->FindLocaleName (L"en-us", &index, &exists);
      if (FAILED (hr) || !exists || index == UINT32_MAX)
        index = 0;

      hr = strings->GetStringLength (index, &length);
      if (SUCCEEDED (hr) && length > 0)
        {
          gunichar2 *string_utf16 = g_new (gunichar2, length + 1);

          hr = strings->GetString (index, (wchar_t*) string_utf16, length + 1);
          if (SUCCEEDED (hr))
            string = g_utf16_to_utf8 (string_utf16, -1, NULL, NULL, NULL);

          g_free (string_utf16);
        }
    }

  strings->Release ();

  return string;
}

static char*
util_dwrite_get_font_variant_name (IDWriteFont *font)
{
  IDWriteLocalizedStrings *strings = NULL;
  HRESULT hr;

  hr = font->GetFaceNames (&strings);
  if (FAILED (hr) || strings == NULL)
    {
      g_warning ("IDWriteFont::GetFaceNames failed with error code %x", (unsigned) hr);
      return NULL;
    }

  return util_free_to_string (strings);
}

static char*
util_dwrite_get_font_family_name (IDWriteFontFamily *family)
{
  IDWriteLocalizedStrings *strings = NULL;
  HRESULT hr;

  hr = family->GetFamilyNames (&strings);
  if (FAILED (hr) || strings == NULL)
    {
      g_warning ("IDWriteFontFamily::GetFamilyNames failed with error code %x", (unsigned) hr);
      return NULL;
    }

  return util_free_to_string (strings);
}

static Pango2HbFace*
util_create_pango2_hb_face (IDWriteFontFamily *family,
                            IDWriteFont *font,
                            IDWriteFontFace *face)
{
  char *family_name = util_dwrite_get_font_family_name (family);
  char *variant_name = util_dwrite_get_font_variant_name (font);
  Pango2HbFace *pango_face = NULL;

  if (family_name && variant_name)
    {
      Pango2FontDescription *description = util_get_pango2_font_description (font, family_name);
      hb_face_t *hb_face = hb_directwrite_face_create (face);
      char *name = g_strconcat (family_name, " ", variant_name, NULL);

      hb_face_make_immutable (hb_face);

      pango_face = pango2_hb_face_new_from_hb_face (hb_face, -1, name, description);

      g_free (name);
      hb_face_destroy (hb_face);
      pango2_font_description_free (description);
    }

  g_free (family_name);
  g_free (variant_name);

  return pango_face;
}

/* }}} */
/* {{{ Pango2FontMap implementation */

static void
pango2_direct_write_font_map_populate (Pango2FontMap *map)
{
  Pango2DirectWriteFontMap *dwrite_map = PANGO2_DIRECT_WRITE_FONT_MAP (map);
  IDWriteFontCollection *collection = NULL;
  UINT32 count;
  HRESULT hr;

  hr = dwrite_map->dwrite_factory->GetSystemFontCollection (&collection, FALSE);
  if (FAILED (hr) || collection == NULL)
    g_error ("IDWriteFactory::GetSystemFontCollection failed with error code %x\n", (unsigned)hr);

  count = collection->GetFontFamilyCount ();

  for (UINT32 i = 0; i < count; i++)
    {
      IDWriteFontFamily *family = NULL;
      UINT32 font_count;

      hr = collection->GetFontFamily (i, &family);
      if G_UNLIKELY (FAILED (hr) || family == NULL)
        {
          g_warning ("IDWriteFontCollection::GetFontFamily failed with error code %x\n", (unsigned)hr);
          continue;
        }

      font_count = family->GetFontCount ();

      for (UINT32 j = 0; j < font_count; j++)
        {
          IDWriteFont *font = NULL;
          IDWriteFontFace *face = NULL;
          Pango2HbFace *pango_face = NULL;

          hr = family->GetFont (j, &font);
          if (FAILED (hr) || font == NULL)
            {
              g_warning ("IDWriteFontFamily::GetFont failed with error code %x\n", (unsigned)hr);
              break;
            }

          hr = font->CreateFontFace (&face);
          if (FAILED (hr) || face == NULL)
            {
              g_warning ("IDWriteFont::CreateFontFace failed with error code %x\n", (unsigned)hr);
              font->Release ();
              continue;
            }

          pango_face = util_create_pango2_hb_face (family, font, face);
          if (pango_face)
            pango2_font_map_add_face (map, PANGO2_FONT_FACE (pango_face));

          face->Release ();
          font->Release ();
        }

      family->Release ();
    }

  collection->Release ();
  collection = NULL;

  pango2_win32_font_map_add_aliases_and_fallbacks (map);
}

/* }}} */
/* {{{ Pango2DirectWriteFontMap implementation */

G_DEFINE_FINAL_TYPE (Pango2DirectWriteFontMap, pango2_direct_write_font_map, PANGO2_TYPE_FONT_MAP)

struct DirectWriteItems
{
  IDWriteFactory *dwrite_factory;
  IDWriteGdiInterop *gdi_interop;
};

static struct DirectWriteItems
init_direct_write (void)
{
  HRESULT hr;
  struct DirectWriteItems dwrite_items = {NULL, NULL};
  IDWriteFactory *dwrite_factory = NULL;
  IDWriteGdiInterop *gdi_interop = NULL;

  hr = DWriteCreateFactory (DWRITE_FACTORY_TYPE_SHARED,
                            UUID_OF_IDWriteFactory,
                            reinterpret_cast<IUnknown**> (&dwrite_factory));

  if (FAILED (hr) || !dwrite_factory)
    g_error ("DWriteCreateFactory failed with error code %x", (unsigned)hr);
  else
    {
      hr = dwrite_factory->GetGdiInterop (&gdi_interop);

      if (FAILED (hr) || !gdi_interop)
        {
          dwrite_factory->Release ();
          g_error ("GdiInterop failed with error code %x", (unsigned)hr);
        }
      else
        {
          dwrite_items.dwrite_factory = dwrite_factory;
          dwrite_items.gdi_interop = gdi_interop;
        }
    }

  return dwrite_items;
}

static void
pango2_direct_write_font_map_init (Pango2DirectWriteFontMap *self)
{
  struct DirectWriteItems dwrite_items = init_direct_write ();

  self->dwrite_factory = dwrite_items.dwrite_factory;
  self->gdi_interop = dwrite_items.gdi_interop;

  pango2_font_map_repopulate (PANGO2_FONT_MAP (self), TRUE);
}

static void
pango2_direct_write_font_map_finalize (GObject *object)
{
  Pango2DirectWriteFontMap *dwrite_map = PANGO2_DIRECT_WRITE_FONT_MAP (object);

  if (dwrite_map->gdi_interop != NULL)
    {
      dwrite_map->gdi_interop->Release ();
      dwrite_map->gdi_interop = NULL;
    }

  dwrite_map->dwrite_factory->Release ();
  dwrite_map->dwrite_factory = NULL;

  G_OBJECT_CLASS (pango2_direct_write_font_map_parent_class)->finalize (object);
}

static void
pango2_direct_write_font_map_class_init (Pango2DirectWriteFontMapClass *class_)
{
  GObjectClass *object_class = G_OBJECT_CLASS (class_);
  Pango2FontMapClass *font_map_class = PANGO2_FONT_MAP_CLASS (class_);

  object_class->finalize = pango2_direct_write_font_map_finalize;

  font_map_class->populate = pango2_direct_write_font_map_populate;
}

/* }}} */
 /* {{{ Public API */

/**
 * pango2_direct_write_font_map_new:
 *
 * Creates a new `Pango2DirectWriteFontMap` object.
 *
 * Returns: a new `Pango2DirectWriteFontMap`
 */
Pango2DirectWriteFontMap *
pango2_direct_write_font_map_new (void)
{
  return (Pango2DirectWriteFontMap *) g_object_new (PANGO2_TYPE_DIRECT_WRITE_FONT_MAP, NULL);
}

/**
 * pango2_direct_write_get_font_description_from_dwrite_font:
 * @dwrite_font: the `IDWriteFont` to query the font description
 *
 * Returns a `Pango2FontDescription` that corresonds to the `IDWriteFont`,
 * this API is normally used from C++ as `IDWriteFont`'s are created or
 * obtained via the Windows DirectWrite APIs, which are normally only
 * accessible via C++.
 *
 * Return value: the `Pango2FontDescription` corresonding to @dwrite_font,
 * the returned value should be freed with [method@Pango2.FontDescription.free]
 */
Pango2FontDescription *
pango2_direct_write_get_font_description_from_dwrite_font (gpointer dwrite_font)
{
  HRESULT hr;
  IDWriteFont *font = NULL;
  IDWriteFontFamily *family = NULL;
  Pango2FontDescription *desc = NULL;

  g_return_val_if_fail (dwrite_font != NULL, NULL);

  font = static_cast<IDWriteFont*>(dwrite_font);

  hr = font->GetFontFamily (&family);

  if (SUCCEEDED (hr) && family != NULL)
    {
      char *family_name = util_dwrite_get_font_family_name (family);

      if (family_name != NULL)
        desc = util_get_pango2_font_description (font, family_name);

      family->Release ();
    }
  else
    g_error ("IDWriteFont::GetFontFamily failed with error code %x\n", (unsigned)hr);

  return desc;
}

/**
 * pango2_direct_write_get_font_description_from_logfontw:
 * @lfw: the `LOGFONTW` to query the font description
 * @font_map: (nullable): the `Pango2FontMap` to use
 *
 * Returns a `Pango2FontDescription` that corresonds to the `LOGFONTW`.  An optional
 * `Pango2FontMap` of type `Pango2DirectWriteFontMap` may be passed in to indicate
 * DirectWrite has been set up through Pango, to optimize things.
 *
 * Return value: the `Pango2FontDescription` corresonding to @lfw,
 * the returned value should be freed with [method@Pango2.FontDescription.free]
 */
Pango2FontDescription *
pango2_direct_write_get_font_description_from_logfontw (LOGFONTW      *lfw,
                                                        Pango2FontMap *font_map)
{
  HRESULT hr;
  IDWriteFont *dwrite_font = NULL;
  Pango2DirectWriteFontMap *dwrite_fontmap = NULL;
  Pango2FontDescription *desc = NULL;
  struct DirectWriteItems dwrite_items = {NULL, NULL};
  IDWriteFactory *dwrite_factory = NULL;
  IDWriteGdiInterop *gdi_interop = NULL;

  if (PANGO2_IS_DIRECT_WRITE_FONT_MAP (font_map))
    gdi_interop = PANGO2_DIRECT_WRITE_FONT_MAP (font_map)->gdi_interop;
  else
    {
      struct DirectWriteItems dwrite_items = init_direct_write ();

      dwrite_factory = dwrite_items.dwrite_factory;
      gdi_interop = dwrite_items.gdi_interop;

      if (dwrite_factory == NULL || gdi_interop == NULL)
        return NULL;
    }

  hr = gdi_interop->CreateFontFromLOGFONT (lfw, &dwrite_font);

  if (FAILED (hr) || dwrite_font == NULL)
    {
      g_error ("IDWriteFactory::GdiInterop::CreateFontFromLOGFONT failed with error code %x\n", (unsigned)hr);
      return NULL;
    }

  desc = pango2_direct_write_get_font_description_from_dwrite_font (dwrite_font);
  dwrite_font->Release ();

  if (dwrite_factory != NULL)
    {
      gdi_interop->Release ();
      dwrite_factory->Release ();
    }

  return desc;
}
/* }}} */

/* vim:set foldmethod=marker expandtab: */