keys/ui_tools: Break down the generalized ENTER command.

Breaks down the ENTER command into more specific commands.
- ACTIVATE_BUTTON
- EXECUTE_SEARCH
- NEW_LINE

Tests and docs updated.

Author: Niloth-p

docs/hotkeys.md

@@ -24,13 +24,13 @@
 |Scroll up|<kbd>PgUp</kbd> / <kbd>K</kbd>|
 |Scroll down|<kbd>PgDn</kbd> / <kbd>J</kbd>|
 |Go to bottom / Last message|<kbd>End</kbd> / <kbd>G</kbd>|
+|Trigger the selected entry|<kbd>Enter</kbd>|
 |Narrow to all messages|<kbd>a</kbd> / <kbd>Esc</kbd>|
 |Narrow to all direct messages|<kbd>P</kbd>|
 |Narrow to all starred messages|<kbd>f</kbd>|
 |Narrow to messages in which you're mentioned|<kbd>#</kbd>|
 |Next unread topic|<kbd>n</kbd>|
 |Next unread direct message|<kbd>p</kbd>|
-|Perform current action|<kbd>Enter</kbd>|
 
 ## Searching
 |Command|Key Combination|
@@ -40,6 +40,7 @@
 |Search streams|<kbd>q</kbd>|
 |Search topics in a stream|<kbd>q</kbd>|
 |Search emojis from emoji picker|<kbd>p</kbd>|
+|Execute the search and go to search results|<kbd>Enter</kbd>|
 
 ## Message actions
 |Command|Key Combination|
@@ -83,6 +84,7 @@
 |Autocomplete @mentions, #stream_names, :emoji: and topics|<kbd>Ctrl</kbd> + <kbd>f</kbd>|
 |Cycle through autocomplete suggestions in reverse|<kbd>Ctrl</kbd> + <kbd>r</kbd>|
 |Narrow to compose box message recipient|<kbd>Meta</kbd> + <kbd>.</kbd>|
+|Insert new line|<kbd>Enter</kbd>|
 
 ## Editor: Navigation
 |Command|Key Combination|

tests/ui_tools/test_boxes.py

@@ -1819,7 +1819,7 @@ def test_valid_char(
     @pytest.mark.parametrize(
         "log, expect_body_focus_set", [([], False), (["SOMETHING"], True)]
     )
-    @pytest.mark.parametrize("enter_key", keys_for_command("ENTER"))
+    @pytest.mark.parametrize("enter_key", keys_for_command("EXECUTE_SEARCH"))
     def test_keypress_ENTER(
         self,
         panel_search_box: PanelSearchBox,

tests/ui_tools/test_buttons.py

@@ -262,7 +262,7 @@ def test_keypress_TOGGLE_MUTE_STREAM(
 
 class TestUserButton:
     # FIXME Place this in a general test of a derived class?
-    @pytest.mark.parametrize("enter_key", keys_for_command("ENTER"))
+    @pytest.mark.parametrize("enter_key", keys_for_command("ACTIVATE_BUTTON"))
     def test_activate_called_once_on_keypress(
         self,
         mocker: MockerFixture,
@@ -358,7 +358,7 @@ def test_init_calls_top_button(
         assert emoji_button.emoji_name == emoji_unit[0]
         assert emoji_button.reaction_count == count
 
-    @pytest.mark.parametrize("key", keys_for_command("ENTER"))
+    @pytest.mark.parametrize("key", keys_for_command("ACTIVATE_BUTTON"))
     @pytest.mark.parametrize(
         "emoji, has_user_reacted, is_selected_final, expected_reaction_count",
         [

tests/ui_tools/test_messages.py

@@ -1961,7 +1961,9 @@ def test_footlinks_limit(self, maximum_footlinks, expected_instance):
         assert isinstance(footlinks, expected_instance)
 
     @pytest.mark.parametrize(
-        "key", keys_for_command("ENTER"), ids=lambda param: f"left_click-key:{param}"
+        "key",
+        keys_for_command("ACTIVATE_BUTTON"),
+        ids=lambda param: f"left_click-key:{param}",
     )
     def test_mouse_event_left_click(
         self, mocker, msg_box, key, widget_size, compose_box_is_open

tests/ui_tools/test_popups.py

@@ -830,7 +830,7 @@ def test_init(self, edit_mode_view: EditModeView) -> None:
             (2, "change_all"),
         ],
     )
-    @pytest.mark.parametrize("key", keys_for_command("ENTER"))
+    @pytest.mark.parametrize("key", keys_for_command("ACTIVATE_BUTTON"))
     def test_select_edit_mode(
         self,
         edit_mode_view: EditModeView,
@@ -1523,7 +1523,7 @@ def test_keypress_exit_popup(
         self.stream_info_view.keypress(size, key)
         assert self.controller.exit_popup.called
 
-    @pytest.mark.parametrize("key", (*keys_for_command("ENTER"), " "))
+    @pytest.mark.parametrize("key", (*keys_for_command("ACTIVATE_BUTTON"), " "))
     def test_checkbox_toggle_mute_stream(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
@@ -1536,7 +1536,7 @@ def test_checkbox_toggle_mute_stream(
 
         toggle_mute_status.assert_called_once_with(stream_id)
 
-    @pytest.mark.parametrize("key", (*keys_for_command("ENTER"), " "))
+    @pytest.mark.parametrize("key", (*keys_for_command("ACTIVATE_BUTTON"), " "))
     def test_checkbox_toggle_pin_stream(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:
@@ -1549,7 +1549,7 @@ def test_checkbox_toggle_pin_stream(
 
         toggle_pin_status.assert_called_once_with(stream_id)
 
-    @pytest.mark.parametrize("key", (*keys_for_command("ENTER"), " "))
+    @pytest.mark.parametrize("key", (*keys_for_command("ACTIVATE_BUTTON"), " "))
     def test_checkbox_toggle_visual_notification(
         self, key: str, widget_size: Callable[[Widget], urwid_Size]
     ) -> None:

zulipterminal/config/keys.py

@@ -91,6 +91,11 @@ class KeyBinding(TypedDict):
         'help_text': 'Go to bottom / Last message',
         'key_category': 'navigation',
     },
+    'ACTIVATE_BUTTON': {
+        'keys': ['enter'],
+        'help_text': 'Trigger the selected entry',
+        'key_category': 'navigation',
+    },
     'REPLY_MESSAGE': {
         'keys': ['r', 'enter'],
         'help_text': 'Reply to the current message',
@@ -244,16 +249,16 @@ class KeyBinding(TypedDict):
         'excluded_from_random_tips': True,
         'key_category': 'searching',
     },
+    'EXECUTE_SEARCH': {
+        'keys': ['enter'],
+        'help_text': 'Execute the search and go to search results',
+        'key_category': 'searching',
+    },
     'TOGGLE_MUTE_STREAM': {
         'keys': ['m'],
         'help_text': 'Mute/unmute streams',
         'key_category': 'stream_list',
     },
-    'ENTER': {
-        'keys': ['enter'],
-        'help_text': 'Perform current action',
-        'key_category': 'navigation',
-    },
     'THUMBS_UP': {
         'keys': ['+'],
         'help_text': 'Toggle thumbs-up reaction to the current message',
@@ -400,6 +405,14 @@ class KeyBinding(TypedDict):
         'help_text': 'Swap with previous character',
         'key_category': 'editor_text_manipulation',
     },
+    'NEW_LINE': {
+        # urwid_readline's command
+        # This obvious hotkey is added to clarify against 'enter' to send
+        # and to differentiate from other hotkeys using 'enter'.
+        'keys': ['enter'],
+        'help_text': 'Insert new line',
+        'key_category': 'msg_compose',
+    },
     'FULL_RENDERED_MESSAGE': {
         'keys': ['f'],
         'help_text': 'Show/hide full rendered message (from message information)',

zulipterminal/ui_tools/boxes.py

@@ -947,14 +947,14 @@ def main_view(self) -> Any:
 
     def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if (
-            is_command_key("ENTER", key) and self.text_box.edit_text == ""
+            is_command_key("EXECUTE_SEARCH", key) and self.text_box.edit_text == ""
         ) or is_command_key("GO_BACK", key):
             self.text_box.set_edit_text("")
             self.controller.exit_editor_mode()
             self.controller.view.middle_column.set_focus("body")
             return key
 
-        elif is_command_key("ENTER", key):
+        elif is_command_key("EXECUTE_SEARCH", key):
             self.controller.exit_editor_mode()
             self.controller.search_messages(self.text_box.edit_text)
             self.controller.view.middle_column.set_focus("body")
@@ -1003,15 +1003,15 @@ def valid_char(self, ch: str) -> bool:
 
     def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
         if (
-            is_command_key("ENTER", key) and self.get_edit_text() == ""
+            is_command_key("EXECUTE_SEARCH", key) and self.get_edit_text() == ""
         ) or is_command_key("GO_BACK", key):
             self.panel_view.view.controller.exit_editor_mode()
             self.reset_search_text()
             self.panel_view.set_focus("body")
             # Don't call 'Esc' when inside a popup search-box.
             if not self.panel_view.view.controller.is_any_popup_open():
                 self.panel_view.keypress(size, primary_key_for_command("GO_BACK"))
-        elif is_command_key("ENTER", key) and not self.panel_view.empty_search:
+        elif is_command_key("EXECUTE_SEARCH", key) and not self.panel_view.empty_search:
             self.panel_view.view.controller.exit_editor_mode()
             self.set_caption([("filter_results", " Search Results "), " "])
             self.panel_view.set_focus("body")

zulipterminal/ui_tools/buttons.py

@@ -120,7 +120,7 @@ def activate(self, key: Any) -> None:
         self.show_function()
 
     def keypress(self, size: urwid_Size, key: str) -> Optional[str]:
-        if is_command_key("ENTER", key):
+        if is_command_key("ACTIVATE_BUTTON", key):
             self.activate(key)
             return None
         else:  # This is in the else clause, to avoid multiple activation
@@ -417,7 +417,7 @@ def mouse_event(
         self, size: urwid_Size, event: str, button: int, col: int, row: int, focus: int
     ) -> bool:
         if event == "mouse press" and button == 1:
-            self.keypress(size, primary_key_for_command("ENTER"))
+            self.keypress(size, primary_key_for_command("ACTIVATE_BUTTON"))
             return True
         return super().mouse_event(size, event, button, col, row, focus)
 

zulipterminal/ui_tools/messages.py

@@ -898,7 +898,7 @@ def mouse_event(
         if event == "mouse press" and button == 1:
             if self.model.controller.is_in_editor_mode():
                 return True
-            self.keypress(size, primary_key_for_command("ENTER"))
+            self.keypress(size, primary_key_for_command("ACTIVATE_BUTTON"))
             return True
 
         return super().mouse_event(size, event, button, col, row, focus)

zulipterminal/ui_tools/views.py

@@ -1740,7 +1740,11 @@ def __init__(self, controller: Any, button: Any) -> None:
         for mode in EDIT_MODE_CAPTIONS:
             self.add_radio_button(mode)
         super().__init__(
-            controller, self.widgets, "ENTER", 62, "Topic edit propagation mode"
+            controller,
+            self.widgets,
+            "ACTIVATE_BUTTON",
+            62,
+            "Topic edit propagation mode",
         )
         # Set cursor to marked checkbox.
         for i in range(len(self.widgets)):