Skip to content

Conversation

@holke
Copy link
Collaborator

@holke holke commented Dec 1, 2025

Describe your changes here:

Closes #2008

External libraries were not able to see if t8code is linked against VTK and if so against which version of it.

CMake now builds a header file containing the macros:

/** Macro that is 1 if we link against VTK on 0 if we don't. */
#define T8_ENABLE_VTK 1
/** VTK major version number - Only defined if T8_ENABLE_VTK is 1 */
#define T8_VTK_MAJOR_VERSION 9
/** VTK minor version number - Only defined if T8_ENABLE_VTK is 1 */
#define T8_VTK_MINOR_VERSION 1

This header file is also installed and available to thirdparty libs.

I also modified the vtk linkage test to incorporate these macros.

All these boxes must be checked by the AUTHOR before requesting review:

  • The PR is small enough to be reviewed easily. If not, consider splitting up the changes in multiple PRs.
  • The title starts with one of the following prefixes: Documentation:, Bugfix:, Feature:, Improvement: or Other:.
  • If the PR is related to an issue, make sure to link it.
  • The author made sure that, as a reviewer, he/she would check all boxes below.

All these boxes must be checked by the REVIEWERS before merging the pull request:

As a reviewer please read through all the code lines and make sure that the code is fully understood, bug free, well-documented and well-structured.

General

  • The reviewer executed the new code features at least once and checked the results manually.
  • The code follows the t8code coding guidelines.
  • New source/header files are properly added to the CMake files.
  • The code is well documented. In particular, all function declarations, structs/classes and their members have a proper doxygen documentation.
  • All new algorithms and data structures are sufficiently optimal in terms of memory and runtime (If this should be merged, but there is still potential for optimization, create a new issue).

Tests

  • The code is covered in an existing or new test case using Google Test.
  • The code coverage of the project (reported in the CI) should not decrease. If coverage is decreased, make sure that this is reasonable and acceptable.
  • Valgrind doesn't find any bugs in the new code. This script can be used to check for errors; see also this wiki article.

If the Pull request introduces code that is not covered by the github action (for example coupling with a new library):

  • Should this use case be added to the github action?
  • If not, does the specific use case compile and all tests pass (check manually).

Scripts and Wiki

  • If a new directory with source files is added, it must be covered by the script/find_all_source_files.scp to check the indentation of these files.
  • If this PR introduces a new feature, it must be covered in an example or tutorial and a Wiki article.

License

  • The author added a BSD statement to doc/ (or already has one).

@codecov
Copy link

codecov bot commented Dec 1, 2025

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 76.60%. Comparing base (9cf1f44) to head (7898be7).
⚠️ Report is 142 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #2010   +/-   ##
=======================================
  Coverage   76.60%   76.60%           
=======================================
  Files         109      109           
  Lines       18721    18721           
=======================================
  Hits        14341    14341           
  Misses       4380     4380           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@Davknapp
Copy link
Collaborator

Davknapp commented Dec 1, 2025

Have you tried to export the targets using

install(EXPORT targets 
FILE
....
DESTINATION
)

https://cmake.org/cmake/help/latest/command/install.html#export
?

I think this is the way we should actually go here (if it works).

@Davknapp Davknapp assigned Davknapp and holke and unassigned Davknapp Dec 1, 2025
@holke
Copy link
Collaborator Author

holke commented Dec 1, 2025

Have you tried to export the targets using

install(EXPORT targets 
FILE
....
DESTINATION
)

https://cmake.org/cmake/help/latest/command/install.html#export ?

I think this is the way we should actually go here (if it works).

As i understand EXPORT is for build files from the CMaker syste and this would create a .cmake file " By default the generated file will be called .cmake"?

We want the generated header to be copied over to the projects include instead.

Or do i miss something?

@holke holke assigned Davknapp and unassigned holke Dec 1, 2025
@Davknapp
Copy link
Collaborator

Davknapp commented Dec 1, 2025

You can find an alternative approach in #2012

@Davknapp Davknapp assigned holke and unassigned Davknapp Dec 2, 2025
@Davknapp Davknapp closed this Dec 15, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Feature: VTK lib header file with linkage macros.

3 participants