Fix typos and add missing entry.
[bpt/emacs.git] / lisp / descr-text.el
CommitLineData
dcb90b5f 1;;; descr-text.el --- describe text mode
2a1e884e 2
0d30b337 3;; Copyright (C) 1994, 1995, 1996, 2001, 2002, 2003, 2004,
409cc4a3 4;; 2005, 2006, 2007, 2008 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.
67PROPERTIES should be a list of overlay or text properties.
7fb0741b 68The `category', `face' and `font-lock-face' properties are made
57d79b99 69into 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.
114Interactively, describe them for the character after point.
115If optional second argument OUTPUT-BUFFER is non-nil,
116insert the output into that buffer, and don't initialize or clear it
117otherwise."
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
KH
182(defcustom describe-char-unidata-list
183 '(name general-category decomposition old-name)
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)
190 (const :tag "Unicode general category " general-category)
191 (const :tag "Unicode canonical combining class"
192 canonical-combining-class)
193 (const :tag "Unicode bidi class" bidi-class)
194 (const :tag "Unicode decomposition mapping" decomposition)
195 (const :tag "Unicode decimal digit value" decimal-digit-value)
196 (const :tag "Unicode digit value" digit-value)
197 (const :tag "Unicode numeric value" numeric-value)
198 (const :tag "Unicode mirrored" mirrored)
199 (const :tag "Unicode old name" old-name)
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 207This is the UnicodeData.txt file from the Unicode Consortium, used for
2a4960f9 208diagnostics. If it is non-nil `describe-char' will print data
49c2a2dc
SM
209looked up from it. This facility is mostly of use to people doing
210multilingual development.
4adb7c09 211
2acb13b1
JB
212This is a fairly large file, not typically present on GNU systems.
213At 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.
222Each element is a list of a property description and the property value.
f1f194de
KH
223The list is null if CHAR isn't found in `describe-char-unicodedata-file'.
224This 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
dfc7a783 348 (encoded-string-description encoded coding charset)))))
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
4adb7c09
RS
356;;;###autoload
357(defun describe-char (pos)
358 "Describe the character after POS (interactively, the character after point).
359The information includes character code, charset and code points in it,
360syntax, category, how the character is encoded in a file,
361character composition information (if relevant),
362as well as widgets, buttons, overlays, and text properties."
363 (interactive "d")
4adb7c09
RS
364 (if (>= pos (point-max))
365 (error "No character follows specified position"))
366 (let* ((char (char-after pos))
dfc7a783 367 (charset (or (get-text-property pos 'charset) (char-charset char)))
ca9088e7 368 (composition (find-composition pos nil nil t))
7fb0741b
KH
369 (component-chars nil)
370 (display-table (or (window-display-table)
371 buffer-display-table
372 standard-display-table))
373 (disp-vector (and display-table (aref display-table char)))
4adb7c09 374 (multibyte-p enable-multibyte-characters)
6482d093
KH
375 (overlays (mapcar #'(lambda (o) (overlay-properties o))
376 (overlays-at pos)))
6398b88f
AS
377 (char-description (if (not multibyte-p)
378 (single-key-description char)
379 (if (< char 128)
380 (single-key-description char)
381 (string-to-multibyte
382 (char-to-string char)))))
e5a5c80c
NR
383 (text-props-desc
384 (let ((tmp-buf (generate-new-buffer " *text-props*")))
385 (unwind-protect
386 (progn
387 (describe-text-properties pos tmp-buf)
388 (with-current-buffer tmp-buf (buffer-string)))
389 (kill-buffer tmp-buf))))
327719ee 390 item-list max-width code)
831ccfa6 391
dfc7a783
KH
392 (or (setq code (encode-char char charset))
393 (setq charset (char-charset char)
394 code (encode-char char charset)))
ed441285
KH
395 (setq item-list
396 `(("character"
41882805 397 ,(format "%s (%d, #o%o, #x%x)"
e5a5c80c
NR
398 (apply 'propertize char-description
399 (text-properties-at pos))
41882805 400 char char char))
327719ee 401 ("preferred charset"
57d79b99 402 ,`(insert-text-button
e5a5c80c
NR
403 ,(symbol-name charset)
404 'type 'help-character-set 'help-args '(,charset))
ed441285
KH
405 ,(format "(%s)" (charset-description charset)))
406 ("code point"
879dfc97
KH
407 ,(let ((str (if (integerp code)
408 (format (if (< code 256) "0x%02X" "0x%04X") code)
409 (format "0x%04X%04X" (car code) (cdr code)))))
410 (if (<= (charset-dimension charset) 2)
41882805
MB
411 `(insert-text-button
412 ,str
413 'action (lambda (&rest ignore)
879dfc97
KH
414 (list-charset-chars ',charset)
415 (with-selected-window
416 (get-buffer-window "*Character List*" 0)
417 (goto-char (point-min))
418 (forward-line 2) ;Skip the header.
419 (let ((case-fold-search nil))
420 (if (search-forward ,(char-to-string char)
421 nil t)
422 (goto-char (match-beginning 0))))))
41882805
MB
423 'help-echo
424 "mouse-2, RET: show this character in its character set")
879dfc97 425 str)))
ed441285 426 ("syntax"
d8ac3d27 427 ,(let ((syntax (syntax-after pos)))
ed441285
KH
428 (with-temp-buffer
429 (internal-describe-syntax-value syntax)
430 (buffer-string))))
431 ("category"
432 ,@(let ((category-set (char-category-set char)))
433 (if (not category-set)
434 '("-- none --")
9f40939d 435 (mapcar #'(lambda (x) (format "%c:%s"
ed441285
KH
436 x (category-docstring x)))
437 (category-set-mnemonics category-set)))))
309473d0 438 ("to input"
22259c93
KH
439 ,@(let ((key-list (and (eq input-method-function
440 'quail-input-method)
309473d0
KH
441 (quail-find-key char))))
442 (if (consp key-list)
443 (list "type"
444 (mapconcat #'(lambda (x) (concat "\"" x "\""))
fedbc8e5
JL
445 key-list " or ")
446 "with"
57d79b99 447 `(insert-text-button
2fd54bf8 448 ,current-input-method
e5a5c80c
NR
449 'type 'help-input-method
450 'help-args '(,current-input-method))))))
ed441285
KH
451 ("buffer code"
452 ,(encoded-string-description
453 (string-as-unibyte (char-to-string char)) nil))
454 ("file code"
455 ,@(let* ((coding buffer-file-coding-system)
dfc7a783 456 (encoded (encode-coding-char char coding charset)))
ed441285
KH
457 (if encoded
458 (list (encoded-string-description encoded coding)
459 (format "(encoded by coding system %S)" coding))
460 (list "not encodable by coding system"
461 (symbol-name coding)))))
462 ("display"
463 ,(cond
464 (disp-vector
465 (setq disp-vector (copy-sequence disp-vector))
466 (dotimes (i (length disp-vector))
ed441285 467 (aset disp-vector i
c57b496b
JB
468 (cons (aref disp-vector i)
469 (describe-char-display
470 pos (glyph-char (aref disp-vector i))))))
ed441285 471 (format "by display table entry [%s] (see below)"
8b18fb8f
JL
472 (mapconcat
473 #'(lambda (x)
da55bb96 474 (format "?%c" (glyph-char (car x))))
8b18fb8f 475 disp-vector " ")))
ed441285
KH
476 (composition
477 (let ((from (car composition))
478 (to (nth 1 composition))
479 (next (1+ pos))
480 (components (nth 2 composition))
481 ch)
482 (setcar composition
483 (and (< from pos) (buffer-substring from pos)))
484 (setcar (cdr composition)
485 (and (< next to) (buffer-substring next to)))
486 (dotimes (i (length components))
487 (if (integerp (setq ch (aref components i)))
488 (push (cons ch (describe-char-display pos ch))
489 component-chars)))
490 (setq component-chars (nreverse component-chars))
491 (format "composed to form \"%s\" (see below)"
492 (buffer-substring from to))))
493 (t
494 (let ((display (describe-char-display pos char)))
495 (if (display-graphic-p (selected-frame))
7fb0741b 496 (if display
7a674474 497 (concat "by this font (glyph code)\n " display)
ed441285
KH
498 "no font available")
499 (if display
500 (format "terminal code %s" display)
501 "not encodable for terminal"))))))
879dfc97
KH
502 ,@(let ((face
503 (if (not (or disp-vector composition))
504 (cond
505 ((and show-trailing-whitespace
506 (save-excursion (goto-char pos)
70583cb5 507 (looking-at-p "[ \t]+$")))
879dfc97
KH
508 'trailing-whitespace)
509 ((and nobreak-char-display char (eq char '#xa0))
510 'nobreak-space)
511 ((and nobreak-char-display char (eq char '#xad))
512 'escape-glyph)
513 ((and (< char 32) (not (memq char '(9 10))))
514 'escape-glyph)))))
515 (if face (list (list "hardcoded face"
2fd54bf8
JL
516 `(insert-text-button
517 ,(symbol-name face)
518 'type 'help-face 'help-args '(,face))))))
180505d5 519 ,@(let ((unicodedata (describe-char-unicode-data char)))
ed441285
KH
520 (if unicodedata
521 (cons (list "Unicode data" " ") unicodedata)))))
95eede5c 522 (setq max-width (apply #'max (mapcar #'(lambda (x)
879dfc97 523 (if (cadr x) (length (car x)) 0))
4adb7c09 524 item-list)))
bfd94110 525 (help-setup-xref nil (interactive-p))
3db0e8bf 526 (with-help-window (help-buffer)
ca9088e7 527 (with-current-buffer standard-output
4adb7c09
RS
528 (set-buffer-multibyte multibyte-p)
529 (let ((formatter (format "%%%ds:" max-width)))
530 (dolist (elt item-list)
831ccfa6
DL
531 (when (cadr elt)
532 (insert (format formatter (car elt)))
533 (dolist (clm (cdr elt))
57d79b99 534 (if (eq (car-safe clm) 'insert-text-button)
fedbc8e5
JL
535 (progn (insert " ") (eval clm))
536 (when (>= (+ (current-column)
70583cb5 537 (or (string-match-p "\n" clm)
fedbc8e5
JL
538 (string-width clm))
539 1)
540 (window-width))
541 (insert "\n")
542 (indent-to (1+ max-width)))
543 (insert " " clm)))
831ccfa6 544 (insert "\n"))))
7fb0741b 545
086c5b2b
KH
546 (when overlays
547 (save-excursion
548 (goto-char (point-min))
549 (re-search-forward "character:[ \t\n]+")
c57b496b 550 (let ((end (+ (point) (length char-description))))
6398b88f 551 (mapc #'(lambda (props)
086c5b2b 552 (let ((o (make-overlay (point) end)))
6398b88f
AS
553 (while props
554 (overlay-put o (car props) (nth 1 props))
555 (setq props (cddr props)))))
086c5b2b 556 overlays))))
ed441285 557
7fb0741b
KH
558 (when disp-vector
559 (insert
560 "\nThe display table entry is displayed by ")
561 (if (display-graphic-p (selected-frame))
562 (progn
563 (insert "these fonts (glyph codes):\n")
564 (dotimes (i (length disp-vector))
da55bb96 565 (insert (glyph-char (car (aref disp-vector i))) ?:
7fb0741b 566 (propertize " " 'display '(space :align-to 5))
c57b496b 567 (or (cdr (aref disp-vector i)) "-- no font --")
fedbc8e5 568 "\n")
da55bb96
KS
569 (let ((face (glyph-face (car (aref disp-vector i)))))
570 (when face
571 (insert (propertize " " 'display '(space :align-to 5))
572 "face: ")
573 (insert (concat "`" (symbol-name face) "'"))
574 (insert "\n")))))
7fb0741b
KH
575 (insert "these terminal codes:\n")
576 (dotimes (i (length disp-vector))
577 (insert (car (aref disp-vector i))
578 (propertize " " 'display '(space :align-to 5))
579 (or (cdr (aref disp-vector i)) "-- not encodable --")
580 "\n"))))
581
4adb7c09 582 (when composition
7fb0741b
KH
583 (insert "\nComposed")
584 (if (car composition)
585 (if (cadr composition)
586 (insert " with the surrounding characters \""
7a674474
KH
587 (mapconcat 'describe-char-padded-string
588 (car composition) "")
589 "\" and \""
590 (mapconcat 'describe-char-padded-string
591 (cadr composition) "")
592 "\"")
7fb0741b 593 (insert " with the preceding character(s) \""
7a674474
KH
594 (mapconcat 'describe-char-padded-string
595 (car composition) "")
596 "\""))
7fb0741b
KH
597 (if (cadr composition)
598 (insert " with the following character(s) \""
7a674474
KH
599 (mapconcat 'describe-char-padded-string
600 (cadr composition) "")
601 "\"")))
3f8b1daa
KH
602 (if (and (vectorp (nth 2 composition))
603 (vectorp (aref (nth 2 composition) 0)))
c57b496b 604 (let ((font (aref (aref (nth 2 composition) 0) 0)))
b2c6a479 605 (insert " using this font:\n "
c57b496b
JB
606 (symbol-name (font-get font :type))
607 ?:
608 (aref (query-font font) 0)
b2c6a479 609 "\nby these glyphs:\n")
3f8b1daa
KH
610 (mapc (lambda (x) (insert (format " %S\n" x)))
611 (nth 2 composition)))
7a674474
KH
612 (insert " by the rule:\n\t(")
613 (let ((first t))
c57b496b 614 (mapc (lambda (x)
7a674474
KH
615 (if first (setq first nil)
616 (insert " "))
617 (if (consp x) (insert (format "%S" x))
618 (if (= x ?\t) (insert (single-key-description x))
619 (insert ??)
620 (insert (describe-char-padded-string x)))))
621 (nth 2 composition)))
622 (insert ")\nThe component character(s) are displayed by ")
3f8b1daa
KH
623 (if (display-graphic-p (selected-frame))
624 (progn
625 (insert "these fonts (glyph codes):")
626 (dolist (elt component-chars)
627 (if (/= (car elt) ?\t)
c57b496b 628 (insert "\n "
7a674474
KH
629 (describe-char-padded-string (car elt))
630 ?:
3f8b1daa 631 (propertize " " 'display '(space :align-to 5))
7a674474 632 (or (cdr elt) "-- no font --")))))
3f8b1daa
KH
633 (insert "these terminal codes:")
634 (dolist (elt component-chars)
635 (insert "\n " (car elt) ":"
636 (propertize " " 'display '(space :align-to 4))
637 (or (cdr elt) "-- not encodable --"))))
638 (insert "\nSee the variable `reference-point-alist' for "
639 "the meaning of the rule.\n")))
3a73f428 640
3253c7c6
SM
641 (insert (if (not describe-char-unidata-list)
642 "\nCharacter code properties are not shown: "
643 "\nCharacter code properties: "))
3424774b
KH
644 (insert-text-button
645 "customize what to show"
646 'action (lambda (&rest ignore)
647 (customize-variable
648 'describe-char-unidata-list)))
f1f194de 649 (insert "\n")
3253c7c6 650 (dolist (elt (if (eq describe-char-unidata-list t)
95eede5c 651 (nreverse (mapcar 'car char-code-property-alist))
3253c7c6 652 describe-char-unidata-list))
f1f194de
KH
653 (let ((val (get-char-code-property char elt))
654 description)
655 (when val
656 (setq description (char-code-property-description elt val))
3253c7c6
SM
657 (insert (if description
658 (format " %s: %s (%s)\n" elt val description)
659 (format " %s: %s\n" elt val))))))
f1f194de 660
25a3c9d1 661 (if text-props-desc (insert text-props-desc))
2fd54bf8 662 (setq help-xref-stack-item (list 'help-insert-string (buffer-string)))
3db0e8bf 663 (toggle-read-only 1)))))
4adb7c09 664
781424c2 665(define-obsolete-function-alias 'describe-char-after 'describe-char "22.1")
831ccfa6 666
288395a7
CW
667(provide 'descr-text)
668
d8ac3d27 669;; arch-tag: fc55a498-f3e9-4312-b5bd-98cc02480af1
2a1e884e 670;;; descr-text.el ends here