Introduction au calcul-lisp-indent
Une meilleure solution consiste à remplacer la fonction calculate-lisp-indent. En bref, calculate-lisp-indentest une fonction qui renvoie la colonne à laquelle une ligne au point doit être mise en retrait. Cette fonction indique ce lisp-indent-functionque chaque ligne doit être indentée. (voir aussi mon post sur reddit pour plus d'informations).
Comparaison avec d'autres réponses
L'avantage de cette réponse sur l'utilisation de la fonction modifiée de Fuco1 est que (1) elle corrige la racine du problème qui réside au calculate-lisp-indentlieu de simplement nettoyer après la mauvaise indentation renvoyée par calculate-lisp-indent(2) elle généralise aux listes entre guillemets et entre guillemets (et elle fonctionne qu'ils soient explicitement cités / rétrogradés ou avec 'et `). Il fonctionne également avec des guillemets et des guillemets arbitrairement imbriqués.
L'avantage de cette réponse sur le remplacement lisp-indent-functionpar la common-lisp-indent-functionfonction est qu'elle n'a pas pour effet secondaire de gâcher d'autres indentations elisp. Elisp et common-lisp sont mis en retrait différemment.
Comment ça fonctionne
Ce conditionnel (in calculate-lisp-indent) est ce qui décide si un sexp est indenté comme une fonction ou non. Ce qui tombe dans sa clause else est en retrait comme une fonction. Ce qui tombe dans sa clause if, est mis en retrait normalement (sous l'élément courant). Pour le mettre en retrait des listes entre guillemets en tant que données plutôt qu'en tant que fonctions, nous devons ajouter davantage de vérification pour les cas où la liste est citée dans le prédicat conditionnel.
(if (= (point) calculate-lisp-indent-last-sexp)
;; Containing sexp has nothing before this line
;; except the first element. Indent under that element.
nil
;; Skip the first element, find start of second (the first
;; argument of the function call) and indent under.
(progn (forward-sexp 1)
(parse-partial-sexp (point)
calculate-lisp-indent-last-sexp
0 t)))
Ce code vérifie les parenthèses ouvertes du sexp en retrait. Si c'est sexp avec plusieurs sexp, il les vérifie tous. Il retourne t s'il trouve des sexps cités ou rétrogradés.
(let* ((positions (elt state 9))
(last (car (last positions)))
(rest (nreverse (butlast positions)))
(any-quoted-p nil)
(point nil))
(or
(when-let (char last)
(or (char-equal char ?')
(char-equal char ?`)))
(while (and rest (not any-quoted-p))
(setq point (pop rest))
(setq any-quoted-p
(or
(when-let (char point)
(or (char-equal char ?')
(char-equal char ?`)))
(save-excursion
(goto-char (1+ point))
(looking-at-p "\\(?:back\\)?quote[\t\n\f\s]+(")))))))
Prime
Si vous souhaitez qu'une liste commençant par un mot-clé soit mise en retrait en tant que données même si elle n'est pas citée, ajoutez-la comme autre vérification au prédicat conditionnel. Cela peut être utile pour les macros dans lesquelles les plists ne sont pas cités pour des raisons de commodité, comme dans defhydra .
(when-let (char-after (char-after (1+ containing-sexp)))
(char-equal char-after ?:))
Exemples
L'extrait de code complet que j'ai publié ci-dessous fonctionne avec le cas que vous avez mentionné et plus encore. Veuillez l'essayer!
;; Your example
`(:token ,token
:token-quality ,quality)
;; Other cool examples
(quote (hi im gosu
the best vayne player))
'(i am the phantom of
the opera)
'((angel of music
hide no longer))
(backquote (past the point
no return
... the final chapter))
`(fee fi fo
fum)
;; should indent it like a function.
(iamafunction arg1
arg2
arg3)
Pour une explication plus approfondie de la façon dont cela fonctionne, consultez mon article sur reddit .
Extrait de code complet
Voici l'extrait de code complet.
(advice-add #'calculate-lisp-indent :override #'void~calculate-lisp-indent)
(defun void~calculate-lisp-indent (&optional parse-start)
"Add better indentation for quoted and backquoted lists."
;; This line because `calculate-lisp-indent-last-sexp` was defined with `defvar`
;; with it's value ommited, marking it special and only defining it locally. So
;; if you don't have this, you'll get a void variable error.
(defvar calculate-lisp-indent-last-sexp)
(save-excursion
(beginning-of-line)
(let ((indent-point (point))
state
;; setting this to a number inhibits calling hook
(desired-indent nil)
(retry t)
calculate-lisp-indent-last-sexp containing-sexp)
(cond ((or (markerp parse-start) (integerp parse-start))
(goto-char parse-start))
((null parse-start) (beginning-of-defun))
(t (setq state parse-start)))
(unless state
;; Find outermost containing sexp
(while (< (point) indent-point)
(setq state (parse-partial-sexp (point) indent-point 0))))
;; Find innermost containing sexp
(while (and retry
state
(> (elt state 0) 0))
(setq retry nil)
(setq calculate-lisp-indent-last-sexp (elt state 2))
(setq containing-sexp (elt state 1))
;; Position following last unclosed open.
(goto-char (1+ containing-sexp))
;; Is there a complete sexp since then?
(if (and calculate-lisp-indent-last-sexp
(> calculate-lisp-indent-last-sexp (point)))
;; Yes, but is there a containing sexp after that?
(let ((peek (parse-partial-sexp calculate-lisp-indent-last-sexp
indent-point 0)))
(if (setq retry (car (cdr peek))) (setq state peek)))))
(if retry
nil
;; Innermost containing sexp found
(goto-char (1+ containing-sexp))
(if (not calculate-lisp-indent-last-sexp)
;; indent-point immediately follows open paren.
;; Don't call hook.
(setq desired-indent (current-column))
;; Find the start of first element of containing sexp.
(parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
(cond ((looking-at "\\s(")
;; First element of containing sexp is a list.
;; Indent under that list.
)
((> (save-excursion (forward-line 1) (point))
calculate-lisp-indent-last-sexp)
;; This is the first line to start within the containing sexp.
;; It's almost certainly a function call.
(if (or
;; Containing sexp has nothing before this line
;; except the first element. Indent under that element.
(= (point) calculate-lisp-indent-last-sexp)
;; First sexp after `containing-sexp' is a keyword. This
;; condition is more debatable. It's so that I can have
;; unquoted plists in macros. It assumes that you won't
;; make a function whose name is a keyword.
;; (when-let (char-after (char-after (1+ containing-sexp)))
;; (char-equal char-after ?:))
;; Check for quotes or backquotes around.
(let* ((positions (elt state 9))
(last (car (last positions)))
(rest (reverse (butlast positions)))
(any-quoted-p nil)
(point nil))
(or
(when-let (char (char-before last))
(or (char-equal char ?')
(char-equal char ?`)))
(progn
(while (and rest (not any-quoted-p))
(setq point (pop rest))
(setq any-quoted-p
(or
(when-let (char (char-before point))
(or (char-equal char ?')
(char-equal char ?`)))
(save-excursion
(goto-char (1+ point))
(looking-at-p
"\\(?:back\\)?quote[\t\n\f\s]+(")))))
any-quoted-p))))
;; Containing sexp has nothing before this line
;; except the first element. Indent under that element.
nil
;; Skip the first element, find start of second (the first
;; argument of the function call) and indent under.
(progn (forward-sexp 1)
(parse-partial-sexp (point)
calculate-lisp-indent-last-sexp
0 t)))
(backward-prefix-chars))
(t
;; Indent beneath first sexp on same line as
;; `calculate-lisp-indent-last-sexp'. Again, it's
;; almost certainly a function call.
(goto-char calculate-lisp-indent-last-sexp)
(beginning-of-line)
(parse-partial-sexp (point) calculate-lisp-indent-last-sexp
0 t)
(backward-prefix-chars)))))
;; Point is at the point to indent under unless we are inside a string.
;; Call indentation hook except when overridden by lisp-indent-offset
;; or if the desired indentation has already been computed.
(let ((normal-indent (current-column)))
(cond ((elt state 3)
;; Inside a string, don't change indentation.
nil)
((and (integerp lisp-indent-offset) containing-sexp)
;; Indent by constant offset
(goto-char containing-sexp)
(+ (current-column) lisp-indent-offset))
;; in this case calculate-lisp-indent-last-sexp is not nil
(calculate-lisp-indent-last-sexp
(or
;; try to align the parameters of a known function
(and lisp-indent-function
(not retry)
(funcall lisp-indent-function indent-point state))
;; If the function has no special alignment
;; or it does not apply to this argument,
;; try to align a constant-symbol under the last
;; preceding constant symbol, if there is such one of
;; the last 2 preceding symbols, in the previous
;; uncommented line.
(and (save-excursion
(goto-char indent-point)
(skip-chars-forward " \t")
(looking-at ":"))
;; The last sexp may not be at the indentation
;; where it begins, so find that one, instead.
(save-excursion
(goto-char calculate-lisp-indent-last-sexp)
;; Handle prefix characters and whitespace
;; following an open paren. (Bug#1012)
(backward-prefix-chars)
(while (not (or (looking-back "^[ \t]*\\|([ \t]+"
(line-beginning-position))
(and containing-sexp
(>= (1+ containing-sexp) (point)))))
(forward-sexp -1)
(backward-prefix-chars))
(setq calculate-lisp-indent-last-sexp (point)))
(> calculate-lisp-indent-last-sexp
(save-excursion
(goto-char (1+ containing-sexp))
(parse-partial-sexp (point) calculate-lisp-indent-last-sexp 0 t)
(point)))
(let ((parse-sexp-ignore-comments t)
indent)
(goto-char calculate-lisp-indent-last-sexp)
(or (and (looking-at ":")
(setq indent (current-column)))
(and (< (line-beginning-position)
(prog2 (backward-sexp) (point)))
(looking-at ":")
(setq indent (current-column))))
indent))
;; another symbols or constants not preceded by a constant
;; as defined above.
normal-indent))
;; in this case calculate-lisp-indent-last-sexp is nil
(desired-indent)
(t
normal-indent))))))
Notes finales
Il convient de noter que cette question serait mieux généralisée quant à la façon d'empêcher emacs d'indenter des listes entre guillemets et non entre guillemets en tant que fonctions .