branch: externals/sxhkdrc-mode
commit 32770897ce59406e3c694916651962a757ec273e
Author: Protesilaos Stavrou <i...@protesilaos.com>
Commit: Protesilaos Stavrou <i...@protesilaos.com>
Add first version of sxhkdrc-mode
---
.gitignore | 3 ++
README.md | 15 +++++++
sxhkdrc-mode.el | 125 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++
3 files changed, 143 insertions(+)
diff --git a/.gitignore b/.gitignore
new file mode 100644
index 0000000000..cb62d01d0e
--- /dev/null
+++ b/.gitignore
@@ -0,0 +1,3 @@
+*.elc
+*-autoloads.el
+*-pkg.el
diff --git a/README.md b/README.md
new file mode 100644
index 0000000000..dfc1e361e0
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+# sxhkdrc-mode for GNU Emacs
+
+This is a major mode for editing `sxhkdrc` files. SXHKD is the Simple
+X Hotkey Daemon which is commonly used in minimalist desktop sessions
+on Xorg, such as with the Binary Space Partitioning Window Manager
+(BSPWM). The `sxhkdrc` file configures key chords, binding them to
+commands. For the technicalities, read the man page `sxhkd(1)`.
+
++ Package name (GNU ELPA): `sxhkdrc-mode`
++ Git repo on SourceHut: <https://git.sr.ht/~protesilaos/sxhkdrc-mode>
+ - Mirrors:
+ + GitHub: <https://github.com/protesilaos/sxhkdrc-mode>
+ + GitLab: <https://gitlab.com/protesilaos/sxhkdrc-mode>
++ Mailing list: <https://lists.sr.ht/~protesilaos/general-issues>
++ Backronym: Such Xenotropic Hot Keys Demonstrate Robustness and
Configurability.
diff --git a/sxhkdrc-mode.el b/sxhkdrc-mode.el
new file mode 100644
index 0000000000..767afd7abf
--- /dev/null
+++ b/sxhkdrc-mode.el
@@ -0,0 +1,125 @@
+;;; sxhkdrc-mode.el --- Major mode for sxhkdrc files (Simple X Hot Key Daemon)
-*- lexical-binding: t -*-
+
+;; Copyright (C) 2022 Free Software Foundation, Inc.
+
+;; Author: Protesilaos Stavrou <i...@protesilaos.com>
+;; Maintainer: Protesilaos Stavrou General Issues
<~protesilaos/general-iss...@lists.sr.ht>
+;; URL: https://git.sr.ht/~protesilaos/sxhkdrc-mode
+;; Mailing-List: https://lists.sr.ht/~protesilaos/general-issues
+;; Version: 0.1.0
+;; Package-Requires: ((emacs "27.1"))
+
+;; 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:
+;;
+;; Major mode for editing sxhkdrc files (Simple X Hot Key Daemon). It
+;; defines basic fontification rules and supports indentation.
+;;
+;; SXHKD is the Simple X Hotkey Daemon which is commonly used in
+;; minimalist desktop sessions on Xorg, such as with the Binary Space
+;; Partitioning Window Manager (BSPWM).
+;;
+;; Why call the package SXHKDRC-something? One school of thought is
+;; that it is named after the files it applies to. The heterodox
+;; view, however, is that SXHKDRC is a backronym: Such Xenotropic Hot
+;; Keys Demonstrate Robustness and Configurability.
+
+;;; Code:
+
+(defgroup sxhkdrc nil
+ "Major mode for editing sxhkdrc files.
+SXHKD is the Simple X Hotkey Daemon which is commonly used in
+minimalist desktop sessions on Xorg, such as with the Binary
+Space Partitioning Window Manager (BSPWM)."
+ :group 'programming)
+
+(defvar sxhkdrc-mode-syntax
+ '((key-modifier . ( "control" "ctrl" "shift" "alt" "meta" "super" "hyper"
+ "mod1" "mod2" "mod3" "mod4" "mod5"))
+ (key-generic . "^\\<.*?\\>")
+ (comment . "^\\([\s\t]+\\)?#.*$")
+ (command . "^[\s\t]+\\([;]\\)?\\(\\_<.*?\\_>\\)")
+ (indent-other . 0)
+ (indent-command . 4))
+ "List of associations for sxhkdrc syntax.")
+
+(defun sxhkdrc-mode--modifiers-regexp (placement)
+ "Return `sxhkdrc-mode--modifiers' as a single string regexp.
+PLACEMENT controls how to format the regexp: `start' is for the
+beginning of the line, `chord' is when the modifier is part of a
+key chord chain (demarcated by a colon or semicolon)."
+ (let ((mods (alist-get 'key-modifier sxhkdrc-mode-syntax)))
+ (pcase placement
+ ('start (format "^\\(%s\\)" (mapconcat #'identity mods "\\|")))
+ ('chord (format "[;:]\\([\s\t]\\)?\\(%s\\)" (mapconcat #'identity mods
"\\|"))))))
+
+(defface sxhkdrc-mode-primary-modifier
+ '((t :inherit font-lock-keyword-face))
+ "Face for sxhkd modifiers at the start of a key sequence or chord.")
+
+(defface sxhkdrc-mode-generic-key
+ '((t :inherit font-lock-builtin-face))
+ "Face for sxhkd generic keys at the start of a sequence.")
+
+(defface sxhkdrc-mode-command
+ '((t :inherit font-lock-function-name-face))
+ "Face for the first part of an sxhkd command.")
+
+(defface sxhkdrc-mode-command-async
+ '((t :inherit bold))
+ "Face for the sxhkd asynchronous command indicator.")
+
+(defconst sxhkdrc-mode-font-lock-keywords
+ (let ((syntax sxhkdrc-mode-syntax))
+ `((,(sxhkdrc-mode--modifiers-regexp 'start)
+ (1 'sxhkdrc-mode-primary-modifier))
+ (,(sxhkdrc-mode--modifiers-regexp 'chord)
+ (2 'sxhkdrc-mode-primary-modifier))
+ (,(alist-get 'command syntax)
+ (1 'sxhkdrc-mode-command-async t t)
+ (2 'sxhkdrc-mode-command t t))
+ (,(alist-get 'key-generic syntax)
+ (0 'sxhkdrc-mode-generic-key))))
+ "Fontification of sxhkdrc files.")
+
+(defun sxhkdrc-mode-indent-line ()
+ "Indent line according to `sxhkdrc-mode-syntax'."
+ (interactive)
+ (let ((syntax sxhkdrc-mode-syntax))
+ (save-excursion
+ (beginning-of-line)
+ (when (or (not (looking-at (alist-get 'key-generic syntax)))
+ (save-excursion
+ (forward-line -1)
+ (beginning-of-line)
+ (looking-at (alist-get 'key-generic syntax))))
+ (delete-horizontal-space)
+ (indent-to (alist-get 'indent-command syntax))))))
+
+;;;###autoload
+(define-derived-mode sxhkdrc-mode prog-mode "SXHKDRC"
+ "Major mode for editing sxhkdrc files (Simple X Hot Key Daemon)."
+ (setq-local indent-line-function 'sxhkdrc-mode-indent-line
+ comment-start "# "
+ comment-start-skip "#+ *")
+ (setq font-lock-defaults '(sxhkdrc-mode-font-lock-keywords)))
+
+;;;###autoload
+(add-to-list 'auto-mode-alist '("sxhkdrc\\'" . sxhkdrc-mode))
+
+(provide 'sxhkdrc-mode)
+;;; sxhkdrc-mode.el ends here
