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
|
;;; ezimage.el --- Generalized Image management -*- lexical-binding: t -*-
;; Copyright (C) 1999-2023 Free Software Foundation, Inc.
;; Author: Eric M. Ludlam <zappo@gnu.org>
;; Keywords: file, tags, tools
;; This file is part of GNU Emacs.
;; GNU Emacs 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.
;; GNU Emacs 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 GNU Emacs. If not, see <https://www.gnu.org/licenses/>.
;;; Commentary:
;;
;; A few routines for placing an image over text that will work for any
;; Emacs implementation without error. When images are not supported, then
;; they are just not displayed.
;;
;; The idea is that gui buffers (trees, buttons, etc) will have text
;; representations of the GUI elements. These routines will replace the text
;; with an image when images are available.
;;; Code:
(require 'image)
(defcustom ezimage-use-images (and (display-images-p)
(image-type-available-p 'xpm))
"Non-nil means ezimage should display icons."
:group 'ezimage
:version "21.1"
:type 'boolean)
;;; Create our own version of defimage
(defmacro defezimage (variable imagespec docstring)
"Define VARIABLE as an image if `defimage' is not available.
IMAGESPEC is the image data, and DOCSTRING is documentation for the image."
(declare (indent defun))
`(progn
(defimage ,variable ,imagespec ,docstring)
(put (quote ,variable) 'ezimage t)))
(defezimage ezimage-directory
((:type xpm :file "ezimage/dir.xpm" :ascent center))
"Image used for empty directories.")
(defezimage ezimage-directory-plus
((:type xpm :file "ezimage/dir-plus.xpm" :ascent center))
"Image used for closed directories with stuff in them.")
(defezimage ezimage-directory-minus
((:type xpm :file "ezimage/dir-minus.xpm" :ascent center))
"Image used for open directories with stuff in them.")
(defezimage ezimage-page-plus
((:type xpm :file "ezimage/page-plus.xpm" :ascent center))
"Image used for closed files with stuff in them.")
(defezimage ezimage-page-minus
((:type xpm :file "ezimage/page-minus.xpm" :ascent center))
"Image used for open files with stuff in them.")
(defezimage ezimage-page
((:type xpm :file "ezimage/page.xpm" :ascent center))
"Image used for files with nothing interesting in it.")
(defezimage ezimage-tag
((:type xpm :file "ezimage/tag.xpm" :ascent center))
"Image used for tags.")
(defezimage ezimage-tag-plus
((:type xpm :file "ezimage/tag-plus.xpm" :ascent center))
"Image used for closed tag groups.")
(defezimage ezimage-tag-minus
((:type xpm :file "ezimage/tag-minus.xpm" :ascent center))
"Image used for open tags.")
(defezimage ezimage-tag-gt
((:type xpm :file "ezimage/tag-gt.xpm" :ascent center))
"Image used for closed tags (with twist arrow).")
(defezimage ezimage-tag-v
((:type xpm :file "ezimage/tag-v.xpm" :ascent center))
"Image used for open tags (with twist arrow).")
(defezimage ezimage-tag-type
((:type xpm :file "ezimage/tag-type.xpm" :ascent center))
"Image used for tags that represent a data type.")
(defezimage ezimage-box-plus
((:type xpm :file "ezimage/box-plus.xpm" :ascent center))
"Image of a closed box.")
(defezimage ezimage-box-minus
((:type xpm :file "ezimage/box-minus.xpm" :ascent center))
"Image of an open box.")
(defezimage ezimage-mail
((:type xpm :file "ezimage/mail.xpm" :ascent center))
"Image of an envelope.")
(defezimage ezimage-checkout
((:type xpm :file "ezimage/checkmark.xpm" :ascent center))
"Image representing a checkmark. For files checked out of a VC.")
(defezimage ezimage-object
((:type xpm :file "ezimage/bits.xpm" :ascent center))
"Image representing bits (an object file.)")
(defezimage ezimage-object-out-of-date
((:type xpm :file "ezimage/bitsbang.xpm" :ascent center))
"Image representing bits with a ! in it. (An out of data object file.)")
(defezimage ezimage-label
((:type xpm :file "ezimage/label.xpm" :ascent center))
"Image used for label prefix.")
(defezimage ezimage-lock
((:type xpm :file "ezimage/lock.xpm" :ascent center))
"Image of a lock. Used for Read Only, or private.")
(defezimage ezimage-unlock
((:type xpm :file "ezimage/unlock.xpm" :ascent center))
"Image of an unlocked lock.")
(defezimage ezimage-key
((:type xpm :file "ezimage/key.xpm" :ascent center))
"Image of a key.")
(defezimage ezimage-document-tag
((:type xpm :file "ezimage/doc.xpm" :ascent center))
"Image used to indicate documentation available.")
(defezimage ezimage-document-plus
((:type xpm :file "ezimage/doc-plus.xpm" :ascent center))
"Image used to indicate closed documentation.")
(defezimage ezimage-document-minus
((:type xpm :file "ezimage/doc-minus.xpm" :ascent center))
"Image used to indicate open documentation.")
(defezimage ezimage-info-tag
((:type xpm :file "ezimage/info.xpm" :ascent center))
"Image used to indicate more information available.")
(defvar ezimage-expand-image-button-alist
'(
;; here are some standard representations
("<+>" . ezimage-directory-plus)
("<->" . ezimage-directory-minus)
("< >" . ezimage-directory)
("[+]" . ezimage-page-plus)
("[-]" . ezimage-page-minus)
("[?]" . ezimage-page)
("[ ]" . ezimage-page)
("{+}" . ezimage-box-plus)
("{-}" . ezimage-box-minus)
;; Some vaguely representative entries
("*" . ezimage-checkout)
("#" . ezimage-object)
("!" . ezimage-object-out-of-date)
("%" . ezimage-lock)
)
"List of text and image associations.")
(defun ezimage-insert-image-button-maybe (start length &optional string)
"Insert an image button based on text starting at START for LENGTH chars.
If buttontext is unknown, just insert that text.
If we have an image associated with it, use that image.
Optional argument STRING is a string upon which to add text properties."
(when ezimage-use-images
(let* ((bt (buffer-substring start (+ length start)))
(a (assoc bt ezimage-expand-image-button-alist)))
(if (and a (symbol-value (cdr a)))
(ezimage-insert-over-text (symbol-value (cdr a))
start
(+ start (length bt))))))
string)
(defun ezimage-image-over-string (string &optional alist)
"Insert over the text in STRING an image found in ALIST.
Return STRING with properties applied."
(if ezimage-use-images
(let ((a (assoc string alist)))
(if (and a (symbol-value (cdr a)))
(ezimage-insert-over-text (symbol-value (cdr a))
0 (length string)
string)
string))
string))
(defun ezimage-insert-over-text (image start end &optional string)
"Place IMAGE over the text between START and END.
Assumes the image is part of a GUI and can be clicked on.
Optional argument STRING is a string upon which to add text properties."
(when ezimage-use-images
(add-text-properties start end
(list 'display image
'rear-nonsticky (list 'display))
string))
string)
(defun ezimage-image-association-dump ()
"Dump out the current state of the Ezimage image alist.
See `ezimage-expand-image-button-alist' for details."
(interactive)
(with-output-to-temp-buffer "*Ezimage Images*"
(with-current-buffer "*Ezimage Images*"
(goto-char (point-max))
(insert "Ezimage image cache.\n\n")
(let ((start (point)) (end nil))
(insert "Image\tText\tImage Name")
(setq end (point))
(insert "\n")
(put-text-property start end 'face 'underline))
(let ((ia ezimage-expand-image-button-alist))
(while ia
(let ((start (point)))
(insert (car (car ia)))
(insert "\t")
(ezimage-insert-image-button-maybe start
(length (car (car ia))))
(insert (car (car ia)) "\t" (format "%s" (cdr (car ia))) "\n"))
(setq ia (cdr ia)))))))
(defun ezimage-image-dump ()
"Dump out the current state of the Ezimage image alist.
See `ezimage-expand-image-button-alist' for details."
(interactive)
(with-output-to-temp-buffer "*Ezimage Images*"
(with-current-buffer "*Ezimage Images*"
(goto-char (point-max))
(insert "Ezimage image cache.\n\n")
(let ((start (point)) (end nil))
(insert "Image\tImage Name")
(setq end (point))
(insert "\n")
(put-text-property start end 'face 'underline))
(let ((ia (ezimage-all-images)))
(while ia
(let ((start (point)))
(insert "cm")
(ezimage-insert-over-text (symbol-value (car ia)) start (point))
(insert "\t" (format "%s" (car ia)) "\n"))
(setq ia (cdr ia)))))))
(defun ezimage-all-images ()
"Return a list of all variables containing ez images."
(let ((ans nil))
(mapatoms (lambda (sym)
(if (get sym 'ezimage) (setq ans (cons sym ans)))))
(setq ans (sort ans (lambda (a b)
(string< (symbol-name a) (symbol-name b)))))
ans))
(provide 'ezimage)
;;; ezimage.el ends here
|
