cairo-language-server 2.18.0

The Cairo Language Server
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125

use cairo_lang_filesystem::ids::FileId;
use cairo_lang_semantic::Expr;
use cairo_lang_semantic::db::SemanticGroup;
use cairo_lang_semantic::items::function_with_body::{
    FunctionWithBodySemantic, SemanticExprLookup,
};
use cairo_lang_semantic::items::functions::FunctionsSemantic;
use cairo_lang_semantic::lookup_item::LookupItemEx;
use cairo_lang_syntax::node::ast::{self, ArgClause, BinaryOperator, ExprBinary, ExprFunctionCall};
use cairo_lang_syntax::node::{SyntaxNode, TypedSyntaxNode};
use cairo_language_common::CommonGroup;
use lsp_types::{InlayHint, InlayHintKind, InlayHintLabel};

use crate::lang::db::{AnalysisDatabase, LsSemanticGroup};
use crate::lang::lsp::ToLsp;
use crate::lang::proc_macros::db::get_og_node;

pub fn param_inlay_hints<'db>(
    db: &'db AnalysisDatabase,
    file: FileId<'db>,
    call_syntax: ExprFunctionCall<'db>,
) -> Vec<InlayHint> {
    let Some(signature) = resolve_call_signature(db, &call_syntax) else {
        return vec![];
    };

    let syntax_args: Vec<_> = call_syntax.arguments(db).arguments(db).elements(db).collect();
    let params: Vec<_> =
        signature.params.iter().filter(|p| p.name.to_string(db) != "self").collect();

    syntax_args
        .iter()
        .zip(params.iter())
        .filter_map(|(arg, param)| hint_for_arg(db, file, arg, &param.name.to_string(db)))
        .collect()
}

/// Resolves a syntax-level function call to its semantic [`Signature`].
fn resolve_call_signature<'db>(
    db: &'db AnalysisDatabase,
    call_syntax: &ExprFunctionCall<'db>,
) -> Option<cairo_lang_semantic::Signature<'db>> {
    let call_node = call_syntax.as_syntax_node();

    let is_method_call = call_node
        .parent(db)
        .and_then(|parent| ExprBinary::cast(db, parent))
        .is_some_and(|binary| matches!(binary.op(db), BinaryOperator::Dot(_)));

    let semantic_db: &dyn SemanticGroup = db;

    db.get_node_resultants(call_node)?
        .iter()
        .find_map(|resultant| {
            let resultant_call = ExprFunctionCall::cast(db, *resultant)?;
            let lookup_item = db.find_lookup_item(resultant_call.as_syntax_node())?;
            let function_with_body = lookup_item.function_with_body()?;

            let stable_ptr = if is_method_call {
                let parent = resultant_call.as_syntax_node().parent(db)?;
                ExprBinary::cast(db, parent)?.stable_ptr(db).into()
            } else {
                resultant_call.stable_ptr(db).into()
            };

            let expr_id = db.lookup_expr_by_ptr(function_with_body, stable_ptr).ok()?;
            let Expr::FunctionCall(func_call) =
                semantic_db.expr_semantic(function_with_body, expr_id)
            else {
                return None;
            };

            db.concrete_function_signature(func_call.function).ok()
        })
        .cloned()
}

/// Produces a parameter-name hint for a single argument, or [`None`] if skipped.
/// Skips named args and args with a name matching the param name (`x: x`).
fn hint_for_arg<'db>(
    db: &'db AnalysisDatabase,
    file: FileId<'db>,
    arg: &ast::Arg<'db>,
    param_name: &str,
) -> Option<InlayHint> {
    let ArgClause::Unnamed(unnamed) = arg.arg_clause(db) else {
        return None;
    };

    if should_skip_hint(db, &unnamed.value(db), param_name) {
        return None;
    }

    let og_node = get_og_node(db, arg.as_syntax_node())?;
    make_hint(db, file, og_node, param_name)
}

/// Skips hint if the arg name matches the param name (`x: x`).
fn should_skip_hint(db: &AnalysisDatabase, arg_expr: &ast::Expr, param_name: &str) -> bool {
    if let ast::Expr::Path(path) = arg_expr {
        let text = path.as_syntax_node().get_text_without_trivia(db).to_string(db);
        if text == param_name {
            return true;
        }
    }
    false
}

fn make_hint<'db>(
    db: &'db AnalysisDatabase,
    file: FileId<'db>,
    node: SyntaxNode<'db>,
    param_name: &str,
) -> Option<InlayHint> {
    Some(InlayHint {
        position: node.span_without_trivia(db).position_in_file(db, file)?.start.to_lsp(),
        label: InlayHintLabel::String(format!("{param_name}: ")),
        kind: Some(InlayHintKind::PARAMETER),
        text_edits: None,
        tooltip: None,
        padding_left: None,
        padding_right: None,
        data: None,
    })
}