Comment puis-je hériter du mode prog, tout en prenant en charge les anciens emacsen?

J'écris un mode majeur pour un langage de programmation, mais je veux prendre en charge les anciennes versions d'Emacs. prog-modeest relativement nouveau. Je veux hériter de prog-modesi c'est défini, mais toujours faire quelque chose de sensé autrement.

Quelle est la meilleure approche? Dois-je defalias prog-modeutiliser un Emacsen plus ancien, ou cela interférera-t-il avec d'autres modes s'ils font la même chose?

Au prix d'une liaison de symboles de niveau supérieur supplémentaire, il existe une solution très soignée qui évite de répéter le define-derived-modeformulaire:

(defalias 'my-fancy-parent-mode
  (if (fboundp 'prog-mode) 'prog-mode 'fundamental-mode))

(define-derived-mode my-fancy-mode my-fancy-parent-mode
   ...)

Fonctionne très bien dans n'importe quel Emacs> = 23. J'ai proposé cela haml-modeil y a quelques années à l'IIRC, et il semble s'être propagé de là à plusieurs autres modes majeurs. La principale chose que la define-derived-modemacro fait avec le symbole du mode parent est de générer du code qui appelle sa fonction: dans ce sens, defaliasrend la nouvelle variable exactement équivalente à la fonction aliasée.

Une mise en garde est que cela peut prêter à confusion derived-mode-p, donc le code qui vérifie si votre mode est dérivé prog-modepeut ne pas fonctionner correctement. En pratique, je n'ai rencontré aucun problème: il est plus courant qu'un tel code s'y accroche prog-mode-hook, qui est toujours exécuté.

(Comme Jorgen le souligne dans les commentaires, define-derived-modeutilise également la mode-classpropriété du symbole du mode parent et defaliasne la copiera pas. Au moment de la rédaction, cette propriété ne semble être utilisée que pourspecial-mode .)

Mise à jour: ces jours-ci, je suggère simplement d'exiger au moins Emacs 24, car les anciennes versions sont obsolètes depuis longtemps.

tl; dr: utilisez ifet votre propre fonction init:

(if (fboundp 'prog-mode)
    (define-derived-mode your-cool-mode prog-mode "Cool"
      "Docstring"
      (your-cool--init))
  (define-derived-mode your-cool-mode nil "Cool"
    "Docstring"
    (your-cool--init)))

Effectuez ensuite toute l'initialisation du mode your-cool-init.

Explication plus longue:

Le problème est que la manière officielle d'écrire un mode majeur dérivé est d'utiliser la define-derived-modemacro:

(define-derived-mode your-cool-mode prog-mode ...)

Sur les anciens Emacsen (pré-24), cela se brise quand prog-mode. Et vous ne pouvez pas l'utiliser (if (fboundp 'prog-mode) ...)parce que la macro attend un symbole littéral et le citera pour vous dans l'extension.

define-derived-modeutilise le parent de multiples façons. Vous devez copier tous ceux-ci dans votre propre définition de mode pour les utiliser, et c'est à la fois fastidieux et sujet aux erreurs.

La seule façon est donc d'utiliser deux define-derived-modeinstructions différentes , selon qu'elles prog-modeexistent ou non. Cela vous pose le problème d'écrire deux fois votre code d'initialisation. Ce qui est bien sûr mauvais, alors vous extrayez cela dans sa propre fonction, comme décrit ci-dessus.

(La meilleure solution est bien sûr de supprimer le support pour 23.x et d'utiliser la portée lexicale. Mais je suppose que vous avez déjà envisagé et abandonné cette option. :-))

Je pense que les tests utilisant ont fboundpplus de sens.

(if (fboundp 'prog-mode)
    ...
   ...)

Vous pouvez définir une macro wrapper pour define-derived-modeévaluer ses arguments.

(defmacro define-derived-mode* (child parent name &optional docstring &rest body)
  (macroexpand `(define-derived-mode ,(eval child) ,(eval parent) ,(eval name)
                                     ,(eval docstring) . ,body)))
(define-derived-mode* 'toy-mode
  (if (fboundp 'prog-mode) 'prog-mode 'fundamental-mode)
  "Toy"
  "Major mode for my favorite toy language"
  (toy-mode-setup))

(Avertissement: seulement testé de manière minimale.)