bug#25187: Initialization of `shell-mode-map' is not safe

bug#25187: Initialization of `shell-mode-map' is not safe

[Alexander Shukaev]

Hi,

consider

(defvar shell-mode-map
   (let ((map (nconc (make-sparse-keymap) comint-mode-map)))
     (define-key map "\C-c\C-f" 'shell-forward-command)
     (define-key map "\C-c\C-b" 'shell-backward-command)
     (define-key map "\t" 'completion-at-point)
     (define-key map (kbd "M-RET") 'shell-resync-dirs)
     (define-key map "\M-?" 'comint-dynamic-list-filename-completions)
     (define-key map [menu-bar completion]
       (cons "Complete"
	    (copy-keymap (lookup-key comint-mode-map [menu-bar completion]))))
     (define-key-after (lookup-key map [menu-bar completion])
       [complete-env-variable] '("Complete Env. Variable Name" .
				shell-dynamic-complete-environment-variable)
       'complete-file)
     (define-key-after (lookup-key map [menu-bar completion])
       [expand-directory] '("Expand Directory Reference" .
			   shell-replace-by-expanded-directory)
       'complete-expand)
     map))

from 'shell.el'.  When somebody decides to customize `comint-mode-map' 
by, for example, first wiping it out and then filling it again,

(with-eval-after-load 'comint	
   ;; Wipe `comint-mode-map':
   (setcdr comint-mode-map nil)
   ;; Fill `comint-mode-map':
   ...)

then when the `shell' feature is loaded, it will inevitably fail because 
`(lookup-key comint-mode-map [menu-bar completion])' may no longer 
return a keymap but rather nil or a number.

Looking forward for fix.

Regards,
Alexander

bug#25187: Initialization of `shell-mode-map' is not safe

[Lars Ingebrigtsen]

Alexander Shukaev <emacs@Alexander.Shukaev.name> writes:

> consider
>
> (defvar shell-mode-map
>   (let ((map (nconc (make-sparse-keymap) comint-mode-map)))

[...]

> from 'shell.el'.  When somebody decides to customize `comint-mode-map'
> by, for example, first wiping it out and then filling it again,
>
> (with-eval-after-load 'comint	
>   ;; Wipe `comint-mode-map':
>   (setcdr comint-mode-map nil)
>   ;; Fill `comint-mode-map':
>   ...)
>
> then when the `shell' feature is loaded, it will inevitably fail
> because `(lookup-key comint-mode-map [menu-bar completion])' may no
> longer return a keymap but rather nil or a number.

I've now fixed this in Emacs 27 by just removing the nconc from the
shell mode map -- shell-mode is derived from comint-mode, so it
automatically inherits its map.

-- 
(domestic pets only, the antidote for overdose, milk.)
   bloggy blog: http://lars.ingebrigtsen.no