1 ;;; descr-text.el --- describe text mode
3 ;; Copyright (C) 1994, 1995, 1996, 2001, 2002, 2003, 2004,
4 ;; 2005, 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
6 ;; Author: Boris Goldowsky <boris@gnu.org>
8 ;; Keywords: faces, i18n, Unicode, multilingual
10 ;; This file is part of GNU Emacs.
12 ;; GNU Emacs is free software: you can redistribute it and/or modify
13 ;; it under the terms of the GNU General Public License as published by
14 ;; the Free Software Foundation, either version 3 of the License, or
15 ;; (at your option) any later version.
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.
22 ;; You should have received a copy of the GNU General Public License
23 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
27 ;;; Describe-Text Mode.
31 (eval-when-compile (require 'quail
))
34 ;;; Describe-Text Utilities.
36 (defun describe-text-widget (widget)
37 "Insert text to describe WIDGET in the current buffer."
39 (symbol-name (if (symbolp widget
) widget
(car widget
)))
40 'action
`(lambda (&rest ignore
)
41 (widget-browse ',widget
))
42 'help-echo
"mouse-2, RET: browse this widget")
45 "(widget)Top" 'type
'help-info
'help-args
'("(widget)Top")))
47 (defun describe-text-sexp (sexp)
48 "Insert a short description of SEXP in the current buffer."
49 (let ((pp (condition-case signal
51 (error (prin1-to-string signal
)))))
52 (when (string-match-p "\n\\'" pp
)
53 (setq pp
(substring pp
0 (1- (length pp
)))))
55 (if (and (not (string-match-p "\n" pp
))
56 (<= (length pp
) (- (window-width) (current-column))))
59 "[Show]" 'action
`(lambda (&rest ignore
)
60 (with-output-to-temp-buffer
63 'help-echo
"mouse-2, RET: pretty print value in another buffer"))))
65 (defun describe-property-list (properties)
66 "Insert a description of PROPERTIES in the current buffer.
67 PROPERTIES should be a list of overlay or text properties.
68 The `category', `face' and `font-lock-face' properties are made
69 into help buttons that call `describe-text-category' or
70 `describe-face' when pushed."
71 ;; Sort the properties by the size of their value.
72 (dolist (elt (sort (let (ret)
74 (push (list (pop properties
) (pop properties
)) ret
))
76 (lambda (a b
) (string< (prin1-to-string (nth 0 a
) t
)
77 (prin1-to-string (nth 0 b
) t
)))))
78 (let ((key (nth 0 elt
))
80 (insert (propertize (format " %-20s " key
)
81 'face
'help-argument-name
))
82 (cond ((eq key
'category
)
85 'action
`(lambda (&rest ignore
)
86 (describe-text-category ',value
))
87 'help-echo
"mouse-2, RET: describe this category"))
88 ((memq key
'(face font-lock-face mouse-face
))
91 'type
'help-face
'help-args
(list value
)))
93 (describe-text-widget value
))
95 (describe-text-sexp value
))))
98 ;;; Describe-Text Commands.
100 (defun describe-text-category (category)
101 "Describe a text property category."
102 (interactive "SCategory: ")
103 (help-setup-xref (list #'describe-text-category category
) (interactive-p))
105 (with-output-to-temp-buffer "*Help*"
106 (set-buffer standard-output
)
107 (insert "Category " (format "%S" category
) ":\n\n")
108 (describe-property-list (symbol-plist category
))
109 (goto-char (point-min)))))
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
119 (if (>= pos
(point-max))
120 (error "No character follows specified position"))
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.")
125 (let ((buffer (current-buffer))
126 (target-buffer "*Help*"))
127 (when (eq buffer
(get-buffer target-buffer
))
128 (setq target-buffer
"*Help*<2>"))
130 (with-output-to-temp-buffer target-buffer
131 (set-buffer standard-output
)
132 (setq output-buffer
(current-buffer))
133 (insert "Text content at position " (format "%d" pos
) ":\n\n")
134 (with-current-buffer buffer
135 (describe-text-properties-1 pos output-buffer
))
136 (goto-char (point-min))))))))
138 (defun describe-text-properties-1 (pos output-buffer
)
139 (let* ((properties (text-properties-at pos
))
140 (overlays (overlays-at pos
))
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
)))
149 (with-current-buffer output-buffer
151 (when (widgetp widget
)
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")))
157 (describe-text-widget widget
)
160 (when (and button
(not (widgetp wid-button
)))
162 (insert "Here is a `" (format "%S" button-type
)
163 "' button labeled `" button-label
"'.\n\n"))
167 (if (eq (length overlays
) 1)
168 (insert "There is an overlay here:\n")
169 (insert "There are " (format "%d" (length overlays
))
170 " overlays here:\n"))
171 (dolist (overlay overlays
)
172 (insert " From " (format "%d" (overlay-start overlay
))
173 " to " (format "%d" (overlay-end overlay
)) "\n")
174 (describe-property-list (overlay-properties overlay
)))
179 (insert "There are text properties here:\n")
180 (describe-property-list properties
)))))
182 (defcustom describe-char-unidata-list
183 '(name old-name general-category decomposition
)
184 "List of Unicode-based character property names shown by `describe-char'."
187 :type
'(choice (const :tag
"All properties" t
)
189 (const :tag
"Unicode Name" name
)
190 (const :tag
"Unicode old name" old-name
)
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
)
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
))))
205 (defcustom describe-char-unicodedata-file nil
206 "Location of Unicode data file.
207 This is the UnicodeData.txt file from the Unicode Consortium, used for
208 diagnostics. If it is non-nil `describe-char' will print data
209 looked up from it. This facility is mostly of use to people doing
210 multilingual development.
212 This is a fairly large file, not typically present on GNU systems.
213 At the time of writing it is at the URL
214 `http://www.unicode.org/Public/UNIDATA/UnicodeData.txt'."
217 :type
'(choice (const :tag
"None" nil
)
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.
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'."
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
))
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
))
232 (goto-char (point-min))
233 (let ((hex (format "%04X" char
))
235 (if (re-search-forward (concat "^" hex
) nil 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
)
241 (string-to-number (match-string 1) 16)))
244 (looking-at "^\\([^;]+\\);[^;]+Last>;")
247 (string-to-number (match-string 1) 16))))))
248 (if (and (>= char first
)
252 (let ((fields (mapcar (lambda (elt)
253 (if (> (length elt
) 0)
257 (line-beginning-position)
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.
267 (list "Name" (let ((name (nth 0 fields
)))
268 ;; Check for <..., First>, <..., Last>
269 (if (string-match "\\`\\(<[^,]+\\)," name
)
270 (concat (match-string 1 name
) ">")
273 (let ((val (nth 1 fields
)))
274 (or (char-code-property-description
275 'general-category
(intern val
))
277 (list "Combining class"
278 (let ((val (nth 1 fields
)))
279 (or (char-code-property-description
280 'canonical-combining-class
(intern val
))
282 (list "Bidi category"
283 (let ((val (nth 1 fields
)))
284 (or (char-code-property-description
285 'bidi-class
(intern val
))
290 (let* ((parts (split-string (nth 4 fields
)))
292 (if (string-match "\\`<\\(.+\\)>\\'" info
)
293 (setq info
(match-string 1 info
))
295 (if info
(setq parts
(cdr parts
)))
296 (setq parts
(mapconcat
298 (string (string-to-number arg
16)))
300 (concat info parts
))))
301 (list "Decimal digit value"
305 (list "Numeric value"
308 (if (equal "Y" (nth 8 fields
))
310 (list "Old name" (nth 9 fields
))
311 (list "ISO 10646 comment" (nth 10 fields
))
312 (list "Uppercase" (and (nth 11 fields
)
313 (string (string-to-number
314 (nth 11 fields
) 16))))
315 (list "Lowercase" (and (nth 12 fields
)
316 (string (string-to-number
317 (nth 12 fields
) 16))))
318 (list "Titlecase" (and (nth 13 fields
)
319 (string (string-to-number
320 (nth 13 fields
) 16)))))))))))
322 ;; Not defined on builds without X, but behind display-graphic-p.
323 (declare-function internal-char-font
"fontset.c" (position &optional ch
))
325 ;; Return information about how CHAR is displayed at the buffer
326 ;; position POS. If the selected frame is on a graphic display,
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
333 (defun describe-char-display (pos char
)
334 (if (display-graphic-p (selected-frame))
335 (let ((char-font-info (internal-char-font pos char
)))
337 (let ((type (font-get (car char-font-info
) :type
))
338 (name (font-xlfd-name (car char-font-info
)))
339 (code (cdr char-font-info
)))
341 (format "%s:%s (#x%02X)" type name code
)
342 (format "%s:%s (#x%04X%04X)"
343 type name
(car code
) (cdr code
))))))
344 (let* ((charset (get-text-property pos
'charset
))
345 (coding (terminal-coding-system))
346 (encoded (encode-coding-char char coding charset
)))
348 (encoded-string-description encoded coding
)))))
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
)))
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
"")
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
))
368 (format "%c:%s" x doc
)))
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."
379 (if (>= pos
(point-max))
380 (error "No character follows specified position"))
381 (let* ((char (char-after pos
))
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
))))
385 (composition (find-composition pos nil nil t
))
386 (component-chars nil
)
387 (display-table (or (window-display-table)
389 standard-display-table
))
390 (disp-vector (and display-table
(aref display-table char
)))
391 (multibyte-p enable-multibyte-characters
)
392 (overlays (mapcar #'(lambda (o) (overlay-properties o
))
394 (char-description (if (not multibyte-p
)
395 (single-key-description char
)
397 (single-key-description char
)
399 (char-to-string char
)))))
401 (let ((tmp-buf (generate-new-buffer " *text-props*")))
404 (describe-text-properties pos tmp-buf
)
405 (with-current-buffer tmp-buf
(buffer-string)))
406 (kill-buffer tmp-buf
))))
407 item-list max-width code
)
410 (or (setq code
(encode-char char charset
))
411 (setq charset
(char-charset char
)
412 code
(encode-char char charset
)))
416 ,(format "%s (%d, #o%o, #x%x)"
417 (apply 'propertize char-description
418 (text-properties-at pos
))
421 ,`(insert-text-button
422 ,(symbol-name charset
)
423 'type
'help-character-set
'help-args
'(,charset
))
424 ,(format "(%s)" (charset-description charset
)))
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)
432 'action
(lambda (&rest ignore
)
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
)
441 (goto-char (match-beginning 0))))))
443 "mouse-2, RET: show this character in its character set")
446 ,(let ((syntax (syntax-after pos
)))
448 (internal-describe-syntax-value syntax
)
451 ,@(if (not eight-bit-p
)
452 (let ((category-set (char-category-set char
)))
454 (describe-char-categories category-set
)
457 ,@(if (not eight-bit-p
)
458 (let ((key-list (and (eq input-method-function
460 (quail-find-key char
))))
463 (mapconcat #'(lambda (x) (concat "\"" x
"\""))
467 ,current-input-method
468 'type
'help-input-method
469 'help-args
'(,current-input-method
)))))))
472 (encoded-string-description
473 (string-as-unibyte (char-to-string char
)) nil
)
474 (format "#x%02X" char
)))
477 (let* ((coding buffer-file-coding-system
)
478 (encoded (encode-coding-char char coding charset
)))
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
))))
488 (setq disp-vector
(copy-sequence disp-vector
))
489 (dotimes (i (length disp-vector
))
491 (cons (aref disp-vector i
)
492 (describe-char-display
493 pos
(glyph-char (aref disp-vector i
))))))
494 (format "by display table entry [%s] (see below)"
497 (format "?%c" (glyph-char (car x
))))
500 (let ((from (car composition
))
501 (to (nth 1 composition
))
503 (components (nth 2 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
))
513 (setq component-chars
(nreverse component-chars
))
514 (format "composed to form \"%s\" (see below)"
515 (buffer-substring from to
))))
517 (let ((display (describe-char-display pos char
)))
518 (if (display-graphic-p (selected-frame))
520 (concat "by this font (glyph code)\n " display
)
523 (format "terminal code %s" display
)
524 "not encodable for terminal"))))))
526 (if (not (or disp-vector composition
))
528 ((and show-trailing-whitespace
529 (save-excursion (goto-char pos
)
530 (looking-at-p "[ \t]+$")))
531 'trailing-whitespace
)
532 ((and nobreak-char-display char
(eq char
'#xa0
))
534 ((and nobreak-char-display char
(eq char
'#xad
))
536 ((and (< char
32) (not (memq char
'(9 10))))
538 (if face
(list (list "hardcoded face"
541 'type
'help-face
'help-args
'(,face
))))))
542 ,@(if (not eight-bit-p
)
543 (let ((unicodedata (describe-char-unicode-data char
)))
545 (cons (list "Unicode data" " ") unicodedata
))))))
546 (setq max-width
(apply #'max
(mapcar #'(lambda (x)
547 (if (cadr x
) (length (car x
)) 0))
549 (help-setup-xref nil
(interactive-p))
550 (with-help-window (help-buffer)
551 (with-current-buffer standard-output
552 (set-buffer-multibyte multibyte-p
)
553 (let ((formatter (format "%%%ds:" max-width
)))
554 (dolist (elt item-list
)
556 (insert (format formatter
(car elt
)))
557 (dolist (clm (cdr elt
))
558 (if (eq (car-safe clm
) 'insert-text-button
)
559 (progn (insert " ") (eval clm
))
560 (when (>= (+ (current-column)
561 (or (string-match-p "\n" clm
)
566 (indent-to (1+ max-width
)))
572 (goto-char (point-min))
573 (re-search-forward "character:[ \t\n]+")
574 (let ((end (+ (point) (length char-description
))))
575 (mapc #'(lambda (props)
576 (let ((o (make-overlay (point) end
)))
578 (overlay-put o
(car props
) (nth 1 props
))
579 (setq props
(cddr props
)))))
584 "\nThe display table entry is displayed by ")
585 (if (display-graphic-p (selected-frame))
587 (insert "these fonts (glyph codes):\n")
588 (dotimes (i (length disp-vector
))
589 (insert (glyph-char (car (aref disp-vector i
))) ?
:
590 (propertize " " 'display
'(space :align-to
5))
591 (or (cdr (aref disp-vector i
)) "-- no font --")
593 (let ((face (glyph-face (car (aref disp-vector i
)))))
595 (insert (propertize " " 'display
'(space :align-to
5))
597 (insert (concat "`" (symbol-name face
) "'"))
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 --")
607 (insert "\nComposed")
608 (if (car composition
)
609 (if (cadr composition
)
610 (insert " with the surrounding characters \""
611 (mapconcat 'describe-char-padded-string
612 (car composition
) "")
614 (mapconcat 'describe-char-padded-string
615 (cadr composition
) "")
617 (insert " with the preceding character(s) \""
618 (mapconcat 'describe-char-padded-string
619 (car composition
) "")
621 (if (cadr composition
)
622 (insert " with the following character(s) \""
623 (mapconcat 'describe-char-padded-string
624 (cadr composition
) "")
626 (if (and (vectorp (nth 2 composition
))
627 (vectorp (aref (nth 2 composition
) 0)))
628 (let* ((gstring (nth 2 composition
))
629 (font (lgstring-font gstring
))
630 (nglyphs (lgstring-glyph-len gstring
))
635 (insert " using this font:\n "
636 (symbol-name (font-get font
:type
))
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
))
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
)))
650 (insert " by the rule:\n\t(")
653 (if first
(setq first nil
)
655 (if (consp x
) (insert (format "%S" x
))
656 (if (= x ?
\t) (insert (single-key-description x
))
658 (insert (describe-char-padded-string x
)))))
659 (nth 2 composition
)))
660 (insert ")\nThe component character(s) are displayed by ")
661 (if (display-graphic-p (selected-frame))
663 (insert "these fonts (glyph codes):")
664 (dolist (elt component-chars
)
665 (if (/= (car elt
) ?
\t)
667 (describe-char-padded-string (car elt
))
669 (propertize " " 'display
'(space :align-to
5))
670 (or (cdr elt
) "-- no font --")))))
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")))
680 (insert (if (not describe-char-unidata-list
)
681 "\nCharacter code properties are not shown: "
682 "\nCharacter code properties: "))
684 "customize what to show"
685 'action
(lambda (&rest ignore
)
687 'describe-char-unidata-list
)))
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
))
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
)))))))
700 (if text-props-desc
(insert text-props-desc
))
701 (setq help-xref-stack-item
(list 'help-insert-string
(buffer-string)))
702 (toggle-read-only 1)))))
704 (define-obsolete-function-alias 'describe-char-after
'describe-char
"22.1")
706 (provide 'descr-text
)
708 ;; arch-tag: fc55a498-f3e9-4312-b5bd-98cc02480af1
709 ;;; descr-text.el ends here