rust-analyzer/crates/ra_ide/src/inlay_hints.rs

1056 lines
26 KiB
Rust
Raw Normal View History

//! FIXME: write short doc here
use hir::{Adt, HirDisplay, Semantics, Type};
2020-02-06 11:52:32 +00:00
use ra_ide_db::RootDatabase;
2019-12-21 17:45:46 +00:00
use ra_prof::profile;
2019-07-19 21:20:09 +00:00
use ra_syntax::{
ast::{self, ArgListOwner, AstNode, TypeAscriptionOwner},
2020-02-29 22:24:50 +00:00
match_ast, SmolStr, TextRange,
2019-07-19 21:20:09 +00:00
};
2020-02-06 11:52:32 +00:00
use crate::{FileId, FunctionSignature};
2019-12-21 17:45:46 +00:00
#[derive(Clone, Debug, PartialEq, Eq)]
2020-03-12 16:38:48 +00:00
pub struct InlayHintsOptions {
pub type_hints: bool,
pub parameter_hints: bool,
pub max_length: Option<usize>,
}
2020-03-12 16:38:48 +00:00
impl Default for InlayHintsOptions {
fn default() -> Self {
Self { type_hints: true, parameter_hints: true, max_length: None }
}
}
#[derive(Clone, Debug, PartialEq, Eq)]
2019-07-19 21:20:09 +00:00
pub enum InlayKind {
2019-08-04 21:28:36 +00:00
TypeHint,
ParameterHint,
2019-07-19 21:20:09 +00:00
}
#[derive(Debug)]
pub struct InlayHint {
pub range: TextRange,
2019-07-22 18:52:47 +00:00
pub kind: InlayKind,
pub label: SmolStr,
2019-07-19 21:20:09 +00:00
}
pub(crate) fn inlay_hints(
db: &RootDatabase,
file_id: FileId,
2020-03-12 16:38:48 +00:00
options: &InlayHintsOptions,
) -> Vec<InlayHint> {
2020-02-29 22:24:50 +00:00
let _p = profile("inlay_hints");
let sema = Semantics::new(db);
let file = sema.parse(file_id);
2020-02-29 22:24:50 +00:00
let mut res = Vec::new();
for node in file.syntax().descendants() {
2020-02-29 22:24:50 +00:00
match_ast! {
match node {
2020-03-12 16:38:48 +00:00
ast::CallExpr(it) => { get_param_name_hints(&mut res, &sema, options, ast::Expr::from(it)); },
ast::MethodCallExpr(it) => { get_param_name_hints(&mut res, &sema, options, ast::Expr::from(it)); },
ast::BindPat(it) => { get_bind_pat_hints(&mut res, &sema, options, it); },
2020-02-29 22:24:50 +00:00
_ => (),
}
}
}
res
2019-07-19 21:20:09 +00:00
}
2020-02-29 22:24:50 +00:00
fn get_param_name_hints(
acc: &mut Vec<InlayHint>,
sema: &Semantics<RootDatabase>,
2020-03-12 16:38:48 +00:00
options: &InlayHintsOptions,
2020-02-29 22:24:50 +00:00
expr: ast::Expr,
) -> Option<()> {
2020-03-12 16:38:48 +00:00
if !options.parameter_hints {
return None;
}
2020-02-29 22:24:50 +00:00
let args = match &expr {
ast::Expr::CallExpr(expr) => expr.arg_list()?.args(),
ast::Expr::MethodCallExpr(expr) => expr.arg_list()?.args(),
_ => return None,
};
2020-02-29 22:24:50 +00:00
let args_count = args.clone().count();
let fn_signature = get_fn_signature(sema, &expr)?;
let n_params_to_skip =
if fn_signature.has_self_param && fn_signature.parameter_names.len() > args_count {
1
} else {
0
};
let hints = fn_signature
.parameter_names
.iter()
.skip(n_params_to_skip)
.zip(args)
.filter(|(param, arg)| should_show_param_hint(&fn_signature, param, &arg))
.map(|(param_name, arg)| InlayHint {
range: arg.syntax().text_range(),
kind: InlayKind::ParameterHint,
label: param_name.into(),
});
acc.extend(hints);
Some(())
}
fn get_bind_pat_hints(
acc: &mut Vec<InlayHint>,
sema: &Semantics<RootDatabase>,
2020-03-12 16:38:48 +00:00
options: &InlayHintsOptions,
2020-02-29 22:24:50 +00:00
pat: ast::BindPat,
) -> Option<()> {
2020-03-12 16:38:48 +00:00
if !options.type_hints {
return None;
}
2020-02-29 22:24:50 +00:00
let ty = sema.type_of_pat(&pat.clone().into())?;
if should_not_display_type_hint(sema.db, &pat, &ty) {
return None;
}
acc.push(InlayHint {
range: pat.syntax().text_range(),
kind: InlayKind::TypeHint,
2020-03-12 16:38:48 +00:00
label: ty.display_truncated(sema.db, options.max_length).to_string().into(),
2020-02-29 22:24:50 +00:00
});
Some(())
2019-07-21 20:28:05 +00:00
}
fn pat_is_enum_variant(db: &RootDatabase, bind_pat: &ast::BindPat, pat_ty: &Type) -> bool {
if let Some(Adt::Enum(enum_data)) = pat_ty.as_adt() {
let pat_text = bind_pat.syntax().to_string();
enum_data
.variants(db)
.into_iter()
.map(|variant| variant.name(db).to_string())
.any(|enum_name| enum_name == pat_text)
} else {
false
}
}
fn should_not_display_type_hint(db: &RootDatabase, bind_pat: &ast::BindPat, pat_ty: &Type) -> bool {
if pat_ty.is_unknown() {
return true;
}
2020-03-08 21:21:08 +00:00
if let Some(Adt::Struct(s)) = pat_ty.as_adt() {
if s.fields(db).is_empty() && s.name(db).to_string() == bind_pat.syntax().to_string() {
return true;
}
}
2020-02-22 20:07:09 +00:00
for node in bind_pat.syntax().ancestors() {
match_ast! {
match node {
ast::LetStmt(it) => {
return it.ascribed_type().is_some()
},
ast::Param(it) => {
return it.ascribed_type().is_some()
},
ast::MatchArm(_it) => {
return pat_is_enum_variant(db, bind_pat, pat_ty);
},
ast::IfExpr(it) => {
return it.condition().and_then(|condition| condition.pat()).is_some()
&& pat_is_enum_variant(db, bind_pat, pat_ty);
},
ast::WhileExpr(it) => {
return it.condition().and_then(|condition| condition.pat()).is_some()
&& pat_is_enum_variant(db, bind_pat, pat_ty);
},
2020-02-22 20:07:09 +00:00
_ => (),
}
}
}
false
}
fn should_show_param_hint(
fn_signature: &FunctionSignature,
param_name: &str,
argument: &ast::Expr,
) -> bool {
let argument_string = argument.syntax().to_string();
if param_name.is_empty() || argument_string.ends_with(param_name) {
return false;
}
let parameters_len = if fn_signature.has_self_param {
fn_signature.parameters.len() - 1
} else {
fn_signature.parameters.len()
};
// avoid displaying hints for common functions like map, filter, etc.
if parameters_len == 1 && (param_name.len() == 1 || param_name == "predicate") {
return false;
}
true
}
fn get_fn_signature(sema: &Semantics<RootDatabase>, expr: &ast::Expr) -> Option<FunctionSignature> {
match expr {
ast::Expr::CallExpr(expr) => {
// FIXME: Type::as_callable is broken for closures
let callable_def = sema.type_of_expr(&expr.expr()?)?.as_callable()?;
match callable_def {
hir::CallableDef::FunctionId(it) => {
Some(FunctionSignature::from_hir(sema.db, it.into()))
}
hir::CallableDef::StructId(it) => {
FunctionSignature::from_struct(sema.db, it.into())
}
hir::CallableDef::EnumVariantId(it) => {
FunctionSignature::from_enum_variant(sema.db, it.into())
}
}
}
ast::Expr::MethodCallExpr(expr) => {
let fn_def = sema.resolve_method_call(&expr)?;
Some(FunctionSignature::from_hir(sema.db, fn_def))
}
_ => None,
}
}
2019-07-21 20:28:05 +00:00
2019-07-19 21:20:09 +00:00
#[cfg(test)]
mod tests {
2020-03-12 16:38:48 +00:00
use crate::inlay_hints::InlayHintsOptions;
2019-08-29 13:49:10 +00:00
use insta::assert_debug_snapshot;
2019-07-19 21:20:09 +00:00
2019-12-07 18:14:01 +00:00
use crate::mock_analysis::single_file;
#[test]
fn param_hints_only() {
let (analysis, file_id) = single_file(
r#"
fn foo(a: i32, b: i32) -> i32 { a + b }
fn main() {
let _x = foo(4, 4);
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions{ parameter_hints: true, type_hints: false, max_length: None}).unwrap(), @r###"
[
InlayHint {
range: [106; 107),
kind: ParameterHint,
label: "a",
},
InlayHint {
range: [109; 110),
kind: ParameterHint,
label: "b",
},
]"###);
}
#[test]
fn hints_disabled() {
let (analysis, file_id) = single_file(
r#"
fn foo(a: i32, b: i32) -> i32 { a + b }
fn main() {
let _x = foo(4, 4);
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions{ type_hints: false, parameter_hints: false, max_length: None}).unwrap(), @r###"[]"###);
}
#[test]
fn type_hints_only() {
let (analysis, file_id) = single_file(
r#"
fn foo(a: i32, b: i32) -> i32 { a + b }
fn main() {
let _x = foo(4, 4);
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions{ type_hints: true, parameter_hints: false, max_length: None}).unwrap(), @r###"
[
InlayHint {
range: [97; 99),
kind: TypeHint,
label: "i32",
},
]"###);
}
2019-12-07 22:54:18 +00:00
#[test]
fn default_generic_types_should_not_be_displayed() {
2019-12-07 22:54:18 +00:00
let (analysis, file_id) = single_file(
r#"
struct Test<K, T = u8> {
k: K,
2019-12-07 22:54:18 +00:00
t: T,
}
fn main() {
let zz = Test { t: 23, k: 33 };
let zz_ref = &zz;
2019-12-07 22:54:18 +00:00
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-12-07 22:54:18 +00:00
[
InlayHint {
range: [69; 71),
2019-12-07 22:54:18 +00:00
kind: TypeHint,
label: "Test<i32>",
},
InlayHint {
range: [105; 111),
kind: TypeHint,
label: "&Test<i32>",
},
2019-12-07 22:54:18 +00:00
]
"###
);
}
2019-07-19 21:20:09 +00:00
#[test]
2019-07-27 21:50:26 +00:00
fn let_statement() {
2019-07-21 20:28:05 +00:00
let (analysis, file_id) = single_file(
2019-07-19 21:20:09 +00:00
r#"
2019-07-27 21:50:26 +00:00
#[derive(PartialEq)]
enum CustomOption<T> {
None,
Some(T),
}
#[derive(PartialEq)]
struct Test {
a: CustomOption<u32>,
b: u8,
}
2019-07-19 21:20:09 +00:00
fn main() {
struct InnerStruct {}
let test = 54;
let test: i32 = 33;
let mut test = 33;
let _ = 22;
let test = "test";
2019-07-19 21:20:09 +00:00
let test = InnerStruct {};
2019-07-19 21:20:09 +00:00
let test = vec![222];
let test: Vec<_> = (0..3).collect();
2019-07-27 21:50:26 +00:00
let test = (0..3).collect::<Vec<i128>>();
let test = (0..3).collect::<Vec<_>>();
2019-07-19 21:20:09 +00:00
let mut test = Vec::new();
test.push(333);
2019-07-19 21:20:09 +00:00
let test = (42, 'a');
let (a, (b, c, (d, e), f)) = (2, (3, 4, (6.6, 7.7), 5));
2019-12-07 18:14:01 +00:00
let &x = &92;
2019-07-27 21:50:26 +00:00
}"#,
2019-07-21 20:28:05 +00:00
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-11-15 09:56:24 +00:00
[
InlayHint {
range: [193; 197),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [236; 244),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [275; 279),
kind: TypeHint,
label: "&str",
},
InlayHint {
range: [539; 543),
kind: TypeHint,
label: "(i32, char)",
},
InlayHint {
range: [566; 567),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [570; 571),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [573; 574),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [577; 578),
kind: TypeHint,
label: "f64",
},
InlayHint {
range: [580; 581),
kind: TypeHint,
label: "f64",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [584; 585),
kind: TypeHint,
label: "i32",
},
2019-12-07 18:14:01 +00:00
InlayHint {
range: [627; 628),
kind: TypeHint,
label: "i32",
},
2019-11-15 09:56:24 +00:00
]
"###
2019-07-27 21:50:26 +00:00
);
}
#[test]
2019-12-23 15:53:35 +00:00
fn closure_parameters() {
2019-07-27 21:50:26 +00:00
let (analysis, file_id) = single_file(
r#"
fn main() {
let mut start = 0;
(0..2).for_each(|increment| {
start += increment;
});
2019-12-23 15:53:35 +00:00
let multiply = |a, b, c, d| a * b * c * d;
let _: i32 = multiply(1, 2, 3, 4);
let multiply_ref = &multiply;
2019-12-23 15:53:35 +00:00
let return_42 = || 42;
2019-07-27 21:50:26 +00:00
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-11-15 09:56:24 +00:00
[
InlayHint {
range: [21; 30),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [57; 66),
kind: TypeHint,
label: "i32",
},
2019-12-23 15:53:35 +00:00
InlayHint {
range: [115; 123),
2019-12-23 15:53:35 +00:00
kind: TypeHint,
label: "|…| -> i32",
},
InlayHint {
range: [127; 128),
2019-12-23 15:53:35 +00:00
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [130; 131),
2019-12-23 15:53:35 +00:00
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [133; 134),
2019-12-23 15:53:35 +00:00
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [136; 137),
2019-12-23 15:53:35 +00:00
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [201; 213),
kind: TypeHint,
label: "&|…| -> i32",
},
InlayHint {
range: [236; 245),
2019-12-23 15:53:35 +00:00
kind: TypeHint,
label: "|| -> i32",
},
2019-11-15 09:56:24 +00:00
]
"###
2019-07-27 21:50:26 +00:00
);
}
#[test]
fn for_expression() {
let (analysis, file_id) = single_file(
r#"
fn main() {
let mut start = 0;
for increment in 0..2 {
start += increment;
}
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-11-15 09:56:24 +00:00
[
InlayHint {
range: [21; 30),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [44; 53),
kind: TypeHint,
label: "i32",
},
]
"###
2019-07-27 21:50:26 +00:00
);
}
#[test]
fn if_expr() {
let (analysis, file_id) = single_file(
r#"
#[derive(PartialEq)]
enum CustomOption<T> {
None,
Some(T),
}
#[derive(PartialEq)]
struct Test {
a: CustomOption<u32>,
b: u8,
}
use CustomOption::*;
2019-07-27 21:50:26 +00:00
fn main() {
let test = Some(Test { a: Some(3), b: 1 });
if let None = &test {};
2019-07-27 21:50:26 +00:00
if let test = &test {};
if let Some(test) = &test {};
if let Some(Test { a, b }) = &test {};
if let Some(Test { a: x, b: y }) = &test {};
if let Some(Test { a: Some(x), b: y }) = &test {};
if let Some(Test { a: None, b: y }) = &test {};
if let Some(Test { b: y, .. }) = &test {};
if test == None {}
2019-07-27 21:50:26 +00:00
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-11-15 09:56:24 +00:00
[
InlayHint {
range: [188; 192),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "CustomOption<Test>",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [267; 271),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&CustomOption<Test>",
},
2019-11-15 09:56:24 +00:00
InlayHint {
range: [300; 304),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&Test",
},
InlayHint {
range: [341; 342),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&CustomOption<u32>",
},
InlayHint {
range: [344; 345),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&u8",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [387; 388),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&CustomOption<u32>",
},
InlayHint {
range: [393; 394),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
2019-11-15 09:56:24 +00:00
InlayHint {
range: [441; 442),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&u32",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [448; 449),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
InlayHint {
range: [500; 501),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
InlayHint {
range: [543; 544),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
2019-11-15 09:56:24 +00:00
]
"###
2019-07-27 21:50:26 +00:00
);
}
#[test]
fn while_expr() {
let (analysis, file_id) = single_file(
r#"
#[derive(PartialEq)]
enum CustomOption<T> {
None,
Some(T),
}
#[derive(PartialEq)]
struct Test {
a: CustomOption<u32>,
b: u8,
}
use CustomOption::*;
2019-07-27 21:50:26 +00:00
fn main() {
let test = Some(Test { a: Some(3), b: 1 });
while let None = &test {};
2019-07-27 21:50:26 +00:00
while let test = &test {};
while let Some(test) = &test {};
while let Some(Test { a, b }) = &test {};
while let Some(Test { a: x, b: y }) = &test {};
while let Some(Test { a: Some(x), b: y }) = &test {};
while let Some(Test { a: None, b: y }) = &test {};
while let Some(Test { b: y, .. }) = &test {};
while test == None {}
2019-07-27 21:50:26 +00:00
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-11-15 09:56:24 +00:00
[
InlayHint {
range: [188; 192),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "CustomOption<Test>",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [273; 277),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&CustomOption<Test>",
},
2019-11-15 09:56:24 +00:00
InlayHint {
range: [309; 313),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&Test",
},
InlayHint {
range: [353; 354),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&CustomOption<u32>",
},
InlayHint {
range: [356; 357),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&u8",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [402; 403),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&CustomOption<u32>",
},
InlayHint {
range: [408; 409),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
2019-11-15 09:56:24 +00:00
InlayHint {
range: [459; 460),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "&u32",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [466; 467),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
InlayHint {
range: [521; 522),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
InlayHint {
range: [567; 568),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "&u8",
},
2019-11-15 09:56:24 +00:00
]
2019-08-07 13:14:22 +00:00
"###
2019-07-27 21:50:26 +00:00
);
}
#[test]
fn match_arm_list() {
let (analysis, file_id) = single_file(
r#"
#[derive(PartialEq)]
2019-08-04 21:28:36 +00:00
enum CustomOption<T> {
2019-07-27 21:50:26 +00:00
None,
Some(T),
}
#[derive(PartialEq)]
struct Test {
a: CustomOption<u32>,
b: u8,
}
use CustomOption::*;
2019-07-27 21:50:26 +00:00
fn main() {
match Some(Test { a: Some(3), b: 1 }) {
None => (),
2019-07-27 21:50:26 +00:00
test => (),
Some(test) => (),
Some(Test { a, b }) => (),
Some(Test { a: x, b: y }) => (),
Some(Test { a: Some(x), b: y }) => (),
Some(Test { a: None, b: y }) => (),
Some(Test { b: y, .. }) => (),
2019-07-27 21:50:26 +00:00
_ => {}
}
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
2019-11-15 09:56:24 +00:00
[
2020-02-22 22:23:33 +00:00
InlayHint {
range: [252; 256),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "CustomOption<Test>",
},
2019-11-15 09:56:24 +00:00
InlayHint {
range: [277; 281),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "Test",
},
InlayHint {
range: [310; 311),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "CustomOption<u32>",
},
InlayHint {
range: [313; 314),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "u8",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [348; 349),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "CustomOption<u32>",
},
InlayHint {
range: [354; 355),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "u8",
},
2019-11-15 09:56:24 +00:00
InlayHint {
range: [394; 395),
2019-11-15 09:56:24 +00:00
kind: TypeHint,
label: "u32",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [401; 402),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "u8",
},
InlayHint {
range: [445; 446),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "u8",
},
InlayHint {
range: [480; 481),
2020-02-22 22:23:33 +00:00
kind: TypeHint,
label: "u8",
},
2019-11-15 09:56:24 +00:00
]
"###
2019-07-21 17:51:27 +00:00
);
2019-07-19 21:20:09 +00:00
}
2019-11-19 16:40:38 +00:00
#[test]
fn hint_truncation() {
let (analysis, file_id) = single_file(
r#"
struct Smol<T>(T);
struct VeryLongOuterName<T>(T);
fn main() {
let a = Smol(0u32);
let b = VeryLongOuterName(0usize);
let c = Smol(Smol(0u32))
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions { max_length: Some(8), ..Default::default() }).unwrap(), @r###"
2019-11-19 16:40:38 +00:00
[
InlayHint {
range: [74; 75),
kind: TypeHint,
label: "Smol<u32>",
},
InlayHint {
range: [98; 99),
kind: TypeHint,
label: "VeryLongOuterName<…>",
},
InlayHint {
range: [137; 138),
kind: TypeHint,
label: "Smol<Smol<…>>",
},
]
"###
);
}
#[test]
fn function_call_parameter_hint() {
let (analysis, file_id) = single_file(
r#"
enum CustomOption<T> {
None,
Some(T),
}
use CustomOption::*;
struct FileId {}
struct SmolStr {}
impl From<&str> for SmolStr {
fn from(_: &str) -> Self {
unimplemented!()
}
}
struct TextRange {}
struct SyntaxKind {}
struct NavigationTarget {}
struct Test {}
impl Test {
fn method(&self, mut param: i32) -> i32 {
param * 2
}
fn from_syntax(
file_id: FileId,
name: SmolStr,
focus_range: CustomOption<TextRange>,
full_range: TextRange,
kind: SyntaxKind,
docs: CustomOption<String>,
description: CustomOption<String>,
) -> NavigationTarget {
NavigationTarget {}
}
}
fn test_func(mut foo: i32, bar: i32, msg: &str, _: i32, last: i32) -> i32 {
foo + bar
}
fn main() {
let not_literal = 1;
let _: i32 = test_func(1, 2, "hello", 3, not_literal);
let t: Test = Test {};
t.method(123);
Test::method(&t, 3456);
Test::from_syntax(
FileId {},
"impl".into(),
None,
TextRange {},
SyntaxKind {},
None,
None,
);
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions::default()).unwrap(), @r###"
[
InlayHint {
range: [798; 809),
kind: TypeHint,
label: "i32",
},
InlayHint {
range: [842; 843),
kind: ParameterHint,
label: "foo",
},
InlayHint {
range: [845; 846),
kind: ParameterHint,
label: "bar",
},
InlayHint {
range: [848; 855),
kind: ParameterHint,
label: "msg",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [860; 871),
2020-02-22 22:23:33 +00:00
kind: ParameterHint,
label: "last",
},
InlayHint {
range: [914; 917),
kind: ParameterHint,
label: "param",
},
2020-02-22 22:23:33 +00:00
InlayHint {
range: [937; 939),
2020-02-22 22:23:33 +00:00
kind: ParameterHint,
label: "&self",
},
InlayHint {
range: [941; 945),
kind: ParameterHint,
label: "param",
},
InlayHint {
range: [980; 989),
kind: ParameterHint,
label: "file_id",
},
InlayHint {
range: [999; 1012),
kind: ParameterHint,
label: "name",
},
InlayHint {
range: [1022; 1026),
kind: ParameterHint,
label: "focus_range",
},
InlayHint {
range: [1036; 1048),
kind: ParameterHint,
label: "full_range",
},
InlayHint {
range: [1058; 1071),
kind: ParameterHint,
label: "kind",
},
InlayHint {
range: [1081; 1085),
kind: ParameterHint,
label: "docs",
},
InlayHint {
range: [1095; 1099),
kind: ParameterHint,
label: "description",
},
]
"###
);
}
#[test]
fn omitted_parameters_hints_heuristics() {
let (analysis, file_id) = single_file(
r#"
fn map(f: i32) {}
fn filter(predicate: i32) {}
struct TestVarContainer {
test_var: i32,
}
struct Test {}
impl Test {
fn map(self, f: i32) -> Self {
self
}
fn filter(self, predicate: i32) -> Self {
self
}
fn no_hints_expected(&self, _: i32, test_var: i32) {}
}
fn main() {
let container: TestVarContainer = TestVarContainer { test_var: 42 };
let test: Test = Test {};
map(22);
filter(33);
let test_processed: Test = test.map(1).filter(2);
let test_var: i32 = 55;
test_processed.no_hints_expected(22, test_var);
test_processed.no_hints_expected(33, container.test_var);
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions { max_length: Some(8), ..Default::default() }).unwrap(), @r###"
[]
"###
);
}
2020-03-08 21:21:08 +00:00
#[test]
fn unit_structs_have_no_type_hints() {
let (analysis, file_id) = single_file(
r#"
enum CustomResult<T, E> {
Ok(T),
Err(E),
}
use CustomResult::*;
struct SyntheticSyntax;
fn main() {
match Ok(()) {
Ok(_) => (),
Err(SyntheticSyntax) => (),
}
}"#,
);
2020-03-12 16:38:48 +00:00
assert_debug_snapshot!(analysis.inlay_hints(file_id, &InlayHintsOptions { max_length: Some(8), ..Default::default() }).unwrap(), @r###"
2020-03-08 21:21:08 +00:00
[]
"###
);
}
2019-07-19 21:20:09 +00:00
}