Qt header discovery & framework support; vendor simplecpp update by jcfr · Pull Request #302 · MeVisLab/pythonqt

jcfr · 2025-09-18T14:56:51Z

This PR modernizes how the generator discovers Qt headers/frameworks and vendors a newer simplecpp with framework-aware search logic. Together these changes make builds robust on macOS (Qt frameworks) and cleaner across all platforms.

Vendor `simplecpp` update

Bumps generator/simplecpp/{simplecpp.h, simplecpp.cpp} to patched-2025-08-30-37fa4f49b (upstream: commontk/simplecpp@bfc53ad; previously cppcheck-opensource/simplecpp@37fa4f4).
Re-applies local patch: generator/simplecpp/do_not_stop_on_error.patch.
Introduces a typed, ordered search path API:
- DUI::PathKind { Include, SystemInclude, Framework, SystemFramework }
- DUI::searchPaths plus helpers addIncludePath, addSystemIncludePath, addFrameworkPath, addSystemFrameworkPath
- Back-compat: if searchPaths is empty, legacy includePaths is mirrored as Include.
Adds Apple framework resolution for #include <Pkg/Hdr.h> → <Pkg.framework/Headers/Hdr.h> (and PrivateHeaders fallback).
Interleaves -I and -F in the original CLI order; handles -isystem and -iframework.

Upstream compare:commontk/simplecpp@37fa4f4...bfc53ad

Note

This changes are vendored from the commontk/simplecpp fork including commit backported from:

feat: Ordered search paths for -I, -isystem, -F, -iframework + Darwin framework support (with legacy -I back-compat) cppcheck-opensource/simplecpp#511

Generator: discover Qt headers via `QLibraryInfo`

Prefers QLibraryInfo::HeadersPath; falls back to $QTDIR/include if needed.
Accepts include roots from:
- PYTHONQT_INCLUDE (path list; validated)
- --include-paths (validated)
Probes and appends existing module subdirs under the Qt include root: QtCore, QtGui, QtNetwork, QtOpenGL, QtXml.
Starts using DUI::addIncludePath(...) instead of pushing to the legacy includePaths.
Removes hardcoded macOS /Library/Frameworks/.../Headers assumptions (to defer to new framework discovery).

Generator: discover Qt framework paths dynamically (macOS)

New getFrameworkDirectories(...) collects framework/library search roots from:
- . (cwd)
- PYTHONQT_FRAMEWORK (validated)
- --framework-paths (validated)
- ${QTDIR}/lib/<Module>.framework when present, plus ${QTDIR}/lib
- QLibraryInfo::LibrariesPath when available
Passes these paths to the preprocessor using DUI::addFrameworkPath(...).

Generator: detect Qt version from frameworks on macOS

getQtVersion(...) now accepts either header include directories or framework roots.
On macOS, probes Versions/A/Headers/qtcoreversion.h when given a framework root (e.g., .../QtCore.framework).
Tries include paths first, then framework paths; aborts early with a clear error message if neither yields a version.

This pull request supersedes the following ones:

This pull request fixes the following issues:

FixesQt6 on macos: missing generated_cpp #276

jcfr · 2025-09-18T15:00:27Z

@jamesobutler Now this has been proposed upstream, we will be able to contribute CMakeLists.txt changes including Qt6 support, along with finalizing CTK & Slicer Qt updates 🚀

jcfr · 2025-09-18T22:21:41Z

@mrbean-bremen Thanks for the review 🙏 I will revisit and update shortly 🚀

…a4f49b (bfc53ad); was master (37fa4f4) Upstream: commontk/simplecpp@bfc53ad Source date: 2025-08-30 Files: generator/simplecpp/simplecpp.h, generator/simplecpp/simplecpp.cpp Patch: generator/simplecpp/do_not_stop_on_error.patch re-applied Compare: commontk/simplecpp@37fa4f4...bfc53ad

- Prefer `QLibraryInfo::{HeadersPath}` to locate Qt headers; fall back to `$QTDIR/include` when `QLibraryInfo` is unavailable or invalid. - Accept include roots from `PYTHONQT_INCLUDE` and `--include-paths`; warn and skip non-existent paths; normalize with `QDir::cleanPath`. - Probe module subdirs under the Qt include root and append those that exist (QtCore, QtGui, QtNetwork, QtOpenGL, QtXml). - Use `DUI::addIncludePath(...)` instead of pushing to `includePaths`. - Minor cleanups: Use QStringLiteral, add helpers for path joining/dir checks. Remove hardcoded macOS `/Library/Frameworks` header paths from the QTDIR-missing branch anticipating the addition of `getFrameworkDirectories` function.

… PYTHONQT_FRAMEWORK Add `getFrameworkDirectories` to collect framework/library search roots from: - `.` (cwd), - `PYTHONQT_FRAMEWORK` (path-list, validated), - `--framework-paths` CLI arg (validated), - `${QTDIR}/lib/<Module>` when present, plus `${QTDIR}/lib`. Co-authored-by: Hans Johnson <hans-johnson@uiowa.edu>

- Extend Qt version discovery to accept framework roots (e.g., .../QtCore.framework) in addition to include dirs. - On macOS, also probe `Versions/A/Headers/qtcoreversion.h`. - Try include paths first, then framework paths; abort with a clear error if neither yields a version. Co-authored-by: Hans Johnson <hans-johnson@uiowa.edu>

…generated on macOS

This improves header file detection on macOS by introducing support for additional common paths where `qtcoreversion.h` might be located. This change enhances compatibility with different Qt installations.

jcfr · 2025-09-19T06:16:51Z

@mrbean-bremen This now ready for final review & integration 🙏 🚀

mrbean-bremen

Very nice - thank you!

usiems · 2025-09-22T15:09:57Z

+ // Prefer QLibraryInfo (works without QTDIR)
+ QString qtInclude = QLibraryInfo::location(QLibraryInfo::HeadersPath);
+ if (!isDir(qtInclude)) {
+ // Fallback to QTDIR/include
+ const QString qtDir = qEnvironmentVariable("QTDIR");


I dislike a little bit the fact that now we can't generate the bindings for a different Qt version than the version with which the generator was built. Sure, this is a little bit of a corner case, but I know that I have used this at some time during development.
Could we get another override mechanism for the Qt include directory?

Very sensible point. This is an oversight & I will revisit.

I dislike a little bit the fact that now we can't generate the bindings for a different Qt version than the version with which the generator was built. Sure, this is a little bit of a corner case, but I know that I have used this at some time during development.
For future reference, this has been addressed in #313

mrbean-bremen reviewed Sep 18, 2025
View reviewed changes

Comment threadgenerator/simplecpp/simplecpp.h
Comment threadgenerator/main.cpp
Comment threadgenerator/main.cpp

jcfr force-pushed the update-simplecpp-apple-framework-support branch from 4c7ea5a to 9a945d4Compare September 19, 2025 02:22

jcfr force-pushed the update-simplecpp-apple-framework-support branch from 9a945d4 to b330ba7Compare September 19, 2025 02:29

jcfrand others added 4 commits September 19, 2025 01:49

ci: Simplify generator call & re-enable check verifying wrappers are …
4d93e7a
…generated on macOS

fix(generator): Support additional qtcoreversion.h header paths
dd42ec8
This improves header file detection on macOS by introducing support for additional common paths where `qtcoreversion.h` might be located. This change enhances compatibility with different Qt installations.

jcfr force-pushed the update-simplecpp-apple-framework-support branch from 9689614 to dd42ec8Compare September 19, 2025 05:50

jcfr mentioned this pull request Sep 19, 2025
ENH: Improve Qt include path resolution macOS #271
Closed

mrbean-bremen approved these changes Sep 19, 2025
View reviewed changes

mrbean-bremen merged commit 57688f5 into MeVisLab:masterSep 19, 2025
19 checks passed

mrbean-bremen mentioned this pull request Sep 19, 2025
Fix warning about missing or non-existing QTDIR #299
Closed

jcfr deleted the update-simplecpp-apple-framework-support branch September 19, 2025 07:09

usiems reviewed Sep 22, 2025
View reviewed changes

This was referenced Sep 29, 2025
Update Slicer to use Qt6 Slicer/Slicer#6388
Open
Build & generator cleanup: drop Qt5 wrapper fallbacks, switch CI to Qt 6.10, normalize macOS includes, add qmake toggles, and regenerate wrappers in CI #313
Merged

jcfr mentioned this pull request Oct 23, 2025
ENH: Prepare for qt6 commontk/PythonQt#93
Closed

jcfr mentioned this pull request Nov 9, 2025
Add support for Qt 6 alongside Qt 5 commontk/CTK#1309
Merged

Navigation Menu

Uh oh!

Qt header discovery & framework support; vendor simplecpp update - #302

Qt header discovery & framework support; vendor simplecpp update#302
mrbean-bremen merged 6 commits into
MeVisLab:masterfrom
jcfr:update-simplecpp-apple-framework-support

jcfr commented Sep 18, 2025•
edited
Loading

Uh oh!

jcfr commented Sep 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jcfr commented Sep 18, 2025

Uh oh!

jcfr commented Sep 19, 2025

Uh oh!

mrbean-bremen left a comment

Uh oh!

Uh oh!

usiemsSep 22, 2025

Uh oh!

jcfrSep 22, 2025

Uh oh!

jcfrSep 30, 2025

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Uh oh!

Conversation

jcfr commented Sep 18, 2025• edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Vendor simplecpp update

Generator: discover Qt headers via QLibraryInfo

Generator: discover Qt framework paths dynamically (macOS)

Generator: detect Qt version from frameworks on macOS

Uh oh!

jcfr commented Sep 18, 2025

Uh oh!

Uh oh!

Uh oh!

Uh oh!

jcfr commented Sep 18, 2025

Uh oh!

jcfr commented Sep 19, 2025

Uh oh!

mrbean-bremen left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

usiemsSep 22, 2025

Choose a reason for hiding this comment

Uh oh!

jcfrSep 22, 2025

Choose a reason for hiding this comment

Uh oh!

jcfrSep 30, 2025

Choose a reason for hiding this comment

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

jcfr commented Sep 18, 2025•
edited
Loading

Vendor `simplecpp` update

Generator: discover Qt headers via `QLibraryInfo`