🪴 Zero's Garden

autoload

Nov 20, 20232 min read

Magic autoload comment

A magic autoload comment (often called an autoload cookie) consists of ;;;###autoload, on a line by itself, just before the real definition of the function in its autoload-able source file. The function loaddefs-generate writes a corresponding autoload call into loaddefs.el. Building Emacs loads loaddefs.el and thus calls autoload.

Example:

;;;###autoload
(define-derived-mode ini-mode prog-mode "ini"
  "Major mode for editing Windows-style ini files."
  (setq font-lock-defaults '(ini-font-lock-keywords nil)))

Same line magic

You can also use a magic comment to execute a form at build time without executing it when the file itself is loaded. To do this, write the form on the same line as the magic comment. Since it is in a comment, it does nothing when you load the source file; but loaddefs-generate copies it to loaddefs.el, where it is executed while building Emacs.

Example:

;;;###autoload(add-to-list 'auto-mode-alist '("\\.ini\\'" . ini-mode))

autoload function

Outside of Emacs itself, Doom modules and package.el-managed packages, the magic comment ;;;###autoload does not work by default.

In your local Emacs Lisp files, you should use the autoload function directly, or import it with use-package by configuring :load-path to load a local package and use :commands (including :hook, :bind, :mode, etc.) to let use-package handle autoload for you.

References

Graph View

Backlinks

  • No backlinks found