Make header_only_library() function
#262
Merged
Conversation
This file contains 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
Au is overwhelmingly built from header-only libraries. We can make this a lot easier to maintain with a CMake function, `header_only_library()`, that presents an Au-centric interface. Specifically, the function will automatically: - Make the target an `INTERFACE` - Set `FILE_SET HEADERS` - Set `BASE_DIRS` to the base Au directory Users must provide the `HEADERS` option, and we will use those to set the `FILES` option. Users can optionall provide the `DEPS` option, and we'll use it if present to populate a `target_link_libraries` call. We also add an optional `GTEST_SRCS` argument. If this is provided, then we will automatically create a `_test`-suffixed target, link to the library and to `gtest_main`, and run `gtest_discover_tests()`. If the test has any dependencies apart from the tested target, and GTest, they can be supplied via an optional `GTEST_EXTRA_DEPS` argument. Finally, we provide the option to mark a library as `INTERNAL_ONLY`. For now, we borrow the `EXPORT_NAME` manipulation from the original CMake branch, but we could choose to do other things later --- the important part is marking the intent that the library is internal-only.
chiphogg
added
the
release notes: ⚙️ repo
geoffviola
approved these changes
Jul 10, 2024
There was a problem hiding this comment.
Changes make sense. Test still passes.
docker run --rm \
ubuntu@sha256:2e863c44b718727c860746568e1d54afd13b2fa71b160f5cd9058fc436217b30 \
/bin/bash -c \
'apt update && apt install -y clang cmake git && git clone -b chiphogg/cmake-header-only-library#215 https://github.com/aurora-opensource/au.git && cd au && cmake -S . -B cmake/build -DCMAKE_VERIFY_INTERFACE_HEADER_SETS=TRUE && cmake --build cmake/build --target all all_verify_interface_header_sets test'| ${ARG_NAME} | ||
| ${ARG_GTEST_EXTRA_DEPS} | ||
| GTest::gtest_main | ||
| GTest::gmock_main |
There was a problem hiding this comment.
Both main targets would have two main functions. You should only need GTest::gmock_main.
gmock_main has main and depends on gmock. gmock depends on gtest.
There was a problem hiding this comment.
Nice catch! Now I'm a little curious why it actually worked before (or at least, appeared to), with two main functions.
`gmock_main` already provides it.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
Au is overwhelmingly built from header-only libraries. We can make this
a lot easier to maintain with a CMake function,
header_only_library(),that presents an Au-centric interface. Specifically, the function will
automatically:
INTERFACEFILE_SET HEADERSBASE_DIRSto the base Au directoryUsers must provide the
HEADERSoption, and we will use those to setthe
FILESoption. Users can optionall provide theDEPSoption, andwe'll use it if present to populate a
target_link_librariescall.We also add an optional
GTEST_SRCSargument. If this is provided,then we will automatically create a
_test-suffixed target, link to thelibrary and to
gtest_main, and rungtest_discover_tests(). If thetest has any dependencies apart from the tested target, and GTest, they
can be supplied via an optional
GTEST_EXTRA_DEPSargument.Finally, we provide the option to mark a library as
INTERNAL_ONLY. Fornow, we borrow the
EXPORT_NAMEmanipulation from the original CMakebranch, but we could choose to do other things later --- the important
part is marking the intent that the library is internal-only.
Helps #215.