Add IWYU export pragmas to protect internal headers #756
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
|
These pragmas are also respected by Include Cleaner from clangd. Recently, I've been evaluating Zed and got warnings about headers without installing or configuring anything. Apparently, the trend in code editors is to come with batteries included, and for C++ on Linux that's the clangd language server. |
|
It looks kind of ugly :-( . Does |
|
Yeah, sounds great, lemme change it real quick. |
Include What You Use tries to add the internal nanobind headers to files using nanobind.h. Tell it that it should rely on nanobind.h to export all of the internal symbols using the `export` pragma. https://github.com/include-what-you-use/include-what-you-use/blob/master/docs/IWYUPragmas.md#iwyu-pragma-export
|
Thanks! |
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.
We use Include What You Use to manage
#includes across a large codebase. IWYU automatically adds and removes#includestatements in each source file to match what symbols are being used in that file. By default it tries to directly include internal nanobind headers when it detects symbols from those files.This PR adds
exportpragmas to tell IWYU basically the same thing as the comment on line 38 tells humans: thatnanobind.hitself exports all of the internal symbols, and that the transitive headers should not be directly included.We've been carrying this patch for a while and it's been working great for us.
Thanks for making nanobind!