systemd-mode/systemd-mode.el
Mark Oteiza a22a097e2c use function-item in customize
Thanks to lua-mode maintainer for the idea
2015-02-28 16:08:34 -05:00

152 lines
5.4 KiB
EmacsLisp

;;; systemd-mode.el --- Major mode for editing systemd units
;; Copyright (C) 2014-2015 Mark Oteiza <mvoteiza@udel.edu>
;; Author: Mark Oteiza <mvoteiza@udel.edu>
;; Keywords: tools, unix
;; This file 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 file 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 file. If not, see <http://www.gnu.org/licenses/>.
;;; Commentary:
;;; Code:
(require 'thingatpt)
(require 'url-parse)
(defgroup systemd ()
"Major mode for editing systemd units."
:group 'tools)
(defcustom systemd-browse-url-function 'eww
"Browser to use for HTTP(S) documentation."
:type '(radio (function-item eww)
(function-item browse-url)
(function :tag "Other function"))
:group 'systemd)
(defcustom systemd-comment-start "#"
"String to insert to start a new comment."
:type '(choice (string :tag "Comment sign" "#")
(string :tag "Semicolon" ";"))
:group 'systemd)
(defvar systemd-font-lock-keywords
`(
("^\\([#;]\\(.*\\)\\)$"
(1 'font-lock-comment-delimiter-face)
(2 'font-lock-comment-face))
("\\\\$" 0 'font-lock-warning-face) ; line break
;; sections
("^\\(\\[[[:upper:]][[:alnum:]]+\\]\\)"
1 'font-lock-type-face)
;; keys
("^\\([[:upper:]][[:alnum:]]+\\)="
1 'font-lock-keyword-face)
;; boolean arguments
("=\\(1\\|yes\\|true\\|on\\|0\\|no\\|false\\|off\\)$"
1 'font-lock-constant-face)
;; specifiers
("%[nNpPiIfcrRtuUhsmbHv%]" 0 'font-lock-constant-face)
)
"Default expressions to highlight in `systemd-mode'. See systemd.unit(5)
for details on unit file syntax.")
(defun systemd-get-value (start)
"Joins lines in the key value starting at buffer position START,
possibly broken by a backslash, and returns a string containing
the value."
(save-excursion
(let ((break "\\\\\n")
end)
(while (progn (goto-char (1- (line-end-position)))
(looking-at break))
(forward-line))
(setq end (line-end-position))
(replace-regexp-in-string break " " (buffer-substring start end)))))
(defun systemd-doc-find ()
"Find the value of the unit's “Documentation” keys and return
as a list of strings, otherwise nil."
(let ((key "^Documentation=")
string)
(save-excursion
(goto-char (point-min))
(while (re-search-forward key nil t)
(setq string (concat string " " (systemd-get-value (point))))))
(when string
(split-string string))))
(defun systemd-doc-open (url)
"Open URL. Interactively completes the documentation in the
current unit file, defaulting to the link under point, if any."
(interactive
(let* ((collection (systemd-doc-find))
(uri (or (thing-at-point-url-at-point)
(car-safe collection)))
(prompt (concat "URL"
(when uri (format " (default %s)" uri))
": ")))
(list (completing-read prompt collection nil nil nil nil uri))))
(let ((link (url-generic-parse-url url)))
(pcase (url-type link)
("file" (find-file (url-filename link)))
("man" (url-man link))
("info" (url-info link))
((or "http" "https") (funcall systemd-browse-url-function url))
(_ (user-error "Invalid link")))))
(defvar systemd-mode-syntax-table
(let ((table (make-syntax-table)))
(modify-syntax-entry ?\" ". " table)
(modify-syntax-entry ?\n "> " table)
(modify-syntax-entry ?\% "\\ " table)
table)
"Syntax table used in `systemd-mode' buffers.")
(defvar systemd-mode-map
(let ((map (make-sparse-keymap)))
(define-key map (kbd "C-c C-o") 'systemd-doc-open)
map)
"Keymap used in `systemd-mode' buffers.")
;;;###autoload (add-to-list 'auto-mode-alist '("\\.automount\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.busname\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.mount\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.service\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.socket\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.target\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.timer\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.link\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.netdev\\'" . systemd-mode))
;;;###autoload (add-to-list 'auto-mode-alist '("\\.network\\'" . systemd-mode))
;;;###autoload
(define-derived-mode systemd-mode fundamental-mode "Systemd"
"Major mode for editing systemd unit files. See
http://www.freedesktop.org/wiki/Software/systemd/ for more
information about systemd. The hook `systemd-mode-hook' is run
at mode initialization.
Key bindings:
\\{systemd-mode-map}"
(set-syntax-table systemd-mode-syntax-table)
(setq-local comment-start systemd-comment-start)
(setq-local font-lock-defaults '(systemd-font-lock-keywords))
(run-mode-hooks 'systemd-mode-hook))
(provide 'systemd-mode)
;;; systemd-mode.el ends here