1use vvv_core::RelPath;
5
6use serde::{Deserialize, Serialize};
7
8use crate::{Match, Occurrence, Reach, Skipped};
9use vvv_core::{Address, Highlight, ImportRef, Position, Symbol};
10
11#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
13pub struct Outline {
14 pub path: RelPath,
15 #[serde(default, skip_serializing_if = "Option::is_none")]
17 pub module: Option<Address>,
18 pub items: Vec<OutlineItem>,
19}
20
21#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
22pub struct OutlineItem {
23 #[serde(flatten)]
24 pub symbol: Symbol,
25 pub start: Position,
27 pub end: Position,
28 #[serde(default, skip_serializing_if = "Option::is_none")]
31 pub address: Option<Address>,
32 #[serde(default, skip_serializing_if = "Option::is_none")]
34 pub reach: Option<Reach>,
35}
36
37#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
40pub struct References {
41 pub name: String,
42 pub declarations: Vec<Match>,
43 pub occurrences: Vec<Occurrence>,
44}
45
46#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
48pub struct Locations {
49 pub name: String,
50 pub sites: Vec<Site>,
51}
52
53#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
54pub struct Site {
55 pub declaration: Match,
56 #[serde(default, skip_serializing_if = "Option::is_none")]
57 pub address: Option<Address>,
58 #[serde(default, skip_serializing_if = "Option::is_none")]
61 pub import: Option<String>,
62}
63
64#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
66pub struct Deps {
67 pub path: RelPath,
68 #[serde(default, skip_serializing_if = "Option::is_none")]
70 pub module: Option<Address>,
71 pub imports: Vec<Dep>,
72 pub importers: Vec<Importer>,
73 #[serde(default, skip_serializing_if = "Vec::is_empty")]
74 pub skipped: Vec<Skipped>,
75}
76
77#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
80pub struct Dep {
81 #[serde(flatten)]
82 pub import: ImportRef,
83 pub start: Position,
85 #[serde(default, skip_serializing_if = "Option::is_none")]
87 pub address: Option<Address>,
88 #[serde(default, skip_serializing_if = "Option::is_none")]
91 pub origin: Option<Address>,
92 #[serde(default, skip_serializing_if = "Option::is_none")]
94 pub file: Option<RelPath>,
95}
96
97#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
99pub struct Importer {
100 pub path: RelPath,
101 #[serde(flatten)]
102 pub import: ImportRef,
103 pub start: Position,
104}
105
106#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
108pub struct Explanation {
109 pub path: RelPath,
110 pub position: Position,
111 #[serde(default, skip_serializing_if = "Option::is_none")]
113 pub symbol: Option<Symbol>,
114 #[serde(default, skip_serializing_if = "Option::is_none")]
116 pub declared: Option<Position>,
117 #[serde(default, skip_serializing_if = "Option::is_none")]
118 pub line: Option<String>,
119 #[serde(default, skip_serializing_if = "Option::is_none")]
121 pub module: Option<Address>,
122 #[serde(default, skip_serializing_if = "Option::is_none")]
123 pub address: Option<Address>,
124 #[serde(default, skip_serializing_if = "Option::is_none")]
125 pub reach: Option<Reach>,
126 #[serde(default, skip_serializing_if = "Vec::is_empty")]
128 pub via: Vec<Address>,
129 #[serde(default, skip_serializing_if = "Option::is_none")]
132 pub import: Option<Dep>,
133 pub importers: Vec<RelPath>,
137}
138
139#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
141pub struct File {
142 pub path: RelPath,
143 pub text: String,
144 #[serde(default, skip_serializing_if = "Vec::is_empty")]
145 pub highlights: Vec<Highlight>,
146}
147
148#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
150pub struct Placed {
151 pub path: RelPath,
152 #[serde(flatten)]
153 pub symbol: Symbol,
154 pub start: Position,
156 pub address: Address,
157 pub reach: Reach,
158}
159
160#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
162pub struct Surface {
163 #[serde(default, skip_serializing_if = "Option::is_none")]
165 pub package: Option<vvv_core::PackageId>,
166 pub items: Vec<Exposed>,
167}
168
169#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
170pub struct Exposed {
171 #[serde(flatten)]
172 pub declaration: Placed,
173 #[serde(default, skip_serializing_if = "Vec::is_empty")]
175 pub via: Vec<Address>,
176 pub importers: usize,
178}
179
180#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
183pub struct Impact {
184 pub name: String,
185 pub address: Address,
186 pub consumers: Vec<Consumer>,
188}
189
190#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
191pub struct Consumer {
192 pub module: Address,
193 pub path: RelPath,
194 pub depth: u32,
195 pub through: Address,
198}
199
200#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
203pub struct Dead {
204 pub items: Vec<Unreferenced>,
205}
206
207#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
208pub struct Unreferenced {
209 #[serde(flatten)]
210 pub declaration: Placed,
211 pub unsure: usize,
214}
215
216#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
219pub struct ImportsReport {
220 #[serde(default, skip_serializing_if = "Option::is_none")]
222 pub path: Option<RelPath>,
223 pub unused: Vec<ImportSite>,
225 pub unresolved: Vec<ImportSite>,
227 pub redundant: Vec<ImportSite>,
230 pub unplaced: Vec<RelPath>,
233}
234
235#[derive(Debug, Clone, PartialEq, Eq, Serialize, Deserialize)]
236pub struct ImportSite {
237 pub path: RelPath,
238 #[serde(flatten)]
239 pub import: ImportRef,
240 pub start: Position,
241 #[serde(default, skip_serializing_if = "Option::is_none")]
242 pub address: Option<Address>,
243}