refactor: doom-module: conform variables to conventions

- Rename doom--empty-module-context to doom-module--empty-context.
- Nest doom-module-context symbol plist in its 'keys' property. (By
  convention, Doom uses keywords as keys in most places. Let's be
  consistent)
- Updates all uses of doom-module--context-field and
  doom-module-context-get.
This commit is contained in:
Henrik Lissner 2024-02-02 18:58:34 -05:00
parent fc6934c240
commit 77ea4013dd
No known key found for this signature in database
GPG key ID: B60957CA074D39A3
2 changed files with 18 additions and 15 deletions

View file

@ -125,12 +125,12 @@ your `doom!' block, a warning is emitted before replacing it with :emacs vc and
;; ;;
;;; `doom-module-context' ;;; `doom-module-context'
(defvar doom--empty-module-context [nil nil nil nil nil nil nil]) (defvar doom-module--empty-context [nil nil nil nil nil nil nil])
(eval-and-compile (eval-and-compile
(setplist 'doom-module-context '(index 0 initdepth 1 configdepth 2 (put 'doom-module-context 'keys '(:index 0 :initdepth 1 :configdepth 2
group 3 name 4 flags 5 features 6))) :group 3 :name 4 :flags 5 :features 6)))
(defvar doom-module-context doom--empty-module-context (defvar doom-module-context doom-module--empty-context
"A vector describing the module associated it with the active context. "A vector describing the module associated it with the active context.
Contains the following: [INDEX INITDEPTH CONFIGDEPTH :GROUP MODULE FLAGS FEATURES] Contains the following: [INDEX INITDEPTH CONFIGDEPTH :GROUP MODULE FLAGS FEATURES]
@ -138,7 +138,8 @@ Contains the following: [INDEX INITDEPTH CONFIGDEPTH :GROUP MODULE FLAGS FEATURE
Do not directly set this variable, only let-bind it.") Do not directly set this variable, only let-bind it.")
;; DEPRECATED: Remove this when byte-compilation is introduced to Doom core. ;; DEPRECATED: Remove this when byte-compilation is introduced to Doom core.
(defmacro doom-module--context-field (field) (get 'doom-module-context field)) (defmacro doom-module--context-field (field)
(plist-get (get 'doom-module-context 'keys) field))
(defun doom-module-context-get (field &optional context) (defun doom-module-context-get (field &optional context)
"Return the FIELD of CONTEXT. "Return the FIELD of CONTEXT.
@ -146,7 +147,9 @@ Do not directly set this variable, only let-bind it.")
FIELD should be one of `index', `initdepth', `configdepth', `group', `name', FIELD should be one of `index', `initdepth', `configdepth', `group', `name',
`flags', or `features'. CONTEXT should be a `doom-module-context' vector. If `flags', or `features'. CONTEXT should be a `doom-module-context' vector. If
omitted, defaults to `doom-module-context'." omitted, defaults to `doom-module-context'."
(aref (or context doom-module-context) (get 'doom-module-context field))) (aref (or context doom-module-context)
(plist-get (get 'doom-module-context 'keys)
field)))
(defun doom-module-context (group &optional name) (defun doom-module-context (group &optional name)
"Create a `doom-module-context' from a module by GROUP and NAME. "Create a `doom-module-context' from a module by GROUP and NAME.
@ -156,14 +159,14 @@ If NAME is omitted, GROUP is treated as a module key cons cell: (GROUP . NAME)."
(let ((key (if name (cons group name) group))) (let ((key (if name (cons group name) group)))
(or (get (or (car-safe key) key) (or (get (or (car-safe key) key)
(cdr-safe key)) (cdr-safe key))
doom--empty-module-context))) doom-module--empty-context)))
(defun doom-module-context-key (&optional context) (defun doom-module-context-key (&optional context)
"Return the module of the active `doom-module-context' as a module key." "Return the module of the active `doom-module-context' as a module key."
(declare (side-effect-free t)) (declare (side-effect-free t))
(let ((context (or context doom-module-context))) (let ((context (or context doom-module-context)))
(cons (aref context (doom-module--context-field group)) (cons (aref context (doom-module--context-field :group))
(aref context (doom-module--context-field name))))) (aref context (doom-module--context-field :name)))))
(defmacro doom-module-context-with (module-key &rest body) (defmacro doom-module-context-with (module-key &rest body)
"Evaluate BODY with `doom-module-context' informed by MODULE-KEY." "Evaluate BODY with `doom-module-context' informed by MODULE-KEY."
@ -477,20 +480,20 @@ For more about modules and flags, see `doom!'."
;; PERF: This macro bypasses the module API to spare startup their runtime ;; PERF: This macro bypasses the module API to spare startup their runtime
;; cost, as `modulep!' gets called *a lot* during startup. In the future, ;; cost, as `modulep!' gets called *a lot* during startup. In the future,
;; Doom will byte-compile its core files. At that time, we can use it again. ;; Doom will byte-compile its core files. At that time, we can use it again.
(and (cond (flag (memq flag (aref (or (get category module) doom--empty-module-context) (and (cond (flag (memq flag (aref (or (get category module) doom-module--empty-context)
(doom-module--context-field flags)))) (doom-module--context-field :flags))))
(module (get category module)) (module (get category module))
((aref doom-module-context 0) ((aref doom-module-context 0)
(memq category (aref doom-module-context (memq category (aref doom-module-context
(doom-module--context-field flags)))) (doom-module--context-field :flags))))
((let ((file ((let ((file
;; This must be expanded at the call site, not in ;; This must be expanded at the call site, not in
;; `modulep!'s definition, to get the file we want. ;; `modulep!'s definition, to get the file we want.
(macroexpand '(file!)))) (macroexpand '(file!))))
(if-let (module (doom-module-from-path file)) (if-let (module (doom-module-from-path file))
(memq category (aref (or (get (car module) (cdr module)) (memq category (aref (or (get (car module) (cdr module))
doom--empty-module-context) doom-module--empty-context)
(doom-module--context-field flags))) (doom-module--context-field :flags)))
(error "(modulep! %s %s %s) couldn't figure out what module it was called from (in %s)" (error "(modulep! %s %s %s) couldn't figure out what module it was called from (in %s)"
category module flag file))))) category module flag file)))))
t)) t))

View file

@ -1352,7 +1352,7 @@ between the two."
)) ))
;;; Custom org modules ;;; Custom org modules
(dolist (flag (doom-module-context-get 'flags)) (dolist (flag (doom-module-context-get :flags))
(load! (concat "contrib/" (substring (symbol-name flag) 1)) nil t)) (load! (concat "contrib/" (substring (symbol-name flag) 1)) nil t))
;; Add our general hooks after the submodules, so that any hooks the ;; Add our general hooks after the submodules, so that any hooks the