-
Notifications
You must be signed in to change notification settings - Fork 10
/
hui-em-but.el
380 lines (322 loc) · 13.3 KB
/
hui-em-but.el
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
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
;;; hui-em-but.el --- GNU Emacs button highlighting and flashing support -*- lexical-binding: t; -*-
;;
;; Author: Bob Weiner
;;
;; Orig-Date: 21-Aug-92
;; Last-Mod: 26-May-24 at 17:24:25 by Bob Weiner
;;
;; SPDX-License-Identifier: GPL-3.0-or-later
;;
;; Copyright (C) 1992-2022 Free Software Foundation, Inc.
;; See the "HY-COPY" file for license information.
;;
;; This file is part of GNU Hyperbole.
;;; Commentary:
;;
;; Can't use read-only buttons here because then outline-mode
;; becomes unusable.
;;; Code:
;; (when noninteractive
;; ;; Don't load this library
;; (with-current-buffer " *load*"
;; (goto-char (point-max))))
;;; ************************************************************************
;;; Other required Elisp libraries
;;; ************************************************************************
(require 'hload-path)
(require 'custom) ;; For defface.
(require 'hbut)
;; Comment out next line out because this triggers loads of kview
;; which loads klink which contains a defib whose priority should be set
;; by loading klink from hibtypes.el instead.
;; (eval-when-compile (require 'hyrolo))
;;; ************************************************************************
;;; Public variables
;;; ************************************************************************
(defcustom hproperty:but-highlight-flag t
"*Non-nil means highlight named Hyperbole buttons with `hproperty:but-face'."
:type 'boolean
:group 'hyperbole-buttons)
(defcustom hproperty:but-emphasize-flag nil
"*Non-nil means emphasize selectability of Hyperbole button labels.
This is shown when hovering over the button with the mouse."
:type 'boolean
:group 'hyperbole-buttons)
(defcustom hproperty:but-flash-time 1000
"*Emacs button flash delay."
:type '(integer :match (lambda (_widget value) (and (integerp value) (> value 0))))
:group 'hyperbole-buttons)
(make-obsolete-variable 'hproperty:but-flash-time "Use `hproperty:but-flash-time-seconds' instead" "8.0")
(defcustom hproperty:but-flash-time-seconds 0.05
"*Emacs button flash delay."
:type 'float
:group 'hyperbole-buttons)
(defface hbut-flash
'((((class color) (min-colors 88) (background light))
:background "red3")
(((class color) (min-colors 88) (background dark))
:background "red3")
(((class color) (min-colors 16) (background light))
:background "red3")
(((class color) (min-colors 16) (background dark))
:background "red3")
(((class color) (min-colors 8))
:background "red3" :foreground "black")
(t :inverse-video t))
"Face for flashing buttons."
:group 'hyperbole-buttons)
(defcustom hproperty:flash-face 'hbut-flash
"Hyperbole face for flashing hyper-buttons."
:type 'face
:initialize #'custom-initialize-default
:group 'hyperbole-buttons)
(defcustom hproperty:highlight-face 'highlight
"Item highlighting face."
:type 'face
:initialize #'custom-initialize-default
:group 'hyperbole-buttons)
(defface hbut-face
'((((min-colors 88) (background dark)) (:foreground "salmon1"))
(((background dark)) (:background "red" :foreground "black"))
(((min-colors 88)) (:foreground "salmon4"))
(t (:background "red")))
"Face for explicit Hyperbole buttons."
:group 'hyperbole-buttons)
(defcustom hproperty:but-face 'hbut-face
"Hyperbole face for explicit buttons."
:type 'face
:initialize #'custom-initialize-default
:group 'hyperbole-buttons)
(defface hbut-item-face
'((((class color) (min-colors 88) (background light))
:background "yellow")
(((class color) (min-colors 88) (background dark))
:background "yellow")
(((class color) (min-colors 16) (background light))
:background "yellow")
(((class color) (min-colors 16) (background dark))
:background "yellow")
(((class color) (min-colors 8))
:background "yellow" :foreground "black")
(t :inverse-video t))
"Face for Hyperbole list buttons."
:group 'hyperbole-buttons)
(defcustom hproperty:item-face 'hbut-item-face
"Hyperbole face for list hyper-buttons."
:type 'face
:initialize #'custom-initialize-default
:group 'hyperbole-buttons)
(defface ibut-face
'((((min-colors 88) (background dark)) (:foreground "rosybrown"))
(((background dark)) (:background "rosybrown" :foreground "black"))
(((min-colors 88)) (:foreground "rosybrown"))
(t (:background "rosybrown")))
"Face for implicit Hyperbole buttons."
:group 'hyperbole-buttons)
(defcustom hproperty:ibut-face 'ibut-face
"Hyperbole face for implicit buttons."
:type 'face
:initialize #'custom-initialize-default
:group 'hyperbole-buttons)
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
;; Support NEXTSTEP and X window systems.
(and (not (fboundp 'display-color-p))
(fboundp 'x-display-color-p)
(defalias 'display-color-p 'x-display-color-p))
(defun hproperty:but-add (start end face)
"Add between START and END a button using FACE in current buffer.
If `hproperty:but-emphasize-flag' is non-nil when this is called,
emphasize that button is selectable whenever the mouse cursor
moves over it."
(let ((but (make-overlay start end nil t)))
(overlay-put but 'face face)
(when hproperty:but-emphasize-flag
(overlay-put but 'mouse-face 'highlight))))
(defun hproperty:but-clear (&optional pos property value)
"Remove highlighting from any named Hyperbole button at point or POS.
If optional PROPERTY and VALUE are given, remove highlighting only if
the PROPERTY at the position matches VALUE."
(let ((but (hproperty:but-get pos property value)))
(when but
(delete-overlay but))))
(defun hproperty:but-clear-all (&optional regexp-match)
"Remove highlighting from all named Hyperbole buttons in buffer.
If REGEXP-MATCH is non-nil, only buttons matching this argument are
de-highlighted."
(if regexp-match
(progn (ebut:map (lambda (_lbl start end)
(remove-overlays start end 'face hproperty:but-face))
regexp-match 'include-delims)
(ibut:map (lambda (_lbl start end)
(remove-overlays start end 'face hproperty:ibut-face))
regexp-match 'include-delims))
;; Do across whole buffer
(remove-overlays nil nil 'face hproperty:but-face)
(remove-overlays nil nil 'face hproperty:ibut-face)))
(defun hproperty:but-clear-all-in-list (hbut-list)
"Delete all HBUT-LIST hproperties."
(mapc #'delete-overlay hbut-list))
(defun hproperty:but-create (&optional regexp-match)
"Highlight all named Hyperbole buttons in buffer.
De-highlight buttons unless `hproperty:but-highlight-flag' is set.
If REGEXP-MATCH is non-nil, only buttons matching this argument are
highlighted (all others are unhighlighted).
If `hproperty:but-emphasize-flag' is non-nil when this is called,
emphasize that button is selectable whenever the mouse cursor
moves over it."
(interactive)
(hproperty:but-clear-all regexp-match)
(hproperty:but-create-all regexp-match))
(defun hproperty:but-create-all (&optional regexp-match)
"Highlight all named Hyperbole buttons in buffer.
De-highlight buttons unless `hproperty:but-highlight-flag' is set.
If REGEXP-MATCH is non-nil, only buttons matching this argument are
highlighted.
If `hproperty:but-emphasize-flag' is non-nil when this is called,
emphasize that button is selectable whenever the mouse cursor
moves over it."
(when hproperty:but-highlight-flag
(ebut:map (lambda (_lbl start end)
(hproperty:but-add start end hproperty:but-face))
regexp-match 'include-delims)
(ibut:map (lambda (_lbl start end)
(hproperty:but-add start end hproperty:ibut-face))
regexp-match 'include-delims)))
(defun hproperty:but-create-on-yank (_prop-value start end)
"Used in `yank-handled-properties' called with START and END pos of the text."
(save-restriction
(narrow-to-region start end)
(hproperty:but-create-all)))
(defun hproperty:but-delete (hproperty-but)
"Remove HPROPERTY-BUT. See `hproperty:but-get'."
(delete-overlay hproperty-but))
(defun hproperty:but-end (hproperty-but)
"Return the start position of an HPROPERTY-BUT.
See `hproperty:but-get'."
(overlay-end hproperty-but))
(defun hproperty:but-get-all-in-region (start end &optional property value)
"Return all buttons in the current buffer between START and END.
If optional PROPERTY and VALUE are given, return only the first button
with that PROPERTY and VALUE."
(delq nil
(mapcar (lambda (overlay)
(when (memq (overlay-get overlay (or property 'face))
(if property
(list value)
(list hproperty:but-face
hproperty:ibut-face
hproperty:flash-face)))
overlay))
(overlays-in start end))))
(defun hproperty:but-get (&optional pos property value)
"Return button at optional POS or point.
If optional PROPERTY and VALUE are given, return only the first button
with that PROPERTY and VALUE."
(car (hproperty:but-get-all-in-region pos (1+ pos) property value)))
(defun hproperty:but-start (hproperty-but)
"Return the end position of an HPROPERTY-BUT.
See `hproperty:but-get'."
(overlay-start hproperty-but))
(add-to-list 'yank-handled-properties '(hproperty:but-face . hproperty:but-create-on-yank))
;;; ************************************************************************
;;; Private functions
;;; ************************************************************************
(defsubst hproperty:list-cycle (list-ptr list)
"Move LIST-PTR to next element in LIST or when at end to first element."
(or (and list-ptr (setq list-ptr (cdr list-ptr)))
(setq list-ptr list)))
;;; ************************************************************************
;;; Private variables
;;; ************************************************************************
(defconst hproperty:color-list
(when (display-color-p)
(defined-colors)))
(defvar hproperty:color-ptr nil
"Pointer to current color name table to use for Hyperbole buttons.")
(defconst hproperty:good-colors
(if (display-color-p)
'(
"medium violet red" "indianred4" "firebrick1" "DarkGoldenrod"
"NavyBlue" "darkorchid" "tomato3" "mediumseagreen" "deeppink"
"forestgreen" "mistyrose4" "slategrey" "purple4" "dodgerblue3"
"mediumvioletred" "lightsalmon3" "orangered2" "turquoise4" "Gray55")
hproperty:color-list)
"Good colors for contrast against wheat background and black foreground.")
;;; ************************************************************************
;;; Public functions
;;; ************************************************************************
(defun hproperty:cycle-but-color (&optional color)
"Switch button color.
Set color to optional COLOR name or next item referenced by
hproperty:color-ptr."
(interactive "sHyperbole button color: ")
(when (display-color-p)
(when color (setq hproperty:color-ptr nil))
(set-face-foreground
hproperty:but-face (or color (car (hproperty:list-cycle hproperty:color-ptr hproperty:good-colors))))
(redisplay t)
t))
(defun hproperty:but-p (&optional pos property value)
"Return non-nil at point or optional POS iff on a highlighted Hyperbole button."
(memq t (mapcar (lambda (overlay)
(when (memq (overlay-get overlay (or property 'face))
(if property
(list value)
(list hproperty:but-face hproperty:ibut-face)))
t))
(overlays-at (or pos (point))))))
(defun hproperty:set-but-face (pos face)
"Set button face at POS to FACE."
(let ((but (hproperty:but-get pos)))
(when but (overlay-put but 'face face))))
(defun hproperty:but-flash ()
"Flash a Hyperbole button at or near point to indicate selection."
(interactive)
(let* ((categ (hattr:get 'hbut:current 'categ))
(start (hattr:get 'hbut:current 'lbl-start))
(end (hattr:get 'hbut:current 'lbl-end))
(ibut)
(prev)
(categ-face))
(if (eq categ 'explicit)
(setq categ-face hproperty:but-face)
(setq categ-face hproperty:ibut-face
ibut t))
(if (and start end)
(unless (setq prev (hproperty:but-p start))
(hproperty:but-add start end categ-face))
(setq start (point)))
(when (hproperty:but-p start)
(unwind-protect
(progn
(hproperty:set-but-face start hproperty:flash-face)
(sit-for hproperty:but-flash-time-seconds)) ;; Force display update
(hproperty:set-but-face start categ-face)
(redisplay t)))
(and ibut (not prev) (hproperty:but-clear start))))
(defun hproperty:select-item (&optional pnt)
"Select item in current buffer at optional position PNT with hproperty:item-face."
(when pnt (goto-char pnt))
(skip-chars-forward " \t")
(skip-chars-backward "^ \t\n\r")
(let ((start (point)))
(save-excursion
(skip-chars-forward "^ \t\n\r")
(hproperty:but-add start (point) hproperty:item-face)))
(sit-for 0)) ;; Force display update
(defun hproperty:select-line (&optional pnt)
"Select line in current buffer at optional position PNT with hproperty:item-face."
(when pnt (goto-char pnt))
(hproperty:but-add (line-beginning-position) (line-end-position) hproperty:item-face)
;; Force display update
(sit-for 0))
;;; ************************************************************************
;;; Private variables
;;; ************************************************************************
(defvar hproperty:item-button nil
"Button used to highlight an item in a listing buffer.")
(make-variable-buffer-local 'hproperty:item-button)
(provide 'hui-em-but)
;;; hui-em-but.el ends here