83

Is there a difference between setting things for a mode using eval-after-load and using the mode hook?

I've seen some code where define-key is used inside a major mode hook, and some other code where define-key is used in eval-after-load form.


Update:

For better understanding, here is an example of using eval-after-load and mode hooks with org-mode. The code can run before (load "org") or (require 'org) or (package-initialize).

;; The following two lines of code set some org-mode options.
;; Usually, these can be outside (eval-after-load ...) and work.
;; In cases that doesn't work, try using setq-default or set-variable
;; and putting them in (eval-after-load ...), if the
;; doc for the variables don't say what to do.
;; Or use Customize interface.
(setq org-hide-leading-stars t)
(setq org-return-follows-link t)

;; "org" because C-h f org-mode RET says that org-mode is defined in org.el
(eval-after-load "org"
  '(progn
     ;; Establishing your own keybindings for org-mode.
     ;; Variable org-mode-map is available only after org.el or org.elc is loaded.
     (define-key org-mode-map (kbd "<C-M-return>") 'org-insert-heading-respect-content)
     (define-key org-mode-map (kbd "<M-right>") nil) ; erasing a keybinding.
     (define-key org-mode-map (kbd "<M-left>") nil) ; erasing a keybinding.

     (defun my-org-mode-hook ()
       ;; The following two lines of code is run from the mode hook.
       ;; These are for buffer-specific things.
       ;; In this setup, you want to enable flyspell-mode
       ;; and run org-reveal for every org buffer.
       (flyspell-mode 1)
       (org-reveal))
     (add-hook 'org-mode-hook 'my-org-mode-hook)))
1
  • 7
    +1 for "org" because C-h f org-mode RET says that org-mode is defined in org.el. I was struggling getting eval-after-load to actually evaluate for nxml-mode, and this tip worked!
    – Zach Young
    Commented Oct 12, 2014 at 19:40

1 Answer 1

114

Code wrapped in eval-after-load will be executed only once, so it is typically used to perform one-time setup such as setting default global values and behaviour. An example might be setting up a default keymap for a particular mode. In eval-after-load code, there's no notion of the "current buffer".

Mode hooks execute once for every buffer in which the mode is enabled, so they're used for per-buffer configuration. Mode hooks are therefore run later than eval-after-load code; this lets them take actions based upon such information as whether other modes are enabled in the current buffer.

12
  • 1
    On a side note (correct me if I'm wrong): emacs-lisp-mode and lisp-mode seem to get loaded before custom eval-after-load scripts get to be executed. So in that case one might indeed need to use a mode hook instead.
    – balu
    Commented Jan 10, 2014 at 2:35
  • 1
    Yes: the eval-after-load block is always eval'd after the related library is loaded. But note that the code will always be executed before any functions in the related library are called. So if you (eval-after-load 'lisp-mode ...), then the ... code in this block will be run before the lisp-mode function in lisp-mode.el is called.
    – sanityinc
    Commented Jan 10, 2014 at 11:17
  • 1
    What does after-load do exactly? Is there a difference to eval-after-load?
    – balu
    Commented Jan 11, 2014 at 20:59
  • 6
    It's just a local macro wrapper for eval-after-load, to avoid the need to quote the form passed to eval-after-load. ie. instead of (eval-after-load 'foo '(progn (foo) (bar))) I can write (after-load 'foo (foo) (bar)).
    – sanityinc
    Commented Jan 12, 2014 at 11:30
  • 2
    @balu: emacs-lisp-mode and lisp-mode are dumped with emacs and never loaded.
    – sds
    Commented Oct 31, 2014 at 16:00

Not the answer you're looking for? Browse other questions tagged or ask your own question.