DamienCassou
/
desktop-environment
1
0
Fork 0
Code Issues 2 Pull Requests 0 Releases 4 Wiki Activity
Helps you control your GNU/Linux computer from Emacs
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 Commits
2 Branches
182 KiB
 
 
Branch: master
Branches Tags
${ item.name }
Create branch ${ searchTerm }
from 'master'
${ noResults }
desktop-environment/desktop-environment.el

463 lines
17 KiB
Raw Permalink Blame History 

  1. ;;; desktop-environment.el --- Helps you control your GNU/Linux computer  -*- lexical-binding: t; -*-

  2. 

  3. ;; Copyright (C) 2018  Damien Cassou

  4. 

  5. ;; Author: Damien Cassou <damien@cassou.me>, Nicolas Petton <nicolas@petton.fr>

  6. ;; Url: https://gitlab.petton.fr/DamienCassou/desktop-environment

  7. ;; Package-requires: ((emacs "25.1"))

  8. ;; Version: 0.3.0

  9. 

  10. ;; This program is free software; you can redistribute it and/or modify

  11. ;; it under the terms of the GNU General Public License as published by

  12. ;; the Free Software Foundation, either version 3 of the License, or

  13. ;; (at your option) any later version.

  14. 

  15. ;; This program is distributed in the hope that it will be useful,

  16. ;; but WITHOUT ANY WARRANTY; without even the implied warranty of

  17. ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  18. ;; GNU General Public License for more details.

  19. 

  20. ;; You should have received a copy of the GNU General Public License

  21. ;; along with this program.  If not, see <https://www.gnu.org/licenses/>.

  22. 

  23. ;;; Commentary:

  24. 

  25. ;; This package helps you control your GNU/Linux desktop from Emacs.

  26. ;; With desktop-environment, you can control the brightness and volume

  27. ;; as well as take screenshots and lock your screen.  The package

  28. ;; depends on the availability of shell commands to do the hard work

  29. ;; for us.  These commands can be changed by customizing the

  30. ;; appropriate variables.

  31. 

  32. ;; The global minor mode `desktop-environment-mode' binds standard

  33. ;; keys to provided commands: e.g., <XF86AudioRaiseVolume> to raise

  34. ;; the volume, <print> to take a screenshot, and <s-l> to lock the

  35. ;; screen.

  36. 

  37. ;;; Code:

  38. 

  39. (require 'dbus)

  40. 

  41. (defgroup desktop-environment nil

  42.   "Configure desktop-environment."

  43.   :group 'environment)

  44. 

  45. 

  46. ;;; Customization - keyboard backlight

  47. (defcustom desktop-environment-keyboard-backlight-normal-increment 1

  48.   "Normal keyboard increment value."

  49.   :type 'integer)

  50. 

  51. (defcustom desktop-environment-keyboard-backlight-normal-decrement -1

  52.   "Normal keyboard decrement value."

  53.   :type 'integer)

  54. 

  55. 

  56. ;;; Customization - brightness

  57. 

  58. (defcustom desktop-environment-brightness-normal-increment "10%+"

  59.   "Normal brightness increment value."

  60.   :type 'string)

  61. 

  62. (defcustom desktop-environment-brightness-normal-decrement "10%-"

  63.   "Normal brightness decrement value."

  64.   :type 'string)

  65. 

  66. (defcustom desktop-environment-brightness-small-increment "5%+"

  67.   "Small brightness increment value."

  68.   :type 'string)

  69. 

  70. (defcustom desktop-environment-brightness-small-decrement "5%-"

  71.   "Small brightness decrement value."

  72.   :type 'string)

  73. 

  74. (defcustom desktop-environment-brightness-get-command "brightnessctl"

  75.   "Shell command getting current screen brightness level.

  76. If you change this variable, you might want to change

  77. `desktop-environment-brightness-get-regexp' as well."

  78.   :type 'string)

  79. 

  80. (defcustom desktop-environment-brightness-get-regexp "\\([0-9]+%\\)"

  81.   "Regular expression matching brightness value.

  82. 

  83. This regular expression will be tested against the result of

  84. `desktop-environment-brightness-get-command' and group 1 must

  85. match the current brightness level."

  86.   :type 'regexp)

  87. 

  88. (defcustom desktop-environment-brightness-set-command "brightnessctl set %s"

  89.   "Shell command setting the brightness level.

  90. The value must contain 1 occurrence of '%s' that will be

  91. replaced by the desired new brightness level."

  92.   :type 'string)

  93. 

  94. 

  95. ;;; Customization - volume

  96. 

  97. (defcustom desktop-environment-volume-normal-increment "5%+"

  98.   "Normal volume increment value."

  99.   :type 'string)

  100. 

  101. (defcustom desktop-environment-volume-normal-decrement "5%-"

  102.   "Normal volume decrement value."

  103.   :type 'string)

  104. 

  105. (defcustom desktop-environment-volume-small-increment "1%+"

  106.   "Small volume increment value."

  107.   :type 'string)

  108. 

  109. (defcustom desktop-environment-volume-small-decrement "1%-"

  110.   "Small volume decrement value."

  111.   :type 'string)

  112. 

  113. (defcustom desktop-environment-volume-get-command "amixer get Master"

  114.   "Shell command getting current volume level.

  115. If you change this variable, you might want to change

  116. `desktop-environment-volume-get-regexp' as well."

  117.   :type 'string)

  118. 

  119. (defcustom desktop-environment-volume-get-regexp "\\([0-9]+%\\)"

  120.   "Regular expression matching volume value.

  121. 

  122. This regular expression will be tested against the result of

  123. `desktop-environment-volume-get-command' and group 1 must

  124. match the current volume level."

  125.   :type 'regexp)

  126. 

  127. (defcustom desktop-environment-volume-set-command "amixer set Master %s"

  128.   "Shell command setting the volume level.

  129. The value must contain 1 occurrence of '%s' that will be

  130. replaced by the desired new volume level."

  131.   :type 'string)

  132. 

  133. (defcustom desktop-environment-volume-toggle-command "amixer set Master toggle"

  134.   "Shell command toggling between muted and unmuted."

  135.   :type 'string)

  136. 

  137. (defcustom desktop-environment-volume-toggle-microphone-command "amixer set Capture toggle"

  138.   "Shell command toggling microphone between muted and unmuted."

  139.   :type 'string)

  140. 

  141. 

  142. ;;; Customization - screenshots

  143. 

  144. (defcustom desktop-environment-screenshot-command "scrot"

  145.   "Shell command taking a screenshot in the current working directory."

  146.   :type 'string)

  147. 

  148. (defcustom desktop-environment-screenshot-partial-command "scrot -s"

  149.   "Shell command taking a partial screenshot in the current working directory.

  150. 

  151. The shell command should let the user interactively select the

  152. portion of the screen."

  153.   :type 'string)

  154. 

  155. (defcustom desktop-environment-screenshot-directory "~/Pictures"

  156.   "Directory where to save screenshots."

  157.   :type 'directory)

  158. 

  159. 

  160. ;;; Customization - screen locking

  161. 

  162. (defcustom desktop-environment-screenlock-command "slock"

  163.   "Shell command locking the screen."

  164.   :type 'string)

  165. 

  166. 

  167. ;;; Customization - wifi

  168. 

  169. (defcustom desktop-environment-wifi-command "wifi toggle"

  170.   "Shell command toggling wifi."

  171.   :type 'string)

  172. 

  173. ;;; Customization - bluetooth

  174. 

  175. (defcustom desktop-environment-bluetooth-command "bluetooth toggle"

  176.   "Shell command toggling bluetooth."

  177.   :type 'string)

  178. 

  179. 

  180. ;;; Customization - EXWM keybindings

  181. 

  182. (defcustom desktop-environment-update-exwm-global-keys :global

  183.   "Determines interacting with EXWM bindings when enabling/disabling the mode."

  184.   :type '(radio

  185.           (const :tag "Global" :doc "Use `exwm-input-set-key' on mode activation to set bindings." :global)

  186.           (const :tag "Prefix" :doc "Add/Remove keys to `exwm-input-prefix-keys' when enabling/disabling the mode." :prefix)

  187.           (const :tag "Off" :doc "Do not touch EXWM key bindings." nil)))

  188. 

  189. ;;; Helper functions - brightness

  190. 

  191. (defun desktop-environment-brightness-get ()

  192.   "Return a string representing current brightness level."

  193.   (let ((output (shell-command-to-string desktop-environment-brightness-get-command)))

  194.     (save-match-data

  195.       (string-match desktop-environment-brightness-get-regexp output)

  196.       (match-string 1 output))))

  197. 

  198. (defun desktop-environment-brightness-set (value)

  199.   "Set brightness to VALUE."

  200.   (shell-command-to-string (format desktop-environment-brightness-set-command value))

  201.   (message "New brightness value: %s" (desktop-environment-brightness-get)))

  202. 

  203. 

  204. ;;; Helper functions - volume

  205. 

  206. (defun desktop-environment-volume-get ()

  207.   "Return a string representing current volume level."

  208.   (let ((output (shell-command-to-string desktop-environment-volume-get-command)))

  209.     (save-match-data

  210.       (string-match desktop-environment-volume-get-regexp output)

  211.       (match-string 1 output))))

  212. 

  213. (defun desktop-environment-volume-set (value)

  214.   "Set volume to VALUE."

  215.   (shell-command-to-string (format desktop-environment-volume-set-command value))

  216.   (message "New volume value: %s" (desktop-environment-volume-get)))

  217. 

  218. 

  219. ;;; Helper functions - keyboard backlight

  220. (defun desktop-environment-keyboard-backlight-percent ()

  221.   "Return the new keyboard backlight value as a % of maximum backlight."

  222.   (let ((backlight-level (desktop-environment-keyboard-backlight-get)))

  223.     (if (eq backlight-level 0)

  224.         "0.0"

  225.       (*

  226.        (/ (* backlight-level 1.0)

  227.           (* (desktop-environment-keyboard-backlight-get-max) 1.0))

  228.        100))))

  229. 

  230. (defun desktop-environment-keyboard-backlight-get ()

  231.   "Return a number representing keyboard backlight current level."

  232.   (dbus-call-method :system

  233.                     "org.freedesktop.UPower"

  234.                     "/org/freedesktop/UPower/KbdBacklight"

  235.                     "org.freedesktop.UPower.KbdBacklight"

  236.                     "GetBrightness"))

  237. 

  238. (defun desktop-environment-keyboard-backlight-get-max ()

  239.   "Return a number representing keyboard backlight maximum level."

  240.   (dbus-call-method :system

  241.                     "org.freedesktop.UPower"

  242.                     "/org/freedesktop/UPower/KbdBacklight"

  243.                     "org.freedesktop.UPower.KbdBacklight"

  244.                     "GetMaxBrightness"))

  245. 

  246. (defun desktop-environment-keyboard-backlight-set (value)

  247.   "Set keyboard backlight to VALUE."

  248.   (dbus-call-method :system

  249.                     "org.freedesktop.UPower"

  250.                     "/org/freedesktop/UPower/KbdBacklight"

  251.                     "org.freedesktop.UPower.KbdBacklight"

  252.                     "SetBrightness"

  253.                     :int32 value)

  254.   (message "New keyboard value: %s%%" (desktop-environment-keyboard-backlight-percent)))

  255. 

  256. 

  257. ;;; Commands - brightness

  258. 

  259. ;;;###autoload

  260. (defun desktop-environment-brightness-increment ()

  261.   "Increment brightness by `desktop-environment-brightness-normal-increment'."

  262.   (interactive)

  263.   (desktop-environment-brightness-set desktop-environment-brightness-normal-increment))

  264. 

  265. ;;;###autoload

  266. (defun desktop-environment-brightness-decrement ()

  267.   "Decrement brightness by `desktop-environment-brightness-normal-decrement'."

  268.   (interactive)

  269.   (desktop-environment-brightness-set desktop-environment-brightness-normal-decrement))

  270. 

  271. ;;;###autoload

  272. (defun desktop-environment-brightness-increment-slowly ()

  273.   "Increment brightness by `desktop-environment-brightness-small-increment'."

  274.   (interactive)

  275.   (desktop-environment-brightness-set desktop-environment-brightness-small-increment))

  276. 

  277. ;;;###autoload

  278. (defun desktop-environment-brightness-decrement-slowly ()

  279.   "Decrement brightness by `desktop-environment-brightness-small-decrement'."

  280.   (interactive)

  281.   (desktop-environment-brightness-set desktop-environment-brightness-small-decrement))

  282. 

  283. 

  284. ;;; Commands - volume

  285. 

  286. ;;;###autoload

  287. (defun desktop-environment-volume-increment ()

  288.   "Increment volume by `desktop-environment-volume-normal-increment'."

  289.   (interactive)

  290.   (desktop-environment-volume-set desktop-environment-volume-normal-increment))

  291. 

  292. ;;;###autoload

  293. (defun desktop-environment-volume-decrement ()

  294.   "Decrement volume by `desktop-environment-volume-normal-decrement'."

  295.   (interactive)

  296.   (desktop-environment-volume-set desktop-environment-volume-normal-decrement))

  297. 

  298. ;;;###autoload

  299. (defun desktop-environment-volume-increment-slowly ()

  300.   "Increment volume by `desktop-environment-volume-small-increment'."

  301.   (interactive)

  302.   (desktop-environment-volume-set desktop-environment-volume-small-increment))

  303. 

  304. ;;;###autoload

  305. (defun desktop-environment-volume-decrement-slowly ()

  306.   "Decrement volume by `desktop-environment-volume-small-decrement'."

  307.   (interactive)

  308.   (desktop-environment-volume-set desktop-environment-volume-small-decrement))

  309. 

  310. ;;;###autoload

  311. (defun desktop-environment-toggle-mute ()

  312.   "Toggle between muted and un-muted."

  313.   (interactive)

  314.   (message "%s"

  315.            (shell-command-to-string desktop-environment-volume-toggle-command)))

  316. 

  317. ;;;###autoload

  318. (defun desktop-environment-toggle-microphone-mute ()

  319.   "Toggle microphone between muted and un-muted."

  320.   (interactive)

  321.   (message "%s"

  322.            (shell-command-to-string desktop-environment-volume-toggle-microphone-command)))

  323. 

  324. 

  325. ;;; Commands - keyboard backlight

  326. ;;;###autoload

  327. (defun desktop-environment-keyboard-backlight-increment ()

  328.   "Increment keyboard backlight by `desktop-environment-keyboard-backlight-normal-increment'."

  329.   (interactive)

  330.   (desktop-environment-keyboard-backlight-set

  331.    (+ desktop-environment-keyboard-backlight-normal-increment

  332.       (desktop-environment-keyboard-backlight-get))))

  333. 

  334. (defun desktop-environment-keyboard-backlight-decrement ()

  335.   "Decrement keyboard backlight by `desktop-environment-keyboard-backlight-normal-decrement'."

  336.   (interactive)

  337.   (desktop-environment-keyboard-backlight-set

  338.    (+ desktop-environment-keyboard-backlight-normal-decrement

  339.       (desktop-environment-keyboard-backlight-get))))

  340. 

  341. 

  342. ;;; Commands - screenshots

  343. 

  344. ;;;###autoload

  345. (defun desktop-environment-screenshot ()

  346.   "Take a screenshot of the screen in the current working directory."

  347.   (interactive)

  348.   (let ((default-directory (expand-file-name desktop-environment-screenshot-directory)))

  349.     (start-process-shell-command "desktop-environment-screenshot" nil desktop-environment-screenshot-command)))

  350. 

  351. ;;;###autoload

  352. (defun desktop-environment-screenshot-part ()

  353.   "Take a partial screenshot in the current working directory.

  354. 

  355. The command asks the user to interactively select a portion of

  356. the screen."

  357.   (interactive)

  358.   (let ((default-directory (expand-file-name desktop-environment-screenshot-directory)))

  359.     (message "Please select the part of your screen to shoot.")

  360.     (start-process-shell-command "desktop-environment-screenshot" nil desktop-environment-screenshot-partial-command)))

  361. 

  362. 

  363. ;;; Commands - screen locking

  364. 

  365. ;;;###autoload

  366. (defun desktop-environment-lock-screen ()

  367.   "Lock the screen, preventing anyone without a password from using the system."

  368.   (interactive)

  369.   ;; Run command asynchronously so that Emacs does not wait in the background.

  370.   (start-process-shell-command "lock" nil desktop-environment-screenlock-command))

  371. 

  372. 

  373. ;;; Commands - wifi

  374. 

  375. ;;;###autoload

  376. (defun desktop-environment-toggle-wifi ()

  377.   "Toggle wifi adapter on and off."

  378.   (interactive)

  379.   (let ((async-shell-command-buffer 'new-buffer))

  380.     (async-shell-command desktop-environment-wifi-command)))

  381. 

  382. ;;; Commands - bluetooth

  383. 

  384. ;;;###autoload

  385. (defun desktop-environment-toggle-bluetooth ()

  386.   "Toggle bluetooth on and off."

  387.   (interactive)

  388.   (let ((async-shell-command-buffer 'new-buffer))

  389.     (async-shell-command desktop-environment-bluetooth-command)))

  390.   

  391. ;;; Minor mode

  392. 

  393. (defvar desktop-environment-mode-map

  394.   (let ((desktop-environment--keybindings

  395.          `(;; Brightness

  396.            (,(kbd "<XF86MonBrightnessUp>") . ,(function desktop-environment-brightness-increment))

  397.            (,(kbd "<XF86MonBrightnessDown>") . ,(function desktop-environment-brightness-decrement))

  398.            (,(kbd "S-<XF86MonBrightnessUp>") . ,(function desktop-environment-brightness-increment-slowly))

  399.            (,(kbd "S-<XF86MonBrightnessDown>") . ,(function desktop-environment-brightness-decrement-slowly))

  400.            ;; Volume

  401.            (,(kbd "<XF86AudioRaiseVolume>") . ,(function desktop-environment-volume-increment))

  402.            (,(kbd "<XF86AudioLowerVolume>") . ,(function desktop-environment-volume-decrement))

  403.            (,(kbd "S-<XF86AudioRaiseVolume>") . ,(function desktop-environment-volume-increment-slowly))

  404.            (,(kbd "S-<XF86AudioLowerVolume>") . ,(function desktop-environment-volume-decrement-slowly))

  405.            (,(kbd "<XF86AudioMute>") . ,(function desktop-environment-toggle-mute))

  406.            (,(kbd "<XF86AudioMicMute>") . ,(function desktop-environment-toggle-microphone-mute))

  407.            ;; Volume

  408.            (,(kbd "S-<print>") . ,(function desktop-environment-screenshot-part))

  409.            (,(kbd "<print>") . ,(function desktop-environment-screenshot))

  410.            ;; Screen locking

  411.            (,(kbd "s-l") . ,(function desktop-environment-lock-screen))

  412.            ;; Wifi controls

  413.            (,(kbd "<XF86WLAN>") . ,(function desktop-environment-toggle-wifi))

  414.            ;; Bluetooth controls

  415.            (,(kbd "<XF86Bluetooth>") . ,(function desktop-environment-toggle-bluetooth))))

  416.         (map (make-sparse-keymap)))

  417.     (dolist (keybinding desktop-environment--keybindings)

  418.       (define-key map (car keybinding) (cdr keybinding)))

  419.     map)

  420.   "Keymap for `desktop-environment-mode'.")

  421. 

  422. (declare-function exwm-input-set-key "ext:exwm-input")

  423. 

  424. (defun desktop-environment-exwm-set-global-keybindings (enable)

  425.   "When using EXWM, add `desktop-environment-mode-map' to global keys.

  426. 

  427. When ENABLE is non-nil, the bindings will be installed depending

  428. on the value of `desktop-environment-update-exwm-global-keys'.

  429. If set to `:prefix', the bindings will be disabled when ENABLE is

  430. nil."

  431.   (when (featurep 'exwm-input)

  432.     (cl-case desktop-environment-update-exwm-global-keys

  433.       (:global

  434.        (when enable

  435.          (map-keymap (lambda (event definition)

  436.                        (exwm-input-set-key (vector event) definition))

  437.                      desktop-environment-mode-map)))

  438.       (:prefix

  439.        (when (boundp 'exwm-input-prefix-keys)

  440.          (map-keymap (lambda (event definition)

  441.                        (ignore definition)

  442.                        (setq exwm-input-prefix-keys (if enable

  443.                                                         (cons event exwm-input-prefix-keys)

  444.                                                       (delq event exwm-input-prefix-keys))))

  445.                      desktop-environment-mode-map)))

  446.       ((nil) nil)

  447.       (t

  448.        (message "Ignoring unknown value %s for `desktop-environment-update-exwm-global-keys'"

  449.                 desktop-environment-update-exwm-global-keys)))))

  450. 

  451. ;;;###autoload

  452. (define-minor-mode desktop-environment-mode

  453.   "Activate keybindings to control your desktop environment.

  454. 

  455. \\{desktop-environment-mode-map}"

  456.   :global t

  457.   :require 'desktop-environment

  458.   :lighter " DE"

  459.   (desktop-environment-exwm-set-global-keybindings desktop-environment-mode))

  460. 

  461. (provide 'desktop-environment)

  462. ;;; desktop-environment.el ends here