Mercurial > vim
view src/gui_dwrite.cpp @ 32936:c517845bd10e v9.0.1776
patch 9.0.1776: No support for stable Python 3 ABI
Commit: https://github.com/vim/vim/commit/c13b3d1350b60b94fe87f0761ea31c0e7fb6ebf3
Author: Yee Cheng Chin <ychin.git@gmail.com>
Date: Sun Aug 20 21:18:38 2023 +0200
patch 9.0.1776: No support for stable Python 3 ABI
Problem: No support for stable Python 3 ABI
Solution: Support Python 3 stable ABI
Commits:
1) Support Python 3 stable ABI to allow mixed version interoperatbility
Vim currently supports embedding Python for use with plugins, and the
"dynamic" linking option allows the user to specify a locally installed
version of Python by setting `pythonthreedll`. However, one caveat is
that the Python 3 libs are not binary compatible across minor versions,
and mixing versions can potentially be dangerous (e.g. let's say Vim was
linked against the Python 3.10 SDK, but the user sets `pythonthreedll`
to a 3.11 lib). Usually, nothing bad happens, but in theory this could
lead to crashes, memory corruption, and other unpredictable behaviors.
It's also difficult for the user to tell something is wrong because Vim
has no way of reporting what Python 3 version Vim was linked with.
For Vim installed via a package manager, this usually isn't an issue
because all the dependencies would already be figured out. For prebuilt
Vim binaries like MacVim (my motivation for working on this), AppImage,
and Win32 installer this could potentially be an issue as usually a
single binary is distributed. This is more tricky when a new Python
version is released, as there's a chicken-and-egg issue with deciding
what Python version to build against and hard to keep in sync when a new
Python version just drops and we have a mix of users of different Python
versions, and a user just blindly upgrading to a new Python could lead to
bad interactions with Vim.
Python 3 does have a solution for this problem: stable ABI / limited API
(see https://docs.python.org/3/c-api/stable.html). The C SDK limits the
API to a set of functions that are promised to be stable across
versions. This pull request adds an ifdef config that allows us to turn
it on when building Vim. Vim binaries built with this option should be
safe to freely link with any Python 3 libraies without having the
constraint of having to use the same minor version.
Note: Python 2 has no such concept and this doesn't change how Python 2
integration works (not that there is going to be a new version of Python
2 that would cause compatibility issues in the future anyway).
---
Technical details:
======
The stable ABI can be accessed when we compile with the Python 3 limited
API (by defining `Py_LIMITED_API`). The Python 3 code (in `if_python3.c`
and `if_py_both.h`) would now handle this and switch to limited API
mode. Without it set, Vim will still use the full API as before so this
is an opt-in change.
The main difference is that `PyType_Object` is now an opaque struct that
we can't directly create "static types" out of, and we have to create
type objects as "heap types" instead. This is because the struct is not
stable and changes from version to version (e.g. 3.8 added a
`tp_vectorcall` field to it). I had to change all the types to be
allocated on the heap instead with just a pointer to them.
Other functions are also simply missing in limited API, or they are
introduced too late (e.g. `PyUnicode_AsUTF8AndSize` in 3.10) to it that
we need some other ways to do the same thing, so I had to abstract a few
things into macros, and sometimes re-implement functions like
`PyObject_NEW`.
One caveat is that in limited API, `OutputType` (used for replacing
`sys.stdout`) no longer inherits from `PyStdPrinter_Type` which I don't
think has any real issue other than minor differences in how they
convert to a string and missing a couple functions like `mode()` and
`fileno()`.
Also fixed an existing bug where `tp_basicsize` was set incorrectly for
`BufferObject`, `TabListObject, `WinListObject`.
Technically, there could be a small performance drop, there is a little
more indirection with accessing type objects, and some APIs like
`PyUnicode_AsUTF8AndSize` are missing, but in practice I didn't see any
difference, and any well-written Python plugin should try to avoid
excessing callbacks to the `vim` module in Python anyway.
I only tested limited API mode down to Python 3.7, which seemes to
compile and work fine. I haven't tried earlier Python versions.
2) Fix PyIter_Check on older Python vers / type##Ptr unused warning
For PyIter_Check, older versions exposed them as either macros (used in
full API), or a function (for use in limited API). A previous change
exposed PyIter_Check to the dynamic build because Python just moved it
to function-only in 3.10 anyway. Because of that, just make sure we
always grab the function in dynamic builds in earlier versions since
that's what Python eventually did anyway.
3) Move Py_LIMITED_API define to configure script
Can now use --with-python-stable-abi flag to customize what stable ABI
version to target. Can also use an env var to do so as well.
4) Show +python/dyn-stable in :version, and allow has() feature query
Not sure if the "/dyn-stable" suffix would break things, or whether we
should do it another way. Or just don't show it in version and rely on
has() feature checking.
5) Documentation first draft. Still need to implement v:python3_version
6) Fix PyIter_Check build breaks when compiling against Python 3.8
7) Add CI coverage stable ABI on Linux/Windows / make configurable on Windows
This adds configurable options for Windows make files (both MinGW and
MSVC). CI will also now exercise both traditional full API and stable
ABI for Linux and Windows in the matrix for coverage.
Also added a "dynamic" option to Linux matrix as a drive-by change to
make other scripting languages like Ruby / Perl testable under both
static and dynamic builds.
8) Fix inaccuracy in Windows docs
Python's own docs are confusing but you don't actually want to use
`python3.dll` for the dynamic linkage.
9) Add generated autoconf file
10) Add v:python3_version support
This variable indicates the version of Python3 that Vim was built
against (PY_VERSION_HEX), and will be useful to check whether the Python
library you are loading in dynamically actually fits it. When built with
stable ABI, it will be the limited ABI version instead
(`Py_LIMITED_API`), which indicates the minimum version of Python 3 the
user should have, rather than the exact match. When stable ABI is used,
we won't be exposing PY_VERSION_HEX in this var because it just doesn't
seem necessary to do so (the whole point of stable ABI is the promise
that it will work across versions), and I don't want to confuse the user
with too many variables.
Also, cleaned up some documentation, and added help tags.
11) Fix Python 3.7 compat issues
Fix a couple issues when using limited API < 3.8
- Crash on exit: In Python 3.7, if a heap-allocated type is destroyed
before all instances are, it would cause a crash later. This happens
when we destroyed `OptionsType` before calling `Py_Finalize` when
using the limited API. To make it worse, later versions changed the
semantics and now each instance has a strong reference to its own type
and the recommendation has changed to have each instance de-ref its
own type and have its type in GC traversal. To avoid dealing with
these cross-version variations, we just don't free the heap type. They
are static types in non-limited-API anyway and are designed to last
through the entirety of the app, and we also don't restart the Python
runtime and therefore do not need it to have absolutely 0 leaks.
See:
- https://docs.python.org/3/whatsnew/3.8.html#changes-in-the-c-api
- https://docs.python.org/3/whatsnew/3.9.html#changes-in-the-c-api
- PyIter_Check: This function is not provided in limited APIs older than
3.8. Previously I was trying to mock it out using manual
PyType_GetSlot() but it was brittle and also does not actually work
properly for static types (it will generate a Python error). Just
return false. It does mean using limited API < 3.8 is not recommended
as you lose the functionality to handle iterators, but from playing
with plugins I couldn't find it to be an issue.
- Fix loading of PyIter_Check so it will be done when limited API < 3.8.
Otherwise loading a 3.7 Python lib will fail even if limited API was
specified to use it.
12) Make sure to only load `PyUnicode_AsUTF8AndSize` in needed in limited API
We don't use this function unless limited API >= 3.10, but we were
loading it regardless. Usually it's ok in Unix-like systems where Python
just has a single lib that we load from, but in Windows where there is a
separate python3.dll this would not work as the symbol would not have
been exposed in this more limited DLL file. This makes it much clearer
under what condition is this function needed.
closes: #12032
Signed-off-by: Christian Brabandt <cb@256bit.org>
Co-authored-by: Yee Cheng Chin <ychin.git@gmail.com>
author | Christian Brabandt <cb@256bit.org> |
---|---|
date | Sun, 20 Aug 2023 21:30:04 +0200 |
parents | faf7fcd1c8d5 |
children |
line wrap: on
line source
/* vi:set ts=8 sts=4 sw=4 noet: */ /* * Author: MURAOKA Taro <koron.kaoriya@gmail.com> * * Contributors: * - Ken Takata * - Yasuhiro Matsumoto * * Copyright (C) 2013 MURAOKA Taro <koron.kaoriya@gmail.com> * THIS FILE IS DISTRIBUTED UNDER THE VIM LICENSE. */ #define WIN32_LEAN_AND_MEAN #ifndef DYNAMIC_DIRECTX # if WINVER < 0x0600 # error WINVER must be 0x0600 or above to use DirectWrite(DirectX) # endif #endif #include <windows.h> #include <crtdbg.h> #include <assert.h> #include <math.h> #include <d2d1.h> #include <d2d1helper.h> // Disable these macros to compile with old VC and newer SDK (V8.1 or later). #if defined(_MSC_VER) && (_MSC_VER < 1700) # define _COM_Outptr_ __out # define _In_reads_(s) # define _In_reads_opt_(s) # define _Maybenull_ # define _Out_writes_(s) # define _Out_writes_opt_(s) # define _Out_writes_to_(x, y) # define _Out_writes_to_opt_(x, y) # define _Outptr_ #endif #ifdef FEAT_DIRECTX_COLOR_EMOJI # include <dwrite_2.h> #else # include <dwrite.h> #endif #include "gui_dwrite.h" #ifdef __MINGW32__ # define __maybenull SAL__maybenull # define __in SAL__in # define __out SAL__out #endif #ifdef __MINGW32__ # define UNUSED __attribute__((unused)) #else # define UNUSED #endif #if (defined(_MSC_VER) && (_MSC_VER >= 1700)) || (__cplusplus >= 201103L) # define FINAL final #else # define FINAL #endif #ifdef DYNAMIC_DIRECTX extern "C" HINSTANCE vimLoadLib(const char *name); typedef int (WINAPI *PGETUSERDEFAULTLOCALENAME)(LPWSTR, int); typedef HRESULT (WINAPI *PD2D1CREATEFACTORY)(D2D1_FACTORY_TYPE, REFIID, const D2D1_FACTORY_OPTIONS *, void **); typedef HRESULT (WINAPI *PDWRITECREATEFACTORY)(DWRITE_FACTORY_TYPE, REFIID, IUnknown **); static HINSTANCE hD2D1DLL = NULL; static HINSTANCE hDWriteDLL = NULL; static PGETUSERDEFAULTLOCALENAME pGetUserDefaultLocaleName = NULL; static PD2D1CREATEFACTORY pD2D1CreateFactory = NULL; static PDWRITECREATEFACTORY pDWriteCreateFactory = NULL; #define GetUserDefaultLocaleName (*pGetUserDefaultLocaleName) #define D2D1CreateFactory (*pD2D1CreateFactory) #define DWriteCreateFactory (*pDWriteCreateFactory) static void unload(HINSTANCE &hinst) { if (hinst != NULL) { FreeLibrary(hinst); hinst = NULL; } } #endif // DYNAMIC_DIRECTX template <class T> inline void SafeRelease(T **ppT) { if (*ppT) { (*ppT)->Release(); *ppT = NULL; } } static DWRITE_PIXEL_GEOMETRY ToPixelGeometry(int value) { switch (value) { default: case 0: return DWRITE_PIXEL_GEOMETRY_FLAT; case 1: return DWRITE_PIXEL_GEOMETRY_RGB; case 2: return DWRITE_PIXEL_GEOMETRY_BGR; } } static int ToInt(DWRITE_PIXEL_GEOMETRY value) { switch (value) { case DWRITE_PIXEL_GEOMETRY_FLAT: return 0; case DWRITE_PIXEL_GEOMETRY_RGB: return 1; case DWRITE_PIXEL_GEOMETRY_BGR: return 2; default: return -1; } } static DWRITE_RENDERING_MODE ToRenderingMode(int value) { switch (value) { default: case 0: return DWRITE_RENDERING_MODE_DEFAULT; case 1: return DWRITE_RENDERING_MODE_ALIASED; case 2: return DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC; case 3: return DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL; case 4: return DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL; case 5: return DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC; case 6: return DWRITE_RENDERING_MODE_OUTLINE; } } static D2D1_TEXT_ANTIALIAS_MODE ToTextAntialiasMode(int value) { switch (value) { default: case 0: return D2D1_TEXT_ANTIALIAS_MODE_DEFAULT; case 1: return D2D1_TEXT_ANTIALIAS_MODE_CLEARTYPE; case 2: return D2D1_TEXT_ANTIALIAS_MODE_GRAYSCALE; case 3: return D2D1_TEXT_ANTIALIAS_MODE_ALIASED; } } static int ToInt(DWRITE_RENDERING_MODE value) { switch (value) { case DWRITE_RENDERING_MODE_DEFAULT: return 0; case DWRITE_RENDERING_MODE_ALIASED: return 1; case DWRITE_RENDERING_MODE_CLEARTYPE_GDI_CLASSIC: return 2; case DWRITE_RENDERING_MODE_CLEARTYPE_GDI_NATURAL: return 3; case DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL: return 4; case DWRITE_RENDERING_MODE_CLEARTYPE_NATURAL_SYMMETRIC: return 5; case DWRITE_RENDERING_MODE_OUTLINE: return 6; default: return -1; } } class FontCache { public: struct Item { HFONT hFont; IDWriteTextFormat* pTextFormat; DWRITE_FONT_WEIGHT fontWeight; DWRITE_FONT_STYLE fontStyle; Item() : hFont(NULL), pTextFormat(NULL) {} }; private: int mSize; Item *mItems; public: FontCache(int size = 2) : mSize(size), mItems(new Item[size]) { } ~FontCache() { for (int i = 0; i < mSize; ++i) SafeRelease(&mItems[i].pTextFormat); delete[] mItems; } bool get(HFONT hFont, Item &item) { int n = find(hFont); if (n < 0) return false; item = mItems[n]; slide(n); return true; } void put(const Item& item) { int n = find(item.hFont); if (n < 0) n = mSize - 1; if (mItems[n].pTextFormat != item.pTextFormat) { SafeRelease(&mItems[n].pTextFormat); if (item.pTextFormat != NULL) item.pTextFormat->AddRef(); } mItems[n] = item; slide(n); } private: int find(HFONT hFont) { for (int i = 0; i < mSize; ++i) { if (mItems[i].hFont == hFont) return i; } return -1; } void slide(int nextTop) { if (nextTop == 0) return; Item tmp = mItems[nextTop]; for (int i = nextTop - 1; i >= 0; --i) mItems[i + 1] = mItems[i]; mItems[0] = tmp; } }; enum DrawingMode { DM_GDI = 0, DM_DIRECTX = 1, DM_INTEROP = 2, }; struct DWriteContext { HDC mHDC; RECT mBindRect; DrawingMode mDMode; HDC mInteropHDC; bool mDrawing; bool mFallbackDC; ID2D1Factory *mD2D1Factory; ID2D1DCRenderTarget *mRT; ID2D1GdiInteropRenderTarget *mGDIRT; ID2D1SolidColorBrush *mBrush; ID2D1Bitmap *mBitmap; IDWriteFactory *mDWriteFactory; #ifdef FEAT_DIRECTX_COLOR_EMOJI IDWriteFactory2 *mDWriteFactory2; #endif IDWriteGdiInterop *mGdiInterop; IDWriteRenderingParams *mRenderingParams; FontCache mFontCache; IDWriteTextFormat *mTextFormat; DWRITE_FONT_WEIGHT mFontWeight; DWRITE_FONT_STYLE mFontStyle; D2D1_TEXT_ANTIALIAS_MODE mTextAntialiasMode; // METHODS DWriteContext(); virtual ~DWriteContext(); HRESULT CreateDeviceResources(); void DiscardDeviceResources(); HRESULT CreateTextFormatFromLOGFONT(const LOGFONTW &logFont, IDWriteTextFormat **ppTextFormat); HRESULT SetFontByLOGFONT(const LOGFONTW &logFont); void SetFont(HFONT hFont); void Rebind(); void BindDC(HDC hdc, const RECT *rect); HRESULT SetDrawingMode(DrawingMode mode); ID2D1Brush* SolidBrush(COLORREF color); void DrawText(const WCHAR *text, int len, int x, int y, int w, int h, int cellWidth, COLORREF color, UINT fuOptions, const RECT *lprc, const INT *lpDx); void FillRect(const RECT *rc, COLORREF color); void DrawLine(int x1, int y1, int x2, int y2, COLORREF color); void SetPixel(int x, int y, COLORREF color); void Scroll(int x, int y, const RECT *rc); void Flush(); void SetRenderingParams( const DWriteRenderingParams *params); DWriteRenderingParams *GetRenderingParams( DWriteRenderingParams *params); }; class AdjustedGlyphRun : public DWRITE_GLYPH_RUN { private: FLOAT &mAccum; FLOAT mDelta; FLOAT *mAdjustedAdvances; public: AdjustedGlyphRun( const DWRITE_GLYPH_RUN *glyphRun, FLOAT cellWidth, FLOAT &accum) : DWRITE_GLYPH_RUN(*glyphRun), mAccum(accum), mDelta(0.0f), mAdjustedAdvances(new FLOAT[glyphRun->glyphCount]) { assert(cellWidth != 0.0f); for (UINT32 i = 0; i < glyphRun->glyphCount; ++i) { FLOAT orig = glyphRun->glyphAdvances[i]; FLOAT adjusted = adjustToCell(orig, cellWidth); mAdjustedAdvances[i] = adjusted; mDelta += adjusted - orig; } glyphAdvances = mAdjustedAdvances; } ~AdjustedGlyphRun() { mAccum += mDelta; delete[] mAdjustedAdvances; } static FLOAT adjustToCell(FLOAT value, FLOAT cellWidth) { int cellCount = int(floor(value / cellWidth + 0.5f)); if (cellCount < 1) cellCount = 1; return cellCount * cellWidth; } }; struct TextRendererContext { // const fields. COLORREF color; FLOAT cellWidth; // working fields. FLOAT offsetX; }; class TextRenderer FINAL : public IDWriteTextRenderer { public: TextRenderer( DWriteContext* pDWC) : cRefCount_(0), pDWC_(pDWC) { AddRef(); } // add "virtual" to avoid a compiler warning virtual ~TextRenderer() { } IFACEMETHOD(IsPixelSnappingDisabled)( __maybenull void* clientDrawingContext UNUSED, __out BOOL* isDisabled) { *isDisabled = FALSE; return S_OK; } IFACEMETHOD(GetCurrentTransform)( __maybenull void* clientDrawingContext UNUSED, __out DWRITE_MATRIX* transform) { // forward the render target's transform pDWC_->mRT->GetTransform( reinterpret_cast<D2D1_MATRIX_3X2_F*>(transform)); return S_OK; } IFACEMETHOD(GetPixelsPerDip)( __maybenull void* clientDrawingContext UNUSED, __out FLOAT* pixelsPerDip) { float dpiX, unused; pDWC_->mRT->GetDpi(&dpiX, &unused); *pixelsPerDip = dpiX / 96.0f; return S_OK; } IFACEMETHOD(DrawUnderline)( __maybenull void* clientDrawingContext UNUSED, FLOAT baselineOriginX UNUSED, FLOAT baselineOriginY UNUSED, __in DWRITE_UNDERLINE const* underline UNUSED, IUnknown* clientDrawingEffect UNUSED) { return E_NOTIMPL; } IFACEMETHOD(DrawStrikethrough)( __maybenull void* clientDrawingContext UNUSED, FLOAT baselineOriginX UNUSED, FLOAT baselineOriginY UNUSED, __in DWRITE_STRIKETHROUGH const* strikethrough UNUSED, IUnknown* clientDrawingEffect UNUSED) { return E_NOTIMPL; } IFACEMETHOD(DrawInlineObject)( __maybenull void* clientDrawingContext UNUSED, FLOAT originX UNUSED, FLOAT originY UNUSED, IDWriteInlineObject* inlineObject UNUSED, BOOL isSideways UNUSED, BOOL isRightToLeft UNUSED, IUnknown* clientDrawingEffect UNUSED) { return E_NOTIMPL; } IFACEMETHOD(DrawGlyphRun)( __maybenull void* clientDrawingContext, FLOAT baselineOriginX, FLOAT baselineOriginY, DWRITE_MEASURING_MODE measuringMode UNUSED, __in DWRITE_GLYPH_RUN const* glyphRun, __in DWRITE_GLYPH_RUN_DESCRIPTION const* glyphRunDescription UNUSED, IUnknown* clientDrawingEffect UNUSED) { TextRendererContext *context = reinterpret_cast<TextRendererContext*>(clientDrawingContext); AdjustedGlyphRun adjustedGlyphRun(glyphRun, context->cellWidth, context->offsetX); #ifdef FEAT_DIRECTX_COLOR_EMOJI if (pDWC_->mDWriteFactory2 != NULL) { IDWriteColorGlyphRunEnumerator *enumerator = NULL; HRESULT hr = pDWC_->mDWriteFactory2->TranslateColorGlyphRun( baselineOriginX + context->offsetX, baselineOriginY, &adjustedGlyphRun, NULL, DWRITE_MEASURING_MODE_GDI_NATURAL, NULL, 0, &enumerator); if (SUCCEEDED(hr)) { // Draw by IDWriteFactory2 for color emoji BOOL hasRun = TRUE; enumerator->MoveNext(&hasRun); while (hasRun) { const DWRITE_COLOR_GLYPH_RUN* colorGlyphRun; enumerator->GetCurrentRun(&colorGlyphRun); pDWC_->mBrush->SetColor(colorGlyphRun->runColor); pDWC_->mRT->DrawGlyphRun( D2D1::Point2F( colorGlyphRun->baselineOriginX, colorGlyphRun->baselineOriginY), &colorGlyphRun->glyphRun, pDWC_->mBrush, DWRITE_MEASURING_MODE_NATURAL); enumerator->MoveNext(&hasRun); } SafeRelease(&enumerator); return S_OK; } } #endif // Draw by IDWriteFactory (without color emoji) pDWC_->mRT->DrawGlyphRun( D2D1::Point2F( baselineOriginX + context->offsetX, baselineOriginY), &adjustedGlyphRun, pDWC_->SolidBrush(context->color), DWRITE_MEASURING_MODE_NATURAL); return S_OK; } public: IFACEMETHOD_(unsigned long, AddRef) () { return InterlockedIncrement(&cRefCount_); } IFACEMETHOD_(unsigned long, Release) () { long newCount = InterlockedDecrement(&cRefCount_); if (newCount == 0) { delete this; return 0; } return newCount; } IFACEMETHOD(QueryInterface)( IID const& riid, void** ppvObject) { if (__uuidof(IDWriteTextRenderer) == riid) { *ppvObject = this; } else if (__uuidof(IDWritePixelSnapping) == riid) { *ppvObject = this; } else if (__uuidof(IUnknown) == riid) { *ppvObject = this; } else { *ppvObject = NULL; return E_FAIL; } return S_OK; } private: long cRefCount_; DWriteContext* pDWC_; }; DWriteContext::DWriteContext() : mHDC(NULL), mBindRect(), mDMode(DM_GDI), mInteropHDC(NULL), mDrawing(false), mFallbackDC(false), mD2D1Factory(NULL), mRT(NULL), mGDIRT(NULL), mBrush(NULL), mBitmap(NULL), mDWriteFactory(NULL), #ifdef FEAT_DIRECTX_COLOR_EMOJI mDWriteFactory2(NULL), #endif mGdiInterop(NULL), mRenderingParams(NULL), mFontCache(8), mTextFormat(NULL), mFontWeight(DWRITE_FONT_WEIGHT_NORMAL), mFontStyle(DWRITE_FONT_STYLE_NORMAL), mTextAntialiasMode(D2D1_TEXT_ANTIALIAS_MODE_DEFAULT) { HRESULT hr; hr = D2D1CreateFactory(D2D1_FACTORY_TYPE_SINGLE_THREADED, __uuidof(ID2D1Factory), NULL, reinterpret_cast<void**>(&mD2D1Factory)); _RPT2(_CRT_WARN, "D2D1CreateFactory: hr=%p p=%p\n", hr, mD2D1Factory); if (SUCCEEDED(hr)) { hr = DWriteCreateFactory( DWRITE_FACTORY_TYPE_SHARED, __uuidof(IDWriteFactory), reinterpret_cast<IUnknown**>(&mDWriteFactory)); _RPT2(_CRT_WARN, "DWriteCreateFactory: hr=%p p=%p\n", hr, mDWriteFactory); } #ifdef FEAT_DIRECTX_COLOR_EMOJI if (SUCCEEDED(hr)) { DWriteCreateFactory( DWRITE_FACTORY_TYPE_SHARED, __uuidof(IDWriteFactory2), reinterpret_cast<IUnknown**>(&mDWriteFactory2)); _RPT1(_CRT_WARN, "IDWriteFactory2: %s\n", SUCCEEDED(hr) ? "available" : "not available"); } #endif if (SUCCEEDED(hr)) { hr = mDWriteFactory->GetGdiInterop(&mGdiInterop); _RPT2(_CRT_WARN, "GetGdiInterop: hr=%p p=%p\n", hr, mGdiInterop); } if (SUCCEEDED(hr)) { hr = mDWriteFactory->CreateRenderingParams(&mRenderingParams); _RPT2(_CRT_WARN, "CreateRenderingParams: hr=%p p=%p\n", hr, mRenderingParams); } } DWriteContext::~DWriteContext() { SafeRelease(&mTextFormat); SafeRelease(&mRenderingParams); SafeRelease(&mGdiInterop); SafeRelease(&mDWriteFactory); #ifdef FEAT_DIRECTX_COLOR_EMOJI SafeRelease(&mDWriteFactory2); #endif SafeRelease(&mBitmap); SafeRelease(&mBrush); SafeRelease(&mGDIRT); SafeRelease(&mRT); SafeRelease(&mD2D1Factory); } HRESULT DWriteContext::CreateDeviceResources() { HRESULT hr; if (mRT != NULL) return S_OK; D2D1_RENDER_TARGET_PROPERTIES props = { D2D1_RENDER_TARGET_TYPE_DEFAULT, { DXGI_FORMAT_B8G8R8A8_UNORM, D2D1_ALPHA_MODE_IGNORE }, 0, 0, D2D1_RENDER_TARGET_USAGE_GDI_COMPATIBLE, D2D1_FEATURE_LEVEL_DEFAULT }; hr = mD2D1Factory->CreateDCRenderTarget(&props, &mRT); _RPT2(_CRT_WARN, "CreateDCRenderTarget: hr=%p p=%p\n", hr, mRT); if (SUCCEEDED(hr)) { // This always succeeds. mRT->QueryInterface( __uuidof(ID2D1GdiInteropRenderTarget), reinterpret_cast<void**>(&mGDIRT)); _RPT1(_CRT_WARN, "GdiInteropRenderTarget: p=%p\n", mGDIRT); } if (SUCCEEDED(hr)) { hr = mRT->CreateSolidColorBrush( D2D1::ColorF(D2D1::ColorF::Black), &mBrush); _RPT2(_CRT_WARN, "CreateSolidColorBrush: hr=%p p=%p\n", hr, mBrush); } if (SUCCEEDED(hr)) Rebind(); return hr; } void DWriteContext::DiscardDeviceResources() { SafeRelease(&mBitmap); SafeRelease(&mBrush); SafeRelease(&mGDIRT); SafeRelease(&mRT); } HRESULT DWriteContext::CreateTextFormatFromLOGFONT(const LOGFONTW &logFont, IDWriteTextFormat **ppTextFormat) { // Most of this function is copied from: https://github.com/Microsoft/Windows-classic-samples/blob/master/Samples/Win7Samples/multimedia/DirectWrite/RenderTest/TextHelpers.cpp HRESULT hr = S_OK; IDWriteTextFormat *pTextFormat = NULL; IDWriteFont *font = NULL; IDWriteFontFamily *fontFamily = NULL; IDWriteLocalizedStrings *localizedFamilyNames = NULL; float fontSize = 0; if (SUCCEEDED(hr)) { hr = mGdiInterop->CreateFontFromLOGFONT(&logFont, &font); } // Get the font family to which this font belongs. if (SUCCEEDED(hr)) { hr = font->GetFontFamily(&fontFamily); } // Get the family names. This returns an object that encapsulates one or // more names with the same meaning but in different languages. if (SUCCEEDED(hr)) { hr = fontFamily->GetFamilyNames(&localizedFamilyNames); } // Get the family name at index zero. If we were going to display the name // we'd want to try to find one that matched the use locale, but for // purposes of creating a text format object any language will do. wchar_t familyName[100]; if (SUCCEEDED(hr)) { hr = localizedFamilyNames->GetString(0, familyName, ARRAYSIZE(familyName)); } if (SUCCEEDED(hr)) { // Use lfHeight of the LOGFONT as font size. fontSize = float(logFont.lfHeight); if (fontSize < 0) { // Negative lfHeight represents the size of the em unit. fontSize = -fontSize; } else { // Positive lfHeight represents the cell height (ascent + // descent). DWRITE_FONT_METRICS fontMetrics; font->GetMetrics(&fontMetrics); // Convert the cell height (ascent + descent) from design units // to ems. float cellHeight = static_cast<float>( fontMetrics.ascent + fontMetrics.descent) / fontMetrics.designUnitsPerEm; // Divide the font size by the cell height to get the font em // size. fontSize /= cellHeight; } } // The text format includes a locale name. Ideally, this would be the // language of the text, which may or may not be the same as the primary // language of the user. However, for our purposes the user locale will do. wchar_t localeName[LOCALE_NAME_MAX_LENGTH]; if (SUCCEEDED(hr)) { if (GetUserDefaultLocaleName(localeName, LOCALE_NAME_MAX_LENGTH) == 0) hr = HRESULT_FROM_WIN32(GetLastError()); } if (SUCCEEDED(hr)) { // Create the text format object. hr = mDWriteFactory->CreateTextFormat( familyName, NULL, // no custom font collection font->GetWeight(), font->GetStyle(), font->GetStretch(), fontSize, localeName, &pTextFormat); } if (SUCCEEDED(hr)) hr = pTextFormat->SetTextAlignment(DWRITE_TEXT_ALIGNMENT_LEADING); if (SUCCEEDED(hr)) hr = pTextFormat->SetParagraphAlignment( DWRITE_PARAGRAPH_ALIGNMENT_FAR); if (SUCCEEDED(hr)) hr = pTextFormat->SetWordWrapping(DWRITE_WORD_WRAPPING_NO_WRAP); SafeRelease(&localizedFamilyNames); SafeRelease(&fontFamily); SafeRelease(&font); if (SUCCEEDED(hr)) *ppTextFormat = pTextFormat; else SafeRelease(&pTextFormat); return hr; } HRESULT DWriteContext::SetFontByLOGFONT(const LOGFONTW &logFont) { HRESULT hr = S_OK; IDWriteTextFormat *pTextFormat = NULL; hr = CreateTextFormatFromLOGFONT(logFont, &pTextFormat); if (SUCCEEDED(hr)) { SafeRelease(&mTextFormat); mTextFormat = pTextFormat; mFontWeight = static_cast<DWRITE_FONT_WEIGHT>(logFont.lfWeight); mFontStyle = logFont.lfItalic ? DWRITE_FONT_STYLE_ITALIC : DWRITE_FONT_STYLE_NORMAL; } return hr; } void DWriteContext::SetFont(HFONT hFont) { FontCache::Item item; if (mFontCache.get(hFont, item)) { if (item.pTextFormat != NULL) { item.pTextFormat->AddRef(); SafeRelease(&mTextFormat); mTextFormat = item.pTextFormat; mFontWeight = item.fontWeight; mFontStyle = item.fontStyle; mFallbackDC = false; } else mFallbackDC = true; return; } HRESULT hr = E_FAIL; LOGFONTW lf; if (GetObjectW(hFont, sizeof(lf), &lf)) hr = SetFontByLOGFONT(lf); item.hFont = hFont; if (SUCCEEDED(hr)) { item.pTextFormat = mTextFormat; item.fontWeight = mFontWeight; item.fontStyle = mFontStyle; mFallbackDC = false; } else mFallbackDC = true; mFontCache.put(item); } void DWriteContext::Rebind() { SafeRelease(&mBitmap); mRT->BindDC(mHDC, &mBindRect); mRT->SetTransform(D2D1::IdentityMatrix()); D2D1_BITMAP_PROPERTIES props = { {DXGI_FORMAT_B8G8R8A8_UNORM, D2D1_ALPHA_MODE_IGNORE}, 96.0f, 96.0f }; mRT->CreateBitmap( D2D1::SizeU(mBindRect.right - mBindRect.left, mBindRect.bottom - mBindRect.top), props, &mBitmap); } void DWriteContext::BindDC(HDC hdc, const RECT *rect) { mHDC = hdc; mBindRect = *rect; if (mRT == NULL) CreateDeviceResources(); else { Flush(); Rebind(); } } extern "C" void redraw_later_clear(void); HRESULT DWriteContext::SetDrawingMode(DrawingMode mode) { HRESULT hr = S_OK; switch (mode) { default: case DM_GDI: if (mInteropHDC != NULL) { mGDIRT->ReleaseDC(NULL); mInteropHDC = NULL; } if (mDrawing) { hr = mRT->EndDraw(); if (hr == (HRESULT)D2DERR_RECREATE_TARGET) { hr = S_OK; DiscardDeviceResources(); CreateDeviceResources(); redraw_later_clear(); } mDrawing = false; } break; case DM_DIRECTX: if (mInteropHDC != NULL) { mGDIRT->ReleaseDC(NULL); mInteropHDC = NULL; } else if (mDrawing == false) { CreateDeviceResources(); mRT->BeginDraw(); mDrawing = true; } break; case DM_INTEROP: if (mDrawing == false) { CreateDeviceResources(); mRT->BeginDraw(); mDrawing = true; } if (mInteropHDC == NULL) hr = mGDIRT->GetDC(D2D1_DC_INITIALIZE_MODE_COPY, &mInteropHDC); break; } mDMode = mode; return hr; } ID2D1Brush* DWriteContext::SolidBrush(COLORREF color) { mBrush->SetColor(D2D1::ColorF(UINT32(GetRValue(color)) << 16 | UINT32(GetGValue(color)) << 8 | UINT32(GetBValue(color)))); return mBrush; } void DWriteContext::DrawText(const WCHAR *text, int len, int x, int y, int w, int h, int cellWidth, COLORREF color, UINT fuOptions, const RECT *lprc, const INT *lpDx) { if (mFallbackDC) { // Fall back to GDI rendering. HRESULT hr = SetDrawingMode(DM_INTEROP); if (SUCCEEDED(hr)) { HGDIOBJ hFont = ::GetCurrentObject(mHDC, OBJ_FONT); HGDIOBJ hOldFont = ::SelectObject(mInteropHDC, hFont); ::SetTextColor(mInteropHDC, color); ::SetBkMode(mInteropHDC, ::GetBkMode(mHDC)); ::ExtTextOutW(mInteropHDC, x, y, fuOptions, lprc, text, len, lpDx); ::SelectObject(mInteropHDC, hOldFont); } return; } HRESULT hr; IDWriteTextLayout *textLayout = NULL; SetDrawingMode(DM_DIRECTX); hr = mDWriteFactory->CreateTextLayout(text, len, mTextFormat, FLOAT(w), FLOAT(h), &textLayout); if (SUCCEEDED(hr)) { DWRITE_TEXT_RANGE textRange = { 0, UINT32(len) }; textLayout->SetFontWeight(mFontWeight, textRange); textLayout->SetFontStyle(mFontStyle, textRange); TextRenderer renderer(this); TextRendererContext context = { color, FLOAT(cellWidth), 0.0f }; textLayout->Draw(&context, &renderer, FLOAT(x), FLOAT(y)); } SafeRelease(&textLayout); } void DWriteContext::FillRect(const RECT *rc, COLORREF color) { if (mDMode == DM_INTEROP) { // GDI functions are used before this call. Keep using GDI. // (Switching to Direct2D causes terrible slowdown.) HBRUSH hbr = ::CreateSolidBrush(color); ::FillRect(mInteropHDC, rc, hbr); ::DeleteObject(HGDIOBJ(hbr)); } else { SetDrawingMode(DM_DIRECTX); mRT->FillRectangle( D2D1::RectF(FLOAT(rc->left), FLOAT(rc->top), FLOAT(rc->right), FLOAT(rc->bottom)), SolidBrush(color)); } } void DWriteContext::DrawLine(int x1, int y1, int x2, int y2, COLORREF color) { if (mDMode == DM_INTEROP) { // GDI functions are used before this call. Keep using GDI. // (Switching to Direct2D causes terrible slowdown.) HPEN hpen = ::CreatePen(PS_SOLID, 1, color); HGDIOBJ old_pen = ::SelectObject(mInteropHDC, HGDIOBJ(hpen)); ::MoveToEx(mInteropHDC, x1, y1, NULL); ::LineTo(mInteropHDC, x2, y2); ::SelectObject(mInteropHDC, old_pen); ::DeleteObject(HGDIOBJ(hpen)); } else { SetDrawingMode(DM_DIRECTX); mRT->DrawLine( D2D1::Point2F(FLOAT(x1), FLOAT(y1) + 0.5f), D2D1::Point2F(FLOAT(x2), FLOAT(y2) + 0.5f), SolidBrush(color)); } } void DWriteContext::SetPixel(int x, int y, COLORREF color) { if (mDMode == DM_INTEROP) { // GDI functions are used before this call. Keep using GDI. // (Switching to Direct2D causes terrible slowdown.) ::SetPixel(mInteropHDC, x, y, color); } else { SetDrawingMode(DM_DIRECTX); // Direct2D doesn't have SetPixel API. Use DrawLine instead. mRT->DrawLine( D2D1::Point2F(FLOAT(x), FLOAT(y) + 0.5f), D2D1::Point2F(FLOAT(x+1), FLOAT(y) + 0.5f), SolidBrush(color)); } } void DWriteContext::Scroll(int x, int y, const RECT *rc) { SetDrawingMode(DM_DIRECTX); mRT->Flush(); D2D1_RECT_U srcRect; D2D1_POINT_2U destPoint; if (x >= 0) { srcRect.left = rc->left; srcRect.right = rc->right - x; destPoint.x = rc->left + x; } else { srcRect.left = rc->left - x; srcRect.right = rc->right; destPoint.x = rc->left; } if (y >= 0) { srcRect.top = rc->top; srcRect.bottom = rc->bottom - y; destPoint.y = rc->top + y; } else { srcRect.top = rc->top - y; srcRect.bottom = rc->bottom; destPoint.y = rc->top; } mBitmap->CopyFromRenderTarget(&destPoint, mRT, &srcRect); D2D1_RECT_F destRect = { FLOAT(destPoint.x), FLOAT(destPoint.y), FLOAT(destPoint.x + srcRect.right - srcRect.left), FLOAT(destPoint.y + srcRect.bottom - srcRect.top) }; mRT->DrawBitmap(mBitmap, destRect, 1.0F, D2D1_BITMAP_INTERPOLATION_MODE_NEAREST_NEIGHBOR, destRect); } void DWriteContext::Flush() { SetDrawingMode(DM_GDI); } void DWriteContext::SetRenderingParams( const DWriteRenderingParams *params) { if (mDWriteFactory == NULL) return; IDWriteRenderingParams *renderingParams = NULL; D2D1_TEXT_ANTIALIAS_MODE textAntialiasMode = D2D1_TEXT_ANTIALIAS_MODE_DEFAULT; HRESULT hr; if (params != NULL) { hr = mDWriteFactory->CreateCustomRenderingParams(params->gamma, params->enhancedContrast, params->clearTypeLevel, ToPixelGeometry(params->pixelGeometry), ToRenderingMode(params->renderingMode), &renderingParams); textAntialiasMode = ToTextAntialiasMode(params->textAntialiasMode); } else hr = mDWriteFactory->CreateRenderingParams(&renderingParams); if (SUCCEEDED(hr) && renderingParams != NULL) { SafeRelease(&mRenderingParams); mRenderingParams = renderingParams; mTextAntialiasMode = textAntialiasMode; Flush(); mRT->SetTextRenderingParams(mRenderingParams); mRT->SetTextAntialiasMode(mTextAntialiasMode); } } DWriteRenderingParams * DWriteContext::GetRenderingParams( DWriteRenderingParams *params) { if (params != NULL && mRenderingParams != NULL) { params->gamma = mRenderingParams->GetGamma(); params->enhancedContrast = mRenderingParams->GetEnhancedContrast(); params->clearTypeLevel = mRenderingParams->GetClearTypeLevel(); params->pixelGeometry = ToInt(mRenderingParams->GetPixelGeometry()); params->renderingMode = ToInt(mRenderingParams->GetRenderingMode()); params->textAntialiasMode = mTextAntialiasMode; } return params; } //////////////////////////////////////////////////////////////////////////// // PUBLIC C INTERFACES void DWrite_Init(void) { #ifdef DYNAMIC_DIRECTX // Load libraries. hD2D1DLL = vimLoadLib("d2d1.dll"); hDWriteDLL = vimLoadLib("dwrite.dll"); if (hD2D1DLL == NULL || hDWriteDLL == NULL) { DWrite_Final(); return; } // Get address of procedures. pGetUserDefaultLocaleName = (PGETUSERDEFAULTLOCALENAME)GetProcAddress( GetModuleHandle("kernel32.dll"), "GetUserDefaultLocaleName"); pD2D1CreateFactory = (PD2D1CREATEFACTORY)GetProcAddress(hD2D1DLL, "D2D1CreateFactory"); pDWriteCreateFactory = (PDWRITECREATEFACTORY)GetProcAddress(hDWriteDLL, "DWriteCreateFactory"); #endif } void DWrite_Final(void) { #ifdef DYNAMIC_DIRECTX pGetUserDefaultLocaleName = NULL; pD2D1CreateFactory = NULL; pDWriteCreateFactory = NULL; unload(hDWriteDLL); unload(hD2D1DLL); #endif } DWriteContext * DWriteContext_Open(void) { #ifdef DYNAMIC_DIRECTX if (pGetUserDefaultLocaleName == NULL || pD2D1CreateFactory == NULL || pDWriteCreateFactory == NULL) return NULL; #endif return new DWriteContext(); } void DWriteContext_BindDC(DWriteContext *ctx, HDC hdc, const RECT *rect) { if (ctx != NULL) ctx->BindDC(hdc, rect); } void DWriteContext_SetFont(DWriteContext *ctx, HFONT hFont) { if (ctx != NULL) ctx->SetFont(hFont); } void DWriteContext_DrawText( DWriteContext *ctx, const WCHAR *text, int len, int x, int y, int w, int h, int cellWidth, COLORREF color, UINT fuOptions, const RECT *lprc, const INT *lpDx) { if (ctx != NULL) ctx->DrawText(text, len, x, y, w, h, cellWidth, color, fuOptions, lprc, lpDx); } void DWriteContext_FillRect(DWriteContext *ctx, const RECT *rc, COLORREF color) { if (ctx != NULL) ctx->FillRect(rc, color); } void DWriteContext_DrawLine(DWriteContext *ctx, int x1, int y1, int x2, int y2, COLORREF color) { if (ctx != NULL) ctx->DrawLine(x1, y1, x2, y2, color); } void DWriteContext_SetPixel(DWriteContext *ctx, int x, int y, COLORREF color) { if (ctx != NULL) ctx->SetPixel(x, y, color); } void DWriteContext_Scroll(DWriteContext *ctx, int x, int y, const RECT *rc) { if (ctx != NULL) ctx->Scroll(x, y, rc); } void DWriteContext_Flush(DWriteContext *ctx) { if (ctx != NULL) ctx->Flush(); } void DWriteContext_Close(DWriteContext *ctx) { delete ctx; } void DWriteContext_SetRenderingParams( DWriteContext *ctx, const DWriteRenderingParams *params) { if (ctx != NULL) ctx->SetRenderingParams(params); } DWriteRenderingParams * DWriteContext_GetRenderingParams( DWriteContext *ctx, DWriteRenderingParams *params) { if (ctx != NULL) return ctx->GetRenderingParams(params); else return NULL; }