Keyboard shortcuts are set on the top-level scaffold (flutter#3458)

Author: elliette

packages/devtools_app/lib/src/debugger/debugger_screen.dart

@@ -44,6 +44,24 @@ class DebuggerScreen extends Screen {
   @override
   bool showConsole(bool embed) => true;
 
+  @override
+  ShortcutsConfiguration buildKeyboardShortcuts(BuildContext context) {
+    final controller = Provider.of<DebuggerController>(context);
+    final shortcuts = <LogicalKeySet, Intent>{
+      goToLineNumberKeySet: GoToLineNumberIntent(context, controller),
+      searchInFileKeySet: SearchInFileIntent(controller),
+      escapeKeySet: EscapeIntent(controller),
+      openFileKeySet: OpenFileIntent(controller),
+    };
+    final actions = <Type, Action<Intent>>{
+      GoToLineNumberIntent: GoToLineNumberAction(),
+      SearchInFileIntent: SearchInFileAction(),
+      EscapeIntent: EscapeAction(),
+      OpenFileIntent: OpenFileAction(),
+    };
+    return ShortcutsConfiguration(shortcuts: shortcuts, actions: actions);
+  }
+
   @override
   String get docPageId => screenId;
 
@@ -161,37 +179,21 @@ class DebuggerScreenBodyState extends State<DebuggerScreenBody>
       },
     );
 
-    return Shortcuts(
-      shortcuts: <LogicalKeySet, Intent>{
-        goToLineNumberKeySet: GoToLineNumberIntent(context, controller),
-        searchInFileKeySet: SearchInFileIntent(controller),
-        escapeKeySet: EscapeIntent(controller),
-        openFileKeySet: OpenFileIntent(controller),
-      },
-      child: Actions(
-        actions: <Type, Action<Intent>>{
-          GoToLineNumberIntent: GoToLineNumberAction(),
-          SearchInFileIntent: SearchInFileAction(),
-          EscapeIntent: EscapeAction(),
-          OpenFileIntent: OpenFileAction(),
-        },
-        child: Split(
-          axis: Axis.horizontal,
-          initialFractions: const [0.25, 0.75],
+    return Split(
+      axis: Axis.horizontal,
+      initialFractions: const [0.25, 0.75],
+      children: [
+        OutlineDecoration(child: debuggerPanes()),
+        Column(
           children: [
-            OutlineDecoration(child: debuggerPanes()),
-            Column(
-              children: [
-                const DebuggingControls(),
-                const SizedBox(height: denseRowSpacing),
-                Expanded(
-                  child: codeArea,
-                ),
-              ],
+            const DebuggingControls(),
+            const SizedBox(height: denseRowSpacing),
+            Expanded(
+              child: codeArea,
             ),
           ],
         ),
-      ),
+      ],
     );
   }
 

packages/devtools_app/lib/src/scaffold.dart

@@ -326,6 +326,7 @@ class DevToolsScaffoldState extends State<DevToolsScaffold>
       ],
     );
     final theme = Theme.of(context);
+
     return Provider<BannerMessagesController>(
       create: (_) => BannerMessagesController(),
       child: Provider<ImportController>.value(
@@ -340,27 +341,32 @@ class DevToolsScaffoldState extends State<DevToolsScaffold>
               // Using theme.primaryColor matches the default behavior of the
               // title used by [WidgetsApp].
               color: theme.primaryColor,
-              child: Scaffold(
-                appBar: widget.embed ? null : _buildAppBar(scaffoldTitle),
-                body: (serviceManager.connectedAppInitialized &&
-                        !offlineController.offlineMode.value &&
-                        _currentScreen.showConsole(widget.embed))
-                    ? Split(
-                        axis: Axis.vertical,
-                        children: [
-                          content,
-                          Padding(
-                            padding: DevToolsScaffold.horizontalPadding,
-                            child: const DebuggerConsole(),
-                          ),
-                        ],
-                        splitters: [
-                          DebuggerConsole.buildHeader(),
-                        ],
-                        initialFractions: const [0.8, 0.2],
-                      )
-                    : content,
-                bottomNavigationBar: widget.embed ? null : _buildStatusLine(),
+              child: KeyboardShortcuts(
+                keyboardShortcuts: _currentScreen.buildKeyboardShortcuts(
+                  context,
+                ),
+                child: Scaffold(
+                  appBar: widget.embed ? null : _buildAppBar(scaffoldTitle),
+                  body: (serviceManager.connectedAppInitialized &&
+                          !offlineController.offlineMode.value &&
+                          _currentScreen.showConsole(widget.embed))
+                      ? Split(
+                          axis: Axis.vertical,
+                          children: [
+                            content,
+                            Padding(
+                              padding: DevToolsScaffold.horizontalPadding,
+                              child: const DebuggerConsole(),
+                            ),
+                          ],
+                          splitters: [
+                            DebuggerConsole.buildHeader(),
+                          ],
+                          initialFractions: const [0.8, 0.2],
+                        )
+                      : content,
+                  bottomNavigationBar: widget.embed ? null : _buildStatusLine(),
+                ),
               ),
             ),
           );
@@ -495,6 +501,31 @@ class DevToolsScaffoldState extends State<DevToolsScaffold>
   }
 }
 
+class KeyboardShortcuts extends StatelessWidget {
+  const KeyboardShortcuts({
+    @required this.keyboardShortcuts,
+    @required this.child,
+  })  : assert(keyboardShortcuts != null),
+        assert(child != null);
+
+  final ShortcutsConfiguration keyboardShortcuts;
+  final Widget child;
+
+  @override
+  Widget build(BuildContext context) {
+    if (keyboardShortcuts.isEmpty) {
+      return child;
+    }
+    return Shortcuts(
+      shortcuts: keyboardShortcuts.shortcuts,
+      child: Actions(
+        actions: keyboardShortcuts.actions,
+        child: child,
+      ),
+    );
+  }
+}
+
 class SimpleScreen extends Screen {
   const SimpleScreen(this.child)
       : super(

packages/devtools_app/lib/src/screen.dart

@@ -67,6 +67,10 @@ abstract class Screen {
   /// Whether to show the console for this screen.
   bool showConsole(bool embed) => false;
 
+  /// Which keyboard shortcuts shoud be enabled for this screen.
+  ShortcutsConfiguration buildKeyboardShortcuts(BuildContext context) =>
+      ShortcutsConfiguration.empty();
+
   final String screenId;
 
   /// The user-facing name of the page.
@@ -304,3 +308,19 @@ class BadgePainter extends CustomPainter {
     return true;
   }
 }
+
+class ShortcutsConfiguration {
+  const ShortcutsConfiguration({
+    @required this.shortcuts,
+    @required this.actions,
+  }) : assert(shortcuts.length == actions.length);
+
+  factory ShortcutsConfiguration.empty() {
+    return ShortcutsConfiguration(shortcuts: {}, actions: {});
+  }
+
+  final Map<ShortcutActivator, Intent> shortcuts;
+  final Map<Type, Action<Intent>> actions;
+
+  bool get isEmpty => shortcuts.isEmpty && actions.isEmpty;
+}