fix Enter being swallowed by chat mode-map <return> binding

Author: shohi

CHANGELOG.md

@@ -2,6 +2,7 @@
 
 ## Unreleased
 
+- Bugfix: Enter now works with transient/overriding keymaps that bind only `"RET"` (e.g. Embark's action maps) inside chat buffers. `eca-chat-mode-map` bound the raw `<return>` event, which blocked the `<return>` -> `RET` key translation in GUI frames, so those keymaps' `RET` binding was never reached and the keypress silently fell through to `eca-chat--key-pressed-return` instead; only `RET` is bound now.
 - Restore the rolled-back user message into the prompt field. `Rollback chat to before this message` (when messages are included) used to discard the clicked message's text together with the rest of the turn; the text now lands in the prompt unsent, ready to edit and resend, and any draft already typed in the prompt is kept below it, separated by a blank line.
 - Fall back to the buffer's `xref` backend (eglot, etags with a loaded tags table, any custom backend) for `editor/getDefinition`/`editor/getReferences` when lsp-mode cannot serve the file, instead of answering no-server. `includeDeclaration: false` is honored by filtering definition locations out of the references, since LSP-backed xref backends always include the declaration. (editor-code-assistant/eca#351)
 

eca-chat-expandable.el

@@ -291,7 +291,6 @@ NESTED-PROPS is a plist with :parent-id and :label-indent for nested blocks."
                                             (define-key km (kbd "<mouse-1>") (lambda () (interactive) (eca-chat--expandable-content-toggle id)))
                                             (define-key km (kbd "<tab>") (lambda () (interactive) (eca-chat--expandable-content-toggle id)))
                                             (define-key km (kbd "RET") (lambda () (interactive) (eca-chat--expandable-content-toggle id)))
-                                            (define-key km (kbd "<return>") (lambda () (interactive) (eca-chat--expandable-content-toggle id)))
                                             km)
                                   'help-echo "mouse-1 / tab / RET: expand/collapse"))
     (eca-chat--insert "\n")

eca-chat-image.el

@@ -355,16 +355,11 @@ always use the textual fallback."
              (format "Image (%s, %d bytes) — RET or mouse-2 to save"
                      (or (plist-get image-content :mediaType) "?")
                      (length (image-property image :data))))
-            ;; Bind both `RET' (terminal) and `<return>' (graphical
-            ;; frame function-key event) so RET works regardless of
-            ;; whether the chat mode-map has the function-key bound;
-            ;; otherwise `eca-chat--key-pressed-return' shadows ours.
             (let* ((save-fn (lambda ()
                               (interactive)
                               (eca-chat-save-image-at-point ov)))
                    (map (make-sparse-keymap)))
               (define-key map (kbd "RET") save-fn)
-              (define-key map (kbd "<return>") save-fn)
               (define-key map [mouse-2] save-fn)
               (overlay-put ov 'keymap map))))))
      (parent-tool-call-id

eca-chat.el

@@ -843,7 +843,6 @@ and resume link are not left behind under the replayed messages.")
     (define-key map (kbd "C-<return>") #'eca-chat--key-pressed-queue)
     (define-key map (kbd "C-<up>") #'eca-chat--key-pressed-previous-prompt-history)
     (define-key map (kbd "C-<down>") #'eca-chat--key-pressed-next-prompt-history)
-    (define-key map (kbd "<return>") #'eca-chat--key-pressed-return)
     (define-key map (kbd "RET") #'eca-chat--key-pressed-return)
     (define-key map (kbd "C-c C-<return>") #'eca-chat-send-prompt-at-chat)
     ;; Bind only TAB, never the raw <tab> function-key event: binding
@@ -6237,11 +6236,10 @@ ECA chat state, prompt overlays, and rule-based hints."
 derived from `eca-chat-mode'.  `eca-chat-mode' likely failed to activate." mm)
             hints))
     (when (and in-chat-p
-               (not (eq ret-cmd 'eca-chat--key-pressed-return))
-               (not (eq return-cmd 'eca-chat--key-pressed-return)))
-      (push (format "RET is bound to `%s' (and <return> to `%s'), not \
+               (not (eq ret-cmd 'eca-chat--key-pressed-return)))
+      (push (format "RET is bound to `%s', not \
 `eca-chat--key-pressed-return'.  Another keymap is intercepting RET — see \
-\"Likely shadowing\" below." ret-cmd return-cmd)
+\"Likely shadowing\" below." ret-cmd)
             hints))
     (when (and in-chat-p (null session))
       (push "(eca-session) returned nil from inside the chat buffer — \

test/eca-chat-test.el

@@ -1672,6 +1672,32 @@ does not treat the first line as metadata.  Returns FN's value."
   (it "does not bind the raw <tab> event (#281)"
     (expect (lookup-key eca-chat-mode-map (kbd "<tab>")) :to-be nil)))
 
+;; ---------------------------------------------------------------------------
+;; eca-chat-mode-map RET bindings
+;; ---------------------------------------------------------------------------
+
+(describe "eca-chat-mode-map RET bindings"
+
+  (it "binds RET to eca-chat--key-pressed-return"
+    (expect (lookup-key eca-chat-mode-map (kbd "RET"))
+            :to-be #'eca-chat--key-pressed-return))
+
+  ;; Binding raw <return> would block the <return> -> RET key translation
+  ;; in GUI frames, so transient/overriding keymaps binding only "RET"
+  ;; (e.g. embark-file-map) would never receive Enter.  lookup-key follows
+  ;; the parent map, so this also catches a future <return> binding
+  ;; inherited from markdown-mode-map.
+  (it "does not bind the raw <return> event"
+    (expect (lookup-key eca-chat-mode-map (kbd "<return>")) :to-be nil))
+
+  ;; Modified Enter chords are unaffected: they are distinct events with
+  ;; no ASCII equivalent, so they must stay bound as function keys.
+  (it "still binds the modified <return> chords"
+    (expect (lookup-key eca-chat-mode-map (kbd "S-<return>"))
+            :to-be #'eca-chat--key-pressed-newline)
+    (expect (lookup-key eca-chat-mode-map (kbd "C-<return>"))
+            :to-be #'eca-chat--key-pressed-queue)))
+
 ;; ---------------------------------------------------------------------------
 ;; eca-chat--shell-command-state-face
 ;; ---------------------------------------------------------------------------