-
Notifications
You must be signed in to change notification settings - Fork 306
/
inspector_screen.dart
359 lines (318 loc) · 10.7 KB
/
inspector_screen.dart
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
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
// Copyright 2019 The Chromium Authors. All rights reserved.
// Use of this source code is governed by a BSD-style license that can be
// found in the LICENSE file.
import 'dart:collection';
import 'package:flutter/foundation.dart';
import 'package:flutter/material.dart';
import 'package:provider/provider.dart';
import '../analytics/analytics.dart' as ga;
import '../analytics/constants.dart' as analytics_constants;
import '../auto_dispose_mixin.dart';
import '../blocking_action_mixin.dart';
import '../common_widgets.dart';
import '../connected_app.dart';
import '../debugger/debugger_controller.dart';
import '../error_badge_manager.dart';
import '../globals.dart';
import '../screen.dart';
import '../service_extensions.dart' as extensions;
import '../split.dart';
import '../theme.dart';
import '../ui/icons.dart';
import '../ui/service_extension_widgets.dart';
import 'inspector_controller.dart';
import 'inspector_screen_details_tab.dart';
import 'inspector_service.dart';
import 'inspector_tree_controller.dart';
class InspectorScreen extends Screen {
const InspectorScreen()
: super.conditional(
id: id,
requiresLibrary: flutterLibraryUri,
requiresDebugBuild: true,
title: 'Flutter Inspector',
icon: Octicons.deviceMobile,
);
static const id = 'inspector';
// There is not enough room to safely show the console in the embed view of
// the DevTools and IDEs have their own consoles.
@override
bool showConsole(bool embed) => !embed;
@override
String get docPageId => screenId;
@override
Widget build(BuildContext context) => const InspectorScreenBody();
}
class InspectorScreenBody extends StatefulWidget {
const InspectorScreenBody();
@override
InspectorScreenBodyState createState() => InspectorScreenBodyState();
}
class InspectorScreenBodyState extends State<InspectorScreenBody>
with BlockingActionMixin, AutoDisposeMixin {
bool _expandCollapseSupported = false;
bool _layoutExplorerSupported = false;
InspectorController inspectorController;
InspectorTreeController get summaryTreeController =>
inspectorController?.inspectorTree;
InspectorTreeController get detailsTreeController =>
inspectorController?.details?.inspectorTree;
DebuggerController _debuggerController;
bool get enableButtons => actionInProgress == false;
static const summaryTreeKey = Key('Summary Tree');
static const detailsTreeKey = Key('Details Tree');
static const minScreenWidthForTextBeforeScaling = 900.0;
static const unscaledIncludeRefreshTreeWidth = 1255.0;
static const serviceExtensionButtonsIncludeTextWidth = 1160.0;
@override
void initState() {
super.initState();
ga.screen(InspectorScreen.id);
if (serviceManager.inspectorService == null) {
// The app must not be a Flutter app.
return;
}
inspectorController = InspectorController(
inspectorTree: InspectorTreeController(),
detailsTree: InspectorTreeController(),
treeType: FlutterTreeType.widget,
onExpandCollapseSupported: _onExpandCollapseSupported,
onLayoutExplorerSupported: _onLayoutExplorerSupported,
);
}
void _onExpandClick() {
blockWhileInProgress(inspectorController.expandAllNodesInDetailsTree);
}
void _onResetClick() {
blockWhileInProgress(inspectorController.collapseDetailsToSelected);
}
@override
void didChangeDependencies() {
super.didChangeDependencies();
_debuggerController = Provider.of<DebuggerController>(context);
}
@override
Widget build(BuildContext context) {
final summaryTree = _buildSummaryTreeColumn(_debuggerController);
final detailsTree = InspectorTree(
key: detailsTreeKey,
controller: detailsTreeController,
debuggerController: _debuggerController,
);
final splitAxis = Split.axisFor(context, 0.85);
final widgetTrees = Split(
axis: splitAxis,
initialFractions: const [0.33, 0.67],
children: [
summaryTree,
InspectorDetailsTabController(
detailsTree: detailsTree,
controller: inspectorController,
actionButtons: _expandCollapseButtons(),
layoutExplorerSupported: _layoutExplorerSupported,
),
],
);
return Column(
children: <Widget>[
Row(
crossAxisAlignment: CrossAxisAlignment.start,
children: [
ValueListenableBuilder(
valueListenable: serviceManager.serviceExtensionManager
.hasServiceExtension(
extensions.toggleSelectWidgetMode.extension),
builder: (_, selectModeSupported, __) {
return ServiceExtensionButtonGroup(
extensions: [
selectModeSupported
? extensions.toggleSelectWidgetMode
: extensions.toggleOnDeviceWidgetInspector
],
minScreenWidthForTextBeforeScaling:
minScreenWidthForTextBeforeScaling,
);
},
),
const SizedBox(width: denseSpacing),
IconLabelButton(
onPressed: _refreshInspector,
icon: Icons.refresh,
label: 'Refresh Tree',
color: Theme.of(context).colorScheme.serviceExtensionButtonsTitle,
minScreenWidthForTextBeforeScaling:
unscaledIncludeRefreshTreeWidth,
),
const Spacer(),
Row(children: getServiceExtensionWidgets()),
],
),
const SizedBox(height: denseRowSpacing),
Expanded(
child: widgetTrees,
),
],
);
}
Widget _buildSummaryTreeColumn(
DebuggerController debuggerController,
) {
return OutlineDecoration(
child: ValueListenableBuilder(
valueListenable: serviceManager.errorBadgeManager
.erroredItemsForPage(InspectorScreen.id),
builder: (_, LinkedHashMap<String, DevToolsError> errors, __) {
final inspectableErrors = errors.map(
(key, value) => MapEntry(key, value as InspectableWidgetError));
return Stack(
children: [
InspectorTree(
key: summaryTreeKey,
controller: summaryTreeController,
isSummaryTree: true,
widgetErrors: inspectableErrors,
debuggerController: debuggerController,
),
if (errors.isNotEmpty && inspectorController != null)
ValueListenableBuilder(
valueListenable: inspectorController.selectedErrorIndex,
builder: (_, selectedErrorIndex, __) => Positioned(
top: 0,
right: 0,
child: ErrorNavigator(
errors: inspectableErrors,
errorIndex: selectedErrorIndex,
onSelectError: inspectorController.selectErrorByIndex,
),
),
)
],
);
},
),
);
}
List<Widget> getServiceExtensionWidgets() {
return [
ServiceExtensionButtonGroup(
minScreenWidthForTextBeforeScaling:
serviceExtensionButtonsIncludeTextWidth,
extensions: [
extensions.slowAnimations,
extensions.debugPaint,
extensions.debugPaintBaselines,
extensions.repaintRainbow,
extensions.invertOversizedImages,
],
),
// TODO(jacobr): implement TogglePlatformSelector.
// TogglePlatformSelector().selector
];
}
Widget _expandCollapseButtons() {
if (!_expandCollapseSupported) return null;
return Align(
alignment: Alignment.centerRight,
child: Row(
mainAxisAlignment: MainAxisAlignment.end,
mainAxisSize: MainAxisSize.min,
children: [
SizedBox(
child: IconLabelButton(
icon: Icons.unfold_more,
onPressed: enableButtons ? _onExpandClick : null,
label: 'Expand all',
minScreenWidthForTextBeforeScaling:
minScreenWidthForTextBeforeScaling,
),
),
const SizedBox(width: denseSpacing),
SizedBox(
child: IconLabelButton(
icon: Icons.unfold_less,
onPressed: enableButtons ? _onResetClick : null,
label: 'Collapse to selected',
minScreenWidthForTextBeforeScaling:
minScreenWidthForTextBeforeScaling,
),
)
],
),
);
}
void _onExpandCollapseSupported() {
setState(() {
_expandCollapseSupported = true;
});
}
void _onLayoutExplorerSupported() {
setState(() {
_layoutExplorerSupported = true;
});
}
void _refreshInspector() {
ga.select(analytics_constants.inspector, analytics_constants.refresh);
blockWhileInProgress(() async {
await inspectorController?.onForceRefresh();
});
}
}
class ErrorNavigator extends StatelessWidget {
const ErrorNavigator({
Key key,
@required this.errors,
@required this.errorIndex,
@required this.onSelectError,
}) : super(key: key);
final LinkedHashMap<String, InspectableWidgetError> errors;
final int errorIndex;
final Function(int) onSelectError;
@override
Widget build(BuildContext context) {
final label = errorIndex != null
? 'Error ${errorIndex + 1}/${errors.length}'
: 'Errors: ${errors.length}';
return Container(
color: devtoolsError,
child: Padding(
padding: const EdgeInsets.symmetric(
horizontal: defaultSpacing,
vertical: denseSpacing,
),
child: Row(
children: [
Padding(
padding: const EdgeInsets.only(right: denseSpacing),
child: Text(label),
),
IconButton(
padding: EdgeInsets.zero,
constraints: const BoxConstraints(),
splashRadius: defaultIconSize,
icon: const Icon(Icons.keyboard_arrow_up),
onPressed: _previousError,
),
IconButton(
padding: EdgeInsets.zero,
constraints: const BoxConstraints(),
splashRadius: defaultIconSize,
icon: const Icon(Icons.keyboard_arrow_down),
onPressed: _nextError,
),
],
),
),
);
}
void _previousError() {
var newIndex = errorIndex == null ? errors.length - 1 : errorIndex - 1;
while (newIndex < 0) {
newIndex += errors.length;
}
onSelectError(newIndex);
}
void _nextError() {
final newIndex = errorIndex == null ? 0 : (errorIndex + 1) % errors.length;
onSelectError(newIndex);
}
}