Importing Oort Gnus v0.03.
[elisp/gnus.git-] / lisp / gnus-ems.el
1 ;;; gnus-ems.el --- functions for making Gnus work under different Emacsen
2 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001
3 ;;        Free Software Foundation, Inc.
4
5 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
6 ;; Keywords: news
7
8 ;; This file is part of GNU Emacs.
9
10 ;; GNU Emacs is free software; you can redistribute it and/or modify
11 ;; it under the terms of the GNU General Public License as published by
12 ;; the Free Software Foundation; either version 2, or (at your option)
13 ;; any later version.
14
15 ;; GNU Emacs is distributed in the hope that it will be useful,
16 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
17 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18 ;; GNU General Public License for more details.
19
20 ;; You should have received a copy of the GNU General Public License
21 ;; along with GNU Emacs; see the file COPYING.  If not, write to the
22 ;; Free Software Foundation, Inc., 59 Temple Place - Suite 330,
23 ;; Boston, MA 02111-1307, USA.
24
25 ;;; Commentary:
26
27 ;;; Code:
28
29 (eval-when-compile
30   (require 'cl)
31   (require 'ring))
32
33 ;;; Function aliases later to be redefined for XEmacs usage.
34
35 (defvar gnus-mouse-2 [mouse-2])
36 (defvar gnus-down-mouse-3 [down-mouse-3])
37 (defvar gnus-down-mouse-2 [down-mouse-2])
38 (defvar gnus-widget-button-keymap nil)
39 (defvar gnus-mode-line-modified
40   (if (or (featurep 'xemacs)
41           (< emacs-major-version 20))
42       '("--**-" . "-----")
43     '("**" "--")))
44
45 (eval-and-compile
46   (autoload 'gnus-xmas-define "gnus-xmas")
47   (autoload 'gnus-xmas-redefine "gnus-xmas")
48   (autoload 'appt-select-lowest-window "appt"))
49
50 (if (featurep 'xemacs)
51     (autoload 'gnus-smiley-display "smiley")
52   (autoload 'gnus-smiley-display "smiley-ems")) ; override XEmacs version
53
54 (defun gnus-kill-all-overlays ()
55   "Delete all overlays in the current buffer."
56   (let* ((overlayss (overlay-lists))
57          (buffer-read-only nil)
58          (overlays (delq nil (nconc (car overlayss) (cdr overlayss)))))
59     (while overlays
60       (delete-overlay (pop overlays)))))
61
62 ;;; Mule functions.
63
64 (defun gnus-mule-max-width-function (el max-width)
65   `(let* ((val (eval (, el)))
66           (valstr (if (numberp val)
67                       (int-to-string val) val)))
68      (if (> (length valstr) ,max-width)
69          (truncate-string-to-width valstr ,max-width)
70        valstr)))
71
72 (eval-and-compile
73   (if (featurep 'xemacs)
74       (gnus-xmas-define)
75     (defvar gnus-mouse-face-prop 'mouse-face
76       "Property used for highlighting mouse regions.")))
77
78 (eval-and-compile
79   (let ((case-fold-search t))
80     (cond
81      ((string-match "windows-nt\\|os/2\\|emx\\|cygwin32"
82                     (symbol-name system-type))
83       (setq nnheader-file-name-translation-alist
84             (append nnheader-file-name-translation-alist
85                     (mapcar (lambda (c) (cons c ?_))
86                             '(?: ?* ?\" ?< ?> ??))
87                     '((?+ . ?-))))))))
88
89 (defvar gnus-tmp-unread)
90 (defvar gnus-tmp-replied)
91 (defvar gnus-tmp-score-char)
92 (defvar gnus-tmp-indentation)
93 (defvar gnus-tmp-opening-bracket)
94 (defvar gnus-tmp-lines)
95 (defvar gnus-tmp-name)
96 (defvar gnus-tmp-closing-bracket)
97 (defvar gnus-tmp-subject-or-nil)
98 (defvar gnus-check-before-posting)
99
100 (defun gnus-ems-redefine ()
101   (cond
102    ((featurep 'xemacs)
103     (gnus-xmas-redefine))
104
105    ((featurep 'mule)
106     ;; Mule and new Emacs definitions
107
108     ;; [Note] Now there are three kinds of mule implementations,
109     ;; original MULE, XEmacs/mule and Emacs 20+ including
110     ;; MULE features.  Unfortunately these API are different.  In
111     ;; particular, Emacs (including original MULE) and XEmacs are
112     ;; quite different.  Howvere, this version of Gnus doesn't support
113     ;; anything other than XEmacs 20+ and Emacs 20.3+.
114
115     ;; Predicates to check are following:
116     ;; (boundp 'MULE) is t only if MULE (original; anything older than
117     ;;                     Mule 2.3) is running.
118     ;; (featurep 'mule) is t when every mule variants are running.
119
120     ;; It is possible to detect XEmacs/mule by (featurep 'mule) and
121     ;; checking `emacs-version'.  In this case, the implementation for
122     ;; XEmacs/mule may be shareable between XEmacs and XEmacs/mule.
123
124     (defvar gnus-summary-display-table nil
125       "Display table used in summary mode buffers.")
126     (defalias 'gnus-max-width-function 'gnus-mule-max-width-function)
127
128     (when (boundp 'gnus-check-before-posting)
129       (setq gnus-check-before-posting
130             (delq 'long-lines
131                   (delq 'control-chars gnus-check-before-posting))))
132
133     (defun gnus-summary-line-format-spec ()
134       (insert gnus-tmp-unread gnus-tmp-replied
135               gnus-tmp-score-char gnus-tmp-indentation)
136       (put-text-property
137        (point)
138        (progn
139          (insert
140           gnus-tmp-opening-bracket
141           (format "%4d: %-20s"
142                   gnus-tmp-lines
143                   (if (> (length gnus-tmp-name) 20)
144                       (truncate-string-to-width gnus-tmp-name 20)
145                     gnus-tmp-name))
146           gnus-tmp-closing-bracket)
147          (point))
148        gnus-mouse-face-prop gnus-mouse-face)
149       (insert " " gnus-tmp-subject-or-nil "\n")))))
150
151 (defun gnus-region-active-p ()
152   "Say whether the region is active."
153   (and (boundp 'transient-mark-mode)
154        transient-mark-mode
155        (boundp 'mark-active)
156        mark-active))
157
158 (if (fboundp 'add-minor-mode)
159     (defalias 'gnus-add-minor-mode 'add-minor-mode)
160   (defun gnus-add-minor-mode (mode name map &rest rest)
161     (set (make-local-variable mode) t)
162     (unless (assq mode minor-mode-alist)
163       (push `(,mode ,name) minor-mode-alist))
164     (unless (assq mode minor-mode-map-alist)
165       (push (cons mode map)
166             minor-mode-map-alist))))
167
168 (defun gnus-x-splash ()
169   "Show a splash screen using a pixmap in the current buffer."
170   (let ((dir (nnheader-find-etc-directory "gnus"))
171         pixmap file height beg i)
172     (save-excursion
173       (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
174       (let ((buffer-read-only nil)
175             width height)
176         (erase-buffer)
177         (when (and dir
178                    (file-exists-p (setq file
179                                         (expand-file-name "x-splash" dir))))
180           (with-temp-buffer
181             (insert-file-contents file)
182             (goto-char (point-min))
183             (ignore-errors
184               (setq pixmap (read (current-buffer))))))
185         (when pixmap
186           (make-face 'gnus-splash)
187           (setq height (/ (car pixmap) (frame-char-height))
188                 width (/ (cadr pixmap) (frame-char-width)))
189           (set-face-foreground 'gnus-splash "Brown")
190           (set-face-stipple 'gnus-splash pixmap)
191           (insert-char ?\n (* (/ (window-height) 2 height) height))
192           (setq i height)
193           (while (> i 0)
194             (insert-char ?\  (* (/ (window-width) 2 width) width))
195             (setq beg (point))
196             (insert-char ?\  width)
197             (set-text-properties beg (point) '(face gnus-splash))
198             (insert ?\n)
199             (decf i))
200           (goto-char (point-min))
201           (sit-for 0))))))
202
203 (defvar gnus-article-xface-ring-internal nil
204   "Cache for face data.")
205
206 ;; Worth customizing?
207 (defvar gnus-article-xface-ring-size 6
208   "Length of the ring used for `gnus-article-xface-ring-internal'.")
209
210 (defvar gnus-article-compface-xbm
211   (condition-case ()
212       (eq 0 (string-match "#define"
213                           (shell-command-to-string "uncompface -X")))
214     (error nil))
215   "Non-nil means the compface program supports the -X option.
216 That produces XBM output.")
217
218 (defun gnus-article-display-xface (beg end &optional buffer)
219   "Display an XFace header from between BEG and END in BUFFER.
220 Requires support for images in your Emacs and the external programs
221 `uncompface', and `icontopbm'.  On a GNU/Linux system these
222 might be in packages with names like `compface' or `faces-xface' and
223 `netpbm' or `libgr-progs', for instance.  See also
224 `gnus-article-compface-xbm'.
225
226 This function is for Emacs 21+.  See `gnus-xmas-article-display-xface'
227 for XEmacs."
228   ;; It might be worth converting uncompface's output in Lisp.
229
230   (when (if (fboundp 'display-graphic-p)
231             (display-graphic-p))
232     (unless gnus-article-xface-ring-internal ; Only load ring when needed.
233       (setq gnus-article-xface-ring-internal
234             (make-ring gnus-article-xface-ring-size)))
235     (save-excursion
236       (let* ((cur (current-buffer))
237              (data (if buffer
238                        (with-current-buffer buffer
239                          (buffer-substring beg end))
240                      (buffer-substring beg end)))
241              (image (cdr-safe (assoc data (ring-elements
242                                            gnus-article-xface-ring-internal))))
243              default-enable-multibyte-characters)
244         (unless image
245           (with-temp-buffer
246             (insert data)
247             (and (eq 0 (apply #'call-process-region (point-min) (point-max)
248                               "uncompface"
249                               'delete '(t nil) nil
250                               (if gnus-article-compface-xbm
251                                   '("-X"))))
252                  (if gnus-article-compface-xbm
253                      t
254                    (goto-char (point-min))
255                    (progn (insert "/* Width=48, Height=48 */\n") t)
256                    (eq 0 (call-process-region (point-min) (point-max)
257                                               "icontopbm"
258                                               'delete '(t nil))))
259                  ;; Miles Bader says that faces don't look right as
260                  ;; light on dark.
261                  (if (eq 'dark (cdr-safe (assq 'background-mode
262                                                (frame-parameters))))
263                      (setq image (create-image (buffer-string)
264                                                (if gnus-article-compface-xbm
265                                                    'xbm
266                                                  'pbm)
267                                                t
268                                                :ascent 'center
269                                                :foreground "black"
270                                                :background "white"))
271                    (setq image (create-image (buffer-string)
272                                              (if gnus-article-compface-xbm
273                                                  'xbm
274                                                'pbm)
275                                              t
276                                              :ascent 'center)))))
277           (ring-insert gnus-article-xface-ring-internal (cons data image)))
278         (when image
279           (goto-char (point-min))
280           (re-search-forward "^From:" nil 'move)
281           (insert-image image))))))
282
283 (provide 'gnus-ems)
284
285 ;;; gnus-ems.el ends here