This repository has been archived on 2024-10-22. You can view files and clone it, but cannot push or open issues or pull requests.
spacemacs/core/core-toggle.el

68 lines
2.3 KiB
EmacsLisp

;;; core-toggle.el --- Spacemacs Core File
;;
;; Copyright (c) 2012-2014 Sylvain Benner
;; Copyright (c) 2014-2015 Sylvain Benner & Contributors
;;
;; Author: Sylvain Benner <sylvain.benner@gmail.com>
;; URL: https://github.com/syl20bnr/spacemacs
;;
;; This file is not part of GNU Emacs.
;;
;;; License: GPLv3
(require 'core-funcs)
(defvar spacemacs-toggles '()
"List of all declared toggles. The structure of an element is a
property list (name :func FUNCTION :doc STRING :key STRING).")
(defmacro spacemacs|add-toggle (name &rest props)
"Add a toggle with NAME symbol.
Avaiblabe PROPS:
`:status EXPRESSION'
The EXPRESSION to evaluate to get the current status of the toggle.
`:if EXPRESSION'
If this EXPRESSION evaluate to nil then no attempt to update the toggle
status will be performed.
`:on BODY'
Evaluate BODY when the toggle is switched on.
`:off BODY'
Evaluate BODY when the toggle is switched off.
`:documentation STRING'
STRING describes what the toggle does.
All properties supported by `spacemacs//create-key-binding-form' can be
used."
(let* ((wrapper-func (intern (format "spacemacs/toggle-%s"
(symbol-name name))))
(status (plist-get props :status))
(condition (plist-get props :if))
(doc (plist-get props :documentation))
(on-body (spacemacs/mplist-get props :on))
(off-body (spacemacs/mplist-get props :off))
(bindkeys (spacemacs//create-key-binding-form props wrapper-func)))
`(progn
(push (append '(,name) '(:function ,wrapper-func) ',props)
spacemacs-toggles)
;; toggle function
(defun ,wrapper-func ()
,(format "Toggle %s on and off." (symbol-name name))
(interactive)
;; we evaluate condition and status only if they are a list or
;; a bound symbol
(if (or (null ',condition)
(and (or (and (symbolp ',condition) (boundp ',condition))
(listp ',condition))
,condition))
(if (and (or (and (symbolp ',status) (boundp ',status))
(listp ',status))
,status) (progn ,@off-body) ,@on-body)
(message "This toggle is not supported.")))
,@bindkeys)))
(provide 'core-toggle)