Indent to keep width under 80 columns.
[gnus] / lisp / gnus-ems.el
index 8613af3..b4a2fe9 100644 (file)
@@ -1,15 +1,17 @@
 ;;; gnus-ems.el --- functions for making Gnus work under different Emacsen
-;; Copyright (C) 1995,96 Free Software Foundation, Inc.
 
-;; Author: Lars Magne Ingebrigtsen <larsi@ifi.uio.no>
+;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
+;;   2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
+
+;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
 ;; Keywords: news
 
 ;; 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
 ;; 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., 59 Temple Place - Suite 330,
-;; Boston, MA 02111-1307, USA.
+;; along with GNU Emacs.  If not, see <http://www.gnu.org/licenses/>.
 
 ;;; Commentary:
 
 ;;; Code:
 
-(eval-when-compile (require 'cl))
+(eval-when-compile
+  (require 'cl)
+  (require 'ring))
+
+;;; Function aliases later to be redefined for XEmacs usage.
 
 (defvar gnus-mouse-2 [mouse-2])
+(defvar gnus-down-mouse-3 [down-mouse-3])
+(defvar gnus-down-mouse-2 [down-mouse-2])
+(defvar gnus-widget-button-keymap nil)
+(defvar gnus-mode-line-modified
+  (if (featurep 'xemacs)
+      '("--**-" . "-----")
+    '("**" "--")))
 
-(defalias 'gnus-make-overlay 'make-overlay)
-(defalias 'gnus-overlay-put 'overlay-put)
-(defalias 'gnus-move-overlay 'move-overlay)
-(defalias 'gnus-overlay-end 'overlay-end)
-(defalias 'gnus-extent-detached-p 'ignore)
-(defalias 'gnus-extent-start-open 'ignore)
-(defalias 'gnus-set-text-properties 'set-text-properties)
-(defalias 'gnus-group-remove-excess-properties 'ignore)
-(defalias 'gnus-topic-remove-excess-properties 'ignore)
-(defalias 'gnus-appt-select-lowest-window 'appt-select-lowest-window)
-(defalias 'gnus-mail-strip-quoted-names 'mail-strip-quoted-names)
-(defalias 'gnus-make-local-hook 'make-local-hook)
-(defalias 'gnus-add-hook 'add-hook)
-(defalias 'gnus-character-to-event 'identity)
-(defalias 'gnus-add-text-properties 'add-text-properties)
-(defalias 'gnus-put-text-property 'put-text-property)
-
-(eval-and-compile 
+(eval-and-compile
   (autoload 'gnus-xmas-define "gnus-xmas")
-  (autoload 'gnus-xmas-redefine "gnus-xmas")
-  (autoload 'appt-select-lowest-window "appt.el"))
+  (autoload 'gnus-xmas-redefine "gnus-xmas"))
 
-(or (fboundp 'mail-file-babyl-p)
-    (fset 'mail-file-babyl-p 'rmail-file-p))
+(autoload 'gnus-get-buffer-create "gnus")
+(autoload 'nnheader-find-etc-directory "nnheader")
+(autoload 'smiley-region "smiley")
 
-;;; Mule functions.
+(defun gnus-kill-all-overlays ()
+  "Delete all overlays in the current buffer."
+  (let* ((overlayss (overlay-lists))
+        (buffer-read-only nil)
+        (overlays (delq nil (nconc (car overlayss) (cdr overlayss)))))
+    (while overlays
+      (delete-overlay (pop overlays)))))
 
-(defun gnus-mule-cite-add-face (number prefix face)
-  ;; At line NUMBER, ignore PREFIX and add FACE to the rest of the line.
-  (if face
-      (let ((inhibit-point-motion-hooks t)
-           from to)
-       (goto-line number)
-       (if (boundp 'MULE)
-           (forward-char (chars-in-string prefix))
-         (forward-char (length prefix)))
-       (skip-chars-forward " \t")
-       (setq from (point))
-       (end-of-line 1)
-       (skip-chars-backward " \t")
-       (setq to (point))
-       (if (< from to)
-           (gnus-overlay-put (gnus-make-overlay from to) 'face face)))))
+;;; Mule functions.
 
 (defun gnus-mule-max-width-function (el max-width)
-  (` (let* ((val (eval (, el)))
-           (valstr (if (numberp val)
-                       (int-to-string val) val)))
-       (if (> (length valstr) (, max-width))
-          (truncate-string valstr (, max-width))
-        valstr))))
+  `(let* ((val (eval (, el)))
+         (valstr (if (numberp val)
+                     (int-to-string val) val)))
+     (if (> (length valstr) ,max-width)
+        (truncate-string-to-width valstr ,max-width)
+       valstr)))
 
 (eval-and-compile
-  (if (string-match "XEmacs\\|Lucid" emacs-version)
-      ()
-
+  (if (featurep 'xemacs)
+      (gnus-xmas-define)
     (defvar gnus-mouse-face-prop 'mouse-face
-      "Property used for highlighting mouse regions.")
-
-    ;; Added by Per Abrahamsen <amanda@iesd.auc.dk>.
-    (defvar gnus-display-type 
-      (condition-case nil
-         (let ((display-resource (x-get-resource ".displayType" "DisplayType")))
-           (cond (display-resource (intern (downcase display-resource)))
-                 ((x-display-color-p) 'color)
-                 ((x-display-grayscale-p) 'grayscale)
-                 (t 'mono)))
-       (error 'mono))
-      "A symbol indicating the display Emacs is running under.
-The symbol should be one of `color', `grayscale' or `mono'. If Emacs
-guesses this display attribute wrongly, either set this variable in
-your `~/.emacs' or set the resource `Emacs.displayType' in your
-`~/.Xdefaults'. See also `gnus-background-mode'.
-
-This is a meta-variable that will affect what default values other
-variables get.  You would normally not change this variable, but
-pounce directly on the real variables themselves.")
-
-    (defvar gnus-background-mode 
-      (condition-case nil
-         (let ((bg-resource (x-get-resource ".backgroundMode"
-                                            "BackgroundMode"))
-               (params (frame-parameters)))
-           (cond (bg-resource (intern (downcase bg-resource)))
-                 ((and (cdr (assq 'background-color params))
-                       (< (apply '+ (x-color-values
-                                     (cdr (assq 'background-color params))))
-                          (/ (apply '+ (x-color-values "white")) 3)))
-                  'dark)
-                 (t 'light)))
-       (error 'light))
-      "A symbol indicating the Emacs background brightness.
-The symbol should be one of `light' or `dark'.
-If Emacs guesses this frame attribute wrongly, either set this variable in
-your `~/.emacs' or set the resource `Emacs.backgroundMode' in your
-`~/.Xdefaults'.
-See also `gnus-display-type'.
-
-This is a meta-variable that will affect what default values other
-variables get.  You would normally not change this variable, but
-pounce directly on the real variables themselves."))
-
-  (cond 
-   ((string-match "XEmacs\\|Lucid" emacs-version)
-    (gnus-xmas-define))
-
-   ((or (not (boundp 'emacs-minor-version))
-       (< emacs-minor-version 30))
-    ;; Remove the `intangible' prop.
-    (let ((props (and (boundp 'gnus-hidden-properties) 
-                     gnus-hidden-properties)))
-      (while (and props (not (eq (car (cdr props)) 'intangible)))
-       (setq props (cdr props)))
-      (and props (setcdr props (cdr (cdr (cdr props))))))
-    (or (fboundp 'buffer-substring-no-properties)
-       (defun buffer-substring-no-properties (beg end)
-         (format "%s" (buffer-substring beg end)))))
-   
-   ((boundp 'MULE)
-    (provide 'gnusutil))))
-
-(eval-and-compile
-  (cond
-   ((not window-system)
-    (defun gnus-dummy-func (&rest args))
-    (let ((funcs '(mouse-set-point set-face-foreground
-                                  set-face-background x-popup-menu)))
-      (while funcs
-       (or (fboundp (car funcs))
-           (fset (car funcs) 'gnus-dummy-func))
-       (setq funcs (cdr funcs))))))
-  (or (fboundp 'file-regular-p)
-      (defun file-regular-p (file)
-       (and (not (file-directory-p file))
-            (not (file-symlink-p file))
-            (file-exists-p file))))
-  (or (fboundp 'face-list)
-      (defun face-list (&rest args))))
-
-(eval-and-compile
-  (let ((case-fold-search t))
-    (cond
-     ((string-match "windows-nt\\|os/2\\|emx" (format "%s" system-type))
-      (setq nnheader-file-name-translation-alist
-           (append nnheader-file-name-translation-alist
-                   '((?: . ?_)
-                     (?+ . ?-))))))))
+      "Property used for highlighting mouse regions.")))
 
 (defvar gnus-tmp-unread)
 (defvar gnus-tmp-replied)
@@ -186,49 +81,272 @@ pounce directly on the real variables themselves."))
 (defvar gnus-tmp-name)
 (defvar gnus-tmp-closing-bracket)
 (defvar gnus-tmp-subject-or-nil)
+(defvar gnus-check-before-posting)
+(defvar gnus-mouse-face)
+(defvar gnus-group-buffer)
 
 (defun gnus-ems-redefine ()
-  (cond 
-   ((string-match "XEmacs\\|Lucid" emacs-version)
+  (cond
+   ((featurep 'xemacs)
     (gnus-xmas-redefine))
 
-   ((boundp 'MULE)
-    ;; Mule definitions
-    (defalias 'gnus-truncate-string 'truncate-string)
+   ((featurep 'mule)
+    ;; Mule and new Emacs definitions
+
+    ;; [Note] Now there are three kinds of mule implementations,
+    ;; original MULE, XEmacs/mule and Emacs 20+ including
+    ;; MULE features.  Unfortunately these APIs are different.  In
+    ;; particular, Emacs (including original Mule) and XEmacs are
+    ;; quite different.  However, this version of Gnus doesn't support
+    ;; anything other than XEmacs 20+ and Emacs 20.3+.
+
+    ;; Predicates to check are following:
+    ;; (boundp 'MULE) is t only if Mule (original; anything older than
+    ;;                     Mule 2.3) is running.
+    ;; (featurep 'mule) is t when other mule variants are running.
 
-    (fset 'gnus-summary-make-display-table (lambda () nil))
-    (fset 'gnus-cite-add-face 'gnus-mule-cite-add-face)
-    (fset 'gnus-max-width-function 'gnus-mule-max-width-function)
-    
-    (if (boundp 'gnus-check-before-posting)
-       (setq gnus-check-before-posting
-             (delq 'long-lines
-                   (delq 'control-chars gnus-check-before-posting))))
+    ;; It is possible to detect XEmacs/mule by (featurep 'mule) and
+    ;; (featurep 'xemacs).  In this case, the implementation for
+    ;; XEmacs/mule may be shareable between XEmacs and XEmacs/mule.
+
+    (defvar gnus-summary-display-table nil
+      "Display table used in summary mode buffers.")
+    (defalias 'gnus-max-width-function 'gnus-mule-max-width-function)
+
+    (when (boundp 'gnus-check-before-posting)
+      (setq gnus-check-before-posting
+           (delq 'long-lines
+                 (delq 'control-chars gnus-check-before-posting))))
 
     (defun gnus-summary-line-format-spec ()
-      (insert gnus-tmp-unread gnus-tmp-replied 
+      (insert gnus-tmp-unread gnus-tmp-replied
              gnus-tmp-score-char gnus-tmp-indentation)
       (put-text-property
        (point)
        (progn
-        (insert 
-         gnus-tmp-opening-bracket 
-         (format "%4d: %-20s" 
-                 gnus-tmp-lines 
-                 (if (> (length gnus-tmp-name) 20) 
-                     (truncate-string gnus-tmp-name 20) 
+        (insert
+         gnus-tmp-opening-bracket
+         (format "%4d: %-20s"
+                 gnus-tmp-lines
+                 (if (> (length gnus-tmp-name) 20)
+                     (truncate-string-to-width gnus-tmp-name 20)
                    gnus-tmp-name))
          gnus-tmp-closing-bracket)
         (point))
        gnus-mouse-face-prop gnus-mouse-face)
-      (insert " " gnus-tmp-subject-or-nil "\n"))
-    )))
+      (insert " " gnus-tmp-subject-or-nil "\n")))))
+
+;; Clone of `appt-select-lowest-window' in appt.el.
+(defun gnus-select-lowest-window ()
+"Select the lowest window on the frame."
+  (let ((lowest-window (selected-window))
+       (bottom-edge (nth 3 (window-edges))))
+    (walk-windows (lambda (w)
+                   (let ((next-bottom-edge (nth 3 (window-edges w))))
+                     (when (< bottom-edge next-bottom-edge)
+                       (setq bottom-edge next-bottom-edge
+                             lowest-window w)))))
+    (select-window lowest-window)))
+
+(defun gnus-region-active-p ()
+  "Say whether the region is active."
+  (and (boundp 'transient-mark-mode)
+       transient-mark-mode
+       (boundp 'mark-active)
+       mark-active))
+
+(defun gnus-mark-active-p ()
+  "Non-nil means the mark and region are currently active in this buffer."
+  mark-active) ; aliased to region-exists-p in XEmacs.
+
+(autoload 'gnus-alive-p "gnus-util")
+(autoload 'mm-disable-multibyte "mm-util")
+
+(defun gnus-x-splash ()
+  "Show a splash screen using a pixmap in the current buffer."
+  (interactive)
+  (unless window-system
+    (error "`gnus-x-splash' requires running on the window system"))
+  (switch-to-buffer (gnus-get-buffer-create (if (or (gnus-alive-p)
+                                                   (interactive-p))
+                                               "*gnus-x-splash*"
+                                             gnus-group-buffer)))
+  (let ((inhibit-read-only t)
+       (file (nnheader-find-etc-directory "images/gnus/x-splash" t))
+       pixmap fcw fch width height fringes sbars left yoffset top ls)
+    (erase-buffer)
+    (sit-for 0) ;; Necessary for measuring the window size correctly.
+    (when (and file
+              (ignore-errors
+               (let ((coding-system-for-read 'raw-text))
+                 (with-temp-buffer
+                    (mm-disable-multibyte)
+                   (insert-file-contents file)
+                   (goto-char (point-min))
+                   (setq pixmap (read (current-buffer)))))))
+      (setq fcw (float (frame-char-width))
+           fch (float (frame-char-height))
+           width (/ (car pixmap) fcw)
+           height (/ (cadr pixmap) fch)
+           fringes (if (fboundp 'window-fringes)
+                       (eval '(window-fringes))
+                     '(10 11 nil))
+           sbars (frame-parameter nil 'vertical-scroll-bars))
+      (cond ((eq sbars 'right)
+            (setq sbars
+                  (cons 0 (/ (or (frame-parameter nil 'scroll-bar-width) 14)
+                             fcw))))
+           (sbars
+            (setq sbars
+                  (cons (/ (or (frame-parameter nil 'scroll-bar-width) 14)
+                           fcw)
+                        0)))
+           (t
+            (setq sbars '(0 . 0))))
+      (setq left (- (* (round (/ (1- (/ (+ (window-width)
+                                          (car sbars) (cdr sbars)
+                                          (/ (+ (or (car fringes) 0)
+                                                (or (cadr fringes) 0))
+                                             fcw))
+                                       width))
+                                2))
+                      width)
+                   (car sbars)
+                   (/ (or (car fringes) 0) fcw))
+           yoffset (cadr (window-edges))
+           top (max 0 (- (* (max (if (and (boundp 'tool-bar-mode)
+                                          tool-bar-mode
+                                          (not (featurep 'gtk))
+                                          (eq (frame-first-window)
+                                              (selected-window)))
+                                     1 0)
+                                 (round (/ (1- (/ (+ (1- (window-height))
+                                                     (* 2 yoffset))
+                                                  height))
+                                           2)))
+                            height)
+                         yoffset))
+           ls (/ (or line-spacing 0) fch)
+           height (max 0 (- height ls)))
+      (cond ((>= (- top ls) 1)
+            (insert
+             (propertize
+              " "
+              'display `(space :width 0 :ascent 100))
+             "\n"
+             (propertize
+              " "
+              'display `(space :width 0 :height ,(- top ls 1) :ascent 100))
+             "\n"))
+           ((> (- top ls) 0)
+            (insert
+             (propertize
+              " "
+              'display `(space :width 0 :height ,(- top ls) :ascent 100))
+             "\n")))
+      (if (and (> width 0) (> left 0))
+         (insert (propertize
+                  " "
+                  'display `(space :width ,left :height ,height :ascent 0)))
+       (setq width (+ width left)))
+      (when (> width 0)
+       (insert (propertize
+                " "
+                'display `(space :width ,width :height ,height :ascent 0)
+                'face `(gnus-splash :stipple ,pixmap))))
+      (goto-char (if (<= (- top ls) 0) (1- (point)) (point-min)))
+      (redraw-frame (selected-frame))
+      (sit-for 0))))
+
+;;; Image functions.
+
+(defun gnus-image-type-available-p (type)
+  (and (fboundp 'image-type-available-p)
+       (image-type-available-p type)
+       (if (fboundp 'display-images-p)
+          (display-images-p)
+        t)))
+
+(defun gnus-create-image (file &optional type data-p &rest props)
+  (let ((face (plist-get props :face)))
+    (when face
+      (setq props (plist-put props :foreground (face-foreground face)))
+      (setq props (plist-put props :background (face-background face))))
+    (ignore-errors
+      (apply 'create-image file type data-p props))))
+
+(defun gnus-put-image (glyph &optional string category)
+  (let ((point (point)))
+    (insert-image glyph (or string "*"))
+    (put-text-property point (point) 'gnus-image-category category)
+    (unless string
+      (put-text-property (1- (point)) (point)
+                        'gnus-image-text-deletable t))
+    glyph))
+
+(defun gnus-remove-image (image &optional category)
+  "Remove the image matching IMAGE and CATEGORY found first."
+  (let ((start (point-min))
+       val end)
+    (while (and (not end)
+               (or (setq val (get-text-property start 'display))
+                   (and (setq start
+                              (next-single-property-change start 'display))
+                        (setq val (get-text-property start 'display)))))
+      (setq end (or (next-single-property-change start 'display)
+                   (point-max)))
+      (if (and (equal val image)
+              (equal (get-text-property start 'gnus-image-category)
+                     category))
+         (progn
+           (put-text-property start end 'display nil)
+           (when (get-text-property start 'gnus-image-text-deletable)
+             (delete-region start end)))
+       (unless (= end (point-max))
+         (setq start end
+               end nil))))))
 
+(eval-and-compile
+  (if (fboundp 'set-process-plist)
+      (progn
+       (defalias 'gnus-set-process-plist 'set-process-plist)
+       (defalias 'gnus-process-plist 'process-plist)
+       (defalias 'gnus-process-get 'process-get)
+       (defalias 'gnus-process-put 'process-put))
+    (defun gnus-set-process-plist (process plist)
+      "Replace the plist of PROCESS with PLIST.  Returns PLIST."
+      (put 'gnus-process-plist-internal process plist))
+
+    (defun gnus-process-plist (process)
+      "Return the plist of PROCESS."
+      ;; This form works but can't prevent the plist data from
+      ;; growing infinitely.
+      ;;(get 'gnus-process-plist-internal process)
+      (let* ((plist (symbol-plist 'gnus-process-plist-internal))
+            (tem (memq process plist)))
+       (prog1
+           (cadr tem)
+         ;; Remove it from the plist data.
+         (when tem
+           (if (eq plist tem)
+               (progn
+                 (setcar plist (caddr plist))
+                 (setcdr plist (or (cdddr plist) '(nil))))
+             (setcdr (nthcdr (- (length plist) (length tem) 1) plist)
+                     (cddr tem)))))))
+
+    (defun gnus-process-get (process propname)
+      "Return the value of PROCESS' PROPNAME property.
+This is the last value stored with `(gnus-process-put PROCESS PROPNAME VALUE)'."
+      (plist-get (gnus-process-plist process) propname))
+
+    (defun gnus-process-put (process propname value)
+      "Change PROCESS' PROPNAME property to VALUE.
+It can be retrieved with `(gnus-process-get PROCESS PROPNAME)'."
+      (gnus-set-process-plist process
+                             (plist-put (gnus-process-plist process)
+                                        propname value)))))
 
 (provide 'gnus-ems)
 
-;; Local Variables:
-;; byte-compile-warnings: '(redefine callargs)
-;; End:
-
 ;;; gnus-ems.el ends here