Skip to content

Suggest to use self for fake-self from other languages #54694

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

Merged
merged 4 commits into from
Oct 2, 2018
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 15 additions & 1 deletion src/librustc_resolve/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -2981,13 +2981,13 @@ impl<'a, 'crateloader: 'a> Resolver<'a, 'crateloader> {
// Make the base error.
let expected = source.descr_expected();
let path_str = names_to_string(path);
let item_str = path[path.len() - 1];
let code = source.error_code(def.is_some());
let (base_msg, fallback_label, base_span) = if let Some(def) = def {
(format!("expected {}, found {} `{}`", expected, def.kind_name(), path_str),
format!("not a {}", expected),
span)
} else {
let item_str = path[path.len() - 1];
let item_span = path[path.len() - 1].span;
let (mod_prefix, mod_str) = if path.len() == 1 {
(String::new(), "this scope".to_string())
Expand All @@ -3010,6 +3010,20 @@ impl<'a, 'crateloader: 'a> Resolver<'a, 'crateloader> {
let code = DiagnosticId::Error(code.into());
let mut err = this.session.struct_span_err_with_code(base_span, &base_msg, code);

// Emit help message for fake-self from other languages like `this`(javascript)
let fake_self: Vec<Ident> = ["this", "my"].iter().map(
|s| Ident::from_str(*s)
).collect();
if fake_self.contains(&item_str)
&& this.self_value_is_available(path[0].span, span) {
Copy link
Member

Choose a reason for hiding this comment

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

Can we ever get here in case that this or my are defiend? If so, maybe we should add a check here to only suggest this when they are undefined and the author actually meant what we call self?

A test case to consider adding would be

struct Foo { x: i32 };
impl Foo {
    fn foo(&mut self) -> i32 {
        let this = 13;
        // ... a hundred complicated lines of code ...
        this.x
    }
}

Copy link
Member Author

Choose a reason for hiding this comment

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

yes, it's covered. I tested this locally(but deleted this lines from test case):

let this = self;
this.x

it works fine and doesn't trigger the err.
I'll recover this as you point here.

err.span_suggestion_with_applicability(
span,
"did you mean",
"self".to_string(),
Applicability::MaybeIncorrect,
);
}

// Emit special messages for unresolved `Self` and `self`.
if is_self_type(path, ns) {
__diagnostic_used!(E0411);
Expand Down
52 changes: 52 additions & 0 deletions src/test/ui/self/suggest-self.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
// Copyright 2018 The Rust Project Developers. See the COPYRIGHT
// file at the top-level directory of this distribution and at
// http://rust-lang.org/COPYRIGHT.
//
// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or
// http://www.apache.org/licenses/LICENSE-2.0> or the MIT license
// <LICENSE-MIT or http://opensource.org/licenses/MIT>, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.

struct Foo {
x: i32,
}

impl Foo {
fn this1(&self) -> i32 {
let this = self;
let a = 1;
this.x
}

fn this2(&self) -> i32 {
let a = Foo {
x: 2
};
let this = a;
this.x
Copy link
Member Author

@csmoe csmoe Oct 1, 2018

Choose a reason for hiding this comment

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

@estebank the testcases this1 this2 passed, should it be marked as Applicable?
oh, no, as you pointed out, if it's UnApplicable with this.fo for struct T { foo: i32 }.

Copy link
Member Author

@csmoe csmoe Oct 1, 2018

Choose a reason for hiding this comment

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

@estebank I guess it won't be hard as there alread has methods like check_field

Copy link
Contributor

Choose a reason for hiding this comment

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

That's great! In that case, could you make a follow up PR incorporating that change? At that point, if the check fails it might need to be a note instead of a suggestion, given that the likelihood of the suggestion (even MaybeIncorrect) plummets... I'm not sure.

Copy link
Member Author

Choose a reason for hiding this comment

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

yep, added an entry to TODO.

}

fn foo(&self) -> i32 {
this.x
//~^ ERROR cannot find value `this` in this scope
}

fn bar(&self) -> i32 {
this.foo()
//~^ ERROR cannot find value `this` in this scope
}

fn baz(&self) -> i32 {
my.bar()
//~^ ERROR cannot find value `my` in this scope
}
}

fn main() {
let this = vec![1, 2, 3];
let my = vec![1, 2, 3];
let len = this.len();
let len = my.len();
}

30 changes: 30 additions & 0 deletions src/test/ui/self/suggest-self.stderr
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
error[E0425]: cannot find value `this` in this scope
--> $DIR/suggest-self.rs:31:9
|
LL | this.x
| ^^^^
| |
| not found in this scope
| help: did you mean: `self`

error[E0425]: cannot find value `this` in this scope
--> $DIR/suggest-self.rs:36:9
|
LL | this.foo()
| ^^^^
| |
| not found in this scope
| help: did you mean: `self`

error[E0425]: cannot find value `my` in this scope
--> $DIR/suggest-self.rs:41:9
|
LL | my.bar()
| ^^
| |
| not found in this scope
| help: did you mean: `self`

error: aborting due to 3 previous errors

For more information about this error, try `rustc --explain E0425`.