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
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
//! Structured, on-demand layout data for embedded IDE inspection.
use cranpose_ui::{LayoutBox, LayoutTree};
use serde::Serialize;
/// JSON schema version returned on the structured inspection channel.
pub const SCHEMA_VERSION: u32 = 2;
/// Host request channel. Payload is an optional unsigned request identifier.
pub const REQUEST_CHANNEL: &str = "cranpose.inspector.v2.request";
/// Application response channel containing a JSON [Snapshot].
pub const SNAPSHOT_CHANNEL: &str = "cranpose.inspector.v2.snapshot";
/// Lightweight counter request; payload is an optional unsigned request identifier.
pub const RECOMPOSITIONS_REQUEST_CHANNEL: &str = "cranpose.recompositions.v1.request";
/// Application response containing a JSON [Recompositions].
pub const RECOMPOSITIONS_SNAPSHOT_CHANNEL: &str = "cranpose.recompositions.v1.snapshot";
/// Counters for one live composable instance.
#[derive(Debug, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Recomposition {
/// Instance identity within the preview process.
pub instance_id: u64,
/// Definition and current counter.
#[serde(flatten)]
pub source: Source,
}
/// Live counters independent of the layout tree or inspector node budget.
#[derive(Debug, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Recompositions {
/// Counter protocol version.
pub schema: u32,
/// Request identity used to reject stale responses.
pub request_id: u64,
/// One entry per live composable instance.
pub instances: Vec<Recomposition>,
}
/// Captures opt-in debug preview counters; other builds return no instances.
pub fn recompositions(request_id: u64) -> Recompositions {
Recompositions {
schema: 1,
request_id,
instances: cranpose_core::source_trace::recomposition_snapshot()
.into_iter()
.map(|instance| Recomposition {
instance_id: instance.instance_id,
source: Source {
name: instance.name.to_owned(),
file: instance.file.to_owned(),
line: instance.line,
manifest_dir: instance.manifest_dir.to_owned(),
recompositions: Some(instance.recompositions),
},
})
.collect(),
}
}
/// A property reported by a framework modifier or layout node.
#[derive(Debug, Serialize, PartialEq)]
pub struct Property {
/// Human-readable property name.
pub name: String,
/// Current value, formatted by its owner.
pub value: String,
}
/// An element in a modifier chain, in declaration order.
#[derive(Debug, Serialize, PartialEq)]
pub struct ModifierInfo {
/// Modifier name.
pub name: String,
/// Properties published by the modifier.
pub properties: Vec<Property>,
}
/// A composable definition that contributed to a layout node.
#[derive(Debug, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Source {
/// Function name.
pub name: String,
/// Compiler-reported source file.
pub file: String,
/// One-based declaration line.
pub line: u32,
/// Compiler-reported package directory.
pub manifest_dir: String,
/// Executions after the initial composition of this instance, when tracking is enabled.
#[serde(skip_serializing_if = "Option::is_none")]
pub recompositions: Option<u64>,
}
/// A layout node in preorder, with surface-local logical bounds.
#[derive(Debug, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Node {
/// Identity includes the allocation generation to distinguish recycled nodes.
pub id: String,
/// Parent identity, absent for the root.
pub parent: Option<String>,
/// Layout node classification.
pub kind: String,
/// Text drawn by the node, if any.
pub text: String,
/// Left edge in logical pixels.
pub x: f32,
/// Top edge in logical pixels.
pub y: f32,
/// Width in logical pixels.
pub width: f32,
/// Height in logical pixels.
pub height: f32,
/// Modifier chain in declaration order.
pub modifiers: Vec<ModifierInfo>,
/// Composable origins, outermost first; present in preview builds.
pub sources: Vec<Source>,
}
/// A complete response to one host request, never emitted in the idle frame loop.
#[derive(Debug, Serialize, PartialEq)]
#[serde(rename_all = "camelCase")]
pub struct Snapshot {
/// Protocol schema version.
pub schema: u32,
/// Host request identity, allowing stale responses to be discarded.
pub request_id: u64,
/// Capture duration in microseconds.
pub capture_micros: u64,
/// Whether the node budget cut off part of a large tree.
pub truncated: bool,
/// Primary-surface nodes in preorder.
pub nodes: Vec<Node>,
}
/// Captures the already-laid-out primary surface without rendering another scene.
///
/// `node_budget` bounds work for unusually large trees. Children whose parents
/// were truncated are omitted as well.
pub fn snapshot(tree: Option<&LayoutTree>, request_id: u64, node_budget: usize) -> Snapshot {
let started = std::time::Instant::now();
let mut result = Snapshot {
schema: SCHEMA_VERSION,
request_id,
capture_micros: 0,
truncated: false,
nodes: Vec::new(),
};
let mut stack = tree
.map(|tree| vec![(tree.root(), None)])
.unwrap_or_default();
while let Some((layout, parent)) = stack.pop() {
if result.nodes.len() == node_budget {
result.truncated = true;
break;
}
let node = capture(layout, parent);
for child in layout.children.iter().rev() {
stack.push((child, Some(node.id.clone())));
}
result.nodes.push(node);
}
result.capture_micros = started.elapsed().as_micros().min(u64::MAX as u128) as u64;
result
}
fn capture(layout: &LayoutBox, parent: Option<String>) -> Node {
let text = layout
.node_data
.modifier_slices
.text_content()
.unwrap_or_default()
.to_owned();
let kind = if text.is_empty() {
format!("{:?}", layout.node_data.kind)
} else {
"Text".to_owned()
};
#[cfg(not(feature = "preview"))]
let sources = Vec::new();
#[cfg(feature = "preview")]
let (kind, sources) = {
let mut kind = kind;
let sources: Vec<Source> = layout
.node_data
.source_trace
.iter()
.map(|source| Source {
name: source.name.to_owned(),
file: source.file.to_owned(),
line: source.line,
manifest_dir: source.manifest_dir.to_owned(),
recompositions: source.recompositions(),
})
.collect();
if text.is_empty()
&& let Some(source) = sources.iter().rev().find(|source| source.name != "Layout")
{
kind.clone_from(&source.name);
}
(kind, sources)
};
let modifiers = layout
.node_data
.modifier
.collect_inspector_records()
.into_iter()
.map(|entry| ModifierInfo {
name: entry.name.to_owned(),
properties: entry
.properties
.into_iter()
.map(|property| Property {
name: property.name.to_owned(),
value: property.value,
})
.collect(),
})
.collect();
Node {
id: format!("{}:{}", layout.node_id, layout.node_generation),
parent,
kind,
text,
x: layout.rect.x,
y: layout.rect.y,
width: layout.rect.width,
height: layout.rect.height,
modifiers,
sources,
}
}
#[cfg(test)]
#[path = "tests/inspection_tests.rs"]
mod tests;