Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add enclosing scope parameter to rustc_on_unimplemented #66651

Merged
merged 2 commits into from
Dec 3, 2019

Conversation

basil-cow
Copy link
Contributor

@basil-cow basil-cow commented Nov 22, 2019

Adds a new parameter to #[rustc_on_unimplemented], enclosing scope, which highlights the function or closure scope with a message.

The wip part refers to adding this annotation to Try trait to improve ergonomics (which I don't know how to do since I change both std and librustc)

Closes #61709.

@rust-highfive
Copy link
Collaborator

Thanks for the pull request, and welcome! The Rust team is excited to review your changes, and you should hear from @davidtwco (or someone else) soon.

If any changes to this PR are deemed necessary, please add them as extra commits. This ensures that the reviewer can see what has changed since they last reviewed the code. Due to the way GitHub handles out-of-date commits, this should also make it reasonably obvious what issues have or haven't been addressed. Large or tricky changes may require several passes of review and changes.

Please see the contribution instructions for more information.

@rust-highfive rust-highfive added the S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. label Nov 22, 2019
Copy link
Member

@davidtwco davidtwco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM so far! Thanks for the contribution, I'll leave another comment on where to look for the Try trait.

src/librustc/traits/on_unimplemented.rs Outdated Show resolved Hide resolved
src/librustc/traits/on_unimplemented.rs Show resolved Hide resolved
src/test/ui/on-unimplemented/enclosing-scope.rs Outdated Show resolved Hide resolved
src/test/ui/on-unimplemented/enclosing-scope.rs Outdated Show resolved Hide resolved
@davidtwco
Copy link
Member

To add this note to the Try trait, you'll want to add to the following lines:

#[rustc_on_unimplemented(
on(all(
any(from_method="from_error", from_method="from_ok"),
from_desugaring="QuestionMark"),
message="the `?` operator can only be used in {ItemContext} \
that returns `Result` or `Option` \
(or another type that implements `{Try}`)",
label="cannot use the `?` operator in {ItemContext} that returns `{Self}`"),
on(all(from_method="into_result", from_desugaring="QuestionMark"),
message="the `?` operator can only be applied to values \
that implement `{Try}`",
label="the `?` operator cannot be applied to type `{Self}`")
)]

However, this might not work because the stage0 compiler (typically beta, it's used to build the compiler and standard library with your changes), won't know about enclosing_scope. You might need to use #[cfg_attr(bootstrap, rustc_on_unimplemented(..))] (sort of like the example below):

#![cfg_attr(bootstrap, feature(never_type))]

@basil-cow basil-cow force-pushed the on-unimplemented-scope branch from 2916b92 to 1ae3823 Compare November 24, 2019 21:30
@basil-cow basil-cow changed the title [WIP] Add enclosing scope parameter to rustc_on_unimplemented Add enclosing scope parameter to rustc_on_unimplemented Nov 24, 2019
add ui test

compute enclosing_scope_span on demand

add scope test

make tidy happy

stylistic and typo fixes
@basil-cow basil-cow force-pushed the on-unimplemented-scope branch from 1ae3823 to 1d0c015 Compare November 25, 2019 15:10
Copy link
Member

@davidtwco davidtwco left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM! I've left a comment that I think we should consider to improve the diagnostic further, but I'm happy with this as-is if we don't want to make that change.

@@ -794,6 +796,19 @@ impl<'a, 'tcx> InferCtxt<'a, 'tcx> {
// If it has a custom `#[rustc_on_unimplemented]` note, let's display it
err.note(s.as_str());
}
if let Some(ref s) = enclosing_scope {
let enclosing_scope_span = tcx.def_span(
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should just highlight the function name (see below) or return type instead of the whole body - often these spans can be really long and I tend to find them hard to read. Thoughts, @rust-lang/wg-diagnostics?

pub fn generate_fn_name_span(&self, span: Span) -> Option<Span> {
let prev_span = self.span_extend_to_prev_str(span, "fn", true);
self.span_to_snippet(prev_span).map(|snippet| {
let len = snippet.find(|c: char| !c.is_alphanumeric() && c != '_')
.expect("no label after fn");
prev_span.with_hi(BytePos(prev_span.lo().0 + len as u32))
}).ok()
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I normally agree, particularly because some IDEs will highlight the entire thing making the error borderline useless, but in cases similar to this, where knowing where the block ends might be useful, I prefer this CLI output. We can of course merge as is and open a follow up ticket to explore the options around this.

@estebank
Copy link
Contributor

estebank commented Nov 26, 2019

I think this PR might also close #63078.

@basil-cow
Copy link
Contributor Author

Are we waiting on something or this can be merged?

@davidtwco
Copy link
Member

@bors r+

Oops, sorry @Areredify, had lost track of this.

@bors
Copy link
Contributor

bors commented Dec 2, 2019

📌 Commit 1d0c015 has been approved by davidtwco

@bors bors added S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion. and removed S-waiting-on-review Status: Awaiting review from the assignee but also interested parties. labels Dec 2, 2019
Centril added a commit to Centril/rust that referenced this pull request Dec 3, 2019
…=davidtwco

Add `enclosing scope` parameter to `rustc_on_unimplemented`

Adds a new parameter to `#[rustc_on_unimplemented]`, `enclosing scope`, which highlights the function or closure scope with a message.

The wip part refers to adding this annotation to `Try` trait to improve ergonomics (which I don't know how to do since I change both std and librustc)

Closes rust-lang#61709.
Centril added a commit to Centril/rust that referenced this pull request Dec 3, 2019
…=davidtwco

Add `enclosing scope` parameter to `rustc_on_unimplemented`

Adds a new parameter to `#[rustc_on_unimplemented]`, `enclosing scope`, which highlights the function or closure scope with a message.

The wip part refers to adding this annotation to `Try` trait to improve ergonomics (which I don't know how to do since I change both std and librustc)

Closes rust-lang#61709.
bors added a commit that referenced this pull request Dec 3, 2019
Rollup of 6 pull requests

Successful merges:

 - #66148 (Show the sign for signed ops on `exact_div`)
 - #66651 (Add `enclosing scope` parameter to `rustc_on_unimplemented`)
 - #66904 (Adding docs for keyword match, move)
 - #66935 (syntax: Unify macro and attribute arguments in AST)
 - #66941 (Remove `ord` lang item)
 - #66967 (Remove hack for top-level or-patterns in match checking)

Failed merges:

r? @ghost
@bors bors merged commit 1d0c015 into rust-lang:master Dec 3, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
S-waiting-on-bors Status: Waiting on bors to run and complete tests. Bors will change the label on completion.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Extend rustc_on_unimplemented to allow pointing at enclosing function/closure
5 participants