ENH: Embed UTF-8 active-code-page manifest in Windows test executables (supersedes #4390)#6231
Merged
hjmjohnson merged 1 commit intoMay 7, 2026
Conversation
2 tasks
github-actions
Bot
added
type:Infrastructure
dzenanz
reviewed
May 7, 2026
hjmjohnson
force-pushed
the
windows-utf8-active-codepage
branch
from
e685000 to
32bce76
Compare
This comment was marked as resolved.
This comment was marked as resolved.
![greptile-apps[bot]](https://avatars.githubusercontent.com/in/867647?s=60&v=4){kind=small}
…ables Mirrors the elastix recipe (SuperElastix/elastix#1401, by Bernhard Fröhler) so ITK test executables on Windows treat narrow-char Win32 APIs (CreateFileA, fopen, std::ifstream(const char *), ...) as UTF-8 on Windows 10 1903 and later. Closes the on-Windows portion of issue InsightSoftwareConsortium#4388 (non-ASCII / umlaut paths fail in image readers under non-UTF-8 active code pages). This is the executable-layer fix only. SimpleITK / Python wrappers (python.exe is shipped by upstream Python and cannot have an ITK manifest attached) still need the ImageIOBase / PNG / JPEG library- side conversion to wide paths via the existing-but-unused itkInternationalizationIOHelpers; that follow-up is captured for a later PR. What's added ------------ - CMake/Windows-utf8-codepage.manifest — 8-line XML declaring <activeCodePage>UTF-8</activeCodePage>. - CMake/ITKWindowsUtf8.cmake — itk_target_attach_windows_utf8_manifest() function (no-op outside MSVC). - Auto-attach from CreateTestDriver, CreateGoogleTestDriver, and the standalone itkTestDriver. Examples or downstream module CMakeLists can call the helper explicitly for their own executables. - SetConsoleOutputCP(CP_UTF8) at test driver entry so stdout / stderr also render UTF-8 byte sequences correctly on the console (cosmetic; the manifest is what makes file-IO work). - itkUtf8FilenameGTest.cxx — round-trip a small file at a path containing non-ASCII (UTF-8) characters to lock in the behavior. Supersedes InsightSoftwareConsortium#4390 (Pfleiderer-Adrian) — that PR proposed rejecting non-ASCII filenames in the Python wrapper, which the reviewers (N-Dekker, blowekamp, dzenanz) preferred to address by enabling UTF-8 properly rather than tightening the contract. Co-Authored-By: Adrian Pfleiderer <42115394+Pfleiderer-Adrian@users.noreply.github.com>
hjmjohnson
force-pushed
the
windows-utf8-active-codepage
branch
from
32bce76 to
4eca583
Compare
dzenanz
approved these changes
May 7, 2026
hjmjohnson
added a commit
to hjmjohnson/ITK
that referenced
this pull request
May 12, 2026
…dows-utf8-active-codepage ENH: Embed UTF-8 active-code-page manifest in Windows test executables (supersedes InsightSoftwareConsortium#4390)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Embed a UTF-8 active-code-page manifest into ITK's Windows test executables so non-ASCII (umlaut, CJK, emoji) filenames work without changes to the C++ filename API. Mirrors SuperElastix/elastix#1401 by @codeling. Closes the on-Windows portion of #4388.
Supersedes #4390 (@Pfleiderer-Adrian) — that PR proposed rejecting non-ASCII filenames in the Python wrapper. Reviewers (@N-Dekker, @blowekamp, @dzenanz) preferred enabling UTF-8 properly rather than tightening the contract. @Pfleiderer-Adrian credited via
Co-Authored-By:.What this changes
CMake/Windows-utf8-codepage.manifest— 8-line XML declaring<activeCodePage>UTF-8</activeCodePage>.CMake/ITKWindowsUtf8.cmake—itk_target_attach_windows_utf8_manifest(<target>)helper (no-op outside MSVC).CreateTestDriver,CreateGoogleTestDriver, and the standaloneitkTestDriverbuild site. Examples / downstream module CMakeLists can call the helper explicitly for their own executables.SetConsoleOutputCP(CP_UTF8)at test-driver entry so stdout/stderr render UTF-8 byte sequences correctly on the console (cosmetic; the manifest is what makes file-IO work).itkUtf8FilenameGTest.cxx— round-trip a small file at a path containing UTF-8 characters (speci+U+00E4+l-fil+U+1F44D+.txt) to lock in the behavior.What this does NOT change (Tier B follow-up)
This PR is the executable-layer fix only. SimpleITK / Python wrappers cannot benefit because
python.exeis shipped by upstream Python and ITK cannot attach a manifest to it. To make non-ASCII filenames work for Python consumers on Windows, ITK must wireitk::i18n_open/i18n_fopen(already present atModules/IO/ImageBase/include/itkInternationalizationIOHelpers.h, gated byITK_SUPPORTS_WCHAR_T_FILENAME_CSTYLEIO, but unused outside its own unit test) throughitkImageIOBase.cxx+itkPNGImageIO.cxx+itkJPEGImageIO.cxx.That follow-up is captured locally as a deferred task and will be a separate PR co-authored with @Pfleiderer-Adrian.
Local validation
ninja ITKTestKernelGTestDriver itkTestDriver— clean build../bin/ITKTestKernelGTestDriver --gtest_filter='WindowsUtf8Codepage.*'—[ PASSED ] 1 teston Linux (validates byte-transparent round-trip; Windows behavior is the CI gate).pre-commit run --all-files— clean.Closes #4388 (Windows portion).