1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188
|
;;; elenv.el --- Environment variable management -*- lexical-binding: t; -*-
;; Copyright (C) 2022-2023 Shen, Jen-Chieh
;; Author: Shen, Jen-Chieh <jcs090218@gmail.com>
;; Maintainer: Shen, Jen-Chieh <jcs090218@gmail.com>
;; URL: https://github.com/jcs-elpa/elenv
;; Version: 0.1.0
;; Package-Requires: ((emacs "26.1"))
;; Keywords: maint
;; This file is not part of GNU Emacs.
;; This program is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.
;; This program is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
;; GNU General Public License for more details.
;; You should have received a copy of the GNU General Public License
;; along with this program. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; The package name `elenv' stands for Emacs Lisp environment.
;;
;; Environment variable management.
;;
;;; Code:
;;
;; (@* "Operating System" )
;;
;;;###autoload
(defconst elenv-windows (memq system-type '(cygwin windows-nt ms-dos))
"The operating system is Microsoft Windows compatible.")
;;;###autoload
(defconst elenv-darwin (eq system-type 'darwin)
"The operating system is GNU-Darwin compatible.")
;;;###autoload
(defconst elenv-macos elenv-darwin
"The operating system is macOS compatible.")
;;;###autoload
(defconst elenv-linux (eq system-type 'gnu/linux)
"The operating system is Linux compatible.")
;;;###autoload
(defconst elenv-bsd (eq system-type 'gnu/kfreebsd)
"The operating system is BSD compatible.")
;;;###autoload
(defconst elenv-unix (memq system-type '(aix berkeley-unix hpux usg-unix-v))
"The operating system is Unix compatible.")
;;;###autoload
(defconst elenv-system-type
(cond (elenv-windows 'dos)
(elenv-macos 'mac)
(elenv-linux 'unix)
(elenv-bsd 'bsd)
(t 'unknown))
"Generic system type.")
;;;###autoload
(defmacro elenv-with-os (os &rest body)
"Evaluate BODY by OS."
(declare (indent 1))
`(when (or (eq system-type ,os) (memq system-type ,os)) ,@body))
;;;###autoload
(defmacro elenv-with-windows (&rest body)
"Evaluate BODY in Windows."
(declare (indent 0)) `(when elenv-windows ,@body))
;;;###autoload
(defmacro elenv-with-macos (&rest body)
"Evaluate BODY in macOS."
(declare (indent 0)) `(when elenv-macos ,@body))
;;;###autoload
(defmacro elenv-with-linux (&rest body)
"Evaluate BODY in Linux."
(declare (indent 0)) `(when elenv-linux ,@body))
;;;###autoload
(defmacro elenv-with-bsd (&rest body)
"Evaluate BODY in BSD."
(declare (indent 0)) `(when elenv-bsd ,@body))
;;;###autoload
(defmacro elenv-with-unix (&rest body)
"Evaluate BODY in Unix."
(declare (indent 0)) `(when elenv-unix ,@body))
;;
;; (@* "Environment" )
;;
;;;###autoload
(defmacro elenv-if-env (variable then &rest else)
"Evaluate THEN if VARIABLE is valid, we execute ELSE if not valid."
(declare (indent 1))
`(if-let ((value (getenv ,variable))) ,then ,@else))
;;;###autoload
(defmacro elenv-when-env (variable &rest body)
"Evaluate BODY when VARIABLE is valid."
(declare (indent 1))
`(when-let ((value (getenv ,variable))) ,@body))
;;;###autoload
(defmacro elenv-unless-env (variable &rest body)
"Evaluate BODY when VARIABLE is valid."
(declare (indent 1))
`(unless (getenv ,variable) ,@body))
;;
;; (@* "Executable" )
;;
(defmacro elenv--exec-find (command remote)
"Find executable COMMAND.
For argument REMOTE, see function `executable-find' description."
(let ((var (intern (format "elenv-exec-%s" command))))
`(if (boundp ',var)
(symbol-value ',var)
(defvar ,var (executable-find ,command ,remote)
(format "Variable generate it with `elenv' finding executable `%s'."
,command))
(symbol-value ',var))))
;;;###autoload
(defmacro elenv-if-exec (command remote then &rest else)
"Evaluate body (THEN and ELSE) if COMMAND is found.
For argument REMOTE, see function `executable-find' description."
(declare (indent 3))
`(if-let ((value (elenv--exec-find ,command ,remote)))
,then
,@else))
;;;###autoload
(defmacro elenv-when-exec (command remote &rest body)
"Evaluate BODY when COMMAND is found.
For argument REMOTE, see function `executable-find' description."
(declare (indent 2))
`(when-let ((value (elenv--exec-find ,command ,remote)))
,@body))
;;;###autoload
(defmacro elenv-unless-exec (command remote &rest body)
"Evaluate BODY unless COMMAND is found.
For argument REMOTE, see function `executable-find' description."
(declare (indent 2))
`(unless (elenv--exec-find ,command ,remote)
,@body))
;;
;; (@* "Graphic" )
;;
;;;###autoload
(defconst elenv-graphic-p (display-graphic-p)
"Return t if graphic mode.")
;;
;; (@* "Debugging" )
;;
;;;###autoload
(defun elenv-debugging-p ()
"Return non-nil when debugging."
(bound-and-true-p edebug-active))
(provide 'elenv)
;;; elenv.el ends here
|