1;;; gnus-ems.el --- functions for making Gnus work under different Emacsen
2
3;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4;;   2004, 2005, 2006, 2007 Free Software Foundation, Inc.
5
6;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
7;; Keywords: news
8
9;; This file is part of GNU Emacs.
10
11;; GNU Emacs is free software; you can redistribute it and/or modify
12;; it under the terms of the GNU General Public License as published by
13;; the Free Software Foundation; either version 2, or (at your option)
14;; any later version.
15
16;; GNU Emacs is distributed in the hope that it will be useful,
17;; but WITHOUT ANY WARRANTY; without even the implied warranty of
18;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
19;; GNU General Public License for more details.
20
21;; You should have received a copy of the GNU General Public License
22;; along with GNU Emacs; see the file COPYING.  If not, write to the
23;; Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
24;; Boston, MA 02110-1301, USA.
25
26;;; Commentary:
27
28;;; Code:
29
30(eval-when-compile
31  (require 'cl)
32  (require 'ring))
33
34;;; Function aliases later to be redefined for XEmacs usage.
35
36(defvar gnus-mouse-2 [mouse-2])
37(defvar gnus-down-mouse-3 [down-mouse-3])
38(defvar gnus-down-mouse-2 [down-mouse-2])
39(defvar gnus-widget-button-keymap nil)
40(defvar gnus-mode-line-modified
41  (if (or (featurep 'xemacs)
42	  (< emacs-major-version 20))
43      '("--**-" . "-----")
44    '("**" "--")))
45
46(eval-and-compile
47  (autoload 'gnus-xmas-define "gnus-xmas")
48  (autoload 'gnus-xmas-redefine "gnus-xmas")
49  (autoload 'appt-select-lowest-window "appt")
50  (autoload 'gnus-get-buffer-create "gnus")
51  (autoload 'nnheader-find-etc-directory "nnheader"))
52
53(autoload 'smiley-region "smiley")
54;; Fixme: shouldn't require message
55(autoload 'message-text-with-property "message")
56
57(defun gnus-kill-all-overlays ()
58  "Delete all overlays in the current buffer."
59  (let* ((overlayss (overlay-lists))
60	 (buffer-read-only nil)
61	 (overlays (delq nil (nconc (car overlayss) (cdr overlayss)))))
62    (while overlays
63      (delete-overlay (pop overlays)))))
64
65;;; Mule functions.
66
67(defun gnus-mule-max-width-function (el max-width)
68  `(let* ((val (eval (, el)))
69	  (valstr (if (numberp val)
70		      (int-to-string val) val)))
71     (if (> (length valstr) ,max-width)
72	 (truncate-string-to-width valstr ,max-width)
73       valstr)))
74
75(eval-and-compile
76  (defalias 'gnus-char-width
77    (if (fboundp 'char-width)
78	'char-width
79      (lambda (ch) 1)))) ;; A simple hack.
80
81(eval-and-compile
82  (if (featurep 'xemacs)
83      (gnus-xmas-define)
84    (defvar gnus-mouse-face-prop 'mouse-face
85      "Property used for highlighting mouse regions.")))
86
87(eval-when-compile
88  (defvar gnus-tmp-unread)
89  (defvar gnus-tmp-replied)
90  (defvar gnus-tmp-score-char)
91  (defvar gnus-tmp-indentation)
92  (defvar gnus-tmp-opening-bracket)
93  (defvar gnus-tmp-lines)
94  (defvar gnus-tmp-name)
95  (defvar gnus-tmp-closing-bracket)
96  (defvar gnus-tmp-subject-or-nil)
97  (defvar gnus-check-before-posting)
98  (defvar gnus-mouse-face)
99  (defvar gnus-group-buffer))
100
101(defun gnus-ems-redefine ()
102  (cond
103   ((featurep 'xemacs)
104    (gnus-xmas-redefine))
105
106   ((featurep 'mule)
107    ;; Mule and new Emacs definitions
108
109    ;; [Note] Now there are three kinds of mule implementations,
110    ;; original MULE, XEmacs/mule and Emacs 20+ including
111    ;; MULE features.  Unfortunately these APIs are different.  In
112    ;; particular, Emacs (including original Mule) and XEmacs are
113    ;; quite different.  However, this version of Gnus doesn't support
114    ;; anything other than XEmacs 20+ and Emacs 20.3+.
115
116    ;; Predicates to check are following:
117    ;; (boundp 'MULE) is t only if Mule (original; anything older than
118    ;;                     Mule 2.3) is running.
119    ;; (featurep 'mule) is t when other mule variants are running.
120
121    ;; It is possible to detect XEmacs/mule by (featurep 'mule) and
122    ;; (featurep 'xemacs).  In this case, the implementation for
123    ;; XEmacs/mule may be shareable between XEmacs and XEmacs/mule.
124
125    (defvar gnus-summary-display-table nil
126      "Display table used in summary mode buffers.")
127    (defalias 'gnus-max-width-function 'gnus-mule-max-width-function)
128
129    (when (boundp 'gnus-check-before-posting)
130      (setq gnus-check-before-posting
131	    (delq 'long-lines
132		  (delq 'control-chars gnus-check-before-posting))))
133
134    (defun gnus-summary-line-format-spec ()
135      (insert gnus-tmp-unread gnus-tmp-replied
136	      gnus-tmp-score-char gnus-tmp-indentation)
137      (put-text-property
138       (point)
139       (progn
140	 (insert
141	  gnus-tmp-opening-bracket
142	  (format "%4d: %-20s"
143		  gnus-tmp-lines
144		  (if (> (length gnus-tmp-name) 20)
145		      (truncate-string-to-width gnus-tmp-name 20)
146		    gnus-tmp-name))
147	  gnus-tmp-closing-bracket)
148	 (point))
149       gnus-mouse-face-prop gnus-mouse-face)
150      (insert " " gnus-tmp-subject-or-nil "\n")))))
151
152(defun gnus-region-active-p ()
153  "Say whether the region is active."
154  (and (boundp 'transient-mark-mode)
155       transient-mark-mode
156       (boundp 'mark-active)
157       mark-active))
158
159(defun gnus-mark-active-p ()
160  "Non-nil means the mark and region are currently active in this buffer."
161  mark-active) ; aliased to region-exists-p in XEmacs.
162
163(if (fboundp 'add-minor-mode)
164    (defalias 'gnus-add-minor-mode 'add-minor-mode)
165  (defun gnus-add-minor-mode (mode name map &rest rest)
166    (set (make-local-variable mode) t)
167    (unless (assq mode minor-mode-alist)
168      (push `(,mode ,name) minor-mode-alist))
169    (unless (assq mode minor-mode-map-alist)
170      (push (cons mode map)
171	    minor-mode-map-alist))))
172
173(defun gnus-x-splash ()
174  "Show a splash screen using a pixmap in the current buffer."
175  (let ((dir (nnheader-find-etc-directory "gnus"))
176	pixmap file height beg i)
177    (save-excursion
178      (switch-to-buffer (gnus-get-buffer-create gnus-group-buffer))
179      (let ((buffer-read-only nil)
180	    width height)
181	(erase-buffer)
182	(when (and dir
183		   (file-exists-p (setq file
184					(expand-file-name "x-splash" dir))))
185	  (let ((coding-system-for-read 'raw-text)
186		default-enable-multibyte-characters)
187	    (with-temp-buffer
188	      (insert-file-contents file)
189	      (goto-char (point-min))
190	      (ignore-errors
191		(setq pixmap (read (current-buffer)))))))
192	(when pixmap
193	  (make-face 'gnus-splash)
194	  (setq height (/ (car pixmap) (frame-char-height))
195		width (/ (cadr pixmap) (frame-char-width)))
196	  (set-face-foreground 'gnus-splash "Brown")
197	  (set-face-stipple 'gnus-splash pixmap)
198	  (insert-char ?\n (* (/ (window-height) 2 height) height))
199	  (setq i height)
200	  (while (> i 0)
201	    (insert-char ?\  (* (/ (window-width) 2 width) width))
202	    (setq beg (point))
203	    (insert-char ?\  width)
204	    (set-text-properties beg (point) '(face gnus-splash))
205	    (insert ?\n)
206	    (decf i))
207	  (goto-char (point-min))
208	  (sit-for 0))))))
209
210;;; Image functions.
211
212(defun gnus-image-type-available-p (type)
213  (and (fboundp 'image-type-available-p)
214       (image-type-available-p type)
215       (if (fboundp 'display-images-p)
216	   (display-images-p)
217	 t)))
218
219(defun gnus-create-image (file &optional type data-p &rest props)
220  (let ((face (plist-get props :face)))
221    (when face
222      (setq props (plist-put props :foreground (face-foreground face)))
223      (setq props (plist-put props :background (face-background face))))
224    (apply 'create-image file type data-p props)))
225
226(defun gnus-put-image (glyph &optional string category)
227  (let ((point (point)))
228    (insert-image glyph (or string " "))
229    (put-text-property point (point) 'gnus-image-category category)
230    (unless string
231      (put-text-property (1- (point)) (point)
232			 'gnus-image-text-deletable t))
233    glyph))
234
235(defun gnus-remove-image (image &optional category)
236  (dolist (position (message-text-with-property 'display))
237    (when (and (equal (get-text-property position 'display) image)
238	       (equal (get-text-property position 'gnus-image-category)
239		      category))
240      (put-text-property position (1+ position) 'display nil)
241      (when (get-text-property position 'gnus-image-text-deletable)
242	(delete-region position (1+ position))))))
243
244(provide 'gnus-ems)
245
246;;; arch-tag: e7360b45-14b5-4171-aa39-69a44aed3cdb
247;;; gnus-ems.el ends here
248