]> code.delx.au - gnu-emacs/blobdiff - lisp/descr-text.el
* proced.el (proced-tree-flag): Fix typo in docstring.
[gnu-emacs] / lisp / descr-text.el
index dfa87308fbe06dcb8415a8072c83a6a1242be7d7..f7bf647d15108aa237eecbcf1db7a88c1e5e2d49 100644 (file)
@@ -9,10 +9,10 @@
 
 ;; This file is part of GNU Emacs.
 
-;; GNU Emacs is free software; you can redistribute it and/or modify
+;; 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, or (at your option)
-;; any later version.
+;; 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
@@ -20,9 +20,7 @@
 ;; GNU General Public License for more details.
 
 ;; You should have received a copy of the GNU General Public License
-;; along with GNU Emacs; see the file COPYING.  If not, write to the
-;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
-;; Boston, MA 02110-1301, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
   (let ((pp (condition-case signal
                (pp-to-string sexp)
              (error (prin1-to-string signal)))))
-    (when (string-match "\n\\'" pp)
+    (when (string-match-p "\n\\'" pp)
       (setq pp (substring pp 0 (1- (length pp)))))
-    (if (cond ((string-match "\n" pp)
-              nil)
-             ((> (length pp) (- (window-width) (current-column)))
-              nil)
-             (t t))
+
+    (if (and (not (string-match-p "\n" pp))
+            (<= (length pp) (- (window-width) (current-column))))
        (insert pp)
       (insert-text-button
        "[Show]" 'action `(lambda (&rest ignore)
-                       (with-output-to-temp-buffer
-                           "*Pp Eval Output*"
-                         (princ ',pp)))
+                          (with-output-to-temp-buffer
+                              "*Pp Eval Output*"
+                            (princ ',pp)))
        'help-echo "mouse-2, RET: pretty print value in another buffer"))))
 
 (defun describe-property-list (properties)
@@ -183,26 +179,28 @@ otherwise."
        (insert "There are text properties here:\n")
        (describe-property-list properties)))))
 \f
-(defcustom describe-char-unidata-list nil
+(defcustom describe-char-unidata-list
+  '(name old-name general-category decomposition)
   "List of Unicode-based character property names shown by `describe-char'."
   :group 'mule
   :version "23.1"
-  :type '(set
-         (const :tag "Unicode Name" name)
-         (const :tag "Unicode general category " general-category)
-         (const :tag "Unicode canonical combining class"
-                canonical-combining-class)
-         (const :tag "Unicode bidi class" bidi-class)
-         (const :tag "Unicode decomposition mapping" decomposition)
-         (const :tag "Unicode decimal digit value" decimal-digit-value)
-         (const :tag "Unicode digit value" digit-value)
-         (const :tag "Unicode numeric value" numeric-value)
-         (const :tag "Unicode mirrored" mirrored)
-         (const :tag "Unicode old name" old-name)
-         (const :tag "Unicode ISO 10646 comment" iso-10646-comment)
-         (const :tag "Unicode simple uppercase mapping" uppercase)
-         (const :tag "Unicode simple lowercase mapping" lowercase)
-         (const :tag "Unicode simple titlecase mapping" titlecase)))
+  :type '(choice (const :tag "All properties" t)
+          (set
+           (const :tag "Unicode Name" name)
+           (const :tag "Unicode old name" old-name)
+           (const :tag "Unicode general category " general-category)
+           (const :tag "Unicode canonical combining class"
+                  canonical-combining-class)
+           (const :tag "Unicode bidi class" bidi-class)
+           (const :tag "Unicode decomposition mapping" decomposition)
+           (const :tag "Unicode decimal digit value" decimal-digit-value)
+           (const :tag "Unicode digit value" digit-value)
+           (const :tag "Unicode numeric value" numeric-value)
+           (const :tag "Unicode mirrored" mirrored)
+           (const :tag "Unicode ISO 10646 comment" iso-10646-comment)
+           (const :tag "Unicode simple uppercase mapping" uppercase)
+           (const :tag "Unicode simple lowercase mapping" lowercase)
+           (const :tag "Unicode simple titlecase mapping" titlecase))))
 
 (defcustom describe-char-unicodedata-file nil
   "Location of Unicode data file.
@@ -219,13 +217,6 @@ At the time of writing it is at the URL
   :type '(choice (const :tag "None" nil)
                 file))
 
-;; We could convert the unidata file into a Lispy form once-for-all
-;; and distribute it for loading on demand.  It might be made more
-;; space-efficient by splitting strings word-wise and replacing them
-;; with lists of symbols interned in a private obarray, e.g.
-;; "LATIN SMALL LETTER A" => '(LATIN SMALL LETTER A).
-
-;; Fixme: Check whether this needs updating for Unicode 4.
 (defun describe-char-unicode-data (char)
   "Return a list of Unicode data for unicode CHAR.
 Each element is a list of a property description and the property value.
@@ -328,27 +319,40 @@ This function is semi-obsolete.  Use `get-char-code-property'."
                                      (string (string-to-number
                                               (nth 13 fields) 16)))))))))))
 
+;; Not defined on builds without X, but behind display-graphic-p.
+(declare-function internal-char-font "fontset.c" (position &optional ch))
+
 ;; Return information about how CHAR is displayed at the buffer
 ;; position POS.  If the selected frame is on a graphic display,
-;; return a cons (FONTNAME . GLYPH-CODE) where GLYPH-CODE is a
-;; hexadigit string representing the glyph-ID.  Otherwise, return a
-;; string describing the terminal codes for the character.
+;; return a string "FONT-DRIVER:FONT-NAME (GLYPH-CODE)" where:
+;;   FONT-DRIVER is the font-driver name,
+;;   FONT-NAME is the font name,
+;;   GLYPH-CODE is a hexadigit string representing the glyph-ID.
+;; Otherwise, return a string describing the terminal codes for the
+;; character.
 (defun describe-char-display (pos char)
   (if (display-graphic-p (selected-frame))
       (let ((char-font-info (internal-char-font pos char)))
        (if char-font-info
-           (if (integerp (cdr char-font-info))
-               (setcdr char-font-info (format "%02X" (cdr char-font-info)))
-             (setcdr char-font-info
-                     (format "%04X%04X"
-                             (cadr char-font-info) (cddr char-font-info)))))
-       char-font-info)
-    (let* ((coding (terminal-coding-system))
-          (encoded (encode-coding-char char coding)))
+           (let ((type (font-get (car char-font-info) :type))
+                 (name (font-xlfd-name (car char-font-info)))
+                 (code (cdr char-font-info)))
+              (if (integerp code)
+                  (format "%s:%s (#x%02X)" type name code)
+                (format "%s:%s (#x%04X%04X)"
+                        type name (car code) (cdr code))))))
+    (let* ((charset (get-text-property pos 'charset))
+          (coding (terminal-coding-system))
+          (encoded (encode-coding-char char coding charset)))
       (if encoded
          (encoded-string-description encoded coding)))))
 
 \f
+;; Return a string of CH with composition for padding on both sides.
+;; It is displayed without overlapping with the left/right columns.
+(defsubst describe-char-padded-string (ch)
+  (compose-string (string ch) 0 1 (format "\t%c\t" ch)))
+
 ;;;###autoload
 (defun describe-char (pos)
   "Describe the character after POS (interactively, the character after point).
@@ -360,7 +364,7 @@ as well as widgets, buttons, overlays, and text properties."
   (if (>= pos (point-max))
       (error "No character follows specified position"))
   (let* ((char (char-after pos))
-        (charset (char-charset char))
+        (charset (or (get-text-property pos 'charset) (char-charset char)))
         (composition (find-composition pos nil nil t))
         (component-chars nil)
         (display-table (or (window-display-table)
@@ -385,7 +389,9 @@ as well as widgets, buttons, overlays, and text properties."
              (kill-buffer tmp-buf))))
         item-list max-width code)
 
-    (setq code (encode-char char charset))
+    (or (setq code (encode-char char charset))
+       (setq charset (char-charset char)
+             code (encode-char char charset)))
     (setq item-list
          `(("character"
             ,(format "%s (%d, #o%o, #x%x)"
@@ -447,7 +453,7 @@ as well as widgets, buttons, overlays, and text properties."
               (string-as-unibyte (char-to-string char)) nil))
            ("file code"
             ,@(let* ((coding buffer-file-coding-system)
-                     (encoded (encode-coding-char char coding)))
+                     (encoded (encode-coding-char char coding charset)))
                 (if encoded
                     (list (encoded-string-description encoded coding)
                           (format "(encoded by coding system %S)" coding))
@@ -458,10 +464,10 @@ as well as widgets, buttons, overlays, and text properties."
               (disp-vector
                (setq disp-vector (copy-sequence disp-vector))
                (dotimes (i (length disp-vector))
-                 (setq char (aref disp-vector i))
                  (aset disp-vector i
-                       (cons char (describe-char-display
-                                   pos (glyph-char char)))))
+                       (cons (aref disp-vector i)
+                             (describe-char-display
+                              pos (glyph-char (aref disp-vector i))))))
                (format "by display table entry [%s] (see below)"
                        (mapconcat
                         #'(lambda (x)
@@ -488,10 +494,7 @@ as well as widgets, buttons, overlays, and text properties."
                (let ((display (describe-char-display pos char)))
                  (if (display-graphic-p (selected-frame))
                      (if display
-                         (concat
-                          "by this font (glyph code)\n"
-                          (format "     %s (#x%s)"
-                                  (car display) (cdr display)))
+                         (concat "by this font (glyph code)\n    " display)
                        "no font available")
                    (if display
                        (format "terminal code %s" display)
@@ -501,7 +504,7 @@ as well as widgets, buttons, overlays, and text properties."
                         (cond
                          ((and show-trailing-whitespace
                                (save-excursion (goto-char pos)
-                                               (looking-at "[ \t]+$")))
+                                               (looking-at-p "[ \t]+$")))
                           'trailing-whitespace)
                          ((and nobreak-char-display char (eq char '#xa0))
                           'nobreak-space)
@@ -516,7 +519,7 @@ as well as widgets, buttons, overlays, and text properties."
            ,@(let ((unicodedata (describe-char-unicode-data char)))
                (if unicodedata
                    (cons (list "Unicode data" " ") unicodedata)))))
-    (setq max-width (apply #'max (mapcar #'(lambda (x) 
+    (setq max-width (apply #'max (mapcar #'(lambda (x)
                                             (if (cadr x) (length (car x)) 0))
                                         item-list)))
     (help-setup-xref nil (interactive-p))
@@ -531,7 +534,7 @@ as well as widgets, buttons, overlays, and text properties."
                (if (eq (car-safe clm) 'insert-text-button)
                    (progn (insert " ") (eval clm))
                  (when (>= (+ (current-column)
-                              (or (string-match "\n" clm)
+                              (or (string-match-p "\n" clm)
                                   (string-width clm))
                               1)
                            (window-width))
@@ -544,7 +547,7 @@ as well as widgets, buttons, overlays, and text properties."
          (save-excursion
            (goto-char (point-min))
            (re-search-forward "character:[ \t\n]+")
-           (let* ((end (+ (point) (length char-description))))
+           (let ((end (+ (point) (length char-description))))
              (mapc #'(lambda (props)
                        (let ((o (make-overlay (point) end)))
                          (while props
@@ -561,10 +564,7 @@ as well as widgets, buttons, overlays, and text properties."
                (dotimes (i (length disp-vector))
                  (insert (glyph-char (car (aref disp-vector i))) ?:
                          (propertize " " 'display '(space :align-to 5))
-                         (if (cdr (aref disp-vector i))
-                             (format "%s (#x%s)" (cadr (aref disp-vector i))
-                                     (cddr (aref disp-vector i)))
-                           "-- no font --")
+                         (or (cdr (aref disp-vector i)) "-- no font --")
                          "\n")
                  (let ((face (glyph-face (car (aref disp-vector i)))))
                    (when face
@@ -584,42 +584,66 @@ as well as widgets, buttons, overlays, and text properties."
          (if (car composition)
              (if (cadr composition)
                  (insert " with the surrounding characters \""
-                         (car composition) "\" and \""
-                         (cadr composition) "\"")
+                         (mapconcat 'describe-char-padded-string
+                                    (car composition) "")
+                         "\" and \""
+                         (mapconcat 'describe-char-padded-string
+                                    (cadr composition) "")
+                         "\"")
                (insert " with the preceding character(s) \""
-                       (car composition) "\""))
+                       (mapconcat 'describe-char-padded-string
+                                  (car composition) "")
+                       "\""))
            (if (cadr composition)
                (insert " with the following character(s) \""
-                       (cadr composition) "\"")))
+                       (mapconcat 'describe-char-padded-string
+                                  (cadr composition) "")
+                       "\"")))
          (if (and (vectorp (nth 2 composition))
                   (vectorp (aref (nth 2 composition) 0)))
-             (progn
-               (insert " using this font:\n  "
-                       (aref (query-font (aref (aref (nth 2 composition) 0) 0))
-                             0)
-                       "\nby these glyphs:\n")
-               (mapc (lambda (x) (insert (format "  %S\n" x)))
-                     (nth 2 composition)))
-           (insert " by the rule:\n\t("
-                   (mapconcat (lambda (x)
-                                (if (consp x) (format "%S" x)
-                                  (if (= x ?\t)
-                                      (single-key-description x)
-                                    (string ?? x))))
-                              (nth 2 composition)
-                              " ")
-                   ")")
-           (insert  "\nThe component character(s) are displayed by ")
+             (let* ((gstring (nth 2 composition))
+                    (font (lgstring-font gstring))
+                    (nglyphs (lgstring-glyph-len gstring))
+                    (i 0)
+                    glyph)
+               (if font
+                   (progn
+                     (insert " using this font:\n  "
+                             (symbol-name (font-get font :type))
+                             ?:
+                             (aref (query-font font) 0)
+                             "\nby these glyphs:\n")
+                     (while (and (< i nglyphs)
+                                 (setq glyph (lgstring-glyph gstring i)))
+                       (insert (format "  %S\n" glyph))
+                       (setq i (1+ i))))
+                 (insert " by these characters:\n")
+                 (while (and (< i nglyphs)
+                             (setq glyph (lgstring-glyph gstring i)))
+                   (insert (format " %c (#x%d)\n"
+                                   (lglyph-char glyph) (lglyph-char glyph)))
+                   (setq i (1+ i)))))
+           (insert " by the rule:\n\t(")
+           (let ((first t))
+             (mapc (lambda (x)
+                     (if first (setq first nil)
+                       (insert " "))
+                     (if (consp x) (insert (format "%S" x))
+                       (if (= x ?\t) (insert (single-key-description x))
+                         (insert ??)
+                         (insert (describe-char-padded-string x)))))
+                   (nth 2 composition)))
+           (insert  ")\nThe component character(s) are displayed by ")
            (if (display-graphic-p (selected-frame))
                (progn
                  (insert "these fonts (glyph codes):")
                  (dolist (elt component-chars)
                    (if (/= (car elt) ?\t)
-                       (insert "\n " (car elt) ?:
+                       (insert "\n "
+                               (describe-char-padded-string (car elt))
+                               ?:
                                (propertize " " 'display '(space :align-to 5))
-                               (if (cdr elt)
-                                   (format "%s (#x%s)" (cadr elt) (cddr elt))
-                                 "-- no font --")))))
+                               (or (cdr elt) "-- no font --")))))
              (insert "these terminal codes:")
              (dolist (elt component-chars)
                (insert "\n  " (car elt) ":"
@@ -628,30 +652,31 @@ as well as widgets, buttons, overlays, and text properties."
            (insert "\nSee the variable `reference-point-alist' for "
                    "the meaning of the rule.\n")))
 
-       (if (not describe-char-unidata-list)
-           (insert "\nCharacter code properties are not shown: ")
-         (insert "\nCharacter code properties: "))
+       (insert (if (not describe-char-unidata-list)
+                    "\nCharacter code properties are not shown: "
+                  "\nCharacter code properties: "))
        (insert-text-button
         "customize what to show"
         'action (lambda (&rest ignore)
                   (customize-variable
                    'describe-char-unidata-list)))
        (insert "\n")
-       (dolist (elt describe-char-unidata-list)
+       (dolist (elt (if (eq describe-char-unidata-list t)
+                         (nreverse (mapcar 'car char-code-property-alist))
+                       describe-char-unidata-list))
          (let ((val (get-char-code-property char elt))
                description)
            (when val
              (setq description (char-code-property-description elt val))
-             (if description
-                 (insert (format "  %s: %s (%s)\n" elt val description))
-               (insert (format "  %s: %s\n" elt val))))))
+             (insert (if description
+                          (format "  %s: %s (%s)\n" elt val description)
+                        (format "  %s: %s\n" elt val))))))
 
         (if text-props-desc (insert text-props-desc))
        (setq help-xref-stack-item (list 'help-insert-string (buffer-string)))
        (toggle-read-only 1)))))
 
-(defalias 'describe-char-after 'describe-char)
-(make-obsolete 'describe-char-after 'describe-char "22.1")
+(define-obsolete-function-alias 'describe-char-after 'describe-char "22.1")
 
 (provide 'descr-text)