solidity-language-server 0.1.36

A fast Solidity language server powered by solc and Foundry
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

//! Function, modifier, and parameter list AST node types.

use serde::{Deserialize, Serialize};

use super::{
    Documentation, Expression, FunctionKind, IdentifierPath, ModifierInvocationKind, NodeID,
    StateMutability, Statement, TypeName, VariableDeclaration, Visibility,
};

/// A function definition.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct FunctionDefinition {
    pub id: NodeID,
    pub src: String,
    pub name: String,
    #[serde(default)]
    pub name_location: Option<String>,
    #[serde(default)]
    pub documentation: Option<Documentation>,
    pub kind: FunctionKind,
    pub state_mutability: StateMutability,
    #[serde(default)]
    pub visibility: Option<Visibility>,
    #[serde(rename = "virtual", default)]
    pub is_virtual: Option<bool>,
    #[serde(default)]
    pub overrides: Option<OverrideSpecifier>,
    pub parameters: ParameterList,
    pub return_parameters: ParameterList,
    #[serde(default)]
    pub modifiers: Vec<ModifierInvocation>,
    /// The function body. `None` for interface/abstract functions.
    #[serde(default)]
    pub body: Option<Statement>,
    #[serde(default)]
    pub implemented: Option<bool>,
    #[serde(default)]
    pub scope: Option<NodeID>,
    /// 4-byte function selector (hex string, no `0x` prefix).
    #[serde(default)]
    pub function_selector: Option<String>,
    /// Base functions this function overrides.
    #[serde(default)]
    pub base_functions: Option<Vec<NodeID>>,
}

/// A parameter list (used for function params and return params).
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct ParameterList {
    pub id: NodeID,
    pub src: String,
    #[serde(default)]
    pub parameters: Vec<VariableDeclaration>,
}

/// A modifier definition.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct ModifierDefinition {
    pub id: NodeID,
    pub src: String,
    pub name: String,
    #[serde(default)]
    pub name_location: Option<String>,
    #[serde(default)]
    pub documentation: Option<Documentation>,
    #[serde(default)]
    pub visibility: Option<Visibility>,
    pub parameters: ParameterList,
    #[serde(rename = "virtual", default)]
    pub is_virtual: Option<bool>,
    #[serde(default)]
    pub overrides: Option<OverrideSpecifier>,
    /// The modifier body. `None` for abstract modifiers.
    #[serde(default)]
    pub body: Option<Statement>,
    /// Base modifiers this modifier overrides.
    #[serde(default)]
    pub base_modifiers: Option<Vec<NodeID>>,
}

/// A modifier invocation (or base constructor specifier) on a function.
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct ModifierInvocation {
    pub id: NodeID,
    pub src: String,
    pub modifier_name: IdentifierPath,
    #[serde(default)]
    pub arguments: Option<Vec<Expression>>,
    #[serde(default)]
    pub kind: Option<ModifierInvocationKind>,
}

/// An override specifier (`override` or `override(A, B)`).
#[derive(Clone, Debug, Deserialize, Serialize, PartialEq, Eq)]
#[serde(rename_all = "camelCase")]
pub struct OverrideSpecifier {
    pub id: NodeID,
    pub src: String,
    #[serde(default)]
    pub overrides: Vec<TypeName>,
}