Refactor highlight handling in FocusManager #119075
Conversation
|
It looks like this pull request may not have tests. Please make sure to add tests before merging. If you need an exemption to this rule, contact Hixie on the #hackers channel in Chat (don't just cc him here, he won't see it! He's on Discord!). If you are not sure if you need tests, consider this rule of thumb: the purpose of a test is to make sure someone doesn't accidentally revert the fix. Ask yourself, is there anything in your PR that you feel it is important we not accidentally revert back to how it was before your fix? Reviewers: Read the Tree Hygiene page and make sure this patch meets those guidelines before LGTMing. |
|
test-exempt: code refactor with no semantic change |
| if (_markedForFocus == node) { | ||
| _markedForFocus = null; | ||
| } | ||
| _dirtyNodes.remove(node); | ||
| _pendingAutofocuses.removeWhere((_Autofocus autofocus) => autofocus.autofocusNode == node || autofocus.scope == node); |
There was a problem hiding this comment.
Is this new/changed functionality that should be tested?
There was a problem hiding this comment.
Oh! Yes, although I actually meant for that to be in another PR (later). I'll remove it for now.
I think this is something that should be happening, but currently isn't being done.
| // A class to detect and manage the highlight mode transitions. | ||
| // An instance of this is owned by the FocusManager. | ||
| class _HighlightModeManager { | ||
| _HighlightModeManager(); |
There was a problem hiding this comment.
Do you need this empty constructor? Actually kinds surprised that no lint is flagging this...
There was a problem hiding this comment.
No, I guess not. Will remove.
Yes, kind of odd that there's no lint.
|
|
||
| /// Remove a previously registered closure from the list of closures that the | ||
| /// [FocusManager] notifies. | ||
| void removeListener(ValueChanged<FocusHighlightMode> listener) => _listeners.remove(listener); |
There was a problem hiding this comment.
add/removeListener appears to be operating on the static _emptyListeners list instead of an instance variable since _listeners is never set to anything but the static _emptyListeners. That's probably not intended?
There was a problem hiding this comment.
Ooh, good catch. If I could have made the empty one const, I would have. Instead of the static empty list, I decided to just re-init the _listeners to a new empty list when it gets disposed, so that there's no chance that something will operate on a static list, inserting things while disposed, making all disposed instances point to the same (now non-empty!) list.
| GestureBinding.instance.pointerRouter.removeGlobalRoute(handlePointerEvent); | ||
| ServicesBinding.instance.keyEventManager.keyMessageHandler = null; | ||
| } | ||
| _listeners = _emptyListeners; |
There was a problem hiding this comment.
See other comment, I believe even before this line, _listeners always equals to _emptyListeners.
| } | ||
|
|
||
| @pragma('vm:notify-debugger-on-exception') | ||
| void notifyListeners() { |
There was a problem hiding this comment.
Is there a reason this class can't just extend/mixin ChangeNotifier instead of re-implementing that functionality?
There was a problem hiding this comment.
If there is a reason, maybe document it?
There was a problem hiding this comment.
Yes, because ChangeNotifier doesn't provide the modified value in the callback. I'll add some docs.
462851d to
c08e85c
Compare
c08e85c to
9691a5a
Compare
|
auto label is removed for flutter/flutter, pr: 119075, due to - The status or check suite Mac build_tests_2_4 has failed. Please fix the issues identified (or deflake) before re-applying this label. |
* 3735231 Cleanup old Dart SDK layout compatibility (flutter/flutter#118819) * 4d25030 Add leak_tracker as dev_dependency. (flutter/flutter#118952) * e3c51a2 Add Windows unit tests to plugin template (flutter/flutter#118638) * d20dd9e Roll Flutter Engine from 7d3233d26d09 to 71ee5f19bc16 (15 revisions) (flutter/flutter#119081) * 5dabe10 Fix path name to discover debug apk on add2app builds (flutter/flutter#117999) * 50ed8a3 Enable `unnecessary_null_comparison` check (flutter/flutter#118849) * 455e6ac Test integration test apps' runner files against current template app (flutter/flutter#118646) * a788e1b Roll Flutter Engine from 71ee5f19bc16 to 59ea78bfabda (2 revisions) (flutter/flutter#119087) * c35370c Roll Flutter Engine from 59ea78bfabda to 2499a5d9fca7 (2 revisions) (flutter/flutter#119089) * 2f0dd56 Refactor highlight handling in FocusManager (flutter/flutter#119075) * 2759f3f Roll Flutter Engine from 2499a5d9fca7 to d98926c32ee7 (2 revisions) (flutter/flutter#119090) * 760fb21 Roll Flutter Engine from d98926c32ee7 to bec40654a5d7 (2 revisions) (flutter/flutter#119093) * bbca694 Roll Flutter Engine from bec40654a5d7 to 5405f2c26e85 (2 revisions) (flutter/flutter#119095) * 6414c36 f1464b49c Manually roll ANGLE, vulkan-deps, SwiftShader (flutter/engine#38650) (flutter/flutter#119097) * 426cdd9 55bb8deaf [Impeller] Linear sample atlas glyphs when the CTM isn't translation/scale only (flutter/engine#39112) (flutter/flutter#119098) * 83c3a61 Only emit image painting events in debug & profile modes. (flutter/flutter#118872) * b113df2 bffb98352 Roll Skia from b72fececbdcc to 8ffd5c20d634 (3 revisions) (flutter/engine#39114) (flutter/flutter#119099) * 351466a Add Decoding Flutter videos to API docs (flutter/flutter#116454) * 318f875 Pass through magnifierConfiguration (flutter/flutter#118270) * eced23e d39ab638b Roll Fuchsia Mac SDK from MUvFS0baOnigVUIND... to _H53AyDxR9Pm2TbwN... (flutter/engine#39122) (flutter/flutter#119126) * 29ab437 Add Material 3 `CheckboxListTile` example and update existing examples (flutter/flutter#118792) * a815ee6 8efc7183b Roll Skia from 8ffd5c20d634 to da5034f9d117 (4 revisions) (flutter/engine#39123) (flutter/flutter#119129)
* 3735231 Cleanup old Dart SDK layout compatibility (flutter/flutter#118819) * 4d25030 Add leak_tracker as dev_dependency. (flutter/flutter#118952) * e3c51a2 Add Windows unit tests to plugin template (flutter/flutter#118638) * d20dd9e Roll Flutter Engine from 7d3233d26d09 to 71ee5f19bc16 (15 revisions) (flutter/flutter#119081) * 5dabe10 Fix path name to discover debug apk on add2app builds (flutter/flutter#117999) * 50ed8a3 Enable `unnecessary_null_comparison` check (flutter/flutter#118849) * 455e6ac Test integration test apps' runner files against current template app (flutter/flutter#118646) * a788e1b Roll Flutter Engine from 71ee5f19bc16 to 59ea78bfabda (2 revisions) (flutter/flutter#119087) * c35370c Roll Flutter Engine from 59ea78bfabda to 2499a5d9fca7 (2 revisions) (flutter/flutter#119089) * 2f0dd56 Refactor highlight handling in FocusManager (flutter/flutter#119075) * 2759f3f Roll Flutter Engine from 2499a5d9fca7 to d98926c32ee7 (2 revisions) (flutter/flutter#119090) * 760fb21 Roll Flutter Engine from d98926c32ee7 to bec40654a5d7 (2 revisions) (flutter/flutter#119093) * bbca694 Roll Flutter Engine from bec40654a5d7 to 5405f2c26e85 (2 revisions) (flutter/flutter#119095) * 6414c36 f1464b49c Manually roll ANGLE, vulkan-deps, SwiftShader (flutter/engine#38650) (flutter/flutter#119097) * 426cdd9 55bb8deaf [Impeller] Linear sample atlas glyphs when the CTM isn't translation/scale only (flutter/engine#39112) (flutter/flutter#119098) * 83c3a61 Only emit image painting events in debug & profile modes. (flutter/flutter#118872) * b113df2 bffb98352 Roll Skia from b72fececbdcc to 8ffd5c20d634 (3 revisions) (flutter/engine#39114) (flutter/flutter#119099) * 351466a Add Decoding Flutter videos to API docs (flutter/flutter#116454) * 318f875 Pass through magnifierConfiguration (flutter/flutter#118270) * eced23e d39ab638b Roll Fuchsia Mac SDK from MUvFS0baOnigVUIND... to _H53AyDxR9Pm2TbwN... (flutter/engine#39122) (flutter/flutter#119126) * 29ab437 Add Material 3 `CheckboxListTile` example and update existing examples (flutter/flutter#118792) * a815ee6 8efc7183b Roll Skia from 8ffd5c20d634 to da5034f9d117 (4 revisions) (flutter/engine#39123) (flutter/flutter#119129)
* 3735231 Cleanup old Dart SDK layout compatibility (flutter/flutter#118819) * 4d25030 Add leak_tracker as dev_dependency. (flutter/flutter#118952) * e3c51a2 Add Windows unit tests to plugin template (flutter/flutter#118638) * d20dd9e Roll Flutter Engine from 7d3233d26d09 to 71ee5f19bc16 (15 revisions) (flutter/flutter#119081) * 5dabe10 Fix path name to discover debug apk on add2app builds (flutter/flutter#117999) * 50ed8a3 Enable `unnecessary_null_comparison` check (flutter/flutter#118849) * 455e6ac Test integration test apps' runner files against current template app (flutter/flutter#118646) * a788e1b Roll Flutter Engine from 71ee5f19bc16 to 59ea78bfabda (2 revisions) (flutter/flutter#119087) * c35370c Roll Flutter Engine from 59ea78bfabda to 2499a5d9fca7 (2 revisions) (flutter/flutter#119089) * 2f0dd56 Refactor highlight handling in FocusManager (flutter/flutter#119075) * 2759f3f Roll Flutter Engine from 2499a5d9fca7 to d98926c32ee7 (2 revisions) (flutter/flutter#119090) * 760fb21 Roll Flutter Engine from d98926c32ee7 to bec40654a5d7 (2 revisions) (flutter/flutter#119093) * bbca694 Roll Flutter Engine from bec40654a5d7 to 5405f2c26e85 (2 revisions) (flutter/flutter#119095) * 6414c36 f1464b49c Manually roll ANGLE, vulkan-deps, SwiftShader (flutter/engine#38650) (flutter/flutter#119097) * 426cdd9 55bb8deaf [Impeller] Linear sample atlas glyphs when the CTM isn't translation/scale only (flutter/engine#39112) (flutter/flutter#119098) * 83c3a61 Only emit image painting events in debug & profile modes. (flutter/flutter#118872) * b113df2 bffb98352 Roll Skia from b72fececbdcc to 8ffd5c20d634 (3 revisions) (flutter/engine#39114) (flutter/flutter#119099) * 351466a Add Decoding Flutter videos to API docs (flutter/flutter#116454) * 318f875 Pass through magnifierConfiguration (flutter/flutter#118270) * eced23e d39ab638b Roll Fuchsia Mac SDK from MUvFS0baOnigVUIND... to _H53AyDxR9Pm2TbwN... (flutter/engine#39122) (flutter/flutter#119126) * 29ab437 Add Material 3 `CheckboxListTile` example and update existing examples (flutter/flutter#118792) * a815ee6 8efc7183b Roll Skia from 8ffd5c20d634 to da5034f9d117 (4 revisions) (flutter/engine#39123) (flutter/flutter#119129)
Description
This refactors the highlight mode management in the FocusManager to separate it out into a separate private class. The public API hasn't changed, but this separates the responsibilities so it's easier to tell what part of the code is focus management and which part is highlight management. They're linked in that they both operate off of the same key event stream, but they probably should have been separate from the beginning.
Tests