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
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
|
;;; xcompose-mode --- XCompose support for Emacs -*- lexical-binding: t; -*-
;; Copyright © 2025 Thomas Voss
;; Author: Thomas Voss <mail@thomasvoss.com>
;; Created: June 2025
;; Keywords: languages xcompose
;; URL: https://git.thomasvoss.com/xcompose-mode
;; Version: 1.1.0
;; Permission is hereby granted, free of charge, to any person
;; obtaining a copy of this software and associated documentation
;; files (the "Software"), to deal in the Software without
;; restriction, including without limitation the rights to use, copy,
;; modify, merge, publish, distribute, sublicense, and/or sell copies
;; of the Software, and to permit persons to whom the Software is
;; furnished to do so, subject to the following conditions:
;; The above copyright notice and this permission notice shall be
;; included in all copies or substantial portions of the Software.
;; THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
;; EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
;; MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
;; NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS
;; BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN
;; ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
;; CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
;; SOFTWARE.
;;; Commentary:
;; This file provides the major mode xcompose-mode, for use in editing
;; .XCompose files, which are used in X-windows systems to define the
;; behavior certain sequential keystroke combinations, usually involving
;; the ‘Multi-Key’.
;;
;; This file is derived from ‘xcompose-mode.el’ found at the following
;; address:
;; https://github.com/kragen/xcompose/blob/master/xcompose-mode.el
;;; Code:
;;;###autoload
(dolist (path (list "\\`/usr/share/X11/locale/[^/]+/Compose\\'"
"\\.XCompose\\'"
(getenv "XCOMPOSEFILE")))
(when path
(add-to-list 'auto-mode-alist (cons path 'xcompose-mode))))
^L
;;; Faces
(defface xcompose-angle-face
'((t (:inherit bold)))
"Face for the angle brackets (<>) around key-names."
:group 'xcompose)
(defface xcompose-keys-face
'((t (:inherit font-lock-constant-face)))
"Face for the key names."
:group 'xcompose)
(defface xcompose-string-face
'((t (:inherit font-lock-string-face)))
"Face for the quoted strings containing the character(s) to be produced."
:group 'xcompose)
(defface xcompose-number-face
'((t (:inherit font-lock-preprocessor-face :weight bold)))
"Face for the hex numbers identifying the code-point."
:group 'xcompose)
(defface xcompose-colon-face
'((t (:inherit bold)))
"Face for the \":\" separating the keystrokes from the character string."
:group 'xcompose)
(defface xcompose-keyword-face
'((t (:inherit font-lock-keyword-face)))
"Face for keywords."
:group 'xcompose)
(defface xcompose-modifier-face
'((t (:inherit font-lock-keyword-face)))
"Face for modifiers."
:group 'xcompose)
(defface xcompose-modifier-prefix-face
'((t . ()))
"Face for modifier prefixes."
:group 'xcompose)
^L
;;; Customisable Variables
(defgroup xcompose nil
"Customization group for `xcompose'."
:prefix "xcompose-"
:group 'languages)
(defcustom xcompose-rule-style 'string-codepoint
"Rule style to use for `xcompose-insert-rule.'
XCompose rules may include a codepoint, a string, or both. For more
details, checkout the xcompose(5) manual page."
:type '(choice (const :tag "Codepoint only" codepoint)
(const :tag "String and codepoint" string-codepoint)
(const :tag "String only" string))
:package-version '(xcompose . "1.0.0")
:group 'xcompose)
^L
;;; Variables
(defvar xcompose-mode-syntax-table
(let ((st (make-syntax-table text-mode-syntax-table)))
(dolist (pair '((?< . "(> ")
(?> . ")< ")
(?# . "< ")
(?_ . "_ ")
(?\n . "> ")
(?{ . "| ")
(?} . "| ")))
(modify-syntax-entry (car pair) (cdr pair) st))
st)
"Syntax table for `xcompose-mode'.")
(defvar xcompose-mode-map
(let ((map (make-sparse-keymap)))
(keymap-set map "C-c C-i" #'xcompose-insert-rule)
map)
"Keymap for `xcompose-mode'.")
(defvar xcompose--modifier-rx
(regexp-opt '("Ctrl" "Lock" "Caps" "Shift" "Alt" "Meta" "None")))
(defvar xcompose-font-lock-keywords
`(("[<>]" . 'xcompose-angle-face)
("<\\([a-zA-Z0-9_]*\\)>" . (1 'xcompose-keys-face))
("\"[^\"]*\"" . 'xcompose-string-face)
("U[0-9A-Fa-f]\\{4,6\\}" . 'xcompose-number-face)
(,xcompose--modifier-rx . 'xcompose-modifier-face)
("[!~]" . 'xcompose-modifier-prefix-face)
(":" . 'xcompose-colon-face)
("^[ \t]*include" . 'xcompose-keyword-face))
"Keywords for `xcompose-mode'.")
(defvar xcompose--char-name-table
(let ((ht (make-hash-table :test #'eq))
(pairs '((#x20 . "space") (?! . "exclam") (?\" . "quotedbl")
(?# . "numbersign") (?$ . "dollar") (?% . "percent")
(?& . "ampersand") (?\' . "apostrophe") (?\( . "parenleft")
(?\) . "parenright") (?* . "asterisk") (?+ . "plus")
(?, . "comma") (?- . "minus") (?. . "period") (?/ . "slash")
(?: . "colon") (?\; . "semicolon") (?< . "less") (?= . "equal")
(?> . "greater") (?? . "question") (?@ . "at")
(?\[ . "bracketleft") (?\\ . "backslash")
(?\] . "bracketright") (?^ . "asciicircum") (?_ . "underscore")
(?` . "grave") (?\{ . "braceleft") (?| . "bar")
(?\} . "braceright") (?~ . "asciitilde"))))
(dolist (pair pairs)
(puthash (car pair) (cdr pair) ht))
ht))
(define-abbrev-table 'xcompose-mode-abbrev-table
'(("<Mu" "<Multi_key>" nil :system t)
("<am" "<ampersand>" nil :system t)
("<ap" "<apostrophe>" nil :system t)
("<asciic" "<asciicircum>" nil :system t)
("<asciit" "<asciitilde>" nil :system t)
("<ast" "<asterisk>" nil :system t)
("<at" "<at>" nil :system t)
("<bac" "<backslash>" nil :system t)
("<bar" "<bar>" nil :system t)
("<bracel" "<braceleft>" nil :system t)
("<bracer" "<braceright>" nil :system t)
("<bracketl" "<bracketleft>" nil :system t)
("<bracketr" "<bracketright>" nil :system t)
("<col" "<colon>" nil :system t)
("<com" "<comma>" nil :system t)
("<do" "<dollar>" nil :system t)
("<eq" "<equal>" nil :system t)
("<ex" "<exclam>" nil :system t)
("<gra" "<grave>" nil :system t)
("<gre" "<greater>" nil :system t)
("<le" "<less>" nil :system t)
("<mi" "<minus>" nil :system t)
("<nu" "<numbersign>" nil :system t)
("<parenl" "<parenleft>" nil :system t)
("<parenr" "<parenright>" nil :system t)
("<perc" "<percent>" nil :system t)
("<peri" "<period>" nil :system t)
("<pl" "<plus>" nil :system t)
("<que" "<question>" nil :system t)
("<quo" "<quotedbl>" nil :system t)
("<se" "<semicolon>" nil :system t)
("<sl" "<slash>" nil :system t)
("<sp" "<space>" nil :system t)
("<un" "<underscore>" nil :system t))
"Abbreviation table for `compose-mode'."
:regexp "\\(<[a-zA-Z0-9_]+\\)"
:case-fixed t)
^L
;;; Functions
(defun xcompose--insert-key (key)
(insert ?< (gethash key xcompose--char-name-table key) "> "))
(defun xcompose-insert-rule ()
"Insert a new remapping rule at point.
Reads a key sequence and a resulting rune from the minibuffer, and
inserts the corresponding remapping rule at point. The style of the rule
is determined by the variable `xcompose-rule-style'."
(interactive)
(let ((keys (vconcat (read-string (format-prompt "Key sequence" nil))))
(rune (read-char-from-minibuffer (format-prompt "Resulting rune" nil))))
(seq-do #'xcompose--insert-key keys)
(insert ": ")
(pcase xcompose-rule-style
('codepoint
(insert (format "U%04X" rune)))
('string
(insert ?\" rune ?\"))
('string-codepoint
(insert (format "\"%c\" U%04X" rune rune))))))
;;;###autoload
(define-derived-mode xcompose-mode conf-mode "XCompose"
"Major mode for .XCompose files
\\{xcompose-mode-map}"
:group 'xcompose
(font-lock-add-keywords nil xcompose-font-lock-keywords)
(setq-local comment-start "# "
comment-start-skip "#+\\s-*"
comment-end ""))
(provide 'xcompose-mode)
;;; xcompose-mode.el ends here
|
