Add inlay hint for exclusive ranges
Adds an inlay hint containing a '<' character to exclusive range expressions and patterns that specify an upper bound.
This commit is contained in:
parent
f595e60b6d
commit
3c378b9c70
@ -17,7 +17,7 @@
|
||||
use syntax::{
|
||||
ast::{
|
||||
self, ArrayExprKind, AstChildren, BlockExpr, HasArgList, HasAttrs, HasLoopBody, HasName,
|
||||
SlicePatComponents,
|
||||
RangeItem, SlicePatComponents,
|
||||
},
|
||||
AstNode, AstPtr, SyntaxNodePtr,
|
||||
};
|
||||
|
@ -1,5 +1,6 @@
|
||||
use hir::Semantics;
|
||||
use ide_db::RootDatabase;
|
||||
use syntax::ast::RangeItem;
|
||||
use syntax::ast::{edit::AstNodeEdit, AstNode, HasName, LetStmt, Name, Pat};
|
||||
use syntax::T;
|
||||
|
||||
|
@ -32,6 +32,7 @@
|
||||
mod implicit_static;
|
||||
mod param_name;
|
||||
mod implicit_drop;
|
||||
mod range_exclusive;
|
||||
|
||||
#[derive(Clone, Debug, PartialEq, Eq)]
|
||||
pub struct InlayHintsConfig {
|
||||
@ -51,6 +52,7 @@ pub struct InlayHintsConfig {
|
||||
pub param_names_for_lifetime_elision_hints: bool,
|
||||
pub hide_named_constructor_hints: bool,
|
||||
pub hide_closure_initialization_hints: bool,
|
||||
pub range_exclusive_hints: bool,
|
||||
pub closure_style: ClosureStyle,
|
||||
pub max_length: Option<usize>,
|
||||
pub closing_brace_hints_min_lines: Option<usize>,
|
||||
@ -127,6 +129,7 @@ pub enum InlayKind {
|
||||
Parameter,
|
||||
Type,
|
||||
Drop,
|
||||
RangeExclusive,
|
||||
}
|
||||
|
||||
#[derive(Debug)]
|
||||
@ -517,14 +520,21 @@ fn hints(
|
||||
closure_captures::hints(hints, famous_defs, config, file_id, it.clone());
|
||||
closure_ret::hints(hints, famous_defs, config, file_id, it)
|
||||
},
|
||||
ast::Expr::RangeExpr(it) => range_exclusive::hints(hints, config, it),
|
||||
_ => None,
|
||||
}
|
||||
},
|
||||
ast::Pat(it) => {
|
||||
binding_mode::hints(hints, sema, config, &it);
|
||||
if let ast::Pat::IdentPat(it) = it {
|
||||
match it {
|
||||
ast::Pat::IdentPat(it) => {
|
||||
bind_pat::hints(hints, famous_defs, config, file_id, &it);
|
||||
}
|
||||
ast::Pat::RangePat(it) => {
|
||||
range_exclusive::hints(hints, config, it);
|
||||
}
|
||||
_ => {}
|
||||
}
|
||||
Some(())
|
||||
},
|
||||
ast::Item(it) => match it {
|
||||
@ -621,6 +631,7 @@ mod tests {
|
||||
closing_brace_hints_min_lines: None,
|
||||
fields_to_resolve: InlayFieldsToResolve::empty(),
|
||||
implicit_drop_hints: false,
|
||||
range_exclusive_hints: false,
|
||||
};
|
||||
pub(super) const TEST_CONFIG: InlayHintsConfig = InlayHintsConfig {
|
||||
type_hints: true,
|
||||
|
121
crates/ide/src/inlay_hints/range_exclusive.rs
Normal file
121
crates/ide/src/inlay_hints/range_exclusive.rs
Normal file
@ -0,0 +1,121 @@
|
||||
//! Implementation of "range exclusive" inlay hints:
|
||||
//! ```no_run
|
||||
//! for i in 0../* < */10 {}
|
||||
//! if let ../* < */100 = 50 {}
|
||||
//! ```
|
||||
use syntax::{ast, SyntaxToken, T};
|
||||
|
||||
use crate::{InlayHint, InlayHintsConfig};
|
||||
|
||||
pub(super) fn hints(
|
||||
acc: &mut Vec<InlayHint>,
|
||||
config: &InlayHintsConfig,
|
||||
range: impl ast::RangeItem,
|
||||
) -> Option<()> {
|
||||
(config.range_exclusive_hints && range.end().is_some())
|
||||
.then(|| {
|
||||
range.op_token().filter(|token| token.kind() == T![..]).map(|token| {
|
||||
acc.push(inlay_hint(token));
|
||||
})
|
||||
})
|
||||
.flatten()
|
||||
}
|
||||
|
||||
fn inlay_hint(token: SyntaxToken) -> InlayHint {
|
||||
InlayHint {
|
||||
range: token.text_range(),
|
||||
position: crate::InlayHintPosition::After,
|
||||
pad_left: false,
|
||||
pad_right: false,
|
||||
kind: crate::InlayKind::RangeExclusive,
|
||||
label: crate::InlayHintLabel::from("<"),
|
||||
text_edit: None,
|
||||
needs_resolve: false,
|
||||
}
|
||||
}
|
||||
|
||||
#[cfg(test)]
|
||||
mod tests {
|
||||
use crate::{
|
||||
inlay_hints::tests::{check_with_config, DISABLED_CONFIG},
|
||||
InlayHintsConfig,
|
||||
};
|
||||
|
||||
#[test]
|
||||
fn range_exclusive_expression_bounded_above_hints() {
|
||||
check_with_config(
|
||||
InlayHintsConfig { range_exclusive_hints: true, ..DISABLED_CONFIG },
|
||||
r#"
|
||||
fn main() {
|
||||
let a = 0..10;
|
||||
//^^<
|
||||
let b = ..100;
|
||||
//^^<
|
||||
let c = (2 - 1)..(7 * 8)
|
||||
//^^<
|
||||
}"#,
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn range_exclusive_expression_unbounded_above_no_hints() {
|
||||
check_with_config(
|
||||
InlayHintsConfig { range_exclusive_hints: true, ..DISABLED_CONFIG },
|
||||
r#"
|
||||
fn main() {
|
||||
let a = 0..;
|
||||
let b = ..;
|
||||
}"#,
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn range_inclusive_expression_no_hints() {
|
||||
check_with_config(
|
||||
InlayHintsConfig { range_exclusive_hints: true, ..DISABLED_CONFIG },
|
||||
r#"
|
||||
fn main() {
|
||||
let a = 0..=10;
|
||||
let b = ..=100;
|
||||
}"#,
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn range_exclusive_pattern_bounded_above_hints() {
|
||||
check_with_config(
|
||||
InlayHintsConfig { range_exclusive_hints: true, ..DISABLED_CONFIG },
|
||||
r#"
|
||||
fn main() {
|
||||
if let 0..10 = 0 {}
|
||||
//^^<
|
||||
if let ..100 = 0 {}
|
||||
//^^<
|
||||
}"#,
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn range_exclusive_pattern_unbounded_above_no_hints() {
|
||||
check_with_config(
|
||||
InlayHintsConfig { range_exclusive_hints: true, ..DISABLED_CONFIG },
|
||||
r#"
|
||||
fn main() {
|
||||
if let 0.. = 0 {}
|
||||
if let .. = 0 {}
|
||||
}"#,
|
||||
);
|
||||
}
|
||||
|
||||
#[test]
|
||||
fn range_inclusive_pattern_no_hints() {
|
||||
check_with_config(
|
||||
InlayHintsConfig { range_exclusive_hints: true, ..DISABLED_CONFIG },
|
||||
r#"
|
||||
fn main() {
|
||||
if let 0..=10 = 0 {}
|
||||
if let ..=100 = 0 {}
|
||||
}"#,
|
||||
);
|
||||
}
|
||||
}
|
@ -133,6 +133,7 @@ fn add_file(&mut self, file_id: FileId) {
|
||||
closure_capture_hints: false,
|
||||
closing_brace_hints_min_lines: Some(25),
|
||||
fields_to_resolve: InlayFieldsToResolve::empty(),
|
||||
range_exclusive_hints: false,
|
||||
},
|
||||
file_id,
|
||||
None,
|
||||
|
@ -792,6 +792,7 @@ fn run_ide_things(&self, analysis: Analysis, mut file_ids: Vec<FileId>) {
|
||||
max_length: Some(25),
|
||||
closing_brace_hints_min_lines: Some(20),
|
||||
fields_to_resolve: InlayFieldsToResolve::empty(),
|
||||
range_exclusive_hints: true,
|
||||
},
|
||||
file_id,
|
||||
None,
|
||||
|
@ -399,6 +399,8 @@ struct ConfigData {
|
||||
/// Whether to show function parameter name inlay hints at the call
|
||||
/// site.
|
||||
inlayHints_parameterHints_enable: bool = "true",
|
||||
/// Whether to show exclusive range inlay hints.
|
||||
inlayHints_rangeExclusiveHints_enable: bool = "false",
|
||||
/// Whether to show inlay hints for compiler inserted reborrows.
|
||||
/// This setting is deprecated in favor of #rust-analyzer.inlayHints.expressionAdjustmentHints.enable#.
|
||||
inlayHints_reborrowHints_enable: ReborrowHintsDef = "\"never\"",
|
||||
@ -1464,6 +1466,7 @@ pub fn inlay_hints(&self) -> InlayHintsConfig {
|
||||
} else {
|
||||
None
|
||||
},
|
||||
range_exclusive_hints: self.data.inlayHints_rangeExclusiveHints_enable,
|
||||
fields_to_resolve: InlayFieldsToResolve {
|
||||
resolve_text_edits: client_capability_fields.contains("textEdits"),
|
||||
resolve_hint_tooltip: client_capability_fields.contains("tooltip"),
|
||||
|
@ -136,6 +136,16 @@ impl<L, R> HasAttrs for Either<L, R>
|
||||
{
|
||||
}
|
||||
|
||||
/// Trait to describe operations common to both `RangeExpr` and `RangePat`.
|
||||
pub trait RangeItem {
|
||||
type Bound;
|
||||
|
||||
fn start(&self) -> Option<Self::Bound>;
|
||||
fn end(&self) -> Option<Self::Bound>;
|
||||
fn op_kind(&self) -> Option<RangeOp>;
|
||||
fn op_token(&self) -> Option<SyntaxToken>;
|
||||
}
|
||||
|
||||
mod support {
|
||||
use super::{AstChildren, AstNode, SyntaxKind, SyntaxNode, SyntaxToken};
|
||||
|
||||
|
@ -13,6 +13,8 @@
|
||||
SyntaxNode, SyntaxToken, T,
|
||||
};
|
||||
|
||||
use super::RangeItem;
|
||||
|
||||
impl ast::HasAttrs for ast::Expr {}
|
||||
|
||||
impl ast::Expr {
|
||||
@ -227,16 +229,12 @@ fn op_details(&self) -> Option<(usize, SyntaxToken, RangeOp)> {
|
||||
Some((ix, token, bin_op))
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
pub fn op_kind(&self) -> Option<RangeOp> {
|
||||
self.op_details().map(|t| t.2)
|
||||
}
|
||||
impl RangeItem for ast::RangeExpr {
|
||||
type Bound = ast::Expr;
|
||||
|
||||
pub fn op_token(&self) -> Option<SyntaxToken> {
|
||||
self.op_details().map(|t| t.1)
|
||||
}
|
||||
|
||||
pub fn start(&self) -> Option<ast::Expr> {
|
||||
fn start(&self) -> Option<ast::Expr> {
|
||||
let op_ix = self.op_details()?.0;
|
||||
self.syntax()
|
||||
.children_with_tokens()
|
||||
@ -244,13 +242,21 @@ pub fn start(&self) -> Option<ast::Expr> {
|
||||
.find_map(|it| ast::Expr::cast(it.into_node()?))
|
||||
}
|
||||
|
||||
pub fn end(&self) -> Option<ast::Expr> {
|
||||
fn end(&self) -> Option<ast::Expr> {
|
||||
let op_ix = self.op_details()?.0;
|
||||
self.syntax()
|
||||
.children_with_tokens()
|
||||
.skip(op_ix + 1)
|
||||
.find_map(|it| ast::Expr::cast(it.into_node()?))
|
||||
}
|
||||
|
||||
fn op_token(&self) -> Option<SyntaxToken> {
|
||||
self.op_details().map(|t| t.1)
|
||||
}
|
||||
|
||||
fn op_kind(&self) -> Option<RangeOp> {
|
||||
self.op_details().map(|t| t.2)
|
||||
}
|
||||
}
|
||||
|
||||
impl ast::IndexExpr {
|
||||
|
@ -14,6 +14,8 @@
|
||||
ted, NodeOrToken, SmolStr, SyntaxElement, SyntaxToken, TokenText, T,
|
||||
};
|
||||
|
||||
use super::{RangeItem, RangeOp};
|
||||
|
||||
impl ast::Lifetime {
|
||||
pub fn text(&self) -> TokenText<'_> {
|
||||
text_of_first_token(self.syntax())
|
||||
@ -875,8 +877,10 @@ pub fn parent(&self) -> Option<ast::Module> {
|
||||
}
|
||||
}
|
||||
|
||||
impl ast::RangePat {
|
||||
pub fn start(&self) -> Option<ast::Pat> {
|
||||
impl RangeItem for ast::RangePat {
|
||||
type Bound = ast::Pat;
|
||||
|
||||
fn start(&self) -> Option<ast::Pat> {
|
||||
self.syntax()
|
||||
.children_with_tokens()
|
||||
.take_while(|it| !(it.kind() == T![..] || it.kind() == T![..=]))
|
||||
@ -884,13 +888,37 @@ pub fn start(&self) -> Option<ast::Pat> {
|
||||
.find_map(ast::Pat::cast)
|
||||
}
|
||||
|
||||
pub fn end(&self) -> Option<ast::Pat> {
|
||||
fn end(&self) -> Option<ast::Pat> {
|
||||
self.syntax()
|
||||
.children_with_tokens()
|
||||
.skip_while(|it| !(it.kind() == T![..] || it.kind() == T![..=]))
|
||||
.filter_map(|it| it.into_node())
|
||||
.find_map(ast::Pat::cast)
|
||||
}
|
||||
|
||||
fn op_token(&self) -> Option<SyntaxToken> {
|
||||
self.syntax().children_with_tokens().find_map(|it| {
|
||||
let token = it.into_token()?;
|
||||
|
||||
match token.kind() {
|
||||
T![..] => Some(token),
|
||||
T![..=] => Some(token),
|
||||
_ => None,
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
fn op_kind(&self) -> Option<RangeOp> {
|
||||
self.syntax().children_with_tokens().find_map(|it| {
|
||||
let token = it.into_token()?;
|
||||
|
||||
match token.kind() {
|
||||
T![..] => Some(RangeOp::Exclusive),
|
||||
T![..=] => Some(RangeOp::Inclusive),
|
||||
_ => None,
|
||||
}
|
||||
})
|
||||
}
|
||||
}
|
||||
|
||||
impl ast::TokenTree {
|
||||
|
@ -1,7 +1,7 @@
|
||||
//! Precedence representation.
|
||||
|
||||
use crate::{
|
||||
ast::{self, BinaryOp, Expr, HasArgList},
|
||||
ast::{self, BinaryOp, Expr, HasArgList, RangeItem},
|
||||
match_ast, AstNode, SyntaxNode,
|
||||
};
|
||||
|
||||
|
@ -9,7 +9,7 @@
|
||||
|
||||
use crate::{
|
||||
algo,
|
||||
ast::{self, HasAttrs, HasVisibility, IsString},
|
||||
ast::{self, HasAttrs, HasVisibility, IsString, RangeItem},
|
||||
match_ast, AstNode, SyntaxError,
|
||||
SyntaxKind::{CONST, FN, INT_NUMBER, TYPE_ALIAS},
|
||||
SyntaxNode, SyntaxToken, TextSize, T,
|
||||
|
@ -596,6 +596,11 @@ Maximum length for inlay hints. Set to null to have an unlimited length.
|
||||
Whether to show function parameter name inlay hints at the call
|
||||
site.
|
||||
--
|
||||
[[rust-analyzer.inlayHints.rangeExclusiveHints.enable]]rust-analyzer.inlayHints.rangeExclusiveHints.enable (default: `false`)::
|
||||
+
|
||||
--
|
||||
Whether to show exclusive range inlay hints.
|
||||
--
|
||||
[[rust-analyzer.inlayHints.reborrowHints.enable]]rust-analyzer.inlayHints.reborrowHints.enable (default: `"never"`)::
|
||||
+
|
||||
--
|
||||
|
@ -1308,6 +1308,11 @@
|
||||
"default": true,
|
||||
"type": "boolean"
|
||||
},
|
||||
"rust-analyzer.inlayHints.rangeExclusiveHints.enable": {
|
||||
"markdownDescription": "Whether to show exclusive range inlay hints.",
|
||||
"default": false,
|
||||
"type": "boolean"
|
||||
},
|
||||
"rust-analyzer.inlayHints.reborrowHints.enable": {
|
||||
"markdownDescription": "Whether to show inlay hints for compiler inserted reborrows.\nThis setting is deprecated in favor of #rust-analyzer.inlayHints.expressionAdjustmentHints.enable#.",
|
||||
"default": "never",
|
||||
|
Loading…
Reference in New Issue
Block a user