Fix some more docstring etc. quoting problems
[gnus] / lisp / format-spec.el
index 86b9b55..bf096bf 100644 (file)
@@ -1,17 +1,16 @@
 ;;; format-spec.el --- functions for formatting arbitrary formatting strings
 
-;; Copyright (C) 1999, 2000, 2002, 2003, 2004,
-;;   2005 Free Software Foundation, Inc.
+;; Copyright (C) 1999-2015 Free Software Foundation, Inc.
 
 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;; Keywords: tools
 
 ;; 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 2, 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
@@ -19,9 +18,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:
 
@@ -33,7 +30,8 @@
   "Return a string based on FORMAT and SPECIFICATION.
 FORMAT is a string containing `format'-like specs like \"bash %u %k\",
 while SPECIFICATION is an alist mapping from format spec characters
-to values."
+to values.  Any text properties on a %-spec itself are propagated to
+the text that it generates."
   (with-temp-buffer
     (insert format)
     (goto-char (point-min))
@@ -45,12 +43,22 @@ to values."
        ;; Valid format spec.
        ((looking-at "\\([-0-9.]*\\)\\([a-zA-Z]\\)")
        (let* ((num (match-string 1))
-              (spec (string-to-char (match-string 2)))
-              (val (cdr (assq spec specification))))
-         (delete-region (1- (match-beginning 0)) (match-end 0))
+              (spec (if (featurep 'xemacs)
+                        (char-to-int (string-to-char (match-string 2)))
+                      (string-to-char (match-string 2))))
+              (val (assq spec specification)))
          (unless val
-           (error "Invalid format character: `%%%c'" spec))
-         (insert (format (concat "%" num "s") val))))
+           (error "Invalid format character: `%%%c'" spec))
+         (setq val (cdr val))
+         ;; Pad result to desired length.
+         (let ((text (format (concat "%" num "s") val)))
+           ;; Insert first, to preserve text properties.
+           (insert-and-inherit text)
+           ;; Delete the specifier body.
+            (delete-region (+ (match-beginning 0) (length text))
+                           (+ (match-end 0) (length text)))
+            ;; Delete the percent sign.
+            (delete-region (1- (match-beginning 0)) (match-beginning 0)))))
        ;; Signal an error on bogus format strings.
        (t
        (error "Invalid format string"))))
@@ -64,11 +72,16 @@ starting with a character."
     (while pairs
       (unless (cdr pairs)
        (error "Invalid list of pairs"))
-      (push (cons (car pairs) (cadr pairs)) alist)
+      (push (cons (if (featurep 'xemacs)
+                     (if (characterp (car pairs))
+                         (char-to-int (car pairs))
+                       (car pairs))
+                   (car pairs))
+                 (cadr pairs))
+           alist)
       (setq pairs (cddr pairs)))
     (nreverse alist)))
 
 (provide 'format-spec)
 
-;;; arch-tag: c22d49cf-d167-445d-b7f1-2504d4173f53
 ;;; format-spec.el ends here