Header restructuring #61
Open
Conversation
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
Purely cosmetic but brings this closer to the variant meson generates.
This matches what is done in CMake, bringing the .pc files closer together and given we have some quite generic header names that might clash with others, seems like a good idea in this case.
Co-Authored-By: Sebastian Ramacher <sramacher@debian.org>
Moves the library sources and headers all together in a subfolder in source, like it is already done with kiss_fft. This makes it clearer that especially the headers are not part of our public API.
This should be available on any recent distro and even if not, is only a build-time constraint so someone could build CMake from source if on some ancient system or use the CMake provided repositories. This is needed to use newer CMake features like target_sources file sets. See: https://cmake.org/cmake/help/latest/command/target_sources.html#file-sets
These headers are right now part of the public API/ABI, so this should be made clear by moving them to the include directory until that changes. They were already installed so this is not a public-facing change.
CMake: Use a file set on the target, not only properly makes CMake aware of the headers, it also sets the include directory properly and preserves the subfolder when installing the file set. Meson: Install headers with preserve_path to preserve subfolders. The includes in the header files were changed also to properly reference the other headers inside the correct subdirectories.
When building the library, do not add the subdirs to the include paths, this brings things closer to how the headers are actually used by library users as well.
|
Supersedes #11 |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
With this change the header layout is actually made use of by preserving it when installing the headers, so that there is no longer a difference between the file layout used when building the library and what users get in the end.
Also the canonical include path is now even with meson corrected to be
<spatialaudio/header>, given that spatialaudio headers names are somewhat generic at times and might even clash (kiss_fftfor example), requiring to specify thesubdir as "namespacing" for the headers seems like a better idea. Note that it has always been like this with the old
CMake build anyway.
As this uses CMake's file sets for target_sources, it means we have to require CMake 3.23 (released March 29, 2022).