add support for remapped and aliased modes #9
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This patch tries to make `bind-map` aware of two ways in which major modes can be remapped: via aliasing or via `major-mode-remap-alist`. The motivating scenario is AUCTeX, which as of version 14.0.1 has renamed several major modes, e.g., latex-mode has been renamed as LaTeX-mode. AUCTeX attempts to offer backwards compatibility using a mix of remapping and aliasing. For users of emacs < 29, `latex-mode` is redefined as an alias for `LaTeX-mode`, whereas for users of emacs 29+, `latex-mode` is remapped to `LaTeX-mode` using `major-mode-remap-alist`. However, if a user had configured keymaps for `latex-mode` using `bind-map`, they will not be available in `LaTeX-mode`. This is especially problematic for distributions like `spacemacs` which need to support users of both old and new AUCTeX (see syl20bnr/spacemacs#16282 for more discussion). This patch introduces two new customizable options, `bind-map-use-remapped-modes` and `bind-map-use-aliased-modes`. Both options default to `t`, in which case when `bind-map` is deciding whether to activate a given keymap, it will compare the value of `major-mode` to not only the symbol for which the keymap was configured configured (e.g., `latex-mode`), but any remapped or aliased modes (e.g., `'(latex-mode LaTeX-mode)`. This logic is implemented in the new (private) function `bind-map--lookup-major-modes` to facilitate lookup of applicable major-modes on the fly. As a result, if a user adjusts `major-mode-remap-alist` or adjusts aliased, `bind-map`'s behavior will change accordingly.
dankessler
force-pushed
the
feat-remap-aliased-modes
branch
from
7714881 to
87a193f
Compare
|
Thanks. It looks ok to me. |
|
Oh shoot, I used |
This was referenced Mar 8, 2024
fnussbaum
added a commit
to fnussbaum/emacs-bind-map
that referenced
this pull request
Dec 11, 2024
Emacs 30 introduces `major-mode-remap-defaults`, and in particular the auctex remappings are moved to this new variable (from the user option `major-mode-remap-alist`). Hence it is necessary to fix `bind-map--lookup-major-modes` which was added in justbur#9. Emacs 30 also provides the accessor function `major-mode-remap` with the following definition: ```elisp (defun major-mode-remap (mode) "Return the function to use to enable MODE." (or (cdr (or (assq mode major-mode-remap-alist) (assq mode major-mode-remap-defaults))) mode)) ```
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This patch tries to make
bind-mapaware of two ways in which major modes can be remapped: via aliasing or viamajor-mode-remap-alist.The motivating scenario is AUCTeX, which as of version 14.0.1 has renamed several major modes, e.g., latex-mode has been renamed as LaTeX-mode. AUCTeX attempts to offer backwards compatibility using a mix of remapping and aliasing. For users of emacs < 29,
latex-modeis redefined as an alias forLaTeX-mode, whereas for users of emacs 29+,latex-modeis remapped toLaTeX-modeusingmajor-mode-remap-alist.However, if a user had configured keymaps for
latex-modeusingbind-map, they will not be available inLaTeX-mode. This is especially problematic for distributions likespacemacswhich need to support users of both old and new AUCTeX (see syl20bnr/spacemacs#16282 for more discussion).This patch introduces two new customizable options,
bind-map-use-remapped-modesandbind-map-use-aliased-modes. Both options default tot, in which case whenbind-mapis deciding whether to activate a given keymap, it will compare the value ofmajor-modeto not only the symbol for which the keymap was configured configured (e.g.,latex-mode), but any remapped or aliased modes (e.g.,'(latex-mode LaTeX-mode). This logic is implemented in the new (private) functionbind-map--lookup-major-modesto facilitate lookup of applicable major-modes on the fly. As a result, if a user adjustsmajor-mode-remap-alistor adjusts aliased,bind-map's behavior will change accordingly.