Allow specifying the source location of #expect() and #require().
#27
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
grynspan
requested review from
SeanROlszewski,
briancroom,
dennisweissmann,
stmontgomery and
suzannaratcliff
as code owners
Contributor
Author
|
@swift-ci please test |
1 similar comment
Contributor
Author
|
@swift-ci please test |
Matejkob
reviewed
Sep 25, 2023
Contributor
Author
|
@swift-ci please test |
This PR adds an additional argument to the `#expect()` and `#require()` macros that, if specified, replaces the source location derived at macro expansion time and passed to `__check()`. This change is ABI-safe for anyone who has already adopted swift-testing because it does not affect the emitted code or symbols. It is source-safe. In the typical use case, the existing/old code path is taken at compile time and this PR has no effect. If a developer wants to specify a precise source location, they can do so. This PR also changes the default behaviour of `#expect()` to generate an instance of `SourceLocation` using default arguments rather than by asking the macro context to provide all info. This is a little bit faster and is more accurate when a freestanding macro expression is embedded in another macro expression, such as: ```swift #expect(try foo()) } ``` > [!NOTE] > The arguments to `SourceLocation.init()` all currently have default values. We might want to change that in the future so that a developer cannot accidentally underspecify an instance. Where a default value is truly required, we can offer a `.here()` factory function that explicitly indicates intent. Resolves rdar://112974442. Resolves #15.
grynspan
force-pushed
the
jgrynspan/112974442-sourcelocation-arg
branch
from
581cd35 to
b2eb738
Compare
Contributor
Author
|
@swift-ci please test |
stmontgomery
approved these changes
Sep 26, 2023
Contributor
stmontgomery
left a comment
stmontgomery
left a comment
There was a problem hiding this comment.
One small thing, but LGTM!
Contributor
Author
|
@swift-ci please test |
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.
This PR adds an additional argument to the
#expect()and#require()macros that, if specified, replaces the source location derived at macro expansion time and passed to__check(). This change is ABI-safe for anyone who has already adopted swift-testing because it does not affect the emitted code or symbols. It is source-safe.In the typical use case, the existing/old code path is taken at compile time and this PR has no effect. If a developer wants to specify a precise source location, they can do so.
This PR also changes the default behaviour of
#expect()to generate an instance ofSourceLocationusing default arguments rather than by asking the macro context to provide all info. This is a little bit faster and is more accurate when a freestanding macro expression is embedded in another macro expression, such as:Note
The arguments to
SourceLocation.init()all currently have default values. We might want to change that in the future so that a developer cannot accidentally underspecify an instance. Where a default value is truly required, we can offer a.here()factory function that explicitly indicates intent.Resolves rdar://112974442.
Resolves #15.