1 ;;; gnus-ems.el --- functions for making Gnus work under different Emacsen
3 ;; Copyright (C) 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, 2003,
4 ;; 2004, 2005, 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
6 ;; Author: Lars Magne Ingebrigtsen <larsi@gnus.org>
9 ;; This file is part of GNU Emacs.
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 3 of the License, or
14 ;; (at your option) any later version.
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.
21 ;; You should have received a copy of the GNU General Public License
22 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
32 ;;; Function aliases later to be redefined for XEmacs usage.
34 (defvar gnus-mouse-2
[mouse-2
])
35 (defvar gnus-down-mouse-3
[down-mouse-3
])
36 (defvar gnus-down-mouse-2
[down-mouse-2
])
37 (defvar gnus-widget-button-keymap nil
)
38 (defvar gnus-mode-line-modified
39 (if (featurep 'xemacs
)
44 (autoload 'gnus-xmas-define
"gnus-xmas")
45 (autoload 'gnus-xmas-redefine
"gnus-xmas"))
47 (autoload 'gnus-get-buffer-create
"gnus")
48 (autoload 'nnheader-find-etc-directory
"nnheader")
49 (autoload 'smiley-region
"smiley")
51 (defun gnus-kill-all-overlays ()
52 "Delete all overlays in the current buffer."
53 (let* ((overlayss (overlay-lists))
54 (buffer-read-only nil
)
55 (overlays (delq nil
(nconc (car overlayss
) (cdr overlayss
)))))
57 (delete-overlay (pop overlays
)))))
61 (defun gnus-mule-max-width-function (el max-width
)
62 `(let* ((val (eval (, el
)))
63 (valstr (if (numberp val
)
64 (int-to-string val
) val
)))
65 (if (> (length valstr
) ,max-width
)
66 (truncate-string-to-width valstr
,max-width
)
70 (if (featurep 'xemacs
)
72 (defvar gnus-mouse-face-prop
'mouse-face
73 "Property used for highlighting mouse regions.")))
75 (defvar gnus-tmp-unread
)
76 (defvar gnus-tmp-replied
)
77 (defvar gnus-tmp-score-char
)
78 (defvar gnus-tmp-indentation
)
79 (defvar gnus-tmp-opening-bracket
)
80 (defvar gnus-tmp-lines
)
81 (defvar gnus-tmp-name
)
82 (defvar gnus-tmp-closing-bracket
)
83 (defvar gnus-tmp-subject-or-nil
)
84 (defvar gnus-check-before-posting
)
85 (defvar gnus-mouse-face
)
86 (defvar gnus-group-buffer
)
88 (defun gnus-ems-redefine ()
94 ;; Mule and new Emacs definitions
96 ;; [Note] Now there are three kinds of mule implementations,
97 ;; original MULE, XEmacs/mule and Emacs 20+ including
98 ;; MULE features. Unfortunately these APIs are different. In
99 ;; particular, Emacs (including original Mule) and XEmacs are
100 ;; quite different. However, this version of Gnus doesn't support
101 ;; anything other than XEmacs 20+ and Emacs 20.3+.
103 ;; Predicates to check are following:
104 ;; (boundp 'MULE) is t only if Mule (original; anything older than
105 ;; Mule 2.3) is running.
106 ;; (featurep 'mule) is t when other mule variants are running.
108 ;; It is possible to detect XEmacs/mule by (featurep 'mule) and
109 ;; (featurep 'xemacs). In this case, the implementation for
110 ;; XEmacs/mule may be shareable between XEmacs and XEmacs/mule.
112 (defvar gnus-summary-display-table nil
113 "Display table used in summary mode buffers.")
114 (defalias 'gnus-max-width-function
'gnus-mule-max-width-function
)
116 (when (boundp 'gnus-check-before-posting
)
117 (setq gnus-check-before-posting
119 (delq 'control-chars gnus-check-before-posting
))))
121 (defun gnus-summary-line-format-spec ()
122 (insert gnus-tmp-unread gnus-tmp-replied
123 gnus-tmp-score-char gnus-tmp-indentation
)
128 gnus-tmp-opening-bracket
131 (if (> (length gnus-tmp-name
) 20)
132 (truncate-string-to-width gnus-tmp-name
20)
134 gnus-tmp-closing-bracket
)
136 gnus-mouse-face-prop gnus-mouse-face
)
137 (insert " " gnus-tmp-subject-or-nil
"\n")))))
139 ;; Clone of `appt-select-lowest-window' in appt.el.
140 (defun gnus-select-lowest-window ()
141 "Select the lowest window on the frame."
142 (let ((lowest-window (selected-window))
143 (bottom-edge (nth 3 (window-edges))))
144 (walk-windows (lambda (w)
145 (let ((next-bottom-edge (nth 3 (window-edges w
))))
146 (when (< bottom-edge next-bottom-edge
)
147 (setq bottom-edge next-bottom-edge
149 (select-window lowest-window
)))
151 (defun gnus-region-active-p ()
152 "Say whether the region is active."
153 (and (boundp 'transient-mark-mode
)
155 (boundp 'mark-active
)
158 (defun gnus-mark-active-p ()
159 "Non-nil means the mark and region are currently active in this buffer."
160 mark-active
) ; aliased to region-exists-p in XEmacs.
162 (autoload 'gnus-alive-p
"gnus-util")
163 (autoload 'mm-disable-multibyte
"mm-util")
165 (defun gnus-x-splash ()
166 "Show a splash screen using a pixmap in the current buffer."
168 (unless window-system
169 (error "`gnus-x-splash' requires running on the window system"))
170 (switch-to-buffer (gnus-get-buffer-create (if (or (gnus-alive-p)
174 (let ((inhibit-read-only t
)
175 (file (nnheader-find-etc-directory "images/gnus/x-splash" t
))
176 pixmap fcw fch width height fringes sbars left yoffset top ls
)
178 (sit-for 0) ;; Necessary for measuring the window size correctly.
181 (let ((coding-system-for-read 'raw-text
))
183 (mm-disable-multibyte)
184 (insert-file-contents file
)
185 (goto-char (point-min))
186 (setq pixmap
(read (current-buffer)))))))
187 (setq fcw
(float (frame-char-width))
188 fch
(float (frame-char-height))
189 width
(/ (car pixmap
) fcw
)
190 height
(/ (cadr pixmap
) fch
)
191 fringes
(if (fboundp 'window-fringes
)
192 (eval '(window-fringes))
194 sbars
(frame-parameter nil
'vertical-scroll-bars
))
195 (cond ((eq sbars
'right
)
197 (cons 0 (/ (or (frame-parameter nil
'scroll-bar-width
) 14)
201 (cons (/ (or (frame-parameter nil
'scroll-bar-width
) 14)
205 (setq sbars
'(0 .
0))))
206 (setq left
(- (* (round (/ (1- (/ (+ (window-width)
207 (car sbars
) (cdr sbars
)
208 (/ (+ (or (car fringes
) 0)
209 (or (cadr fringes
) 0))
215 (/ (or (car fringes
) 0) fcw
))
216 yoffset
(cadr (window-edges))
217 top
(max 0 (- (* (max (if (and (boundp 'tool-bar-mode
)
219 (not (featurep 'gtk
))
220 (eq (frame-first-window)
223 (round (/ (1- (/ (+ (1- (window-height))
229 ls
(/ (or line-spacing
0) fch
)
230 height
(max 0 (- height ls
)))
231 (cond ((>= (- top ls
) 1)
235 'display
`(space :width
0 :ascent
100))
239 'display
`(space :width
0 :height
,(- top ls
1) :ascent
100))
245 'display
`(space :width
0 :height
,(- top ls
) :ascent
100))
247 (if (and (> width
0) (> left
0))
250 'display
`(space :width
,left
:height
,height
:ascent
0)))
251 (setq width
(+ width left
)))
255 'display
`(space :width
,width
:height
,height
:ascent
0)
256 'face
`(gnus-splash :stipple
,pixmap
))))
257 (goto-char (if (<= (- top ls
) 0) (1- (point)) (point-min)))
258 (redraw-frame (selected-frame))
263 (defun gnus-image-type-available-p (type)
264 (and (fboundp 'image-type-available-p
)
265 (image-type-available-p type
)
266 (if (fboundp 'display-images-p
)
270 (defun gnus-create-image (file &optional type data-p
&rest props
)
271 (let ((face (plist-get props
:face
)))
273 (setq props
(plist-put props
:foreground
(face-foreground face
)))
274 (setq props
(plist-put props
:background
(face-background face
))))
276 (apply 'create-image file type data-p props
))))
278 (defun gnus-put-image (glyph &optional string category
)
279 (let ((point (point)))
280 (insert-image glyph
(or string
"*"))
281 (put-text-property point
(point) 'gnus-image-category category
)
283 (put-text-property (1- (point)) (point)
284 'gnus-image-text-deletable t
))
287 (defun gnus-remove-image (image &optional category
)
288 "Remove the image matching IMAGE and CATEGORY found first."
289 (let ((start (point-min))
291 (while (and (not end
)
292 (or (setq val
(get-text-property start
'display
))
294 (next-single-property-change start
'display
))
295 (setq val
(get-text-property start
'display
)))))
296 (setq end
(or (next-single-property-change start
'display
)
298 (if (and (equal val image
)
299 (equal (get-text-property start
'gnus-image-category
)
302 (put-text-property start end
'display nil
)
303 (when (get-text-property start
'gnus-image-text-deletable
)
304 (delete-region start end
)))
305 (unless (= end
(point-max))
310 ;; XEmacs does not have window-inside-pixel-edges
311 (defalias 'gnus-window-inside-pixel-edges
312 (if (fboundp 'window-inside-pixel-edges
)
313 'window-inside-pixel-edges
314 'window-pixel-edges
))
316 (if (fboundp 'set-process-plist
)
318 (defalias 'gnus-set-process-plist
'set-process-plist
)
319 (defalias 'gnus-process-plist
'process-plist
)
320 (defalias 'gnus-process-get
'process-get
)
321 (defalias 'gnus-process-put
'process-put
))
322 (defun gnus-set-process-plist (process plist
)
323 "Replace the plist of PROCESS with PLIST. Returns PLIST."
324 (put 'gnus-process-plist-internal process plist
))
326 (defun gnus-process-plist (process)
327 "Return the plist of PROCESS."
328 ;; This form works but can't prevent the plist data from
329 ;; growing infinitely.
330 ;;(get 'gnus-process-plist-internal process)
331 (let* ((plist (symbol-plist 'gnus-process-plist-internal
))
332 (tem (memq process plist
)))
335 ;; Remove it from the plist data.
339 (setcar plist
(caddr plist
))
340 (setcdr plist
(or (cdddr plist
) '(nil))))
341 (setcdr (nthcdr (- (length plist
) (length tem
) 1) plist
)
344 (defun gnus-process-get (process propname
)
345 "Return the value of PROCESS' PROPNAME property.
346 This is the last value stored with `(gnus-process-put PROCESS PROPNAME VALUE)'."
347 (plist-get (gnus-process-plist process
) propname
))
349 (defun gnus-process-put (process propname value
)
350 "Change PROCESS' PROPNAME property to VALUE.
351 It can be retrieved with `(gnus-process-get PROCESS PROPNAME)'."
352 (gnus-set-process-plist process
353 (plist-put (gnus-process-plist process
)
358 ;;; gnus-ems.el ends here