doomemacs/modules/feature/file-templates/autoload.el
Henrik Lissner 7d3ffdff06
Remove third line in section headers
This is truly important stuff. We've saved many lives with this update.
2018-09-09 09:58:19 -04:00

137 lines
5.2 KiB
EmacsLisp

;;; feature/file-templates/autoload.el -*- lexical-binding: t; -*-
(defun +file-templates--set (pred plist)
(if (null (car-safe plist))
(setq +file-templates-alist
(delq (assoc pred +file-templates-alist)
+file-templates-alist))
(push `(,pred ,@plist) +file-templates-alist)))
;;;###autodef
(defun set-file-template! (pred &rest plist)
"Register a file template.
PRED can either be a regexp string or a major mode symbol. PLIST may contain
these properties:
:when FUNCTION
Provides a secondary predicate. This function takes no arguments and is
executed from within the target buffer. If it returns nil, this rule will be
skipped over.
:trigger STRING|FUNCTION
If a string, this is the yasnippet trigger keyword used to trigger the
target snippet.
If a function, this function will be run in the context of the buffer to
insert a file template into. It is given no arguments and must insert text
into the current buffer manually.
If omitted, `+file-templates-default-trigger' is used.
:mode SYMBOL
What mode to get the yasnippet snippet from. If omitted, either PRED (if
it's a major-mode symbol) or the mode of the buffer is used.
:project BOOL
If non-nil, ignore this template if this buffer isn't in a project.
:ignore BOOL
If non-nil, don't expand any template for this file and don't test any other
file template rule against this buffer."
(declare (indent defun))
(defer-until! (boundp '+file-templates-alist)
(+file-templates--set pred plist)))
;;;###autodef
(defun set-file-templates! (&rest templates)
"Like `set-file-templates!', but register many file templates at once."
(defer-until! (boundp '+file-templates-alist)
(dolist (template templates)
(+file-templates--set (car template) (cdr template)))))
;; FIXME obsolete :file-template
;;;###autoload
(def-setting! :file-template (pred &rest plist)
:obsolete set-file-template!
`(set-file-template! ,pred ,@plist))
;; FIXME obsolete :file-templates
;;;###autoload
(def-setting! :file-templates (&rest templates)
:obsolete set-file-templates!
`(set-file-templates! ,@templates))
;;
;; Library
;;;###autoload
(cl-defun +file-templates--expand (pred &key project mode trigger ignore _when)
"Auto insert a yasnippet snippet into current file and enter insert mode (if
evil is loaded and enabled)."
(when (and pred (not ignore))
(when (if project (doom-project-p) t)
(unless mode
(setq mode (if (symbolp pred) pred major-mode)))
(unless mode
(user-error "Couldn't determine mode for %s file template" pred))
(unless trigger
(setq trigger +file-templates-default-trigger))
(if (functionp trigger)
(funcall trigger)
(require 'yasnippet)
(unless yas-minor-mode
(yas-minor-mode-on))
(when (and yas-minor-mode
(when-let*
((template (cl-find trigger (yas--all-templates (yas--get-snippet-tables mode))
:key #'yas--template-key :test #'equal)))
(yas-expand-snippet (yas--template-content template)))
(and (featurep 'evil) evil-mode)
(and yas--active-field-overlay
(overlay-buffer yas--active-field-overlay)
(overlay-get yas--active-field-overlay 'yas--field)))
(evil-initialize-state 'insert))))))
;;;###autoload
(defun +file-templates-get-short-path ()
"Fetches a short file path for the header in Doom module templates."
(let ((path (file-truename (or buffer-file-name default-directory))))
(cond ((string-match "/modules/\\(.+\\)$" path)
(match-string 1 path))
((file-in-directory-p path doom-emacs-dir)
(file-relative-name path doom-emacs-dir))
((abbreviate-file-name path)))))
;;;###autoload
(defun +file-template-p (rule)
"Return t if RULE applies to the current buffer."
(let ((pred (car rule))
(plist (cdr rule)))
(and (cond ((and (stringp pred) buffer-file-name) (string-match-p pred buffer-file-name))
((symbolp pred) (eq major-mode pred)))
(or (not (plist-member plist :when))
(funcall (plist-get plist :when) buffer-file-name))
rule)))
;;
;; Commands
;;;###autoload
(defun +file-templates/insert-license ()
"Insert a license file template into the current file."
(interactive)
(require 'yasnippet)
(let* ((templates
(let ((yas-choose-tables-first nil) ; avoid prompts
(yas-choose-keys-first nil))
(cl-loop for tpl in (yas--all-templates (yas--get-snippet-tables 'text-mode))
for uuid = (yas--template-uuid tpl)
if (string-prefix-p "__license-" uuid)
collect (cons (string-remove-prefix "__license-" uuid) tpl))))
(uuid (yas-choose-value (mapcar #'car templates))))
(when uuid
(yas-expand-snippet (cdr (assoc uuid templates))))))
;;;###autoload
(defun +file-templates/debug ()
"Tests the current buffer and outputs the file template rule most appropriate
for it. This is used for testing."
(interactive)
(message "Found %s" (cl-find-if #'+file-template-p +file-templates-alist)))