Commit | Line | Data |
---|---|---|
dcb90b5f | 1 | ;;; descr-text.el --- describe text mode |
2a1e884e | 2 | |
0d30b337 | 3 | ;; Copyright (C) 1994, 1995, 1996, 2001, 2002, 2003, 2004, |
ae940284 | 4 | ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc. |
2a1e884e RS |
5 | |
6 | ;; Author: Boris Goldowsky <boris@gnu.org> | |
57d79b99 | 7 | ;; Maintainer: FSF |
2d65673f | 8 | ;; Keywords: faces, i18n, Unicode, multilingual |
2a1e884e RS |
9 | |
10 | ;; This file is part of GNU Emacs. | |
11 | ||
eb3fa2cf | 12 | ;; GNU Emacs is free software: you can redistribute it and/or modify |
2a1e884e | 13 | ;; it under the terms of the GNU General Public License as published by |
eb3fa2cf GM |
14 | ;; the Free Software Foundation, either version 3 of the License, or |
15 | ;; (at your option) any later version. | |
2a1e884e RS |
16 | |
17 | ;; GNU Emacs is distributed in the hope that it will be useful, | |
18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of | |
19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
20 | ;; GNU General Public License for more details. | |
21 | ||
22 | ;; You should have received a copy of the GNU General Public License | |
eb3fa2cf | 23 | ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>. |
2a1e884e RS |
24 | |
25 | ;;; Commentary: | |
26 | ||
27 | ;;; Describe-Text Mode. | |
28 | ||
29 | ;;; Code: | |
30 | ||
e5a5c80c NR |
31 | (eval-when-compile (require 'quail)) |
32 | (require 'help-fns) | |
2a1e884e RS |
33 | |
34 | ;;; Describe-Text Utilities. | |
35 | ||
36 | (defun describe-text-widget (widget) | |
37 | "Insert text to describe WIDGET in the current buffer." | |
57d79b99 NR |
38 | (insert-text-button |
39 | (symbol-name (if (symbolp widget) widget (car widget))) | |
40 | 'action `(lambda (&rest ignore) | |
e5a5c80c NR |
41 | (widget-browse ',widget)) |
42 | 'help-echo "mouse-2, RET: browse this widget") | |
57d79b99 | 43 | (insert " ") |
e5a5c80c NR |
44 | (insert-text-button |
45 | "(widget)Top" 'type 'help-info 'help-args '("(widget)Top"))) | |
2a1e884e RS |
46 | |
47 | (defun describe-text-sexp (sexp) | |
48 | "Insert a short description of SEXP in the current buffer." | |
49 | (let ((pp (condition-case signal | |
50 | (pp-to-string sexp) | |
51 | (error (prin1-to-string signal))))) | |
70583cb5 | 52 | (when (string-match-p "\n\\'" pp) |
2a1e884e | 53 | (setq pp (substring pp 0 (1- (length pp))))) |
70583cb5 JB |
54 | |
55 | (if (and (not (string-match-p "\n" pp)) | |
56 | (<= (length pp) (- (window-width) (current-column)))) | |
57d79b99 NR |
57 | (insert pp) |
58 | (insert-text-button | |
2fd54bf8 | 59 | "[Show]" 'action `(lambda (&rest ignore) |
70583cb5 JB |
60 | (with-output-to-temp-buffer |
61 | "*Pp Eval Output*" | |
62 | (princ ',pp))) | |
57d79b99 | 63 | 'help-echo "mouse-2, RET: pretty print value in another buffer")))) |
2a1e884e | 64 | |
4adb7c09 | 65 | (defun describe-property-list (properties) |
2a1e884e RS |
66 | "Insert a description of PROPERTIES in the current buffer. |
67 | PROPERTIES should be a list of overlay or text properties. | |
7fb0741b | 68 | The `category', `face' and `font-lock-face' properties are made |
57d79b99 | 69 | into help buttons that call `describe-text-category' or |
7fb0741b | 70 | `describe-face' when pushed." |
e2fa2f6e | 71 | ;; Sort the properties by the size of their value. |
8b18fb8f | 72 | (dolist (elt (sort (let (ret) |
e2fa2f6e | 73 | (while properties |
8b18fb8f | 74 | (push (list (pop properties) (pop properties)) ret)) |
e2fa2f6e | 75 | ret) |
d502fc06 RS |
76 | (lambda (a b) (string< (prin1-to-string (nth 0 a) t) |
77 | (prin1-to-string (nth 0 b) t))))) | |
e2fa2f6e CW |
78 | (let ((key (nth 0 elt)) |
79 | (value (nth 1 elt))) | |
57d79b99 | 80 | (insert (propertize (format " %-20s " key) |
e5a5c80c | 81 | 'face 'help-argument-name)) |
2a1e884e | 82 | (cond ((eq key 'category) |
e5a5c80c NR |
83 | (insert-text-button |
84 | (symbol-name value) | |
85 | 'action `(lambda (&rest ignore) | |
86 | (describe-text-category ',value)) | |
87 | 'help-echo "mouse-2, RET: describe this category")) | |
8b18fb8f | 88 | ((memq key '(face font-lock-face mouse-face)) |
2fd54bf8 JL |
89 | (insert-text-button |
90 | (format "%S" value) | |
91 | 'type 'help-face 'help-args (list value))) | |
f13cc97d | 92 | ((widgetp value) |
2a1e884e RS |
93 | (describe-text-widget value)) |
94 | (t | |
8b18fb8f | 95 | (describe-text-sexp value)))) |
57d79b99 | 96 | (insert "\n"))) |
2a1e884e RS |
97 | \f |
98 | ;;; Describe-Text Commands. | |
99 | ||
100 | (defun describe-text-category (category) | |
101 | "Describe a text property category." | |
e5a5c80c NR |
102 | (interactive "SCategory: ") |
103 | (help-setup-xref (list #'describe-text-category category) (interactive-p)) | |
2a1e884e | 104 | (save-excursion |
ca9088e7 SM |
105 | (with-output-to-temp-buffer "*Help*" |
106 | (set-buffer standard-output) | |
57d79b99 | 107 | (insert "Category " (format "%S" category) ":\n\n") |
4adb7c09 | 108 | (describe-property-list (symbol-plist category)) |
2a1e884e RS |
109 | (goto-char (point-min))))) |
110 | ||
111 | ;;;###autoload | |
4adb7c09 RS |
112 | (defun describe-text-properties (pos &optional output-buffer) |
113 | "Describe widgets, buttons, overlays and text properties at POS. | |
114 | Interactively, describe them for the character after point. | |
115 | If optional second argument OUTPUT-BUFFER is non-nil, | |
116 | insert the output into that buffer, and don't initialize or clear it | |
117 | otherwise." | |
2a1e884e | 118 | (interactive "d") |
4adb7c09 RS |
119 | (if (>= pos (point-max)) |
120 | (error "No character follows specified position")) | |
121 | (if output-buffer | |
122 | (describe-text-properties-1 pos output-buffer) | |
123 | (if (not (or (text-properties-at pos) (overlays-at pos))) | |
124 | (message "This is plain text.") | |
0911ac26 KS |
125 | (let ((buffer (current-buffer)) |
126 | (target-buffer "*Help*")) | |
127 | (when (eq buffer (get-buffer target-buffer)) | |
e217c04e | 128 | (setq target-buffer "*Help*<2>")) |
4adb7c09 | 129 | (save-excursion |
0911ac26 | 130 | (with-output-to-temp-buffer target-buffer |
ca9088e7 | 131 | (set-buffer standard-output) |
4adb7c09 | 132 | (setq output-buffer (current-buffer)) |
57d79b99 | 133 | (insert "Text content at position " (format "%d" pos) ":\n\n") |
4adb7c09 RS |
134 | (with-current-buffer buffer |
135 | (describe-text-properties-1 pos output-buffer)) | |
4adb7c09 RS |
136 | (goto-char (point-min)))))))) |
137 | ||
138 | (defun describe-text-properties-1 (pos output-buffer) | |
2a1e884e RS |
139 | (let* ((properties (text-properties-at pos)) |
140 | (overlays (overlays-at pos)) | |
2a1e884e RS |
141 | (wid-field (get-char-property pos 'field)) |
142 | (wid-button (get-char-property pos 'button)) | |
143 | (wid-doc (get-char-property pos 'widget-doc)) | |
144 | ;; If button.el is not loaded, we have no buttons in the text. | |
145 | (button (and (fboundp 'button-at) (button-at pos))) | |
146 | (button-type (and button (button-type button))) | |
147 | (button-label (and button (button-label button))) | |
148 | (widget (or wid-field wid-button wid-doc))) | |
4adb7c09 RS |
149 | (with-current-buffer output-buffer |
150 | ;; Widgets | |
151 | (when (widgetp widget) | |
152 | (newline) | |
57d79b99 NR |
153 | (insert (cond (wid-field "This is an editable text area") |
154 | (wid-button "This is an active area") | |
155 | (wid-doc "This is documentation text"))) | |
156 | (insert " of a ") | |
4adb7c09 | 157 | (describe-text-widget widget) |
57d79b99 | 158 | (insert ".\n\n")) |
4adb7c09 RS |
159 | ;; Buttons |
160 | (when (and button (not (widgetp wid-button))) | |
161 | (newline) | |
2fd54bf8 JL |
162 | (insert "Here is a `" (format "%S" button-type) |
163 | "' button labeled `" button-label "'.\n\n")) | |
4adb7c09 RS |
164 | ;; Overlays |
165 | (when overlays | |
166 | (newline) | |
167 | (if (eq (length overlays) 1) | |
57d79b99 NR |
168 | (insert "There is an overlay here:\n") |
169 | (insert "There are " (format "%d" (length overlays)) | |
4adb7c09 RS |
170 | " overlays here:\n")) |
171 | (dolist (overlay overlays) | |
57d79b99 | 172 | (insert " From " (format "%d" (overlay-start overlay)) |
4adb7c09 RS |
173 | " to " (format "%d" (overlay-end overlay)) "\n") |
174 | (describe-property-list (overlay-properties overlay))) | |
57d79b99 | 175 | (insert "\n")) |
4adb7c09 RS |
176 | ;; Text properties |
177 | (when properties | |
178 | (newline) | |
57d79b99 | 179 | (insert "There are text properties here:\n") |
4adb7c09 | 180 | (describe-property-list properties))))) |
d6c135fb | 181 | \f |
950b5859 | 182 | (defcustom describe-char-unidata-list |
0e0f6cbd | 183 | '(name old-name general-category decomposition) |
f1f194de KH |
184 | "List of Unicode-based character property names shown by `describe-char'." |
185 | :group 'mule | |
8589dc17 | 186 | :version "23.1" |
3253c7c6 SM |
187 | :type '(choice (const :tag "All properties" t) |
188 | (set | |
189 | (const :tag "Unicode Name" name) | |
0e0f6cbd | 190 | (const :tag "Unicode old name" old-name) |
3253c7c6 SM |
191 | (const :tag "Unicode general category " general-category) |
192 | (const :tag "Unicode canonical combining class" | |
193 | canonical-combining-class) | |
194 | (const :tag "Unicode bidi class" bidi-class) | |
195 | (const :tag "Unicode decomposition mapping" decomposition) | |
196 | (const :tag "Unicode decimal digit value" decimal-digit-value) | |
197 | (const :tag "Unicode digit value" digit-value) | |
198 | (const :tag "Unicode numeric value" numeric-value) | |
199 | (const :tag "Unicode mirrored" mirrored) | |
3253c7c6 SM |
200 | (const :tag "Unicode ISO 10646 comment" iso-10646-comment) |
201 | (const :tag "Unicode simple uppercase mapping" uppercase) | |
202 | (const :tag "Unicode simple lowercase mapping" lowercase) | |
203 | (const :tag "Unicode simple titlecase mapping" titlecase)))) | |
f1f194de | 204 | |
49c2a2dc SM |
205 | (defcustom describe-char-unicodedata-file nil |
206 | "Location of Unicode data file. | |
2acb13b1 | 207 | This is the UnicodeData.txt file from the Unicode Consortium, used for |
2a4960f9 | 208 | diagnostics. If it is non-nil `describe-char' will print data |
49c2a2dc SM |
209 | looked up from it. This facility is mostly of use to people doing |
210 | multilingual development. | |
4adb7c09 | 211 | |
2acb13b1 JB |
212 | This is a fairly large file, not typically present on GNU systems. |
213 | At the time of writing it is at the URL | |
57d79b99 | 214 | `http://www.unicode.org/Public/UNIDATA/UnicodeData.txt'." |
49c2a2dc | 215 | :group 'mule |
bf247b6e | 216 | :version "22.1" |
49c2a2dc SM |
217 | :type '(choice (const :tag "None" nil) |
218 | file)) | |
831ccfa6 | 219 | |
49c2a2dc SM |
220 | (defun describe-char-unicode-data (char) |
221 | "Return a list of Unicode data for unicode CHAR. | |
222 | Each element is a list of a property description and the property value. | |
f1f194de KH |
223 | The list is null if CHAR isn't found in `describe-char-unicodedata-file'. |
224 | This function is semi-obsolete. Use `get-char-code-property'." | |
49c2a2dc SM |
225 | (when describe-char-unicodedata-file |
226 | (unless (file-exists-p describe-char-unicodedata-file) | |
227 | (error "`unicodedata-file' %s not found" describe-char-unicodedata-file)) | |
def7167b JB |
228 | (with-current-buffer (get-buffer-create " *Unicode Data*") |
229 | (when (zerop (buffer-size)) | |
230 | ;; Don't use -literally in case of DOS line endings. | |
231 | (insert-file-contents describe-char-unicodedata-file)) | |
49c2a2dc SM |
232 | (goto-char (point-min)) |
233 | (let ((hex (format "%04X" char)) | |
234 | found first last) | |
235 | (if (re-search-forward (concat "^" hex) nil t) | |
236 | (setq found t) | |
237 | ;; It's not listed explicitly. Look for ranges, e.g. CJK | |
238 | ;; ideographs, and check whether it's in one of them. | |
239 | (while (and (re-search-forward "^\\([^;]+\\);[^;]+First>;" nil t) | |
240 | (>= char (setq first | |
241 | (string-to-number (match-string 1) 16))) | |
242 | (progn | |
243 | (forward-line 1) | |
244 | (looking-at "^\\([^;]+\\);[^;]+Last>;") | |
245 | (> char | |
246 | (setq last | |
247 | (string-to-number (match-string 1) 16)))))) | |
248 | (if (and (>= char first) | |
249 | (<= char last)) | |
250 | (setq found t))) | |
251 | (if found | |
252 | (let ((fields (mapcar (lambda (elt) | |
253 | (if (> (length elt) 0) | |
254 | elt)) | |
255 | (cdr (split-string | |
256 | (buffer-substring | |
257 | (line-beginning-position) | |
258 | (line-end-position)) | |
259 | ";"))))) | |
260 | ;; The length depends on whether the last field was empty. | |
261 | (unless (or (= 13 (length fields)) | |
262 | (= 14 (length fields))) | |
263 | (error "Invalid contents in %s" describe-char-unicodedata-file)) | |
264 | ;; The field names and values lists are slightly | |
265 | ;; modified from Mule-UCS unidata.el. | |
266 | (list | |
267 | (list "Name" (let ((name (nth 0 fields))) | |
268 | ;; Check for <..., First>, <..., Last> | |
269 | (if (string-match "\\`\\(<[^,]+\\)," name) | |
270 | (concat (match-string 1 name) ">") | |
271 | name))) | |
272 | (list "Category" | |
f1f194de KH |
273 | (let ((val (nth 1 fields))) |
274 | (or (char-code-property-description | |
275 | 'general-category (intern val)) | |
276 | val))) | |
49c2a2dc | 277 | (list "Combining class" |
f1f194de KH |
278 | (let ((val (nth 1 fields))) |
279 | (or (char-code-property-description | |
280 | 'canonical-combining-class (intern val)) | |
281 | val))) | |
49c2a2dc | 282 | (list "Bidi category" |
f1f194de KH |
283 | (let ((val (nth 1 fields))) |
284 | (or (char-code-property-description | |
285 | 'bidi-class (intern val)) | |
286 | val))) | |
49c2a2dc SM |
287 | (list |
288 | "Decomposition" | |
289 | (if (nth 4 fields) | |
290 | (let* ((parts (split-string (nth 4 fields))) | |
291 | (info (car parts))) | |
292 | (if (string-match "\\`<\\(.+\\)>\\'" info) | |
293 | (setq info (match-string 1 info)) | |
294 | (setq info nil)) | |
295 | (if info (setq parts (cdr parts))) | |
49c2a2dc SM |
296 | (setq parts (mapconcat |
297 | (lambda (arg) | |
f1f194de | 298 | (string (string-to-number arg 16))) |
49c2a2dc SM |
299 | parts " ")) |
300 | (concat info parts)))) | |
301 | (list "Decimal digit value" | |
302 | (nth 5 fields)) | |
303 | (list "Digit value" | |
304 | (nth 6 fields)) | |
305 | (list "Numeric value" | |
306 | (nth 7 fields)) | |
307 | (list "Mirrored" | |
308 | (if (equal "Y" (nth 8 fields)) | |
309 | "yes")) | |
310 | (list "Old name" (nth 9 fields)) | |
311 | (list "ISO 10646 comment" (nth 10 fields)) | |
312 | (list "Uppercase" (and (nth 11 fields) | |
f1f194de KH |
313 | (string (string-to-number |
314 | (nth 11 fields) 16)))) | |
49c2a2dc | 315 | (list "Lowercase" (and (nth 12 fields) |
f1f194de KH |
316 | (string (string-to-number |
317 | (nth 12 fields) 16)))) | |
49c2a2dc | 318 | (list "Titlecase" (and (nth 13 fields) |
f1f194de KH |
319 | (string (string-to-number |
320 | (nth 13 fields) 16))))))))))) | |
7fb0741b | 321 | |
aa360da1 GM |
322 | ;; Not defined on builds without X, but behind display-graphic-p. |
323 | (declare-function internal-char-font "fontset.c" (position &optional ch)) | |
324 | ||
7fb0741b KH |
325 | ;; Return information about how CHAR is displayed at the buffer |
326 | ;; position POS. If the selected frame is on a graphic display, | |
7a674474 KH |
327 | ;; return a string "FONT-DRIVER:FONT-NAME (GLYPH-CODE)" where: |
328 | ;; FONT-DRIVER is the font-driver name, | |
329 | ;; FONT-NAME is the font name, | |
330 | ;; GLYPH-CODE is a hexadigit string representing the glyph-ID. | |
331 | ;; Otherwise, return a string describing the terminal codes for the | |
332 | ;; character. | |
7fb0741b KH |
333 | (defun describe-char-display (pos char) |
334 | (if (display-graphic-p (selected-frame)) | |
e463f071 | 335 | (let ((char-font-info (internal-char-font pos char))) |
a6bbf9f4 | 336 | (if char-font-info |
7a674474 | 337 | (let ((type (font-get (car char-font-info) :type)) |
c57b496b | 338 | (name (font-xlfd-name (car char-font-info))) |
7a674474 KH |
339 | (code (cdr char-font-info))) |
340 | (if (integerp code) | |
341 | (format "%s:%s (#x%02X)" type name code) | |
342 | (format "%s:%s (#x%04X%04X)" | |
343 | type name (car code) (cdr code)))))) | |
dfc7a783 KH |
344 | (let* ((charset (get-text-property pos 'charset)) |
345 | (coding (terminal-coding-system)) | |
346 | (encoded (encode-coding-char char coding charset))) | |
7fb0741b | 347 | (if encoded |
96065fce | 348 | (encoded-string-description encoded coding))))) |
7fb0741b | 349 | |
d6c135fb | 350 | \f |
7a674474 KH |
351 | ;; Return a string of CH with composition for padding on both sides. |
352 | ;; It is displayed without overlapping with the left/right columns. | |
353 | (defsubst describe-char-padded-string (ch) | |
354 | (compose-string (string ch) 0 1 (format "\t%c\t" ch))) | |
355 | ||
d703f938 JB |
356 | ;; Return a nicely formated list of categories; extended category |
357 | ;; description is added to the category name as a tooltip | |
358 | (defsubst describe-char-categories (category-set) | |
359 | (let ((mnemonics (category-set-mnemonics category-set))) | |
360 | (unless (eq mnemonics "") | |
361 | (list (mapconcat | |
362 | #'(lambda (x) | |
363 | (let* ((c (category-docstring x)) | |
364 | (doc (if (string-match "\\`\\(.*?\\)\n\\(.*\\)\\'" c) | |
365 | (propertize (match-string 1 c) | |
366 | 'help-echo (match-string 2 c)) | |
367 | c))) | |
368 | (format "%c:%s" x doc))) | |
369 | mnemonics ", "))))) | |
370 | ||
4adb7c09 RS |
371 | ;;;###autoload |
372 | (defun describe-char (pos) | |
373 | "Describe the character after POS (interactively, the character after point). | |
374 | The information includes character code, charset and code points in it, | |
375 | syntax, category, how the character is encoded in a file, | |
376 | character composition information (if relevant), | |
377 | as well as widgets, buttons, overlays, and text properties." | |
378 | (interactive "d") | |
4adb7c09 RS |
379 | (if (>= pos (point-max)) |
380 | (error "No character follows specified position")) | |
381 | (let* ((char (char-after pos)) | |
2d3e4f02 KH |
382 | (eight-bit-p (and (not enable-multibyte-characters) (>= char 128))) |
383 | (charset (if eight-bit-p 'eight-bit | |
384 | (or (get-text-property pos 'charset) (char-charset char)))) | |
ca9088e7 | 385 | (composition (find-composition pos nil nil t)) |
7fb0741b KH |
386 | (component-chars nil) |
387 | (display-table (or (window-display-table) | |
388 | buffer-display-table | |
389 | standard-display-table)) | |
390 | (disp-vector (and display-table (aref display-table char))) | |
4adb7c09 | 391 | (multibyte-p enable-multibyte-characters) |
6482d093 KH |
392 | (overlays (mapcar #'(lambda (o) (overlay-properties o)) |
393 | (overlays-at pos))) | |
6398b88f AS |
394 | (char-description (if (not multibyte-p) |
395 | (single-key-description char) | |
396 | (if (< char 128) | |
397 | (single-key-description char) | |
398 | (string-to-multibyte | |
399 | (char-to-string char))))) | |
e5a5c80c NR |
400 | (text-props-desc |
401 | (let ((tmp-buf (generate-new-buffer " *text-props*"))) | |
402 | (unwind-protect | |
403 | (progn | |
404 | (describe-text-properties pos tmp-buf) | |
405 | (with-current-buffer tmp-buf (buffer-string))) | |
406 | (kill-buffer tmp-buf)))) | |
327719ee | 407 | item-list max-width code) |
831ccfa6 | 408 | |
2d3e4f02 KH |
409 | (if multibyte-p |
410 | (or (setq code (encode-char char charset)) | |
411 | (setq charset (char-charset char) | |
412 | code (encode-char char charset))) | |
413 | (setq code char)) | |
ed441285 KH |
414 | (setq item-list |
415 | `(("character" | |
41882805 | 416 | ,(format "%s (%d, #o%o, #x%x)" |
e5a5c80c NR |
417 | (apply 'propertize char-description |
418 | (text-properties-at pos)) | |
41882805 | 419 | char char char)) |
327719ee | 420 | ("preferred charset" |
57d79b99 | 421 | ,`(insert-text-button |
e5a5c80c NR |
422 | ,(symbol-name charset) |
423 | 'type 'help-character-set 'help-args '(,charset)) | |
ed441285 KH |
424 | ,(format "(%s)" (charset-description charset))) |
425 | ("code point" | |
879dfc97 KH |
426 | ,(let ((str (if (integerp code) |
427 | (format (if (< code 256) "0x%02X" "0x%04X") code) | |
428 | (format "0x%04X%04X" (car code) (cdr code))))) | |
429 | (if (<= (charset-dimension charset) 2) | |
41882805 MB |
430 | `(insert-text-button |
431 | ,str | |
432 | 'action (lambda (&rest ignore) | |
879dfc97 KH |
433 | (list-charset-chars ',charset) |
434 | (with-selected-window | |
435 | (get-buffer-window "*Character List*" 0) | |
436 | (goto-char (point-min)) | |
437 | (forward-line 2) ;Skip the header. | |
438 | (let ((case-fold-search nil)) | |
439 | (if (search-forward ,(char-to-string char) | |
440 | nil t) | |
441 | (goto-char (match-beginning 0)))))) | |
41882805 MB |
442 | 'help-echo |
443 | "mouse-2, RET: show this character in its character set") | |
879dfc97 | 444 | str))) |
ed441285 | 445 | ("syntax" |
d8ac3d27 | 446 | ,(let ((syntax (syntax-after pos))) |
ed441285 KH |
447 | (with-temp-buffer |
448 | (internal-describe-syntax-value syntax) | |
449 | (buffer-string)))) | |
450 | ("category" | |
2d3e4f02 KH |
451 | ,@(if (not eight-bit-p) |
452 | (let ((category-set (char-category-set char))) | |
453 | (if category-set | |
454 | (describe-char-categories category-set) | |
455 | '("-- none --"))))) | |
309473d0 | 456 | ("to input" |
2d3e4f02 KH |
457 | ,@(if (not eight-bit-p) |
458 | (let ((key-list (and (eq input-method-function | |
459 | 'quail-input-method) | |
460 | (quail-find-key char)))) | |
461 | (if (consp key-list) | |
462 | (list "type" | |
463 | (mapconcat #'(lambda (x) (concat "\"" x "\"")) | |
464 | key-list " or ") | |
465 | "with" | |
466 | `(insert-text-button | |
467 | ,current-input-method | |
468 | 'type 'help-input-method | |
469 | 'help-args '(,current-input-method))))))) | |
ed441285 | 470 | ("buffer code" |
2d3e4f02 KH |
471 | ,(if multibyte-p |
472 | (encoded-string-description | |
473 | (string-as-unibyte (char-to-string char)) nil) | |
474 | (format "#x%02X" char))) | |
ed441285 | 475 | ("file code" |
2d3e4f02 KH |
476 | ,@(if multibyte-p |
477 | (let* ((coding buffer-file-coding-system) | |
478 | (encoded (encode-coding-char char coding charset))) | |
479 | (if encoded | |
480 | (list (encoded-string-description encoded coding) | |
481 | (format "(encoded by coding system %S)" coding)) | |
482 | (list "not encodable by coding system" | |
483 | (symbol-name coding)))) | |
484 | (list (format "#x%02X" char)))) | |
ed441285 KH |
485 | ("display" |
486 | ,(cond | |
487 | (disp-vector | |
488 | (setq disp-vector (copy-sequence disp-vector)) | |
489 | (dotimes (i (length disp-vector)) | |
ed441285 | 490 | (aset disp-vector i |
c57b496b JB |
491 | (cons (aref disp-vector i) |
492 | (describe-char-display | |
493 | pos (glyph-char (aref disp-vector i)))))) | |
ed441285 | 494 | (format "by display table entry [%s] (see below)" |
8b18fb8f JL |
495 | (mapconcat |
496 | #'(lambda (x) | |
da55bb96 | 497 | (format "?%c" (glyph-char (car x)))) |
8b18fb8f | 498 | disp-vector " "))) |
ed441285 KH |
499 | (composition |
500 | (let ((from (car composition)) | |
501 | (to (nth 1 composition)) | |
502 | (next (1+ pos)) | |
503 | (components (nth 2 composition)) | |
504 | ch) | |
505 | (setcar composition | |
506 | (and (< from pos) (buffer-substring from pos))) | |
507 | (setcar (cdr composition) | |
508 | (and (< next to) (buffer-substring next to))) | |
509 | (dotimes (i (length components)) | |
510 | (if (integerp (setq ch (aref components i))) | |
511 | (push (cons ch (describe-char-display pos ch)) | |
512 | component-chars))) | |
513 | (setq component-chars (nreverse component-chars)) | |
514 | (format "composed to form \"%s\" (see below)" | |
515 | (buffer-substring from to)))) | |
516 | (t | |
517 | (let ((display (describe-char-display pos char))) | |
518 | (if (display-graphic-p (selected-frame)) | |
7fb0741b | 519 | (if display |
7a674474 | 520 | (concat "by this font (glyph code)\n " display) |
ed441285 KH |
521 | "no font available") |
522 | (if display | |
523 | (format "terminal code %s" display) | |
524 | "not encodable for terminal")))))) | |
879dfc97 KH |
525 | ,@(let ((face |
526 | (if (not (or disp-vector composition)) | |
527 | (cond | |
528 | ((and show-trailing-whitespace | |
529 | (save-excursion (goto-char pos) | |
70583cb5 | 530 | (looking-at-p "[ \t]+$"))) |
879dfc97 KH |
531 | 'trailing-whitespace) |
532 | ((and nobreak-char-display char (eq char '#xa0)) | |
533 | 'nobreak-space) | |
534 | ((and nobreak-char-display char (eq char '#xad)) | |
535 | 'escape-glyph) | |
536 | ((and (< char 32) (not (memq char '(9 10)))) | |
537 | 'escape-glyph))))) | |
538 | (if face (list (list "hardcoded face" | |
2fd54bf8 JL |
539 | `(insert-text-button |
540 | ,(symbol-name face) | |
541 | 'type 'help-face 'help-args '(,face)))))) | |
2d3e4f02 KH |
542 | ,@(if (not eight-bit-p) |
543 | (let ((unicodedata (describe-char-unicode-data char))) | |
544 | (if unicodedata | |
545 | (cons (list "Unicode data" " ") unicodedata)))))) | |
95eede5c | 546 | (setq max-width (apply #'max (mapcar #'(lambda (x) |
879dfc97 | 547 | (if (cadr x) (length (car x)) 0)) |
4adb7c09 | 548 | item-list))) |
bfd94110 | 549 | (help-setup-xref nil (interactive-p)) |
3db0e8bf | 550 | (with-help-window (help-buffer) |
ca9088e7 | 551 | (with-current-buffer standard-output |
4adb7c09 RS |
552 | (set-buffer-multibyte multibyte-p) |
553 | (let ((formatter (format "%%%ds:" max-width))) | |
554 | (dolist (elt item-list) | |
831ccfa6 DL |
555 | (when (cadr elt) |
556 | (insert (format formatter (car elt))) | |
557 | (dolist (clm (cdr elt)) | |
57d79b99 | 558 | (if (eq (car-safe clm) 'insert-text-button) |
fedbc8e5 JL |
559 | (progn (insert " ") (eval clm)) |
560 | (when (>= (+ (current-column) | |
70583cb5 | 561 | (or (string-match-p "\n" clm) |
fedbc8e5 JL |
562 | (string-width clm)) |
563 | 1) | |
564 | (window-width)) | |
565 | (insert "\n") | |
566 | (indent-to (1+ max-width))) | |
567 | (insert " " clm))) | |
831ccfa6 | 568 | (insert "\n")))) |
7fb0741b | 569 | |
086c5b2b KH |
570 | (when overlays |
571 | (save-excursion | |
572 | (goto-char (point-min)) | |
573 | (re-search-forward "character:[ \t\n]+") | |
c57b496b | 574 | (let ((end (+ (point) (length char-description)))) |
6398b88f | 575 | (mapc #'(lambda (props) |
086c5b2b | 576 | (let ((o (make-overlay (point) end))) |
6398b88f AS |
577 | (while props |
578 | (overlay-put o (car props) (nth 1 props)) | |
579 | (setq props (cddr props))))) | |
086c5b2b | 580 | overlays)))) |
ed441285 | 581 | |
7fb0741b KH |
582 | (when disp-vector |
583 | (insert | |
584 | "\nThe display table entry is displayed by ") | |
585 | (if (display-graphic-p (selected-frame)) | |
586 | (progn | |
587 | (insert "these fonts (glyph codes):\n") | |
588 | (dotimes (i (length disp-vector)) | |
da55bb96 | 589 | (insert (glyph-char (car (aref disp-vector i))) ?: |
7fb0741b | 590 | (propertize " " 'display '(space :align-to 5)) |
c57b496b | 591 | (or (cdr (aref disp-vector i)) "-- no font --") |
fedbc8e5 | 592 | "\n") |
da55bb96 KS |
593 | (let ((face (glyph-face (car (aref disp-vector i))))) |
594 | (when face | |
595 | (insert (propertize " " 'display '(space :align-to 5)) | |
596 | "face: ") | |
597 | (insert (concat "`" (symbol-name face) "'")) | |
598 | (insert "\n"))))) | |
7fb0741b KH |
599 | (insert "these terminal codes:\n") |
600 | (dotimes (i (length disp-vector)) | |
601 | (insert (car (aref disp-vector i)) | |
602 | (propertize " " 'display '(space :align-to 5)) | |
603 | (or (cdr (aref disp-vector i)) "-- not encodable --") | |
604 | "\n")))) | |
605 | ||
4adb7c09 | 606 | (when composition |
7fb0741b KH |
607 | (insert "\nComposed") |
608 | (if (car composition) | |
609 | (if (cadr composition) | |
610 | (insert " with the surrounding characters \"" | |
7a674474 KH |
611 | (mapconcat 'describe-char-padded-string |
612 | (car composition) "") | |
613 | "\" and \"" | |
614 | (mapconcat 'describe-char-padded-string | |
615 | (cadr composition) "") | |
616 | "\"") | |
7fb0741b | 617 | (insert " with the preceding character(s) \"" |
7a674474 KH |
618 | (mapconcat 'describe-char-padded-string |
619 | (car composition) "") | |
620 | "\"")) | |
7fb0741b KH |
621 | (if (cadr composition) |
622 | (insert " with the following character(s) \"" | |
7a674474 KH |
623 | (mapconcat 'describe-char-padded-string |
624 | (cadr composition) "") | |
625 | "\""))) | |
3f8b1daa KH |
626 | (if (and (vectorp (nth 2 composition)) |
627 | (vectorp (aref (nth 2 composition) 0))) | |
f5a60b43 KH |
628 | (let* ((gstring (nth 2 composition)) |
629 | (font (lgstring-font gstring)) | |
630 | (nglyphs (lgstring-glyph-len gstring)) | |
631 | (i 0) | |
632 | glyph) | |
e47fe93b | 633 | (if (fontp font) |
a62ac7e3 KH |
634 | (progn |
635 | (insert " using this font:\n " | |
636 | (symbol-name (font-get font :type)) | |
637 | ?: | |
638 | (aref (query-font font) 0) | |
639 | "\nby these glyphs:\n") | |
640 | (while (and (< i nglyphs) | |
641 | (setq glyph (lgstring-glyph gstring i))) | |
642 | (insert (format " %S\n" glyph)) | |
643 | (setq i (1+ i)))) | |
644 | (insert " by these characters:\n") | |
645 | (while (and (< i nglyphs) | |
646 | (setq glyph (lgstring-glyph gstring i))) | |
647 | (insert (format " %c (#x%d)\n" | |
648 | (lglyph-char glyph) (lglyph-char glyph))) | |
649 | (setq i (1+ i))))) | |
7a674474 KH |
650 | (insert " by the rule:\n\t(") |
651 | (let ((first t)) | |
c57b496b | 652 | (mapc (lambda (x) |
7a674474 KH |
653 | (if first (setq first nil) |
654 | (insert " ")) | |
655 | (if (consp x) (insert (format "%S" x)) | |
656 | (if (= x ?\t) (insert (single-key-description x)) | |
657 | (insert ??) | |
658 | (insert (describe-char-padded-string x))))) | |
659 | (nth 2 composition))) | |
660 | (insert ")\nThe component character(s) are displayed by ") | |
3f8b1daa KH |
661 | (if (display-graphic-p (selected-frame)) |
662 | (progn | |
663 | (insert "these fonts (glyph codes):") | |
664 | (dolist (elt component-chars) | |
665 | (if (/= (car elt) ?\t) | |
c57b496b | 666 | (insert "\n " |
7a674474 KH |
667 | (describe-char-padded-string (car elt)) |
668 | ?: | |
3f8b1daa | 669 | (propertize " " 'display '(space :align-to 5)) |
7a674474 | 670 | (or (cdr elt) "-- no font --"))))) |
3f8b1daa KH |
671 | (insert "these terminal codes:") |
672 | (dolist (elt component-chars) | |
673 | (insert "\n " (car elt) ":" | |
674 | (propertize " " 'display '(space :align-to 4)) | |
675 | (or (cdr elt) "-- not encodable --")))) | |
676 | (insert "\nSee the variable `reference-point-alist' for " | |
677 | "the meaning of the rule.\n"))) | |
3a73f428 | 678 | |
2d3e4f02 KH |
679 | (unless eight-bit-p |
680 | (insert (if (not describe-char-unidata-list) | |
681 | "\nCharacter code properties are not shown: " | |
682 | "\nCharacter code properties: ")) | |
683 | (insert-text-button | |
684 | "customize what to show" | |
685 | 'action (lambda (&rest ignore) | |
686 | (customize-variable | |
687 | 'describe-char-unidata-list))) | |
688 | (insert "\n") | |
689 | (dolist (elt (if (eq describe-char-unidata-list t) | |
690 | (nreverse (mapcar 'car char-code-property-alist)) | |
691 | describe-char-unidata-list)) | |
692 | (let ((val (get-char-code-property char elt)) | |
693 | description) | |
694 | (when val | |
695 | (setq description (char-code-property-description elt val)) | |
696 | (insert (if description | |
697 | (format " %s: %s (%s)\n" elt val description) | |
698 | (format " %s: %s\n" elt val))))))) | |
f1f194de | 699 | |
25a3c9d1 | 700 | (if text-props-desc (insert text-props-desc)) |
2fd54bf8 | 701 | (setq help-xref-stack-item (list 'help-insert-string (buffer-string))) |
3db0e8bf | 702 | (toggle-read-only 1))))) |
4adb7c09 | 703 | |
781424c2 | 704 | (define-obsolete-function-alias 'describe-char-after 'describe-char "22.1") |
831ccfa6 | 705 | |
288395a7 CW |
706 | (provide 'descr-text) |
707 | ||
d8ac3d27 | 708 | ;; arch-tag: fc55a498-f3e9-4312-b5bd-98cc02480af1 |
2a1e884e | 709 | ;;; descr-text.el ends here |